class OmniAuth::Strategies::GoogleOauth2
Main class for Google OAuth2 strategy.
Constants
- BASE_SCOPES
- BASE_SCOPE_URL
- DEFAULT_SCOPE
Public Instance Methods
custom_build_access_token()
click to toggle source
# File lib/omniauth/strategies/google_oauth2.rb, line 92 def custom_build_access_token access_token = get_access_token(request) verify_hd(access_token) access_token end
Also aliased as: build_access_token
raw_friend_info(id)
click to toggle source
# File lib/omniauth/strategies/google_oauth2.rb, line 84 def raw_friend_info(id) @raw_friend_info ||= access_token.get("https://www.googleapis.com/plus/v1/people/#{id}/people/visible").parsed end
raw_image_info(id)
click to toggle source
# File lib/omniauth/strategies/google_oauth2.rb, line 88 def raw_image_info(id) @raw_image_info ||= access_token.get("https://www.googleapis.com/plus/v1/people/#{id}?fields=image").parsed end
raw_info()
click to toggle source
# File lib/omniauth/strategies/google_oauth2.rb, line 80 def raw_info @raw_info ||= access_token.get('https://www.googleapis.com/plus/v1/people/me/openIdConnect').parsed end
Private Instance Methods
callback_url()
click to toggle source
# File lib/omniauth/strategies/google_oauth2.rb, line 102 def callback_url options[:redirect_uri] || (full_host + script_name + callback_path) end
get_access_token(request)
click to toggle source
# File lib/omniauth/strategies/google_oauth2.rb, line 106 def get_access_token(request) if request.xhr? && request.params['code'] verifier = request.params['code'] redirect_uri = request.params['redirect_uri'] || 'postmessage' client.auth_code.get_token(verifier, get_token_options(redirect_uri), deep_symbolize(options.auth_token_params || {})) elsif request.params['code'] && request.params['redirect_uri'] verifier = request.params['code'] redirect_uri = request.params['redirect_uri'] client.auth_code.get_token(verifier, get_token_options(redirect_uri), deep_symbolize(options.auth_token_params || {})) elsif verify_token(request.params['access_token']) ::OAuth2::AccessToken.from_hash(client, request.params.dup) else verifier = request.params['code'] client.auth_code.get_token(verifier, get_token_options(callback_url), deep_symbolize(options.auth_token_params)) end end
get_scope(params)
click to toggle source
# File lib/omniauth/strategies/google_oauth2.rb, line 123 def get_scope(params) raw_scope = params[:scope] || DEFAULT_SCOPE scope_list = raw_scope.split(' ').map { |item| item.split(',') }.flatten scope_list.map! { |s| s =~ %r{^https?://} || BASE_SCOPES.include?(s) ? s : "#{BASE_SCOPE_URL}#{s}" } scope_list.join(' ') end
get_token_options(redirect_uri)
click to toggle source
# File lib/omniauth/strategies/google_oauth2.rb, line 130 def get_token_options(redirect_uri) { redirect_uri: redirect_uri }.merge(token_params.to_hash(symbolize_keys: true)) end
image_params()
click to toggle source
# File lib/omniauth/strategies/google_oauth2.rb, line 166 def image_params 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' '/' + image_params.join('-') end
image_size_opts_passed?()
click to toggle source
# File lib/omniauth/strategies/google_oauth2.rb, line 162 def image_size_opts_passed? options[:image_size] || options[:image_aspect_ratio] end
image_url()
click to toggle source
# File lib/omniauth/strategies/google_oauth2.rb, line 145 def image_url return nil unless raw_info['picture'] u = URI.parse(raw_info['picture'].gsub('https:https', 'https')) path_index = u.path.to_s.index('/photo.jpg') if path_index && image_size_opts_passed? u.path.insert(path_index, image_params) u.path = u.path.gsub('//', '/') end u.query = strip_unnecessary_query_parameters(u.query) u.to_s end
prune!(hash)
click to toggle source
# File lib/omniauth/strategies/google_oauth2.rb, line 134 def prune!(hash) hash.delete_if do |_, v| prune!(v) if v.is_a?(Hash) v.nil? || (v.respond_to?(:empty?) && v.empty?) end end
strip_unnecessary_query_parameters(query_parameters)
click to toggle source
# File lib/omniauth/strategies/google_oauth2.rb, line 179 def strip_unnecessary_query_parameters(query_parameters) # strip `sz` parameter (defaults to sz=50) which overrides `image_size` options return nil if query_parameters.nil? params = CGI.parse(query_parameters) stripped_params = params.delete_if { |key| key == 'sz' } # don't return an empty Hash since that would result # in URLs with a trailing ? character: http://image.url? return nil if stripped_params.empty? URI.encode_www_form(stripped_params) end
verified_email()
click to toggle source
# File lib/omniauth/strategies/google_oauth2.rb, line 141 def verified_email raw_info['email_verified'] ? raw_info['email'] : nil end
verify_hd(access_token)
click to toggle source
# File lib/omniauth/strategies/google_oauth2.rb, line 200 def verify_hd(access_token) return true unless options.hd @raw_info ||= access_token.get('https://www.googleapis.com/plus/v1/people/me/openIdConnect').parsed options.hd = options.hd.call if options.hd.is_a? Proc allowed_hosted_domains = Array(options.hd) raise CallbackError.new(:invalid_hd, 'Invalid Hosted Domain') unless allowed_hosted_domains.include?(@raw_info['hd']) || options.hd == '*' true end
verify_token(access_token)
click to toggle source
# File lib/omniauth/strategies/google_oauth2.rb, line 193 def verify_token(access_token) return false unless access_token raw_response = client.request(:get, 'https://www.googleapis.com/oauth2/v3/tokeninfo', params: { access_token: access_token }).parsed raw_response['aud'] == options.client_id || options.authorized_client_ids.include?(raw_response['aud']) end