Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/iamrsalman/dots
Lightweight Concurrent Networking Framework
https://github.com/iamrsalman/dots
carthage cocoapods concurrency iamrsalman ios macos networking swift swift-package-manager tvos watchos xcode
Last synced: about 2 months ago
JSON representation
Lightweight Concurrent Networking Framework
- Host: GitHub
- URL: https://github.com/iamrsalman/dots
- Owner: iAmrSalman
- License: mit
- Created: 2017-04-04T00:42:57.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-04-08T23:34:20.000Z (over 6 years ago)
- Last Synced: 2024-10-13T14:47:15.141Z (2 months ago)
- Topics: carthage, cocoapods, concurrency, iamrsalman, ios, macos, networking, swift, swift-package-manager, tvos, watchos, xcode
- Language: Swift
- Homepage:
- Size: 129 KB
- Stars: 38
- Watchers: 9
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Dots
[](https://travis-ci.org/iAmrSalman/Dots)
[](http://cocoapods.org/pods/Dots)
[](http://cocoapods.org/pods/Dots)
[](http://cocoapods.org/pods/Dots)
## Example
To run the example project, clone the repo, and run `pod install` from the Example directory first.
## Requirements
- iOS 8.0+ / macOS 10.10+ / tvOS 9.0+ / watchOS 2.0+
- Xcode 8.0+
- Swift 4.0+
## Installation
### CocoaPods
[CocoaPods](http://cocoapods.org) is a dependency manager for Cocoa projects. You can install it with the following command:
```bash
$ gem install cocoapods
```
> CocoaPods 1.1+ is required to build StorageManager.
To integrate StorageManager into your Xcode project using CocoaPods, specify it in your `Podfile`:
```ruby
source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '9.0'
use_frameworks!
target '' do
pod 'Dots'
end
```
Then, run the following command:
```bash
$ pod install
```
### Carthage
[Carthage](https://github.com/Carthage/Carthage) is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks.
You can install Carthage with [Homebrew](http://brew.sh/) using the following command:
```bash
$ brew update
$ brew install carthage
```
To integrate StorageManager into your Xcode project using Carthage, specify it in your `Cartfile`:
```ogdl
github "iAmrSalman/Dots" ~> 0.5.0
```
Run `carthage update` to build the framework and drag the built `Dots.framework` into your Xcode project.
### Swift Package Manager
The [Swift Package Manager](https://swift.org/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`.
```swift
dependencies: [
.package(url: "https://github.com/iAmrSalman/Dots.git", from: "0.5.0")
]
```
## Usage
### Making a Request
```swift
import Dots
Dots.defualt.request("") { (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]
}
```
### HTTP Methods
The `HTTPMethod` enumeration lists the HTTP methods:
```swift
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:
```swift
Dots.defualt.request("") // method defaults to `.get`
Dots.defualt.request("", method: .post)
Dots.defualt.request("", method: .put)
Dots.defualt.request("", method: .delete)
```
The `request` method parameter defaults to `.get`.
### Parameter Encoding
#### GET Request With URL-Encoded Parameters
```swift
let parameters: Parameters = ["foo": "bar"]
Dots.defualt.request("", parameters: parameters) // defaults url encoding
Dots.defualt.request("", parameters: parameters, encoding: .url)
// ?foo=bar
```
#### POST Request With URL-Encoded Parameters
```swift
let parameters: Parameters = [
"foo": "bar",
"baz": ["a", 1],
"qux": [
"x": 1,
"y": 2,
"z": 3
]
]
Dots.defualt.request("", method: .post, parameters: parameters) // defaults url encoding
Dots.defualt.request("", 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]=3
```
#### POST Request With JSON-Encoded Parameters
```swift
let parameters: Parameters = [
"foo": [1,2,3],
"bar": [
"baz": "qux"
]
]
Dots.defualt.request("", method: .post, parameters: parameters, encoding: .json)
//HTTP header: Content-Type: application/json
// HTTP body: {"foo": [1, 2, 3], "bar": {"baz": "qux"}}
```
### HTTP Headers
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`.
```swift
let headers: HTTPHeaders = [
"Authorization": "Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==",
"Accept": "application/json"
]
Dots.defualt.request("", headers: headers)
```
### Concurrency
Choosing between Asynchronous and Synchronous is supported
```swift
Dots.defualt.request("", concurrency: .async) // concurrency defaults to `.async`
Dots.defualt.request("", concurrency: .sync)
```
### Maximum concurrent requests
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.
```swift
let customDots = Dots(maxConcurrentOperation: )
customDots.request("")
```
### Extensions
#### UIImageView
```swift
imageView.setImage(withURL: "")
```
## Author
Amr Salman, [email protected]
## License
Dots is available under the MIT license. See the LICENSE file for more info.