passport-singly v0.1.1

Passport-Singly

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

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

Installation

$ npm install passport-singly

Usage

Configure Strategy

The Singly authentication strategy authenticates users using a Singly 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 app ID, app secret, and callback URL.

passport.use(new SinglyStrategy({
    clientID: SINGLY_APP_ID,
    clientSecret: SINGLY_APP_SECRET,
    callbackURL: "http://localhost:3000/auth/singly/callback"
  },
  function(accessToken, refreshToken, profile, done) {
    User.findOrCreate({ singlyId: profile.id }, function (err, user) {
      return done(err, user);
    });
  }
));

Authenticate Requests

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

For example, as route middleware in an Express application:

app.get('/auth/singly/:service', passport.authenticate('singly'));

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

Extended Permissions

If you need extended permissions from the user, the permissions can be requested via the scope option to passport.authenticate().

For example, this authorization requests permission to the user's statuses and checkins:

app.get('/auth/singly',
  passport.authenticate('singly', { scope: ['user_status', 'user_checkins'] }),
  function(req, res){
    // The request will be redirected to Singly for authentication, with
    // extended permissions.
  });

Examples

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

Tests

$ npm install --dev
$ make test