hoodoo 1.9.2 → 1.10.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ODE5N2QwMWIyMWIxNDgxYTliZmUyODdjZThkZmFlOTFiYzEzYWEyMg==
+    YjU2MjRlMTgwYjU3ZDdhOTBhZjk4M2E5NGEwZjk5Mjg4MDM0YjMyMw==
   data.tar.gz: !binary |-
-    OGVmODcxY2UxYzNiNTE0NmFlODhhYjhlZjFlZjhiZDA4OGY0MjNkYg==
+    YWFhZjNkZGJkNDMyZDI1NmE4NDk0NGQyMzAxNGFkMDZlMWU0NzRkMw==
 SHA512:
   metadata.gz: !binary |-
-    NmZiODc1NjM5MDYxMzI4NWRmYjEyOTNmNGQyN2YxNmU5MGNlMmQ4NjEzMzZl
-    Y2YzZjAzMjBjZWMxZDgwNTkzN2M1M2M5Y2Y3OWZlYTJhMGM3NTkwY2NmNzgx
-    OGJmODhhOTQxZmJmNGFiMzUyOTI3NGExYmJiYTNhOTM2NGY3YTE=
+    ZDBiYjhmNDc5OTQ2ODAyNjI5NzU3YzY0YjE4MmQzYTRiMjRkY2NmYjdkZDJl
+    N2UxYThkMDhiMzBjMmQ4YWQ1YjcyMDhlMjM2ZDVjNjhiNGJhMTg4ZjgzZTg1
+    MDA0NWQ1OWZmMWM0MzhlNDkzZmNjODM4ZTdkOTUxMTQzYmFmNGY=
   data.tar.gz: !binary |-
-    ODA0YmQ2ZmZjOTgwMGFkZGNhZWVkZTA3MzI5ZjVmZTE2ZTE2ZTVlYWQ1NDJi
-    MGU0MWJhZmU4MmVkMWFmMzMwOWFhNTQwNDRlMjEwYjQ0YTIzOTBhNjgwODIz
-    YWNiODZkN2FhMjc1MjRjYmM1MmNmMDhhMGNjNGVjMTI0NDFkYzg=
+    Y2UyY2ZhMDM1YTRlOTg5ODlmNzYwZDMyNGQyMTRiNjY1NmY3ZDdhYjAwN2Y1
+    NmQxNDQ0NmQ1ZDUxZDA4YzgzZGI1YjdkODY4YTViZjc4MWMwNzVlZmNhM2E4
+    MmY3MDlmZTFhZTBhZTAxYWVkODQ4NWFmYTJkOGQwOWMzNDIzMTE=

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

@@ -27,8 +27,8 @@ module Hoodoo; module Services
       #                 AMQP-based queue.
       #
       # +routing_key+:: The routing key (as a String) to use. Optional. If
-      #                 omitted, reads +ENV[ 'AMQ_LOGGING_ENDPOINT' ]+ or if
-      #                 that is unset, defaults to +platform.logging+.
+      #                 omitted, reads <tt>ENV['AMQ_LOGGING_ENDPOINT']</tt> or
+      #                 if that is unset, defaults to +platform.logging+.
       #
       # If you're running with Rack on top of Alchemy, then the +call+ method's
       # +env+ parameter containing the Rack environment _MUST_ have a key of
@@ -37,9 +37,21 @@ module Hoodoo; module Services
       # parameter. The logger will then use this active Alchemy service to send
       # messages to its configured routing key.
       #
+      # If <tt>ENV['AMQ_ANALYTICS_LOGGING_ENDPOINT']</tt> is defined then its
+      # value is used for a routing key in the case, very specifically, of a
+      # message logged with a +code+ of +analytics+. If the variable is not set,
+      # the same routing key is used for all messages regardless of code; else
+      # that particular code can be streamed off to another Rabbit queue via the
+      # given alternative routing key.
+      #
       def initialize( alchemy, routing_key = nil )
