hoodoo 1.13.0 → 1.14.0

data/spec/transient_store/transient_store_spec.rb

@@ -0,0 +1,448 @@
+require 'spec_helper'
+
+# These tests assume the Memcached plugin is available and has been unit
+# tested thoroughly elsewhere.
+#
+describe Hoodoo::TransientStore do
+
+  RDOC_STATED_DEFAULT_LIFESPAN  = 604800
+  RDOC_STATED_DEFAULT_NAMESPACE = 'nz_co_loyalty_hoodoo_transient_store_'
+
+  class TestTransientStore < Hoodoo::TransientStore::Base
+    def initialize( storage_host_uri:, namespace: )
+      @pool = {}
+    end
+
+    def set( key:, payload:, maximum_lifespan: )
+      @pool[ key ] = payload
+      true
+    end
+
+    def get( key: )
+      @pool[ key ]
+    end
+
+    def delete( key: )
+      @pool.delete( key )
+      true
+    end
+  end
+
+  # ==========================================================================
+
+  context 'registration' do
+    it 'allows registration' do
+      random_name = Hoodoo::UUID.generate().to_sym()
+      Hoodoo::TransientStore.register( as: random_name, using: TestTransientStore )
+
+      expect( Hoodoo::TransientStore.supported_storage_engines() ).to include( random_name )
+    end
+
+    it 'complains about re-registration' do
+      random_name = Hoodoo::UUID.generate().to_sym()
+      Hoodoo::TransientStore.register( as: random_name, using: TestTransientStore )
+
+      expect {
+        Hoodoo::TransientStore.register( as: random_name, using: TestTransientStore )
+      }.to raise_error( RuntimeError, "Hoodoo::TransientStore.register: A storage engine called '#{ random_name }' is already registered" )
+    end
+
+    it 'complains about incorrect subclassing' do
+      random_name = Hoodoo::UUID.generate().to_sym()
+
+      expect {
+        Hoodoo::TransientStore.register( as: random_name, using: Class )
+      }.to raise_error( RuntimeError, "Hoodoo::TransientStore.register requires a Hoodoo::TransientStore::Base subclass - got 'Class'" )
+    end
+
+    it 'allows deregistration' do
+      random_name = Hoodoo::UUID.generate().to_sym()
+
+      Hoodoo::TransientStore.register( as: random_name, using: TestTransientStore )
+      expect( Hoodoo::TransientStore.supported_storage_engines() ).to include( random_name )
+
+      Hoodoo::TransientStore.deregister( as: random_name )
+      expect( Hoodoo::TransientStore.supported_storage_engines() ).to_not include( random_name )
+    end
+  end
+
+  # ==========================================================================
+
+  context 'with' do
+
+    before :each do
+      @engine_name = Hoodoo::UUID.generate().to_sym
+      Hoodoo::TransientStore.register( as: @engine_name, using: TestTransientStore )
+    end
+
+    context '#initialize' do
+      it 'initialises' do
+        max_life  = 120
+        namespace = Hoodoo::UUID.generate()
+        uri       = 'localhost'
+
+        expect( TestTransientStore ).to receive( :new ).with( storage_host_uri: uri, namespace: namespace )
+
+        result = Hoodoo::TransientStore.new(
+          storage_engine:           @engine_name,
+          storage_host_uri:         uri,
+          default_maximum_lifespan: max_life,
+          default_namespace:        namespace
+        )
+
+        expect( result ).to be_a( Hoodoo::TransientStore )
+        expect( result.storage_engine ).to eql( @engine_name )
+        expect( result.default_maximum_lifespan ).to eql( max_life )
+        expect( result.default_namespace ).to eql( namespace )
+      end
+
+      it 'initialises with defaults' do
+        result = Hoodoo::TransientStore.new(
+          storage_engine:   @engine_name,
+          storage_host_uri: 'localhost'
+        )
+
+        expect( result.default_maximum_lifespan ).to eql( RDOC_STATED_DEFAULT_LIFESPAN  )
+        expect( result.default_namespace        ).to eql( RDOC_STATED_DEFAULT_NAMESPACE )
+      end
+
+      context 'unknown storage engines' do
+        before :each do
+          @old_engines = Hoodoo::TransientStore.class_variable_get( '@@supported_storage_engines' )
+          Hoodoo::TransientStore.class_variable_set( '@@supported_storage_engines', { @engine_name => TestTransientStore } ) # Hack for test!
+        end
+
+        after :each do
+          Hoodoo::TransientStore.class_variable_set( '@@supported_storage_engines', @old_engines ) # Hack for test!
+        end
+
+        it 'cause complaint' do
+          # Add two more engine names
+          #
+          Hoodoo::TransientStore.register( as: 'foo', using: TestTransientStore )
+          Hoodoo::TransientStore.register( as: 'bar', using: TestTransientStore )
+
+          expect {
+            result = Hoodoo::TransientStore.new(
+              storage_engine:   :baz,
+              storage_host_uri: 'localhost'
+            )
+          }.to raise_error( RuntimeError, "Hoodoo::TransientStore: Unrecognised storage engine ':baz' requested; allowed values: '#{ @engine_name.to_sym.inspect }', ':foo', ':bar'" )
+        end
+      end
+    end
+
+    # ========================================================================
+
+    context 'attribute accessor' do
+      before :each do
+        @ttl       = 120
+        @namespace = Hoodoo::UUID.generate()
+        @store     = Hoodoo::TransientStore.new(
+          storage_engine:           @engine_name,
+          storage_host_uri:         'localhost',
+          default_maximum_lifespan: @ttl,
+          default_namespace:        @namespace
+        )
+      end
+
+      it '#storage_engine' do
+        expect( @store.storage_engine ).to eql( @engine_name )
+      end
+
+      it '#storage_engine_instance' do
+        expect( @store.storage_engine_instance ).to be_a( TestTransientStore )
+      end
+
+      it '#default_maximum_lifespan' do
+        expect( @store.default_maximum_lifespan ).to eql( @ttl )
+      end
+
+      it '#default_namespace' do
+        expect( @store.default_namespace ).to eql( @namespace )
+      end
+    end
+
+    # ========================================================================
+
+    context '#set' do
+      before :each do
+        @store = Hoodoo::TransientStore.new(
+          storage_engine:   @engine_name,
+          storage_host_uri: 'localhost'
+        )
+      end
+
+      it 'sets with default lifespan' do
+        key     = Hoodoo::UUID.generate()
+        payload = { 'foo' => 'bar' }
+
+        expect_any_instance_of( TestTransientStore ).to(
+          receive( :set ).
+          with(
+            key:              key,
+            payload:          payload,
+            maximum_lifespan: RDOC_STATED_DEFAULT_LIFESPAN
+          ).
+          and_call_original()
+        )
+
+        result = @store.set( key: key, payload: payload )
+        expect( result ).to eq( true )
+      end
+
+      it 'sets with explicit lifespan' do
+        key      = Hoodoo::UUID.generate()
+        payload  = { 'foo' => 'bar' }
+        lifespan = 1
+
+        expect_any_instance_of( TestTransientStore ).to(
+          receive( :set ).
+          with(
+            key:              key,
+            payload:          payload,
+            maximum_lifespan: lifespan
+          ).
+          and_call_original()
+        )
+
+        result = @store.set( key: key, payload: payload, maximum_lifespan: lifespan )
+        expect( result ).to eq( true )
+      end
+
+      it 'consumes and returns exceptions' do
+        expect_any_instance_of( TestTransientStore ).to receive( :set ) do
+          raise 'Hello world'
+        end
+
+        result = @store.set( key: '1', payload: '2' )
+
+        expect( result ).to be_a( RuntimeError )
+        expect( result.message ).to eql( 'Hello world' )
+      end
+
+      it 'prohibits "nil" payloads' do
+        expect {
+          result = @store.set( key: '1', payload: nil )
+        }.to raise_error( RuntimeError, "Hoodoo::TransientStore\#set: Payloads of 'nil' are prohibited" )
+      end
+
+      it 'detects faulty engines' do
+        expect_any_instance_of( TestTransientStore ).to receive( :set ) do
+          'not a boolean'
+        end
+
+        result = @store.set( key: '1', payload: '2' )
+
+        expect( result ).to be_a( RuntimeError )
+        expect( result.message ).to eql( "Hoodoo::TransientStore\#set: Engine '#{ @engine_name }' returned an invalid response" )
+      end
+
+      context 'key normalisation' do
+        it 'normalises the key' do
+          key = :some_symbol
+
+          expect_any_instance_of( TestTransientStore ).to(
+            receive( :set ).with(
+              key:              key.to_s, # i.e. Symbol has been normalised to String
+              payload:          {},
+              maximum_lifespan: RDOC_STATED_DEFAULT_LIFESPAN
+            )
+          )
+
+          @store.set( key: key, payload: {} )
+        end
+
+        it 'complains about unsupported key types' do
+          expect {
+            @store.set( key: Hash.new, payload: {} )
+          }.to raise_error( RuntimeError, "Hoodoo::TransientStore\#set: Keys must be of String or Symbol class; you provided 'Hash'" )
+        end
+
+        it 'complains about empty keys' do
+          expect {
+            @store.set( key: '', payload: {} )
+          }.to raise_error( RuntimeError, 'Hoodoo::TransientStore#set: Empty String or Symbol keys are prohibited' )
+        end
+      end
+    end
+
+    # ========================================================================
+
+    context '#get' do
+      before :each do
+        @store = Hoodoo::TransientStore.new(
+          storage_engine:   @engine_name,
+          storage_host_uri: 'localhost'
+        )
+
+        @key     = Hoodoo::UUID.generate()
+        @payload = { 'foo' => 'bar' }
+
+        @store.set( key: @key, payload: @payload )
+      end
+
+      it 'gets known keys' do
+        expect_any_instance_of( TestTransientStore ).to(
+          receive( :get ).with( key: @key ).and_call_original()
+        )
+
+        expect( @store.get( key: @key ) ).to eql( @payload )
+      end
+
+      it 'returns "nil" for unknown keys' do
+        random_key = Hoodoo::UUID.generate()
+
+        expect_any_instance_of( TestTransientStore ).to(
+          receive( :get ).with( key: random_key ).and_call_original()
+        )
+
+        expect( @store.get( key: random_key ) ).to be_nil
+      end
+
+      it 'consumes exceptions' do
+        expect_any_instance_of( TestTransientStore ).to receive( :get ) do
+          raise 'Hello world'
+        end
+
+        expect( @store.get( key: @key ) ).to be_nil
+      end
+
+      context 'key normalisation' do
+        it 'normalises the key' do
+          key = :some_symbol
+
+          expect_any_instance_of( TestTransientStore ).to(
+            receive( :get ).with(
+              key: key.to_s # i.e. Symbol has been normalised to String
+            )
+          )
+
+          @store.get( key: key )
+        end
+
+        it 'complains about unsupported key types' do
+          expect {
+            @store.get( key: Hash.new )
+          }.to raise_error( RuntimeError, "Hoodoo::TransientStore\#get: Keys must be of String or Symbol class; you provided 'Hash'" )
+        end
+
+        it 'complains about empty keys' do
+          expect {
+            @store.get( key: '' )
+          }.to raise_error( RuntimeError, 'Hoodoo::TransientStore#get: Empty String or Symbol keys are prohibited' )
+        end
+      end
+    end
+
+    # ========================================================================
+
+    context '#delete' do
+      before :each do
+        @store = Hoodoo::TransientStore.new(
+          storage_engine:   @engine_name,
+          storage_host_uri: 'localhost'
+        )
+
+        @key     = Hoodoo::UUID.generate()
+        @payload = { 'foo' => 'bar' }
+
+        @store.set( key: @key, payload: @payload )
+      end
+
+      it 'deletes known keys' do
+        expect( @store.get( key: @key ) ).to eql( @payload )
+
+        expect_any_instance_of( TestTransientStore ).to(
+          receive( :delete ).with( key: @key ).and_call_original()
+        )
+
+        expect( @store.delete( key: @key ) ).to eql( true )
+        expect( @store.get( key: @key ) ).to be_nil
+      end
+
+      it 'ignores unknown keys' do
+        random_key = Hoodoo::UUID.generate()
+
+        expect_any_instance_of( TestTransientStore ).to(
+          receive( :delete ).with( key: random_key ).and_call_original()
+        )
+
+        expect( @store.delete( key: random_key ) ).to eql( true )
+      end
+
+      it 'consumes and returns exceptions' do
+        expect_any_instance_of( TestTransientStore ).to receive( :delete ) do
+          raise 'Hello world'
+        end
+
+        result = @store.delete( key: @key )
+
+        expect( result ).to be_a( RuntimeError )
+        expect( result.message ).to eql( 'Hello world' )
+      end
+
+      it 'detects faulty engines' do
+        expect_any_instance_of( TestTransientStore ).to receive( :delete ) do
+          'not a boolean'
+        end
+
+        result = @store.delete( key: @key )
+
+        expect( result ).to be_a( RuntimeError )
+        expect( result.message ).to eql( "Hoodoo::TransientStore\#delete: Engine '#{ @engine_name }' returned an invalid response" )
+      end
+
+      context 'key normalisation' do
+        it 'normalises the key' do
+          key = :some_symbol
+
+          expect_any_instance_of( TestTransientStore ).to(
+            receive( :delete ).with(
+              key: key.to_s # i.e. Symbol has been normalised to String
+            )
+          )
+
+          @store.delete( key: key )
+        end
+
+        it 'complains about unsupported key types' do
+          expect {
+            @store.delete( key: Hash.new )
+          }.to raise_error( RuntimeError, "Hoodoo::TransientStore\#delete: Keys must be of String or Symbol class; you provided 'Hash'" )
+        end
+
+        it 'complains about empty keys' do
+          expect {
+            @store.delete( key: '' )
+          }.to raise_error( RuntimeError, 'Hoodoo::TransientStore#delete: Empty String or Symbol keys are prohibited' )
+        end
+      end
+    end
+
+    # ========================================================================
+
+    context '#close' do
+      before :each do
+        @store = Hoodoo::TransientStore.new(
+          storage_engine:   @engine_name,
+          storage_host_uri: 'localhost'
+        )
+      end
+
+      it 'closes' do
+        expect_any_instance_of( TestTransientStore ).to receive( :close )
+        @store.close()
+      end
+
+      it 'consumes and ignores exceptions' do
+        expect_any_instance_of( TestTransientStore ).to receive( :close ) do
+          raise 'Hello world'
+        end
+
+        @store.close()
+      end
+    end
+
+  end
+end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: hoodoo
 version: !ruby/object:Gem::Version
