Latest 0.3
Homepage https://github.com/MataDesigns/KeyprApi-iOS
License MIT
Platforms ios 9.0
Frameworks Foundation
Authors

KeyprApi – (Unofficial)

CI Status
Version
License
Platform

KeyprApi is wrapper for Keypr endpoints.

Requirements

  • iOS 9.0+

Installation

Cocoapods

KeyprApi is available through CocoaPods. To install
it, simply add the following line to your Podfile:

pod "KeyprApi"

Carthage

To install it, simple add the following line to your Cartfile

github "MataDesigns/KeyprApi-iOS"

Features

  • Support Authentication Flows
    • ✅ Federated Id
    • ✅ Automatic handling of expired JWT and access token.
    • 🚫 OAuth
  • ✅ Get Reservations for user
  • ✅ Check-in/out of a reservation
  • ✅ Lookup Reservation by Id
  • 🔜 Lookup Reservation by confirmation code and last name

Usage

Intro (Federated)

Understanding JWT

JWT or JSON Web Token is a compact and self-contained way for securely transmitting information between parties as a JSON object.
This information can be verified and trusted because it is digitally signed.

In the case of Keypr’s federated flow it is used if you want to use a 3rd party system as an identity provider.

Keypr requires JWT to use the RS256 algorithm for signing.

JWT payload must contain at least the following:

  • iss – this field identifies what system JWT is generated by. Public key is associated with this URI.
  • exp – a token expiration time in NumericDate format. This is a JSON numeric value representing the number of seconds from 1970-01-01T00:00:00Z UTC until the specified UTC date/time, ignoring leap seconds.
  • given_name – user’s first name
  • family_name – user’s last name
  • email – user’s email address

Learn more about JWTs here

Getting Started

JWT should be generated server side, because of this a required constructor parameter is a JWTGenerator.
The generator will be called when jwt is empty or when it is expired so this should always result in a valid JWT.

Keypr currently has two environments staging and production.

import KeyprApi

func getJWTFromServer(gotJWT: (String)-> Void)) {
  contactYourServerForJWT() { response in
    gotJWT(response.jwt)
  }
}

...

let api = KeyprApi(jwtGenerator: self.getJWTFromServer, environment: .staging)

Checking In/Out of Reservation

All in One Solution

This solution performs a keypr async task for you, with a timeout.

i.e. Calls /async_(check_in or check_out) then calls task/(taskId from /async call) until a success, failure, or timeout happens.

let api = KeyprApi(jwtGenerator: self.getJWTFromServer, environment: .staging)
let reservationId = // use api to get reservation

api.perform(task: .checkIn, reservationId: reservationId, timeout: 10) { (successful, task, error) in
    print(successful)
}
Start async task process

Unless you know what you are doing use the "All in One Solution" ABOVE ⬆️

This will only start a check-in/check-out this will not inform you if the process has completed successful or not. You will have to check that will the check(taskId:) function.

let api = KeyprApi(jwtGenerator: self.getJWTFromServer, environment: .staging)
let reservationId = // use api to get reservation.

api.start(task: .checkIn, reservationId: reservationId) { (task, error) in
    print("TaskId: (task.id)")
}
Check async task

Unless you know what you are doing use the "All in One Solution" ABOVE ⬆️

This is used to check on an async task using taskId gotten from start(task:) function.

let taskId = // Some task id.

api.check(taskId: taskId) { (task, error) in
    if task.attributes.successful {
        print("Woohoo Checked In!!")
    }
    if task.attributes.failed {
        print("Oops something went wrong...")
    }
    if task.attributes.status == "PENDING" {
        // check again
    }
}

More examples to come …

(Look at tests for now)

Author

Nicholas Mata, [email protected]

License

KeyprApi is available under the MIT license. See the LICENSE file for more info.

Latest podspec

{
    "name": "KeyprApi",
    "version": "0.3",
    "summary": "A wrapper for KEYPR Api",
    "description": "A wrapper for KEYPR Api for things like looking up reservations, check-in, and check-out.",
    "homepage": "https://github.com/MataDesigns/KeyprApi-iOS",
    "license": {
        "type": "MIT",
        "file": "LICENSE"
    },
    "authors": {
        "Nicholas Mata": "[email protected]"
    },
    "source": {
        "git": "https://github.com/MataDesigns/KeyprApi-iOS.git",
        "tag": "0.3"
    },
    "platforms": {
        "ios": "9.0"
    },
    "source_files": "KeyprApi/**/*",
    "exclude_files": "KeyprApi/*.plist",
    "frameworks": "Foundation"
}

Pin It on Pinterest

Share This