hoodoo 1.13.0 → 1.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7afd9823b45dd59e8031b83a8eafe26118d38240
-  data.tar.gz: 3b23639744e3b536f5f5192538e88d07cf7cccef
+  metadata.gz: 5f2eb0d49452cfe11be6f7953e2915139a799389
+  data.tar.gz: 2d9ca68a6fc2f064c7e8c1a3473ef3028369ff02
 SHA512:
-  metadata.gz: 79d4a1cc3b9217baecf9129b245e16fea79d80f0fd8cf1accc54724e43ec9d9ea0fc4988241ba5418d52c8c5f33b401fad4157db204e2adfcf8bac72ba69a9e6
-  data.tar.gz: 0bd7649d997eec9b349119464bcd6ea801ffd099bf0df21136e77a6401449cf045f8cd931d0a9846afcc5beb9be02f063643115bde2054de46ddbb5e8acd6766
+  metadata.gz: a3091aedf879cae316a5bbf757bca8f6a01967bd41608359d7ab01f8b54330d2faf482ac0d5d80e222d88ffa9425d15fec98e02e6c976aa9223adbd1ff536816
+  data.tar.gz: 2194d4e534790c220d2bdfadc2b9efc42a8ba408741b1933a6f0c66edd47e2e40103aa04a6a7a22e66e78576395d035a70e111425aad4c0bf59030590ff50019

data/lib/hoodoo.rb

@@ -13,6 +13,7 @@ module Hoodoo
 end
 
 require 'hoodoo/utilities'
+require 'hoodoo/transient_store'
 require 'hoodoo/communicators'
 require 'hoodoo/logger'
 require 'hoodoo/presenters'

data/lib/hoodoo/services/services/session.rb

@@ -10,6 +10,7 @@
 
 require 'ostruct'
 require 'dalli'
+require 'hoodoo/transient_store/mocks/dalli_client'
 
 module Hoodoo
   module Services
@@ -634,111 +635,14 @@ module Hoodoo
         )
       end
 
-      # Mock known uses of Dalli::Client with test implementations.
-      # Use explicitly, or as an RSpec implicit mock via something like
-      # this:
+      # Before Hoodoo::TransientStore was created, the Session system was
+      # directly tied into Memcached and had a mock backend used for tests
+      # without a Redis dependency. This now lives in
+      # Hoodoo::TransientStore::Mocks::DalliClient, but for any code out in
+      # the wild which might use the old Session namespace version, we add
+      # what amounts to a class alias here.
       #
-      #     allow( Dalli::Client ).to receive( :new ).and_return( Hoodoo::Services::Session::MockDalliClient.new )
-      #
-      # ...whenever you need to stub out real Memcached. You will
-      # probably want to add:
-      #
-      #     before :all do # (or ":each")
-      #       Hoodoo::Services::Session::MockDalliClient.reset()
-      #     end
-      #
-      # ...to "clean out Memcached" before or between tests. You can
-      # check the contents of mock Memcached by examining ::store's
-      # hash of data.
-      #
-      class MockDalliClient
-        @@store = {}
-
-        # For test analysis, return the hash of 'memcached' mock data.
-        #
-        # Entries are referenced by the key you used to originally
-        # store them; values are hashes with ":expires_at" giving an
-        # expiry time or "nil" and ":value" giving your stored value.
-        #
-        def self.store
-          @@store
-        end
-
-        # Wipe out all saved data.
-        #
-        def self.reset
-          @@store = {}
-        end
-
-        # Pass +true+ to bypass the mock client (subject to the caller
-        # reading ::bypass?) to e.g. get test code coverage on real
-        # Memcached. Pass +false+ otherwise.
-        #
-        def self.bypass( bypass_boolean )
-          @@bypass = bypass_boolean
-        end
-
-        @@bypass = false
-
-        # If +true+, bypass this class and use real Dalli::Client; else
-        # don't. Default return value is +false+.
-        #
-        def self.bypass?
-          @@bypass
-        end
-
-        # Get the data stored under the given key. Returns +nil+ if
-        # not found / expired.
-        #
-        # +key+:: Key to look up (see #set).
-        #
-        def get( key )
-          data = @@store[ key ]
-          return nil if data.nil?
-
-          expires_at = data[ :expires_at ]
-          return nil unless expires_at.nil? || Time.now < expires_at
-
-          return data[ :value ]
-        end
-
-        # Set data for a given key.
-        #
-        # +key+::   Key under which to store data.
-        #
-        # +value+:: Data to store.
-        #
-        # +ttl+::   (Optional) time-to-live ('live' as in living, not as in
-        #           'live TV') - a value in seconds, after which the data is
-        #           considered expired. If omitted, the data does not expire.
-        #
-        def set( key, value, ttl = nil )
-          data = {
-            :expires_at => ttl.nil? ? nil : Time.now.utc + ttl,
-            :value      => value
-          }
-
-          @@store[ key ] = data
-          true
-        end
-
-        # Remove data for the given key.
-        #
-        def delete( key )
-          if @@store.has_key?( key )
-            @@store.delete( key )
-            true
-          else
-            false
-          end
-        end
-
-        # Mock 'stats' health check.
-        #
-        def stats
-          true
-        end
-      end
+      MockDalliClient = Hoodoo::TransientStore::Mocks::DalliClient
     end
   end
 end