-  version: 1.13.0
+  version: 1.14.0
 platform: ruby
 authors:
 - Loyalty New Zealand
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-01 00:00:00.000000000 Z
+date: 2017-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: kgio
+  name: dalli
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: '2.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: '2.7'
 - !ruby/object:Gem::Dependency
-  name: dalli
+  name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
-  type: :runtime
+        version: '3.2'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -368,6 +368,14 @@ files:
 - lib/hoodoo/services/services/response.rb
 - lib/hoodoo/services/services/service.rb
 - lib/hoodoo/services/services/session.rb
+- lib/hoodoo/transient_store.rb
+- lib/hoodoo/transient_store/mocks/dalli_client.rb
+- lib/hoodoo/transient_store/mocks/redis.rb
+- lib/hoodoo/transient_store/transient_store.rb
+- lib/hoodoo/transient_store/transient_store/base.rb
+- lib/hoodoo/transient_store/transient_store/memcached.rb
+- lib/hoodoo/transient_store/transient_store/memcached_redis_mirror.rb
+- lib/hoodoo/transient_store/transient_store/redis.rb
 - lib/hoodoo/utilities.rb
 - lib/hoodoo/utilities/string_inquirer.rb
 - lib/hoodoo/utilities/utilities.rb
@@ -482,6 +490,13 @@ files:
 - spec/services/services/session_spec.rb
 - spec/shared_examples/middleware_amqp.rb
 - spec/spec_helper.rb
