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

@digifi/periodicjs.ext.oauth2client

v9.2.1

Published

An authentication extension for periodicjs that uses passport to authenticate user sessions.

Downloads

23

Readme

periodicjs.ext.oauth2client Coverage Status Build Status

An extension that connects to an OAuth 2 Server using passport-oauth2 and saves the access token to the user's extension attributes

API Documentation

Usage

CLI TASK

You can preform a task via CLI

$ cd path/to/application/root
### Using the CLI
$ periodicjs ext periodicjs.ext.oauth2client hello  
### Calling Manually
$ node index.js --cli --command --ext --name=periodicjs.ext.oauth2client --task=hello 

Configuration

You can configure periodicjs.ext.oauth2client

Configure

Add an array of OAUTH 2 services in your login extension's passport settings.

e.g. Login Extension content/config/extensions/periodicjs.ext.passport/settings.json configuration:

	{
      "passport":{
				"oauth":{
					"facebook":{
						"appid": "NEEDFBAPPID",
						"appsecret": "NEEDFBAPPSECRET",
						"callbackurl": "http://local.getperiodic.com:8786/auth/facebook/callback",
						"scope":["email", "publish_actions", "offline_access", "user_status", "user_likes", "user_checkins", "user_about_me", "read_stream"]
					},
					"oauth2client":[{
						"client_token_id": "a51f14a3dccf5a57b10947265f4bff14",
						"client_secret": "547d3e64c1183b6a0d3fac5005c97f67",
						"authorization_url":"https://my-oauth2-service.com/api/oauth2/authorize",
						"token_url":"https://my-oauth2-service.com/api/oauth2/token",
						"service_name":"my_oauth2_service",
						"scope":["all-access"]
					}]
				}
			}
	}

Default Configuration

{
  settings: {
    defaults: true,
  },
  databases: {
  },
};

Installation

Installing the Extension

Install like any other extension, run npm run install periodicjs.ext.oauth2client from your periodic application root directory and then normally you would run periodicjs addExtension periodicjs.ext.oauth2client, but this extension does this in the post install npm script.

$ cd path/to/application/root
$ npm run install periodicjs.ext.oauth2client
$ periodicjs addExtension periodicjs.ext.oauth2client //this extension does this in the post install script

Uninstalling the Extension

Run npm run uninstall periodicjs.ext.oauth2client from your periodic application root directory and then normally you would run periodicjs removeExtension periodicjs.ext.oauth2client but this extension handles this in the npm post uninstall script.

$ cd path/to/application/root
$ npm run uninstall periodicjs.ext.oauth2client
$ periodicjs removeExtension periodicjs.ext.oauth2client // this is handled in the npm postinstall script

Testing

Make sure you have grunt installed

$ npm install -g grunt-cli

Then run grunt test or npm test

$ grunt test && grunt coveralls #or locally $ npm test

For generating documentation

$ grunt doc
$ jsdoc2md commands/**/*.js config/**/*.js controllers/**/*.js  transforms/**/*.js utilities/**/*.js index.js > doc/api.md

Notes

  • Check out https://github.com/typesettin/periodicjs for the full Periodic Documentation