https://github.com/jaredhanson/passport-runkeeper

RunKeeper authentication strategy for Passport and Node.js.
https://github.com/jaredhanson/passport-runkeeper

Last synced: 10 months ago
JSON representation

RunKeeper authentication strategy for Passport and Node.js.

• Host: GitHub
• URL: https://github.com/jaredhanson/passport-runkeeper
• Owner: jaredhanson
• License: mit
• Created: 2011-11-29T06:03:34.000Z (over 14 years ago)
• Default Branch: master
• Last Pushed: 2018-01-04T16:27:15.000Z (over 8 years ago)
• Last Synced: 2025-09-30T18:33:19.965Z (10 months ago)
• Language: JavaScript
• Homepage:
• Size: 11.7 KB
• Stars: 18
• Watchers: 4
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Passport-RunKeeper

[Passport](https://github.com/jaredhanson/passport) strategy for authenticating

with [RunKeeper](http://runkeeper.com/) 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](http://www.senchalabs.org/connect/)-style middleware, including

[Express](http://expressjs.com/).

## 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](http://expressjs.com/)

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](https://github.com/jaredhanson/passport-runkeeper/tree/master/examples/login).

## Tests

    $ npm install --dev

    $ make test

[![Build Status](https://secure.travis-ci.org/jaredhanson/passport-runkeeper.png)](http://travis-ci.org/jaredhanson/passport-runkeeper)

## Credits

  - [Jared Hanson](http://github.com/jaredhanson)

## License

[The MIT License](http://opensource.org/licenses/MIT)

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