pheromone 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c735c271b3d680d047c20a0c3d8c5b812400a96
-  data.tar.gz: 8c1ea2816a7ed80d3d8b20defb89396ab5be8b1e
+  metadata.gz: 1bc0ae4ecb429df63bc40406f5cce6cff3a00fe1
+  data.tar.gz: a459c5422e13328a2301345fd54dc6269b27faee
 SHA512:
-  metadata.gz: 8e1bdd606fdb35a7870a68a18bdb494196c6d1ac0047d9c1e93ede7e15e1a93033a960ad27bbc1274282dad08f63dd7abdc1684017f488d7cff200f5dbea8400
-  data.tar.gz: f7e6085d96d6f55d19cbbd93958e8c6f4ea0cb23cedc3618b1f55550c3ee4397644eb7bc8bc2e8a383b1d588de7c938ecfdd1c1ec7cfd012bc9ef7b4932b4e40
+  metadata.gz: 2cc5100938018080e908b82f8168d1f92fea428572148422a036fb7fe2e40fde9d1603993cb761c3624fe9f1f26162209946680bdbe862908c976b8fda30976e
+  data.tar.gz: 00c32581b39cf273e9ffe702fc1ec4cdc20de5217e4c335b9c8a6c2463a12aaee80b4928a0449ad26409431c1d75fe953ce9fb0907aa1421b77573fc18ce646e

data/README.md

@@ -2,7 +2,7 @@
 
 Pheromones are chemical substances secreted from glands and used as a means of communication.
 
-`pheromone` is a mixin to easily send `ActiveRecord` updates to Kafka whenever there is a model update and/or create. 
+`pheromone` allows setting up producers that publish `ActiveRecord` updates to Kafka whenever there is a model update and/or create.
 
 ## Installation
 
@@ -57,7 +57,7 @@ WaterDrop.setup do |config|
   config.raise_on_failure = Rails.env.production?
 end
 ```
- 
+
 ## Usage
 
 ### 1. Supported events
@@ -66,7 +66,7 @@ end
 ```
 class PublishableModel < ActiveRecord::Base
   include Pheromone
-  publish message_options: [
+  publish [
     {
       event_types: [:create],
       topic: :topic1,
@@ -81,7 +81,7 @@ end
 ```
 class PublishableModel < ActiveRecord::Base
   include Pheromone
-  publish message_options: [
+  publish [
     {
       event_types: [:update],
       topic: :topic1,
@@ -89,18 +89,18 @@ class PublishableModel < ActiveRecord::Base
     }
   ]
 end
-``` 
+```
 
 Messages can be published for multiple event types by defining `events_types: [:create, :update]`.
 
 ### 2. Supported message formats
 
-#### 2.a. Using a proc in `message` 
+#### 2.a. Using a proc in `message`
 
 ```
 class PublishableModel < ActiveRecord::Base
   include Pheromone
-  publish message_options: [
+  publish [
     {
       event_types: [:create],
       topic: :topic1,
@@ -110,25 +110,41 @@ class PublishableModel < ActiveRecord::Base
 end
 ```
 
-#### 2.a. Using a defined function in `message`
+#### 2.b. Using a defined function in `message`
 
 ```
 class PublishableModel < ActiveRecord::Base
   include Pheromone
-  publish message_options: [
+  publish [
     {
       event_types: [:update],
       topic: :topic1,
-      message: message 
+      message: message
     }
   ]
-  
+
   def message
     { name: self.name }
   end
 end
 ```
 
+#### 2.c. Using a serializer in `message`
+
+```
+class PublishableModel < ActiveRecord::Base
+  include Pheromone
+  publish [
+    {
+      event_types: [:create],
+      topic: :topic1,
+      serializer: Class.new(BaseSerializer) { attributes :name, :type }
+    }
+  ]
+end
+```
+
+
 ### 3. Sending messages conditionally
 
 #### 3.a. Using a proc in `if`
@@ -136,15 +152,15 @@ end
 ```
 class PublishableModel < ActiveRecord::Base
   include Pheromone
-  publish message_options: [
+  publish [
     {
       event_types: [:update],
       topic: :topic1,
       message: message,
       if: ->(data) { data.condition },
     }
-  ] 
-   
+  ]
+
   def message
     { name: self.name }
   end
@@ -155,19 +171,19 @@ end
 ```
 class PublishableModel < ActiveRecord::Base
   include Pheromone
-  publish message_options: [
+  publish [
     {
       event_types: [:update],
       topic: :topic1,
       message: message,
       if: pre_condition
     }
-  ] 
-  
+  ]
+
   def pre_condition
     name.present?
   end
-  
+
   def message
     { name: self.name }
   end
@@ -182,7 +198,7 @@ The kafka topic can be specified in the `topic` option to `publish`. To publish
 ```
 class PublishableModel < ActiveRecord::Base
   include Pheromone
-  publish message_options: [
+  publish [
     {
       event_types: [:create],
       topic: :topic_test,

data/lib/pheromone/version.rb

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

data/lib/pheromone.rb

@@ -1,7 +1,7 @@
 require 'pheromone/version'
 require 'pheromone/options_validator'
 require 'active_support'
-
+require 'waterdrop'
 # Usage: For publishing messages to kafka, include this concern
 # in the model and then add
 #

metadata

@@ -1,43 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: pheromone
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Ankita Gupta
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-13 00:00:00.000000000 Z
+date: 2017-07-31 00:00:00.000000000 Z
 dependencies:
+- !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: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 4.2.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 4.2.5
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 4.2.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 4.2.5
 - !ruby/object:Gem::Dependency
   name: active_model_serializers
   requirement: !ruby/object:Gem::Requirement