Restofire is a protocol oriented networking client for Alamofire.

• Features
• Requirements
• Installation
• Usage
• License

Features

• [x] Global Configuration for host / headers / parameters etc
• [x] Group Configurations
• [x] Per Request Configuration
• [x] Authentication
• [x] Response Validations
• [x] Custom Response Serializers like JSONDecodable
• [x] Isolate Network Requests from ViewControllers
• [x] Auto retry based on URLError codes
• [x] Request eventually when network is reachable
• [x] NSOperations
• [x] Complete Documentation

Requirements

• iOS 10.0+ / Mac OS X 10.12+ / tvOS 10.0+ / watchOS 3.0+
• Xcode 10

Installation

Dependency Managers

Manually

If you prefer not to use either of the aforementioned dependency managers, you can integrate Restofire into your project manually.

Configurations

Three levels of configuration

• Global Configuration – The global configuration will be applied to all the requests. These include values like scheme, host, version, headers, sessionManager, callbackQueue, maxRetryCount, waitsForConnectivity etc.

func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool {

    Restofire.Configuration.default.host = "httpbin.org"
    Restofire.Retry.default.retryErrorCodes = [.requestTimedOut,.networkConnectionLost]

    return true
}

• Group Configuration – The group configuration inherits all the values from the global configuration. It can be used to group requests that have same behaviour but are different from the global configuration. For instance, If you have more than one host or if your global configuration has default url session and some requests require you to use ephemeral URL session.

import Restofire

protocol ApiaryConfigurable: Configurable {}

extension ApiaryConfigurable {
    public var configuration: Configuration {
        var configuration = Configuration.default
        configuration.host = "private-07c21-rahulkatariya.apiary-mock.com"
        configuration.headers = ["Content-Type": "application/json"]
        return configuration
    }
}

protocol ApiaryRequestable: Requestable, ApiaryConfigurable {}

import Restofire

struct NoteResponseModel: Decodable {
    var id: Int16
    var title: String
}

struct NotesGETService: ApiaryRequestable {
    typealias Response = [NoteResponseModel]
    var path: String? = "notes"
}

• Per Request Configuration – The request configuration inherits all the values from the group configuration or directly from the global configuration.

import Restofire

struct NoteRequestModel: Encodable {
    var title: String
}

struct NotePOSTService: Requestable {
    typealias Response = NoteResponseModel
    let host: String = "private-07c21-rahulkatariya.apiary-mock.com"
    let headers = ["Content-Type": "application/json"]
    let path: String? = "notes"
    let method: HTTPMethod = .post
    var parameters: Any?

    init(parameters: NoteRequestModel) {
        let data = try! JSONEncoder().encode(parameters)
        self.parameters = try! JSONSerialization.jsonObject(with: data, options: .allowFragments)
    }
}

Usage

Making a Request

Requestable gives completion handler to enable making requests and receive response.

import Restofire

class ViewController: UITableViewController {
    var notes: [NoteResponseModel]!
    var requestOp: RequestOperation<NotesGetAllService>!

    override func viewDidLoad() {
        super.viewDidLoad()
        // We want to cancel the request to save resources when the user pops the view controller.
        requestOp = NotesGetAllService().execute() {
            if let value = $0.result.value {
                self.notes = value
            }
        }
    }

    func postNote(title: String) {
        let noteRequestModel = NoteRequestModel(title: title)
        // We don't want to cancel the request even if user pops the view controller.
        NotePOSTService(parameters: noteRequestModel).execute()
    }

    deinit {
        requestOp.cancel()
    }
}

Isolating Network Requests from UIViewControllers

Requestable gives delegate methods to enable making requests from anywhere which you can use to store data in your cache.

import Restofire

struct NotesGetAllService: ApiaryRequestable {
    ...

    func request(_ request: RequestOperation<NotesGetAllService>, didCompleteWithValue value: [NoteResponseModel]) {
      // Here you can store the results into your cache and then listen for changes inside your view controller.
    }
}

Custom Response Serializers

• Decodable

By adding the following snippet in your project, All Requestable associatedType Response as Decodable will be decoded with JSONDecoder.

import Restofire

extension Restofire.DataResponseSerializable where Response: Decodable {
    public var responseSerializer: DataResponseSerializer<Response> {
        return DataRequest.JSONDecodableResponseSerializer()
    }
}

• JSON

By adding the following snippet in your project, All Requestable associatedType Response as Any will be decoded with NSJSONSerialization.

import Restofire

extension Restofire.DataResponseSerializable where Response == Any {
    public var responseSerializer: DataResponseSerializer<Response> {
        return DataRequest.jsonResponseSerializer()
    }
}

Wait for Internet Connectivity

Requestable gives you a property waitsForConnectivity which can be set to true. This will make the first request regardless of the internet connectivity. If the request fails due to .notConnectedToInternet, it will retry the request when internet connection is established.

struct PushTokenPutService: Requestable {

    typealias Response = Data
    ...
    var waitsForConnectivity: Bool = true

}

Contributing

Issues and pull requests are welcome!

Author

Rahul Katariya @rahulkatariya91

License

Restofire is released under the MIT license. See LICENSE for details.