npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

passport-polar

v1.0.1

Published

Passport.js OAuth2 Strategy for Polar

Downloads

128

Readme

passport-polar

Build

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

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

Install

$ npm install passport-polar

Usage

Create an Application

Before using passport-polar, you must register an application with Polar. If you have not already done so, a new application can be created at Polar Admin. Your application will be issued an app ID and app secret, which need to be provided to the strategy. You will also need to configure a redirect URI which matches the route in your application.

Please note: even though the Polar Access Link asks for domain when you are setting up a new app, actually they mean URL, it's enough to set http://myapp.com, you have to set http://myapp.com/auth/polar/callback.

Configure Strategy

The Polar authentication strategy authenticates users using a Polar account and OAuth 2.0 tokens. The app ID and secret obtained when creating an application are supplied as options when creating the strategy. The strategy also requires a verify callback, which receives the access token and optional refresh token, as well as profile and params. Unlikely to other strategies the profile won't be set, it will be always an empty object ({}). But the params will contain the user id.

{ 
  access_token: 'access-token',
  token_type: 'bearer',
  expires_in: 473039999,
  x_user_id: 123445566
}

Here you have to register your user as the documentation describes.

The verify callback must call cb providing a user to complete authentication.

passport.use(new PolarStrategy({
    clientID: POLAR_APP_ID,
    clientSecret: POLAR_APP_SECRET,
    callbackURL: 'http://localhost:3000/auth/polar/callback',
    scope: 'accesslink.read_all'
  },
  function (accessToken, refreshToken, params, profile, cb) {
    /*
     1. fetch https://www.polaraccesslink.com/v3/users/${params.x_user_id}(https://www.polar.com/accesslink-api/?javascript--nodejs#get-user-information)
     2. if empty string is returned, then we need to register the user, otherwise call the `cb` with the fetched data
     3. register the user (https://www.polar.com/accesslink-api/?javascript--nodejs#register-user)
     4. call the `cb` with received user information
   */
  }
));

Authenticate Requests

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

For example, as route middleware in an Express application:

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

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

Examples

You can find a complete example in the example, you can try it out:

  1. get your client id and client secret
  2. cd example
  3. cp .env.example .env
  4. add these parameters to .env
  5. node app.js
  6. navigate to http://localhost:3000
  7. you should receive: No user logged in, go to /login
  8. navigate to http://localhost:3000/login
  9. you should get redirected to the Polar page and once you approve the app, redirected back to http://localhost:3000 where you should your profile's information.

Tests

The test suite is located in the test/ directory. All new features are expected to have corresponding test cases. Ensure that the complete test suite passes by executing:

npm test

Acknowledgement

Thanks Jared Hanson http://jaredhanson.net/ for making Passport.js happen.

License

The MIT License

Copyright (c) 2018 Robert Oroszi