Released under the MIT. Please see LICENSE in the project root folder for more information.
Find the API reference and tutorials on the Documentation site. For recipes on ways to get things working with jsOAuth, try the recipes page. If you need more help or discussion, try the Google jsOAuth Group.
Download the minified library from the distribution directory and include it in your html.
This gives you a global OAuth object for you to set up and make requests with. Setting it up is simple.
Note: *EnablePrivilege** lets you test jsOAuth in Firefox 3, Firefox >= 5 doesn't work*
You can test in chrome using the following commandline on OSX
/Applications/Google\ Chrome.app/Contents/MacOS/Google\ Chrome --disable-web-security --allow-file-access-from-files --allow-file-access --user-data-dir=~/chrome-test/ spec/runner.html
On Ubuntu try
/opt/google/chrome/google-chrome --disable-web-security --allow-file-access-from-files --allow-file-access --user-data-dir=~/chrome-test/ spec/runner.html
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.
Hopefully the syntax will look familier to you, if you've used any kind of javscript framework such as jQuery.
On Node you'll need to install the XHR module with
npm install xhr
Please let me know if jsOAuth doesn't work for you or if your application requires something jsOAuth doesn't currently support. I'm always happy to hear your suggestions. email@example.com
If you like jsOAuth and want to see new features, please donate.
Further reading and tutorials
- Tutorial: Titanium & jsOAuth - Part 1
- Tutorial: Titanium & jsOAuth - Part 2
- Tutotial: Twitter: jsOAuth and Child Browser plugin: non-PIN OAuth access!
- Snippet: A simple example of PIN-based oauth flow with Twitter and jsOAuth by @funkatron
- Snippet: How to upload files using jsOAuth and FormData by @lukaszkorecki
If you have a tutorial you think should be included here, please email me with links.
To start developing, clone this repository and initialise 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 compatible version, type
make jsoauth from the command line.
To build just CommonJS/Node.JS compatible 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
Please report all issues on the GitHub issue tracker for jsOauth.
To test I use Google Chrome
/Applications/Google\ Chrome.app/Contents/MacOS/Google\ Chrome --disable-web-security --allow-file-access-from-files --allow-file-access spec/runner.html
- Rob Griffiths (rob AT bytespider DOT eu) @bytespider