passport-smashrun

0.1.0 • Public • Published

Passport-Smashrun

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

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

Install

$ npm install passport-smashrun

Usage

Configure Strategy

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

passport.use(new SmashrunStrategy({
    clientId: SMASHRUN_CLIENT_ID,
    clientSecret: SMASHRUN_CLIENT_SECRET,
    callbackURL: "http://127.0.0.1:3000/auth/smashrun/callback"
  },
  function(token, tokenSecret, profile, done) {
    User.findOrCreate({ smashrunId: profile.id }, function (err, user) {
      return done(err, user);
    });
  }
));

Authenticate Requests

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

For example, as route middleware in an Express application:

app.get('/auth/smashrun',
  passport.authenticate('smashrun', { scope: [ 'read_activity', 'write_activity' ] }));

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

Credits

License

The MIT License

Copyright (c) 2015 Briac Pilpré

Package Sidebar

Install

npm i passport-smashrun

Weekly Downloads

0

Version

0.1.0

License

MIT

Last publish

Collaborators

  • briacp