Finally! A Festivus for the Restivus!
Yes, it's true, this library is named after the infamous Festivus Seinfeld episode. I had no choice, as my initial name, RestEasy, was already taken by the JBoss Community, and I don't wanna mess with them.
Restivus is a mostly protocol based approach to creating structured HTTP requests and responses. It's simple, easy, and is built around Swift 4's Codable protocol.
I do not currently support CocoaPods because, frankly, I hate it. If there's enough demand I might change my mind. In the interim I recommend using Carthage, as it doesn't take over your workspace.
-
In your cartfile simply add the following
github "ryanbaldwin/Restivus" == 0.4.3 -
Run a
carthage update -
Add the framework to your project, as defined here
- Clone the repo
- Open in Xcode 9
- Build it
- Celebrate
- Go for nachos
- Keep eating nachos
- If you do not hate yourself yet, repeat step 6
- Sleepy time
Get the contents of the Google homepage as raw data:
struct GoogleHomepageRequest: Gettable {
typealias ResponseType = Raw
var url: URL? {
return URL(string: "https://www.google.com")
}
}
let runningTask = try? GoogleHomepageRequest().submit { result in
if case let Result.success(data) = result {
print(String(data: data, encoding: .utf8))
}
}Submit a login request which, upon success, returns the authenticated user JSON in the response, something like the following:
{
"name": "Ryan Baldwin",
"age": 38,
"sex": "male"
}struct User: Codable {
enum Sex: String, Codable {
case male, female
}
var name: String
var age: Int
var sex: Sex
}
struct LoginRequest: Encodable {
var username: String
var password: String
}
extension LoginRequest: Postable {
// Tells Restivus to deserialize the response into the User struct we define above
typealias ResponseType = User
var url: URL? {
return URL(string: "https://my.awesome-app.com/login")
}
}
_ = try? LoginRequest(username: "rbaldwin", password: "insecure").submit() { result in
if case let Result.success(user) = result {
print("\(user.name) (\(user.sex)) is \(user.age) years young, and looking mighty fine.")
}
}Submit a request against a protected endpoint:
struct UpdateUserRequest: Encodable {
var user: User
}
extension UpdateUserRequest: Postable {
typealias ResponseType = User
var url: URL? = {
URL(string: "https://my.awesome-app.com/user/\(self.user.name)")
}
}
/// Sign this request by putting some token in the "Authorization" header
/// This function comes from the `Interceptable` protocol
extension UpdateUserRequest: Interceptable {
func intercept(request: URLRequest) -> URLRequest {
var req = request
req.setValue("Token I_AM_KING", forHTTPHeaderField: "Authorization")
return req
}
}
let userForUpdate = User(name: "Ryan Baldwin", age: 39, sex: .male)
_ = try? UpdateUserRequest(user: userForUpdate).submit() { result in
if case let Result.success(updatedUser) = result {
print("\(user.name) is now a \(user.age) year old \(user.sex)")
}
}The above POSTs the JSON encoded userForUpdate to the server as the following:
{ "user": {"name": "Ryan Baldwin",
"age": 39,
"sex": "male"}}If you don't like that serialization you can implement the Swift.Encodable's encode function to dictate what the serialized structure should look like. For example, maybe we want to get rid of the "user" key and have just the User object serialized in the request:
struct UpdateUserRequest: Encodable {
var user: User
func encode(to encoder: Encoder) throws {
var container = encoder.singleValueContainer()
container.encode(self.user)
}
}The above yields the following JSON:
{
"name": "Ryan Baldwin",
"age": 39,
"sex": "male"
}Examples, tutorials, whatevers will be posted at Restivus' GH Pages site. There, you can also find the official library documentation.
If you're new to Swift 4 and it's Codable protocols, I suggest you take a look at the following articles: