An open API service indexing awesome lists of open source software.

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

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

Last synced: 9 months ago
JSON representation

Vimeo authentication strategy for Passport and Node.js.

Awesome Lists containing this project

README

          

# Passport-Vimeo

[Passport](https://github.com/jaredhanson/passport) strategy for authenticating
with [Vimeo](http://vimeo.com/) using the OAuth 1.0a API.

This module lets you authenticate using Vimeo in your Node.js applications.
By plugging into Passport, Vimeo 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-vimeo

## Usage

#### Configure Strategy

The Vimeo authentication strategy authenticates users using a Vimeo 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 VimeoStrategy({
consumerKey: VIMEO_CONSUMER_KEY,
consumerSecret: VIMEO_CONSUMER_SECRET,
callbackURL: "http://127.0.0.1:3000/auth/vimeo/callback"
},
function(token, tokenSecret, profile, done) {
User.findOrCreate({ vimeoId: profile.id }, function (err, user) {
return done(err, user);
});
}
));

#### Authenticate Requests

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

For example, as route middleware in an [Express](http://expressjs.com/)
application:

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

app.get('/auth/vimeo/callback',
passport.authenticate('vimeo', { 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-vimeo/tree/master/examples/login).

## Tests

$ npm install --dev
$ make test

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

## 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/)>

Sponsor