artsy-eventservice 1.0.8 → 1.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b57886405d5d5d74bc384e16ad8ba63229665cb9
-  data.tar.gz: 3735eb18d6c4ceb84ce01c81902673031d2931bb
+  metadata.gz: 9c8662b50032c8b09290c4f31520b4a0f009be08
+  data.tar.gz: 76312d3024e20c9a291b272c118b226768256468
 SHA512:
-  metadata.gz: e39e3b5ada09e10aa556b087c56ba20cfa1f6f6f263e4a8c9f9eb096cf1114f0d2b489c0eda41c45b88e5518c437d59650d9a14f509697ee784a3b8a1afe1c93
-  data.tar.gz: 0f6b44839fb093d5094c2236c5d7efdad0344a2a9490df774a9b4661823004baf1504c1052e405b9b077cefe768c614ee6b307725aeb21b29f061af80b912c94
+  metadata.gz: 4944fb73e5a0d848dd1a2796a5356bf9873f4ad3d205c8cca86470c9822ea3ee7706f14db471e0ae1a2fbf278ba3686aa17dcc254102c52982f32d22526cc18f
+  data.tar.gz: 14e0753f34d2e8dc8364b2705bdccda7c78271ae004e023f3f5aef5e3efc105101b7e54bb6ea4af136bddbcce2377e6eb5ff051f5d3ebbbfde8b3ea8cc103314

data/CHANGELOG.md

@@ -1,3 +1,5 @@
+### 0.1.9
+* Add `to_json` to `BaseEvent` and deprecate `json` - [@ashkan18](https://github.com/ashkan18)
 ### 0.1.5 (3/24/17)
 * Add initializer-style configuration block
 ### 0.1.2 (3/23/17)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    artsy-eventservice (1.0.8)
+    artsy-eventservice (1.0.9)
       bunny
 
 GEM
@@ -78,4 +78,4 @@ RUBY VERSION
    ruby 2.3.0p0
 
 BUNDLED WITH
-   1.16.1
+   1.16.2

data/README.md

@@ -10,7 +10,7 @@ gem 'artsy-eventservice'
 
 ## Configuration
 
-Add `artsy_eventservice.rb under config/initializers. `Artsy::EventService` uses [Bunny](http://rubybunny.info/) to connect to RabbitMQ. Here is a sample of configuration:
+Add artsy_eventservice.rb within config/initializers. `Artsy::EventService` uses [Bunny](http://rubybunny.info/) to connect to RabbitMQ. Here is a sample of configuration:
 
 ```ruby
 # config/initializers/artsy_eventservice.rb
@@ -70,9 +70,9 @@ Few examples:
 - 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`
+- Topic: `invoices`, routing key: `merchantaccount.created`
 
-`BaseEvent` provides `routing_key` method by default which follows the same pattern mention above, you can override `routing_key` when calling `post_event`.
+`BaseEvent` provides `routing_key` method by default which follows the same pattern mention above, you can override `routing_key` when calling `post_event`. In the default routing key we use `to_s.downcase.gsub('::', '-')` on class name of the `@object` so an instance of `Artsy::UserRequest` with action being `test` will lead to `artsy-userrequest.test`.
 
 ### 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.

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

@@ -30,7 +30,7 @@ module Artsy
         raise 'Event missing topic or verb.' if event.verb.to_s.empty? || topic.to_s.empty?
         post_data(
           topic: topic,
-          data: event.json,
+          data: event.to_json,
           routing_key: routing_key || event.verb,
           headers: headers
         )

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

@@ -3,12 +3,13 @@ require 'json'
 
 module Events
   class BaseEvent
+    extend Gem::Deprecate
     attr_reader :verb, :subject, :object, :properties
+
     def initialize(user: nil, action:, model:)
       @subject = user
       @verb = action
       @object = model
-      @properties = nil
     end
 
     def subject
@@ -30,13 +31,19 @@ module Events
       end
     end
 
-    def json
+    def to_json
       JSON.generate(verb: @verb,
                     subject: subject,
                     object: object,
                     properties: properties)
     end
 
+    def json
+      # Deprecated, switch to to_json
+      to_json
+    end
+    deprecate :json, :to_json, 2019, 12
+
     def routing_key
       "#{@object.class.to_s.downcase.gsub('::', '-')}.#{@verb}"
     end

data/lib/artsy-eventservice/version.rb

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

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

@@ -13,7 +13,7 @@ describe Artsy::EventService::Publisher do
     end
     allow(event).to receive_messages(
       verb: 'testing',
-      json: JSON.generate(hello: true)
+      to_json: JSON.generate(hello: true)
     )
   end
 

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

@@ -17,7 +17,7 @@ describe Events::BaseEvent do
   end
   describe '#json' do
     it 'returns proper json' do
-      expect(JSON.parse(event.json)).to match(
+      expect(JSON.parse(event.to_json)).to match(
         'verb' => 'test',
         'subject' => {
           'id' => 'user-1',

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: artsy-eventservice
 version: !ruby/object:Gem::Version
-  version: 1.0.8
+  version: 1.0.9
 platform: ruby
 authors:
 - Ashkan Nasseri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-30 00:00:00.000000000 Z
+date: 2019-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny