picplz authentication strategy for Passport and Node.js.
JavaScript
Switch branches/tags
Permalink
Failed to load latest commit information.
examples/login
lib/passport-picplz
test
.gitignore
.npmignore
.travis.yml
LICENSE
Makefile
README.md
package.json

README.md

Passport-picplz

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

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

Install

$ npm install passport-picplz

Usage

Configure Strategy

The picplz authentication strategy authenticates users using a picplz 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 PicplzStrategy({
    clientID: PICPLZ_OAUTH2_KEY,
    clientSecret: PICPLZ_OAUTH2_SECRET,
    callbackURL: "http://127.0.0.1:3000/auth/picplz/callback"
  },
  function(accessToken, refreshToken, profile, done) {
    User.findOrCreate({ picplzId: profile.id }, function (err, user) {
      return done(err, user);
    });
  }
));

Authenticate Requests

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

For example, as route middleware in an Express application:

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

app.get('/auth/picplz/callback', 
  passport.authenticate('picplz', { 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/>