Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hkellaway/hottpotato
Delicious HTTP requests for iOS :fire: :potato:
https://github.com/hkellaway/hottpotato
http-client http-requests httpclient ios networking potato swift
Last synced: 7 days ago
JSON representation
Delicious HTTP requests for iOS :fire: :potato:
- Host: GitHub
- URL: https://github.com/hkellaway/hottpotato
- Owner: hkellaway
- License: mit
- Created: 2019-05-10T01:54:01.000Z (over 5 years ago)
- Default Branch: develop
- Last Pushed: 2019-07-02T19:28:28.000Z (over 5 years ago)
- Last Synced: 2024-11-09T04:28:56.413Z (2 months ago)
- Topics: http-client, http-requests, httpclient, ios, networking, potato, swift
- Language: Swift
- Homepage:
- Size: 84 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# HottPotato
Delicious HTTP requests :fire: :potato:
I got tired of writing networking code over and over again for side projects, so I made something I could quickly toss in.
## Features
[](http://cocoapods.org/pods/HottPotato)
[](https://github.com/Carthage/Carthage)
[](https://github.com/apple/swift-package-manager)
[](https://travis-ci.org/hkellaway/HottPotato)
* Simple HTTP requests
* Automatic parsing of `Decodable` models
## Getting Started
- [Download HottPotato](https://github.com/hkellaway/HottPotato/archive/master.zip) and do a `pod install` on the included `HottPotatoDemo` app to see it in action
- Check out the [documentation](http://cocoadocs.org/docsets/HottPotato/) for a more comprehensive look at the classes available in HottPotata
### Swift Version
Currently compatible with Swift 5.0.
### Installation with CocoaPods
```ruby
pod 'HottPotato', :git => 'https://github.com/hkellaway/HottPotato.git', :tag => '0.1.0'
```
### Installation with Carthage
```
github "hkellaway/HottPotato"
```
### Installation with Swift Package Manager
``` swift
import PackageDescription
let package = Package(
name: "HelloWorld",
dependencies: [
.Package(url: "https://github.com/hkellaway/HottPotato.git", majorVersion: 0, minor: 1)
]
)
```
## Usage
### Retrieving Models
To make a request, create an `HTTPResource` with a type that is `Decodable` and enjoy receiving the `Result`.
```swift
let httpClient = HottPotato.shared
let resource = HTTPResource(
method: .GET,
baseURL: "https://api.github.com",
path: "/users/hkellaway"
)
httpClient.sendRequest(for: resource) { result in
switch result {
case .success(let profile):
print("Hello world from \(profile.login)")
case .failure(let error):
print("Goodbye world: \(error.localizedDescription)")
}
}
```
### Discussion
HottPotato simply wraps `URLSession` and leverages some preferred context and patterns. Namely, it assumes we're making HTTP requests, we're receiving JSON back, and our requested models conform to`Decodable`. Additionally, it uses the `Result` type in its response.
Why? Because this is a typical setup for applications & libraries I've worked on. Plus, I'm a big fan of the `Result` type.
#### Retrieving JSON
Internally, HottPotato retrieves JSON - if you'd rather use it to retrieve JSON, simply:
```swift
guard let request = resource.toHTTPRequest() else {
return
}
httpClient.sendJSONRequest(with: request, success: { (_, json) in
print(json)
}, failure: { error in
print(error)
})
```
#### Retrieving Raw Data and HTTPURLResponse
At its very heart, HottPotato simply makes a `URLRequest` using `URLSession` and returns the retrieved `Data` and `HTTPURLResponse`. If you'd rather use it to get back the raw response, simply:
```swift
httpClient.sendHTTPRequest(with: request, success: { (_, response) in
print(response.statusCode)
}, failure: { error in
print(error)
})
```
## Credits
HottPotato was created by [Harlan Kellaway](http://harlankellaway.com).
## License
HottPotato is available under the MIT license. See the [LICENSE](https://raw.githubusercontent.com/hkellaway/HottPotato/master/LICENSE) file for more info.