ocean-rails 3.3.3 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 91cff40a2e3883b3d68b9b54b1640dfe6b5c9fb7
-  data.tar.gz: 6fa15184b9e0eecf15b0b666bdf494a51b0cd0f9
+  metadata.gz: e35b6a26426816dec30071f7fd2c87272e4530d7
+  data.tar.gz: ac1e42b243d0985e4aba91f2b2939ec0e3b3d0c4
 SHA512:
-  metadata.gz: 6e69bbaeb59be763814f41cfc3f9413af265f24da76e1109b995c6bdc82b90fdcb6dc40a527c901a9ed17078a2d253fc8a46c3443d4ed24531246e560a4b4cf3
-  data.tar.gz: c4c6bcdc5890377111480a8b8e9b697d10dc72f0f34bc63ffb0feb3a6714d35a442d14edfb58f2a4825e947d86069254851537188451dabd8a70eeb5fc4d7c1e
+  metadata.gz: 00265cc72834b55c5c5c9e4e4d2f672dddd14ebbbd20baf65c9d28d2898138054d7fd9f08a36c5eacfdc025a04cda1f83373ffe0cda7306fd195cd6db8dde6f1
+  data.tar.gz: 191b0d669a58c0efcac288da5a6605f6d97fcbc62d89a650333f4083fec9da7938fe2b037412a1b20a28f4d2c03ec55582064ceb3855ac820ae71e118f064b9f

data/lib/ocean/api.rb

@@ -145,11 +145,25 @@ class Api
   # +ssl_verifypeer+ (true by default), controls SSL peer verification.
   # +ssl_verifyhost+ (2 by default), controls SSL host verification.
   #
+  # Automatic retries for GET requests are available:
+  #
+  # +retries+, if given and > 0, specifies the number of retries to perform for GET requests.
+  #            Defaults to 0, meaning no retries.
+  # +backoff_time+ (default 1) the initial time to wait between retries. 
+  # +backoff_rate+ (default 0.9) the rate at which the time is increased.
+  # +backoff_max+ (default 30) the maximum time to wait between retries.
+  #
+  # The backoff time is increased after each wait period by the product of itself and 
+  # backoff_rate. The backoff time is capped by backoff_max. The default time and rate
+  # settings will generate the progression 1, 1.9, 3.61, 6.859, 13.0321, 24.76099, etc.
+  # To disable waiting between retries, set +backoff_time+ to zero.
+  #
   def self.request(url, http_method, args: nil, headers: {}, body: nil,
                    credentials: nil,
                    x_api_token: headers['X-API-Token'], 
                    reauthentication: true,
-                   ssl_verifypeer: true, ssl_verifyhost: 2)
+                   ssl_verifypeer: true, ssl_verifyhost: 2,
+                   retries: 0, backoff_time: 1, backoff_rate: 0.9, backoff_max: 30)
     # Set up the request
     headers['Accept'] = "application/json"
     headers['Content-Type'] = "application/json" if [:post, :put].include?(http_method)
@@ -157,39 +171,59 @@ class Api
     x_api_token =  Api.authenticate(*Api.decode_credentials(credentials)) if x_api_token.blank? && credentials.present?
     headers['X-API-Token'] = x_api_token if x_api_token.present?
 
+    response = nil
+    tries_done = 0
+    max_tries = [:get, "GET", "get"].include?(http_method) ? retries + 1 : 1
     while (true) do
-      request = Typhoeus::Request.new(url, 
-                                      method: http_method, 
-                                      headers: headers,
-                                      params: args, 
-                                      body: body, 
-                                      ssl_verifypeer: ssl_verifypeer,
-                                      ssl_verifyhost: ssl_verifyhost)
-      # Run it
-      response = Response.new(request.run)
-      # If successful, return
-      return response if response.success?
-
-      # Not successful, deal with it
-      if response.timed_out?
-        raise Api::TimeoutError, "Api.request timed out"
-      elsif response.status == 0
-        # Could not get an http response, something's wrong.
-        raise Api::NoResponseError, "Api.request could not obtain a response"
-      elsif [400, 419].include?(response.status) && reauthentication && x_api_token.present? 
-        # Re-authenticate and retry
-        if credentials
-          x_api_token = Api.authenticate(*Api.decode_credentials(credentials))
-          headers['X-API-Token'] = x_api_token
+      tries_done += 1
+      last_try = tries_done >= max_tries
+
+      while (true) do
+        request = Typhoeus::Request.new(url, 
+                                        method: http_method, 
+                                        headers: headers,
+                                        params: args, 
+                                        body: body, 
+                                        ssl_verifypeer: ssl_verifypeer,
+                                        ssl_verifyhost: ssl_verifyhost)
+        # Run it
+        response = Response.new(request.run)
+        # If successful, return
+        return response if response.success?
+
+        # Not successful, deal with it
+        if last_try
+          raise Api::TimeoutError, "Api.request timed out" if response.timed_out?
+          raise Api::NoResponseError, "Api.request could not obtain a response" if response.status == 0
         else
-          Api.reset_service_token
-          headers['X-API-Token'] = Api.service_token
+          break if response.timed_out?
+          break if response.status == 0
         end
-        reauthentication = false   # This prevents us from ending up here twice
-      else
-        # Failed
-        break
+
+        # Reauthenticate if necessary
+        if [400, 419].include?(response.status) && reauthentication && x_api_token.present?
+          # Re-authenticate and retry
+          if credentials
+            x_api_token = Api.authenticate(*Api.decode_credentials(credentials))
+            headers['X-API-Token'] = x_api_token
+          else
+            Api.reset_service_token
+            headers['X-API-Token'] = Api.service_token
+          end
+          reauthentication = false   # This prevents us from ending up here twice
+        elsif (400..499).include?(response.status)
+          return response
+        else
+          # Retry on 500s (will we ever get 300s?)
+          break
+        end
+
       end
+      # Retry
+      break if last_try
+      sleep backoff_time
+      seconds = [backoff_time + backoff_time * backoff_rate, 30].min
+      backoff_time = seconds
     end
     # Return the wrapped response to the failed request
     response

data/lib/ocean/api_remote_resource.rb

@@ -86,7 +86,7 @@ class Api
 
   	def initialize(uri, type="application/json",
                    credentials: nil, x_api_token: nil,
-  		             retries: 3, backoff_time: 1, backoff_rate: 2, backoff_max: 30)
+  		             retries: 3, backoff_time: 1, backoff_rate: 0.9, backoff_max: 30)
       super()
   	  @uri = uri
   	  @content_type = type
@@ -171,7 +171,9 @@ class Api
         credentials = nil
         token = rr.x_api_token || Api.service_token
       end
-      response = Api.request rr.uri, :get, headers: {}, credentials: credentials, x_api_token: token
+      response = Api.request rr.uri, :get, headers: {}, credentials: credentials, x_api_token: token,
+                             retries: rr.retries, backoff_time: rr.backoff_time, backoff_rate: rr.backoff_rate, 
+                             backoff_max: rr.backoff_max
       rr.send :status=, response.status
       rr.send :status_message=, response.message
       rr.send :headers=, response.headers

data/lib/ocean/version.rb

@@ -1,3 +1,3 @@
 module Ocean
-  VERSION = "3.3.3"
+  VERSION = "3.4.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ocean-rails
 version: !ruby/object:Gem::Version
-  version: 3.3.3
+  version: 3.4.0
 platform: ruby
 authors:
 - Peter Bengtson