pheromone 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 31f6f9fc473d250ba8ffab5f5dd400254764f233
-  data.tar.gz: c4db76b5a3d4cfe23d30b5bf4cf671b6a9b8c2bb
+  metadata.gz: f73a9670e5afd4662b7b3c951ce47d44e6f4ef0d
+  data.tar.gz: 338faa66fa2406bd8def99618f3438d7ddff0da3
 SHA512:
-  metadata.gz: d5468bd746e962d23e521fd9168c24b027c5761a9369db17c8bfc4613259456627da0f8f3124b7b09530fa06e7d476f7c6c54e6e5766233b46a8ff1c2fda9329
-  data.tar.gz: 08fe9e171660191247a363133b6b89df30f917ecca3c54c7352f08fa68ea663054493d7fc9739188072f0b54388d8aae11e78a45e149077bbbfcbf7a64458c94
+  metadata.gz: 0f7a867cd34de612895f1252983c9739cafb7ec07e52a0de7d62f3201c8b3210c6e34cd53195466a92207866ac86e512b14bdcafa84fe8eb5107b34f397206ad
+  data.tar.gz: e45e68c57a2853742e8013fc188a88034fe829c1355a4306509086614950cfc762d44f46f0a963c91c35f36a00c22ee1c55d528d2dfab986ae8d49a1aca5924a

data/README.md

@@ -299,6 +299,43 @@ class PublishableModel < ActiveRecord::Base
 end
 ```
 
+### 7. 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.
+
+`Pheromone::Messaging::Message` can be initialized with the following arguments:
+ - `topic`: name of the topic to which the message is produced 
+ - `message`: the actual message itself
+ - `metadata`: any additional fields that must be sent along with the message
+ - `options`: producer options as described in Section 6
+ 
+ Of these fields, only `topic` and `message` are compulsory and the remaining two are optional.
+ 
+ Example usage:
+ 
+ ```
+   Pheromone::Messaging::Message.new(
+     topic: 'test_topic',
+     message: { message_text: 'test' },
+     metadata: { event_type: 'create' },
+     producer_options: { max_retries: 5 }
+   )
+ ```
+ 
+ This will send a message to `test_topic` in Kafka in the following format: 
+ 
+ ```
+  {
+    'event_type' => 'create',
+    'timestamp' => '2015-07-14T10:10:00.000+08:00',
+    'blob' => {
+      'message_text' => 'test'
+    }
+  }.to_json
+ ```
+
+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`.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/pheromone/messaging/message.rb

@@ -4,16 +4,30 @@ require 'waterdrop'
 module Pheromone
   module Messaging
     class Message
-      def initialize(topic:, message:, options: {})
+      def initialize(topic:, message:, metadata: {}, options: {})
         @topic = topic
-        @message = MessageFormatter.new(message).format
-        @options = options
+        @message = message
+        @options = options || {}
+        @metadata = metadata || {}
       end
 
-      attr_reader :topic, :message, :options
+      attr_reader :topic, :message, :options, :metadata
 
       def send!
-        ::WaterDrop::Message.new(topic, message, options).send!
+        ::WaterDrop::Message.new(
+          topic,
+          MessageFormatter.new(full_message).format,
+          options
+        ).send!
+      end
+
+      private
+
+      def full_message
+        @metadata.merge!(
+          timestamp: Time.now,
+          blob: @message
+        )
       end
     end
   end

data/lib/pheromone/messaging/message_dispatcher.rb

@@ -38,6 +38,7 @@ module Pheromone
         Message.new(
           topic: @message_parameters[:topic],
           message: @message_parameters[:message],
+          metadata: @message_parameters[:metadata],
           options: @message_parameters[:producer_options] || {}
         )
       end

data/lib/pheromone/publishable.rb

@@ -66,11 +66,14 @@ module Pheromone
         options[:event_types].any? { |event| event == current_event }
       end
 
+      # Manages the actual formatting and sending of messages. By default messages are sent in
+      # sync mode. To override this, provide dispatch_method as :async
       def send_message(options)
         Pheromone::Messaging::MessageDispatcher.new(
           message_parameters: {
             topic: options[:topic],
-            message: message_meta_data.merge!(blob: message_blob(options)),
+            message: message_blob(options),
+            metadata: message_meta_data,
             producer_options: options[:producer_options]
           },
           dispatch_method: options[:dispatch_method] || :sync
@@ -80,8 +83,7 @@ module Pheromone
       def message_meta_data
         {
           event: current_event,
-          entity: self.class.name,
-          timestamp: Time.now
+          entity: self.class.name
         }
       end
 

data/lib/pheromone/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pheromone
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - Ankita Gupta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-28 00:00:00.000000000 Z
+date: 2017-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_model_serializers