Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
RunKeeper authentication strategy for Passport and Node.js.
JavaScript
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
examples/login
lib/passport-runkeeper Wrap error for informative message.
test
.gitignore
.npmignore
.travis.yml
LICENSE
Makefile
README.md
package.json

README.md

Passport-RunKeeper

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

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

Install

$ npm install passport-runkeeper

Usage

Configure Strategy

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

passport.use(new RunKeeperStrategy({
    clientID: RUNKEEPER_CLIENT_ID,
    clientSecret: RUNKEEPER_CLIENT_SECRET,
    callbackURL: "http://127.0.0.1:3000/auth/runkeeper/callback"
  },
  function(accessToken, refreshToken, profile, done) {
    User.findOrCreate({ runkeeperId: profile.id }, function (err, user) {
      return done(err, user);
    });
  }
));

Authenticate Requests

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

For example, as route middleware in an Express application:

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

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

Examples

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

Tests

$ npm install --dev
$ make test

Build Status

Credits

License

The MIT License

Copyright (c) 2011-2013 Jared Hanson <http://jaredhanson.net/>

Something went wrong with that request. Please try again.