pheromone 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1bc0ae4ecb429df63bc40406f5cce6cff3a00fe1
-  data.tar.gz: a459c5422e13328a2301345fd54dc6269b27faee
+  metadata.gz: 72824e89ef3425da33b45c276319f332728461b7
+  data.tar.gz: 5b5bba2271b1fbc069d06615fec68d66b6279cf2
 SHA512:
-  metadata.gz: 2cc5100938018080e908b82f8168d1f92fea428572148422a036fb7fe2e40fde9d1603993cb761c3624fe9f1f26162209946680bdbe862908c976b8fda30976e
-  data.tar.gz: 00c32581b39cf273e9ffe702fc1ec4cdc20de5217e4c335b9c8a6c2463a12aaee80b4928a0449ad26409431c1d75fe953ce9fb0907aa1421b77573fc18ce646e
+  metadata.gz: bf9d4a27bb39fff06ee9fb98c0b501f3c0815330a73abfaf60d1f267588e523d9d550a5d645dd9d9f20a764f63375aba8a3a196aab1b39dc4be6907216f09061
+  data.tar.gz: 0c39091b06b7533f7c9989d9116f314c1badb813096e1e5ece4d0a675536b0eaba324e2f38584736bab54cc04bf8bd1f8543a8535364433889c71aae65d4af88

data/README.md

@@ -208,6 +208,42 @@ class PublishableModel < ActiveRecord::Base
 end
 ```
 
+### 5. Specifying producer options
+
+[Ruby-Kafka](https://github.com/zendesk/ruby-kafka) allows sending options to change the behaviour of Kafka Producer.
+
+These can be sent in by passing `producer_options` to the `publish` method:
+
+```
+class PublishableModel < ActiveRecord::Base
+  include Pheromone
+  publish [
+    {
+      event_types: [:create],
+      topic: :topic_test,
+      message: ->(obj) { { name: obj.name } },
+      producer_options: {
+        # The number of retries when attempting to deliver messages. The default is
+        # 2, so 3 attempts in total, but you can configure a higher or lower number:
+        max_retries: 5,
+        # The number of seconds to wait between retries. In order to handle longer
+        # periods of Kafka being unavailable, increase this number. The default is
+        # 1 second.
+        retry_backoff: 5,
+        # number of acknowledgements that the client should write to before returning
+        # possible values are :all, 0 or 1 and default behaviour is :all, requiring all
+        # replicas to acknowledge
+        required_acks: 1,
+        # compression can be enabled in order to improve bandwidth, and a minimum number
+        # of messages that need to be in the buffer before they are compressed can be 
+        # specified using compression threshold
+        compression_codec: :snappy,
+        compression_threshold: 10 
+      }
+    }
+  ]
+end
+```
 
 ## Development
 

data/lib/pheromone/version.rb

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

data/lib/pheromone.rb

@@ -9,6 +9,13 @@ require 'waterdrop'
 #  publish message_options: [
 #            {
 #              topic: :topic1,
+#              producer_options: {
+#                max_retries: 5,
+#                retry_backoff: 5,
+#                compression_codec: :snappy,
+#                compression_threshold: 10,
+#                required_acks: 1
+#              }
 #              event_types: [:create, :update],
 #              message: { a: 1, b: 2 }
 #            },....
@@ -61,7 +68,8 @@ module Pheromone
   def send_message(options)
     WaterDrop::Message.new(
       options[:topic],
-      message_meta_data.merge!(blob: message_blob(options)).to_json
+      message_meta_data.merge!(blob: message_blob(options)).to_json,
+      options[:producer_options] || {}
     ).send!
   end
 

metadata

@@ -1,31 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: pheromone
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Ankita Gupta
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-31 00:00:00.000000000 Z
+date: 2017-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: active_model_serializers
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: 0.9.3
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.3
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 4.2.5
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -52,20 +52,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.2.5
-- !ruby/object:Gem::Dependency
-  name: active_model_serializers
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.3
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.3
 - !ruby/object:Gem::Dependency
   name: waterdrop
   requirement: !ruby/object:Gem::Requirement
@@ -136,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: with_model
   requirement: !ruby/object:Gem::Requirement