Skip to content

pixiv authentication strategy for Passport and Node.js.

License

Notifications You must be signed in to change notification settings

pixiv/passport-pixiv

Repository files navigation

Passport-Pixiv

Passport strategy for authenticating with pixiv using the OAuth 2.0 API.

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

Install

$ npm install passport-pixiv

Usage

Configure Strategy

The pixiv authentication strategy authenticates users using a pixiv 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 PixivStrategy({
    clientID: PIXIV_CLIENT_ID,
    clientSecret: PIXIV_CLIENT_SECRET,
    callbackURL: "http://127.0.0.1:3000/auth/pixiv/callback"
  },
  function(accessToken, refreshToken, profile, done) {
    User.findOrCreate({ pixivId: profile.id }, function (err, user) {
      return done(err, user);
    });
  }
));

Authenticate Requests

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

For example, as route middleware in an Express application:

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

app.get('/auth/pixiv/callback',
  passport.authenticate('pixiv', { 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

Coverage Status

Dependency Status

Credits

Thanks

License

The MIT License

About

pixiv authentication strategy for Passport and Node.js.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published