Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
advance512 committed Mar 8, 2018
0 parents commit 725d435
Show file tree
Hide file tree
Showing 19 changed files with 14,281 additions and 0 deletions.
20 changes: 20 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# EditorConfig helps developers define and maintain consistent
# coding styles between different editors and IDEs
# editorconfig.org

root = true

[*]

# Change these settings to your own preference
indent_style = space
indent_size = 2

# We recommend you to keep these unchanged
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

[*.md]
trim_trailing_whitespace = false
122 changes: 122 additions & 0 deletions .eslintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
{
// This is the Perfpie eslint config for React projects.
"parser": "babel-eslint",
"extends": [
"airbnb"
],
"plugins": [
],
"env": {
"browser": true,
"jest": true,
"jasmine": true
},
"globals": {

"__DEVELOPMENT__": true,
"__PRODUCTION__": true,
"__CLIENT__": true,
"__SERVER__": true,
"__DEBUG__": true,
"__COVERAGE__": true,
"__BASENAME__": true,
"__INTERNAL_GRAPHQL_URL__": true,
"__EXTERNAL_GRAPHQL_URL__": true,
"__FACEBOOK_APP_ID__": true,
"__FILESTACK_API_KEY__": true,
"__DRIFT_API_KEY__": true,
"__PAYPAL_MODE__": true,
"__PAYPAL_CLIENT_ID__": true,
"__TALKJS_APP_ID__": true,
"__GOOGLE_CLIENT_ID__": true
},
"settings": {
"import/resolver": {
"webpack": {
"config": "webpack/webpack.config.client.development.js"
}
}
},
"rules": {
"max-len": [
"error",
120,
{
"tabWidth": 2,
"ignoreComments": true,
"ignoreUrls": true
}
],
"arrow-body-style": [
"error",
"always"
],
"key-spacing": "off",
"padded-blocks": "off",
"import/no-dynamic-require": 0,
"generator-star-spacing": "off",
"comma-dangle": [
"error",
{
"arrays": "always-multiline",
"objects": "always-multiline",
"imports": "never",
"exports": "never",
"functions": "ignore"
}
],
"function-paren-newline": [
"error",
"consistent"
],
"no-unused-vars": [
"error",
{
"args": "all",
"caughtErrors": "none"
}
],
"import/prefer-default-export": "off",
"no-underscore-dangle": "off",
"no-else-return": "off",
"no-restricted-syntax": [
"error",
"WithStatement",
"ForInStatement",
"BreakStatement",
"DebuggerStatement"
],
"class-methods-use-this": "off",

"import/no-extraneous-dependencies": [
"off",
{
"devDependencies": [
"**/*.test.js",
"**/*.spec.js",
"**/*.stories.js"
]
}
],
"react/prefer-stateless-function": "off",
// TODO: re-enable this when we upgrade the eslint version
//"react/jsx-max-props-per-line": ["error", { "maximum": 1, "when": "multiline" }],
"react/forbid-prop-types": "off",
"react/jsx-filename-extension": [
"error",
{
"extensions": [
".js",
".jsx"
]
}
],
"jsx-a11y/no-marquee": "off",
"react/no-typos": "off",
"object-curly-newline": "off",
"react/jsx-max-props-per-line": ["error", { "when": "multiline", "maximum": 2 }],
"jsx-a11y/anchor-is-valid": "off",
"react/default-props-match-prop-types": "off",
"jsx-a11y/label-has-for": "off"
}
}
10 changes: 10 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.DS_Store
dist
yarn-error.log
npm-debug.log
node_modules
coverage
.idea/
.happypack
.env
.env.dev
15 changes: 15 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
.*.swp
._*
.DS_Store
.git
.hg
.lock-wscript
.svn
.wafpickle-*
CVS
npm-debug.log
node_modules/
.DS_store
.module-cache
npm-debug.log
.c9
5 changes: 5 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
language: node_js
node_js:
- "5"
script:
- npm test
43 changes: 43 additions & 0 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
MIT License

Copyright (c) 2018 Selectom

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.

MIT License

Copyright (c) 2016 Anthony Grove

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.
151 changes: 151 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,151 @@
# react-google-authorize [![NPM version](https://img.shields.io/npm/v/react-google-authorize.svg?style=flat)](https://www.npmjs.com/package/react-google-authorize) [![NPM downloads](https://img.shields.io/npm/dm/react-google-authorize.svg?style=flat)](https://npmjs.org/package/react-google-authorize)

