Skip to content

gdomorski/yahoo-contacts

Repository files navigation

Yahoo-Contacts

Passport strategies for authenticating with Yahoo! using the OAuth 2.0 API.

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

Installation

$ npm install yahoo-contacts

Configure Strategy

The Yahoo authentication strategy authenticates users using a Yahoo 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 YahooStrategy({
    clientID: YAHOO_CONSUMER_KEY,
    clientSecret: YAHOO_CONSUMER_SECRET,
    callbackURL: "http://127.0.0.1:3000/auth/yahoo/callback"
  },
  function(token, tokenSecret, profile, done) {
    User.findOrCreate({ yahooId: profile.id }, function (err, user) {
      return done(err, user);
    });
  }
));

Authenticate Requests

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

For example, as route middleware in an Express application:

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

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

Examples

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

Credits

License

The MIT License

About

Yahoo Contacts

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published