Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

node-oauth signing plugin for superagent requests

tag: 0.2.1

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 History.md
Octocat-spinner-32 README.md
Octocat-spinner-32 package.json
Octocat-spinner-32 superagent-oauth.js
README.md

superagent-oauth

A handy superagent plugin to sign requests with an OAuth token and secret.

Builds on top of node-oauth, but it enables you to leverage the API flexibility of superagent instead of the .get, .getProtectedResource and other methods node-oauth offers.

Example

var oauth = new OAuth()
  , request = require('superagent')

// once you get the access token and secret
request.post('http://api.resource.org/users')
  .sign(oauth, token, secret)
  .send({ my: 'data' })
  .set('X-My', 'Header')
  .end(function (res) {
    console.log(res.status, res.body);
  })

API

Request#sign

OAuth 1.0/1.0a

Request#sign(oauthManager, token, secret)
  • oauthManager: (OAuth) instance of the OAuth manager
  • token: (String) access token
  • secret: (String) access token secret

OAuth2

Request#sign(oauthManager, token)
  • oauthManager: (OAuth2) instance of the OAuth2 manager
  • token: (String) access token

Credits

(The MIT License)

Copyright (c) 2011 Guillermo Rauch <guillermo@learnboost.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.