X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/91ae01aa83e1991975303dad1dbb4d883e243700..8e49ee764b483948524b74eff103ce0ba229593b:/lib/google/api_client.rb

diff --git a/lib/google/api_client.rb b/lib/google/api_client.rb
index 90f422bd0f..baeae1c685 100644
--- a/lib/google/api_client.rb
+++ b/lib/google/api_client.rb
@@ -31,6 +31,7 @@ require 'google/api_client/media'
 require 'google/api_client/service_account'
 require 'google/api_client/batch'
 require 'google/api_client/gzip'
+require 'google/api_client/charset'
 require 'google/api_client/client_secrets'
 require 'google/api_client/railtie' if defined?(Rails)
 
@@ -75,6 +76,9 @@ module Google
     # @option options [String] :ca_file
     #   Optional set of root certificates to use when validating SSL connections.
     #   By default, a bundled set of trusted roots will be used.
+    # @options options[Hash] :force_encoding
+    #   Experimental option. True if response body should be force encoded into the charset
+    #   specified in the Content-Type header. Mostly intended for compressed content.
     # @options options[Hash] :faraday_options
     #   Pass through of options to set on the Faraday connection
     def initialize(options={})
@@ -114,11 +118,13 @@ module Google
       self.key = options[:key]
       self.user_ip = options[:user_ip]
       self.retries = options.fetch(:retries) { 0 }
+      self.expired_auth_retry = options.fetch(:expired_auth_retry) { true }
       @discovery_uris = {}
       @discovery_documents = {}
       @discovered_apis = {}
       ca_file = options[:ca_file] || File.expand_path('../../cacerts.pem', __FILE__)
       self.connection = Faraday.new do |faraday|
+        faraday.response :charset if options[:force_encoding]
         faraday.response :gzip
         faraday.options.params_encoder = Faraday::FlatParamsEncoder
         faraday.ssl.ca_file = ca_file
@@ -250,6 +256,13 @@ module Google
     #  Number of retries
     attr_accessor :retries
 
+    ##
+    # Whether or not an expired auth token should be re-acquired
+    # (and the operation retried) regardless of retries setting
+    # @return [Boolean]
+    #  Auto retry on auth expiry
+    attr_accessor :expired_auth_retry
+
     ##
     # Returns the URI for the directory document.
     #
@@ -265,10 +278,12 @@ module Google
     # @param [String, Symbol] api The API name.
     # @param [String] version The desired version of the API.
     # @param [Addressable::URI] uri The URI of the discovery document.
+    # @return [Google::APIClient::API] The service object.
     def register_discovery_uri(api, version, uri)
       api = api.to_s
       version = version || 'v1'
       @discovery_uris["#{api}:#{version}"] = uri
+      discovered_api(api, version)
     end
 
     ##
@@ -297,6 +312,7 @@ module Google
     # @param [String] version The desired version of the API.
     # @param [String, StringIO] discovery_document
     #   The contents of the discovery document.
+    # @return [Google::APIClient::API] The service object.
     def register_discovery_document(api, version, discovery_document)
       api = api.to_s
       version = version || 'v1'
@@ -311,6 +327,7 @@ module Google
       end
       @discovery_documents["#{api}:#{version}"] =
         MultiJson.load(discovery_document)
+      discovered_api(api, version)
     end
 
     ##
@@ -604,28 +621,40 @@ module Google
       request.authorization = options[:authorization] || self.authorization unless options[:authenticated] == false
       
       tries = 1 + (options[:retries] || self.retries)
+      attempt = 0
 
       Retriable.retriable :tries => tries, 
                           :on => [TransmissionError],
-                          :on_retry => client_error_handler(request.authorization),
+                          :on_retry => client_error_handler,
                           :interval => lambda {|attempts| (2 ** attempts) + rand} do
-        result = request.send(connection, true)
-
-        case result.status
-          when 200...300
-            result
-          when 301, 302, 303, 307
-            request = generate_request(request.to_hash.merge({
-              :uri => result.headers['location'],
-              :api_method => nil
-            }))
-            raise RedirectError.new(result.headers['location'], result)
-          when 400...500
-            raise ClientError.new(result.error_message || "A client error has occurred", result)
-          when 500...600
-            raise ServerError.new(result.error_message || "A server error has occurred", result)
-          else
-            raise TransmissionError.new(result.error_message || "A transmission error has occurred", result)
+        attempt += 1
+
+        # This 2nd level retriable only catches auth errors, and supports 1 retry, which allows
+        # auth to be re-attempted without having to retry all sorts of other failures like
+        # NotFound, etc
+        Retriable.retriable :tries => ((expired_auth_retry || tries > 1) && attempt == 1) ? 2 : 1, 
+                            :on => [AuthorizationError],
+                            :on_retry => authorization_error_handler(request.authorization) do
+          result = request.send(connection, true)
+
+          case result.status
+            when 200...300
+              result
+            when 301, 302, 303, 307
+              request = generate_request(request.to_hash.merge({
+                :uri => result.headers['location'],
+                :api_method => nil
+              }))
+              raise RedirectError.new(result.headers['location'], result)
+            when 401
+              raise AuthorizationError.new(result.error_message || 'Invalid/Expired Authentication', result)
+            when 400, 402...500
+              raise ClientError.new(result.error_message || "A client error has occurred", result)
+            when 500...600
+              raise ServerError.new(result.error_message || "A server error has occurred", result)
+            else
+              raise TransmissionError.new(result.error_message || "A transmission error has occurred", result)
+          end
         end
       end
     end
@@ -673,18 +702,17 @@ module Google
     
 
     ##
-    # Returns on proc for special processing of retries as not all client errors
-    # are recoverable. Only 401s should be retried and only if the credentials
-    # are refreshable
+    # Returns on proc for special processing of retries for authorization errors
+    # Only 401s should be retried and only if the credentials are refreshable
     #
     # @param [#fetch_access_token!] authorization
     #   OAuth 2 credentials
-    # @return [Proc] 
-    def client_error_handler(authorization)  
+    # @return [Proc]
+    def authorization_error_handler(authorization)
       can_refresh = authorization.respond_to?(:refresh_token) && auto_refresh_token 
       Proc.new do |exception, tries|
-        next unless exception.kind_of?(ClientError)
-        if exception.result.status == 401 && can_refresh && tries == 1
+        next unless exception.kind_of?(AuthorizationError)
+        if can_refresh
           begin
             logger.debug("Attempting refresh of access token & retry of request")
             authorization.fetch_access_token!
@@ -696,6 +724,17 @@ module Google
       end
     end
 
+    ##
+    # Returns on proc for special processing of retries as not all client errors
+    # are recoverable. Only 401s should be retried (via authorization_error_handler)
+    #
+    # @return [Proc]
+    def client_error_handler
+      Proc.new do |exception, tries|
+        raise exception if exception.kind_of?(ClientError)
+      end
+    end
+
   end
 
 end