passport-fellowshipone

Passport-FellowshipOne

Passport strategy for authenticating with Fellowship One using the OAuth 1.0a API.

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

Install

$ npm install passport-fellowshipone

Usage

Configure Strategy

The Fellowship One authentication strategy authenticates users using a Fellowship One account and OAuth 1.0a tokens. The strategy requires a verify callback, which accepts these credentials and calls done providing a user, as well as options specifying a developer key and callback URL.

var FellowshipOneStrategy = require('passport-fellowshipone').Strategy;

passport.use(new FellowshipOneStrategy({
	apiURL: 'https://MyChurch.staging.fellowshiponeapi.com/v1',
    consumerKey: F1_DEVELOPER_KEY,
    consumerSecret: F1_SECRET,
    callbackURL: "http://127.0.0.1:3000/auth/fellowshipone/callback"
  },
  function(token, tokenSecret, profile, done) {
    User.findOrCreate({ userId: profile.id }, function (err, user) {
      return done(err, user);
    });
  }
));

Authenticate Requests

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

For example, as route middleware in an Express application:

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

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

Tests

$ npm install --dev
$ npm test

Credits

• Jared Hanson - for Passport and for passport-familysearch upon which this module was based.
• Dave Henderson - for converting passport-familysearch to work with the Fellowship One API

License

The MIT License

Copyright (c) 2014 Dave Henderson