Skip to content

Latest commit

 

History

History
62 lines (48 loc) · 1.9 KB

README.md

File metadata and controls

62 lines (48 loc) · 1.9 KB

Passport-Gumroad

npm version Build Status

Passport strategy for authenticating with Gumroad using the OAuth 2.0 API.

This module lets you authenticate using Gumroad in your Node.js applications. By plugging into Passport, Gumroad authentication can be easily and unobtrusively integrated into any application or framework that supports Connect-style middleware, including Express.

Install

$ npm install passport-gumroad

Usage

Configure Strategy

The Gumroad authentication strategy authenticates users using a Gumroad account and OAuth 2.0 tokens. The strategy requires a verify callback, which accepts these credentials and calls done providing a user, as well as options specifying a client ID, client secret, and callback URL.

passport.use(new GumroadStrategy({
    clientID: GUMROAD_CLIENT_ID,
    clientSecret: GUMROAD_CLIENT_SECRET,
    callbackURL: "http://127.0.0.1:3000/auth/gumroad/callback"
  },
  function(accessToken, refreshToken, profile, done) {
    User.findOrCreate({ gumroadId: profile.id }, function (err, user) {
      return done(err, user);
    });
  }
));

Authenticate Requests

Use passport.authenticate(), specifying the 'gumroad' strategy, to authenticate requests.

For example, as route middleware in an Express application:

app.get('/auth/gumroad',
  passport.authenticate('gumroad'));

app.get('/auth/gumroad/callback',
  passport.authenticate('gumroad', { failureRedirect: '/login' }),
  function(req, res) {
    // Successful authentication, redirect home.
    res.redirect('/');
  });