hoodoo 1.17.0 → 1.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a11d0bed3dc977f5aab127f4ed139e715a9f2431
-  data.tar.gz: 42706658a33e920162e734ad3f0891a8e703e845
+  metadata.gz: 33592f5c0f6228a5253592dff50c587e70319ae8
+  data.tar.gz: 3f7c50f2d5935c5758c2efd61a650b96335be4bf
 SHA512:
-  metadata.gz: d3f795bff6b580fe090f46a624461fac52939941e18564074e68c37e5d3fc757c5da9a34efbbad6ce3c435e0701c021e07c8a157f77f0e268541bbe78180c1f9
-  data.tar.gz: f3fec8a2305e6c815d309c0442724f4fee7a6541606058421a1e473797f50e666dbe40b7540cc34cbb12baa1e8af2cdaa2052c13601e69b182a303feca31bc7e
+  metadata.gz: b5ccdb3765ae191bed76db43c25bbcf674dea032bd8d6ed2b6ff01fdc53ed811748e68ef34dcc1f2f1e89ce2d9f494e2323d31c0292bcf905fd3201661b4ff21
+  data.tar.gz: 3196db1484495a18006ce741da581e77bbce7b3aecf4deb829bb8b96f8005226c486c523d6c1374849323c8241d68cb70cc3dcdbe696f4e6678a723ad5360281

data/lib/hoodoo/client/endpoint/endpoints/http.rb

@@ -33,12 +33,13 @@ module Hoodoo
               raise "Hoodoo::Client::Endpoint::HTTP must be configured with a Hoodoo::Services::Discovery::ForHTTP instance - got '#{ @discovery_result.class.name }'"
             end
 
-            @description                  = Hoodoo::Client::Endpoint::HTTPBased::DescriptionOfRequest.new
-            @description.discovery_result = @discovery_result
-            @description.endpoint_uri     = @discovery_result.endpoint_uri
-            @description.proxy_uri        = @discovery_result.proxy_uri
-            @description.ca_file          = @discovery_result.ca_file
-            @description.http_timeout     = @discovery_result.http_timeout
+            @description                   = Hoodoo::Client::Endpoint::HTTPBased::DescriptionOfRequest.new
+            @description.discovery_result  = @discovery_result
+            @description.endpoint_uri      = @discovery_result.endpoint_uri
+            @description.proxy_uri         = @discovery_result.proxy_uri
+            @description.ca_file           = @discovery_result.ca_file
+            @description.http_timeout      = @discovery_result.http_timeout
+            @description.http_open_timeout = @discovery_result.http_open_timeout
           end
 
         public
@@ -115,10 +116,11 @@ module Hoodoo
 
             data = get_data_for_request( description_of_request )
 
-            action       = description_of_request.action
-            proxy        = description_of_request.proxy_uri
-            ca_file      = description_of_request.ca_file
-            http_timeout = description_of_request.http_timeout
+            action            = description_of_request.action
+            proxy             = description_of_request.proxy_uri
+            ca_file           = description_of_request.ca_file
+            http_timeout      = description_of_request.http_timeout
+            http_open_timeout = description_of_request.http_open_timeout
 
             proxy_host = :ENV
             proxy_port = proxy_user = proxy_pass = nil
@@ -157,6 +159,7 @@ module Hoodoo
             end
 
             http.read_timeout = http_timeout unless http_timeout.nil?
