hoodoo 2.2.3 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b44ab5eb415262a966b85b5745d7babae95bcea72ad1f82dc17d9ba1b0e8aee6
-  data.tar.gz: 7894b8277a7061f9ec1e83ab15fb6f25d92797cf3ad59e2a2d03968ac098b636
+  metadata.gz: 0e8b58918454743aba0a3c4b64ed5b16dded3369ce27868c4344386c83286c84
+  data.tar.gz: 37d7dc316771890f1ff8021420d34a6c12caeb9f7e6928f0d424700734d353c6
 SHA512:
-  metadata.gz: c691cdaf17d8964a04edc102358485047a6b361147f5a14cc8d555772b4709f9dc903ae2d319c5392506330c0686c5cd09ed026bfc0470f923d39bc3d74a1e04
-  data.tar.gz: d2325636825a764be468a6411efec5a9e6bfec2e6d6f5d06f2b404d16a0411b95a23e9499e578600649baadfe65f3069cbdce146367c1acfbbceadef255c2195
+  metadata.gz: 8908060c76f8dd1de5c031d4143a1c3f1e3481c1124d081a0b33c700330aa6a9bd903e811185f7a1beb8f14d5fe29b816acddd684d669eb3ecbf8a27848a6822
+  data.tar.gz: c5d7c0f1b3a00e1be635f5c10fc3c9b4a075bb76da1506cc4587d0d8a329a161c3ff935a370be941707eb75a5649fa1a1e666fa24bca07e23333f352df0f4552

data/lib/hoodoo/client/headers.rb

@@ -65,7 +65,7 @@ module Hoodoo
       #
       DATETIME_IN_PAST_ONLY_PROPERTY_PROC = -> ( value ) {
         value = Hoodoo::Utilities.valid_iso8601_subset_datetime?( value )
-        value = nil if value && value > DateTime.now
+        value = nil if value && Hoodoo::Utilities.is_in_future?( value )
         value || nil # => 'value' if 'value' is truthy, 'nil' if 'value' falsy
       }
 

data/lib/hoodoo/services/middleware/middleware.rb

@@ -260,14 +260,36 @@ module Hoodoo; module Services
     # host available.
     #
     def self.memcached_host
-      ENV[ 'MEMCACHED_HOST' ] || ENV[ 'MEMCACHE_URL' ]
+
+      # See also ::clear_memcached_configuration_cache!.
+      #
+      @@memcached_host ||= ENV[ 'MEMCACHED_HOST' ] || ENV[ 'MEMCACHE_URL' ]
+
+    end
+
+    # This method is intended really just for testing purposes; it clears the
+    # internal cache of Memcached data read from environment variables.
+    #
+    def self.clear_memcached_configuration_cache!
+      @@memcached_host = nil
     end
 
     # Are we running on the queue, else (implied) a local HTTP server?
     #
     def self.on_queue?
-      q = ENV[ 'AMQ_URI' ]
-      q.nil? == false && q.empty? == false
+
+      # See also ::clear_queue_configuration_cache!.
+      #
+      @@amq_uri ||= ENV[ 'AMQ_URI' ]
+      @@amq_uri.nil? == false && @@amq_uri.empty? == false
+
+    end
+
+    # This method is intended really just for testing purposes; it clears the
+    # internal cache of AMQP queue data read from environment variables.
+    #
+    def self.clear_queue_configuration_cache!
+      @@amq_uri = nil
     end
 
     # Return a service 'name' derived from the service's collection of

data/lib/hoodoo/utilities/utilities.rb

@@ -340,6 +340,51 @@ module Hoodoo
       return value.is_a?( ::Date ) && value
     end
 
