https://github.com/sparkbox/passport-harvest

Harvest authentication strategy for Passport and Node.js.
https://github.com/sparkbox/passport-harvest

Last synced: about 2 months ago
JSON representation

Harvest authentication strategy for Passport and Node.js.

• Host: GitHub
• URL: https://github.com/sparkbox/passport-harvest
• Owner: sparkbox
• License: mit
• Created: 2014-02-27T20:43:26.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2015-10-06T20:10:13.000Z (about 9 years ago)
• Last Synced: 2024-04-11T03:37:35.406Z (9 months ago)
• Language: JavaScript
• Size: 133 KB
• Stars: 0
• Watchers: 22
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
:warning: **NOTICE:** We're sorry to say that the needs we had when creating this no longer exist at [Sparkbox](http://seesparkbox.com).  We no longer intend to actively develop and support this passport strategy.  We do intend to sustain the repostory, so feel free to use the repo in your `package.json` dependencies.  We've tagged the only release, [0.1.0](https://github.com/sparkbox/passport-harvest/releases/tag/v0.1.0), which we recommend locking your project against, just in case.

# Passport-Harvest

[Passport](https://github.com/jaredhanson/passport) strategy for authenticating

with [Harvest](http://harvestapp.com/) using the OAuth 2.0 API.

This module lets you authenticate using Harvest in your Node.js applications.

By plugging into Passport, Harvest 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-harvest

## Usage

#### Configure Strategy

The Harvest authentication strategy authenticates users using a Harvest

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 client ID, client secret, and callback URL.

    passport.use(new HarvestStrategy({

        clientID: HARVEST_CLIENT_ID,

        clientSecret: HARVEST_CLIENT_SECRET,

        callbackURL: "http://127.0.0.1:3000/auth/harvest/callback"

      },

      function(accessToken, refreshToken, profile, done) {

        User.findOrCreate({ harvestId: profile.id }, function (err, user) {

          return done(err, user);

        });

      }

    ));

#### Authenticate Requests

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

authenticate requests.

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

application:

    app.get('/auth/harvest',

      passport.authenticate('harvest'));

    app.get('/auth/harvest/callback',

      passport.authenticate('harvest', { failureRedirect: '/login' }),

      function(req, res) {

        // Successful authentication, redirect home.

        res.redirect('/');

      });

## License

MIT