+            http.open_timeout = http_open_timeout unless http_open_timeout.nil?
 
             request_class = {
               :create => Net::HTTP::Post,
@@ -184,7 +187,7 @@ module Hoodoo
               description_of_response.http_status_code = 404
               description_of_response.raw_body_data    = ''
 
-            rescue Net::ReadTimeout => e
+            rescue Net::OpenTimeout, Net::ReadTimeout => e
               description_of_response.http_status_code = 408
               description_of_response.raw_body_data    = ''
 

data/lib/hoodoo/client/endpoint/endpoints/http_based.rb

@@ -71,11 +71,37 @@ module Hoodoo
             attr_accessor :ca_file
 
             # Optional Float indicating the Net::HTTP read timeout value.
+            #
+            # This is a value in seconds (default 60) for which the client
+            # will wait while attempting to read data from a server in any
+            # individual TCP read operation. The timeout becomes active
+            # immediately after a server connection is established.
+            #
+            # If a read attempt is still running after the timeout, the
+            # request is aborted and a +platform.timeout+ error returned.
+            #
+            # See also #http_open_timeout.
+            #
             # This operates at the HTTP transport level and is independent
-            # of any timeouts set within the API providing server.
+            # of any higher level timeouts that might be set up.
             #
             attr_accessor :http_timeout
 
+            # Optional Float indicating the Net::HTTP open timeout value.
+            #
+            # This is a value in seconds (default 60) for which the client
+            # will wait while attempting to connect to a server.
+            #
+            # If the connection attempt is still running after the timeout,
+            # the request is aborted and a +platform.timeout+ error returned.
+            #
+            # See also #http_timeout.
+            #
+            # This operates at the HTTP transport level and is independent
+            # of any higher level timeouts that might be set up.
+            #
+            attr_accessor :http_open_timeout
+
             # Optional Hash of query data.
             #
             attr_accessor :query_hash

data/lib/hoodoo/services/discovery/discoverers/by_convention.rb

@@ -36,47 +36,66 @@ module Hoodoo
             #
             # Options are:
             #
-            # +base_uri+::     A String giving the base URI at which resource
-            #                  endpoint implementations can be found. The
-            #                  protocol (HTTP or HTTPS), host and port are of
-            #                  interest. The path will be overwritten with
-            #                  by-convention values for individual resources.
-            #
-            # +proxy_uri+::    An optional full URI of an HTTP proxy to use if
-            #                  the base URI commands use of HTTP or HTTPS. Ruby
-            #                  will itself read <tt>ENV['HTTP_PROXY']</tt> if
-            #                  set; this option will _override_ that variable.
-            #                  Set as a String, as with +base_uri+.
-            #
-            # +ca_file+::      An optional String indicating a relative or
-            #                  absolute file path to the location of a +.pem+
-            #                  format Certificate Authority file (trust store),
-            #                  which may include multliple certificates. The
-            #                  certificates in the file will be used by
-            #                  Net::HTTP to validate the SSL ceritificate
-            #                  chain presented by remote servers, when calling
-            #                  endpoints over HTTPS with Hoodoo::Client.
-            #
-            #                  Default +nil+ value should be used in nearly all
-            #                  cases and uses Ruby OpenSSL defaults which are
-            #                  generally Operating System provided.
-            #
-            # +http_timeout+:: Optional Float indicating the Net::HTTP read
-            #                  timeout value. This operates at the HTTP
-            #                  transport level and is independent of any
-            #                  timeouts set within the API providing server.
-            #
-            # +routing+::      An optional parameter which gives custom routing
-            #                  for exception cases where the by-convention map
-            #                  doesn't work. This is usually because there is a
-            #                  resource singleton which lives logically at a
-            #                  singular named route rather than plural route,
-            #                  e.g. "/v1/health" rather than "/v1/healths".
+            # +base_uri+::          A String giving the base URI at which
+            #                       resource endpoint implementations can be
+            #                       found. The protocol (HTTP or HTTPS), host
+            #                       and port are of interest. The path will be
+            #                       overwritten with by-convention values for
+            #                       individual resources.
+            #
+            # +proxy_uri+::         An optional full URI of an HTTP proxy to
+            #                       use if the base URI commands use of HTTP or
+            #                       HTTPS. Ruby will itself read
+            #                       <tt>ENV['HTTP_PROXY']</tt> if set; this
+            #                       option _overrides_ that variable. Set as a
+            #                       String, as with +base_uri+.
+            #
+            # +ca_file+::           An optional String indicating a relative or
+            #                       absolute file path to the location of a
+            #                       +.pem+ format Certificate Authority file
+            #                       (trust store), which may include multliple
+            #                       certificates. The certificates in the file
+            #                       will be used by Net::HTTP to validate the
+            #                       SSL ceritificate chain presented by remote
+            #                       servers, when calling endpoints over HTTPS
+            #                       with Hoodoo::Client.
+            #
+            #                       The default +nil+ value should be used in
+            #                       nearly all cases and uses Ruby OpenSSL
+            #                       defaults which are generally Operating
+            #                       System provided.
+            #
+            # +http_timeout+::      Optional Float providing a Net::HTTP read
+            #                       timeout value, when calling endpoints over
+            #                       HTTPS with Hoodoo::Client. This is a value
+            #                       in seconds (default 60) that the client
+            #                       allows for any TCP read operation. It
+            #                       operates at the HTTP transport level and is
+            #                       independent of any higher level timeouts
+            #                       that might be set up.
+            #
+            # +http_open_timeout+:: Optional Float providing a Net::HTTP open
+            #                       timeout value, when calling endpoints over
+            #                       HTTPS with Hoodoo::Client. This is a value
+            #                       in seconds (default 60) that the client
+            #                       allows for any TCP connection attempt. It
+            #                       operates at the HTTP transport level and is
+            #                       independent of any higher level timeouts
+            #                       that might be set up.
+            #
+            # +routing+::           An optional parameter which gives custom
+            #                       routing for exception cases where the
+            #                       by-convention map doesn't work. This is
+            #                       usually because there is a resource
+            #                       singleton which lives logically at a
+            #                       singular named route rather than plural
+            #                       route, e.g. <tt>/v1/health</tt> rather than
+            #                       <tt>/v1/healths</tt>.
             #
             # The +routing+ parameter is a Hash of Resource names _as_
             # _Symbols_, then values which are Hash of API Version _as_
-            # _Integers_ with values that are the Strings giving the
-            # full alternative routing path.
+            # _Integers_ with values that are the Strings giving the full
+            # alternative routing path.
             #
             # For example, by convention API version 2 of a Health resource
             # would be routed to "/v2/healths". You would override this to a
@@ -99,11 +118,13 @@ module Hoodoo
             # actually Hoodoo itself but implemented in a compatible fashion.
             #
             def configure_with( options )
-              @base_uri     = URI.parse( options[ :base_uri  ] )
-              @proxy_uri    = URI.parse( options[ :proxy_uri ] ) unless options[ :proxy_uri ].nil?
-              @ca_file      = options[ :ca_file ]
-              @http_timeout = options[ :http_timeout ]
-              @routing      = options[ :routing ] || {}
+              @base_uri          = URI.parse( options[ :base_uri  ] )
+              @proxy_uri         = URI.parse( options[ :proxy_uri ] ) unless options[ :proxy_uri ].nil?
+
+              @ca_file           = options[ :ca_file           ]
+              @http_timeout      = options[ :http_timeout      ]
+              @http_open_timeout = options[ :http_open_timeout ]
+              @routing           = options[ :routing           ] || {}
             end
 
             # Announce the location of an instance. This is really a no-op
@@ -154,12 +175,13 @@ module Hoodoo
               endpoint_uri.path = path
 
               return Hoodoo::Services::Discovery::ForHTTP.new(
-                resource:     resource,
-                version:      version,
-                endpoint_uri: endpoint_uri,
-                proxy_uri:    @proxy_uri,
-                ca_file:      @ca_file,
-                http_timeout: @http_timeout
+                resource:          resource,
+                version:           version,
+                endpoint_uri:      endpoint_uri,
+                proxy_uri:         @proxy_uri,
+                ca_file:           @ca_file,
+                http_timeout:      @http_timeout,
+                http_open_timeout: @http_open_timeout
               )
             end
 

data/lib/hoodoo/services/discovery/results/for_http.rb

@@ -51,33 +51,62 @@ module Hoodoo
         attr_accessor :ca_file
 
         # Optional Float indicating the Net::HTTP read timeout value.
+        #
+        # This is a value in seconds (default 60) for which the client
+        # will wait while attempting to read data from a server in any
+        # individual TCP read operation. The timeout becomes active
+        # immediately after a server connection is established.
+        #
+        # If a read attempt is still running after the timeout, the
+        # request is aborted and a +platform.timeout+ error returned.
+        #
+        # See also #http_open_timeout.
+        #
         # This operates at the HTTP transport level and is independent
-        # of any timeouts set within the API providing server.
+        # of any higher level timeouts that might be set up.
         #
         attr_accessor :http_timeout
 
+        # Optional Float indicating the Net::HTTP open timeout value.
+        #
+        # This is a value in seconds (default 60) for which the client
+        # will wait while attempting to connect to a server.
+        #
+        # If the connection attempt is still running after the timeout,
+        # the request is aborted and a +platform.timeout+ error returned.
+        #
+        # See also #http_timeout.
+        #
+        # This operates at the HTTP transport level and is independent
+        # of any higher level timeouts that might be set up.
+        #
+        attr_accessor :http_open_timeout
+
         # Create an instance with named parameters as follows:
         #
-        # +resource+::     See #resource.
-        # +version+::      See #version.
-        # +endpoint_uri+:: See #endpoint_uri.
-        # +proxy_uri+::    See #proxy_uri. Optional.
-        # +ca_file+::      See #ca_file. Optional.
-        # +http_timeout+:: See #http_timeout. Optional.
+        # +resource+::          See #resource.
+        # +version+::           See #version.
+        # +endpoint_uri+::      See #endpoint_uri.
+        # +proxy_uri+::         See #proxy_uri. Optional.
+        # +ca_file+::           See #ca_file. Optional.
+        # +http_timeout+::      See #http_timeout. Optional.
+        # +http_open_timeout+:: See #http_open_timeout. Optional.
         #
         def initialize( resource:,
                         version:,
                         endpoint_uri:,
-                        proxy_uri:    nil,
-                        ca_file:      nil,
-                        http_timeout: nil )
+                        proxy_uri:         nil,
+                        ca_file:           nil,
+                        http_timeout:      nil,
+                        http_open_timeout: nil )
 
