pheromone 0.4.4 → 0.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a76799fc95a8238c6a7fddcc083aae52611f46a1
-  data.tar.gz: 61f88eb5864f2afb37daa82cda0b3212a787cff8
+  metadata.gz: b4cb86ee9ef9fea14e1e9993705fd6684472dfd8
+  data.tar.gz: 421982c3b033d1778bcf8e9f4ee7ceec4c039e18
 SHA512:
-  metadata.gz: ce43f010d7559642d2707433d0e271c3eabea9c3f5aa960f5a247a9f621b9be890b6ab972150a2b305b9afaaaed9a8e36c6f0153620ff79e8d42e96ec7481e86
-  data.tar.gz: aeefa586c94343abfc1957f1033ba619d4fb2f85ac3998a9850f50a6c6dc4940ea76fe1b7adf592a6f1f956368d3df047fe8528a46dfec26d0f516701a0710a1
+  metadata.gz: 192c520604afdabf44a96ab535ce14f3c2a7408d9684670a2986a9d7dfbac8f1e6cfe937a45b8a14c6502a5597a907117b58892f499f44e5855b9a6418fb3f84
+  data.tar.gz: e3c87d8c40b5475097c05eeba2fe19348d16a83a50e17aef41c2e27d3be309eee090b517b2c9e938a44f965ab630c8a61e8f8b628942f76ad5c6f22a722fa931

data/README.md

@@ -58,6 +58,7 @@ The timezone setting will transform any timestamp attributes in the message to t
 
 ## Usage
 
+
 ### 1. Sending messages to kafka asynchronously
 
 The underlying Kafka client used by `pheromone` is `ruby-kafka`. This client provides a normal producer that sends messages to Kafka synchronously, and an `async_producer` to send messages to Kafka asynchronously.
@@ -297,7 +298,20 @@ end
 
 ### 7. Specifying message metadata
 
-These can be sent in by specifying `metadata` to the `publish` method:
+Pheromone makes it easier to standardise the format of messages sent to Kafka while affording the flexibility to add other custom fields using the metadata option.
+
+By default, the messages sent to Kafka have an event_type and timestamp attached to it as shown below: 
+```
+  {
+    'event_type' => 'create',
+    'timestamp' => '2015-07-14T10:10:00.000+08:00',
+    'blob' => {
+      'message_text' => 'test'
+    }
+  }.to_json
+```
+
+By specifying `metadata` to the `publish` method:
 
 ```
 class PublishableModel < ActiveRecord::Base
@@ -318,6 +332,20 @@ class PublishableModel < ActiveRecord::Base
 end
 ```
 
+The Kafka message will have the original metadata in addition to the new fields:
+ 
+
+```
+  {
+    'event_type' => 'create',
+    'timestamp' => '2015-07-14T10:10:00.000+08:00',
+    'source' => 'application1',
+    'blob' => {
+      'message_text' => 'test'
+    }
+  }.to_json
+```
+
 ### 8. Sending messages to Kafka directly
 
 `pheromone` provides a custom message object that sends messages to Kafka in a predefined format, to maintain consistency in the message fields.

data/lib/pheromone/publishable.rb

@@ -94,9 +94,10 @@ module Pheromone
 
       def message_meta_data(options, current_event)
         metadata = options[:metadata]
-        return { event: current_event, entity: self.class.name } if metadata.blank?
-        return metadata if metadata.is_a?(Hash)
-        call_proc_or_instance_method(metadata)
+        default_metadata = { event: current_event, entity: self.class.name }
+        return default_metadata if metadata.blank?
+        provided_metadata = metadata.is_a?(Hash) ? metadata : call_proc_or_instance_method(metadata)
+        default_metadata.merge!(provided_metadata)
       end
 
       def message_blob(options)
@@ -111,4 +112,4 @@ module Pheromone
       base.send :extend, ClassMethods
     end
   end
-end
+end

data/lib/pheromone/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Pheromone
-  VERSION = '0.4.4'.freeze
+  VERSION = '0.4.5'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pheromone
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.4.5
 platform: ruby
 authors:
 - Ankita Gupta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-10 00:00:00.000000000 Z
+date: 2018-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_model_serializers