To run the example project, clone the repo, and run pod install from the Example directory first.
- iOS 8.0+ / macOS 10.10+ / tvOS 9.0+ / watchOS 2.0+
- Xcode 8.0+
- Swift 4.0+
CocoaPods is a dependency manager for Cocoa projects. You can install it with the following command:
$ gem install cocoapodsCocoaPods 1.1+ is required to build StorageManager.
To integrate StorageManager into your Xcode project using CocoaPods, specify it in your Podfile:
source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '9.0'
use_frameworks!
target '<Your Target Name>' do
pod 'Dots'
endThen, run the following command:
$ pod installCarthage is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks.
You can install Carthage with Homebrew using the following command:
$ brew update
$ brew install carthageTo integrate StorageManager into your Xcode project using Carthage, specify it in your Cartfile:
github "iAmrSalman/Dots" ~> 0.5.0
Run carthage update to build the framework and drag the built Dots.framework into your Xcode project.
The Swift Package Manager is a tool for automating the distribution of Swift code and is integrated into the swift compiler. It is in early development, but StorageManager does support its use on supported platforms.
Once you have your Swift package set up, adding StorageManager as a dependency is as easy as adding it to the dependencies value of your Package.swift.
dependencies: [
.package(url: "https://github.com/iAmrSalman/Dots.git", from: "0.5.0")
]import Dots
Dots.defualt.request("<URL>") { (dot: Dot) in
print(dot.response) // HTTP URL response
print(dot.data) // server data
print(dot.error) // Errors from request processing
print(dot.json) // JSON dictionary [String: Any]
}The HTTPMethod enumeration lists the HTTP methods:
public enum HTTPMethod: String {
case options = "OPTIONS"
case get = "GET"
case head = "HEAD"
case post = "POST"
case put = "PUT"
case patch = "PATCH"
case delete = "DELETE"
case trace = "TRACE"
case connect = "CONNECT"
}These values can be passed as the method argument to the request Function:
Dots.defualt.request("<URL>") // method defaults to `.get`
Dots.defualt.request("<URL>", method: .post)
Dots.defualt.request("<URL>", method: .put)
Dots.defualt.request("<URL>", method: .delete)The request method parameter defaults to .get.
let parameters: Parameters = ["foo": "bar"]
Dots.defualt.request("<URL>", parameters: parameters) // defaults url encoding
Dots.defualt.request("<URL>", parameters: parameters, encoding: .url)
// <URL>?foo=barlet parameters: Parameters = [
"foo": "bar",
"baz": ["a", 1],
"qux": [
"x": 1,
"y": 2,
"z": 3
]
]
Dots.defualt.request("<URL>", method: .post, parameters: parameters) // defaults url encoding
Dots.defualt.request("<URL>", method: .post, parameters: parameters, encoding: .url)
//httpHeader: Content-Type: application/x-www-form-urlencoded; charset=utf-8
// HTTP body: foo=bar&baz[]=a&baz[]=1&qux[x]=1&qux[y]=2&qux[z]=3let parameters: Parameters = [
"foo": [1,2,3],
"bar": [
"baz": "qux"
]
]
Dots.defualt.request("<URL>", method: .post, parameters: parameters, encoding: .json)
//HTTP header: Content-Type: application/json
// HTTP body: {"foo": [1, 2, 3], "bar": {"baz": "qux"}}Adding a custom HTTP header to a Request is supported directly in the global request method. This makes it easy to attach HTTP headers to a Request.
let headers: HTTPHeaders = [
"Authorization": "Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==",
"Accept": "application/json"
]
Dots.defualt.request("<URL>", headers: headers)Choosing between Asynchronous and Synchronous is supported
Dots.defualt.request("<URL>", concurrency: .async) // concurrency defaults to `.async`
Dots.defualt.request("<URL>", concurrency: .sync)Customizing Maximum concurrent requests executing simultaneously is supported.
The defualt is checking if device is on cellular connection, maximum concurrent requests is restricted to 2, while Wi-Fi is executing up to 6 simultaneous requests.
let customDots = Dots(maxConcurrentOperation: <Int>)
customDots.request("<URL>") imageView.setImage(withURL: "<URL>")Amr Salman, iamrsalman@gmail.com
Dots is available under the MIT license. See the LICENSE file for more info.