omniauth-google-oauth2 0.1.18 → 0.1.19

data/README.md

@@ -42,17 +42,27 @@ You can configure several options, which you pass in to the `provider` method vi
 
   If no value is specified, the user only sees the authentication page if he is not logged in and only sees the consent page the first time he authorizes a given set of scopes.
 
+* `image_aspect_ratio`: The shape of the user's profile picture. Possible values are:
+  * `original`: Picture maintains its original aspect ratio.
+  * `square`: Picture presents equal width and height.
+
+  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.
+
 * `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`.
 
-Here's an example of a possible configuration where the user is asked for extra permissions and is always prompted to select his account when logging in:
+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:
 
 ```ruby
 Rails.application.config.middleware.use OmniAuth::Builder do
   provider :google_oauth2, ENV["GOOGLE_KEY"], ENV["GOOGLE_SECRET"],
-           {
-             :scope => "userinfo.email, userinfo.profile, plus.me, http://gdata.youtube.com",
-             :prompt => "consent select_account"
-           }
+    {
+      :scope => "userinfo.email, userinfo.profile, plus.me, http://gdata.youtube.com",
+      :prompt => "select_account",
+      :image_aspect_ratio => "square",
+      :image_size => 50
+    }
 end
 ```
 

data/lib/omniauth/google_oauth2/version.rb

@@ -1,5 +1,5 @@
 module OmniAuth
   module GoogleOauth2
-    VERSION = "0.1.18"
+    VERSION = "0.1.19"
   end
 end

data/lib/omniauth/strategies/google_oauth2.rb

@@ -43,7 +43,7 @@ module OmniAuth
           :email      => verified_email,
           :first_name => raw_info['given_name'],
           :last_name  => raw_info['family_name'],
-          :image      => raw_info['picture'],
+          :image      => image_url(options),
           :urls => {
             'Google' => raw_info['link']
           }
@@ -85,6 +85,23 @@ module OmniAuth
         raw_info['verified_email'] ? raw_info['email'] : nil
       end
 
+      def image_url(options)
+        original_url = raw_info['picture']
+        return original_url if original_url.nil? || (!options[:image_size] && !options[:image_aspect_ratio])
+
+        image_params = []
+        if options[:image_size].is_a?(Integer)
+          image_params << "s#{options[:image_size]}"
+        elsif options[:image_size].is_a?(Hash)
+          image_params << "w#{options[:image_size][:width]}" if options[:image_size][:width]
+          image_params << "h#{options[:image_size][:height]}" if options[:image_size][:height]
+        end
+        image_params << 'c' if options[:image_aspect_ratio] == 'square'
+
+        params_index = original_url.index('/photo.jpg')
+        original_url.insert(params_index, '/'+image_params.join('-'))
+      end
+
       def verify_token(id_token, access_token)
         # Verify id_token as well
         # request fails and raises error when id_token or access_token is invalid

data/spec/omniauth/strategies/google_oauth2_spec.rb

@@ -159,6 +159,48 @@ describe OmniAuth::Strategies::GoogleOauth2 do
     end
   end
 
+  describe 'image options' do
+    it 'should return the image with size specified in the `image_size` option' do
+      @options = { :image_size => 50 }
+      subject.stub(:raw_info) { { 'picture' => 'https://lh3.googleusercontent.com/url/photo.jpg' } }
+      main_url, image_params = subject.info[:image].match(/^(.*)\/(.*)\/photo.jpg/).captures
+      main_url.should eq('https://lh3.googleusercontent.com/url')
+      image_params.should eq('s50')
+    end
+
+    it 'should return the image with width and height specified in the `image_size` option' do
+      @options = { :image_size => { :width => 50, :height => 50 } }
+      subject.stub(:raw_info) { { 'picture' => 'https://lh3.googleusercontent.com/url/photo.jpg' } }
+      main_url, image_params = subject.info[:image].match(/^(.*)\/(.*)\/photo.jpg/).captures
+      image_params = image_params.split('-').inject({}) do |result, element|
+        result[element.slice!(0)] = element
+        result
+      end
+      main_url.should eq('https://lh3.googleusercontent.com/url')
+      image_params['w'].should eq('50')
+      image_params['h'].should eq('50')
+    end
+
+    it 'should return square image when `image_aspect_ratio` is specified' do
+      @options = { :image_aspect_ratio => 'square' }
+      subject.stub(:raw_info) { { 'picture' => 'https://lh3.googleusercontent.com/url/photo.jpg' } }
+      main_url, image_params = subject.info[:image].match(/^(.*)\/(.*)\/photo.jpg/).captures
+      main_url.should eq('https://lh3.googleusercontent.com/url')
+      image_params.should eq('c')
+    end
+
+    it 'should not break if no picture present in raw_info' do
+      @options = { :image_aspect_ratio => 'square' }
+      subject.stub(:raw_info) { { 'name' => 'User Without Pic' } }
+      subject.info[:image].should be_nil
+    end
+
+    it 'should return original image if no options are provided' do
+      subject.stub(:raw_info) { { 'picture' => 'https://lh3.googleusercontent.com/url/photo.jpg' } }
+      subject.info[:image].should eq('https://lh3.googleusercontent.com/url/photo.jpg')
+    end
+  end
+
   describe 'build_access_token' do
     it 'should read access_token from hash' do
       @request.stub(:params).and_return('id_token' => 'valid_id_token', 'access_token' => 'valid_access_token')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-google-oauth2
 version: !ruby/object:Gem::Version
-  version: 0.1.18
+  version: 0.1.19
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-17 00:00:00.000000000 Z
+date: 2013-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth
@@ -112,7 +112,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 465443751449155842
+      hash: 3969644160829709281
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -121,7 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 465443751449155842
+      hash: 3969644160829709281
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25