+    # Is the given Time, DateTime or String instance specifying a date-time
+    # that is in the future relevant to this executing environment's concept
+    # of "now", allowing for +CLOCK_DRIFT_TOLERANCE+? Returns +true+ if so,
+    # else +false+.
+    #
+    # Future date (clock drift) tolerance is specified in seconds using the
+    # +HOODOO_CLOCK_DRIFT_TOLERANCE+ environment variable. The default is 30
+    # seconds, as described in the relevant Hoodoo Guide:
+    #
+    #   http://loyaltynz.github.io/hoodoo/guides_1000_env_vars.html#hoodoo_clock_drift_tolerance
+    #
+    # +input+:: A value that's passed to ::rationalise_datetime with the
+    #           result checked against `now` allowing for clock drift.
+    #
+    # If the given input is not parseable as a date-time like object, then
+    # the method it will throw a RuntimeError exception via
+    # ::rationalise_datetime.
+    #
+    def self.is_in_future?( input )
+
+      # See also ::clear_clock_drift_configuration_cache!.
+      #
+      @@clock_drift_tolerance ||= (
+        ENV[ 'HOODOO_CLOCK_DRIFT_TOLERANCE' ].nil? ?
+                                                30 :
+        ENV[ 'HOODOO_CLOCK_DRIFT_TOLERANCE' ].to_i
+      )
+
+      value = self.rationalise_datetime( input )
+
+      # Unlike Time, integer addition to DateTime adds days. There are 86400
+      # seconds per day, so below we add @@clock_drift_tolerance seconds.
+      #
+      value > DateTime.now + Rational(@@clock_drift_tolerance, 86400)
+
+    end
+
+    # This method is intended really just for testing purposes; it clears the
+    # internal cache of clock drift tolerance read from environment variable
+    # +HOODOO_CLOCK_DRIFT_TOLERANCE+.
+    #
+    def self.clear_clock_drift_configuration_cache!
+      @@clock_drift_tolerance = nil
+    end
+
     # Returns an ISO 8601 String equivalent of the given Time, Date or
     # DateTime instance as a full date-time with UTC timezone, with
     # "standard high precision" (for rendeirng consistency), subject to

data/lib/hoodoo/version.rb

@@ -12,11 +12,11 @@ module Hoodoo
   # The Hoodoo gem version. If this changes, be sure to re-run
   # <tt>bundle install</tt> or <tt>bundle update</tt>.
   #
-  VERSION = '2.2.3'
+  VERSION = '2.3.0'
 
   # The Hoodoo gem date. If this changes, be sure to re-run
   # <tt>bundle install</tt> or <tt>bundle update</tt>.
   #
-  DATE = '2018-02-19'
+  DATE = '2018-02-22'
 
 end

data/spec/client/headers_spec.rb

@@ -76,6 +76,21 @@ describe Hoodoo::Client::Headers do
         expect( described_class::DATETIME_IN_PAST_ONLY_PROPERTY_PROC.call( date_time_str ) ).to be_nil
       end
     end
+
+    # We assume good coverage for the Utility method below. If this header
+    # Proc is calling that and appears to be responding to its return value,
+    # that's good enough for us here.
+    #
+    it 'uses Hoodoo::Utilities::is_in_future? for is-future checks' do
+      date_time = DateTime.now - 10.seconds
+      date_time_str = Hoodoo::Utilities.nanosecond_iso8601( date_time )
+
+      expect( Hoodoo::Utilities ).to receive( :is_in_future? ).with( date_time ).once.and_return( false )
+      expect( described_class::DATETIME_IN_PAST_ONLY_PROPERTY_PROC.call( date_time_str ) ).to eq( date_time )
+
+      expect( Hoodoo::Utilities ).to receive( :is_in_future? ).with( date_time ).once.and_return( true )
+      expect( described_class::DATETIME_IN_PAST_ONLY_PROPERTY_PROC.call( date_time_str ) ).to be_nil
+    end
   end
 
   it 'DATETIME_WRITER_PROC calls rationalisation method' do

data/spec/services/middleware/middleware_logging_spec.rb

