Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
JavaScript implimentation of the OAuth protocol. Currently supports version 1.0 (RFC5849) of the specification. CommonJS compatable
JavaScript
tree: e2076046b5

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
build
spec
src
.gitignore
.gitmodules
LICENCE
Makefile
README.md
Version

README.md

jsOAuth - JavaScript OAuth library

jsOAuth is a javascript library implimenting the OAuth protocol. jsOAuth aims to form the basis of custom clients such as Twitter and Yahoo.

Written in JavaScript, jsOAuth aims to be a fully featured open source OAuth library for use in Adobe AIR, Appcelerator Titanium and PhoneGAP. In fact, anywhere that javascript can be used and has cross-domain XMLHttpRequests.

Features

Core

  • Single authorisation entry-point
  • Debug mode for testing localy in Firefox, see index.html for example

Released under the MIT. Please see LICENSE in the project root folder for more information.

Usage

Download the minified library and include it in your html.

<script type="text/javascript" src="library/jsOAuth-0.7.5.1.min.js"></script>

This gives you a global OAuth object for you to set up and make requests with. Setting it up is simple.

<script type="text/javascript">
    var oauth, options;

    options = {
        enablePrivilege: true,
        consumerKey: 'ba9df9055c77f338',
        consumerSecret: '846ffe1ec3b18989e73fe7fff833'
    };

    oauth = OAuth(options);
</script>

Note: *EnablePrivilege** lets you test jsOAuth in Firefox*

You'll need to replace the consumer key and secret with your own. Once that is done, you can make your authenticated 2-legged request.

<script type="text/javascript">
    oauth.get('http://oauth-sandbox.sevengoslings.net/two_legged', function (data) {
        alert(data);
    });
</script>

Hopefuly the syntax will look familier to you, if you've any kind of javscript framework such as jQuery.

Please let me know if jsOAuth doesn't work for you or if you're application requires something jsOAuth doesn't currently support. I'm always happy to hear your suggestions. feedback@bytespider.eu

If you like jsOAuth and want to see new features, please donate.

Building

To start developing, clone this repository and initialize the dependent git submodules by executing the following commands:

git submodule init
git submodule update

To build the entire library type make from the command line.

To build just the W3C compatable version, type make jsoauth from the command line. To build just CommonJS/Node.JS compatable module type make commonjs from the command line.

All files are compiled into the dist directory.

To start over once you have already built a copy, type make clean to delete all built distribution files

Issues

Please report all issues on the GitHub issue tracker for jsOauth.

Authors

  • Rob Griffiths (rob AT bytespider DOT eu)
Something went wrong with that request. Please try again.