passport-chiiv/readme.md

OAuth2 client authentication for Chiiv using passport.js

# Passport.js authentication for Chiiv

[Passport](http://passportjs.org/) strategy for authenticating with [Chiiv](https://chiiv.com/) using the OAuth 2.0 API.

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

By plugging into Passport, Chiiv 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-chiiv
```

## Usage

#### Configure Strategy

The Chiiv authentication strategy authenticates users using a Chiiv 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 ChiivOAuth2Strategy({
	clientID: CLIENT_ID,
	clientSecret: CLIENT_SECRET,
	callbackURL: "https://www.example.net/auth/chiiv/callback"
	},
	function(accessToken, refreshToken, profile, done) {
	User.findOrCreate({ providerId: profile.id }, function (err, user) {
		return done(err, user);
	});
	}
));
```

#### Authenticate Requests

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

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

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

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

## Credits

Initiated by [Makis Tracend](http://github.com/tracend)

Part of [Chiiv](http://chiiv.com/) by [K&D Interactive](http://kdi.co/)

Released under the [MIT license](http://makesites.org/licenses/MIT)