Master CocoaPod Plugin for adding Sequencing.com's Real-Time Personalization technology to iOS apps coded in Objective-C
This Master CocoaPod 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:
- add your OAuth2 secret
- add one or more App Chain numbers
- 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:
- Objective-C (CocoaPod plugin) <-- this repo
- Swift (CocoaPod plugin)
- Android (Maven plugin)
- Java (Maven plugin)
- C#/.NET (Nuget for Visual Studio)
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):
- Objective-C (CocoaPod) Plug-n-Play Sample
- Swift (CocoaPod) Plug-n-Play Sample
- Android (Maven) Plug-n-Play Sample
- Implementation
- Master CocoaPod Plugin install
- Authentication flow
- OAuth CocoaPod Plugin integration
- File Selector CocoaPod Plugin integration
- AppChains CocoaPod Plugin integration
- Resources
- Maintainers
- Contribute
To implement this Master Plugin for your app:
-
Register for a free account
-
Add this Master Plugin to your app
-
Generate an OAuth2 secret and insert the secret into the plugin
-
Add one or more App Chain numbers. The App Chain will provide genetic-based information you can use to personalize your app.
-
Configure your app based on each app chain's possible responses
-
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-objc', '~> 1.4.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 CocoaPod plugins installed: OAuth, Files Selector and AppChains
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)
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 endpointredirect_uri=REDIRECT_URL- where the service redirects the user-agent after an authorization code is grantedresponse_type=code- specifies that your application is requesting an authorization code grantstate=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 spoofedclient_id=CLIENT_ID- the application's client ID (how the API identifies the application)scope=CODESspecifies the level of access that the application is requesting
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
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.
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)
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.
See OAuth CocoaPod Plugin documentation (ObjC)
See File Selector CocoaPod Plugin documentation (ObjC)
See AppChains CocoaPod Plugin documentation (ObjC)
This repo is actively maintained by Sequencing.com. Email the Sequencing.com bioinformatics team at [email protected] if you require any more information or just to say hola.
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.