Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

OAuth 1.0A Client Utilities

tag: 0.1.2

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 examples
Octocat-spinner-32 lib
Octocat-spinner-32 test
Octocat-spinner-32 Readme.md
Octocat-spinner-32 package.json
Readme.md

Overview

An OAuth 1.0A library for node.js. There are currently a handful of OAuth libraries but I choose to take a different route with how the API is used. The usage is really similar to simplegeo's python OAuth client. It extends the built-in http client which makes signing requests require two extra parameters. The only difference is that requests must have thier body (if present) and a signature provided, the client takes care of the rest. You are responsible for handling the authentication flow, check out this example to see possible uses.

Thanks to ciaranj for providing a place to start.

Installation

You can be fancy and clone the repo from here, or install npm and run:

npm install oauth-client

The include you must specify is:

require('oauth-client')

Tests

Running the tests requires vows. See vows to get started.

Once installed:

node oauth-test.js

Notes

  • It severely lacks tests (any help appreciated), but for now the signature base string has a couple of tests.
  • I had to patch querystring.js to support overriding escape. qs.stringify was using its internal version of escape and it made the implementation ugly without being able to override its behavior.

License

(The MIT License)

Copyright (c) 2009 Ryan Fairchild <ryan.fairchild [at] gmail [dot] com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Something went wrong with that request. Please try again.