Skip to content

tayste5000/passport-twitter

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

88 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

This is a fork of passport-twitter with default support for email access

passport-twitter

Build Coverage Quality Dependencies Tips

Passport strategy for authenticating with Twitter using the OAuth 1.0a API.

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

Install

$ npm install passport-twitter

Usage

Configure Strategy

The Twitter authentication strategy authenticates users using a Twitter account and OAuth tokens. The strategy requires a verify callback, which receives the access token and corresponding secret as arguments, as well as profile which contains the authenticated user's Twitter profile. The verify callback must call done providing a user to complete authentication.

In order to identify your application to Twitter, specify the consumer key, consumer secret, and callback URL within options. The consumer key and secret are obtained by creating an application at Twitter's developer site.

passport.use(new TwitterStrategy({
    consumerKey: TWITTER_CONSUMER_KEY,
    consumerSecret: TWITTER_CONSUMER_SECRET,
    callbackURL: "http://127.0.0.1:3000/auth/twitter/callback"
  },
  function(token, tokenSecret, profile, done) {
    User.findOrCreate({ twitterId: profile.id }, function (err, user) {
      return done(err, user);
    });
  }
));

Authenticate Requests

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

For example, as route middleware in an Express application:

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

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

Examples

Developers using the popular Express web framework can refer to an example as a starting point for their own web applications.

Tests

$ npm install
$ npm test

Credits

License

The MIT License

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

About

Twitter authentication strategy for Passport and Node.js. (edited to allow email access)

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 83.0%
  • Makefile 11.0%
  • Shell 6.0%