SimpleREST 0.2.1

SimpleREST 0.2.1

×

Maintained by Alexander Gaidukov.

SimpleREST 0.2.1

  • By
  • alexander-gaidukov

SimpleREST

CI Status Version License Platform

Overview

Simple REST is a RESTful client with ability to cache response data.

How to use

Simple request

struct Object: Decodable {
// some properties here
}

struct APIError: Error, Decodable {
// some properties here
}

let resource = Resource<Object, CustomError>(baseURL: URL(string: "https://...")!
path: "resource_path",
params: ["param1": "value1", "param2": "value2"],
method: .get,
headers: ["headerField1": "value1"],
decoder: JSONDecoder())

let task = URLSession.shared.load(resource: resource) { result in
    switch result {
    case .success(let object):
        // handle object
    case .failure(let error):
        // handle error
    }
}

Map and compactMap

Use map method to change the result type of the resource.

struct Object {
    var property: String
}

let resource = Resource<Object, CustomError>(...).map { $0.property }

The resource type is Resource<String, CustomError>

You can use compactMap if property type is optional.

struct Object {
    var property: String?
}

let resource = Resource<Object, CustomError>(...).compactMap { $0.property }

Send data in the request body

For application/json data:

let resource = Resource<Object, CustomError>(baseURL: URL(string: "https://...")!
path: "resource_path",
params: [:],
method: .post(.json(["param1": "value1", "param2": "value2"])),
headers: ["headerField1": "value1"],
decoder: JSONDecoder())

For multipart/form-data data:

let attachment = try! Attachment(path: <path to file>)
let attachments = ["images": [attachment]]

let resource = Resource<Object, CustomError>(baseURL: URL(string: "https://...")!
path: "resource_path",
params: [:],
method: .post(.multipart(params: ["param1": "value1", "param2": "value2"], attachments: attachments)),
headers: ["headerField1": "value1"],
decoder: JSONDecoder())

Task cancelling

task?.cancel()

Caching

To use cache:

let resource = Resource<Object, CustomError>(...)

let cacheableResource = resource.cacheable()

let task = URLSession.shared.load(resource: cacheableResource) { result in
    switch result {
    case .success(let object):
        // handle object
    case .failure(let error):
        // handle error
    }
}

You can specify cache key if you don't want to use the default one (path + all parameters) and cache live time (permanent by default)

let cacheableResource = resource.cacheable(key: "custom_key", liveTime: 60)

If you need to clear cache storage use the following command:

HTTPCache.shared.clear()

You can also clear cache for specific resource:

HTTPCache.shared.clearCache(for:)

Combined requests

Sometimes you need to make multiple consecutive or parallel requests. Use flatMap and zipWith methods for these purposes.

let resource = Resource<Object, CustomError>(...)
let combinedResource = resource.flatMap { object in
    return Resource<OtherObject, CustomError>(...)
}
URLSession.shared.load(combinedResource: combinedResource) { result in
    switch result {
    case .success(let otherObject):
        // handle object
    case .failure(let error):
        // handle error
    }
}
let resource = Resource<Object, CustomError>(...)
let otherResource = Resource<OtherObject, CustomError>(...)
let combinedResource = resource.zipWith(otherResource) { object, otherObject in
    return <object that created from object and otherObject>
}
URLSession.shared.load(combinedResource: combinedResource) { result in
    switch result {
    case .success(let otherObject):
        // handle object
    case .failure(let error):
        // handle error
    }
}

In case of consecutive request there are situanions when you make the second request only if the first request returns some specific parameter. You need to return .value(A) in case if you don't want to make the second request.

let resource = Resource<Object, CustomError>(...)
let combinedResource = resource.flatMap { object in
    if object.needAdditionalData {
        return Resource<OtherObject, CustomError>(...).map { 
            object.additionalData = $0
            return object
        }.combined
    } else {
        return .value(object)
    }
}

Example

To run the example project, clone the repo, and run pod install from the Example directory first.

Requirements

  • ARC
  • iOS 9.0+

Installation

SimpleREST is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod 'SimpleREST'

Author

alexander-gaidukov, [email protected]

License

SimpleREST is available under the MIT license. See the LICENSE file for more info.