-          self.resource     = resource.to_sym
-          self.version      = version.to_i
-          self.endpoint_uri = endpoint_uri
-          self.proxy_uri    = proxy_uri
-          self.ca_file      = ca_file
-          self.http_timeout = http_timeout
+          self.resource          = resource.to_sym
+          self.version           = version.to_i
+          self.endpoint_uri      = endpoint_uri
+          self.proxy_uri         = proxy_uri
+          self.ca_file           = ca_file
+          self.http_timeout      = http_timeout
+          self.http_open_timeout = http_open_timeout
         end
       end
     end

data/lib/hoodoo/version.rb

@@ -9,9 +9,14 @@
 
 module Hoodoo
 
-  # The Hoodoo gem version. If this changes, ensure that the date in
-  # "hoodoo.gemspec" is correct and run "bundle install" (or "update").
+  # The Hoodoo gem version. If this changes, be sure to re-run
+  # <tt>bundle install</tt> or <tt>bundle update</tt>.
   #
-  VERSION = '1.17.0'
+  VERSION = '1.18.0'
+
+  # The Hoodoo gem date. If this changes, be sure to re-run
+  # <tt>bundle install</tt> or <tt>bundle update</tt>.
+  #
+  DATE = '2017-08-17'
 
 end

data/spec/client/client_spec.rb

