loquor 1.11.0 → 1.12.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MWVhNDZhNjQ2NGIyZTczNGFlZmYxN2Y1ZWZiZWQ5NWFhODg2M2MxNA==
+    NDMwODdkODY4NWMwY2ViZjkzOGE4MTczNTU1MGYwYjFiOTMwNmI2Mg==
   data.tar.gz: !binary |-
-    ZTY0ODIyNWJhYzFlYWNjNzMwZWQ4MzAxNzg4YWVlNGM1MjYxMDJmOQ==
+    YTczMjQwNDQ1ZTdiZThkOTE2YWYyNWEzNTIyZDA3Zjc4ZTZiNDgxNA==
 SHA512:
   metadata.gz: !binary |-
-    MDZiM2JkMGY5NzgxNmJmM2RlODc1YmI1MjhiN2MyYWEzNzE3M2RmZmMyZTMx
-    Y2Q3MjcyZDA3MzUzZTRhY2E3OTZlMjBiMjhiMjI1MDFjNjJmOTVhNmY4NGU0
-    YzNlZWY4ZTBkMzc3NjBhNTQ4MjNhOGRiMmY0M2ViY2IyMzIyNjA=
+    ODdmZDYyYTJlY2MwMGMzN2YxZjNmZTlkMjQ4OWMxNTI2ZWNhODI4NzI4MDQ3
+    MjlmMTdhNGIyNmU5YTZiMTZjMjNiNThkYzBkYTkzYTliN2RiNTkxNzQ1NmJi
+    ZjZkNmEyZmI3NTczZWUwMDBmYjViOWY0YjRjMWU4OGUwNTE0YmU=
   data.tar.gz: !binary |-
-    ZTY1ODFmYWQ2N2Q3OWFmZDNhYjc1ODkzN2FkZmQ0ZjRkYjJjMDZjNWRjYTcw
-    ZTdiNDYzOGI0MWZmMWZkZTViODVjNDAwZDZjZWZjMTVjYTA5OTY1OGUxYWRi
-    ZTg1NDk2OWRhZTk2MWI4ZjU2NmU5ZGM1MzU1NzM5ZTg3ZDliZTU=
+    ZGMyOTNhOWFkZjNlYTU1ODY4NzgyYTZkYTc4YzU5ODk1MjA1Y2Q3MjRiNGU4
+    ZTU3MjIwNWZkNDk1MWQ5ZDQyZWRlYWViZTVjNDA3YWRmOWQ1NGYwNWQyM2Ji
+    ZDA0ZWY5ZTRlMmVkZjJiMTRkYzczZTg0MDBjMTFmMzEzYTkxYzE=

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# 1.12.0 / 2014-05-06
+* [FEATURE] Retry support for HTTP 503 status
+
 # 1.11.0 / 2014-05-06
 * [FEATURE] Set user-agent to same value as access_id 
 

data/lib/loquor/configuration.rb

@@ -7,7 +7,7 @@ module Loquor
   class Configuration
 
     SETTINGS = [
-      :logger, :access_id, :secret_key, :endpoint, :substitute_values, :retry_404s
+      :logger, :access_id, :secret_key, :endpoint, :substitute_values, :retry_404s, :retry_503s, :max_retries, :retry_backoff
     ]
 
     attr_writer *SETTINGS
@@ -17,6 +17,9 @@ module Loquor
       self.logger = Filum.logger
       self.substitute_values = {}
       self.retry_404s = false
+      self.retry_503s = true
+      self.max_retries = 5
+      self.retry_backoff = 2
     end
 
     SETTINGS.each do |setting|

data/lib/loquor/http_action.rb

@@ -1,15 +1,18 @@
+require 'rest-client'
+
 module Loquor
   class HttpAction
     def initialize(url, deps)
       @url = url
       @config = deps[:config]
       @should_cache = deps[:should_cache]
+      @retry_count = 0
     end
 
     def signed_request
       req = request
       @config.logger.info "Setting user-agent."
-      req.headers['User-Agent'] = @config.access_id
+      req.headers['User-Agent'] = user_agent
       @config.logger.info "Signing request."
       ApiAuth.sign!(req, @config.access_id, @config.secret_key)
     end
@@ -17,6 +20,17 @@ module Loquor
     def execute
       @config.logger.info "Making HTTP request to: #{full_url}"
       signed_request.execute
