DBNetworkStack is a network abstraction for fetching request and mapping them to model objects
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
DBNetworkStack.xcodeproj
DBNetworkStack.xcworkspace
JSONExample.playground
SimpleDemo.playground
Source
Tests
.gitignore
.hound.yml
.swift-version
.swiftlint.yml
.travis.yml
DBNetworkStack.podspec
LICENSE Adds license file Oct 18, 2016
Package.swift
README.md
codecov.yml

README.md

DBNetworkStack

Build Status codebeat badge codecov Carthage Compatible Swift Package Manager compatible Version

Main Features
🛡 Typed network resources
🏠 Value oriented architecture
🔀 Exchangeable implementations
🚄 Extendable API
🎹        Composable Features          
Fully unit tested
📕  Documented here           

The idea behind this project comes from this talk.objc.io article.

Basic Demo

Lets say you want to fetch a html string.

First you have to create a service, by providing a network access. You can use URLSession out of the box or provide your own custom solution by implementing NetworkAccess.

let networkAccess = URLSession(configuration: .default)
let networkService = BasicNetworkService(networkAccess: networkAccess)

Create a resource with a request to fetch your data.

let url = URL(staticString: "https://httpbin.org")
let request = URLRequest(path: "/", baseURL: url, HTTPMethod: .GET)
let resource = Resource(request: request, parse: { String(data: $0, encoding: .utf8) })

Request your resource and handle the result

networkService.request(resource, onCompletion: { htmlText in
    print(htmlText)
}, onError: { error in
    //Handle errors
})

Load types conforming to Swift-Decodable

struct IPOrigin: Decodable {
    let origin: String
}

let url = URL(staticString: "https://www.httpbin.org")
let request = URLRequest(path: "ip", baseURL: url)

let resource = Resource<IPOrigin>(request: request, decoder: JSONDecoder())

networkService.request(resource, onCompletion: { origin in
    print(origin)
}, onError: { error in
    //Handle errors
})

Accessing HTTPResponse

Request your resource and handle the result & http response. This is similar to just requesting a resulting model.

networkService.request(resource, onCompletionWithResponse: { origin, response in
    print(origin, response)
}, onError: { error in
    //Handle errors
})

Protocol oriented architecture / Exchangability

The following table shows all the protocols and their default implementations.

Protocol Default Implementation
NetworkAccess URLSession
NetworkService BasicNetworkService
URLRequestConvertible URLRequest
NetworkTask URLSessionTask

Composable Features

Class Feature
RetryNetworkService Retrys requests after a given delay when an error meets given criteria.
ModifyRequestNetworkService Modify matching requests. Can be used to add auth tokens or API Keys

Requirements

  • iOS 9.0+ / macOS 10.10+ / tvOS 9.0+ / watchOS 2.0+
  • Xcode 9.0+
  • Swift 3.2/Swift4.0

Installation

Carthage

Carthage is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks.

Specify the following in your Cartfile:

github "dbsystel/dbnetworkstack" ~> 1.2

CocoaPods

pod "DBNetworkStack"

Contributing

Feel free to submit a pull request with new features, improvements on tests or documentation and bug fixes. Keep in mind that we welcome code that is well tested and documented.

Contact

Lukas Schmidt (Mail, @lightsprint09), Christian Himmelsbach (Mail)

License

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