Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Foursquare authentication strategy for Passport and Node.js.
JavaScript
branch: master

README.md

passport-foursquare

Build Coverage Quality Dependencies Tips

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

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

Install

$ npm install passport-foursquare

Usage

Configure Strategy

The Foursquare authentication strategy authenticates users using a Foursquare 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 FoursquareStrategy({
    clientID: FOURSQUARE_CLIENT_ID,
    clientSecret: FOURSQUARE_CLIENT_SECRET,
    callbackURL: "http://127.0.0.1:3000/auth/foursquare/callback"
  },
  function(accessToken, refreshToken, profile, done) {
    User.findOrCreate({ foursquareId: profile.id }, function (err, user) {
      return done(err, user);
    });
  }
));

Authenticate Requests

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

For example, as route middleware in an Express application:

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

app.get('/auth/foursquare/callback', 
  passport.authenticate('foursquare', { 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
$ npm test

Credits

License

The MIT License

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

Something went wrong with that request. Please try again.