inboxable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1207d628727126924ff331738cd526e2dc676964fae984d2b53c6cf97a664418
+  data.tar.gz: 7163397c6d3bd6c90e3beca17957943dd38866d677b4c4057ddf1a14bcff9f33
+SHA512:
+  metadata.gz: a0e65af5f85b964269d7e20525754ec0ebe8152ea9e3d946480af9ad29c973756a70bbd97a4034d11eb38bc97b777e618b58daae4afc19825c99c00ec21c3e3a
+  data.tar.gz: b9da958286397e8b9fc7f165af001a5a234d4e582cf971b6fc6f21f29574078928cb12c6d6b52c99e5187c3867a540af0aca4be82e942c675c910217e8545b9f

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,131 @@
+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:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+Lint/DuplicateMethods: # Disables duplicate methods warning
+  Enabled: false
+Gemspec/RequiredRubyVersion: # Disables required ruby version warning
+  Enabled: false
+Metrics/ParameterLists: # Disables parameter lists warning
+  Enabled: false
+Lint/NextWithoutAccumulator: # Disables next without accumulator warning
+  Enabled: false
+Lint/ShadowingOuterLocalVariable: # Disables shadowing outer local variable warning
+  Enabled: false
+Metrics/ModuleLength: # Disables module length warning
+  Enabled: false
+Layout/EmptyLinesAroundClassBody: # Disables empty lines around class body warning
+  Enabled: false
+Layout/HeredocIndentation: # Disables heredoc indentation warning
+  Enabled: false
+Layout/ClosingHeredocIndentation: # Disables closing heredoc indentation warning
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-01-21
+
+- 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 hama127n@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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Muhammad Nawzad
+
+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,142 @@
+# Inboxable
+
+The Inboxable gem is an opinionated gem that implements the **Transactional Inbox** pattern for Rails applications. The gem provides support for both ActiveRecord and Mongoid. If you are using the **Transactional Outbox** pattern in your application, you can use the [Outboxable](https://github.com/ditkrg/outboxable) to handle both ends of the pattern.
+
+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.
+
+_**Note:**_ If you are not familiar with the **Transactional Outbox and Inbox** patterns, please read the following article [Microservices 101: Transactional Outbox and Inbox](https://softwaremill.com/microservices-101/) before proceeding.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'inboxable'
+```
+
+And then execute:
+
+    bundle install
+
+Or install it yourself as:
+
+    gem install inboxable
+
+## How It Works
+
+The inboxable gem uses a cron job to poll the inbox for new messages. The cron job is scheduled to run every 5 seconds by default. The cron job will fetch the messages from the inbox and process them in batches. The number of messages to be processed in each batch is 100 by default. In the event of a failure, the message will be retried up to 3 times with a delay of 5 seconds between each retry. If the message is still not processed after 3 attempts, the message will be moved to the dead letter queue. Note that all the previous values can be configured using the configuration options. (See the [Configuration](#configuration) section below for more information.)
+
+## Usage
+
+The installation command above will install the Inboxable gem and its dependencies. However, in order for Inboxable to work, you must set up your application to use Inboxable gem to process the inboxes. The following sections will show you how to set up your application to use Inboxable gem.
+
+The below command is to initialize the gem and generate the configuration file.
+
+```sh
+rails g inboxable:install --orm <orm>
+```
+
+The gem provides support for both ActiveRecord and Mongoid. The `--orm` option is used to specify the ORM that you are using in your application. The `--orm` option can be either `active_record` or `mongoid`. Here is an example of how to generate the configuration file for an application that uses ActiveRecord.
+
+```sh
+rails g inboxable:install --orm active_record
+```
+
+The above command will generate the following files:
+
+  1. `config/initializers/inboxable.rb`: This file contains the configuration for the gem. (See the [Configuration](#configuration) section below for more information.)
+  2. `app/models/inbox.rb`: This file contains the `Inbox` model. This model is used to store the messages in the inbox. (See the [Inbox Model](#inbox-model) section below for more information.)
+  3. If you are using ActiveRecord, the following migration file will be generated:
+       - `db/migrate/<timestamp>_create_inboxable_inboxes.rb`: This migration file is used to create the `inboxes` table in the database. (See the [Inbox Model](#inbox-model) section below for more information.)
+
+### Generating Handler Files & Processors
+
+The Inboxable gem provides generators that can be used to generate event handler files and processors. Here is how to generate the files.
+
+#### Generating Handler Files
+
+The following command is used to generate the handler files.
+
+```sh
+rails g inboxable:handler --handler_name <handler_name> --namespace <namespace>
+```
+
+The options are as follows:
+
+- `handler_name`: This option is used to specify the name of the handler. An example of a handler name is `user_update_handler`.
+- `namespace`: This option is used to specify the namespace for the handler class. The namespace must be in the format `<namespace1>::<namespace2>`. For example, if the namespace is `Common::UsersApi`, the handler file will be generated in the `app/handlers/common/users_api` directory.
+
+#### Generating Processor Files
+
+The following command is used to generate the processor files.
+
+```sh
+rails g inboxable:processor --processor_name <processor_name>
+```
+
+The options are as follows:
+
+- `processor_name`: This option is used to specify the name of the processor. An example of a processor name is `user_update_job`.
+
+## Inbox Model
+
+The Inbox model is used to store the messages in the inbox. The Inbox model is generated by the gem when you run the `rails g inboxable:install --orm <orm>` command. Based on the ORM that you are using, the gem will generate the appropriate model. The following is the structure of the Inbox model for ActiveRecord and Mongoid.
+
+### Fields & Attributes
+
+The Inbox model has the following fields and attributes:
+
+---
+| Field | Type | Description |
+| --- | --- | --- |
+| `route_name` | String | The routing key that is used to route the message to the appropriate handler. |
+| `postman_name` | String | The name of the postman that delivered the message. |
+| `payload` | String | The payload of the message. |
+| `event_id` | String | The ID of the event. It is used for idempotency. |
+| `attempts` | Integer | The number of attempts tried to process the message. |
+| `last_attempted_at` | Time | The time of the last attempt to process the message. |
+| `processor_class_name` | String | The name of the processor class that is used to process the message (a Sidekiq worker class). |
+| `metadata` | Hash | The metadata of the message. |
+---
+
+### Methods
+
+The Inbox model has the following methods:
+
+---
+| Method | Description |
+| --- | --- |
+| `increment_attempt` | Increments the number of attempts to process the message. |
+| `process` | Processes the message by enqueuing the processor class to Sidekiq. |
+| `check_threshold_reach` | Checks if the maximum number of attempts to process the message is reached. If so, it sets the status of the message to `failed` and stops processing the message. |
+| `check_publishing` | Checks if the message is already processed. If so, it stops processing the message. |
+---
+
+### Flow
+
+When an event is received by the Rails application, the Handler class should ensure that this message is delivered to the inbox by creating a new record in the inbox. After the record is created, the Inbox model tries to process **once** the job by enqueuing the processor class to Sidekiq. If the job fails, the `Inboxable::PollingReceiverWorker` will retry the job up to 3 times with a delay of 5 seconds between each retry. If the job is still not processed after 3 attempts, the job will be moved to the dead letter queue.
+
+## Configuration
+
+The Inboxable gem provides a number of configuration options that can be used to customize the behavior of the gem. The following is a list of the configuration options that are available.
+
+---
+| Option | Description | Default Value    | Applied To                                           |
+| --- | --- |------------------|---|
+| `orm` | The ORM that is used in the application. | `:active_record` | `/config/initializers/inboxable.rb`                  |
+|`INBOXABLE__CRON_POLL_INTERVAL` | The interval in seconds between each poll of the inbox. | `5`              | Can be overridden by providing an environment variable with the same name. |
+|`INBOXABLE__CRON` | The cron expression that is used to poll the inbox. | `*/5 * * * * *`  | Can be overridden by providing an environment variable with the same name. |
+|`INBOXABLE__BATCH_SIZE` | The number of messages to be processed in each batch. | `100`            | Can be overridden by providing an environment variable with the same name. |
+|`INBOXABLE__MAX_ATTEMPTS` | The maximum number of attempts to process a message. | `3`              | Can be overridden by providing an environment variable with the same name. |
+|`INBOXABLE__RETRY_DELAY_IN_SECONDS` | The delay in seconds before retrying to process a message. | `5`              | Can be overridden by providing an environment variable with the same name. |
+---
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at <https://github.com/[USERNAME]/inboxable>. This project is intended to be a safe, welcoming space for collaboration, and contributors. Please go to issues page to report any bugs or feature requests. If you would like to contribute, please fork the repository and submit a pull request.
+
+To, use the gem locally, clone the repository and run `bundle install` to install dependencies. Then, run `bundle exec rspec` to run the tests.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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/inboxable.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative 'lib/inboxable/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'inboxable'
+  spec.version = Inboxable::VERSION
+  spec.authors = ['Muhammad Nawzad']
+  spec.email = ['hama127n@gmail.com']
+
+  spec.summary = 'An opiniated Gem for Rails applications to implement the transactional inbox pattern.'
+  spec.description = 'An opiniated Gem for Rails applications to implement the transactional inbox pattern.'
+
+  spec.homepage = 'https://github.com/muhammadnawzad/inboxable'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 3.0.0'
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/muhammadnawzad/inboxable'
+  spec.metadata['changelog_uri'] = 'https://github.com/muhammadnawzad/inboxable/blob/main/CHANGELOG.md'
+
+  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 .github appveyor Gemfile])
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.metadata['rubygems_mfa_required'] = 'true'
+end

data/lib/generators/inboxable/handler_generator.rb

@@ -0,0 +1,74 @@
+module Inboxable
+  class HandlerGenerator < Rails::Generators::Base
+
+    source_root File.expand_path('../../templates', __dir__)
+    class_option :handler_name, type: :string, default: 'Handler', desc: 'Class name for the handler'
+    class_option :namespace, type: :string, default: 'Namespace', desc: 'Namespace directory for the handler'
+    attr_reader :nested_namespace
+
+    def initialize(*args)
+      super(*args)
+
+      @handler_name = options[:handler_name]
+      @handler_name != 'Handler' || raise('Handler name is required')
+
+      @namespace = options[:namespace].classify.to_s
+      @namespace != 'Namespace' || raise('Namespace is required')
+
+      @nested_namespace = @namespace.include?('::')
+    end
+
+    def determine_target_path
+      base_path = 'app/services/event_handlers'
+
+      if @nested_namespace
+        @namespace.split('::').each do |namespace|
+          base_path = "#{base_path}/#{namespace.underscore.downcase}"
+        end
+
+        "#{base_path}/#{@handler_name}"
+      else
+        "#{base_path}/#{@namespace.underscore.downcase}/#{@handler_name.underscore.downcase}.rb"
+      end
+    end
+
+    def copy_initializer
+      target_path = determine_target_path
+
+      if Rails.root.join(target_path).exist?
+        say_status('skipped', 'Handler already exists')
+      else
+
+        create_file(target_path, <<-FILE
+module EventHandlers::#{@namespace}
+  class #{@handler_name.classify}
+    def processor_class_name
+      raise NotImplementedError # e.g. 'Processors::ExampleUpdateJob'
+    end
+
+    def self.handle!(_channel, delivery_info, properties, payload)
+      raise ::RabbitCarrots::EventHandlers::Errors::NackMessage if payload.blank?
+
+      begin
+        Inbox.create!(
+          route_name: delivery_info.routing_key,
+          postman_name: delivery_info&.consumer&.queue&.name,
+          payload:,
+          event_id: JSON.parse(payload)['id'],
+          status: :pending,
+          processor_class_name:, # TODO: change this
+          metadata: properties[:headers]
+        )
+
+      rescue ActiveRecord::RecordNotUnique
+        true
+      end
+    end
+  end
+end
+              FILE
+        )
+      end
+    end
+  end
+end

data/lib/generators/inboxable/install_generator.rb

@@ -0,0 +1,49 @@
+module Inboxable
+  class InstallGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    source_root File.expand_path('../../templates', __dir__)
+    class_option :orm, type: :string, default: 'activerecord'
+
+    def initialize(*args)
+      super(*args)
+
+      @orm = options[:orm] || 'activerecord'
+      %w[activerecord mongoid].include?(@orm) || raise(ArgumentError, 'Invalid ORM. Only ActiveRecord and Mongoid are supported.')
+    end
+
+    # Copy initializer into user app
+    def copy_initializer
+      copy_file('activerecord_initializer.rb', 'config/initializers/z_inboxable.rb') if @orm == 'activerecord'
+      copy_file('mongoid_initializer.rb', 'config/initializers/z_inboxable.rb') if @orm == 'mongoid'
+    end
+
+    # Copy user information (model & Migrations) into user app
+    def create_user_model
+      target_path = 'app/models/inbox.rb'
+
+      if Rails.root.join(target_path).exist?
+        say_status('skipped', 'Model inbox already exists')
+      else
+        template('activerecrod_inbox.rb', target_path) if @orm == 'activerecord'
+        template('mongoid_inbox.rb', target_path) if @orm == 'mongoid'
+      end
+    end
+
+    # Copy migrations
+    def copy_migrations
+      return if @orm == 'mongoid'
+
+      if self.class.migration_exists?('db/migrate', 'create_inboxable_inboxes')
+        say_status('skipped', 'Migration create_inboxable_inboxes already exists')
+      else
+        migration_template('create_inboxable_inboxes.rb', 'db/migrate/create_inboxable_inboxes.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/generators/inboxable/processor_generator.rb

@@ -0,0 +1,49 @@
+module Inboxable
+  class ProcessorGenerator < Rails::Generators::Base
+
+    source_root File.expand_path('../../templates', __dir__)
+    class_option :processor_name, type: :string, default: 'Processor', desc: 'Class name for the processor'
+
+    def initialize(*args)
+      super(*args)
+
+      @processor_name = options[:processor_name].classify.to_s
+      @processor_name != 'Processor' || raise('Processor name is required')
+    end
+
+    def copy_initializer
+      target_path = "app/sidekiq/processors/#{@processor_name.underscore.downcase}.rb"
+
+      if Rails.root.join(target_path).exist?
+        say_status('skipped', 'Processor already exists')
+      else
+
+        create_file(target_path, <<-FILE
+module Processors
+  class #{@processor_name}
+    include Sidekiq::Job
+
+    def resource_model
+      raise NotImplementedError # e.g. User
+    end
+
+    def perform(id)
+      resource = Inbox.find(id)
+
+      return if resource.processed?
+
+      payload = JSON.parse(resource.payload)['data']
+
+      resource_model.where(id: payload['id']).where('version < :version', version: payload['version']).update_all(
+        version: payload['version']
+        # TODO: add other attributes
+      )
+    end
+  end
+end
+              FILE
+        )
+      end
+    end
+  end
+end

data/lib/inboxable/configuration.rb

@@ -0,0 +1,27 @@
+module Inboxable
+  class Configuration
+    ALLOWED_ORMS = %i[activerecord mongoid].freeze
+
+    attr_accessor :orm
+
+    def initialize
+      raise Error, 'Sidekiq is not available. Unfortunately, sidekiq must be available for Inboxable to work' unless Object.const_defined?('Sidekiq')
+      raise Error, 'Inboxable Gem uses the sidekiq-cron Gem. Make sure you add it to your project' unless Object.const_defined?('Sidekiq::Cron')
+      raise Error, 'Inboxable Gem only supports Rails but you application does not seem to be a Rails app' unless Object.const_defined?('Rails')
+      raise Error, 'Inboxable Gem only support Rails version 7 and newer' if Rails::VERSION::MAJOR < 7
+
+      Sidekiq::Options[:cron_poll_interval] = ENV.fetch('INBOXABLE__CRON_POLL_INTERVAL', 5).to_i
+      Sidekiq::Cron::Job.create(name: 'InboxablePollingReceiver', cron: ENV.fetch('INBOXABLE__CRON', '*/5 * * * * *'), class: 'Inboxable::PollingReceiverWorker')
+    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/inboxable/polling_receiver_worker.rb

@@ -0,0 +1,35 @@
+require 'sidekiq'
+
+module Inboxable
+  class PollingReceiverWorker
+    include Sidekiq::Job
+
+    def perform
+      Inboxable.configuration.orm == :activerecord ? perform_activerecord : perform_mongoid
+    end
+
+    def perform_activerecord
+      Inbox.pending
+           .where(last_attempted_at: [..Time.zone.now, nil])
+           .find_in_batches(batch_size: ENV.fetch('INBOXABLE__BATCH_SIZE', 100).to_i)
+           .each do |batch|
+        batch.each do |inbox|
+          inbox.processor_class_name.constantize.perform_async(inbox.id)
+          inbox.update(last_attempted_at: 1.minute.from_now, status: :processed, allow_processing: false)
+        end
+      end
+    end
+
+    def perform_mongoid
+      batch_size = ENV.fetch('INBOXABLE__BATCH_SIZE', 100).to_i
+      Inbox.pending
+           .any_of({ last_attempted_at: ..Time.zone.now }, { last_attempted_at: nil })
+           .each_slice(batch_size) do |batch|
+        batch.each do |inbox|
+          inbox.processor_class_name.constantize.perform_async(inbox.id.to_s)
+          inbox.update(last_attempted_at: 1.minute.from_now, status: :processed, allow_processing: false)
+        end
+      end
+    end
+  end
+end

data/lib/inboxable/version.rb

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

data/lib/inboxable.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative 'inboxable/version'
+require_relative 'inboxable/configuration'
+require_relative 'inboxable/polling_receiver_worker'
+
+module Inboxable
+  class Error < StandardError; end
+
+  class << self
+    attr_accessor :configuration
+
+    def configure
+      @configuration ||= Configuration.new
+      yield(@configuration) if block_given?
+    end
+  end
+end

data/lib/templates/activerecord_initializer.rb

@@ -0,0 +1,3 @@
+Inboxable.configure do |config|
+  config.orm = :activerecord
+end

data/lib/templates/activerecrod_inbox.rb

@@ -0,0 +1,30 @@
+class Inbox < ApplicationRecord
+  attribute :allow_processing, :boolean, default: true
+
+  # Callbacks
+  after_commit :process, if: :allow_processing?
+
+  # Scopes and Enums
+  enum status: { pending: 0, processed: 1, failed: 2 }
+
+  def increment_attempt
+    self.attempts = attempts + 1
+    self.last_attempted_at = Time.zone.now
+  end
+
+  def process
+    processor_class_name.constantize.perform_async(id)
+  end
+
+  def check_threshold_reach
+    return if attempts < ENV.fetch('INBOXABLE__MAX_ATTEMPTS', 3)&.to_i
+
+    self.retry_at = Time.zone.now + ENV.fetch('INBOXABLE__RETRY_DELAY_IN_SECONDS', 5)&.to_i&.seconds
+    self.status = :failed
+    self.allow_processing = false
+  end
+
+  def check_publishing
+    self.allow_processing = false if processed?
+  end
+end

data/lib/templates/create_inboxable_inboxes.rb

@@ -0,0 +1,20 @@
+class CreateInboxableInboxes < ActiveRecord::Migration[7.0]
+  def change
+    create_table :inboxes do |t|
+      t.string :route_name,   null: false, default: '', index: true
+      t.string :postman_name, null: false, default: ''
+      t.text :payload, null: true
+
+      t.string :event_id, null: false, default: '', index: { unique: true }
+      t.integer :status, null: false, default: 0
+
+      t.integer  :attempts, null: false, default: 0
+      t.datetime :last_attempted_at, null: true
+
+      t.string :processor_class_name, null: false, default: ''
+      t.jsonb :metadata, default: {}
+
+      t.timestamps
+    end
+  end
+end

data/lib/templates/mongoid_inbox.rb

@@ -0,0 +1,46 @@
+class Inbox
+  include Mongoid::Document
+  include Mongoid::Timestamps
+  include SimpleEnum::Mongoid
+
+  field :route_name, type: String
+  field :postman_name, type: String
+  field :payload, type: String
+  field :event_id, type: String
+  field :attempts, type: Integer, default: 0
+  field :last_attempted_at, type: Time
+  field :processor_class_name, type: String
+  field :metadata, type: Hash, default: {}
+
+  # Indexes
+  index({ event_id: 1 }, unique: true)
+
+  attr_accessor :allow_processing
+
+  as_enum :status, %i[pending processed failed], field: { type: String, default: 'pending' }, map: :string
+
+  validates :processor_class_name, presence: true
+
+  after_create :process, if: proc { |resource| resource.allow_processing == true }
+
+  def increment_attempt
+    self.attempts = attempts + 1
+    self.last_attempted_at = Time.zone.now
+  end
+
+  def process
+    processor_class_name.constantize.perform_async(id.to_s)
+  end
+
+  def check_threshold_reach
+    return if attempts < ENV.fetch('INBOXABLE__MAX_ATTEMPTS', 3)&.to_i
+
+    self.retry_at = Time.zone.now + ENV.fetch('INBOXABLE__RETRY_DELAY_IN_SECONDS', 5)&.to_i&.seconds
+    self.status = :failed
+    self.allow_processing = false
+  end
+
+  def check_publishing
+    self.allow_processing = false if processed?
+  end
+end

data/lib/templates/mongoid_initializer.rb

@@ -0,0 +1,3 @@
+Inboxable.configure do |config|
+  config.orm = :mongoid
+end

data/sig/inboxable/configuration.rbs

@@ -0,0 +1,10 @@
+module Inboxable
+  class Configuration
+    ALLOWED_ORMS: Array[Symbol]
+    attr_accessor orm: Symbol
+
+    def initialize: -> void
+    def orm=: (Symbol) -> Symbol
+    def orm: -> Symbol
+  end
+end

data/sig/inboxable/polling_receiver_worker.rbs

@@ -0,0 +1,7 @@
+module Inboxable
+  class PollingReceiverWorker
+    def initialize: -> void
+    def perform: -> void
+    def perform_activerecord: -> void
+  end
+end

data/sig/inboxable.rbs

@@ -0,0 +1,5 @@
+module Inboxable
+  VERSION: String
+  attr_accessor configuration: Configuration
+  def self.configure: () { (Configuration) -> Configuration } -> Configuration
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: inboxable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Muhammad Nawzad
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-01-22 00:00:00.000000000 Z
+dependencies: []
+description: An opiniated Gem for Rails applications to implement the transactional
+  inbox pattern.
+email:
+- hama127n@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- inboxable.gemspec
+- lib/generators/inboxable/handler_generator.rb
+- lib/generators/inboxable/install_generator.rb
+- lib/generators/inboxable/processor_generator.rb
+- lib/inboxable.rb
+- lib/inboxable/configuration.rb
+- lib/inboxable/polling_receiver_worker.rb
+- lib/inboxable/version.rb
+- lib/templates/activerecord_initializer.rb
+- lib/templates/activerecrod_inbox.rb
+- lib/templates/create_inboxable_inboxes.rb
+- lib/templates/mongoid_inbox.rb
+- lib/templates/mongoid_initializer.rb
+- sig/inboxable.rbs
+- sig/inboxable/configuration.rbs
+- sig/inboxable/polling_receiver_worker.rbs
+homepage: https://github.com/muhammadnawzad/inboxable
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/muhammadnawzad/inboxable
+  source_code_uri: https://github.com/muhammadnawzad/inboxable
+  changelog_uri: https://github.com/muhammadnawzad/inboxable/blob/main/CHANGELOG.md
+  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: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.4
+signing_key:
+specification_version: 4
+summary: An opiniated Gem for Rails applications to implement the transactional inbox
+  pattern.
+test_files: []