Plug-n-play customizable solution for easily adding Real-Time Personalization to Swift iOS apps. Includes OAuth2, File Selector and App Chain code in a single plugin.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
sequencing-master-plugin-api-swift
.gitignore
LICENSE
README.md
sequencing-master-plugin-api-swift.podspec

README.md

Master CocoaPods Plugin for adding Sequencing.com's Real-Time Personalization technology to iOS apps coded in Swift

This Master CocoaPods Plugin can be used to quickly add Real-Time Personalization to your app. This Master Plugin contains a customizable, end-to-end plug-n-play solution that quickly adds all necessary code (OAuth2, File Selector and App Chain coding) to your app.

Once this Master Plugin is added to your app all you'll need to do is:

  1. add your OAuth2 secret
  2. add one or more App Chain numbers
  3. configure your app based on each app chain's possible responses

To code Real-Time Personalization technology into apps, developers may register for a free account at Sequencing.com. App development with RTP is always free.

The Master Plugin is also available in the following languages:

Master Plugin - Plug-n-Play Samples (This code can be used as an out-of-the-box solution to quickly add Real-Time Personalization technology into your app):

Contents

  • Implementation
  • Master CocoaPods Plugin install
  • Authentication flow
  • OAuth CocoaPods Plugin integration
  • File Selector CocoaPods Plugin integration
  • AppChains CocoaPods Plugin integration
  • Resources
  • Maintainers
  • Contribute

Implementation

To implement this Master Plugin for your app:

  1. Register for a free account

  2. Add this repo's Master Plugin to your app

  3. Generate an OAuth2 secret and insert the secret into the plugin

  4. Add one or more App Chain numbers. The App Chain will provide genetic-based information you can use to personalize your app.

  5. Configure your app based on each app chain's possible responses

Master CocoaPod Plugin install

  • see CocoaPods guides

  • create Podfile in your project directory: $ pod init

  • specify "sequencing-master-plugin-api-objc" pod parameters in Podfile:

    pod 'sequencing-master-plugin-api-swift', '~> 1.3.1'

  • install the dependency in your project: $ pod install

  • always open the Xcode workspace instead of the project file: $ open *.xcworkspace

  • as a result you'll have 3 CocoaPods plugins installed: OAuth, Files Selector and AppChains

Authentication flow

Sequencing.com uses standard OAuth approach which enables applications to obtain limited access to user accounts on an HTTP service from 3rd party applications without exposing the user's password. OAuth acts as an intermediary on behalf of the end user, providing the service with an access token that authorizes specific account information to be shared.

![Authentication sequence diagram] (https://github.com/SequencingDOTcom/oAuth2-code-and-demo/blob/master/screenshots/oauth_activity.png)

Steps

Step 1: Authorization Code Link

First, the user is given an webpage opened by following authorization code link:

https://sequencing.com/oauth2/authorize?redirect_uri=REDIRECT_URL&response_type=code&state=STATE&client_id=CLIENT_ID&scope=SCOPES

Here is an explanation of the link components:

  • https://sequencing.com/oauth2/authorize - the API authorization endpoint
  • redirect_uri=REDIRECT_URL - where the service redirects the user-agent after an authorization code is granted
  • response_type=code - specifies that your application is requesting an authorization code grant
  • state=STATE - holds the random verification code that will be compared with the same code within the server answer in order to verify if response was being spoofed
  • client_id=CLIENT_ID - the application's client ID (how the API identifies the application)
  • scope=CODES specifies the level of access that the application is requesting

login dialog

Step 2: User Authorizes Application

User must first log in to the service, to authenticate their identity (unless they are already logged in). Then they will be prompted by the service to authorize or deny the application access to their account. Here is an example authorize application prompt

grant dialog

Step 3: Application Receives Authorization Code

When user clicks "Authorize Application", the service will open the redirect_URI url address, which was specified during the authorization request. In iOS application following redirect_uri was used:

authapp://Default/Authcallback

As soon as your application detects that redirect_uri page was opened then it should analyse the server response with the state verification code. If the state verification code matches the one was sent in authorization request then it means that the server response is valid. Now we can get the authorization code form the server response.

Step 4: Application Requests Access Token

The application requests an access token from the API, by passing the authorization code (got from server response above) along with authentication details, including the client secret, to the API token endpoint. Here is an example POST request to Sequencing.com token endpoint:

https://sequencing.com/oauth2/token

Following POST parameters have to be sent

  • grant_type='authorization_code'
  • code=AUTHORIZATION_CODE (where AUTHORIZATION_CODE is a code acquired in a "code" parameter in the result of redirect from sequencing.com)
  • redirect_uri=REDIRECT_URL (where REDIRECT_URL is the same URL as the one used in step 1)

Step 5: Application Receives Access Token

If the authorization is valid, the API will send a JSON response containing the token object to the application. Token object contains accessToken, its expirationDate, tokenType, scope and refreshToken.

OAuth CocoaPod Plugin integration

See OAuth CocoaPod Plugin documentation (Swift)

File Selector CocoaPod Plugin integration

See File Selector CocoaPod Plugin documentation (Swift)

AppChains CocoaPod Plugin integration

See AppChains CocoaPod Plugin documentation (Swift)

Resources

Maintainers

This repo is actively maintained by Sequencing.com. Email the Sequencing.com bioinformatics team at gittaca@sequencing.com if you require any more information or just to say hola.

Contribute

We encourage you to passionately fork us. If interested in updating the master branch, please send us a pull request. If the changes contribute positively, we'll let it ride.