event_router 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50b25ed1a6cbef8f2dc0b4b571d76118e987ed9b123de3f1a759e4393b7e801b
-  data.tar.gz: 8d2c80e151358fa7fe58a2eff3f0250f2f795eeda327c4248ca554452be5ff24
+  metadata.gz: 79dbcbada6f98ca97196267161c48f526c84e4003b9b17f08d802204e9f46772
+  data.tar.gz: 7b6bbaeed68e1264329c5ef2e616fcccdab0792b95dfc180af466e1159829838
 SHA512:
-  metadata.gz: 713cc074634b7af45b462e4f8f31bb8ea4515aaa3485fb70a7b04bd83fad6136d9924b2a5c33e641c615c10d51c8497d9cb91a1f27a8ea1b1e64de5d22d57112
-  data.tar.gz: cff521d40abfc0260d5e64e42e2bf7274919e84b0c80e2dcb49edd25e4a42b526099742de7973cf3fbc152b4c548cfe969aacab1dcb952aeda5bd35c9efeb016
+  metadata.gz: 5ce10b55197712cf503960918fb7c6936ed334441a882eb374cbb50ca746d1b6d7a5287d8f4b33465e557aba62c85ef80103037dc286ad30277fe0a0d91a5769
+  data.tar.gz: 5bddbd23394618c8518b0fb5c0dd50c8af1c645ac2e849f2e3006119594b52e31aa9f1ccb787b32846f10ff32fa48e46c33c10b6760222f36de7618d0c623d97

data/.github/workflows/specs.yaml

@@ -7,7 +7,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu, macos]
+        os: [ubuntu]
         ruby: [2.5, 2.6, 2.7]
 
     steps:

data/README.md

