superagent-openauth

0.1.0 • Public • Published

superagent-openauth

A superagent plugin that signs requests with OAuth or OAuth2 via the openauth module.

Inspired by/based on superagent-oauth.

Usage

var OAuth = require('openauth');
var request = require('superagent');
 
require('superagent-openauth')(request);
 
var oauth = new OAuth(consumerKey, consumerSecret, {...});
 
request.post('https://api.twitter.com/1.1/statuses/update.json')
  .sign(oauth, token, tokenSecret)
  .type('urlencoded')
  .send({status: 'hello world'})
  .end(function(res) {
    console.log(res.status, res.body);
  });

API

Request#sign

OAuth 1.0/1.0A

request.sign(oauth, token, secret);
  • oauth: OAuth instance
  • token: string access token
  • secret: string access token secret

OAuth2

request.sign(oauth, token);
  • oauth: OAuth2 instance
  • token: string access token

License

The MIT License (MIT)

Copyright © 2014 GlobeSherpa

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.

Package Sidebar

Install

npm i superagent-openauth

Weekly Downloads

0

Version

0.1.0

License

none

Last publish

Collaborators

  • skeggse