@@ -99,7 +99,9 @@ describe Hoodoo::Services::Middleware do
   context 'off queue' do
     before :each do
       @old_queue = ENV[ 'AMQ_URI' ]
+
       ENV[ 'AMQ_URI' ] = nil
+      Hoodoo::Services::Middleware.clear_queue_configuration_cache!
 
       @cvar = false
       if Hoodoo::Services::Middleware.class_variable_defined?( '@@alchemy' )
@@ -110,6 +112,7 @@ describe Hoodoo::Services::Middleware do
 
     after :each do
       ENV[ 'AMQ_URI' ] = @old_queue
+      Hoodoo::Services::Middleware.clear_queue_configuration_cache!
 
       if Hoodoo::Services::Middleware.class_variable_defined?( '@@alchemy' )
         if @cvar == true
@@ -146,7 +149,9 @@ describe Hoodoo::Services::Middleware do
   context 'on queue' do
     before :each do
       @old_queue = ENV[ 'AMQ_URI' ]
+
       ENV[ 'AMQ_URI' ] = 'amqp://test:test@127.0.0.1'
+      Hoodoo::Services::Middleware.clear_queue_configuration_cache!
 
       @cvar = false
       if Hoodoo::Services::Middleware.class_variable_defined?( '@@alchemy' )
@@ -157,6 +162,7 @@ describe Hoodoo::Services::Middleware do
 
     after :each do
       ENV[ 'AMQ_URI' ] = @old_queue
+      Hoodoo::Services::Middleware.clear_queue_configuration_cache!
 
       if Hoodoo::Services::Middleware.class_variable_defined?( '@@alchemy' )
         if @cvar == true

data/spec/services/middleware/middleware_spec.rb

@@ -178,31 +178,86 @@ describe Hoodoo::Services::Middleware do
   end
 
   context 'utility methods' do
+    before :each do
+      Hoodoo::Services::Middleware.clear_memcached_configuration_cache!
+      Hoodoo::Services::Middleware.clear_queue_configuration_cache!
+    end
+
+    after :each do
+      Hoodoo::Services::Middleware.clear_memcached_configuration_cache!
+      Hoodoo::Services::Middleware.clear_queue_configuration_cache!
+    end
+
     it 'should know about Memcached via environment variable' do
-      old = ENV[ 'MEMCACHED_HOST' ]
-      ENV[ 'MEMCACHED_HOST' ] = nil
-      expect(Hoodoo::Services::Middleware.has_memcached?).to eq(false)
-      ENV[ 'MEMCACHED_HOST' ] = 'foo'
-      expect(Hoodoo::Services::Middleware.has_memcached?).to eq(true)
-      ENV[ 'MEMCACHED_HOST' ] = old
+      spec_helper_change_environment( 'MEMCACHED_HOST', nil ) do
+        expect(Hoodoo::Services::Middleware.has_memcached?).to eq(false)
+      end
+
+      spec_helper_change_environment( 'MEMCACHED_HOST', 'foo' ) do
+        Hoodoo::Services::Middleware.clear_memcached_configuration_cache!
+        expect(Hoodoo::Services::Middleware.has_memcached?).to eq(true)
+      end
+    end
+
+    it 'caches Memcached environment variable value' do
+      spec_helper_change_environment( 'MEMCACHED_HOST', 'foo' ) do
+        expect(Hoodoo::Services::Middleware.has_memcached?).to eq(true)
+
+        # Cached value -> result of check remains 'true', since prior
+        # result is cached.
+        #
+        spec_helper_change_environment( 'MEMCACHED_HOST', nil ) do
+          expect(Hoodoo::Services::Middleware.has_memcached?).to eq(true)
+        end
+      end
     end
 
     it 'should know about Memcached via legacy environment variable' do
