roo_on_rails 1.9.0 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 82ad20e84b42ea5464aa1d089f6e54c1476f38bf
-  data.tar.gz: b707a2fc6d70a093fc7b75c9ab44f61d1678bdd7
+  metadata.gz: a75dec85ceb80185f16de9a7750600c6a6284f20
+  data.tar.gz: b0c3482407ff65e0cf7a69e9935a4b1b67a54893
 SHA512:
-  metadata.gz: d94ba024d087ea2d51405d81bc9b690c072492551384d409bc0d8b34d6b24a11dd46db96e8ef5093ef6e04db731d149af91377470d0da6fc7fc328e81ec09682
-  data.tar.gz: 0a7839fda65b584af46860dd660a303889cb9a159502053a02ec7875e70fe1ea20c7240f12b9f0ccb2696134fe19b72d8c3b5a2b19a77d95467992feb84cab79
+  metadata.gz: 2a0e90668340f68bec18a4fcf1b7aaaf0fe05a1a89649a0fe0383bcbc19bb9aeb1070201d5cadc3b0f8dd3f5c43ae3b036b001c562aac20479a7c042ac4c6492
+  data.tar.gz: 3c90104b1133595ddd86729440776ac6a0c08f03aa71f87584afee49353545f4fd7cef91ecedd0d1a2dade237453d2960c43be7110414e29d69c5b47cfc48be4

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# v1.10.0 (2017-08-11)
+
+Features:
+
+- Asynchronous publishing of events to Routemaster (#56)
+
 # v1.9.0 (2017-08-08)
 
 Features:

data/README.routemaster_client.md

@@ -8,39 +8,29 @@ It also assumes that your app has an API for the resources you want to publish l
 
 ### Setup lifecycle events for your models
 
-We will most likely want to publish lifecycle events for several models, so to write slightly less code let's create a model concern first:
-
-```ruby
-# app/models/concerns/routemaster_lifecycle_events.rb
-require 'roo_on_rails/routemaster/lifecycle_events'
-
-module RoutemasterLifecycleEvents
-  extend ActiveSupport::Concern
-  include RooOnRails::Routemaster::LifecycleEvents
-
-  included do
-    publish_lifecycle_events
-  end
-end
-```
-
-Then let's include this concern to the relevant model(s):
+You can use publish events on create, update, and destroy by including the `PublishLifecycleEvents` module:
 
 ```ruby
 # app/models/order.rb
+require 'roo_on_rails/routemaster/publish_lifecycle_events'
+
 class Order < ApplicationRecord
-  include RoutemasterLifecycleEvents
+  include RooOnRails::Routemaster::PublishLifecycleEvents
 
   # ...
 end
 ```
 
-And another one for the example:
+If you need more control over which events are published you can use the base module `LifecycleEvents` and specify them explicitly:
 
 ```ruby
 # app/models/rider.rb
+require 'roo_on_rails/routemaster/lifecycle_events'
+
 class Rider < ApplicationRecord
-  include RoutemasterLifecycleEvents
+  include RooOnRails::Routemaster::LifecycleEvents
+
+  publish_lifecycle_events :create, :destroy
 
   # ...
 end
@@ -48,26 +38,31 @@ end
 
 ### Create publishers for lifecycle events
 
-We have now configured our models to publish lifecycle events to Routemaster, but it won't send anything until you have enabled publishing and created matching publishers. Let's start with creating a `BasePublisher` that we can then inherit from:
+We have now configured our models to publish lifecycle events to Routemaster, but it won't send anything until you have enabled publishing and created matching publishers. Let's start with creating an `ApplicationPublisher` that we can use as our default.
 
 ```ruby
-# app/publishers/base_publisher.rb
+# app/publishers/application_publisher.rb
 require 'roo_on_rails/routemaster/publisher'
 
-class BasePublisher < RooOnRails::Routemaster::Publisher
+class ApplicationPublisher < RooOnRails::Routemaster::Publisher
   include Rails.application.routes.url_helpers
 
+  def url
+    url_helper = :"api_#{model.class.name.underscore}_url"
+    public_send(url_helper, model.id, host: ENV.fetch('API_HOST'), protocol: 'https')
+  end
+
   # Add your method overrides here if needed
 end
 ```
 
-Then create a publisher for each model with lifecycle events enabled:
+If different behaviour is needed for specific models then you can override the defaults in their publishers:
 
 ```ruby
 # app/publishers/order_publisher.rb
-class OrderPublisher < BasePublisher
-  def url
-    api_order_url(model, host: ENV.fetch('API_HOST'), protocol: 'https')
+class OrderPublisher < ApplicationPublisher
+  def async?
+    true
   end
 end
 ```
@@ -76,9 +71,9 @@ and
 
 ```ruby
 # app/publishers/rider_publisher.rb
-class RiderPublisher < BasePublisher
-  def url
-    api_rider_url(model, host: ENV.fetch('API_HOST'), protocol: 'https')
+class RiderPublisher < ApplicationPublisher
+  def topic
+    'a_different_rider_topic'
   end
 end
 ```
@@ -96,10 +91,11 @@ PUBLISHERS = [
   RiderPublisher
 ].freeze
 
+RooOnRails::Routemaster::Publishers.register_default(ApplicationPublisher)
 PUBLISHERS.each do |publisher|
   model_class = publisher.to_s.gsub("Publisher", "").constantize
   RooOnRails::Routemaster::Publishers.register(publisher, model_class: model_class)
 end
 ```
 
-We should now be all set for our app to publish lifecycle events for `orders` and `riders` onto the event bus, so that other apps can listen to them.
+We should now be all set for our app to publish lifecycle events for all our models onto the event bus, with special behaviour for `orders` and `riders`, so that other apps can listen to them.

data/gemfiles/rails_3.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    roo_on_rails (1.9.0)
+    roo_on_rails (1.10.0)
       dogstatsd-ruby
       dotenv-rails (~> 2.1)
       faraday
@@ -76,7 +76,7 @@ GEM
     erubis (2.7.0)
     ethon (0.10.1)
       ffi (>= 1.3.0)
-    excon (0.58.0)
+    excon (0.57.1)
     faraday (0.12.2)
       multipart-post (>= 1.2, < 3)
     faraday_middleware (0.12.2)
@@ -141,7 +141,7 @@ GEM
     omniauth (1.4.2)
       hashie (>= 1.2, < 4)
       rack (>= 1.0, < 3)
-    omniauth-google-oauth2 (0.5.2)
+    omniauth-google-oauth2 (0.5.1)
       jwt (~> 1.5)
       multi_json (~> 1.3)
       omniauth (>= 1.1.1)

data/gemfiles/rails_4.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    roo_on_rails (1.9.0)
+    roo_on_rails (1.10.0)
       dogstatsd-ruby
       dotenv-rails (~> 2.1)
       faraday
@@ -83,7 +83,7 @@ GEM
     erubis (2.7.0)
     ethon (0.10.1)
       ffi (>= 1.3.0)
-    excon (0.58.0)
+    excon (0.57.1)
     faraday (0.12.2)
       multipart-post (>= 1.2, < 3)
     faraday_middleware (0.12.2)
@@ -155,7 +155,7 @@ GEM
     omniauth (1.6.1)
       hashie (>= 3.4.6, < 3.6.0)
       rack (>= 1.6.2, < 3)
-    omniauth-google-oauth2 (0.5.2)
+    omniauth-google-oauth2 (0.5.1)
       jwt (~> 1.5)
       multi_json (~> 1.3)
       omniauth (>= 1.1.1)

data/gemfiles/rails_5.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    roo_on_rails (1.9.0)
+    roo_on_rails (1.10.0)
       dogstatsd-ruby
       dotenv-rails (~> 2.1)
       faraday
@@ -86,7 +86,7 @@ GEM
     erubis (2.7.0)
     ethon (0.10.1)
       ffi (>= 1.3.0)
-    excon (0.58.0)
+    excon (0.57.1)
     faraday (0.12.2)
       multipart-post (>= 1.2, < 3)
     faraday_middleware (0.12.2)
@@ -159,7 +159,7 @@ GEM
     omniauth (1.6.1)
       hashie (>= 3.4.6, < 3.6.0)
       rack (>= 1.6.2, < 3)
-    omniauth-google-oauth2 (0.5.2)
+    omniauth-google-oauth2 (0.5.1)
       jwt (~> 1.5)
       multi_json (~> 1.3)
       omniauth (>= 1.1.1)

data/gemfiles/rails_5_1.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    roo_on_rails (1.9.0)
+    roo_on_rails (1.10.0)
       dogstatsd-ruby
       dotenv-rails (~> 2.1)
       faraday
@@ -87,7 +87,7 @@ GEM
     erubis (2.7.0)
     ethon (0.10.1)
       ffi (>= 1.3.0)
-    excon (0.58.0)
+    excon (0.57.1)
     faraday (0.12.2)
       multipart-post (>= 1.2, < 3)
     faraday_middleware (0.12.2)
@@ -160,7 +160,7 @@ GEM
     omniauth (1.6.1)
       hashie (>= 3.4.6, < 3.6.0)
       rack (>= 1.6.2, < 3)
-    omniauth-google-oauth2 (0.5.2)
+    omniauth-google-oauth2 (0.5.1)
       jwt (~> 1.5)
       multi_json (~> 1.3)
       omniauth (>= 1.1.1)

data/lib/roo_on_rails/routemaster/publish_lifecycle_events.rb

@@ -0,0 +1,13 @@
+require 'active_support/concern'
+require 'roo_on_rails/routemaster/lifecycle_events'
+
+module RooOnRails
+  module Routemaster
+    module PublishLifecycleEvents
+      extend ActiveSupport::Concern
+      include LifecycleEvents
+
+      included(&:publish_lifecycle_events)
+    end
+  end
+end

data/lib/roo_on_rails/routemaster/publisher.rb

@@ -22,7 +22,7 @@ module RooOnRails
 
       def publish!
         return unless will_publish?
-        @client.send(@event, topic, url, data: stringify_keys(data))
+        @client.send(@event, topic, url, async: async?, data: stringify_keys(data))
       end
 
       def topic
@@ -33,6 +33,10 @@ module RooOnRails
         raise NotImplementedError
       end
 
+      def async?
+        false
+      end
+
       def data
         nil
       end

data/lib/roo_on_rails/routemaster/publishers.rb

@@ -1,17 +1,27 @@
 module RooOnRails
   module Routemaster
     module Publishers
+      @default_publishers = []
       @publishers = {}
 
+      def self.register_default(publisher_class)
+        @default_publishers << publisher_class
+      end
+
       def self.register(publisher_class, model_class:)
         @publishers[model_class] ||= Set.new
         @publishers[model_class] << publisher_class
       end
 
       def self.for(model, event)
-        publisher_classes = @publishers[model.class]
+        publisher_classes = @publishers[model.class] || @default_publishers
         publisher_classes.map { |c| c.new(model, event) }
       end
+
+      def self.clear
+        @default_publishers = []
+        @publishers = {}
+      end
     end
   end
 end

data/lib/roo_on_rails/version.rb

@@ -1,3 +1,3 @@
 module RooOnRails
-  VERSION = '1.9.0'.freeze
+  VERSION = '1.10.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roo_on_rails
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.10.0
 platform: ruby
 authors:
 - Julien Letessier
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-08 00:00:00.000000000 Z
+date: 2017-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv-rails
@@ -433,6 +433,7 @@ files:
 - lib/roo_on_rails/railties/routemaster.rb
 - lib/roo_on_rails/railties/sidekiq.rb
 - lib/roo_on_rails/routemaster/lifecycle_events.rb
+- lib/roo_on_rails/routemaster/publish_lifecycle_events.rb
 - lib/roo_on_rails/routemaster/publisher.rb
 - lib/roo_on_rails/routemaster/publishers.rb
 - lib/roo_on_rails/shell.rb