hal-client 4.1.5 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: efcf798149673758521fcaf3816c0d0bf9ef7a60
-  data.tar.gz: 2db07e4799e463cb5a43e1282831ed1589a3cc80
+  metadata.gz: 8007fc0fdf2984a6cdc35d90dfbdc73a020686d4
+  data.tar.gz: a9b99d9d95c268e8be81324cf98ea76427f72c8e
 SHA512:
-  metadata.gz: 2634325d8730ee52e83beaa43915ad49602eff032b325066be3a1d8f63a9746d9613fe8d98b5d23225dff7ec2b9c5ff41cc320e6ab69f5f1db8a0171fbed4139
-  data.tar.gz: 18def3b9cccc4be9f466f1503edfab366b37fac03b145af3e15cc52124430af38c5b709706835c400efe719fd2dec6220164d9b574f69cd72e8018d0c2e6e829
+  metadata.gz: bc49c5224b0824b7d5da339467028ce9cb0b61162d3b9d4a18303e3af37fe493d832afa1cfbc65490647cd3c9441580059d5bf43b6247fa10479624685135cd6
+  data.tar.gz: 5eb75a205939f44e074c55ad18d55275c4d9672287e2973b28557e965241fcd562af9611874cddb1c71cdbff2f13b5756e4f3416c36ac7d15661612a7c7247f7

data/lib/hal_client.rb

@@ -21,6 +21,8 @@ class HalClient
   autoload :HttpError, 'hal_client/errors'
   autoload :HttpClientError, 'hal_client/errors'
   autoload :HttpServerError, 'hal_client/errors'
+  autoload :NullLogger, 'hal_client/null_logger'
+  autoload :Retryinator, 'hal_client/retryinator'
 
   autoload :RepresentationEditor, 'hal_client/representation_editor'
 
@@ -50,6 +52,9 @@ class HalClient
     @logger = options.fetch(:logger, NullLogger.new)
     @timeout = options.fetch(:timeout, Float::INFINITY)
     @base_client_with_headers = {}
+    @retry_duration = options.fetch(:retry_duration, Retryinator::DEFAULT_DURATION)
+
+    @retryinator = Retryinator.new(logger: logger, duration: retry_duration)
 
     default_message_request_headers.set('Accept', options[:accept]) if
       options[:accept]
@@ -93,7 +98,7 @@ class HalClient
   def get(url, headers={})
     headers = auth_headers(url).merge(headers)
     client = client_for_get(override_headers: headers)
-    resp = bmtb("GET <#{url}>") { client.get(url) }
+    resp = retryinator.retryable { bmtb("GET <#{url}>") { client.get(url) } }
     interpret_response resp
 
   rescue HttpError => e
@@ -119,7 +124,36 @@ class HalClient
 
         begin
           client = client_for_post(override_headers: headers)
-          resp = bmtb("#{verb} <#{url}>") { client.request(method, url, body: req_body) }
+          resp = bmtb("#{verb} <#{url}>") {
+            client.request(method, url, body: req_body)
+          }
+          interpret_response resp
+
+        rescue HttpError => e
+          fail e.class.new("#{verb} <#{url}> failed with code #{e.response.status}", e.response)
+        end
+      end
+    end
+
+    def def_idempotent_unsafe_request(method)
+      verb = method.to_s.upcase
+
+      define_method(method) do |url, data, headers={}|
+        headers = auth_headers(url).merge(headers)
+
+        req_body = if data.respond_to? :to_hal
+                     data.to_hal
+                   elsif data.is_a? Hash
+                     data.to_json
+                   else
+                     data
+                   end
+
+        begin
+          client = client_for_post(override_headers: headers)
+          resp = bmtb("#{verb} <#{url}>") {
+            retryinator.retryable { client.request(method, url, body: req_body) }
+          }
           interpret_response resp
 
         rescue HttpError => e
@@ -141,7 +175,7 @@ class HalClient
   # url - The URL of the resource of interest.
   # data - a `String`, a `Hash` or an object that responds to `#to_hal`
   # headers - custom header fields to use for this request
-  def_unsafe_request :put
+  def_idempotent_unsafe_request :put
 
   # Patch a `Representation`, `String` or `Hash` to the resource identified at `url`.
   #
@@ -159,7 +193,7 @@ class HalClient
 
     begin
       client = client_for_post(override_headers: headers)
-      resp = bmtb("DELETE <#{url}>") { client.request(:delete, url) }
+      resp = bmtb("DELETE <#{url}>") { retryinator.retryable { client.request(:delete, url) } }
       interpret_response resp
     rescue HttpError => e
       fail e.class.new("DELETE <#{url}> failed with code #{e.response.status}", e.response)
@@ -168,7 +202,7 @@ class HalClient
 
   protected
 
-  attr_reader :headers, :auth_helper, :logger, :timeout
+  attr_reader :headers, :auth_helper, :logger, :timeout, :retry_duration, :retryinator
 
   NullAuthHelper = ->(_url) { nil }
 
@@ -341,10 +375,4 @@ class HalClient
     end
   end
   extend EntryPointCovenienceMethods
-
-
-  class NullLogger
-    def info(*_); end
-    def debug(*_); end
-  end
 end

data/lib/hal_client/null_logger.rb

@@ -0,0 +1,8 @@
+class HalClient
+  class NullLogger
+    def info(*_); end
+    def debug(*_); end
+    def warn(*_); end
+    def error(*_); end
+  end
+end

data/lib/hal_client/retryinator.rb