-      old = ENV[ 'MEMCACHED_HOST' ]
-      ENV[ 'MEMCACHED_HOST' ] = nil
-      expect(Hoodoo::Services::Middleware.has_memcached?).to eq(false)
-      ENV[ 'MEMCACHED_HOST' ] = 'foo'
-      expect(Hoodoo::Services::Middleware.has_memcached?).to eq(true)
-      ENV[ 'MEMCACHED_HOST' ] = old
+      spec_helper_change_environment( 'MEMCACHE_URL', nil ) do
+        expect(Hoodoo::Services::Middleware.has_memcached?).to eq(false)
+      end
+
+      spec_helper_change_environment( 'MEMCACHE_URL', 'foo' ) do
+        Hoodoo::Services::Middleware.clear_memcached_configuration_cache!
+        expect(Hoodoo::Services::Middleware.has_memcached?).to eq(true)
+      end
+    end
+
+    it 'caches legacy Memcached environment variable value' do
+      spec_helper_change_environment( 'MEMCACHE_URL', 'foo' ) do
+        expect(Hoodoo::Services::Middleware.has_memcached?).to eq(true)
+
+        # Cached value -> result of check remains 'true', since prior
+        # result is cached.
+        #
+        spec_helper_change_environment( 'MEMCACHE_URL', nil ) do
+          expect(Hoodoo::Services::Middleware.has_memcached?).to eq(true)
+        end
+      end
     end
 
     it 'should know about a queue' do
-      old = ENV[ 'AMQ_URI' ]
-      ENV[ 'AMQ_URI' ] = nil
-      expect(Hoodoo::Services::Middleware.on_queue?).to eq(false)
-      ENV[ 'AMQ_URI' ] = 'foo'
-      expect(Hoodoo::Services::Middleware.on_queue?).to eq(true)
-      ENV[ 'AMQ_URI' ] = old
+      spec_helper_change_environment( 'AMQ_URI', nil ) do
+        expect(Hoodoo::Services::Middleware.on_queue?).to eq(false)
+      end
+
+      spec_helper_change_environment( 'AMQ_URI', 'foo' ) do
+        Hoodoo::Services::Middleware.clear_queue_configuration_cache!
+        expect(Hoodoo::Services::Middleware.on_queue?).to eq(true)
+      end
+    end
+
+    it 'caches queue environment variable value' do
+      spec_helper_change_environment( 'AMQ_URI', 'foo' ) do
+        expect(Hoodoo::Services::Middleware.on_queue?).to eq(true)
+
+        # Cached value -> result of check remains 'true', since prior
+        # result is cached.
+        #
+        spec_helper_change_environment( 'AMQ_URI', nil ) do
+          expect(Hoodoo::Services::Middleware.on_queue?).to eq(true)
+        end
+      end
     end
   end
 

data/spec/shared_examples/middleware_amqp.rb

@@ -21,7 +21,10 @@ shared_examples 'an AMQP-based middleware/client endpoint' do |optional_extra_he
   before :each do
     @optional_extra_header_hash = optional_extra_header_hash || {}
     @old_queue = ENV[ 'AMQ_URI' ]
+
     ENV[ 'AMQ_URI' ] = 'amqp://test:test@127.0.0.1'
+    Hoodoo::Services::Middleware.clear_queue_configuration_cache!
+
     @mw = Hoodoo::Services::Middleware.new( RSpecTestServiceExoticStub.new )
 
     @cvar = false
@@ -39,6 +42,7 @@ shared_examples 'an AMQP-based middleware/client endpoint' do |optional_extra_he
 
   after :each do
     ENV[ 'AMQ_URI' ] = @old_queue
+    Hoodoo::Services::Middleware.clear_queue_configuration_cache!
 
     if Hoodoo::Services::Middleware.class_variable_defined?( '@@alchemy' )
       if @cvar == true

data/spec/spec_helper.rb

@@ -380,6 +380,19 @@ def spec_helper_count_database_calls_in( &block )
   return count
 end
 
