A passport strategy for miiCard
JavaScript Makefile
Switch branches/tags
Nothing to show
Clone or download
Pull request Compare This branch is 1 commit ahead of eugeniop:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib/passport-miiCard
test
.gitignore
.travis.yml
LICENSE
Makefile
README.md
package.json

README.md

Passport-miiCard

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

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

Install

$ npm install passport-miiCard

Usage

Configure Strategy

The miiCard authentication strategy authenticates users using a miiCard 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 consumerKey, consumerSecret, and callback URL.

passport.use(new miiCardStrategy({
    clientID: ID,
    clientSecret: SECRET,
    callbackURL: "http://127.0.0.1:3000/auth/miicard/callback"
  },
  function(accessToken, refreshToken, profile, done) {
    User.findOrCreate({ miiCardId: profile.id }, function (err, user) {
      return done(err, user);
    });
  }
));

Authenticate Requests

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

For example, as route middleware in an Express application:

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

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

Tests

$ npm install --dev
$ make test

Credits

License

The MIT License

Copyright (c) 2011-2013 Eugenio Pace