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-aircall

v0.0.3

Published

Aircall authentication strategy for Passport.

Downloads

2

Readme

passport-aircall

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

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

Install

$ npm install passport-aircall

Usage

Create an Application

Before using passport-aircall, you must obtain OAuth credentation from Aircall. If you don't have them yet, please follow this step of Aircall's tutorial. Aircall's team will issue a client_id and client_secret, which need to be provided to the strategy. You will also need to configure a callback URL which matches a route in your application.

Configure Strategy

The Aircall authentication strategy authenticates companies using an Aircall account and OAuth 2.0 tokens. The client_id and client_secret obtained before 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 which contains the authenticated company's Aircall profile. The verify callback must call cb providing a user to complete authentication.

var AircallStrategy = require('passport-aircall').Strategy;

passport.use(
  new AircallStrategy(
    {
      clientID: process.env.AIRCALL_CLIENT_ID,
      clientSecret: process.env.AIRCALL_CLIENT_SECRET,
      callbackURL: 'https://www.website.com/auth/aircall/callback',
      scope: ['public_api'] // 'public_api' is a mandatory scope
    },
    function(accessToken, refreshToken, profile, cb) {
      Company.findOrCreate({ name: profile.name }, function(err, company) {
        return cb(err, company);
      });
    }
  )
);

Authenticate Requests

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

For example, as route middleware in an Express application:

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

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

Examples

Developers using the popular Express web framework can refer to an example as a starting point for their own web applications. The example shows how to authenticate users using Facebook. However, because both Facebook and Aircall use OAuth 2.0, the code is similar. Simply replace references to Facebook with corresponding references to Aircall.

Contributing

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:

$ make test

Coverage

Note: Istanbul package must be installed globally to run test coverage.

The test suite covers 100% of the code base. All new feature development is expected to maintain that level. Coverage reports can be viewed by executing:

$ make test-cov
$ make view-cov

License

The MIT License