outboxable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 974efa7874e38a5ca48f6c91b58fbb0b1d8b7508135ecd50dd1e230ad8c9d508
+  data.tar.gz: 565c240d3c10c0abd3ffe191af9d189e3f0fcaf95e66dffc17ff3f861cbb87c3
+SHA512:
+  metadata.gz: 1f1f87256f1f331ec2d16a1b42453a57f58498894f965d8e7a996266b1ac8749fc304126c3f5ba71d75a89a03e0d2864b2e0216ade977c157db61abf77cb0855
+  data.tar.gz: ad131708cecf7baf24a520058118f92bccc835d3a9f7c8874838c43c95d4a0bd88ea5e26932a961e484cb31b4bd79b37972fcceb7794e0b172e30cee67ae5df6

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,113 @@
+require: rubocop-rails
+
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+Layout/SpaceBeforeBrackets: # (new in 1.7)
+  Enabled: true
+Layout/LineLength: 
+  Max: 350
+Lint/AmbiguousAssignment: # (new in 1.7)
+  Enabled: true
+Lint/DeprecatedConstants: # (new in 1.8)
+  Enabled: true
+Lint/DuplicateBranch: # (new in 1.3)
+  Enabled: true
+Lint/DuplicateRegexpCharacterClassElement: # (new in 1.1)
+  Enabled: true
+Lint/EmptyBlock: # (new in 1.1)
+  Enabled: true
+Lint/EmptyClass: # (new in 1.3)
+  Enabled: true
+Lint/LambdaWithoutLiteralBlock: # (new in 1.8)
+  Enabled: true
+Lint/NoReturnInBeginEndBlocks: # (new in 1.2)
+  Enabled: true
+Lint/NumberedParameterAssignment: # (new in 1.9)
+  Enabled: true
+Lint/OrAssignmentToConstant: # (new in 1.9)
+  Enabled: true
+Lint/RedundantDirGlobSort: # (new in 1.8)
+  Enabled: true
+Lint/SymbolConversion: # (new in 1.9)
+  Enabled: true
+Lint/ToEnumArguments: # (new in 1.1)
+  Enabled: true
+Lint/TripleQuotes: # (new in 1.9)
+  Enabled: true
+Lint/UnexpectedBlockArity: # (new in 1.5)
+  Enabled: true
+Lint/UnmodifiedReduceAccumulator: # (new in 1.1)
+  Enabled: true
+Style/ArgumentsForwarding: # (new in 1.1)
+  Enabled: true
+Style/CollectionCompact: # (new in 1.2)
+  Enabled: true
+Style/DocumentDynamicEvalDefinition: # (new in 1.1)
+  Enabled: true
+Style/Documentation:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Style/EndlessMethod: # (new in 1.8)
+  Enabled: true
+Style/HashConversion: # (new in 1.10)
+  Enabled: true
+Style/HashExcept: # (new in 1.7)
+  Enabled: true
+Style/IfWithBooleanLiteralBranches: # (new in 1.9)
+  Enabled: true
+Style/NegatedIfElseCondition: # (new in 1.2)
+  Enabled: true
+Style/NilLambda: # (new in 1.3)
+  Enabled: true
+Style/RedundantArgument: # (new in 1.4)
+  Enabled: true
+Style/SwapValues: # (new in 1.1)
+  Enabled: true
+Rails/ActiveRecordCallbacksOrder: # (new in 2.7)
+  Enabled: true
+Rails/AfterCommitOverride: # (new in 2.8)
+  Enabled: true
+Rails/AttributeDefaultBlockValue: # (new in 2.9)
+  Enabled: true
+Rails/FindById: # (new in 2.7)
+  Enabled: true
+Rails/Inquiry: # (new in 2.7)
+  Enabled: true
+Rails/MailerName: # (new in 2.7)
+  Enabled: true
+Rails/MatchRoute: # (new in 2.7)
+  Enabled: true
+Rails/NegateInclude: # (new in 2.7)
+  Enabled: true
+Rails/Pluck: # (new in 2.7)
+  Enabled: true
+Rails/PluckInWhere: # (new in 2.7)
+  Enabled: true
+Rails/RenderInline: # (new in 2.7)
+  Enabled: true
+Rails/RenderPlainText: # (new in 2.7)
+  Enabled: true
+Rails/ShortI18n: # (new in 2.7)
+  Enabled: true
+Rails/SquishedSQLHeredocs: # (new in 2.8)
+  Enabled: true
+Rails/UniqueValidationWithoutIndex:
+  Enabled: false
+Rails/WhereEquals: # (new in 2.9)
+  Enabled: true
+Rails/WhereExists: # (new in 2.7)
+  Enabled: true
+Rails/WhereNot: # (new in 2.8)
+  Enabled: true
+Metrics/BlockLength:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Max: 15
+Metrics/PerceivedComplexity:
+  Max: 15

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-02-26
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at broosk.edogawa@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in outboxable.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,69 @@
+PATH
+  remote: .
+  specs:
+    outboxable (0.1.0)
+      bunny (>= 2.19.0)
+      connection_pool (~> 2.3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    amq-protocol (2.3.2)
+    ast (2.4.2)
+    bunny (2.20.3)
+      amq-protocol (~> 2.3, >= 2.3.1)
+      sorted_set (~> 1, >= 1.0.2)
+    connection_pool (2.3.0)
+    diff-lcs (1.5.0)
+    json (2.6.3)
+    parallel (1.22.1)
+    parser (3.2.1.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rbtree (0.4.6)
+    regexp_parser (2.7.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.45.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.26.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.11.0)
+    set (1.0.3)
+    sorted_set (1.0.3)
+      rbtree
+      set (~> 1.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  outboxable!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.4.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Brusk Awat
+
+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,227 @@
+# Outboxable
+
+The Outboxable Gem is tailored for Rails applications to implement the transactional outbox pattern. It currently only supports ActiveRecord.
+
+Please take into consideration that this Gem is **opinionated**, meaning it expects you to follow a certain pattern and specific setting. If you don't like it, you can always fork it and change it.
+
+### Restrictions
+
+1. When using RabbitMQ, it only publishes events to a ***topic*** exchange. 
+1. It assumes that you are using routing keys to publish to the topic exchange.
+1. It publishes events in a background job using [Sidekiq](https://github.com/sidekiq/sidekiq). Therefore, you application must use Sidekiq.
+1. It implements the [polling publisher pattern](https://microservices.io/patterns/data/polling-publisher.html). For that, it uses [](https://github.com/sidekiq-cron/sidekiq-cron) to check the unpublished outboxes every 5 seconds after the initialization of the application.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```ruby
+$ bundle add outboxable
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```ruby
+$ gem install outboxable
+```
+
+Then run: 
+
+```shell
+$ rails g outboxable:install
+```
+
+The command above will add a migration file and the Outbox model. You will need then to run the migrations:
+
+```shell
+$ rails db:migrate
+```
+
+## Usage
+
+The installation command above will also add a configuration file to your initializer:
+
+```ruby
+# This monkey patch allows you to customize the message format that you publish to your broker. 
+# By default, Outboxable publishes a CloudEvent message to your broker.
+module Outboxable
+  module RabbitMq
+    class Publisher
+      # Override this method to customize the message format that you publish to your broker
+      # DO NOT CHANGE THE METHOD SIGNATURE
+      def to_envelope(resource:)
+        {
+          id: resource.id,
+          source: 'http://localhost:3000',
+          specversion: '1.0',
+          type: resource.routing_key,
+          datacontenttype: 'application/json',
+          data: @resource.payload
+        }.to_json
+      end
+    end
+  end
+end
+
+Outboxable.configure do |config|
+  # Specify the ORM you are using. For now, only ActiveRecord is supported.
+  config.orm = :activerecord
+
+  # Specify the message broker you are using. For now, only RabbitMQ is supported.
+  config.message_broker = :rabbitmq
+
+  # RabbitMQ configurations
+  config.rabbitmq_host = ENV.fetch('RABBITMQ__HOST')
+  config.rabbitmq_port = ENV.fetch('RABBITMQ__PORT', 5672)
+  config.rabbitmq_user = ENV.fetch('RABBITMQ__USER')
+  config.rabbitmq_password = ENV.fetch('RABBITMQ__PASSWORD')
+  config.rabbitmq_vhost = ENV.fetch('RABBITMQ__VHOST')
+  config.rabbitmq_event_bus_exchange = ENV.fetch('EVENTBUS__EXCHANGE_NAME')
+end
+```
+
+The monkey patch in the code above is crucial in giving you a way to customize the format of the message that you will publish to the message broker. Be default, it follows the specs of the [Cloud Native Events Specifications v1.0.2](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md). 
+
+
+
+### General use-cases
+
+The Outboxable Gem provides a general-purpose polymorphic model for creating outboxes. In order to maintain a transactional outbox, the changes that occur to a resource and the associated outbox must happen within the same transaction:
+
+```ruby
+ActiveRecord::Base.transaction do
+  book = Book.find(1)
+  book.update!(title: 'Patterns of Enterprise Application Architecture', author: 'Martin Fowler')
+  Outbox.create!(
+    routing_key: 'books.updated',
+    exchange: 'YOUR RABBITMQ EXCHANGE',
+    payload: book.as_json,
+    outboxable: book
+  )
+end
+
+```
+
+
+If you are intending to create an outbox that is not necessarily associated with a resource, you can use the following configuration that sets the ``size`` attribute to ``:batch``:
+
+```ruby
+ActiveRecord::Base.transaction do
+  book = Book.find(1)
+  book.update!(status: :published)
+  Outbox.create!(
+    routing_key: 'notifications.publish',
+    exchange: 'YOUR EXCHANGE',
+    payload: {
+      channels: ['sms', 'email'],
+      message: "Hello, world!"
+    },
+    size: :batch
+  )
+end
+```
+
+
+
+### The Outboxable Concern
+
+The Outboxable Gem provides an ActiveRecord Model Concern that you can reuse in your models, which in turn will take care of transactionally creating events in case of create or update of the resource. All you have to do is to ``include Outboxable`` in your model and implement a method by the name of ``outbox_configurations``:
+
+
+
+```ruby
+class Book < ApplicationRecord
+  include Outboxable
+
+  # Enums
+  enum status: { draft: 0, published: 1 }
+
+  def outbox_configurations
+    @outbox_configurations ||= {
+      base: {
+        routing_key: 'books'
+      },
+      run_on: {
+        create: {},
+        update: {
+          condition: proc { |book| book.published? },
+          routing_key: 'books.published'
+        }
+      }
+    }
+  end
+end
+```
+
+
+
+The ``outbox_configurations`` method will be called and used by the Outboxable Gem to transactionally create an outbox and publish. In the code above, it will create an outbox when the book is created. For that purpose it will use the routing key ``books.created`` as a convention. It will also publish an event if the book is updated, using the routing key: ``books.published`` since it was specified in the hash. 
+
+
+
+Here's the schema of what could be passed to the ``outbox_configurations`` in JSON Schema format:
+
+```json
+{
+  "type": "object",
+  "properties": {
+    "base": {
+      "type": "object",
+      "properties": {
+        "routing_key": { "type": "string" }
+      }
+    },
+    "run_on": {
+      "type": "object",
+      "properties": {
+        "create": {
+          "type": "object",
+          "properties": {
+            "condition": { "type": "Ruby Proc" },
+            "routing_key": { "type": "string" }
+          }
+        },
+        "update": {
+          "type": "object",
+          "properties": {
+            "condition": { "type": "Ruby Proc" },
+            "routing_key": { "type": "string" }
+          }
+        }
+      }
+    }
+  }
+}
+```
+
+
+
+The ``run_on`` key represents another hash that can have the keys ``create`` and ``update``. If one of these keys are not supplied, the outbox will not be created for the unspecified operation; in other words, if you do not specify the configuration for ``update``, for example, an outbox will NOT be created when the book is updated. 
+
+Each operation key such as ``create`` and ``update`` can also take a ``condition`` key, which represents a Ruby proc that must return a boolean expression. It can also take a ``routing_key`` option, which specifies that routing key with which the outbox will publish the event to the message broker. If you don't specify the ``routing_key``, it will use the base`s routing key dotted by``created`` for create operation and ``updated`` for update operation.
+
+
+
+Last but not least, run sidekiq so that the Outboxable Gem can publish the events to the broker: 
+
+```shell
+$ bundle exec sidekiq
+```
+
+## 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 the created tag, 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/[USERNAME]/outboxable. 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/[USERNAME]/outboxable/blob/master/CODE_OF_CONDUCT.md).
+
+## 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 Outboxable project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/outboxable/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/generators/outboxable/install_generator.rb

@@ -0,0 +1,36 @@
+module Outboxable
+  class InstallGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    source_root File.expand_path('../../../templates', __FILE__)
+
+    # Copy initializer into user app
+    def copy_initializer
+      copy_file('initializer.rb', 'config/initializers/outboxable.rb')
+    end
+
+    # Copy user information (model & Migrations) into user app
+    def create_user_model
+      target_path = "app/models/outbox.rb"
+      unless File.exist?(File.join(Rails.root, target_path))
+        template("outbox.rb", target_path)
+      else
+        say_status('skipped', "Model outbox already exists")
+      end
+    end
+
+    # Copy migrations
+    def copy_migrations
+      if self.class.migration_exists?('db/migrate', "create_outboxable_outboxes")
+        say_status('skipped', "Migration create_outboxable_outboxes already exists")
+      else
+        migration_template('create_outboxable_outboxes.rb', "db/migrate/create_outboxable_outboxes.rb")
+      end
+    end
+
+    # Use to assign migration time otherwise generator will error
+    def self.next_migration_number(dir)
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    end
+  end
+end

data/lib/outboxable/configuration.rb

@@ -0,0 +1,57 @@
+module Outboxable
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  class Configuration
+    ALLOWED_MESSAGE_BROKERS = %i[rabbitmq].freeze
+    ALLOWED_ORMS = %i[activerecord].freeze
+
+    attr_accessor :rabbitmq_host, 
+                  :rabbitmq_port,
+                  :rabbitmq_user,
+                  :rabbitmq_password,
+                  :rabbitmq_vhost,
+                  :rabbitmq_event_bus_exchange,
+                  :message_broker,
+                  :orm
+
+    def initialize
+      raise Error, 'Sidekiq is not available. Unfortunately, sidekiq must be available for Outboxable to work' unless Object.const_defined?('Sidekiq')
+      raise Error, 'Outboxable Gem only supports Rails but you application does not seem to be a Rails app' unless Object.const_defined?('Rails')
+      raise Error, 'Outboxable Gem only support Rails version 7 and newer' if Rails::VERSION::MAJOR < 7
+      raise Error, 'Outboxable Gem uses the sidekiq-cron Gem. Make sure you add it to your project' unless Object.const_defined?('Sidekiq::Cron')
+
+      # In accordance to sidekiq-cron README: https://github.com/sidekiq-cron/sidekiq-cron#under-the-hood
+      Sidekiq::Options[:cron_poll_interval] = 5
+
+      # Create the cron job for the polling publisher
+      Sidekiq::Cron::Job.create(name: 'OutboxablePollingPublisher', cron: '*/5 * * * * *', class: 'Outboxable::PollingPublisherWorker') 
+    end
+
+    def message_broker=(message_broker)
+      raise ArgumentError, "Message broker must be one of #{ALLOWED_MESSAGE_BROKERS}" unless ALLOWED_MESSAGE_BROKERS.include?(message_broker)
+
+      @message_broker = message_broker
+    end
+
+    def message_broker
+      @message_broker || :rabbitmq
+    end
+
+    def orm=(orm)
+      raise ArgumentError, "ORM must be one of #{ALLOWED_ORMS}" unless ALLOWED_ORMS.include?(orm)
+
+      @orm = orm
+    end
+
+    def orm
+      @orm || :activerecord
+    end
+  end
+end

data/lib/outboxable/connection.rb

@@ -0,0 +1,26 @@
+require 'singleton'
+
+module Outboxable
+  class Connection
+    include ::Singleton
+    attr_reader :connection
+
+    def initialize
+      @connection = Bunny.new(
+        host: RabbitCarrots.configuration.rabbitmq_host,
+        port: RabbitCarrots.configuration.rabbitmq_port,
+        user: RabbitCarrots.configuration.rabbitmq_user,
+        password: RabbitCarrots.configuration.rabbitmq_password,
+        vhost: RabbitCarrots.configuration.rabbitmq_vhost
+      )
+
+      @connection.start
+    end
+
+    def channel
+      @channel ||= ConnectionPool.new do
+        connection.create_channel
+      end
+    end
+  end
+end

data/lib/outboxable/polling_publisher_worker.rb

@@ -0,0 +1,14 @@
+module Outboxable
+  class PollingPublisherWorker
+    include Sidekiq::Job
+    sidekiq_options queue: 'critical'
+
+    def perform
+      Outbox.pending.find_in_batches(batch_size: 100).each do |batch|
+        batch.each do |outbox|
+          Outboxable::Worker.perform_async(outbox.id)
+        end
+      end
+    end
+  end
+end

data/lib/outboxable/publishing_manager.rb

@@ -0,0 +1,10 @@
+module Outboxable
+  class PublishingManager
+    def self.publish(resource:)
+      case Outboxable.configuration.message_broker
+      when :rabbitmq
+        Outboxable::RabbitMq::Publisher.new(resource:).publish
+      end
+    end
+  end
+end

data/lib/outboxable/rabbitmq/publisher.rb

@@ -0,0 +1,37 @@
+module Outboxable
+  module RabbitMq
+    class Publisher
+      def initialize(resource:)
+        @resource = resource
+      end
+    
+      def to_envelope(resource:)
+        # throw not implemented method error
+        raise NotImplementedError, "Please implement the to_envelope method in your own module" 
+      end
+    
+      def publish
+        confirmed = nil
+    
+        Outboxable::Connection.instance.channel.with do |channel|
+          channel.confirm_select
+    
+          # Declare a exchange
+          exchange = channel.topic(@resource.exchange, durable: true)
+    
+          # Publish the CloudEvent resource to the exchange
+          exchange.publish(to_envelope(resource: @resource), routing_key: @resource.routing_key, headers: @resource.try(:headers) || {})
+    
+          # Wait for confirmation
+          confirmed = channel.wait_for_confirms
+        end
+    
+        return unless confirmed
+    
+        @resource.reload
+        @resource.increment_attempt
+        @resource.update(status: :published, retry_at: nil)
+      end
+    end
+  end
+end

data/lib/outboxable/version.rb

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

data/lib/outboxable/worker.rb

@@ -0,0 +1,9 @@
+module Outboxable
+  class Worker
+    include Sidekiq::Job
+
+    def perform(outbox_id)
+      Outboxable::PublishingManager.publish(resource: Outbox.find(outbox_id))
+    end
+  end
+end

data/lib/outboxable.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require_relative "outboxable/version"
+
+require 'outboxable/worker'
+require 'outboxable/publishing_manager'
+require 'outboxable/polling_publisher_worker'
+require 'outboxable/connection'
+require 'outboxable/configuration'
+require 'outboxable/rabbitmq/publisher'
+
+
+module Outboxable
+  class Error < StandardError; end
+  
+  extend ActiveSupport::Concern
+
+  included do
+    after_create :instantiate_outbox_for_create, if: proc { |object| object.check_outbox_condition(object:, operation: :create) }
+    after_update :instantiate_outbox_for_update, if: proc { |object| object.check_outbox_condition(object:, operation: :update) }
+
+    has_many :outboxes, as: :outboxable, autosave: false
+
+    def instantiate_outbox(routing_key: )
+      outboxes.new(
+        routing_key:,
+        exchange: Outboxable.configuration.rabbitmq_event_bus_exchange,
+        payload: as_json
+      )
+    end
+
+    def instantiate_outbox_for_create
+      routing_key = outbox_configurations[:run_on][:create]&.[](:routing_key) || "#{outbox_configurations[:base][:routing_key]}.created"
+      instantiate_outbox(routing_key:).save!
+    end
+
+    def instantiate_outbox_for_update
+      routing_key = outbox_configurations[:run_on][:update]&.[](:routing_key) || "#{outbox_configurations[:base][:routing_key]}.updated"
+      instantiate_outbox(routing_key:).save!
+    end
+
+    def check_outbox_condition(object:, operation:)
+      # Check if called on create
+      operation_is_included = object.outbox_configurations[:run_on].keys.include?(operation)
+
+      # Check if there is a supplied condition
+      supplied_condition_as_proc = object.outbox_configurations[:run_on][operation][:condition]
+
+      # Return the result of operation is included if supplied condition is blank, which mean that there is no condition to be met
+      return operation_is_included if supplied_condition_as_proc.blank?
+
+      # Else check the condition as well as the inclusion of the operation
+      operation_is_included && supplied_condition_as_proc.call(self)
+    end
+  end
+end

data/lib/templates/create_outboxable_outboxes.rb

@@ -0,0 +1,25 @@
+class CreateOutboxableOutboxes < ActiveRecord::Migration[7.0]
+  def change
+    enable_extension 'pgcrypto' unless extension_enabled?('pgcrypto')
+
+    create_table :outboxes, id: :uuid, default: 'gen_random_uuid()' do |t|
+      t.integer :status, null: false, default: 0
+
+      t.string :exchange, null: false, default: ''
+      t.string :routing_key, null: false, default: ''
+
+      t.integer  :attempts, null: false, default: 0
+      t.datetime :last_attempted_at, null: true
+      t.datetime :retry_at, null: true
+
+      t.jsonb :payload, default: {}
+      t.jsonb :headers, default: {}
+
+      t.integer :size, null: false, default: 0
+
+      t.references :outboxable, polymorphic: true, null: true 
+
+      t.timestamps
+    end
+  end
+end

data/lib/templates/initializer.rb

@@ -0,0 +1,36 @@
+# This monkey patch allows you to customize the message format that you publish to your broker. 
+# By default, Outboxable publishes a CloudEvent message to your broker.
+module Outboxable
+  module RabbitMq
+    class Publisher
+      # Override this method to customize the message format that you publish to your broker
+      # DO NOT CHANGE THE METHOD SIGNATURE
+      def to_envelope(resource:)
+        {
+          id: resource.id,
+          source: 'http://localhost:3000',
+          specversion: '1.0',
+          type: resource.routing_key,
+          datacontenttype: 'application/json',
+          data: @resource.payload
+        }.to_json
+      end
+    end
+  end
+end
+
+Outboxable.configure do |config|
+  # Specify the ORM you are using. For now, only ActiveRecord is supported.
+  config.orm = :activerecord
+
+  # Specify the message broker you are using. For now, only RabbitMQ is supported.
+  config.message_broker = :rabbitmq
+
+  # RabbitMQ configurations
+  config.rabbitmq_host = ENV.fetch('RABBITMQ__HOST')
+  config.rabbitmq_port = ENV.fetch('RABBITMQ__PORT', 5672)
+  config.rabbitmq_user = ENV.fetch('RABBITMQ__USER')
+  config.rabbitmq_password = ENV.fetch('RABBITMQ__PASSWORD')
+  config.rabbitmq_vhost = ENV.fetch('RABBITMQ__VHOST')
+  config.rabbitmq_event_bus_exchange = ENV.fetch('EVENTBUS__EXCHANGE_NAME')
+end

data/lib/templates/outbox.rb

@@ -0,0 +1,32 @@
+class Outbox < ApplicationRecord
+  attribute :allow_publish, :boolean, default: true
+
+  # Callbacks
+  after_commit :publish, if: :allow_publish?
+  before_save :check_publishing
+
+  # Enums
+  enum status: { pending: 0, published: 1, failed: 2 }
+  enum size: { single: 0, batch: 1 }
+
+  # Validations
+  validates :payload, presence: true
+  validates :exchange, presence: true
+  validates :routing_key, presence: true
+
+  # Associations
+  belongs_to :outboxable, polymorphic: true, optional: true
+
+  def increment_attempt
+    self.attempts = attempts + 1
+    self.last_attempted_at = Time.zone.now
+  end
+
+  def publish
+    Outboxable::Worker.perform_async(id)
+  end
+
+  def check_publishing
+    self.allow_publish = false if published?
+  end
+end

data/outboxable.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "lib/outboxable/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "outboxable"
+  spec.version = Outboxable::VERSION
+  spec.authors = ["Brusk Awat"]
+  spec.email = ["broosk.edogawa@gmail.com"]
+
+  spec.summary = "An opiniated Gem for Rails applications to implement the transactional outbox pattern."
+  spec.description = "The Outboxable Gem is tailored for Rails applications to implement the transactional outbox pattern. It currently only supports ActiveRecord."
+  spec.homepage = "https://githuh.com/broosk1993/outboxable"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://githuh.com/broosk1993/outboxable"
+  spec.metadata["changelog_uri"] = "https://githuh.com/broosk1993/outboxable/CHANGELOG.md"
+
+  # 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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  
+  spec.add_dependency 'bunny', '>= 2.19.0'
+  spec.add_dependency 'connection_pool', '~> 2.3.0'
+end

data/sig/outboxable.rbs

@@ -0,0 +1,4 @@
+module Outboxable
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: outboxable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brusk Awat
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-02-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bunny
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.19.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.19.0
+- !ruby/object:Gem::Dependency
+  name: connection_pool
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+description: The Outboxable Gem is tailored for Rails applications to implement the
+  transactional outbox pattern. It currently only supports ActiveRecord.
+email:
+- broosk.edogawa@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/outboxable/install_generator.rb
+- lib/outboxable.rb
+- lib/outboxable/configuration.rb
+- lib/outboxable/connection.rb
+- lib/outboxable/polling_publisher_worker.rb
+- lib/outboxable/publishing_manager.rb
+- lib/outboxable/rabbitmq/publisher.rb
+- lib/outboxable/version.rb
+- lib/outboxable/worker.rb
+- lib/templates/create_outboxable_outboxes.rb
+- lib/templates/initializer.rb
+- lib/templates/outbox.rb
+- outboxable.gemspec
+- sig/outboxable.rbs
+homepage: https://githuh.com/broosk1993/outboxable
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://githuh.com/broosk1993/outboxable
+  source_code_uri: https://githuh.com/broosk1993/outboxable
+  changelog_uri: https://githuh.com/broosk1993/outboxable/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.1
+signing_key: 
+specification_version: 4
+summary: An opiniated Gem for Rails applications to implement the transactional outbox
+  pattern.
+test_files: []