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

waterlock-google-auth

v0.1.2-rc1

Published

google authentication for waterlock

Downloads

3

Readme

Waterlock Google Auth

Build Status NPM version Dependency Status

waterlock-google-auth is a module for waterlock providing a google authentication method for users.

Usage

npm install waterlock-google-auth

Set the following option in your waterlock.json config file.

  • allow is an optional filter - if you omit it, all domains will be allowed.

  • redirectUri is also an optional property - use this if you want to override the computed redirectUri. This is useful for when you want to send an auth code to waterlock instead of having waterlock handle the entire auth flow for you. Useful for when you're developing an SPA which handles the authentication with something like Torii (EmberJs). See https://github.com/wayne-o/ember-waterlock-example waterlock will validate the auth code with the provider and retrieve an access token which can be used to setup a session and return the JWT to your app

"authMethod":[
   {
      name: 'waterlock-google-auth',
      clientId: 'CLIENT_ID',
      clientSecret: 'CLIENT_SECRET',
      allow: ['DOMAIN', 'USER@DOMAIN'],
      redirectUri: 'redirectUri'
    }
]

Direct your user to /auth/login to initiate the oauth request. The callback uri is /auth/google_oauth2 if successfuly authenticated a user record will be created if a user is not found one will be created using the waterlines findOrCreate method

Grabbing Google field values

By default, waterlock-google-auth stores the user's googleEmail in the Auth model. By providing waterlock with some field maps you can hydrate the user object with extended information. The cost of this is a second call to google's /me api To grab and store this, you will need to modify the attribute fields in your Auth.js model...

// api/models/Auth.js
module.exports = {
	attributes: require('waterlock').models.auth.attributes({
		firstName: 'string',
		lastName: 'string',
		gender: 'string',
		timezone: 'number'
	})
}

...and then add a fieldMap object within the google authMethod in your waterlock.js config file which matches your model's fields to google's fields.

authMethod: [
	{
		name: 'waterlock-google-auth',
      clientId: 'CLIENT_ID',
      clientSecret: 'CLIENT_SECRET',
      allow: ['DOMAIN', 'USER@DOMAIN'],
      redirectUri: 'redirectUri'
		fieldMap: {
			// <model-field>: <google-field>,
			'firstName': 'given_name',
			'lastName': 'family_name',
			'gender': 'gender'
		}
	}
]