@jimmycode/simple-oauth2-reddit
v0.6.0
Published
A simple Node.js client library for Reddit OAuth2.
Downloads
17
Readme
Simple OAuth2 Reddit
This library is a wrapper around Simple OAuth2 Library
Specially made for Authorization Code Flow with Reddit.
Requirements
Latest Node 8 LTS or newer versions.
Getting started
npm install --save simple-oauth2 @jimmycode/simple-oauth2-reddit
or
yarn add simple-oauth2 @jimmycode/simple-oauth2-reddit
Usage
const simpleOAuth2Reddit = require('@jimmycode/simple-oauth2-reddit');
const reddit = simpleOAuth2Reddit.create(options);
reddit
object exposes 3 keys:
- authorize: Middleware to request user's authorization.
- getToken: Middleware for callback processing and exchange the authorization token for an
access_token
- oauth2: The underlying simple-oauth2 instance.
Options
Required options
| Option | Description | |--------------|--------------------------------------------------------------------------------------------| | clientId | Your App Id. | | clientSecret | Your App Secret Id. | | callbackURL | Callback configured when you created the app. | | state | Your CSRF anti-forgery token. More at: https://auth0.com/docs/protocols/oauth2/oauth-state |
Other options
| Option | Default | Description | |------------------|------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | scope | ['identity'] | https://github.com/reddit-archive/reddit/wiki/OAuth2#authorization | | returnError | false | When is false (default), will call the next middleware with the error object. When is true, will set req.tokenError to the error, and call the next middleware as if there were no error. | | authorizeHost | 'https://www.reddit.com' | | | authorizePath | '/api/v1/authorize' | | | tokenHost | 'https://www.reddit.com' | | | tokenPath | '/api/v1/access_token' | | | authorizeOptions | {} | Pass extra parameters when requesting authorization. | | tokenOptions | {} | Pass extra parameters when requesting access_token. |
Example
Original boilerplate
const oauth2 = require('simple-oauth2').create({
client: {
id: process.env.REDDIT_APP_ID,
secret: process.env.REDDIT_APP_SECRET
},
auth: {
authorizeHost: 'https://www.reddit.com'
authorizePath: '/api/v1/authorize',
tokenHost: 'https://www.reddit.com',
tokenPath: '/api/v1/access_token'
}
});
router.get('/auth/reddit', (req, res) => {
const authorizationUri = oauth2.authorizationCode.authorizeURL({
redirect_uri: 'http://localhost:3000/auth/reddit/callback',
scope: ['identity'],
state: 'random-unique-string'
});
res.redirect(authorizationUri);
});
router.get('/auth/reddit/callback', async(req, res) => {
const code = req.query.code;
const options = {
code,
state: 'same-random-unique-string',
redirect_uri: 'http://localhost:3000/auth/reddit/callback'
};
try {
// The resulting token.
const result = await oauth2.authorizationCode.getToken(options);
// Exchange for the access token.
const token = oauth2.accessToken.create(result);
return res.status(200).json(token);
} catch (error) {
console.error('Access Token Error', error.message);
return res.status(500).json('Authentication failed');
}
});
With SimpleOAuth2Reddit
const simpleOAuth2Reddit = require('@jimmycode/simple-oauth2-reddit');
const reddit = simpleOAuth2Reddit.create({
clientId: process.env.REDDIT_APP_ID,
clientSecret: process.env.REDDIT_APP_SECRET,
callbackURL: 'http://localhost:3000/auth/reddit/callback',
state: 'random-unique-string'
});
// Ask the user to authorize.
router.get('/auth/reddit', reddit.authorize);
// Exchange the token for the access token.
router.get('/auth/reddit/callback', reddit.accessToken, (req, res) => {
return res.status(200).json(req.token);
});