-        @alchemy     = alchemy
-        @routing_key = routing_key || ENV[ 'AMQ_LOGGING_ENDPOINT' ] || 'platform.logging'
+        routing_key           = routing_key || ENV[ 'AMQ_LOGGING_ENDPOINT' ] || 'platform.logging'
+        analytics_routing_key = ENV[ 'AMQ_ANALYTICS_LOGGING_ENDPOINT' ]
+
+        @alchemy      = alchemy
+        @routing_keys = Hash.new( routing_key ) # Use "routing_key" as a default value
+
+        @routing_keys[ :analytics ] = analytics_routing_key || routing_key
       end
 
       # Custom implementation of the Hoodoo::Logger::WriterMixin#report
@@ -83,7 +95,10 @@ module Hoodoo; module Services
           :identity             => ( session[ 'identity' ] || {} ).to_h
         }.to_json()
 
-        @alchemy.send_message_to_service( @routing_key, { "body" => message } )
+        @alchemy.send_message_to_service(
+          @routing_keys[ code.to_sym ],
+          { "body" => message }
+        )
       end
     end
 

data/lib/hoodoo/version.rb

@@ -12,6 +12,6 @@ module Hoodoo
   # The Hoodoo gem version. If this changes, ensure that the date in
   # "hoodoo.gemspec" is correct and run "bundle install" (or "update").
   #
-  VERSION = '1.9.2'
+  VERSION = '1.10.0'
 
 end

data/spec/services/middleware/amqp_log_writer_spec.rb

@@ -53,16 +53,16 @@ describe Hoodoo::Services::Middleware::AMQPLogWriter do
 
     @session.caller_identity_name = @identity_id_4
 
-    @alchemy = OpenStruct.new
-    @queue   = 'foo.bar'
-    @logger  = described_class.new( @alchemy, @queue )
+    @alchemy             = OpenStruct.new
+    @default_routing_key = 'foo.bar'
+    @custom_routing_key  = 'baz.foo'
+    @logger              = described_class.new( @alchemy, @default_routing_key )
   end
 
-  it 'sends expected data' do
+  def test_with_code( code, expected_routing_key )
     Timecop.freeze do
       level          = 'warn'
       component      = 'test_component'
-      code           = 'test_code'
       reported_at    = Time.now.iso8601( 12 )
       id             = Hoodoo::UUID.generate
       interaction_id = Hoodoo::UUID.generate
@@ -92,9 +92,51 @@ describe Hoodoo::Services::Middleware::AMQPLogWriter do
         :identity             => Hoodoo::Utilities.stringify( @session.identity.to_h )
       }
 
-      expect( @alchemy ).to receive( :send_message_to_service ).with( @queue, { "body" => expected_hash.to_json } ).once
+      expect( @alchemy ).to receive( :send_message_to_service ).with(
+        expected_routing_key,
+        { "body" => expected_hash.to_json }
+      ).once
 
       @logger.report( level, component, code, data )
     end
   end
+
+  it 'sends expected data' do
+    test_with_code( 'test_code', @default_routing_key )
+  end
+
+  context 'sends analytics data' do
+    context 'to default queue' do
+      it 'with no routing override (by String)' do
+        test_with_code( 'analytics', @default_routing_key )
+      end
+
+      it 'with no routing override (by Symbol)' do
+        test_with_code( :analytics, @default_routing_key )
+      end
+    end
+
+    context 'to custom queue' do
+      before :each do
+        ENV[ 'AMQ_ANALYTICS_LOGGING_ENDPOINT' ] = @custom_routing_key
+
+        # Recreate the logger instance from the outermost 'before each'
+        # block in order to re-run the initialiser and re-check ENV.
+        #
+        @logger = described_class.new( @alchemy, @default_routing_key )
+      end
+
+      after :each do
+        ENV.delete( 'AMQ_ANALYTICS_LOGGING_ENDPOINT' )
+      end
+
+      it 'with routing override (by String)' do
+        test_with_code( 'analytics', @custom_routing_key )
+      end
+
+      it 'with routing override (by Symbol)' do
+        test_with_code( :analytics, @custom_routing_key )
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hoodoo
 version: !ruby/object:Gem::Version
-  version: 1.9.2
+  version: 1.10.0
 platform: ruby
 authors:
 - Loyalty New Zealand
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-29 00:00:00.000000000 Z
+date: 2016-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kgio