| Master | Development |
|---|---|
 |
 |
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.
- Apache Cordova 3.5+
- Apache Cordova InAppBrowser Plugin
- jsSHA Secure Hash Library (Twitter, Withings, and Magento only)
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.
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);
$cordovaOauth.salesforce(string loginUrl, string clientId);
$cordovaOauth.strava(string clientId, string clientSecret, array appScope);
$cordovaOauth.withings(string clientId, string clientSecret);
$cordovaOauth.foursquare(string clientId);
$cordovaOauth.magento(string baseUrl, string clientId, string clientSecret)
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", ["email"]).then(function(result) {
console.log("Response Object -> " + JSON.stringify(result));
}, function(error) {
console.log("Error -> " + error);
});
To authenticate with Twitter, Withings, and Magento an additional library is required. These services require HMAC-SHA1 signatures in their Oauth implementation. Including the sha1.js component of jsSHA will accomplish this task.
Email me via my website - http://www.nraboy.com
Tweet me on Twitter - @nraboy
Ionic Framework - http://www.ionicframework.com
AngularJS - http://www.angularjs.org
Apache Cordova - http://cordova.apache.org
Nic Raboy's Code Blog - https://blog.nraboy.com