> A Google OAuth Component for React that supports multiple instances
Developed in [Selectom](https://www.selectom.com).

## Install

```
yarn add react-google-authorize
```

**Why yet another React Google oauth component?**

All existing React Google oauth components (e.g. [react-google-login](https://github.com/anthonyjgrove/react-google-login), which is the basis of this library, and also [react-google-login-component](https://github.com/kennetpostigo/react-google-login-component), [react-google-oauth](https://github.com/CyrilSiman/react-google-oauth) and [react-social-login](https://github.com/deepakaggarwal7/react-social-login)) use the [gapi.auth2.init](https://developers.google.com/identity/sign-in/web/reference#gapiauth2initparams) method for handling the authentication and authorization process, which has the limitation of only supporting one button in the document at a time.

We needed to support multiple authorization buttons, potentially for different Google user accounts, so we implemented this control to use the [gapi.auth2.authorize](https://developers.google.com/identity/sign-in/web/reference#gapiauth2authorizeparams-callback) method instead.
This means that you don't get a GoogleUser object to play with, but you can request authorization from different users at the same time.


## How to use
```js
import React from 'react';
import ReactDOM from 'react-dom';
import GoogleAuthorize from 'react-google-authorize';
// or
import { GoogleAuthorize } from 'react-google-authorize';


const responseGoogle = (response) => {
console.log(response);
}

ReactDOM.render(
<GoogleAuthorize
clientId="815121234598-5nn3e2ftm5hobdjbemuappb2t112345.apps.googleusercontent.com"
buttonText="Authorize"
onSuccess={responseGoogle}
onFailure={responseGoogle}
/>,
document.getElementById('googleButton')
);
```
## Parameters

| params | value | default value | description |
|:------------:|:--------:|:------------------------------------:|:----------------:|
| clientId | string | REQUIRED | |
| hostedDomain | string | - | |
| scope | string | profile email | |
| responseType | string | permission | Can be either space-delimited 'id_token', to retrieve an ID Token + 'permission' (or 'token'), to retrieve an Access Token, or 'code', to retrieve an Authorization Code.
| onSuccess | function | REQUIRED | |
| onFailure | function | REQUIRED | |
| onRequest | function | - | |
| buttonText | string | Login with Google | |
| className | string | - | |
| style | object | - | |
| disabledStyle| object | - | |
| loginHint | string | - | |
| prompt | string | - | |
| tag | string | button | sets element tag (div, a, span, etc |
| type | string | button |sets button type (submit || button) |
| fetchBasicProfile | boolean | true | |
| disabled | boolean | false | |
| discoveryDocs | - | https://developers.google.com/discovery/v1/using |
| uxMode | string | popup | The UX mode to use for the sign-in flow. Valid values are popup and redirect. |
| redirectUri | string | - | If using ux_mode='redirect', this parameter allows you to override the default redirect_uri that will be used at the end of the consent flow. The default redirect_uri is the current URL stripped of query parameters and hash fragment. |
| isSignedIn | boolean | false | If true will return GoogleUser object on load, if user has given your app permission |

Google Scopes List: https://developers.google.com/identity/protocols/googlescopes

## onSuccess callback

Argument to the callback with be the [AuthorizeResponse](https://developers.google.com/identity/sign-in/web/reference#gapiauth2authorizeresponse) object.

If you use the hostedDomain param, make sure to validate the id_token (a JSON web token) returned by Google on your backend server:
1. In the `responseGoogle(response) {...}` callback function, you should get back a standard JWT located at `response.hg.id_token`
2. Send this token to your server (preferably as an `Authorization` header)
3. Have your server decode the id_token by using a common JWT library such as [jwt-simple](https://github.com/hokaccha/node-jwt-simple) or by sending a GET request to `https://www.googleapis.com/oauth2/v3/tokeninfo?id_token=YOUR_TOKEN_HERE`
4. The returned decoded token should have an `hd` key equal to the hosted domain you'd like to restrict to.

You can also pass child components such as icons into the button component.
```js
<GoogleAuthorize
clientId={'815121234598-5nn3e2ftm5hobdjbemuappb2t112345.apps.googleusercontent.com'}
onSuccess={responseGoogle}
onFailure={responseGoogle}
>
<FontAwesome
name='google'
/>
<span> Login with Google</span>
</GoogleAuthorize>

```


## onFailure callback

onFailure callback is called when either initialization or a authorization attempt fails.
Argument is an error object.

Common error codes include:

| error code | description |
|:----------:|:-----------:|
| `idpiframe_initialization_failed` | initialization of the Google Auth API failed (this will occur if a client doesn't have [third party cookies enabled](https://github.com/google/google-api-javascript-client/issues/260)) |
| `popup_closed_by_user` | The user closed the popup before finishing the sign in flow.|
| `access_denied` | The user denied the permission to the scopes required |
| `immediate_failed` | No user could be automatically selected without prompting the consent flow. |

More details can be found in the official Google docs:
* [GoogleAuth.then(onInit, onError)](https://developers.google.com/identity/sign-in/web/reference#googleauththenoninit-onerror)
* [GoogleAuth.signIn(options)](https://developers.google.com/identity/sign-in/web/reference#googleauthsigninoptions)
* [GoogleAuth.grantOfflineAccess(options)](https://developers.google.com/identity/sign-in/web/reference#googleauthgrantofflineaccessoptions)

## Dev Server
```
yarn run start
```
Default dev server runs at localost:3000 in browser.
You can set IP and PORT in webpack.config.dev.js

## Run Tests
```
npm run test:watch
```

(or `yarn run test:watch` for running on code change)

## Production Bundle
```
yarn run bundle
```

## Related projects

You might also be interested in these projects:

* [react-google-login](https://github.com/anthonyjgrove/react-google-login): This project was forked from it, but is incompatible because of the way it uses the Google auth2 library. It it suitable for logging in, or managing sessions on the client side.

## Contributing

Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/selectom/react-google-authorize/issues/new).

## Author

**Alon Diamant (advance512)**

* [github/advance512](https://github.com/advance512)
* [Homepage](http://www.alondiamant.com)
8 changes: 8 additions & 0 deletions demo/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<!DOCTYPE html>
<html>
<link rel="stylesheet" href="//cdn.rawgit.com/twbs/bootstrap/v4-dev/dist/css/bootstrap.css">
<div id="google-authorize"></div>
<script src="//use.fontawesome.com/3bd7769ce1.js"></script>
<script src="/webpack-dev-server.js"></script>
<script src="bundle.js"></script>
</html>
Loading

0 comments on commit 725d435

Please sign in to comment.