+# Change a named environment varible's value and call a given block.
+# Afterwards, restore the old value of that variable.
+
+def spec_helper_change_environment( name, value, &block )
+  old_value = ENV[ name ]
+  begin
+    ENV[ name ] = value
+    yield
+  ensure
+    ENV[ name ] = old_value
+  end
+end
+
 # In Ruby 2.5.0 the Ruby team removed <tt>Dir::Tmpname.make_tmpname</tt>:
 #
 # https://github.com/ruby/ruby/commit/25d56ea7b7b52dc81af30c92a9a0e2d2dab6ff27

data/spec/utilities/utilities_spec.rb

@@ -485,6 +485,66 @@ describe Hoodoo::Utilities do
     end
   end
 
+  describe '#is_in_future?' do
+    before :each do
+      @old_drift = ENV[ 'HOODOO_CLOCK_DRIFT_TOLERANCE' ]
+      ENV.delete( 'HOODOO_CLOCK_DRIFT_TOLERANCE' )
+      Hoodoo::Utilities.clear_clock_drift_configuration_cache!
+
+      @default = 30
+    end
+
+    after :all do
+      ENV[ 'HOODOO_CLOCK_DRIFT_TOLERANCE' ] = @old_drift
+    end
+
+    it 'says "no" for "now"' do
+      expect( Hoodoo::Utilities.is_in_future?( Time.now ) ).to eq( false )
+    end
+
+    it 'says "no" inside default drift allowance' do
+      expect( Hoodoo::Utilities.is_in_future?( Time.now + ( @default / 2 ) ) ).to eq( false )
+    end
+
+    # Hoodoo Guides: "...less than or equal to... ...is permitted...".
+    #
+    it 'says "no" at default drift allowance' do
+      expect( Hoodoo::Utilities.is_in_future?( Time.now + @default ) ).to eq( false )
+    end
+
+    it 'says "yes" outside default drift allowance' do
+      expect( Hoodoo::Utilities.is_in_future?( Time.now + @default + 1 ) ).to eq( true )
+    end
+
+    it 'drift allowance can be reconfigured' do
+      spec_helper_change_environment( 'HOODOO_CLOCK_DRIFT_TOLERANCE', '10' ) do
+        Hoodoo::Utilities.clear_clock_drift_configuration_cache!
+        expect( Hoodoo::Utilities.is_in_future?( Time.now + 10 ) ).to eq( false )
+        expect( Hoodoo::Utilities.is_in_future?( Time.now + 11 ) ).to eq( true )
+      end
+    end
+
+    it 'drift allowance can be set to zero' do
+      spec_helper_change_environment( 'HOODOO_CLOCK_DRIFT_TOLERANCE', '0' ) do
+        Hoodoo::Utilities.clear_clock_drift_configuration_cache!
+        expect( Hoodoo::Utilities.is_in_future?( Time.now ) ).to eq( false )
+        expect( Hoodoo::Utilities.is_in_future?( Time.now + 0.1 ) ).to eq( true )
+      end
+    end
+
+    it 'drift configuration is cached' do
+      expect( Hoodoo::Utilities.is_in_future?( Time.now + @default + 1 ) ).to eq( true )
+
+      # Configuring the environment variable for a much longer tolerance
+      # without resetting the internal cache variable should result in
+      # the old value still being used.
+      #
+      spec_helper_change_environment( 'HOODOO_CLOCK_DRIFT_TOLERANCE', ( @default * 2 ).to_s ) do
+        expect( Hoodoo::Utilities.is_in_future?( Time.now + @default + 1 ) ).to eq( true )
+      end
+    end
+  end
+
   describe '#standard_iso8601' do
     before :each do
       @old_tz = ENV[ 'TZ' ]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hoodoo
 version: !ruby/object:Gem::Version
-  version: 2.2.3
+  version: 2.3.0
 platform: ruby
 authors:
 - Loyalty New Zealand
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-19 00:00:00.000000000 Z
+date: 2018-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dalli