+- spec/transient_store/transient_store/base_spec.rb
+- spec/transient_store/transient_store/memcached_redis_mirror_spec.rb
+- spec/transient_store/transient_store/memcached_spec.rb
+- spec/transient_store/transient_store/mocks/dalli_client_spec.rb
+- spec/transient_store/transient_store/mocks/redis_spec.rb
+- spec/transient_store/transient_store/redis_spec.rb
+- spec/transient_store/transient_store_spec.rb
 - spec/utilities/utilities_spec.rb
 - spec/utilities/uuid_spec.rb
 homepage: https://loyaltynz.github.io/hoodoo/
@@ -618,5 +633,12 @@ test_files:
 - spec/services/services/session_spec.rb
 - spec/shared_examples/middleware_amqp.rb
 - spec/spec_helper.rb
+- spec/transient_store/transient_store/base_spec.rb
+- spec/transient_store/transient_store/memcached_redis_mirror_spec.rb
+- spec/transient_store/transient_store/memcached_spec.rb
+- spec/transient_store/transient_store/mocks/dalli_client_spec.rb
+- spec/transient_store/transient_store/mocks/redis_spec.rb
+- spec/transient_store/transient_store/redis_spec.rb
+- spec/transient_store/transient_store_spec.rb
 - spec/utilities/utilities_spec.rb
 - spec/utilities/uuid_spec.rb