# simple-oauth2-reddit > A simple Node.js client library for Reddit OAuth2. Latest version **0.5.1** (published 2018-07-07) · MIT license · 0 weekly downloads ## Install ```sh npm install simple-oauth2-reddit pnpm add simple-oauth2-reddit yarn add simple-oauth2-reddit bun add simple-oauth2-reddit ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.5.1 | | Published | 2018-07-07 | | First published | 2018-07-03 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 1 | | Unpacked size | 13.2 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 4 | | Author | JimmyCode Social | | Maintainers | albertomr86 | | Keywords | oauth2, auth2-client, reddit, reddit-api, reddit-login, reddit-auth, reddit-oauth, simple-oauth2 | ## Links - npm: https://www.npmjs.com/package/simple-oauth2-reddit - Repository: https://github.com/jimmycodesocial/simple-oauth2-reddit - Issues: https://github.com/jimmycodesocial/simple-oauth2-reddit/issues - npm.io page: https://npm.io/package/simple-oauth2-reddit ## Dependencies (1) - [simple-oauth2](https://npm.io/package/simple-oauth2.md) ^2.2.0 ## Alternatives - [@clerk/clerk-expo](https://npm.io/package/@clerk/clerk-expo.md) — 133.6K weekly downloads - [@pothos/plugin-authz](https://npm.io/package/@pothos/plugin-authz.md) — 12.4K weekly downloads - [@bounded-sh/client](https://npm.io/package/@bounded-sh/client.md) — 3.2K weekly downloads - [@luigi-project/plugin-auth-oauth2](https://npm.io/package/@luigi-project/plugin-auth-oauth2.md) — 2.3K weekly downloads - [@nocobase/plugin-verification](https://npm.io/package/@nocobase/plugin-verification.md) — 2.0K weekly downloads ## Recent versions - 0.5.1 (latest) — 2018-07-07 - 0.5.0 — 2018-07-03 ## README # Simple OAuth2 Reddit This library is a wrapper around [Simple OAuth2 Library](https://github.com/lelylan/simple-oauth2) Specially made for [Authorization Code Flow](https://tools.ietf.org/html/draft-ietf-oauth-v2-31#section-4.1) with Reddit. ## Requirements Latest Node 8 LTS or newer versions. ## Getting started ``` npm install --save simple-oauth2 simple-oauth2-reddit ``` or ``` yarn add simple-oauth2 simple-oauth2-reddit ``` ### Usage ```js const simpleOAuth2Reddit = require('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](https://github.com/lelylan/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 ```js 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 ```js const simpleOAuth2Reddit = require('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); }); ``` --- _Source: https://npm.io/package/simple-oauth2-reddit · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._