data/lib/hoodoo/transient_store.rb

@@ -0,0 +1,19 @@
+########################################################################
+# File::    transient_store.rb
+# (C)::     Loyalty New Zealand 2017
+#
+# Purpose:: Include temporary/transient storage abstraction layers.
+# ----------------------------------------------------------------------
+#           01-Feb-2017 (ADH): Created
+########################################################################
+
+# Core abstraction
+
+require 'hoodoo/transient_store/transient_store'
+require 'hoodoo/transient_store/transient_store/base'
+
+# Storage engine plugins
+
+require 'hoodoo/transient_store/transient_store/memcached'
+require 'hoodoo/transient_store/transient_store/redis'
+require 'hoodoo/transient_store/transient_store/memcached_redis_mirror'

data/lib/hoodoo/transient_store/mocks/dalli_client.rb

@@ -0,0 +1,148 @@
+########################################################################
+# File::    dalli_client.rb
+# (C)::     Loyalty New Zealand 2017
+#
+# Purpose:: A mock/fake Dalli::Client minimal implementation as an
+#           alternative test back-end for Memcached-independent tests.
+# ----------------------------------------------------------------------
+#           02-Feb-2017 (ADH): Created.
+########################################################################
+
+module Hoodoo
+  class TransientStore
+
+    # Mock back-end code used by tests to allow them to run without a
+    # dependency on the real engine (though the real engine is always
+    # recommended and Hoodoo core tests always cover both).
+    #
+    class Mocks
+
+      # Mock known uses of Dalli::Client with test implementations.
+      # Use explicitly, or as an RSpec implicit mock via something like
+      # this:
+      #
+      #     allow( Dalli::Client ).to(
+      #       receive( :new ).
+      #       and_return( Hoodoo::TransientStore::Mocks::DalliClient.new )
+      #     )
+      #
+      # ...whenever you need to stub out real Memcached. You will
+      # probably want to add:
+      #
+      #     before :all do # (or ":each")
+      #       Hoodoo::TransientStore::Mocks::DalliClient.reset()
+      #     end
+      #
+      # ...to "clean out Memcached" before or between tests. You can
+      # check the contents of mock Memcached by examining ::store's
+      # hash of data.
+      #
+      # The test coverage for Hoodoo::TransientStore selects this backend in
+      # passing. Generally speaking you should favour Hoodoo::TransientStore
+      # over hard-coding to a storage engine available by the Hoodoo
+      # abstraction and, as a result, may never need this mock class at all.
+      #
+      class DalliClient
+        @@store = {}
+
+        # For test analysis, return the hash of 'memcached' mock data.
+        #
+        # Entries are referenced by the key you used to originally
+        # store them; values are hashes with ":expires_at" giving an
+        # expiry time or "nil" and ":value" giving your stored value.
+        #
+        def self.store
+          @@store
+        end
+
+        # Wipe out all saved data.
+        #
+        def self.reset
+          @@store = {}
+        end
+
+        # Pass +true+ to bypass the mock client (subject to the caller
+        # reading ::bypass?) to e.g. get test code coverage on real
+        # Memcached. Pass +false+ otherwise.
+        #
+        # (Deprecated, but indefinitely maintained).
+        #
+        def self.bypass( bypass_boolean )
+          @@bypass = bypass_boolean
+        end
+
+        @@bypass = false
+
+        # If +true+, bypass this class and use real Dalli::Client; else
+        # don't. Default return value is +false+.
+        #
+        # (Deprecated, but indefinitely maintained).
+        #
+        def self.bypass?
+          @@bypass
+        end
+
+        # Get the data stored under the given key. Returns +nil+ if
+        # not found / expired.
+        #
+        # +key+:: Key to look up (see #set).
+        #
+        def get( key )
+          data = @@store[ key ]
+          return nil if data.nil?
+
+          expires_at = data[ :expires_at ]
+          return nil unless expires_at.nil? || Time.now < expires_at
+
+          return data[ :value ]
+        end
+
+        # Set data for a given key.
+        #
+        # +key+::   Key under which to store data.
+        #
+        # +value+:: Data to store.
+        #
+        # +ttl+::   (Optional) time-to-live ('live' as in living, not as in
+        #           'live TV') - a value in seconds, after which the data is
+        #           considered expired. If omitted, the data does not expire.
+        #
+        def set( key, value, ttl = nil )
+          data = {
+            :expires_at => ttl.nil? ? nil : Time.now.utc + ttl,
+            :value      => value
+          }
+
+          @@store[ key ] = data
+          true
+        end
+
+        # Remove data for the given key.
+        #
+        def delete( key )
+          if @@store.has_key?( key )
+            @@store.delete( key )
+            true
+          else
+            false
+          end
+        end
+
+        # Stub for 'closing' a connection.
+        #
+        def close; end
+
+        # Mock 'stats' health check.
+        #
+        def stats
+
+          # Should really be a Hash, but kept as 'true' in case any existing
+          # client depends on this; it isn't too important either way.
+          #
+          true
+
+        end
+      end
+    end
+  end
+end

