rakesh-mohanta / ng-cordova-oauth

AngularJS oauth library for use with Apache Cordova projects

Master	Development

ngCordovaOauth

ngCordovaOauth is an AngularJS Apache Cordova Oauth library. The purpose of this library is to quickly and easily obtain an access token from various web services to use their APIs.

Requirements

• Apache Cordova 3.5+
• Apache Cordova InAppBrowser Plugin
• jsSHA Secure Hash Library (Twitter only)

Installing ngCordovaOauth Into Your Project

Copy the following file from this repository to your Apache Cordova project:

$ cd ng-cordova-oauth
$ cp ng-cordova-oauth.js /path/to/project/www/js/ng-cordova-oauth.min.js

The JavaScript library must then be added to your index.html file found in your projects www directory:

<script src="js/ng-cordova-oauth.min.js"></script>

Once added to your index.html file, you must inject the library into your app.js module. Make your app.js file look something like the following:

angular.module('starter', ['ionic', 'ngCordovaOauth'])

At this point, ngCordovaOauth is installed into your project and is ready for use.

Using ngCordovaOauth In Your Project

Each web service API acts independently in this library. However, when configuring each web service, one thing must remain consistent. You must use http://localhost/callback as your callback / redirect URI. This is because this library will perform tasks when this URL is found.

$cordovaOauth.dropbox(string appKey);
$cordovaOauth.digitalOcean(string clientId, string clientSecret);
$cordovaOauth.google(string clientId, array appScope);
$cordovaOauth.github(string clientId, string clientSecret, array appScope);
$cordovaOauth.facebook(string clientId, array appScope);
$cordovaOauth.linkedin(string clientId, string clientSecret, array appScope, string state);
$cordovaOauth.instagram(string clientId, array appScope);
$cordovaOauth.box(string clientId, string clientSecret, string state);
$cordovaOauth.reddit(string clientId, string clientSecret, array appScope);
$cordovaOauth.twitter(string consumerKey, string consumerSecretKey);
$cordovaOauth.meetup(string consumerKey);

Each API call returns a promise. The success callback will provide a response object and the error callback will return a string.

$cordovaOauth.google("CLIENT_ID_HERE", ["https://www.googleapis.com/auth/userinfo.email"]).then(function(result) {
    console.log("Response Object -> " + JSON.stringify(result));
}, function(error) {
    console.log("Error -> " + error);
});

To authenticate with Twitter an additional library is required. Twitter requires HMAC-SHA1 signatures in their Oauth implementation. Including the sha1.js component of jsSHA will accomplish this task.

Version History

0.0.4 - November 22, 2014

• Add Meetup support

0.0.3 - November 20, 2014

• Add Twitter support
• Check if InAppBrowser is installed

0.0.2 - November 4, 2014

• Add LinkedIn support
• Add Instagram support
• Add Box support
• Add Reddit support
• Use implicit grant for Google service

0.0.1 - October 20, 2014

• Add Digital Ocean support
• Add Dropbox support
• Add Google support
• Add GitHub support
• Add Facebook support

Have a question or found a bug (compliments work too)?

Email me via my website - http://www.nraboy.com

Tweet me on Twitter - @nraboy

Resources

Ionic Framework - http://www.ionicframework.com

AngularJS - http://www.angularjs.org

Apache Cordova - http://cordova.apache.org