Restofire: A Protocol Oriented Networking Abstraction Layer in Swift

Restofire

Platforms License

Swift Package Manager Carthage compatible CocoaPods compatible

Travis

Join the chat at https://gitter.im/Restofire/Restofire Twitter

Restofire is a protocol oriented network abstraction layer in swift that is built on top of Alamofire to use services in a declartive way.

Features

  • [x] No Learning Curve
  • [x] Default Configuration for Base URL / headers / parameters etc
  • [x] Multiple Configurations
  • [x] Single Request Configuration
  • [x] Custom Response Serializers
  • [x] JSONDecodable
  • [x] Authentication
  • [x] Response Validations
  • [x] Request NSOperation
  • [x] Request eventually when internet is reachable
  • [x] Complete Documentation

Requirements

  • iOS 8.0+ / Mac OS X 10.10+ / tvOS 9.0+ / watchOS 2.0+
  • Xcode 8+
  • Swift 3.1+

Installation

CocoaPods

CocoaPods is a dependency manager for Cocoa projects. You can install it with the following command:

$ gem install cocoapods

To integrate Restofire into your Xcode project using CocoaPods, specify it in your Podfile:

source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '8.0'
use_frameworks!

pod 'Restofire', '~> 3.0.0'

Then, run the following command:

$ pod install

Carthage

Carthage is a decentralized dependency manager that automates the process of adding frameworks to your Cocoa application.

You can install Carthage with Homebrew using the following command:

$ brew update
$ brew install carthage

To integrate Restofire into your Xcode project using Carthage, specify it in your Cartfile:

github "Restofire/Restofire" ~> 3.0.0

Swift Package Manager

To use Restofire as a Swift Package Manager package just add the following in your Package.swift file.

import PackageDescription

let package = Package(
    name: "HelloRestofire",
    dependencies: [
        .Package(url: "https://github.com/Restofire/Restofire.git", .upToNextMajor(from: "3.0.0"))
    ]
)

Manually

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

Git Submodules

  • Open up Terminal, cd into your top-level project directory, and run the following command if your project is not initialized as a git repository:
$ git init
  • Add Restofire as a git submodule by running the following command:
$ git submodule add https://github.com/Restofire/Restofire.git
$ git submodule update --init --recursive
  • Open the new Restofire folder, and drag the Restofire.xcodeproj into the Project Navigator of your application’s Xcode project.

    It should appear nested underneath your application’s blue project icon. Whether it is above or below all the other Xcode groups does not matter.

  • Select the Restofire.xcodeproj in the Project Navigator and verify the deployment target matches that of your application target.

  • Next, select your application project in the Project Navigator (blue project icon) to navigate to the target configuration window and select the application target under the Targets heading in the sidebar.

  • In the tab bar at the top of that window, open the General panel.

  • Click on the + button under the Embedded Binaries section.

  • You will see two different Restofire.xcodeproj folders each with two different versions of the Restofire.framework nested inside a Products folder.

    It does not matter which Products folder you choose from.

  • Select the Restofire.framework & Alamofire.framework.

  • And that’s it!

The Restofire.framework is automagically added as a target dependency, linked framework and embedded framework in a copy files build phase which is all you need to build on the simulator and a device.

Embeded Binaries

  • Download the latest release from https://github.com/Restofire/Restofire/releases
  • Next, select your application project in the Project Navigator (blue project icon) to navigate to the target configuration window and select the application target under the Targets heading in the sidebar.
  • In the tab bar at the top of that window, open the General panel.
  • Click on the + button under the Embedded Binaries section.
  • Add the downloaded Restofire.framework & Alamofire.framework.
  • And that’s it!

Usage

Global Configuration

import Restofire

class AppDelegate: UIResponder, UIApplicationDelegate {

    func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool {
        // Override point for customization after application launch.

        Restofire.Configuration.default.host = "httpbin.org"

        return true
  }

}

Restofire with JSONDecodable Response Serializer

import Restofire

extension Restofire.DataResponseSerializable where Response: Decodable {

    public var responseSerializer: DataResponseSerializer<Response> {
        return DataRequest.JSONDecodableResponseSerializer()
    }

}

extension Restofire.DownloadResponseSerializable where Response: Decodable {

    public var responseSerializer: DownloadResponseSerializer<Response> {
        return DownloadRequest.JSONDecodableResponseSerializer()
    }

}

Creating a Service

import Restofire

struct HTTPBin: Decodable {
    var url: URL
}

struct HTTPBinGETService: Requestable {

    typealias Response = HTTPBin
    var path: String? = "get"

    func request(_ request: DataRequest, didCompleteWithValue value: HTTPBin) {
        // Use this place to store your output to a cache.
        print(value.url.absoluteString) // "https://httpbin.org/get"
    }
}

Group Level Configuration

protocol MockyConfigurable: Configurable {}

extension MockyConfigurable {

    public var configuration: Restofire.Configuration {
        var mockyConfiguration = Restofire.Configuration()
        mockyConfiguration.scheme = "http://"
        mockyConfiguration.host = "mocky.io"
        mockyConfiguration.version = "v2"
        return mockyConfiguration
    }

}

protocol MockyValidatable: Validatable { }

extension MockyValidatable {

    var validation: Validation {
        var validation = Validation()
        validation.acceptableStatusCodes = Array(200..<300)
        validation.acceptableContentTypes = ["application/json"]
        return validation
    }

}

protocol MockyRequestable: Requestable, MockyConfigurable, MockyValidatable {}

Creating the Service


import Restofire

struct MockyGETService: MockyRequestable {

    typealias Response = Any
    let path: String = "get"
    var parameters: Any?

    init(parameters: Any?) {
        self.parameters = parameters
    }

}

Request Level Configuration

import Restofire

struct MoviesReviewGETService: Requestable {

    var scheme: String = "http://"
    var host: String = "api.nytimes.com/svc/movies"
    var version: String = "v2"
    var path: String? = "reviews"
    var parameters: Any?
    var queue: DispatchQueue? = DispatchQueue.main
    var credential: URLCredential? = URLCredential(user: "user", password: "password", persistence: .forSession)
    var retryErrorCodes: Set<URLError.Code> = [.timedOut,.networkConnectionLost]

    init(path: String, parameters: Any) {
        self.path += path
        self.parameters = parameters
    }

}

Consuming the Service

import Restofire

class ViewController: UIViewController {

    var person: [String: Any]!
    var requestOp: RequestOperation<HTTPBinPersonGETService>!

    func getPerson() {
        requestOp = MockyGETService(parameters: ["name": "Rahul Katariya"])
            .response() {
            if let value = $0.result.value {
                self.person = value
            }
        }
    }

    deinit {
        requestOp.cancel()
    }

}

License

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