passport-goodreads

    1.0.0 • Public • Published

    Passport-Goodreads

    Passport strategy for authenticating with Goodreads using the OAuth 1.0 API.

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

    Install

    $ npm install passport-goodreads
    

    Usage

    Configure Strategy

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

    passport.use(new GoodreadsStrategy({
        consumerKey: GOODREADS_KEY,
        consumerSecret: GOODREADS_SECRET,
        callbackURL: "http://127.0.0.1:3000/auth/goodreads/callback"
      },
      function(token, tokenSecret, profile, done) {
        User.findOrCreate({ goodreadsId: profile.id }, function (err, user) {
          return done(err, user);
        });
      }
    ));
    

    Authenticate Requests

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

    For example, as route middleware in an Express application:

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

    Examples

    For a complete, working example, refer to the login example.

    Tests

    $ npm install --dev
    $ make test
    

    Build Status

    Credits

    License

    The MIT License

    Copyright (c) 2011-2013 Jared Hanson <http://jaredhanson.net/>

    Install

    npm i passport-goodreads

    DownloadsWeekly Downloads

    12

    Version

    1.0.0

    License

    none

    Last publish

    Collaborators

    • jaredhanson