passport-meveto

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

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

Install

$ npm install passport-meveto

Usage

Create an Application

Before using passport-meveto, you must register an application with Meveto. If you have not already done so, a new application can be created at meveto dashboard, please follow meveto docs for further info.
Your application will be issued a client ID and client secret, which need to be provided to the strategy.
You will also need to configure a callback URL which matches the route in your application.

Configure Strategy

The Meveto authentication strategy authenticates users using a Meveto 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

profile. The verify callback must call cb providing a user to complete authentication.

var MevetoStrategy = require('passport-meveto').Strategy;

passport.use(new MevetoStrategy({
    clientID: MEVETO_CLIENT_ID,
    clientSecret: MEVETO_CLIENT_SECRET,
    callbackURL: "http://127.0.0.1:3000/auth/meveto/callback"
  },
  function(accessToken, refreshToken, profile, cb) {
    User.findOrCreate({ mevetoId: profile.id }, function (err, user) {
      return cb(err, user);
    });
  }
));

Authenticate Requests

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

For example, as route middleware in an Express application:

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

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

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 MIT License