hal-client 3.15.0 → 3.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a02928e0fcb08ea201d51a1b76e3db118ea2efde
-  data.tar.gz: 51cf12b4ac3d35e742322d75ae86ca4a16f0f114
+  metadata.gz: 2e97fd75dd9bb812c2cdf28bcd0a9a316a94bb71
+  data.tar.gz: d260178d87921fe2031ae62a33952cdbbc7019a7
 SHA512:
-  metadata.gz: 72e1e77e6fdc336f0d66755aa598a66213f021cfca90554b98cba699b63a83dd9eb82fb267a906c5e00c55f35953491e8aee3be8bc934c11e79f1e5617d7c63d
-  data.tar.gz: 92fb2baaacfeca8b492e9c842a8cf5f9b9e77f29c76983918809895249a289058583b7cdece571d37fb5a054b0b09721315770b5d73f5c7c7a2ea01afc7f9580
+  metadata.gz: 6cd9c0e7192d66633ec12c0409a4cde8a8b6fb413965671f7590dd9bc77778399da2be2cc229567066a422d317c94eab89e7822869744ade921be700ee1c14f3
+  data.tar.gz: 77e05a49bc31a09950cce202d93936e9eea97c1776229b3d7c43f89e647bafa5618d97a3f099693622f295eecdac0c9cfe55cd3fc751564a1e3f1db60d5ad85c

data/lib/hal_client/errors.rb

@@ -20,4 +20,6 @@ class HalClient
 
   # Server responded with a 5xx status code
   HttpServerError = Class.new(HttpError)
+
+  TimeoutError = Class.new(StandardError)
 end

data/lib/hal_client/version.rb

@@ -1,3 +1,3 @@
 class HalClient
-  VERSION = "3.15.0"
+  VERSION = "3.16.0"
 end

data/lib/hal_client.rb

@@ -1,6 +1,7 @@
 require "hal_client/version"
 require 'http'
 require 'multi_json'
+require 'benchmark'
 
 # Adapter used to access resources.
 class HalClient
@@ -31,11 +32,18 @@ class HalClient
   #     the authorization header
   #   :headers - a hash of other headers to send on each request.
   #   :base_client - An HTTP::Client object to use.
+  #   :logger - a Logger object to which benchmark and activity info
+  #      will be written. Benchmark data will be written at info level
+  #      and activity at debug level.
+  #   :timeout - number of seconds that after which any request will be
+  #      terminated and an exception raised. Default: Float::INFINITY
   def initialize(options={})
     @default_message_request_headers = HTTP::Headers.new
     @default_entity_request_headers = HTTP::Headers.new
     @auth_helper = as_callable(options.fetch(:authorization, NullAuthHelper))
     @base_client ||= options[:base_client]
+    @logger = options.fetch(:logger, NullLogger.new)
+    @timeout = options.fetch(:timeout, Float::INFINITY)
 
     default_message_request_headers.set('Accept', options[:accept]) if
       options[:accept]
@@ -65,6 +73,7 @@ class HalClient
     default_message_request_headers.set('Accept', accept_values.join(", "))
     # We can work with HAL so provide a back stop accept.
   end
+  protected :initialize
 
   # Returns a `Representation` of the resource identified by `url`.
   #
@@ -72,7 +81,9 @@ class HalClient
   # headers - custom header fields to use for this request
   def get(url, headers={})
     headers = auth_headers(url).merge(headers)
-    interpret_response client_for_get(override_headers: headers).get(url)
+    client = client_for_get(override_headers: headers)
+    resp = bmtb("GET <#{url}>") { client.get(url) }
+    interpret_response resp
 
   rescue HttpError => e
     fail e.class.new("GET <#{url}> failed with code #{e.response.status}", e.response)
@@ -82,6 +93,8 @@ class HalClient
     protected
 
     def def_unsafe_request(method)
+      verb = method.to_s.upcase
+
       define_method(method) do |url, data, headers={}|
         headers = auth_headers(url).merge(headers)
 
@@ -94,11 +107,12 @@ class HalClient
                    end
 
         begin
-          interpret_response client_for_post(override_headers: headers)
-                              .request(method, url, body: req_body)
+          client = client_for_post(override_headers: headers)
+          resp = bmtb("#{verb} <#{url}>") { client.request(method, url, body: req_body) }
+          interpret_response resp
 
         rescue HttpError => e
-          fail e.class.new("#{method.to_s.upcase} <#{url}> failed with code #{e.response.status}", e.response)
+          fail e.class.new("#{verb} <#{url}> failed with code #{e.response.status}", e.response)
         end
       end
     end
@@ -133,22 +147,17 @@ class HalClient
     headers = auth_headers(url).merge(headers)
 
     begin
-      interpret_response client_for_post(override_headers: headers)
-                          .request(:delete, url)
+      client = client_for_post(override_headers: headers)
+      resp = bmtb("DELETE <#{url}>") { client.request(:delete, url) }
+      interpret_response resp
     rescue HttpError => e
       fail e.class.new("DELETE <#{url}> failed with code #{e.response.status}", e.response)
     end
   end
 
