passport-cisco-spark/README.md

Cisco Spark authentication strategy for Passport.

# Passport - Cisco Spark

[Passport](https://github.com/jaredhanson/passport) strategy for authenticating
with [Cisco Spark](https://www.ciscospark.com/) using the OAuth 2.0 API.

This module lets you authenticate using Cisco Spark in your Node.js applications.
By plugging into Passport, Cisco Spark 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-cisco-spark

## Usage

#### Configure Strategy

The Cisco Spark authentication strategy authenticates users using a Cisco Spark
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 CiscoSparkStrategy({
        clientID: CISCO_SPARK_CLIENT_ID,
        clientSecret: CISCO_SPARK_CLIENT_SECRET,
        callbackURL: "http://127.0.0.1:3000/auth/spark/callback"
      },
      function(accessToken, refreshToken, profile, done) {
        User.findOrCreate({ sparkId: profile.id }, function (err, user) {
          return done(err, user);
        });
      }
    ));

#### Authenticate Requests

Use `passport.authenticate()`, specifying the `'cisco-spark'` strategy, to
authenticate requests.

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

    app.get('/auth/spark',
      passport.authenticate('cisco-spark'));

    app.get('/auth/spark/callback', 
      passport.authenticate('cisco-spark', { 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/bmoyroud/passport-cisco-spark/tree/master/examples/login).

## Tests

    $ npm install --dev
    $ make test

[![Build Status](https://travis-ci.org/bmoyroud/passport-cisco-spark.svg?branch=master)](https://travis-ci.org/bmoyroud/passport-cisco-spark)

## Credits

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

## License

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