omniauth-google-oauth2 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 504806ff4b3271e6aa36b0fb763231109d7a360f
-  data.tar.gz: 53dfd97a2482935bb4674cf4642e19a6373e376e
+  metadata.gz: 65ffc15faaed3d23a1c4a7ca2d5fa07f8ffda0f5
+  data.tar.gz: 6c70bafaec2478b78b8293bca662a898d4d4e019
 SHA512:
-  metadata.gz: a9bb17842ea595cd6ce12b9c8fe58096c666b7e02c58ec51a153755826cf9b869720d07f84f60f26f75d54a8d3d1e0c76e8ca8b48a1d3d80c419a0f766b85915
-  data.tar.gz: 4e0c2303a6d1c6c1ff9efc6f1eff9aa3068034adab61715a92ab042fbd19ef05208c6398d98c1db7e0804a90914802d622379d42cefe18acc2696c2f23326e10
+  metadata.gz: 55b5b27e600710e73ddd27d4ec9886faed3d76a2909f05090e46da59bde030d5e2cc567ac3a92d213fc9737a3938be4c1507d7f9631d8cfbd1b1962a87ca56b9
+  data.tar.gz: f4091407c27f7fb9d05751a927cd2963f2f9447e7ad8ce9af32f2769bc5759f0a0dc488a273ea79b32bd56e44fd5a9f2e4ffc177e96fac096a9bc93400368b71

data/.rubocop.yml

@@ -0,0 +1,20 @@
+ClassLength:
+  Enabled: false
+Layout/IndentHeredoc:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Metrics/BlockLength:
+  ExcludedMethods: ['describe', 'context']
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/LineLength:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+Style/FileName:
+  Enabled: false
+Style/MutableConstant:
+  Enabled: false

data/.travis.yml

@@ -1,14 +1,6 @@
-before_install:
-  - gem update --system 2.1.11
 language: ruby
 rvm:
-  - "2.0.0"
-  - "2.1.0"
-  - "2.2.0"
-  - "2.3.0"
-  - "rbx"
-  - "jruby"
-matrix:
-  allow_failures:
-    - rvm: "rbx"
-    - rvm: "jruby"
+  - '2.1.10'
+  - '2.2.7'
+  - '2.3.4'
+  - '2.4.1'

data/CHANGELOG.md

@@ -1,6 +1,23 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## 0.5.0 - 2017-05-29
+
+### Added
+- Rubocop checks to specs.
+- Defaulted dev environment to ruby 2.3.4.
+
+### Deprecated
+- Nothing.
+
+### Removed
+- Testing support for older versions of ruby not supported by OmniAuth 1.5.
+- Key `[:urls]['Google']` no longer exists, it has been renamed to `[:urls][:google]`.
+
+### Fixed
+- Updated all code to rubocop conventions. This includes the Ruby 1.9 hash syntax when appropriate.
+- Example javascript flow now picks up ENV vars for google key and secret.
+
 ## 0.4.1 - 2016-03-14
 
 ### Added

data/Gemfile

@@ -1,7 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec
-
-group :example do
-  gem 'sinatra'
-end

data/README.md

