Giter Club home page Giter Club logo

passport-bungie's Introduction

Passport-Bungie

Passport strategy for authenticating with Bungie using the OAuth 2.0 API. This package was adopted from Fred Chien's excellent passport-github2 Strategy.

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

Installation

$ npm install passport-bungie

Usage

Configure Strategy

The Bungie authentication strategy authenticates users using a Bungie application 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, an API Key, and callback URL.

IMPORTANT NOTE

Bungie requires the callback URL you set in the application to use https. You can not use http://localhost even in development. You app, even in development, must use https. You can solve this however you like. The solution I found with the least friction was ngrok. You can use a free account for development and easily setup a proxy.

passport.use(
   new GitHubStrategy(
      {
         clientID: BUNGIE_CLIENT_ID,
         clientSecret: BUNGIE_CLIENT_SECRET,
         callbackURL: 'https://127.0.0.1:3000/auth/bungie/callback',
         customHeaders: { 'X-API-KEY': BUNGIE_APIKEY },
      },
      function (accessToken, refreshToken, profile, done) {
         User.findOrCreate({ bungie: memberhipId }, function (err, user) {
            return done(err, user);
         });
      }
   )
);

Authenticate Requests

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

For example, as route middleware in an Express application:

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

app.get(
   '/auth/bungie/callback',
   passport.authenticate('bungie', { 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) 2011-2013 Jared Hanson <http://jaredhanson.net/>

passport-bungie's People

Contributors

royanger avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.