artsy-eventservice 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7bcde99f80b60c849663d0402629e335c000669f
-  data.tar.gz: d210c63aee1afc7473c3cd5f42da578368a6756f
+  metadata.gz: b2fc420aec74a16109d3473d71cb71bd2c1fbafd
+  data.tar.gz: eda0bb72a66fe5cdc85887ea8d3c0aa325d5bae8
 SHA512:
-  metadata.gz: 247bdd61719b7885eb5ccd531a4a7747575c983eb482dd88496ced9be9682c517a53fb24181ae18668cbe80639f068d7d30763de7a9bfbb7f3b5c781bfd71179
-  data.tar.gz: 4e8af51716145e1688661e52bcc1c014efc8ebca198a354e6f53632c414a27ea1b5d85e9515a716e9cc21de6d2f5a012a1db029b55f3275fee38588e27ae30ee
+  metadata.gz: 6bf09515e7ed36508e0f0de94fa652ed91842418b3c79411748c8bf9affc5abad0795d15e2a6aea6b65ee6780e959a586da34d14cad0c4eea486b60fd882ca91
+  data.tar.gz: 96323a9511c6db2f81a1f2c5bde6a316b8e9740b43f1385f8698421a2079bbcce5eb73af576871baefcbc654dd534a092f3287be7471bf9e4b722d6e1ac90ce6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    artsy-eventservice (1.0.2)
+    artsy-eventservice (1.0.3)
       bunny (~> 2.6.2)
 
 GEM

data/README.md

@@ -59,10 +59,28 @@ Call `post_event` with proper `topic` and `event`:
 Artsy::EventService.post_event(topic: 'testing', event: event_model)
 ```
 
+# How to pick topic and routing key?
+Think of topic as high level business area. From consumer perspective there will be one connection per topic, consumer can decide to filter events they want to receive in that topic based on `routing_key` they listening on. For `topic` use plural names.
+
+We recommend to use following `routing_key` strategy:
+`<model_name>.<verb>`.
+
+Few examples:
+- Topic: `conversations`, routing key: `message.sent`
+- Topic: `conversations`, routing key: `conversation.created`
+- Topic: `conversations`, routing key: `conversation.dismissed`
+- Topic: `invoices`, routing key: `invoice.paid`
+- Topic: `invoices`, routing key: `merchant_account.created`
+
+`BaseEvent` provides `routing_key` method by default which follows the same pattern mention above, you can override `routing_key` when calling `post_event`.
 
 ### Update to Version 1.0
 In previous versions this gem was using Environment variables for configuration. On version 1.0, configuration step is now mandatory and it will no longer read environment variables directly. Make sure to go to configuration step.
 
+### Update to Version 1.0.3
+Since this version we've updated `routing_key` to default to `<event object class name>.<event.verb>`. This means if your consumers were listening on `verb` routing key, now they need to update to include object's class name.
+You can always override this feature by passing in `routing_key` to `post_event`.
+
 # Contributing
 
 * Fork the project.

data/lib/artsy-eventservice/artsy/event_service.rb

@@ -4,7 +4,7 @@ module Artsy
   module EventService
     def self.post_event(topic:, event:, routing_key: nil)
       return unless event_stream_enabled?
-      Publisher.publish(topic: topic, event: event, routing_key: routing_key)
+      Publisher.publish(topic: topic, event: event, routing_key: routing_key || event.routing_key)
     end
 
     def self.consume(**args)

data/lib/artsy-eventservice/presenters/events/base_event.rb

@@ -36,5 +36,9 @@ module Events
                     object: object,
                     properties: properties)
     end
+
+    def routing_key
+      "#{@object.class.to_s.downcase.gsub('::', '-')}.#{@verb}"
+    end
   end
 end

data/lib/artsy-eventservice/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 module Artsy
   module EventService
-    VERSION = '1.0.2'
+    VERSION = '1.0.3'
   end
 end

data/spec/artsy-eventstream/artsy/event_service_spec.rb

@@ -2,7 +2,7 @@
 require 'spec_helper'
 
 describe Artsy::EventService do
-  let(:event) { double('event', topic: 'foo', verb: 'bar') }
+  let(:event) { double('event', topic: 'foo', verb: 'bar', routing_key: 'test.passed') }
 
   context 'event stream disabled' do
     before do
@@ -22,7 +22,7 @@ describe Artsy::EventService do
     end
     describe '.post_event' do
       it 'calls publish with proper params' do
-        expect(Artsy::EventService::Publisher).to receive(:publish).with(topic: 'test', event: event, routing_key: nil)
+        expect(Artsy::EventService::Publisher).to receive(:publish).with(topic: 'test', event: event, routing_key: 'test.passed')
 
         Artsy::EventService.post_event(topic: 'test', event: event)
       end

data/spec/artsy-eventstream/presenters/events/base_event_spec.rb

@@ -32,4 +32,9 @@ describe Events::BaseEvent do
       )
     end
   end
+  describe '#routing_key' do
+    it 'returns proper routing key' do
+      expect(event.routing_key).to eq 'rspec-mocks-double.test'
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: artsy-eventservice
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Ashkan Nasseri