RxRestClient

Example

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

Requirements

• iOS 9.3+
• Swift 4.1+
• Xcode 9.3+

Installation

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

pod 'RxRestClient'

Features

• Simple way to do requests
• Simple way to have response state in reactive way
• Ability to customization
• Retry on any error
• Handle network reachability status
• Retry on become reachable
• Ability to use absalute and relative urls
• Logger
• Swift Codable protocol support
• Use custom SessionManager
• more coming soon

How to use

First of all you need to create struct of your response state and implement ResponseState protocol.

struct RepositoriesState: ResponseState {

    typealias Body = Data

    var state: BaseState?
    var data: [Repository]?

    private init() {
        state = nil
    }

    init(state: BaseState) {
        self.state = state
    }

    init(response: (HTTPURLResponse, Data?)) {
        if response.0.statusCode == 200, let body = response.1 {
            self.data = try? JSONDecoder().decode(RepositoryResponse.self, from: body).items
        }
    }

    static let empty = RepositoriesState()
}

It is required to mention expected Body type (String or Data).

After that you need to create request model:

struct RepositoryQuery: Encodable {
    let q: String
}

Than you can do the request to get repositories:

import RxSwift
import RxRestClient

protocol RepositoriesServiceProtocol {
    func get(query: RepositoryQuery) -> Observable<RepositoriesState>
}

final class RepositoriesService: RepositoriesServiceProtocol {

    private let client = RxRestClient()

    func get(query: RepositoryQuery) -> Observable<RepositoriesState> {
        return client.get("https://api.github.com/search/repositories", query: query)
    }
}

In order to customize client you can use RxRestClientOptions:

var options = RxRestClientOptions.default
options.addHeader(key: "x-apikey", value: "<API_KEY>")
client = RxRestClient(baseUrl: <BASE _URL>), options: options)

Relative vs absalute url

In order to use relative url you need to give <BASE_URL> when initializing client object.

let client = RxRestClient(baseURL: <BASE_URL>)

When calling any request you can provide either String endpoint or absalute URL. If you will String it will be appended to baseURL.

client.get("rest/contacts")

If baseURL is nil than it will try to convert provided String to URL.

In order to use absalute url even when your client has baseURL you can provide URL like this:

if let url = URL(string: "https://api.github.com/search/repositories") {
    client.get(url: url, query: ["q": search])
}

Logger

In order to log curl command of sent request you can use RxRestClientOptions.logger option. For just printing debug description to console you can use builtin DebugRxRestClientLogger logger.

If you prefer to have a custom logger, for example, log requests to the file, you need to implement RxRestClientLogger protocol and pass it as an option.

Author

Tigran Hambardzumyan, tigran@stdevmail.com

Support

Feel free to open issuses with any suggestions, bug reports, feature requests, questions.

Let us know!

We’d be really happy if you sent us links to your projects where you use our component. Just send an email to developer@stdevmail.com and do let us know if you have any questions or suggestion.

License

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