@@ -2,9 +2,9 @@
 
 ![Specs](https://github.com/ahmad-elassuty/event_router/workflows/Specs/badge.svg)
 
-One domain event can have multiple side-effects in your system, for example sending emails, creating notifications, tasks, audit logs, event store, updating other system resources async and many more.
+EventRouter helps you organise your application domain events in a simple and intuitive way.
 
-EventRouter helps you organise your application domain events side-effects in a simple and intuitive way. No more bloated workers that does many actions, which violates Single responsiblity principle.
+One domain event can have multiple side-effects in your system, for example sending emails, creating notifications, tasks, audit logs, event store, updating other system resources async and many more. EventRouter will help you create dedicated classes for your events, that can be consumed by multiple destinations.
 
 ## Installation
 
@@ -22,13 +22,11 @@ Or install it yourself as:
 
     $ gem install event_router
 
-EventRouter is already pre-configured with some defaults. Please check the wikis for more info on how to update the configurations.
+EventRouter is pre-configured with some defaults. Please check the [Wiki](https://github.com/ahmad-elassuty/event_router/wiki/Configurations) for more info on how to update the configurations.
 
 ## Usage
 
-### Event
-
-It is very easy to create a new domain event and deliver it to multiple destinations.
+It is very easy to create a new domain event and deliver it to multiple destinations:
 
 - Create your new domain event and define the destination:
 
@@ -42,7 +40,7 @@ It is very easy to create a new domain event and deliver it to multiple destinat
 
   ```ruby
   class EmailNotifier
-    def self.order_placed(event, payload)
+    def self.order_placed(event:, payload:)
       # [TODO] Handle the event here
     end
   end
@@ -54,11 +52,15 @@ It is very easy to create a new domain event and deliver it to multiple destinat
   OrderPlaced.publish(order_id: 1, time: Time.now)
   ```
 
-And your are done! 🎉 
+  Also you can publish the event async:
+
+  ```ruby
+  OrderPlaced.publish_async(order_id: 1, time: Time.now)
+  ```
 
-### Destinations
+And your are done! 🎉
 
-A single event can define multiple destinations, and each destination can have different set of options.
+An event can also define multiple destinations and each destination can have different set of options:
 
 ```ruby
 class OrderPlaced < EventRouter::Event
@@ -67,30 +69,27 @@ class OrderPlaced < EventRouter::Event
 end
 ```
 
-For the full list of options, please check the wikis 📚.
+For the full list of options, please check the [Wiki](https://github.com/ahmad-elassuty/event_router/wiki/Events-And-Destinations) 📚.
 
 ### Delivery Adapters
 
-You can configure how your events are delivered to their destinations. EventRouter currently supports two different delivery adapters:
+You can configure how your events are delivered to their consumers. EventRouter currently supports two different delivery adapters:
 
-- Sync
-- Sidekiq
+- [x] Sync (default)
+- [x] [Sidekiq](https://github.com/mperham/sidekiq)
 
-The `sync` adapter is the default delivery adapter and does not require any dependencies. To asynchronously process your event, please use other backends, e.g Sidekiq.
+The `sync` adapter is the default delivery adapter. To asynchronously process your event, please use other backends e.g Sidekiq, or create your own custom adapter.
 
-To setup other adapters, please check the wikis 📚.
+To setup other adapters, please check the [Wiki](https://github.com/ahmad-elassuty/event_router/wiki/Configurations) 📚.
 
 ### Serializers
 
-Similarly, you can configure how events are serialized before they are handed to the delivery adapter. This is mainly to provide flexibility on how events are stored in the delivery backend and maintain the objects structure.
-
-- Json
-- Oj
-
-The `json` adapter is the default serializer adapter and does not require any dependencies.
+Similarly, you can configure how events are serialized before they are handed to the delivery backend. This is mainly to provide flexibility on how events are stored and maintain the objects structure on deserialization. EventRouter currently supports two serializer adapters:
 
-To setup other adapters, please check the wikis 📚.
+- [x] Json (default)
+- [x] [Oj](https://github.com/ohler55/oj)
 
+To change the default serializer adapter, please check the [Wiki](https://github.com/ahmad-elassuty/event_router/wiki/Configurations) 📚.
 
 ## Development
 

data/lib/event_router.rb

@@ -17,6 +17,10 @@ module EventRouter
     EventRouter::Publisher.publish(events, adapter: adapter)
   end
 
+  def publish_async(events, adapter: EventRouter.configuration.delivery_adapter)
+    EventRouter::Publisher.publish_async(events, adapter: adapter)
+  end
+
   def serialize(event, adapter: EventRouter.configuration.serializer_adapter)
     EventRouter::Serializer.serialize(event, adapter: adapter)
   end

data/lib/event_router/delivery_adapters/base.rb

@@ -21,6 +21,10 @@ module EventRouter
         def deliver(_event)
           raise NotImplementedError, "deliver method is not implemented for #{name}"
         end
+
+        def deliver_async(_event)
+          raise NotImplementedError, "deliver_async method is not implemented for #{name}"
+        end
       end
     end
   end

data/lib/event_router/delivery_adapters/helpers/deliver.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module EventRouter
+  module DeliveryAdapters
+    module Helpers
+      module Deliver
+        module_function
+
+        def yield_destinations(event)
+          event.destinations.each do |_name, destination|
+            if destination.prefetch_payload?
+              payload             = destination.extra_payload(event)
+              serialized_payload  = EventRouter.serialize(payload)
+            end
+
+            yield destination, serialized_payload
+          end
+        end
+      end
+    end
+  end
+end

data/lib/event_router/delivery_adapters/helpers/sidekiq.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module EventRouter
+  module DeliveryAdapters
+    module Helpers
+      module Sidekiq
+        module_function
+
+        def process_event(event, serialized_event: nil)
+          serialized_event ||= EventRouter.serialize(event)
+
+          options = EventRouter::DeliveryAdapters::Sidekiq.options
+
+          Helpers::Deliver.yield_destinations(event) do |destination, serialized_payload|
+            Workers::SidekiqDestinationDeliveryWorker
+              .set(queue: options[:queue], retry: options[:retry])
+              .perform_async(destination.name, serialized_event, serialized_payload)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/event_router/delivery_adapters/sidekiq.rb

@@ -1,6 +1,14 @@
 # frozen_string_literal: true
 
-require_relative 'jobs/sidekiq_event_delivery_job'
+require 'sidekiq'
+
+require_relative '../serializer'
+
+require_relative 'helpers/deliver'
+require_relative 'helpers/sidekiq'
+
+require_relative 'workers/sidekiq_destination_delivery_worker'
+require_relative 'workers/sidekiq_event_delivery_worker'
 
 module EventRouter
   module DeliveryAdapters
@@ -17,18 +25,15 @@ module EventRouter
         end
 
         def deliver(event)
-          serialized_event = EventRouter.serialize(event)
+          Helpers::Sidekiq.process_event(event)
+        end
 
-          event.destinations.each do |name, destination|
-            if destination.prefetch_payload?
-              payload             = destination.extra_payload(event)
-              serialized_payload  = EventRouter.serialize(payload)
-            end
+        def deliver_async(event)
+          serialized_event = EventRouter.serialize(event)
 
-            Jobs::SidekiqEventDeliveryJob
-              .set(queue: options[:queue], retry: options[:retry])
-              .perform_async(name, serialized_event, serialized_payload)
-          end
+          Workers::SidekiqEventDeliveryWorker
+            .set(queue: options[:queue], retry: options[:retry])
+            .perform_async(serialized_event)
         end
       end
     end

data/lib/event_router/delivery_adapters/sync.rb

@@ -3,11 +3,17 @@
 module EventRouter
   module DeliveryAdapters
     class Sync < Base
-      def self.deliver(event)
-        event.destinations.each do |_name, destination|
-          payload = destination.extra_payload(event)
+      class << self
+        def deliver(event)
+          event.destinations.each do |_name, destination|
+            payload = destination.extra_payload(event)
 
-          destination.process(event, payload)
+            destination.process(event, payload)
+          end
+        end
+
+        def deliver_async(event)
+          Thread.new { deliver(event) }
         end
       end
     end

data/lib/event_router/delivery_adapters/{jobs/sidekiq_event_delivery_job.rb → workers/sidekiq_destination_delivery_worker.rb}

@@ -1,12 +1,9 @@
 # frozen_string_literal: true
 
-require_relative '../../serializer'
-require 'sidekiq'
-
 module EventRouter
   module DeliveryAdapters
-    module Jobs
-      class SidekiqEventDeliveryJob
+    module Workers
+      class SidekiqDestinationDeliveryWorker
         include ::Sidekiq::Worker
 
         def perform(destination_name, serialized_event, serialized_payload)

data/lib/event_router/delivery_adapters/workers/sidekiq_event_delivery_worker.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module EventRouter
+  module DeliveryAdapters
+    module Workers
+      class SidekiqEventDeliveryWorker
+        include ::Sidekiq::Worker
+
+        def perform(serialized_event)
+          event = EventRouter.deserialize(serialized_event)
+
+          Helpers::Sidekiq.process_event(event, serialized_event: serialized_event)
+        end
+      end
+    end
+  end
+end

data/lib/event_router/event.rb

@@ -48,6 +48,10 @@ module EventRouter
       def publish(**attrs)
         EventRouter.publish(new(**attrs))
       end
+
+      def publish_async(**attrs)
+        EventRouter.publish_async(new(**attrs))
+      end
     end
   end
 end

data/lib/event_router/publisher.rb

@@ -15,6 +15,12 @@ module EventRouter
       Array(events).each { |event| adapter_class.deliver(event) }
     end
 
+    def publish_async(events, adapter:)
+      adapter_class = delivery_adapter(adapter)
+
+      Array(events).each { |event| adapter_class.deliver_async(event) }
+    end
+
     def delivery_adapter(adapter)
       EventRouter.configuration.delivery_adapter_class(adapter)
     end

data/lib/event_router/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EventRouter
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: event_router
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Ahmad Elassuty
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-23 00:00:00.000000000 Z
+date: 2021-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -143,9 +143,12 @@ files:
 - lib/event_router.rb
 - lib/event_router/configuration.rb
 - lib/event_router/delivery_adapters/base.rb
-- lib/event_router/delivery_adapters/jobs/sidekiq_event_delivery_job.rb
+- lib/event_router/delivery_adapters/helpers/deliver.rb
+- lib/event_router/delivery_adapters/helpers/sidekiq.rb
 - lib/event_router/delivery_adapters/sidekiq.rb
 - lib/event_router/delivery_adapters/sync.rb
+- lib/event_router/delivery_adapters/workers/sidekiq_destination_delivery_worker.rb
+- lib/event_router/delivery_adapters/workers/sidekiq_event_delivery_worker.rb
 - lib/event_router/destination.rb
 - lib/event_router/error.rb
 - lib/event_router/errors/required_option_error.rb