adamvr-superagent-oauth
v0.2.4
Published
Tiny superagent plugin to easily sign requests with node-oauth.
Downloads
30
Readme
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');
require('superagent-oauth')(request);
// 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 <[email protected]>
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.