passport-poniverse v0.0.1

passport-poniverse

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

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

Install

$ npm install passport-poniverse

Usage

Create an Application

Before using passport-poniverse, you must first obtain a Client ID and Secret from Poniverse. This can be done by following the instructions at the bottom of of the API page. The client ID and secret need to be provided to the strategy. You will also need to state a callback URL which matches the route in your application.

Configure Strategy

The Poniverse authentication strategy authenticates users using a Poniverse account and OAuth 2.0 tokens. The client ID and secret obtained when creating an application are supplied as options when creating the strategy. The strategy also requires a verify callback, which receives the access token and optional refresh token, as well as profile which contains the authenticated user's Poniverse profile. The verify callback must call cb providing a user to complete authentication.

var PoniverseStrategy = require('passport-poniverse').Strategy;

passport.use(new PoniverseStrategy({
    clientID: PONIVERSE_CLIENT_ID,
    clientSecret: PONIVERSE_CLIENT_SECRET,
    callbackURL: "http://127.0.0.1:3000/auth/poniverse/callback"
  },
  function(accessToken, refreshToken, profile, cb) {
    User.findOrCreate({ poniverseId: profile.id }, function (err, user) {
      return cb(err, user);
    });
  }
));

Authenticate Requests

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

For example, as route middleware in an Express application:

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

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

Examples

Developers using the popular Express web framework can refer to an example as a starting point for their own web applications. The example shows how to authenticate users using Facebook. However, because both Facebook and Poniverse use OAuth 2.0, the code is similar. Simply replace references to Facebook with corresponding references to Poniverse.

Contributing

Tests

The test suite is located in the test/ directory. All new features are expected to have corresponding test cases. Ensure that the complete test suite passes by executing:

$ make test

Coverage

The test suite covers 100% of the code base. All new feature development is expected to maintain that level. Coverage reports can be viewed by executing:

$ make test-cov
$ make view-cov

License

The Apache-2.0 License

Copyright (c) 2016 Ross Gibson