pheromone 0.4.5 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b4cb86ee9ef9fea14e1e9993705fd6684472dfd8
-  data.tar.gz: 421982c3b033d1778bcf8e9f4ee7ceec4c039e18
+  metadata.gz: 3e21ddb46a7940af3aa6428f01c768b484c8cd08
+  data.tar.gz: e25484b58e3f22a92d4829c17c850d45e6207273
 SHA512:
-  metadata.gz: 192c520604afdabf44a96ab535ce14f3c2a7408d9684670a2986a9d7dfbac8f1e6cfe937a45b8a14c6502a5597a907117b58892f499f44e5855b9a6418fb3f84
-  data.tar.gz: e3c87d8c40b5475097c05eeba2fe19348d16a83a50e17aef41c2e27d3be309eee090b517b2c9e938a44f965ab630c8a61e8f8b628942f76ad5c6f22a722fa931
+  metadata.gz: d222ca050b37759c2a85d3d5aff1d3e3a95a29fdf741dc916762cde97ed95ce67632fe443c1eafaf74e5771fc6dbdab7e2d9def782f8129f108d4da142fade11
+  data.tar.gz: 6b18b8348d1a54b2e5a9b3b4c9e87ccb85aebba4908c7a03b5378c305bc18e9dbc91ab07113348ed3da0a56274ff97eb57cefefa98166d8b268aad4a838c110d

data/README.md

@@ -383,6 +383,74 @@ The Kafka message will have the original metadata in addition to the new fields:
 
 As seen above `timestamp` will be added automatically to the main attributes along with the message metadata. The actual message will be encapsulated inside a key called `blob`.
 
