https://github.com/jaredhanson/passport-paypal-oauth

PayPal (OAuth) authentication strategy for Passport and Node.js.
https://github.com/jaredhanson/passport-paypal-oauth

Last synced: about 1 year ago
JSON representation

PayPal (OAuth) authentication strategy for Passport and Node.js.

• Host: GitHub
• URL: https://github.com/jaredhanson/passport-paypal-oauth
• Owner: jaredhanson
• License: mit
• Created: 2012-04-28T05:44:45.000Z (about 14 years ago)
• Default Branch: master
• Last Pushed: 2024-06-07T15:36:50.000Z (about 2 years ago)
• Last Synced: 2025-05-13T01:45:16.897Z (about 1 year ago)
• Language: JavaScript
• Size: 10.7 KB
• Stars: 30
• Watchers: 5
• Forks: 28
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Passport-PayPal-OAuth

[Passport](http://passportjs.org/) strategy for authenticating with [PayPal](http://www.paypal.com/)

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](http://www.senchalabs.org/connect/)-style middleware, including

[Express](http://expressjs.com/).

## 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](http://expressjs.com/)

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](https://github.com/jaredhanson/passport-paypal-oauth/tree/master/examples/login).

## Tests

    $ npm install --dev

    $ make test

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

## Credits

  - [Jared Hanson](http://github.com/jaredhanson)

## License

[The MIT License](http://opensource.org/licenses/MIT)

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