| 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
- Apache Cordova Whitelist Plugin
- jsSHA Secure Hash Library (Twitter, Withings, and Magento only)
Installing ngCordovaOauth Into Your Project
Bower way:
Add this repository as dependency:
$ bower install ng-cordova-oauth -S
This action will set the dependency and add it to the bower.json file.
The JavaScript library must then be added to your index.html file found in your projects www directory:
<script src="../ng-cordova-oauth/ng-cordova-oauth.min.js"></script>
Outdated way:
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>
Injecting:
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, object options);
$cordovaOauth.digitalOcean(string clientId, string clientSecret);
$cordovaOauth.google(string clientId, array appScope, object options);
$cordovaOauth.github(string clientId, string clientSecret, array appScope);
$cordovaOauth.facebook(string clientId, array appScope, object options);
$cordovaOauth.linkedin(string clientId, string clientSecret, array appScope, string state);
$cordovaOauth.instagram(string clientId, array appScope, object options);
$cordovaOauth.box(string clientId, string clientSecret, string state);
$cordovaOauth.reddit(string clientId, string clientSecret, array appScope);
$cordovaOauth.twitter(string consumerKey, string consumerSecretKey, object options);
$cordovaOauth.meetup(string consumerKey, object options);
$cordovaOauth.salesforce(string loginUrl, string clientId);
$cordovaOauth.strava(string clientId, string clientSecret, array appScope);
$cordovaOauth.withings(string clientId, string clientSecret);
$cordovaOauth.foursquare(string clientId, object options);
$cordovaOauth.magento(string baseUrl, string clientId, string clientSecret)
$cordovaOauth.vkontakte(string clientId, array appScope)
$cordovaOauth.adfs(string clientId, string adfsServer, string relyingPartyId)
$cordovaOauth.imgur(string clientId, object options)
$cordovaOauth.spotify(string clientId, array appScope, object options)
$cordovaOauth.uber(string clientId, array appScope, object options)
$cordovaOauth.windowsLive(string clientId, array appScope, object options)
$cordovaOauth.yammer(string clientId, object options)
$cordovaOauth.venmo(string clientId, array appScope, object options)
$cordovaOauth.stripe(string clientId, string clientSecret, string appScope, object options)
$cordovaOauth.rally(string clientId, string clientSecret, string appScope, object options)
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.
As of Apache Cordova 5.0.0, the whitelist plugin must be used in order to reach external web services.
This library will NOT work with a web browser, ionic serve, or ionic view. It must be used via installing to a device or simulator.
Version History
Contribution Rules
All contributions must be made via the development branch. This keeps the project more maintainable in terms of versioning as well as code control.
Have a question or found a bug (compliments work too)?
Tweet me on Twitter - @nraboy
Resources
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
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent