Skip to content

Latest commit

 

History

History
76 lines (52 loc) · 2.54 KB

README.md

File metadata and controls

76 lines (52 loc) · 2.54 KB

Passport-PayPal-OAuth

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

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

Install

$ npm install passport-paypal-oauth

Usage

Configure Strategy

The PayPal authentication strategy authenticates users using a PayPal 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 app ID, app secret, and callback URL.

passport.use(new PayPalStrategy({
    clientID: PAYPAL_APP_ID,
    clientSecret: PAYPAL_APP_SECRET,
    callbackURL: "http://localhost:3000/auth/paypal/callback"
  },
  function(accessToken, refreshToken, profile, done) {
    User.findOrCreate({ paypalId: profile.id }, function (err, user) {
      return done(err, user);
    });
  }
));

Authenticate Requests

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

For example, as route middleware in an Express application:

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

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

Build Status

Credits

License

The MIT License

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

Sponsor