omniauth-google-oauth2 0.2.1 → 0.2.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    Nzk0NDc2ZmZhYjJiOTI1OWI5NDY1NDcwZTNlNWE2NTI0OTk1OWQwNQ==
+  data.tar.gz: !binary |-
+    NmMzNzgxNzg3NDAxYTE5NGI1ODc5MzA1MDY3YmI1MGNlZjc5ODlkYQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NWEzNjllMDY0ODRkMTY1ZTljMGYwOGQzZWI4YjE3ZWUxMGY1YWUwMjQxMjVh
+    NDhjNTRlYzVlOWFiYWU2ZjZhYWQwMThlNzU0NmI1NzE0MTc1NGRlOTYwMjk2
+    NTY5ZWE0Mjk4MjNiZTNkN2NmYWQ5ZmJlOWRhYWE2YjUxZDA3YWY=
+  data.tar.gz: !binary |-
+    NTFhODFlZDlkZDVmMTY4NzJkMzc4YzJmZGMzZjc4NTA2ZGE0Y2NhMDY0MTEx
+    YTg5ZmU5NGZhOWFjNWIzOThiNjMxMzlkMzljMjFlZTFlNDVhYTY5NzZhY2Iz
+    YWU5YzA4MDFiOWY5NDEyNWUxMDQxZWEzNDAzOTYwM2RlMDkzMjM=

data/.ruby-gemset

@@ -0,0 +1 @@
+omniauth-google-oauth2

data/.ruby-version

@@ -1 +1 @@
-ruby-1.9.3
+1.9.3-p484

data/.travis.yml

@@ -1,6 +1,8 @@
+before_install:
+  - gem update --system 2.1.11
 language: ruby
 rvm:
   - "1.8.7"
   - "1.9.2"
   - "1.9.3"
-  - "2.0.0"
+  - "2.0.0"

data/README.md

@@ -28,7 +28,7 @@ end
 
 You can now access the OmniAuth Google OAuth2 URL: `/auth/google_oauth2`
 
-Fore more examples please check out `examples/omni_auth.rb`
+For more examples please check out `examples/omni_auth.rb`
 
 ## Configuration
 
@@ -36,7 +36,7 @@ You can configure several options, which you pass in to the `provider` method vi
 
 * `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 `userinfo.email` and `userinfo.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!
