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.
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(string: "https://httpbin.org")!
let request = URLRequest(path: "/", baseURL: url)
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
})
struct IPOrigin: Decodable {
let origin: String
}
let url: URL! = URL(string: "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
})
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
})
The following table shows all the protocols and their default implementations.
Protocol | Default Implementation |
---|---|
NetworkAccess |
URLSession |
NetworkService |
BasicNetworkService |
URLRequestConvertible |
URLRequest |
NetworkTask |
URLSessionTask |
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 |
- iOS 9.0+ / macOS 10.10+ / tvOS 9.0+ / watchOS 2.0+
- Xcode 9.0+
- Swift 3.2/Swift4.0
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.0
pod "DBNetworkStack"
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.
Lukas Schmidt (Mail, @lightsprint09), Christian Himmelsbach (Mail)
DBNetworkStack is released under the MIT license. See LICENSE for details.