@@ -461,10 +461,11 @@ describe Hoodoo::Client do
 
     context 'and with a custom HTTP read timeout' do
       before :each do
+        timeout    = 0.001
         base_uri   = "http://localhost:#{ @port }"
         discoverer = Hoodoo::Services::Discovery::ByConvention.new(
           base_uri:     base_uri,
-          http_timeout: 0.0000001
+          http_timeout: timeout
         )
 
         set_vars_for(
@@ -473,6 +474,43 @@ describe Hoodoo::Client do
           session_id:   @old_test_session.session_id,
           discoverer:   discoverer
         )
+
+        expect_any_instance_of( Net::HTTP ).to receive( :read_timeout= ).with( timeout ).and_call_original
+        allow_any_instance_of( Net::BufferedIO ).to receive( :read ) do | instance, *args |
+          expect( instance.read_timeout ).to eq( timeout )
+          raise Net::ReadTimeout
+        end
+      end
+
+      it 'times out elegantly' do
+        mock_ident = Hoodoo::UUID.generate()
+        result     = @endpoint.show( mock_ident )
+
+        expect( result.platform_errors.has_errors? ).to eq( true )
+        expect( result.platform_errors.errors[ 0 ][ 'code' ] ).to eq( 'platform.timeout' )
+      end
+    end
+
+    context 'and with a custom HTTP open timeout' do
+      before :each do
+        timeout    = 0.001
+        base_uri   = "http://localhost:#{ @port }"
+        discoverer = Hoodoo::Services::Discovery::ByConvention.new(
+          base_uri:          base_uri,
+          http_open_timeout: timeout
+        )
+
+        set_vars_for(
+          base_uri:     base_uri,
+          auto_session: false,
+          session_id:   @old_test_session.session_id,
+          discoverer:   discoverer
+        )
+
+        expect_any_instance_of( Net::HTTP ).to receive( :open_timeout= ).with( timeout ).and_call_original
+        expect( Timeout ).to receive( :timeout ).with( timeout, Net::OpenTimeout ).once do
+          raise Net::OpenTimeout
+        end
       end
 
       it 'times out elegantly' do

data/spec/services/discovery/results/for_http_spec.rb

@@ -24,14 +24,16 @@ describe Hoodoo::Services::Discovery::ForHTTP do
       endpoint_uri: endpoint_uri(),
       proxy_uri: proxy_uri(),
       ca_file: 'foo.pem',
-      http_timeout: 0.25
+      http_timeout: 0.25,
+      http_open_timeout: 2.5
     )
 
-    expect( r.resource     ).to eq( :Bar ) # Also Symbol
-    expect( r.version      ).to eq( 2 )
-    expect( r.endpoint_uri ).to eq( endpoint_uri() )
-    expect( r.proxy_uri    ).to eq( proxy_uri() )
-    expect( r.ca_file      ).to eq( 'foo.pem' )
-    expect( r.http_timeout ).to eq( 0.25 )
+    expect( r.resource          ).to eq( :Bar ) # Also Symbol
+    expect( r.version           ).to eq( 2 )
+    expect( r.endpoint_uri      ).to eq( endpoint_uri() )
+    expect( r.proxy_uri         ).to eq( proxy_uri() )
+    expect( r.ca_file           ).to eq( 'foo.pem' )
+    expect( r.http_timeout      ).to eq( 0.25 )
+    expect( r.http_open_timeout ).to eq( 2.5 )
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hoodoo
 version: !ruby/object:Gem::Version
-  version: 1.17.0
+  version: 1.18.0
 platform: ruby
 authors:
 - Loyalty New Zealand
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-01 00:00:00.000000000 Z
+date: 2017-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dalli