@@ -0,0 +1,55 @@
+require 'hal_client/null_logger'
+
+class HalClient
+
+  # Retries http requests that meet certain conditions -- we want to retry if we got a 500 level
+  # (server) error but not if we got a 400 level (client) error. We want to retry if we rescue an
+  # HttpError (likely a network issue) but not more general exceptions that likely indicate another
+  # problem that should be surfaced.
+
+  # Example usage:
+  # Retryinator.call { fetch_http_response }
+  class Retryinator
+
+    attr_reader :max_tries, :duration, :logger
+
+    DEFAULT_MAX_TRIES = 3
+    DEFAULT_DURATION = 1
+
+    def initialize(options={})
+      @max_tries = options.fetch(:max_tries, DEFAULT_MAX_TRIES)
+      @duration = options.fetch(:duration, DEFAULT_DURATION)
+      @logger = options.fetch(:logger, HalClient::NullLogger.new)
+    end
+
+    def retryable(&block)
+      current_try = 1
+
+      loop do
+        begin
+          result = yield block
+
+          if server_error?(result.code)
+            logger.warn "Received a #{result.code} response with body:\n#{result.body}"
+            return result if current_try >= max_tries
+          else
+            return result
+          end
+        rescue HttpError => e
+          logger.warn "Encountered an HttpError: #{e.message}"
+          raise e if current_try >= max_tries
+        end
+
+        logger.warn "Failed attempt #{current_try} of #{max_tries}. " +
+                      "Waiting #{duration} seconds before retrying"
+
+        current_try += 1
+        sleep duration
+      end
+    end
+
+    def server_error?(status_code)
+      500 <= status_code && status_code < 600
+    end
+  end
+end

data/lib/hal_client/version.rb

@@ -1,3 +1,3 @@
 class HalClient
-  VERSION = "4.1.5"
+  VERSION = "4.2.0"
 end

data/spec/hal_client/retryinator_spec.rb

@@ -0,0 +1,74 @@
+require 'hal_client/errors'
+require 'hal_client/retryinator'
+
+RSpec.describe HalClient::Retryinator do
+
+  let(:max_tries) { 5 }
+  let(:mock_response) { double(Http::Response, body: '', code: 200)}
+  subject { described_class.new(max_tries: max_tries, duration: 0) }
+
+  context "the passed block always raises an error" do
+    let(:never_the_charm) { CharmMaker.new(:never, mock_response) }
+
+    it "raises an error and tries the maximum number of times" do
+      expect do
+        subject.retryable { never_the_charm.call }
+      end.to raise_error(HalClient::HttpError)
+
+      expect(never_the_charm.attempts_made).to eq(max_tries)
+    end
+  end
+
+  context "the server returns a success response" do
+    let(:first_time_is_the_charm) { CharmMaker.new(1, mock_response) }
+
+    it "returns the response" do
+      expect(subject.retryable {first_time_is_the_charm.call}).to eq(first_time_is_the_charm.response)
+    end
+
+    it "calls the block once" do
+      subject.retryable { first_time_is_the_charm.call }
+
+      expect(first_time_is_the_charm.attempts_made).to eq(1)
+    end
+  end
+
+  context "the server returns an error response" do
+    before do
+      allow(mock_response).to receive(:code).and_return(500)
+    end
+
+    let(:returns_error_reponses) { CharmMaker.new(1, mock_response) }
+
+    it "retries the request the maximum number of times" do
+      subject.retryable { returns_error_reponses.call }
+
+      expect(returns_error_reponses.attempts_made).to eq(max_tries)
+    end
+
+    it "returns the response" do
+      expect(subject.retryable { returns_error_reponses.call }).to eq(returns_error_reponses.response)
+    end
+  end
+
+  class CharmMaker
+    attr_accessor :attempts_made, :charm, :response
+
+    def initialize(charm, response)
+      @attempts_made = 0
+      @charm = charm
+      @response = response
+    end
+
+    def call
+      self.attempts_made = self.attempts_made + 1
+
+      if charm == :never || self.attempts_made < charm
+        raise HalClient::HttpError.new("message", response)
+      else
+        response
+      end
+    end
+  end
+
+end

data/spec/hal_client_spec.rb

@@ -7,7 +7,7 @@ RSpec.describe HalClient do
     it { is_expected.to be_kind_of HalClient }
   end
 
-  subject(:client) { HalClient.new }
+  subject(:client) { HalClient.new(retry_duration: 0) }
 
   describe '.new w/ custom accept' do
     subject { HalClient.new(accept: "application/vnd.myspecialmediatype") }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hal-client
 version: !ruby/object:Gem::Version
-  version: 4.1.5
+  version: 4.2.0
 platform: ruby
 authors:
 - Peter Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-01 00:00:00.000000000 Z
+date: 2017-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -175,9 +175,11 @@ files:
 - lib/hal_client/interpreter.rb
 - lib/hal_client/link.rb
 - lib/hal_client/links_section.rb
+- lib/hal_client/null_logger.rb
 - lib/hal_client/representation.rb
 - lib/hal_client/representation_editor.rb
 - lib/hal_client/representation_set.rb
+- lib/hal_client/retryinator.rb
 - lib/hal_client/version.rb
 - spec/hal_client/collection_spec.rb
 - spec/hal_client/curie_resolver_spec.rb
@@ -187,6 +189,7 @@ files:
 - spec/hal_client/representation_editor_spec.rb
 - spec/hal_client/representation_set_spec.rb
 - spec/hal_client/representation_spec.rb
+- spec/hal_client/retryinator_spec.rb
 - spec/hal_client_spec.rb
 - spec/spec_helper.rb
 - spec/support/custom_matchers.rb
@@ -223,6 +226,7 @@ test_files:
 - spec/hal_client/representation_editor_spec.rb
 - spec/hal_client/representation_set_spec.rb
 - spec/hal_client/representation_spec.rb
+- spec/hal_client/retryinator_spec.rb
 - spec/hal_client_spec.rb
 - spec/spec_helper.rb
 - spec/support/custom_matchers.rb