@@ -1,5 +1,5 @@
 [![Gem Version](https://badge.fury.io/rb/omniauth-google-oauth2.svg)](https://badge.fury.io/rb/omniauth-google-oauth2)
-[![Build Status](https://travis-ci.org/zquestz/omniauth-google-oauth2.png)](https://travis-ci.org/zquestz/omniauth-google-oauth2)
+[![Build Status](https://travis-ci.org/zquestz/omniauth-google-oauth2.svg)](https://travis-ci.org/zquestz/omniauth-google-oauth2)
 
 # OmniAuth Google OAuth2 Strategy
 
@@ -7,7 +7,7 @@ Strategy to authenticate with Google via OAuth2 in OmniAuth.
 
 Get your API key at: https://code.google.com/apis/console/  Note the Client ID and the Client Secret.
 
-**Note**: You must enable the "Contacts API" and "Google+ API" via the Google API console. Otherwise, you will receive an `OAuth2::Error` stating that access is not configured when you attempt to authenticate.
+**Note**: You must enable the "Contacts API" and "Google+ API" via the Google API console. Otherwise, you will receive an `OAuth2::Error`(`Error: "Invalid credentials"`) stating that access is not configured when you attempt to authenticate.
 
 For more details, read the Google docs: https://developers.google.com/accounts/docs/OAuth2
 
@@ -16,7 +16,7 @@ For more details, read the Google docs: https://developers.google.com/accounts/d
 Add to your `Gemfile`:
 
 ```ruby
-gem "omniauth-google-oauth2"
+gem 'omniauth-google-oauth2'
 ```
 
 Then `bundle install`.
@@ -36,7 +36,7 @@ Here's an example for adding the middleware to a Rails app in `config/initialize
 
 ```ruby
 Rails.application.config.middleware.use OmniAuth::Builder do
-  provider :google_oauth2, ENV["GOOGLE_CLIENT_ID"], ENV["GOOGLE_CLIENT_SECRET"]
+  provider :google_oauth2, ENV['GOOGLE_CLIENT_ID'], ENV['GOOGLE_CLIENT_SECRET']
 end
 ```
 
@@ -44,15 +44,18 @@ You can now access the OmniAuth Google OAuth2 URL: `/auth/google_oauth2`
 
 For more examples please check out `examples/omni_auth.rb`
 
-NOTE: While developing your application, if you change the scope in the initializer you will need to restart your app server. Remember that 'email' and 'profile' scopes are required!
+NOTE: While developing your application, if you change the scope in the initializer you will need to restart your app server. Remember that either the 'email' or 'profile' scope is required!
 
 ## Configuration
 
 You can configure several options, which you pass in to the `provider` method via a hash:
 
 * `scope`: A comma-separated list of permissions you want to request from the user. See the [Google OAuth 2.0 Playground](https://developers.google.com/oauthplayground/) for a full list of available permissions. Caveats:
-  * The `email` and `profile` scopes are used by default. By defining your own `scope`, you override these defaults. If you need these scopes, don't forget to add them yourself!
+  * The `email` and `profile` scopes are used by default. By defining your own `scope`, you override these defaults, but Google requires at least one of `email` or `profile`, so make sure to add at least one of them to your scope!
   * Scopes starting with `https://www.googleapis.com/auth/` do not need that prefix specified. So while you can use the smaller scope `books` since that permission starts with the mentioned prefix, you should use the full scope URL `https://docs.google.com/feeds/` to access a user's docs, for example.
+
+* `redirect_uri`: Override the redirect_uri used by the gem.
+
 * `prompt`: A space-delimited list of string values that determines whether the user is re-prompted for authentication and/or consent. Possible values are:
   * `none`: No authentication or consent pages will be displayed; it will return an error if the user is not already authenticated and has not pre-configured consent for the requested scopes. This can be used as a method to check for existing authentication and/or consent.
   * `consent`: The user will always be prompted for consent, even if he has previously allowed access a given set of scopes.
@@ -80,7 +83,7 @@ You can configure several options, which you pass in to the `provider` method vi
 
 * `login_hint`: When your app knows which user it is trying to authenticate, it can provide this parameter as a hint to the authentication server. Passing this hint suppresses the account chooser and either pre-fill the email box on the sign-in form, or select the proper session (if the user is using multiple sign-in), which can help you avoid problems that occur if your app logs in the wrong user account. The value can be either an email address or the sub string, which is equivalent to the user's Google+ ID.
 
-* `include_granted_scopes`: If this is provided with the value true, and the authorization request is granted, the authorization will include any previous authorizations granted to this user/application combination for other scopes. See Google's [Incremental Autorization](https://developers.google.com/accounts/docs/OAuth2WebServer#incrementalAuth) for additional details.
+* `include_granted_scopes`: If this is provided with the value true, and the authorization request is granted, the authorization will include any previous authorizations granted to this user/application combination for other scopes. See Google's [Incremental Authorization](https://developers.google.com/accounts/docs/OAuth2WebServer#incrementalAuth) for additional details.
 
 * `openid_realm`: Set the OpenID realm value, to allow upgrading from OpenID based authentication to OAuth 2 based authentication. When this is set correctly an `openid_id` value will be set in `[:extra][:id_info]` in the authentication hash with the value of the user's OpenID ID URL.
 
@@ -88,66 +91,69 @@ Here's an example of a possible configuration where the strategy name is changed
 
 ```ruby
 Rails.application.config.middleware.use OmniAuth::Builder do
-  provider :google_oauth2, ENV["GOOGLE_CLIENT_ID"], ENV["GOOGLE_CLIENT_SECRET"],
+  provider :google_oauth2, ENV['GOOGLE_CLIENT_ID'], ENV['GOOGLE_CLIENT_SECRET'],
     {
-      :name => "google",
-      :scope => "email, profile, plus.me, http://gdata.youtube.com",
-      :prompt => "select_account",
-      :image_aspect_ratio => "square",
-      :image_size => 50
+      name: 'google',
+      scope: 'email, profile, plus.me, http://gdata.youtube.com',
+      prompt: 'select_account',
+      image_aspect_ratio: 'square',
+      image_size: 50
     }
 end
 ```
 
 ## Auth Hash
 
-Here's an example of an authentication hash available in the callback by accessing `request.env["omniauth.auth"]`:
+Here's an example of an authentication hash available in the callback by accessing `request.env['omniauth.auth']`:
 
 ```ruby
 {
-    :provider => "google_oauth2",
-    :uid => "123456789",
-    :info => {
-        :name => "John Doe",
-        :email => "john@company_name.com",
-        :first_name => "John",
-        :last_name => "Doe",
-        :image => "https://lh3.googleusercontent.com/url/photo.jpg"
-    },
-    :credentials => {
-        :token => "token",
-        :refresh_token => "another_token",
-        :expires_at => 1354920555,
-        :expires => true
+  "provider" => "google_oauth2",
+  "uid" => "100000000000000000000",
+  "info" => {
+    "name" => "John Smith",
+    "email" => "john@example.com",
+    "first_name" => "John",
+    "last_name" => "Smith",
+    "image" => "https://lh4.googleusercontent.com/photo.jpg",
+    "urls" => {
+      "google" => "https://plus.google.com/+JohnSmith"
+    }
+  },
+  "credentials" => {
+    "token" => "TOKEN",
+    "refresh_token" => "REFRESH_TOKEN",
+    "expires_at" => 1496120719,
+    "expires" => true
+  },
+  "extra" => {
+    "id_token" => "ID_TOKEN",
+    "id_info" => {
+      "azp" => "APP_ID",
+      "aud" => "APP_ID",
+      "sub" => "100000000000000000000",
+      "email" => "john@example.com",
+      "email_verified" => true,
+      "at_hash" => "HK6E_P6Dh8Y93mRNtsDB1Q",
+      "iss" => "accounts.google.com",
+      "iat" => 1496117119,
+      "exp" => 1496120719
     },
-    :extra => {
-        :raw_info => {
-            :sub => "123456789",
-            :email => "user@domain.example.com",
-            :email_verified => true,
-            :name => "John Doe",
-            :given_name => "John",
-            :family_name => "Doe",
-            :profile => "https://plus.google.com/123456789",
-            :picture => "https://lh3.googleusercontent.com/url/photo.jpg",
-            :gender => "male",
-            :birthday => "0000-06-25",
-            :locale => "en",
-            :hd => "company_name.com"
-        },
-        :id_info => {
-            "iss" => "accounts.google.com",
-            "at_hash" => "HK6E_P6Dh8Y93mRNtsDB1Q",
-            "email_verified" => "true",
-            "sub" => "10769150350006150715113082367",
-            "azp" => "APP_ID",
-            "email" => "jsmith@example.com",
-            "aud" => "APP_ID",
-            "iat" => 1353601026,
-            "exp" => 1353604926,
-            "openid_id" => "https://www.google.com/accounts/o8/id?id=ABCdfdswawerSDFDsfdsfdfjdsf"
-        }
+    "raw_info" => {
+      "kind" => "plus#personOpenIdConnect",
+      "gender" => "male",
+      "sub" => "100000000000000000000",
+      "name" => "John Smith",
+      "given_name" => "John",
+      "family_name" => "Smith",
+      "profile" => "https://plus.google.com/+JohnSmith",
+      "picture" => "https://lh4.googleusercontent.com/photo.jpg?sz=50",
+      "email" => "john@example.com",
+      "email_verified" => "true",
+      "locale" => "en",
+      "hd" => "company.com"
     }
+  }
 }
 ```
 
@@ -155,20 +161,22 @@ Here's an example of an authentication hash available in the callback by accessi
 
 First define your application id and secret in `config/initializers/devise.rb`. Do not use the snippet mentioned in the [Usage](https://github.com/zquestz/omniauth-google-oauth2#usage) section.
 
+Configuration options can be passed as the last parameter here as key/value pairs.
+
 ```ruby
-config.omniauth :google_oauth2, "GOOGLE_CLIENT_ID", "GOOGLE_CLIENT_SECRET", { }
+config.omniauth :google_oauth2, 'GOOGLE_CLIENT_ID', 'GOOGLE_CLIENT_SECRET', {}
 ```
 
 Then add the following to 'config/routes.rb' so the callback routes are defined.
 
 ```ruby
-devise_for :users, :controllers => { :omniauth_callbacks => "users/omniauth_callbacks" }
+devise_for :users, controllers: { omniauth_callbacks: 'users/omniauth_callbacks' }
 ```
 
 Make sure your model is omniauthable. Generally this is "/app/models/user.rb"
 
 ```ruby
-devise :omniauthable, :omniauth_providers => [:google_oauth2]
+devise :omniauthable, omniauth_providers: [:google_oauth2]
 ```
 
 Then make sure your callbacks controller is setup.
@@ -177,14 +185,14 @@ Then make sure your callbacks controller is setup.
 class Users::OmniauthCallbacksController < Devise::OmniauthCallbacksController
   def google_oauth2
       # You need to implement the method below in your model (e.g. app/models/user.rb)
-      @user = User.from_omniauth(request.env["omniauth.auth"])
+      @user = User.from_omniauth(request.env['omniauth.auth'])
 
       if @user.persisted?
-        flash[:notice] = I18n.t "devise.omniauth_callbacks.success", :kind => "Google"
-        sign_in_and_redirect @user, :event => :authentication
+        flash[:notice] = I18n.t 'devise.omniauth_callbacks.success', kind: 'Google'
+        sign_in_and_redirect @user, event: :authentication
       else
-        session["devise.google_data"] = request.env["omniauth.auth"]
-        redirect_to new_user_registration_url
+        session['devise.google_data'] = request.env['omniauth.auth'].except(:extra) #Removing extra as it can overflow some session stores
+        redirect_to new_user_registration_url, alert: @user.errors.full_messages.join("\n")
       end
   end
 end
@@ -195,12 +203,12 @@ and bind to or create the user
 ```ruby
 def self.from_omniauth(access_token)
     data = access_token.info
-    user = User.where(:email => data["email"]).first
+    user = User.where(email: data['email']).first
 
     # Uncomment the section below if you want users to be created if they don't exist
     # unless user
-    #     user = User.create(name: data["name"],
-    #        email: data["email"],
+    #     user = User.create(name: data['name'],
+    #        email: data['email'],
     #        password: Devise.friendly_token[0,20]
     #     )
     # end
@@ -210,7 +218,10 @@ end
 
 For your views you can login using:
 
-```ruby
+```erb
+<%= link_to "Sign in with Google", user_google_oauth2_omniauth_authorize_path %>
+
+<%# Devise prior 4.1.0: %>
 <%= link_to "Sign in with Google", user_omniauth_authorize_path(:google_oauth2) %>
 ```
 
@@ -261,8 +272,7 @@ window.gpAsyncInit = function() {
     }, function(response) {
       if (response && !response.error) {
         // google authentication succeed, now post data to server.
-        jQuery.ajax({type: 'POST', url: "/auth/google_oauth2/callback", 
-data: response,
+        jQuery.ajax({type: 'POST', url: '/auth/google_oauth2/callback', data: response,
           success: function(data) {
             // response from server
           }
@@ -276,23 +286,15 @@ data: response,
 
 ```
 
-### Omniauth state
-
-If you'd like to use omniauth state param, you can implement it by yourself using rails csrf token. For example:
+#### Note about mobile clients (iOS, Android)
 
-```ruby
-class ApplicationController < ActionController::Base
-  before_action :initialize_omniauth_state
+The documentation at https://developers.google.com/identity/sign-in/ios/offline-access specifies the _REDIRECT_URI_ to be either a set value or an EMPTY string for mobile logins to work. Else, you will run into _redirect_uri_mismatch_ errors.
 
-  protected
+In that case, ensure to send an additional parameter `redirect_uri=` (empty string) to the `/auth/google_oauth2/callback` URL from your mobile device.
 
-  def initialize_omniauth_state
-    session['omniauth.state'] = response.headers['X-CSRF-Token'] = form_authenticity_token
-  end
-...
-```
+#### Note about CORS
 
-and add ```skip_before_filter :verify_authenticity_token``` in your omniauth callback controller because it is already verified by omniauth state. And then you need to add ```:provider_ignores_state => true``` in your omniauth initializer.
+If you're making POST requests to `/auth/google_oauth2/callback` from another domain, then you need to make sure `'X-Requested-With': 'XMLHttpRequest'` header is included with your request, otherwise your server might respond with `OAuth2::Error, : Invalid Value` error.
 
 ## Fixing Protocol Mismatch for `redirect_uri` in Rails
 
@@ -305,7 +307,7 @@ OmniAuth.config.full_host = Rails.env.production? ? 'https://domain.com' : 'http
 
 ## License
 
-Copyright (c) 2016 by Josh Ellithorpe
+Copyright (c) 2017 by Josh Ellithorpe
 
 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:
 

data/Rakefile

@@ -1,7 +1,8 @@
-#!/usr/bin/env rake
+# frozen_string_literal: true
+
 require File.join('bundler', 'gem_tasks')
 require File.join('rspec', 'core', 'rake_task')
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/examples/Gemfile

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
-gem 'sinatra'
-gem 'omniauth-google-oauth2'
+gem 'omniauth-google-oauth2', '~> 0.5'
+gem 'sinatra', '~> 1.4'

data/examples/config.ru

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Sample app for Google OAuth2 Strategy
 # Make sure to setup the ENV variables GOOGLE_KEY and GOOGLE_SECRET
 # Run with "bundle exec rackup"
@@ -15,31 +17,104 @@ require 'omniauth-google-oauth2'
 # http://railsapps.github.io/openssl-certificate-verify-failed.html
 OpenSSL::SSL::VERIFY_PEER = OpenSSL::SSL::VERIFY_NONE
 
+# Main example app for omniauth-google-oauth2
 class App < Sinatra::Base
   get '/' do
     <<-HTML
-    <ul>
-      <li><a href='/auth/google_oauth2'>Sign in with Google</a></li>
-    </ul>
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Google OAuth2 Example</title>
+    <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.2.1/jquery.min.js"></script>
+    <script>
+      jQuery(function() {
+        return $.ajax({
+          url: 'https://apis.google.com/js/client:plus.js?onload=gpAsyncInit',
+          dataType: 'script',
+          cache: true
+        });
+      });
+
+      window.gpAsyncInit = function() {
+        gapi.auth.authorize({
+          immediate: true,
+          response_type: 'code',
+          cookie_policy: 'single_host_origin',
+          client_id: '#{ENV['GOOGLE_KEY']}',
+          scope: 'email profile'
+        }, function(response) {
+          return;
+        });
+        $('.googleplus-login').click(function(e) {
+          e.preventDefault();
+          gapi.auth.authorize({
+            immediate: false,
+            response_type: 'code',
+            cookie_policy: 'single_host_origin',
+            client_id: '#{ENV['GOOGLE_KEY']}',
+            scope: 'email profile'
+          }, function(response) {
+            if (response && !response.error) {
+              // google authentication succeed, now post data to server.
+              jQuery.ajax({type: 'POST', url: "/auth/google_oauth2/callback", data: response,
+                success: function(data) {
+                  // Log the data returning from google.
+                  console.log(data)
+                }
+              });
+            } else {
+              // google authentication failed.
+              console.log("FAILED")
+            }
+          });
+        });
+      };
+    </script>
+  </head>
+  <body>
+  <ul>
+    <li><a href='/auth/google_oauth2'>Sign in with Google</a></li>
+    <li><a href='#' class="googleplus-login">Sign in with Google via AJAX</a></li>
+  </ul>
+  </body>
+</html>
     HTML
   end
 
+  post '/auth/:provider/callback' do
+    content_type 'text/plain'
+    begin
+      request.env['omniauth.auth'].to_hash.inspect
+    rescue
+      'No Data'
+    end
+  end
+
   get '/auth/:provider/callback' do
     content_type 'text/plain'
-    request.env['omniauth.auth'].to_hash.inspect rescue "No Data"
+    begin
+      request.env['omniauth.auth'].to_hash.inspect
+    rescue
+      'No Data'
+    end
   end
 
   get '/auth/failure' do
     content_type 'text/plain'
-    request.env['omniauth.auth'].to_hash.inspect rescue "No Data"
+    begin
+      request.env['omniauth.auth'].to_hash.inspect
+    rescue
+      'No Data'
+    end
   end
 end
 
-use Rack::Session::Cookie, :secret => ENV['RACK_COOKIE_SECRET']
+use Rack::Session::Cookie, secret: ENV['RACK_COOKIE_SECRET']
 
 use OmniAuth::Builder do
   # For additional provider examples please look at 'omni_auth.rb'
-  provider :google_oauth2, ENV['GOOGLE_KEY'], ENV['GOOGLE_SECRET'], {}
+  # The key provider_ignores_state is only for AJAX flows. It is not recommended for normal logins.
+  provider :google_oauth2, ENV['GOOGLE_KEY'], ENV['GOOGLE_SECRET'], access_type: 'offline', prompt: 'consent', provider_ignores_state: true, scope: 'email,profile,calendar'
 end
 
 run App.new