outboxer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a573b50b1f20cc0966a9c6baef36216240ab20adee17adcf03da8a193436bf78
+  data.tar.gz: 86573195530a94aac112fd0c52169a7564e97f0e677ba03c26d37b87e8eb7c02
+SHA512:
+  metadata.gz: edd4bc1e08e57f742985e8382fa1202ee6df3812282f9b0d12054cce63406fb9a7101fa6a53d93f85205faf31ae324b35c3254c9ab586865959cdd1a2ccfe951
+  data.tar.gz: 5d5196f1bdcadb519720c4d80b01852d9463f1d5844a90bd8447d392675b17357adae4deb4088b8210ea65f0ab4555707b0affee69aac20b0832b5ff0505b77a

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,229 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.6
+  SuggestExtensions: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 100
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 60
+
+Layout/MultilineMethodCallBraceLayout:
+  EnforcedStyle: same_line
+
+Naming/RescuedExceptionsVariableName:
+  PreferredName: exception
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Gemspec/DeprecatedAttributeAssignment: # new in 1.30
+  Enabled: true
+Gemspec/DevelopmentDependencies: # new in 1.44
+  Enabled: true
+Gemspec/RequireMFA: # new in 1.23
+  Enabled: true
+Layout/LineContinuationLeadingSpace: # new in 1.31
+  Enabled: true
+Layout/LineContinuationSpacing: # new in 1.31
+  Enabled: true
+Layout/LineEndStringConcatenationIndentation: # new in 1.18
+  Enabled: true
+Layout/SpaceBeforeBrackets: # new in 1.7
+  Enabled: true
+Lint/AmbiguousAssignment: # new in 1.7
+  Enabled: true
+Lint/AmbiguousOperatorPrecedence: # new in 1.21
+  Enabled: true
+Lint/AmbiguousRange: # new in 1.19
+  Enabled: true
+Lint/ConstantOverwrittenInRescue: # new in 1.31
+  Enabled: true
+Lint/DeprecatedConstants: # new in 1.8
+  Enabled: true
+Lint/DuplicateBranch: # new in 1.3
+  Enabled: true
+Lint/DuplicateMagicComment: # new in 1.37
+  Enabled: true
+Lint/DuplicateMatchPattern: # new in 1.50
+  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/EmptyInPattern: # new in 1.16
+  Enabled: true
+Lint/IncompatibleIoSelectWithFiberScheduler: # new in 1.21
+  Enabled: true
+Lint/LambdaWithoutLiteralBlock: # new in 1.8
+  Enabled: true
+Lint/MixedCaseRange: # new in 1.53
+  Enabled: true
+Lint/NoReturnInBeginEndBlocks: # new in 1.2
+  Enabled: true
+Lint/NonAtomicFileOperation: # new in 1.31
+  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/RedundantRegexpQuantifiers: # new in 1.53
+  Enabled: true
+Lint/RefinementImportMethods: # new in 1.27
+  Enabled: true
+Lint/RequireRangeParentheses: # new in 1.32
+  Enabled: true
+Lint/RequireRelativeSelfPath: # new in 1.22
+  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
+Lint/UselessRescue: # new in 1.43
+  Enabled: true
+Lint/UselessRuby2Keywords: # new in 1.23
+  Enabled: true
+Metrics/CollectionLiteralLength: # new in 1.47
+  Enabled: true
+Naming/BlockForwarding: # new in 1.24
+  Enabled: true
+Security/CompoundHash: # new in 1.28
+  Enabled: true
+Security/IoMethods: # new in 1.22
+  Enabled: true
+Style/ArgumentsForwarding: # new in 1.1
+  Enabled: true
+Style/ArrayIntersect: # new in 1.40
+  Enabled: true
+Style/CollectionCompact: # new in 1.2
+  Enabled: true
+Style/ComparableClamp: # new in 1.44
+  Enabled: true
+Style/ConcatArrayLiterals: # new in 1.41
+  Enabled: true
+Style/DataInheritance: # new in 1.49
+  Enabled: true
+Style/DirEmpty: # new in 1.48
+  Enabled: true
+Style/DocumentDynamicEvalDefinition: # new in 1.1
+  Enabled: true
+Style/EmptyHeredoc: # new in 1.32
+  Enabled: true
+Style/EndlessMethod: # new in 1.8
+  Enabled: true
+Style/EnvHome: # new in 1.29
+  Enabled: true
+Style/ExactRegexpMatch: # new in 1.51
+  Enabled: true
+Style/FetchEnvVar: # new in 1.28
+  Enabled: true
+Style/FileEmpty: # new in 1.48
+  Enabled: true
+Style/FileRead: # new in 1.24
+  Enabled: true
+Style/FileWrite: # new in 1.24
+  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/InPatternThen: # new in 1.16
+  Enabled: true
+Style/MagicCommentFormat: # new in 1.35
+  Enabled: true
+Style/MapCompactWithConditionalBlock: # new in 1.30
+  Enabled: true
+Style/MapToHash: # new in 1.24
+  Enabled: true
+Style/MapToSet: # new in 1.42
+  Enabled: true
+Style/MinMaxComparison: # new in 1.42
+  Enabled: true
+Style/MultilineInPatternThen: # new in 1.16
+  Enabled: true
+Style/NegatedIfElseCondition: # new in 1.2
+  Enabled: true
+Style/NestedFileDirname: # new in 1.26
+  Enabled: true
+Style/NilLambda: # new in 1.3
+  Enabled: true
+Style/NumberedParameters: # new in 1.22
+  Enabled: true
+Style/NumberedParametersLimit: # new in 1.22
+  Enabled: true
+Style/ObjectThen: # new in 1.28
+  Enabled: true
+Style/OpenStructUse: # new in 1.23
+  Enabled: true
+Style/OperatorMethodCall: # new in 1.37
+  Enabled: true
+Style/QuotedSymbols: # new in 1.16
+  Enabled: true
+Style/RedundantArgument: # new in 1.4
+  Enabled: true
+Style/RedundantArrayConstructor: # new in 1.52
+  Enabled: true
+Style/RedundantConstantBase: # new in 1.40
+  Enabled: true
+Style/RedundantCurrentDirectoryInPath: # new in 1.53
+  Enabled: true
+Style/RedundantDoubleSplatHashBraces: # new in 1.41
+  Enabled: true
+Style/RedundantEach: # new in 1.38
+  Enabled: true
+Style/RedundantFilterChain: # new in 1.52
+  Enabled: true
+Style/RedundantHeredocDelimiterQuotes: # new in 1.45
+  Enabled: true
+Style/RedundantInitialize: # new in 1.27
+  Enabled: true
+Style/RedundantLineContinuation: # new in 1.49
+  Enabled: true
+Style/RedundantRegexpArgument: # new in 1.53
+  Enabled: true
+Style/RedundantRegexpConstructor: # new in 1.52
+  Enabled: true
+Style/RedundantSelfAssignmentBranch: # new in 1.19
+  Enabled: true
+Style/RedundantStringEscape: # new in 1.37
+  Enabled: true
+Style/ReturnNilInPredicateMethodDefinition: # new in 1.53
+  Enabled: true
+Style/SelectByRegexp: # new in 1.22
+  Enabled: true
+Style/StringChars: # new in 1.12
+  Enabled: true
+Style/SwapValues: # new in 1.1
+  Enabled: true
+Style/YAMLFileRead: # new in 1.53
+  Enabled: true

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-07-30
+
+- 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. 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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Adam Mikulasev
+
+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,76 @@
+# Outboxer
+
+Creating a message in an SQL database and publishing it to redis via a sidekiq worker are two operations that cannot be combined into a single atomic operation. If either database fails, inconsistencies can occur.
+
+In Outboxer, when a new message is created in your application's SQL database, Outboxer automatically creates a message in an outbox table with a status of 'unpublished', within the same local transaction. This ensures that either both operations succeed or both fail, preserving atomicity.
+
+## Installation
+
+1. Add the Outboxer gem to your application's Gemfile:
+
+```ruby
+gem 'outboxer'
+```
+
+2. Install the Outboxer gem:
+
+```bash
+bundle install
+```
+
+3. Generate the migration and publisher files
+
+```bash
+bin/rails generate outboxer:install
+```
+
+## Usage
+
+### 1. Migrate your database
+
+```bash
+bin/rake db:migrate
+```
+
+
+### 2. Include Outboxer into existing model
+
+First, include `Outboxer::Outboxable` into your existing `Message` model:
+
+```ruby
+class Message < ApplicationRecord
+  include Outboxer::Outboxable
+end
+```
+
+### 3. Update the publish block
+
+By default, the `bin/publisher` script does not do anything with the message in its block.
+
+To customize this behavior, you should update the block in the `bin/publisher` file:
+
+```ruby
+Outboxer::Publisher.publish do |message:, logger:|
+  Worker.perform_async({ message_id: message.id })
+end
+```
+
+### 3. Run the Publisher
+
+To start publishing messages, run the `bin/publisher` script:
+
+```bash
+bin/publisher
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/fast-programmer/outboxer. 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/fast-programmer/outboxer/blob/main/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 Outboxer project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/fast-programmer/outboxer/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+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/generators/outboxer/install_generator.rb

@@ -0,0 +1,30 @@
+module Outboxer
+  class InstallGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    source_root File.expand_path("templates", __dir__)
+
+    def self.next_migration_number(dirname)
+      next_number = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+
+      next_number += 1 while Dir.glob("#{dirname}/#{next_number}*").any?
+
+      next_number.to_s
+    end
+
+    def copy_bin_file
+      template "bin/publisher.rb", "bin/publisher"
+      run "chmod +x bin/publisher"
+    end
+
+    def copy_migrations
+      migration_template(
+        "migrations/create_outboxer_messages.rb",
+        "db/migrate/create_outboxer_messages.rb")
+
+      migration_template(
+        "migrations/create_outboxer_exceptions.rb",
+        "db/migrate/create_outboxer_exceptions.rb")
+    end
+  end
+end

data/generators/outboxer/templates/bin/publisher.rb

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require_relative "../config/environment"
+
+Outboxer::Publisher.publish do |args|
+  # Worker.perform_async({ message_id: args.message.id })
+end

data/generators/outboxer/templates/migrations/create_outboxer_exceptions.rb

@@ -0,0 +1,15 @@
+class CreateOutboxerExceptions < ActiveRecord::Migration[6.1]
+  def change
+    create_table :outboxer_exceptions do |t|
+      t.references :message, null: false, foreign_key: { to_table: :outboxer_messages }
+
+      t.text :class_name, null: false
+      t.text :message_text, null: false
+      t.column :backtrace, :text, array: true
+
+      t.timestamps
+    end
+
+    remove_column :outboxer_exceptions, :updated_at
+  end
+end

data/generators/outboxer/templates/migrations/create_outboxer_messages.rb

@@ -0,0 +1,13 @@
+class CreateOutboxerMessages < ActiveRecord::Migration[6.1]
+  def change
+    create_table :outboxer_messages do |t|
+      t.references :message, polymorphic: true, null: false
+      t.text :status, null: false
+
+      t.timestamps
+    end
+
+    add_index :outboxer_messages, %i[status created_at]
+    add_index :outboxer_messages, %i[message_type message_id], unique: true
+  end
+end

data/lib/outboxer/models/exception.rb

@@ -0,0 +1,11 @@
+require "active_record"
+
+module Outboxer
+  module Models
+    class Exception < ::ActiveRecord::Base
+      self.table_name = :outboxer_exceptions
+
+      belongs_to :message, class_name: "::Outboxer::Models::Message"
+    end
+  end
+end

data/lib/outboxer/models/message.rb

@@ -0,0 +1,20 @@
+require "active_record"
+
+module Outboxer
+  module Models
+    class Message < ::ActiveRecord::Base
+      self.table_name = :outboxer_messages
+
+      STATUS = {
+        unpublished: "unpublished",
+        publishing: "publishing",
+        failed: "failed"
+      }.freeze
+
+      belongs_to :message, polymorphic: true
+
+      has_many :exceptions, -> { order(created_at: :asc) },
+               class_name: "::Outboxer::Models::Exception"
+    end
+  end
+end

data/lib/outboxer/models/outboxable.rb

@@ -0,0 +1,23 @@
+module Outboxer
+  module Models
+    module Outboxable
+      def self.included(base)
+        base.extend ClassMethods
+
+        base.class_eval do
+          has_one :message, class_name: "Outboxer::Models::Message", as: :outbox_message,
+                            dependent: :destroy
+
+          after_create :create_outbox_message!
+        end
+      end
+
+      def create_outbox_message!
+        Models::Message.create!(message: self, status: Models::Message::STATUS[:unpublished])
+      end
+
+      module ClassMethods
+      end
+    end
+  end
+end

data/lib/outboxer/publisher.rb

@@ -0,0 +1,113 @@
+require "logger"
+
+module Outboxer
+  module Publisher
+    module_function
+
+    @publishing = false
+    @logger = Logger.new($stdout)
+
+    Args = Struct.new(:message, :logger)
+
+    def publish(poll: 1, backoff: ->(current_backoff) { [current_backoff * 2, 5 * 60].min })
+      @publishing = true
+
+      ActiveRecord::Base.connection_pool.with_connection do
+        while @publishing
+          outboxer_message = dequeue(backoff: backoff)
+
+          if outboxer_message.nil?
+            sleep poll
+
+            next
+          end
+
+          begin
+            yield Args.new(outboxer_message.message, @logger)
+          rescue StandardError => exception
+            failed(
+              outboxer_message: outboxer_message,
+              backoff: backoff,
+              exception: exception)
+
+            next
+          end
+
+          published(
+            outboxer_message: outboxer_message,
+            backoff: backoff)
+        end
+      end
+    end
+
+    def dequeue(backoff:)
+      retry_on_error(backoff: backoff) do
+        ActiveRecord::Base.transaction do
+          message = Models::Message
+            .where(status: Models::Message::STATUS[:unpublished])
+            .order(created_at: :asc)
+            .limit(1)
+            .lock("FOR UPDATE SKIP LOCKED")
+            .first
+
+          message&.update!(status: Models::Message::STATUS[:publishing])
+
+          message
+        end
+      end
+    end
+
+    def published(outboxer_message:, backoff:)
+      retry_on_error(backoff: backoff) do
+        outboxer_message.destroy!
+      end
+    end
+
+    def failed(outboxer_message:, exception:, backoff:)
+      @logger.error(
+        "Exception raised: #{exception.class}: #{exception.message}\n" \
+        "#{exception.backtrace.join("\n")}")
+
+      retry_on_error(backoff: backoff) do
+        ActiveRecord::Base.transaction do
+          outboxer_message.update!(status: Models::Message::STATUS[:failed])
+
+          outboxer_message.exceptions.create!(
+            class_name: exception.class.name,
+            message_text: exception.message,
+            backtrace: exception.backtrace)
+        end
+      end
+    end
+
+    def retry_on_error(backoff:, &block)
+      current_backoff = 1
+
+      begin
+        block.call
+      rescue StandardError => exception
+        @logger.fatal(
+          "Exception raised: #{exception.class}: #{exception.message}\n" \
+          "#{exception.backtrace.join("\n")}")
+
+        raise exception unless @publishing
+
+        sleep current_backoff
+
+        current_backoff = backoff.call(current_backoff)
+
+        retry
+      end
+    end
+
+    def stop
+      @publishing = false
+    end
+
+    Signal.trap("TERM") do
+      @logger.info("Received SIGTERM, stopping...")
+
+      stop
+    end
+  end
+end

data/lib/outboxer/railtie.rb

@@ -0,0 +1,12 @@
+require "outboxer"
+require "rails"
+
+module Outboxer
+  class Railtie < Rails::Railtie
+    railtie_name :outboxer
+
+    generators do
+      require_relative "../../generators/outboxer/install_generator"
+    end
+  end
+end

data/lib/outboxer/version.rb

@@ -0,0 +1,3 @@
+module Outboxer
+  VERSION = "0.1.0".freeze
+end

data/lib/outboxer.rb

@@ -0,0 +1,13 @@
+require "active_support"
+
+require_relative "outboxer/version"
+require_relative "outboxer/railtie" if defined?(Rails)
+require_relative "outboxer/models/outboxable"
+require_relative "outboxer/models/message"
+require_relative "outboxer/models/exception"
+
+require_relative "outboxer/publisher"
+
+module Outboxer
+  Outboxable = Models::Outboxable
+end

data/outboxer.gemspec

@@ -0,0 +1,33 @@
+# rubocop:disable Layout/LineLength
+require_relative "lib/outboxer/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "outboxer"
+  spec.version = Outboxer::VERSION
+  spec.authors = ["Adam Mikulasev"]
+  spec.email = ["adam@fastprogrammer.co"]
+
+  spec.summary = "Transactional outbox implementation for event driven Ruby on Rails applications that use SQL"
+  spec.homepage = "https://github.com/fast-programmer/outboxer"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/fast-programmer/outboxer"
+  # spec.metadata["changelog_uri"] = "Put your gem's CHANGELOG.md URL here."
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord", "~> 7.0"
+  spec.add_dependency "pg", "~> 1.5"
+end
+# rubocop:enable Layout/LineLength

data/sig/outboxer.rbs

@@ -0,0 +1,19 @@
+module Outboxer
+  VERSION: String
+  
+  module Publisher
+    class Args
+      attr_reader message: untyped
+      attr_reader logger: Logger
+      
+      def initialize: (untyped message, Logger logger) -> void
+    end
+  
+    def self.publish: (?Integer poll, ?Proc[Integer, Integer] backoff) { (Args) -> untyped } -> void
+    def self.dequeue: ({ backoff: Proc[Integer, Integer] }) -> untyped
+    def self.published: ({ outboxer_message: untyped, backoff: Proc[Integer, Integer] }) -> void
+    def self.failed: ({ outboxer_message: untyped, exception: Exception, backoff: Proc[Integer, Integer] }) -> void
+    def self.retry_on_error: ({ backoff: Proc[Integer, Integer] }) { () -> untyped } -> untyped
+    def self.stop: () -> void
+  end
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: outboxer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adam Mikulasev
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-08-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+description:
+email:
+- adam@fastprogrammer.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- generators/outboxer/install_generator.rb
+- generators/outboxer/templates/bin/publisher.rb
+- generators/outboxer/templates/migrations/create_outboxer_exceptions.rb
+- generators/outboxer/templates/migrations/create_outboxer_messages.rb
+- lib/outboxer.rb
+- lib/outboxer/models/exception.rb
+- lib/outboxer/models/message.rb
+- lib/outboxer/models/outboxable.rb
+- lib/outboxer/publisher.rb
+- lib/outboxer/railtie.rb
+- lib/outboxer/version.rb
+- outboxer.gemspec
+- sig/outboxer.rbs
+homepage: https://github.com/fast-programmer/outboxer
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/fast-programmer/outboxer
+  source_code_uri: https://github.com/fast-programmer/outboxer
+  rubygems_mfa_required: 'true'
+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.1.6
+signing_key:
+specification_version: 4
+summary: Transactional outbox implementation for event driven Ruby on Rails applications
+  that use SQL
+test_files: []