-  class << self
-    def delete(url, headers={})
-      new.delete(url, headers)
-    end
-  end
-
   protected
 
-  attr_reader :headers, :auth_helper
+  attr_reader :headers, :auth_helper, :logger, :timeout
 
   NullAuthHelper = ->(_url) { nil }
 
@@ -248,6 +257,33 @@ class HalClient
     [:content_type, /^content-type$/i].any?{|pat| pat === field_name}
   end
 
+  def bmtb(msg, &blk)
+    benchmark(msg) { timebox(msg, &blk) }
+  end
+
+  def timebox(msg, &blk)
+    if timeout < Float::INFINITY
+      Timeout.timeout(timeout, &blk)
+    else
+      yield
+    end
+
+  rescue Timeout::Error
+    timeout_ms = timeout * 1000
+    raise TimeoutError, "Killed %s for taking more than %.1fms." % [msg, timeout_ms]
+  end
+  def benchmark(msg, &blk)
+    result = nil
+    elapsed = Benchmark.realtime do
+      result = yield
+    end
+
+    logger.info '%s (%.1fms)' % [ msg, elapsed*1000 ]
+
+    result
+  end
+
+
   module EntryPointCovenienceMethods
     # Returns a `Representation` of the resource identified by `url`.
     #
@@ -266,6 +302,24 @@ class HalClient
       default_client.post(url, data, options)
     end
 
+    # Patch a `Representation` or `String` to the resource identified at `url`.
+    #
+    # url - The URL of the resource of interest.
+    # data - a `String` or an object that responds to `#to_hal`
+    # options - set of options to pass to `RestClient#get`
+    def patch(url, data, options={})
+      default_client.patch(url, data, options)
+    end
+
+    # Delete the resource identified at `url`.
+    #
+    # url - The URL of the resource of interest.
+    # options - set of options to pass to `RestClient#get`
+    def delete(url, options={})
+      default_client.delete(url, options)
+    end
+
+
     protected
 
     def default_client
@@ -274,4 +328,9 @@ class HalClient
   end
   extend EntryPointCovenienceMethods
 
+
+  class NullLogger
+    def info(*_); end
+    def debug(*_); end
+  end
 end

data/spec/hal_client_spec.rb

@@ -77,6 +77,43 @@ describe HalClient do
         expect(request.with(headers: { "DummyHeader" => "Test" })).to have_been_made
       end
     end
+
+    context "logging" do
+      let(:logger) { MemoryLogger.new }
+      subject(:client) { HalClient.new logger: logger }
+      it "logs the request" do
+        expect(logger.info_entries).to have(1).item
+        expect(logger.info_entries.first).to include "http://example.com/foo"
+      end
+    end
+
+  end
+
+  context "server takes too long" do
+    let!(:request) { stub_request(:any, "http://example.com/foo")
+                     .with { sleep 1 }  }
+
+    subject(:client) { HalClient.new timeout: 0.1 }
+
+    it "#get raises TimeoutError" do
+      expect{client.get "http://example.com/foo"}.to raise_exception HalClient::TimeoutError
+    end
+
+    it "#get includes url and verb in the error message" do
+      err = client.get("http://example.com/foo") rescue $!
+      expect(err.to_s).to include "GET <http://example.com/foo>"
+    end
+
+    it "#post raises HttpClientError" do
+      expect{client.post "http://example.com/foo", "foo"}.to raise_exception HalClient::TimeoutError
+    end
+
+    it "#post attaches response to the raise error" do
+      err = client.post("http://example.com/foo", "") rescue $!
+      expect(err.to_s).to include "POST <http://example.com/foo>"
+    end
+
+
   end
 
   context "server responds with client error" do
@@ -233,6 +270,16 @@ describe HalClient do
         expect(post_request).to have_been_made
       end
     end
+
+    context "logging" do
+      before do return_val end
+      let(:logger) { MemoryLogger.new }
+      subject(:client) { HalClient.new logger: logger }
+      it "logs the request" do
+        expect(logger.info_entries).to have(1).item
+        expect(logger.info_entries.first).to include "http://example.com/foo"
+      end
+    end
   end
 
   describe ".post(<url>)" do
@@ -298,5 +345,24 @@ describe HalClient do
     to_return body: "{}" }
 
   let!(:request) { stub_request(:get, "http://example.com/foo").
-    to_return body: "{}" }
+                   to_return body: "{}" }
+
+  class MemoryLogger
+    def info_entries
+      @info_entries ||= []
+    end
+    def debug_entries
+      @debug_entries ||= []
+    end
+
+    def info(msg=nil)
+      msg = yield if block_given?
+      info_entries << msg
+    end
+
+    def debug(msg=nil)
+      msg = yield if block_given?
+      debug_entries << msg
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hal-client
 version: !ruby/object:Gem::Version
-  version: 3.15.0
+  version: 3.16.0
 platform: ruby
 authors:
 - Peter Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-01 00:00:00.000000000 Z
+date: 2016-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http