pheromone 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 211d951dfbe1c536f52a67b62951a53c5b0a4a16
-  data.tar.gz: 816acb6f156832ce4a58bb5b2d74b27984a62aa7
+  metadata.gz: 63271f5d1308a9f022f2fa76e31ddf0f51e2bbaa
+  data.tar.gz: 8637f120bba37d51e1ce5ab52279f92b3f776a13
 SHA512:
-  metadata.gz: 9f02b3dd53c379043284c215d7d839dacffd45630512cdddb51bd2b7383b47703b6eee40544dfd9549bd54ea649dd7977ef931e1880beab3341cd36ac0ab2995
-  data.tar.gz: f70218da3b02dfacb19d6a3f65b6f96bad9eafd443fba65a0a65fdc2dd5d34f1a3e6176621c9d2d3e41eb75f39b91df223d74f79684f509849bac968abf04300
+  metadata.gz: 22adbaa1bf556272bf5ec71a10429a2f6e496ea051a2e64e659aa687f1c44706bd42668f4eaf965597e153ef79dfd07dc0c811383d0c46dadd9b30aaeafbed90
+  data.tar.gz: 089891f1c6bf466e5f6aa1c1f21697f0fe6fd2276886f8217656762fda2d50d6bc676fe6c232ce67323b2b992e1a3a1d131842217147cd1bdb46e4219376e817

data/README.md

@@ -52,6 +52,7 @@ Edit this file to modify the default config. The following configuration options
 | background_processor.klass    | String        | Background processor class name that sends messages to kafka |
 | timezone_format               | String        | Valid timezone name for timestamps sent to kafka |
 | message_format                | Symbol        | Only supports :json format currently |
+| enabled                       | Boolean       | Defaults to true. When this is set to false, no messages will be sent to Kafka |
 
 The timezone setting will transform any timestamp attributes in the message to the specified format.
 
@@ -91,6 +92,7 @@ Create a new class and add the name under `Pheromone.config.background_processor
    def self.perform(message_object)
      Pheromone::Messaging::Message.new(
        topic: message_object['topic'],
+       metadata: { source: 'application1' },
        blob: message_object['blob'],
        metadata: message_object['metadata'],
        options: message_object['options']
@@ -126,6 +128,7 @@ class PublishableModel < ActiveRecord::Base
     {
       event_types: [:create],
       topic: :topic1,
+      metadata: { source: 'application1' },
       message: ->(obj) { { name: obj.name } }
     }
   ]
@@ -141,6 +144,7 @@ class PublishableModel < ActiveRecord::Base
     {
       event_types: [:update],
       topic: :topic1,
+      metadata: { source: 'application1' },
       message: ->(obj) { { name: obj.name } }
     }
   ]
@@ -160,6 +164,7 @@ class PublishableModel < ActiveRecord::Base
     {
       event_types: [:create],
       topic: :topic1,
+      metadata: { source: 'application1' },
       message: ->(obj) { { name: obj.name } }
     }
   ]
@@ -175,6 +180,7 @@ class PublishableModel < ActiveRecord::Base
     {
       event_types: [:update],
       topic: :topic1,
+      metadata: { source: 'application1' },
       message: message
     }
   ]
@@ -194,6 +200,7 @@ class PublishableModel < ActiveRecord::Base
     {
       event_types: [:create],
       topic: :topic1,
+      metadata: { source: 'application1' },
       serializer: Class.new(BaseSerializer) { attributes :name, :type }
     }
   ]
@@ -288,7 +295,30 @@ class PublishableModel < ActiveRecord::Base
 end
 ```
 
-### 7. Sending messages to Kafka directly
+### 7. Specifying message metadata
+
+These can be sent in by specifying `metadata` to the `publish` method:
+
+```
+class PublishableModel < ActiveRecord::Base
+  include Pheromone::Publishable
+  publish [
+    {
+      event_types: [:create],
+      topic: :topic_test,
+      message: ->(obj) { { name: obj.name } },
+      metadata: { source: 'application1' },
+      producer_options: {
+        key: 'key',
+        partition: 1,
+        partition_key: 'key'
+      }
+    }
+  ]
+end
+```
+
+### 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.
 
