event_router 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 50b25ed1a6cbef8f2dc0b4b571d76118e987ed9b123de3f1a759e4393b7e801b
+  data.tar.gz: 8d2c80e151358fa7fe58a2eff3f0250f2f795eeda327c4248ca554452be5ff24
+SHA512:
+  metadata.gz: 713cc074634b7af45b462e4f8f31bb8ea4515aaa3485fb70a7b04bd83fad6136d9924b2a5c33e641c615c10d51c8497d9cb91a1f27a8ea1b1e64de5d22d57112
+  data.tar.gz: cff521d40abfc0260d5e64e42e2bf7274919e84b0c80e2dcb49edd25e4a42b526099742de7973cf3fbc152b4c548cfe969aacab1dcb952aeda5bd35c9efeb016

data/.github/workflows/quality.yaml

@@ -0,0 +1,16 @@
+name: Quality
+on: push
+
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - uses: ruby/setup-ruby@v1
+      with:
+        bundler-cache: true
+
+    - run: bundle
+    - run: bundle exec rubocop

data/.github/workflows/specs.yaml

@@ -0,0 +1,23 @@
+name: Specs
+on: push
+
+jobs:
+  specs:
+    runs-on: ${{ matrix.os }}-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu, macos]
+        ruby: [2.5, 2.6, 2.7]
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+
+    - run: bundle
+    - run: bundle exec rspec
+

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# Debug
+.byebug_history

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,16 @@
+AllCops:
+  NewCops: enable
+
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - spec/**/*
+    - bin/**/*
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+
+# [TODO] Turn on documentation rule
+Style/Documentation:
+  Enabled: false
+

data/.ruby-gemset