data/lib/hoodoo/transient_store/mocks/redis.rb

@@ -0,0 +1,138 @@
+########################################################################
+# File::    redis.rb
+# (C)::     Loyalty New Zealand 2017
+#
+# Purpose:: A mock/fake Redis client minimal implementation as an
+#           alternative test back-end for Redis-independent tests.
+# ----------------------------------------------------------------------
+#           02-Feb-2017 (ADH): Created.
+########################################################################
+
+module Hoodoo
+  class TransientStore
+    class Mocks
+
+      # Mock known uses of Redis with test implementations. Use explicitly,
+      # or as an RSpec implicit mock via something like this:
+      #
+      #     allow( Redis ).to(
+      #       receive( :new ).
+      #       and_return( Hoodoo::TransientStore::Mocks::Redis.new )
+      #     )
+      #
+      # ...whenever you need to stub out real Memcached. You will
+      # probably want to add:
+      #
+      #     before :all do # (or ":each")
+      #       Hoodoo::TransientStore::Mocks::Redis.reset()
+      #     end
+      #
+      # ...to "clean out Memcached" before or between tests. You can
+      # check the contents of mock Memcached by examining ::store's
+      # hash of data.
+      #
+      # The test coverage for Hoodoo::TransientStore selects this backend in
+      # passing. Generally speaking you should favour Hoodoo::TransientStore
+      # over hard-coding to a storage engine available by the Hoodoo
+      # abstraction and, as a result, may never need this mock class at all.
+      #
+      class Redis
+        @@store = {}
+
+        # For test analysis, return the hash of 'memcached' mock data.
+        #
+        # Entries are referenced by the key you used to originally
+        # store them; values are hashes with ":expires_at" giving an
+        # expiry time or "nil" and ":value" giving your stored value.
+        #
+        def self.store
+          @@store
+        end
+
+        # Wipe out all saved data.
+        #
+        def self.reset
+          @@store = {}
+        end
+
+        # Get the data stored under the given key. Returns +nil+ if
+        # not found / expired.
+        #
+        # +key+:: Key to look up (see #set).
+        #
+        def get( key )
+          data = @@store[ key ]
+          return nil if data.nil?
+
+          expires_at = data[ :expires_at ]
+          return nil unless expires_at.nil? || Time.now < expires_at
+
+          return data[ :value ]
+        end
+
+        # Alias for #get.
+        #
+        def []( key )
+          get( key )
+        end
+
+        # Set data for a given key.
+        #
+        # +key+::   Key under which to store data.
+        #
+        # +value+:: Data to store.
+        #
+        # +ttl+::   (Optional) time-to-live ('live' as in living, not as in
+        #           'live TV') - a value in seconds, after which the data is
+        #           considered expired. If omitted, the data does not expire.
+        #
+        def set( key, value, ttl = nil )
+          @@store[ key ] = { :value => value }
+          'OK'
+        end
+
+        # Alias for #set.
+        #
+        def []=( key, value )
+          set( key, value )
+        end
+
+        # Set expiry time for a given key, which must exist.
+        #
+        # +ttl+:: time-to-live ('live' as in living, not as in 'live TV').
+        #         A value in seconds, after which the data is considered
+        #         expired.
+        #
+        def expire( key, ttl )
+          unless @@store.has_key?( key )
+            raise "Hoodoo::TransientStore::Mocks::Redis\#expire: Cannot find key '#{ key }'"
+          end
+
+          @@store[ key ][ :expires_at ] = Time.now.utc + ttl
+          true
+        end
+
+        # Remove data for the given key.
+        #
+        def del( key )
+          if @@store.has_key?( key )
+            @@store.delete( key )
+            1
+          else
+            0
+          end
+        end
+
+        # Stub for 'closing' a connection.
+        #
+        def quit; end
+
+        # Mock 'info' health check.
+        #
+        def info( command )
+          { :alive => command }
+        end
+      end
+    end
+  end
+end