+    rescue RestClient::ServiceUnavailable => e
+      @config.logger.error("503 received for request to #{@url}.")
+      @retry_count += 1
+      if should_retry
+        @config.logger.error("Retrying (retry attempt #{@retry_count})")
+        back_off(@config.retry_backoff ** @retry_count)
+        retry
+      else
+        @config.logger.error("Abandoning request (service unavailable)")
+        raise e
+      end
     rescue RestClient::ResourceNotFound => e
       @config.logger.error("HTTP 404 when accessing #{full_url}")
       raise
@@ -25,11 +39,23 @@ module Loquor
       raise
     end
 
+    def back_off(delay)
+      sleep(delay)
+    end
+
     private
 
+    def should_retry
+      @config.retry_503s && @retry_count < @config.max_retries
+    end
+
     def full_url
       "#{@config.endpoint}#{@url}"
     end
+
+    def user_agent
+      "Loquor-#{VERSION}/#{@config.access_id}"
+    end
   end
 end
 

data/lib/loquor/version.rb

@@ -1,3 +1,3 @@
 module Loquor
-  VERSION = "1.11.0"
+  VERSION = "1.12.0"
 end

data/test/http_action_test.rb

@@ -11,6 +11,7 @@ module Loquor
     def deps
       logger = mock()
       logger.stubs(info: nil)
+      logger.stubs(error: nil)
 
       config = mock()
       config.stubs(logger: logger)
@@ -18,6 +19,9 @@ module Loquor
       config.stubs(secret_key: @secret_key)
       config.stubs(endpoint: @endpoint)
       config.stubs(cache: @cache)
+      config.stubs(retry_backoff: 2)
+      config.stubs(max_retries: 5)
+      config.stubs(retry_503s: true)
       {config: config}
     end
     
@@ -27,5 +31,89 @@ module Loquor
       action.expects(signed_request: mock(execute: json))
       assert_equal json, action.send(:execute)
     end
+
+    def test_execute_retries_on_503
+      json = "{}"
+
+      r = mock()
+      r.stubs(:execute).raises(RestClient::ServiceUnavailable.new)
+        .then.raises(RestClient::ServiceUnavailable.new).then.returns(json)
+
+      action = HttpAction.new("", deps)
+      action.expects(signed_request: r).times(3)
+      action.expects(:back_off).with(2)
+      action.expects(:back_off).with(4)
+
+      assert_equal json, action.send(:execute)
+    end
+
+    def test_disable_503_retries
+      my_deps = deps
+      my_deps[:config].stubs(retry_503s: false)
+
+      r = mock()
+      r.stubs(:execute).raises(RestClient::ServiceUnavailable.new)
+
+      action = HttpAction.new("", my_deps)
+      action.expects(signed_request: r)
+
+      assert_raises RestClient::ServiceUnavailable do
+        action.send(:execute)
+      end
+    end
+
+    def test_execute_rethrows_503_when_retry_count_exceeded
+      r = mock()
+      r.stubs(:execute).raises(RestClient::ServiceUnavailable.new).times(5)
+
+      action = HttpAction.new("", deps)
+      action.expects(signed_request: r).times(5)
+      action.expects(:back_off).with(2)
+      action.expects(:back_off).with(4)
+      action.expects(:back_off).with(8)
+      action.expects(:back_off).with(16)
+
+      assert_raises RestClient::ServiceUnavailable do
+        action.send(:execute)
+      end
+    end
+
+    def test_execute_rethrows_503_with_configurable_backoff_and_max_retries
+      my_deps = deps
+      my_deps[:config].stubs(retry_backoff: 3)
+      my_deps[:config].stubs(max_retries: 4)
+
+      r = mock()
+      r.stubs(:execute).raises(RestClient::ServiceUnavailable.new).times(4)
+
+      action = HttpAction.new("", my_deps)
+      action.expects(signed_request: r).times(4)
+      action.expects(:back_off).with(3)
+      action.expects(:back_off).with(9)
+      action.expects(:back_off).with(27)
+
+      assert_raises RestClient::ServiceUnavailable do
+        action.send(:execute)
+      end
+    end
+
+    def test_execute_rethrows_404
+      err = RestClient::ResourceNotFound.new
+
+      r = mock()
+      r.stubs(:execute).raises(err)
+
+      action = HttpAction.new("", deps)
+      action.expects(signed_request: r)
+
+      assert_raises RestClient::ResourceNotFound do
+        action.send(:execute)
+      end
+    end
+
+    def test_user_agent
+      action = HttpAction.new("", deps)
+      assert /Loquor-\d+.\d+.\d+\/123/.match(action.send(:user_agent))
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: loquor
 version: !ruby/object:Gem::Version
-  version: 1.11.0
+  version: 1.12.0
 platform: ruby
 authors:
 - Jeremy Walker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-06 00:00:00.000000000 Z
+date: 2014-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: filum