-  * Scopes starting with `https://www.googleapis.com/auth/` do not need that prefix specified. So while you should 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.
+  * 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.
 * `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.
@@ -50,16 +50,19 @@ You can configure several options, which you pass in to the `provider` method vi
 
   Defaults to `original`.
 
-* `image_size`: The size of the user's profile picture. The image returned will have width equal to the given value and variable height, according to the `image_aspect_ratio` chosen. Additionally, a picture with specific width and height can be request by setting this option to a hash with `:width` and `:height` as keys. If only `:width` or `:height` is specified, a picture whose width or height is closest to the requested size and requested aspect ratio will be returned. Defaults to the original width and height of the picture.
+* `image_size`: The size of the user's profile picture. The image returned will have width equal to the given value and variable height, according to the `image_aspect_ratio` chosen. Additionally, a picture with specific width and height can be requested by setting this option to a hash with `width` and `height` as keys. If only `width` or `height` is specified, a picture whose width or height is closest to the requested size and requested aspect ratio will be returned. Defaults to the original width and height of the picture.
 
-* `access_type`: Defaults to `offline`, so a refresh token is sent to be used when the user is not present at the browser. Can be set to `online`.
+* `name`: The name of the strategy. The default name is `google_oauth2` but it can be changed to any value, for example `google`. The OmniAuth URL will thus change to `/auth/google` and the `provider` key in the auth hash will then return `google`.
 
-Here's an example of a possible configuration where the user is asked for extra permissions, the user is always prompted to select his account when logging in and the user's profile picture is returned as a thumbnail:
+* `access_type`: Defaults to `offline`, so a refresh token is sent to be used when the user is not present at the browser. Can be set to `online`. Note that if you need a refresh token, google requires you to also to specify the option `prompt: 'consent'`, which is not a default.
+
+Here's an example of a possible configuration where the strategy name is changed, the user is asked for extra permissions, the user is always prompted to select his account when logging in and the user's profile picture is returned as a thumbnail:
 
 ```ruby
 Rails.application.config.middleware.use OmniAuth::Builder do
   provider :google_oauth2, ENV["GOOGLE_KEY"], ENV["GOOGLE_SECRET"],
     {
+      :name => "google",
       :scope => "userinfo.email, userinfo.profile, plus.me, http://gdata.youtube.com",
       :prompt => "select_account",
       :image_aspect_ratio => "square",

data/lib/omniauth/google_oauth2/version.rb

@@ -1,5 +1,5 @@
 module OmniAuth
   module GoogleOauth2
-    VERSION = "0.2.1"
+    VERSION = "0.2.2"
   end
 end

data/lib/omniauth/strategies/google_oauth2.rb

@@ -8,7 +8,9 @@ module OmniAuth
 
       option :name, 'google_oauth2'
 
-      option :authorize_options, [:access_type, :hd, :login_hint, :prompt, :scope, :state, :redirect_uri]
+      option :skip_friends, true
+
+      option :authorize_options, [:access_type, :hd, :login_hint, :prompt, :request_visible_actions, :scope, :state, :redirect_uri]
 
       option :client_options, {
         :site          => 'https://accounts.google.com',
@@ -49,7 +51,9 @@ module OmniAuth
 
       extra do
         hash = {}
+        hash[:id_token] = access_token['id_token']
         hash[:raw_info] = raw_info unless skip_info?
+        hash[:raw_friend_info] = raw_friend_info(raw_info['id']) unless skip_info? || options[:skip_friends]
         prune! hash
       end
 
@@ -57,6 +61,10 @@ module OmniAuth
         @raw_info ||= access_token.get('https://www.googleapis.com/oauth2/v1/userinfo').parsed
       end
 
+      def raw_friend_info(id)
+        @raw_friend_info ||= access_token.get("https://www.googleapis.com/plus/v1/people/#{id}/people/visible").parsed
+      end
+
       def custom_build_access_token
         if verify_token(request.params['id_token'], request.params['access_token'])
           ::OAuth2::AccessToken.from_hash(client, request.params.dup)

data/spec/omniauth/strategies/google_oauth2_spec.rb

@@ -121,6 +121,17 @@ describe OmniAuth::Strategies::GoogleOauth2 do
       end
     end
 
+    describe 'request_visible_actions' do
+      it "should default to nil" do
+        subject.authorize_params['request_visible_actions'].should eq(nil)
+      end
+
+      it 'should set the request_visible_actions parameter if present' do
+        @options = {:request_visible_actions => 'something'}
+        subject.authorize_params['request_visible_actions'].should eq('something')
+      end
+    end
+
     describe 'scope' do
       it 'should expand scope shortcuts' do
         @options = {:scope => 'userinfo.email'}
@@ -238,15 +249,82 @@ describe OmniAuth::Strategies::GoogleOauth2 do
     end
   end
 
-  describe 'raw info' do
-    it 'should include raw_info in extras hash by default' do
-      subject.stub(:raw_info) { {:foo => 'bar'} }
-      subject.extra[:raw_info].should eq({:foo => 'bar'})
+  describe '#extra' do
+    let(:client) do
+      OAuth2::Client.new('abc', 'def') do |builder|
+        builder.request :url_encoded
+        builder.adapter :test do |stub|
+          stub.get('/oauth2/v1/userinfo') {|env| [200, {'content-type' => 'application/json'}, '{"id": "12345"}']}
+          stub.get('/plus/v1/people/12345/people/visible') {|env| [200, {'content-type' => 'application/json'}, '[{"foo":"bar"}]']}
+        end
+      end
+    end
+    let(:access_token) { OAuth2::AccessToken.from_hash(client, {}) }
+
+    before { subject.stub(:access_token => access_token) }
+
+    describe 'id_token' do
+      context 'when the id_token is passed into the access token' do
+       let(:access_token) { OAuth2::AccessToken.from_hash(client, {'id_token' => 'xyz'}) }
+
+        it 'should include id_token when set on the access_token' do
+          subject.extra.should include(:id_token => 'xyz')
+        end
+      end
+
+      context 'when the id_token is missing' do
+        it 'should not include id_token' do
+          subject.extra.should_not have_key(:id_token)
+        end
+      end
+    end
+
+    describe 'raw_info' do
+      context 'when skip_info is true' do
+        before { subject.options[:skip_info] = true }
+
+        it 'should not include raw_info' do
+          subject.extra.should_not have_key(:raw_info)
+        end
+      end
+
+      context 'when skip_info is false' do
+        before { subject.options[:skip_info] = false }
+
+        it 'should include raw_info' do
+          subject.extra[:raw_info].should eq('id' => '12345')
+        end
+      end
     end
 
-    it 'should not include raw_info in extras hash when skip_info is specified' do
-      @options = {:skip_info => true}
-      subject.extra.should_not have_key(:raw_info)
+    describe 'raw_friend_info' do
+      context 'when skip_info is true' do
+        before { subject.options[:skip_info] = true }
+
+        it 'should not include raw_friend_info' do
+          subject.extra.should_not have_key(:raw_friend_info)
+        end
+      end
+
+      context 'when skip_info is false' do
+        before { subject.options[:skip_info] = false }
+
+        context 'when skip_friends is true' do
+          before { subject.options[:skip_friends] = true }
+
+          it 'should not include raw_friend_info' do
+            subject.extra.should_not have_key(:raw_friend_info)
+          end
+        end
+
+        context 'when skip_friends is false' do
+          before { subject.options[:skip_friends] = false }
+
+          it 'should not include raw_friend_info' do
+            subject.extra[:raw_friend_info].should eq([{'foo' => 'bar'}])
+          end
+        end
+      end
     end
   end
 

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-google-oauth2
 version: !ruby/object:Gem::Version
-  version: 0.2.1
-  prerelease: 
+  version: 0.2.2
 platform: ruby
 authors:
 - Josh Ellithorpe
@@ -10,12 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-16 00:00:00.000000000 Z
+date: 2013-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -23,7 +21,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -31,7 +28,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth-oauth2
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -39,7 +35,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -47,7 +42,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -55,7 +49,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -63,7 +56,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -71,7 +63,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -84,6 +75,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .ruby-gemset
 - .ruby-version
 - .rvmrc
 - .travis.yml
@@ -101,32 +93,25 @@ files:
 - spec/spec_helper.rb
 homepage: ''
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -775688096927888860
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -775688096927888860
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.0.7
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A Google OAuth2 strategy for OmniAuth 1.x
 test_files: []