@@ -0,0 +1 @@
+event_router

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.7.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ahmad.elassuty@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in event_router.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,89 @@
+PATH
+  remote: .
+  specs:
+    event_router (0.1.0)
+      activesupport
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.3.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    ast (2.4.1)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.7)
+    connection_pool (2.2.3)
+    diff-lcs (1.3)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    method_source (1.0.0)
+    minitest (5.14.1)
+    oj (3.10.14)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    rack (2.2.3)
+    rainbow (3.0.0)
+    redis (4.2.1)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.1)
+    rubocop (0.89.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.3.0, < 1.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.3.0)
+      parser (>= 2.7.1.4)
+    ruby-progressbar (1.10.1)
+    sidekiq (6.1.1)
+      connection_pool (>= 2.2.2)
+      rack (~> 2.0)
+      redis (>= 4.2.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.7.0)
+    zeitwerk (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  event_router!
+  oj
+  pry
+  pry-byebug
+  rspec (~> 3.0)
+  rubocop
+  sidekiq
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Ahmad Elassuty
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,113 @@
+# EventRouter
+
+![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 side-effects in a simple and intuitive way. No more bloated workers that does many actions, which violates Single responsiblity principle.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'event_router'
+```
+
+And then execute:
+
+    $ bundle install
+
+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.
+
+## Usage
+
+### Event
+
+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:
+
+  ```ruby
+  class OrderPlaced < EventRouter::Event
+    deliver_to :email_notifier, handler: EmailNotifier
+  end
+  ```
+
+- Create your handler:
+
+  ```ruby
+  class EmailNotifier
+    def self.order_placed(event, payload)
+      # [TODO] Handle the event here
+    end
+  end
+  ```
+
+- Publish your event:
+
+  ```ruby
+  OrderPlaced.publish(order_id: 1, time: Time.now)
+  ```
+
+And your are done! 🎉 
+
+### Destinations
+
+A single event can define multiple destinations, and each destination can have different set of options.
+
+```ruby
+class OrderPlaced < EventRouter::Event
+  deliver_to :email_notifier, handler: EmailNotifier
+  deliver_to :event_store, handler: EventStore, handler_method: :custom_method
+end
+```
+
+For the full list of options, please check the wikis 📚.
+
+### Delivery Adapters
+
+You can configure how your events are delivered to their destinations. EventRouter currently supports two different delivery adapters:
+
+- Sync
+- 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.
+
+To setup other adapters, please check the wikis 📚.
+
+### 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.
+
+To setup other adapters, please check the wikis 📚.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ahmad-elassuty/event_router. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/ahmad-elassuty/event_router/blob/master/CODE_OF_CONDUCT.md).
+
+Special thanks to [Ivan](https://github.com/idanci) for doing code review 🔍
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the EventRouter project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ahmad-elassuty/event_router/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'event_router'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/event_router.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative 'lib/event_router/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'event_router'
+  spec.version       = EventRouter::VERSION
+  spec.authors       = ['Ahmad Elassuty']
+  spec.email         = ['ahmad.elassuty@gmail.com']
+
+  spec.summary       = 'Organise your application domain events side-effects in a simple and intuitive way.'
+  spec.homepage      = 'https://github.com/ahmad-elassuty/event_router'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Dependencies
+  spec.add_dependency 'activesupport'
+
+  # Development dependencies
+  spec.add_development_dependency 'oj'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'sidekiq'
+end

data/examples/common.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require_relative 'event_store/order_placed'
+require_relative 'notifications'
+require_relative 'payment_received'
+require_relative 'order_placed'

data/examples/event_store/order_placed.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Examples
+  module EventStore
+    class OrderPlaced
+      def self.handle(event:, payload:)
+        puts "#{'=' * 10} [EventStore] #{'=' * 10}"
+        puts 'Received order_placed'
+        puts event.inspect
+        puts payload.inspect
+        puts '=' * 32
+      end
+    end
+  end
+end

data/examples/notifications.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Examples
+  module Notifications
+    module_function
+
+    def order_placed(event:, payload:)
+      puts "#{'=' * 10} [Notifications] #{'=' * 10}"
+      puts 'Received order_placed'
+      puts event.inspect
+      puts payload.inspect
+      puts '=' * 35
+    end
+
+    def payment_received(event:, **_payload)
+      puts "#{'=' * 10} [Notifications] #{'=' * 10}"
+      puts 'Received payment_received'
+      puts event.inspect
+      puts '=' * 35
+    end
+  end
+end

data/examples/order_placed.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Examples
+  class OrderPlaced < EventRouter::Event
+    deliver_to :notifications,
+               handler: Examples::Notifications
+
+    deliver_to :event_store,
+               handler: Examples::EventStore::OrderPlaced,
+               handler_method: :handle,
+               prefetch_payload: true,
+               payload_method: :store_payload
+
+    # Extra payload
+    def store_payload
+      {
+        id: SecureRandom.uuid
+      }
+    end
+  end
+end

data/examples/payment_received.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Examples
+  class PaymentReceived < EventRouter::Event
+    deliver_to :notifications,
+               handler: Examples::Notifications
+  end
+end

data/examples/sidekiq/config.yml

@@ -0,0 +1,3 @@
+:concurrency: 1
+:queues:
+  - [event_router, 1]

data/examples/sidekiq/run_console.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'event_router'
+require 'pry'
+
+require_relative '../common'
+
+EventRouter.configure do |config|
+  config.register_delivery_adapter :sidekiq, queue: :event_router, retry: 5
+
+  config.delivery_adapter = :sidekiq
+end
+
+Pry.start

data/examples/sidekiq/run_server.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'event_router'
+
+require_relative '../common'
+
+EventRouter.configure do |config|
+  config.register_delivery_adapter :sidekiq, queue: :event_router, retry: 5
+
+  config.delivery_adapter = :sidekiq
+end

data/examples/sync/run_console.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'event_router'
+
+require_relative '../common'
+
+require 'pry'
+Pry.start

data/lib/event_router.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'event_router/version'
+require 'event_router/error'
+
+require 'event_router/event'
+require 'event_router/delivery_adapters/base'
+require 'event_router/serializers/base'
+require 'event_router/publisher'
+require 'event_router/serializer'
+require 'event_router/configuration'
+
+module EventRouter
+  module_function
+
+  def publish(events, adapter: EventRouter.configuration.delivery_adapter)
+    EventRouter::Publisher.publish(events, adapter: adapter)
+  end
+
+  def serialize(event, adapter: EventRouter.configuration.serializer_adapter)
+    EventRouter::Serializer.serialize(event, adapter: adapter)
+  end
+
+  def deserialize(payload, adapter: EventRouter.configuration.serializer_adapter)
+    EventRouter::Serializer.deserialize(payload, adapter: adapter)
+  end
+
+  def configuration
+    @configuration ||= Configuration.new
+  end
+
+  def configure
+    yield configuration if block_given?
+  end
+end

data/lib/event_router/configuration.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require_relative 'errors/unsupported_option_error'
+
+module EventRouter
+  class Configuration
+    attr_reader :delivery_adapter, :delivery_adapters,
+                :serializer_adapter, :serializer_adapters
+
+    def initialize
+      @delivery_adapters    = {}
+      @serializer_adapters  = {}
+
+      register_delivery_adapter(:sync)
+      @delivery_adapter = :sync
+
+      register_serializer_adapter(:json)
+      @serializer_adapter = :json
+    end
+
+    def delivery_adapter=(adapter, _opts = {})
+      validate_inclusion!(:delivery_adapter, adapter, @delivery_adapters)
+
+      @delivery_adapter = adapter
+    end
+
+    def delivery_adapter_class(adapter)
+      @delivery_adapters[adapter]
+    end
+
+    def register_delivery_adapter(adapter, opts = {})
+      adapter_class = load_adapter_class(Publisher::ADAPTERS, adapter) || opts[:adapter_class]
+
+      adapter_class.options       = opts
+      @delivery_adapters[adapter] = adapter_class
+    end
+
+    def serializer_adapter=(adapter)
+      validate_inclusion!(:serializer_adapter, adapter, @serializer_adapters)
+
+      @serializer_adapter = adapter
+    end
+
+    def serializer_adapter_class(adapter)
+      @serializer_adapters[adapter]
+    end
+
+    def register_serializer_adapter(adapter, opts = {})
+      adapter_class = load_adapter_class(Serializer::ADAPTERS, adapter) || opts[:adapter_class]
+
+      @serializer_adapters[adapter] = adapter_class
+    end
+
+    private
+
+    def load_adapter_class(adapters, adapter)
+      return nil unless adapters.key?(adapter)
+
+      require_relative adapters[adapter][:path]
+      Kernel.const_get(adapters[adapter][:adapter_class])
+    end
+
+    def validate_inclusion!(config, option, supported_options)
+      return if supported_options.include?(option)
+
+      raise Errors::UnsupportedOptionError.new(
+        config: config, option: option, supported_options: supported_options.keys
+      )
+    end
+  end
+end

data/lib/event_router/delivery_adapters/base.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative '../errors/required_option_error'
+
+module EventRouter
+  module DeliveryAdapters
+    class Base
+      class << self
+        attr_reader :options
+
+        def options=(options)
+          validate_options!(options)
+
+          @options = options
+        end
+
+        def validate_options!(_options)
+          true
+        end
+
+        def deliver(_event)
+          raise NotImplementedError, "deliver method is not implemented for #{name}"
+        end
+      end
+    end
+  end
+end

data/lib/event_router/delivery_adapters/jobs/sidekiq_event_delivery_job.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative '../../serializer'
+require 'sidekiq'
+
+module EventRouter
+  module DeliveryAdapters
+    module Jobs
+      class SidekiqEventDeliveryJob
+        include ::Sidekiq::Worker
+
+        def perform(destination_name, serialized_event, serialized_payload)
+          event       = EventRouter.deserialize(serialized_event)
+          destination = event.destinations[destination_name.to_sym]
+
+          return unless destination
+
+          payload = if destination.prefetch_payload?
+                      EventRouter.deserialize(serialized_payload)
+                    else
+                      destination.extra_payload(event)
+                    end
+
+          destination.process(event, payload)
+        end
+      end
+    end
+  end
+end

data/lib/event_router/delivery_adapters/sidekiq.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'jobs/sidekiq_event_delivery_job'
+
+module EventRouter
+  module DeliveryAdapters
+    class Sidekiq < Base
+      REQUIRED_OPTIONS = %i[queue retry].freeze
+
+      class << self
+        def validate_options!(options)
+          missing_options = REQUIRED_OPTIONS - options.compact.keys
+
+          return true if missing_options.empty?
+
+          raise Errors::RequiredOptionError.new(options: missing_options, adapter: self)
+        end
+
+        def deliver(event)
+          serialized_event = EventRouter.serialize(event)
+
+          event.destinations.each do |name, destination|
+            if destination.prefetch_payload?
+              payload             = destination.extra_payload(event)
+              serialized_payload  = EventRouter.serialize(payload)
+            end
+
+            Jobs::SidekiqEventDeliveryJob
+              .set(queue: options[:queue], retry: options[:retry])
+              .perform_async(name, serialized_event, serialized_payload)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/event_router/delivery_adapters/sync.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module EventRouter
+  module DeliveryAdapters
+    class Sync < Base
+      def self.deliver(event)
+        event.destinations.each do |_name, destination|
+          payload = destination.extra_payload(event)
+
+          destination.process(event, payload)
+        end
+      end
+    end
+  end
+end

data/lib/event_router/destination.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module EventRouter
+  class Destination
+    # Attributes
+    attr_reader :name, :handler, :handler_method,
+                :prefetch_payload, :payload_method
+
+    # Constants
+    DEFAULT_ATTRIBUTES = {
+      # Defaults to the event name, e.g "order_placed"
+      handler_method: nil,
+      # Defaults to not fetch before scheduling the job.
+      prefetch_payload: false,
+      # Defaults to destination name, e.g "#{name}_payload"
+      payload_method: nil
+    }.freeze
+
+    # Methods
+    def initialize(name, handler:, **opts)
+      opts = DEFAULT_ATTRIBUTES.merge(opts)
+
+      @name             = name
+      @handler          = handler
+      @handler_method   = opts[:handler_method]
+      @prefetch_payload = opts[:prefetch_payload]
+      @payload_method   = opts[:payload_method] || "#{name}_payload"
+    end
+
+    def process(event, payload)
+      handler.send(
+        handler_method || event.name,
+        event: event,
+        payload: payload
+      )
+    end
+
+    def prefetch_payload?
+      @prefetch_payload
+    end
+
+    def extra_payload(event)
+      return nil unless event.respond_to?(payload_method)
+
+      event.send(payload_method)
+    end
+  end
+end

data/lib/event_router/error.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module EventRouter
+  class Error < StandardError; end
+end

data/lib/event_router/errors/required_option_error.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative '../error'
+
+module EventRouter
+  module Errors
+    class RequiredOptionError < Error
+      def initialize(message: nil, options:, adapter:)
+        @options = options
+        @adapter = adapter
+
+        super(message || self.message)
+      end
+
+      def message
+        "#{@options} are required for #{@adapter} adapter."
+      end
+    end
+  end
+end

data/lib/event_router/errors/unsupported_option_error.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative '../error'
+
+module EventRouter
+  module Errors
+    class UnsupportedOptionError < Error
+      def initialize(message: nil, config:, option:, supported_options:)
+        @config             = config
+        @option             = option
+        @supported_options  = supported_options
+
+        super(message || self.message)
+      end
+
+      def message
+        "Unsupported #{@option} for #{@config} configuration. Currently supports #{@supported_options}. " \
+          'Please consider registering the adapter before referencing it.'
+      end
+    end
+  end
+end

data/lib/event_router/event.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'securerandom'
+require 'active_support/core_ext/class/attribute'
+require 'active_support/core_ext/string/inflections'
+
+require_relative 'destination'
+
+module EventRouter
+  class Event
+    attr_reader :uid, :created_at, :payload
+    attr_accessor :correlation_id
+
+    class_attribute :destinations, default: {}, instance_writer: false
+
+    def initialize(uid: SecureRandom.uuid, correlation_id: SecureRandom.uuid, created_at: Time.now, **payload)
+      @uid            = uid
+      @correlation_id = correlation_id
+      @created_at     = created_at
+      @payload        = payload
+    end
+
+    def to_hash
+      {
+        uid: uid,
+        correlation_id: correlation_id,
+        payload: payload,
+        created_at: created_at
+      }
+    end
+
+    alias to_h to_hash
+
+    def name
+      self.class.name.demodulize.underscore
+    end
+
+    class << self
+      def inherited(base)
+        base.destinations = destinations.dup
+        super
+      end
+
+      def deliver_to(name, opts = {})
+        destinations[name] = EventRouter::Destination.new(name, **opts)
+      end
+
+      def publish(**attrs)
+        EventRouter.publish(new(**attrs))
+      end
+    end
+  end
+end

data/lib/event_router/publisher.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module EventRouter
+  module Publisher
+    module_function
+
+    ADAPTERS = {
+      sync: { adapter_class: 'EventRouter::DeliveryAdapters::Sync', path: 'delivery_adapters/sync' },
+      sidekiq: { adapter_class: 'EventRouter::DeliveryAdapters::Sidekiq', path: 'delivery_adapters/sidekiq' }
+    }.freeze
+
+    def publish(events, adapter:)
+      adapter_class = delivery_adapter(adapter)
+
+      Array(events).each { |event| adapter_class.deliver(event) }
+    end
+
+    def delivery_adapter(adapter)
+      EventRouter.configuration.delivery_adapter_class(adapter)
+    end
+
+    private_class_method :delivery_adapter
+  end
+end

data/lib/event_router/serializer.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module EventRouter
+  module Serializer
+    module_function
+
+    ADAPTERS = {
+      json: { adapter_class: 'EventRouter::Serializers::Json', path: 'serializers/json' },
+      oj: { adapter_class: 'EventRouter::Serializers::Oj', path: 'serializers/oj' }
+    }.freeze
+
+    def serialize(payload, adapter:)
+      serializer_adapter(adapter).serialize(payload)
+    end
+
+    def deserialize(payload, adapter:)
+      serializer_adapter(adapter).deserialize(payload)
+    end
+
+    def serializer_adapter(adapter)
+      EventRouter.configuration.serializer_adapter_class(adapter)
+    end
+
+    private_class_method :serializer_adapter
+  end
+end

data/lib/event_router/serializers/base.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module EventRouter
+  module Serializers
+    class Base
+      class << self
+        def serialize(_object)
+          raise NotImplementedError, 'Sub-classes must implement serialize method.'
+        end
+
+        def deserialize(_string)
+          raise NotImplementedError, 'Sub-classes must implement serialize method.'
+        end
+      end
+    end
+  end
+end

data/lib/event_router/serializers/json.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module EventRouter
+  module Serializers
+    class Json < Base
+      EVENT_CLASS_ATTRIBUTE_NAME = 'er_class'
+
+      class << self
+        def serialize(object)
+          return JSON.generate(object) unless object.is_a?(EventRouter::Event)
+
+          attributes = object.to_h
+          attributes[EVENT_CLASS_ATTRIBUTE_NAME] = object.class.name
+
+          JSON.generate(attributes)
+        end
+
+        def deserialize(payload)
+          object = JSON.parse(payload)
+
+          return object unless object.is_a?(Hash)
+          return object unless object.key?(EVENT_CLASS_ATTRIBUTE_NAME)
+
+          event_class     = object.delete(EVENT_CLASS_ATTRIBUTE_NAME)
+          event_instance  = const_get(event_class).new
+
+          object.each do |attribute, value|
+            event_instance.instance_variable_set(:"@#{attribute}", value)
+          end
+
+          event_instance
+        end
+      end
+    end
+  end
+end

data/lib/event_router/serializers/oj.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'oj'
+
+module EventRouter
+  module Serializers
+    class Oj < Base
+      class << self
+        def serialize(object)
+          ::Oj.dump(object, mode: :object)
+        end
+
+        def deserialize(string)
+          ::Oj.load(string, mode: :object)
+        end
+      end
+    end
+  end
+end

data/lib/event_router/version.rb

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

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: event_router
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ahmad Elassuty
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-01-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: oj
+  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: pry
+  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: pry-byebug
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: sidekiq
+  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'
+description:
+email:
+- ahmad.elassuty@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/quality.yaml"
+- ".github/workflows/specs.yaml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- event_router.gemspec
+- examples/common.rb
+- examples/event_store/order_placed.rb
+- examples/notifications.rb
+- examples/order_placed.rb
+- examples/payment_received.rb
+- examples/sidekiq/config.yml
+- examples/sidekiq/run_console.rb
+- examples/sidekiq/run_server.rb
+- examples/sync/run_console.rb
+- 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/sidekiq.rb
+- lib/event_router/delivery_adapters/sync.rb
+- lib/event_router/destination.rb
+- lib/event_router/error.rb
+- lib/event_router/errors/required_option_error.rb
+- lib/event_router/errors/unsupported_option_error.rb
+- lib/event_router/event.rb
+- lib/event_router/publisher.rb
+- lib/event_router/serializer.rb
+- lib/event_router/serializers/base.rb
+- lib/event_router/serializers/json.rb
+- lib/event_router/serializers/oj.rb
+- lib/event_router/version.rb
+homepage: https://github.com/ahmad-elassuty/event_router
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ahmad-elassuty/event_router
+  source_code_uri: https://github.com/ahmad-elassuty/event_router
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Organise your application domain events side-effects in a simple and intuitive
+  way.
+test_files: []