X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/a3e0ea84510b67400f203598eca7b91286ca84b5..ee6f8ae6f983f2beb1afa94f9332f9e244fbbb9d:/lib/google/api_client.rb diff --git a/lib/google/api_client.rb b/lib/google/api_client.rb index 4a9678d10b..4c9ee03c7a 100644 --- a/lib/google/api_client.rb +++ b/lib/google/api_client.rb @@ -20,19 +20,25 @@ require 'compat/multi_json' require 'stringio' require 'google/api_client/version' +require 'google/api_client/logging' require 'google/api_client/errors' require 'google/api_client/environment' require 'google/api_client/discovery' +require 'google/api_client/request' require 'google/api_client/reference' require 'google/api_client/result' require 'google/api_client/media' require 'google/api_client/service_account' require 'google/api_client/batch' +require 'google/api_client/railtie' if defined?(Rails) module Google + ## # This class manages APIs communication. class APIClient + include Google::APIClient::Logging + ## # Creates a new Google API client. # @@ -46,6 +52,10 @@ module Google #
  • :oauth_1
    • #
  • :oauth_2
    • # + # @option options [Boolean] :auto_refresh_token (true) + # The setting that controls whether or not the api client attempts to + # refresh authorization when a 401 is hit in #execute. If the token does + # not support it, this option is ignored. # @option options [String] :application_name # The name of the application using the client. # @option options [String] :application_version @@ -61,6 +71,8 @@ module Google # @option options [String] :discovery_path ("/discovery/v1") # The discovery base path. This rarely needs to be changed. def initialize(options={}) + logger.debug { "#{self.class} - Initializing client with options #{options}" } + # Normalize key to String to allow indifferent access. options = options.inject({}) do |accu, (key, value)| accu[key.to_sym] = value @@ -73,26 +85,29 @@ module Google # Most developers will want to leave this value alone and use the # application_name option. - application_string = ( - options[:application_name] ? ( - "#{options[:application_name]}/" + - "#{options[:application_version] || '0.0.0'}" - ) : "" - ) + if options[:application_name] + app_name = options[:application_name] + app_version = options[:application_version] + application_string = "#{app_name}/#{app_version || '0.0.0'}" + else + logger.warn { "#{self.class} - Please provide :application_name and :application_version when initializing the client" } + end self.user_agent = options[:user_agent] || ( "#{application_string} " + - "google-api-ruby-client/#{VERSION::STRING} " + + "google-api-ruby-client/#{Google::APIClient::VERSION::STRING} " + ENV::OS_VERSION ).strip # The writer method understands a few Symbols and will generate useful # default authentication mechanisms. self.authorization = options.key?(:authorization) ? options[:authorization] : :oauth_2 + self.auto_refresh_token = options.fetch(:auto_refresh_token) { true } self.key = options[:key] self.user_ip = options[:user_ip] @discovery_uris = {} @discovery_documents = {} @discovered_apis = {} + return self end @@ -152,6 +167,13 @@ module Google return @authorization end + ## + # The setting that controls whether or not the api client attempts to + # refresh authorization when a 401 is hit in #execute. + # + # @return [Boolean] + attr_accessor :auto_refresh_token + ## # The application's API key issued by the API console. # @@ -341,7 +363,7 @@ module Google # Returns the method object for a given RPC name and service version. # # @param [String, Symbol] rpc_name The RPC name of the desired method. - # @param [String, Symbol] rpc_name The API the method is within. + # @param [String, Symbol] api The API the method is within. # @param [String] version The desired version of the API. # # @return [Google::APIClient::Method] The method object. @@ -439,7 +461,7 @@ module Google ## # Generates a request. # - # @option options [Google::APIClient::Method, String] :api_method + # @option options [Google::APIClient::Method] :api_method # The method object or the RPC name of the method being executed. # @option options [Hash, Array] :parameters # The parameters to send to the method. @@ -480,15 +502,13 @@ module Google # If a Hash, the below parameters are handled. If an Array, the # parameters are assumed to be in the below order: # - # - (Google::APIClient::Method, String) api_method: + # - (Google::APIClient::Method) api_method: # The method object or the RPC name of the method being executed. # - (Hash, Array) parameters: # The parameters to send to the method. # - (String) body: The body of the request. # - (Hash, Array) headers: The HTTP headers for the request. # - (Hash) options: A set of options for the request, of which: - # - (String) :version (default: "v1") - - # The service version. Only used if `api_method` is a `String`. # - (#generate_authenticated_request) :authorization (default: true) - # The authorization mechanism for the response. Used only if # `:authenticated` is `true`. @@ -502,8 +522,9 @@ module Google # result = client.execute(batch_request) # # @example + # plus = client.discovered_api('plus') # result = client.execute( - # :api_method => 'plus.activities.list', + # :api_method => plus.activities.list, # :parameters => {'collection' => 'public', 'userId' => 'me'} # ) # @@ -528,21 +549,28 @@ module Google options[:parameters] = params.shift if params.size > 0 options[:body] = params.shift if params.size > 0 options[:headers] = params.shift if params.size > 0 - options[:client] = self + options.update(params.shift) if params.size > 0 request = self.generate_request(options) end + request.headers['User-Agent'] ||= '' + self.user_agent unless self.user_agent.nil? + request.parameters['key'] ||= self.key unless self.key.nil? + request.parameters['userIp'] ||= self.user_ip unless self.user_ip.nil? + connection = options[:connection] || Faraday.default_connection request.authorization = options[:authorization] || self.authorization unless options[:authenticated] == false result = request.send(connection) - - if request.upload_type == 'resumable' - upload = result.resumable_upload - unless upload.complete? - result = upload.send(connection) + if result.status == 401 && authorization.respond_to?(:refresh_token) && auto_refresh_token + begin + logger.debug("Attempting refresh of access token & retry of request") + authorization.fetch_access_token! + result = request.send(connection) + rescue Signet::AuthorizationError + # Ignore since we want the original error end end + return result end @@ -571,38 +599,12 @@ module Google return result end - ## - # Ensures API method names specified as strings resolve to - # discovered method instances - def resolve_method(method, version) - version ||= 'v1' - if method.kind_of?(Google::APIClient::Method) || method == nil - return method - elsif method.respond_to?(:to_str) || method.kind_of?(Symbol) - # This method of guessing the API is unreliable. This will fail for - # APIs where the first segment of the RPC name does not match the - # service name. However, this is a fallback mechanism anyway. - # Developers should be passing in a reference to the method, rather - # than passing in a string or symbol. This should raise an error - # in the case of a mismatch. - method = method.to_s - api = method[/^([^.]+)\./, 1] - api_method = self.discovered_method(method, api, version) - if api_method.nil? - raise ArgumentError, "API method could not be found." - end - return api_method - else - raise TypeError, - "Expected Google::APIClient::Method, got #{method.class}." - end - end - protected ## # Resolves a URI template against the client's configured base. # + # @api private # @param [String, Addressable::URI, Addressable::Template] template # The template to resolve. # @param [Hash] mapping The mapping that corresponds to the template.