+### 9. Encoding messages
+
+`pheromone` allows encoding messages using custom encoders. Encoders can be specified by simply specifying a proc to encode the message in any given format.
+
+`publish` takes the `encoder` and `message_format` as options for encoding to be specified. Encoder is called with the entire message object and performs encoding on this message.
+
+```        
+  publish(
+    [ 
+      {
+        topic: :test_topic,
+        event_types: [:update, :create],
+        serializer: TestSerializer,
+        message_format: :with_encoding,
+        encoder: ->(message) { avro.encode(message, schema_name: 'test') },
+        if: ->(object) { object.should_publish_status_update? }
+      }
+    ]
+  )
+```
+
+## Message Contents
+
+In versions before `< 0.5`, the metadata keys were present at the top-most level, and the message itself was embedded inside the key `blob`.
+
+The message published to Kafka looks like this:
+ ```
+ {
+   event: 'create',
+   entity: 'KlassName',
+   timestamp: '2015-07-14T02:10:00.000Z',
+   blob: {
+     message_contents: 'message_contents'
+   }
+ }
+ ```
+ From `0.5` version onwards, the message format looks like this: 
+ ```
+ {
+   metadata: {
+     event: 'create',
+     entity: 'KlassName',
+     timestamp: '2015-07-14T02:10:00.000Z'
+   }
+   blob: {
+     message_contents: 'message_contents'
+   }
+ }
+ ```
+ `event`, `entity`, and `timestamp` are determined and added by `pheromone`. `timestamp` will be in UTC by default and will use `timezone_format` value specified in `config/initializers/pheromone.rb`. Contents of `metadata` can be modified by using these [guidelines](https://github.com/ankitagupta12/pheromone#7-specifying-message-metadata). Message contents are placed under the key `blob`.
+
+  In order to use the format with `blob` embedded inside `metadata`, specify option `embed_blob` as `true` inside `publish` options like this:
+  
+  ```        
+  publish(
+    [ 
+      {
+        topic: :test_topic,
+        event_types: [:update, :create],
+        serializer: TestSerializer,
+        message_format: :with_encoding,
+        embed_blob: true
+        encoder: ->(message) { avro.encode(message, schema_name: 'test') },
+        if: ->(object) { object.should_publish_status_update? }
+      }
+    ]
+  )
+  ```
 ## Testing
 
 #### RSpec

data/lib/pheromone/messaging/message.rb

@@ -2,29 +2,37 @@
 module Pheromone
   module Messaging
     class Message
-      def initialize(topic:, blob:, metadata: {}, options: {})
+      def initialize(topic:, blob:, metadata: {}, options: {}, encoder:, message_format:, embed_blob:)
         @topic = topic
         @blob = blob
         @options = options || {}
         @metadata = metadata || {}
+        @encoder = encoder
+        @message_format = message_format
+        @embed_blob = embed_blob
       end
 
       attr_reader :topic, :blob, :options, :metadata
 
       def send!
         WaterDrop::SyncProducer.call(
-          MessageFormatter.new(full_message).format,
+          MessageFormatter.new(
+            message,
+            @encoder,
+            @message_format
+          ).format,
           { topic: topic.to_s }.merge!(options)
         )
       end
 
       private
 
-      def full_message
-        @metadata.merge!(
-          timestamp: Time.now,
-          blob: @blob
-        )
+      def message
+        if @embed_blob
+          @metadata.merge!(blob: @blob)
+        else
+          { metadata: @metadata, blob: @blob }
+        end
       end
     end
   end

data/lib/pheromone/messaging/message_dispatcher.rb

@@ -17,7 +17,12 @@ module Pheromone
       def dispatch
         return unless Pheromone.enabled?
         if @dispatch_method == :sync
-          message.send!
+          Message.new(
+            message_body.merge!(
+              encoder: @message_parameters[:encoder],
+              message_format: @message_parameters[:message_format]
+            )
+          ).send!
         elsif @dispatch_method == :async
           send_message_asynchronously
         end
@@ -36,16 +41,13 @@ module Pheromone
         end
       end
 
-      def message
-        Message.new(message_body)
-      end
-
       def message_body
         {
           topic: @message_parameters[:topic],
           blob: @message_parameters[:blob],
           metadata: @message_parameters[:metadata],
-          options: @message_parameters[:producer_options] || {}
+          options: @message_parameters[:producer_options] || {},
+          embed_blob: @message_parameters[:embed_blob]
         }
       end
 

data/lib/pheromone/messaging/message_formatter.rb

@@ -2,15 +2,23 @@ require 'pheromone/exceptions/unsupported_message_format'
 module Pheromone
   module Messaging
     class MessageFormatter
-      SUPPORTED_MESSAGE_FORMATS = [:json].freeze
+      include Pheromone::MethodInvoker
+      SUPPORTED_MESSAGE_FORMATS = [:json, :with_encoding].freeze
 
-      def initialize(message)
+      def initialize(message, encoder, format)
         @message = message
+        @encoder = encoder
+        @message_format = format
       end
 
       def format
-        if Pheromone.config.message_format == :json
-          convert_to_time_format.to_json
+        if message_format == :json
+          message_with_time_conversion.to_json
+        elsif message_format == :with_encoding
+          call_proc_or_instance_method(
+            @encoder,
+            message_with_time_conversion.with_indifferent_access
+          )
         elsif !SUPPORTED_MESSAGE_FORMATS.include?(Pheromone.config.message_format)
           raise Pheromone::Exceptions::UnsupportedMessageFormat.new
         end
@@ -18,8 +26,12 @@ module Pheromone
 
       private
 
+      def message_format
+        @message_format || Pheromone.config.message_format
+      end
+
       # recursively converts time to the timezone set in configuration
-      def convert_to_time_format
+      def message_with_time_conversion
         deep_transform_values!(@message) do |value|
           if value.is_a? Time
             value.in_time_zone(Pheromone.config.timezone)

data/lib/pheromone/method_invoker.rb

@@ -6,8 +6,8 @@ module Pheromone
       # which is difficult to avoid since it handles
       # either a lambda/Proc or a named method from the including
       # class.
-      def call_proc_or_instance_method(proc_or_symbol)
-        return proc_or_symbol.call(self) if proc_or_symbol.respond_to?(:call)
+      def call_proc_or_instance_method(proc_or_symbol, argument = nil)
+        return proc_or_symbol.call(argument || self) if proc_or_symbol.respond_to?(:call)
         unless respond_to? proc_or_symbol
           raise "Method #{proc_or_symbol} not found for #{self.class.name}"
         end

data/lib/pheromone/publishable.rb

@@ -86,7 +86,10 @@ module Pheromone
             topic: options[:topic],
             blob: message_blob(options),
             metadata: message_meta_data(options, current_event),
-            producer_options: options[:producer_options]
+            encoder: options[:encoder],
+            message_format: options[:message_format],
+            producer_options: options[:producer_options],
+            embed_blob: options[:embed_blob]
           },
           dispatch_method: options[:dispatch_method] || :sync
         ).dispatch
@@ -94,7 +97,7 @@ module Pheromone
 
       def message_meta_data(options, current_event)
         metadata = options[:metadata]
-        default_metadata = { event: current_event, entity: self.class.name }
+        default_metadata = { event: current_event.to_s, entity: self.class.name, timestamp: Time.now }
         return default_metadata if metadata.blank?
         provided_metadata = metadata.is_a?(Hash) ? metadata : call_proc_or_instance_method(metadata)
         default_metadata.merge!(provided_metadata)

data/lib/pheromone/version.rb

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

data/pheromone.gemspec

@@ -33,5 +33,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'sidekiq'
   spec.add_development_dependency 'sqlite3'
   spec.add_development_dependency 'timecop', '~> 0.8'
-  spec.add_development_dependency 'with_model', '~> 1.2'
+  spec.add_development_dependency 'with_model', '~> 1.2.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pheromone
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.5.0
 platform: ruby
 authors:
 - Ankita Gupta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-28 00:00:00.000000000 Z
+date: 2018-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_model_serializers
@@ -184,14 +184,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 1.2.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 1.2.1
 description: Sends messages to kafka using different formats and strategies
 email:
 - ankitagupta12391@gmail.com