JavaScript HTML Shell
Switch branches/tags
Nothing to show
Latest commit fbf70f9 Jun 25, 2017

README.md

google-oauth2-web-client

Code Climate Build Status

Login with Google using OAuth2 for client-side web app, completes login flow discribed in Using OAuth 2.0 for Client-side Applications.

This library is a spin-off project from HTML5 Word Cloud. The original commits can be found in here.

Simple usage

  1. Load the script with <script> or as an AMD module.
  2. Create an instance of the library with var go2 = new GO2(options), where options should contain at least the clientId you got from the Google API Console.
  3. Attach your callbacks to go2.onlogin and go2.onlogout. You will be able to get the accessToken from onlogin callback or from the go2.getAccessToken() method.
  4. (Immediate mode) At this point, you may call go2.login(false, true) and to silently test and regain the previous approval. If it's approved, onlogin callback will fire.
  5. Call go2.login() to start an interactive login process, with a popup. The call must be a result of a user action, such as a click, to prevent popup blocker.

Check out comments in the script source code for detail.

##Options

  • clientId: string (required)
  • redirectUri: string (optional)
  • scope: string | string[] (optional)
  • popupHeight: number (optional)
  • popupWidth: number (optional)
  • responseType: string (optional)
  • accessType: string (optional)

FAQ

Why not use library supplied by Google and reinvent the wheel?

Because I can; also because the library is light-weighted and transparent to me. For some reason, I cannot get auth library to load without getting the entire client library; onload callback never fires.

You are very welcome to use the library from Google since it will be better supported.

What can I do with the accessToken or code I got once the login is completed?

You can

  • Use the token to request data from Google's server directly from the client-side web app in the browser (with JSON-P or CORS), for example, this is how HTML5 Word Cloud does it.
  • Send the token to your own server, verify it with Google to associate a Google account with a user session on your site. Documentation here.

Typescript support

Include the src/google-oauth2.d.ts for Typescript support.

Testing

To run tests, first you would need to pull the required QUnit and Sinon.JS library by running

git submodule init
git submodule update

Then, start a localhost HTTP server, for example,

python -m SimpleHTTPServer 8009

Test with local fake OAuth endpoint

Point your browser to http://localhost:8009/test/?localtest=true to start testing. You will need to disable popup blocker to properly run the interactive test cases.

Test with the real Google OAuth endpoint

Point your browser to http://127-0-0-1.org.uk:8009/test/ to start testing. You will need to disable popup blocker to properly run the interactive test cases.

Writing tests

You will find all the information you need to write test cases on the QUnit and Sinon.JS website. All code submission are expected to accompany with test cases.

Auther

Timothy Guan-tin Chien

Contributors

License

Copyright (c) 2016 Timothy Guan-tin Chien

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.