@@ -325,6 +355,38 @@ end
 
 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`.
 
+## Testing
+
+#### RSpec
+
+`pheromone` makes it easy to control when it is enabled during testing with `pheromone/frameworks/rspec`
+ 
+ ```
+ # spec/rails_helper.rb
+ require 'rspec/rails'
+ # ...
+ require 'pheromone/frameworks/rspec'
+ 
+ ```
+ 
+ With this helper, `publishable` is disabled by default. To turn it on, pass `publishable: true` to the spec block like this:
+ 
+ ```
+ describe 'PublishableModel' do
+   before do
+     @invocation_count = 0
+     allow(WaterDrop::SyncProducer).to receive(:call) do
+     @invocation_count += 1
+   end
+    
+   it 'sends messages to kafka', publishable: true do
+     PublishableModel.create
+     expect(@invocation_count).to eq(1)
+   end
+ end
+ ```
+ 
+ 
 ## 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/config.rb

@@ -6,6 +6,7 @@ module Pheromone
     extend Dry::Configurable
     # accepts message format. Currently only accepts :json as the permitted value
     setting :message_format, :json
+    setting :enabled, true
     setting :background_processor do
       # accepts :sidekiq or :resque as a value
       setting :name

data/lib/pheromone/frameworks/rspec.rb

@@ -0,0 +1,11 @@
+require 'rspec/core'
+
+RSpec.configure do |config|
+  config.before(:each) do
+    Pheromone.config.enabled = false
+  end
+
+  config.before(:each, publishable: true) do
+    Pheromone.config.enabled = true
+  end
+end

data/lib/pheromone/messaging/message_dispatcher.rb

@@ -15,6 +15,7 @@ module Pheromone
       end
 
       def dispatch
+        return unless enabled?
         if @dispatch_method == :sync
           message.send!
         elsif @dispatch_method == :async
@@ -39,6 +40,10 @@ module Pheromone
         Message.new(message_body)
       end
 
+      def enabled?
+        Pheromone.config.enabled
+      end
+
       def message_body
         {
           topic: @message_parameters[:topic],

data/lib/pheromone/publishable.rb

@@ -11,6 +11,7 @@
 #                compression_threshold: 10,
 #                required_acks: 1
 #              }
+#              metadata: { source: 'application1' }
 #              event_types: [:create, :update],
 #              message: { a: 1, b: 2 }
 #              dispatch_method: :async
@@ -30,6 +31,8 @@ require 'pheromone/validators/options_validator'
 require 'pheromone/exceptions/invalid_publish_options'
 require 'pheromone/method_invoker'
 require 'pheromone/messaging/message_dispatcher'
+require 'pry'
+
 module Pheromone
   module Publishable
     # class methods for the model including Publishable
@@ -56,6 +59,7 @@ module Pheromone
       include Pheromone::MethodInvoker
 
       def dispatch_messages(message_options:, current_event:)
+        return unless enabled?
         message_options.each do |options|
           next unless check_conditions(options, current_event)
           send_message(options, current_event)
@@ -64,6 +68,10 @@ module Pheromone
 
       private
 
+      def enabled?
+        Pheromone.config.enabled
+      end
+
       def check_conditions(options, current_event)
         condition_callback = options[:if]
         result = check_event(options, current_event)

data/lib/pheromone/version.rb

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

data/lib/pheromone.rb

@@ -1,6 +1,7 @@
 require 'pheromone/publishable'
 require 'pheromone/config'
 require 'pheromone/messaging/message'
+require 'pheromone/frameworks/rspec'
 require 'rails/railtie'
 require 'waterdrop'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pheromone
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Ankita Gupta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-25 00:00:00.000000000 Z
+date: 2018-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_model_serializers
@@ -216,6 +216,7 @@ files:
 - lib/pheromone/config.rb
 - lib/pheromone/exceptions/invalid_publish_options.rb
 - lib/pheromone/exceptions/unsupported_message_format.rb
+- lib/pheromone/frameworks/rspec.rb
 - lib/pheromone/messaging/message.rb
 - lib/pheromone/messaging/message_dispatcher.rb
 - lib/pheromone/messaging/message_formatter.rb