outboxable 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1d338ac197df1adcd420ef12703e96615086f8cc7a0062b72f11deaaec68666
-  data.tar.gz: 8af422939a04418b12fdb66701b310d49399ba12c974cbeb7718c91b2975760a
+  metadata.gz: 469a8e0dea372c23c827c4bff24fecaed9f4c2921f4d40de8fdbed7225dbd52e
+  data.tar.gz: 17bd59884f0a7385ae7557b76192ba08aa81e1cd9441730e71dd1bb426a9f60f
 SHA512:
-  metadata.gz: 4fa5c959e651053d21bc817f58e93ed9d5b58badf44abda041308de7b5be2f17a380bf1656095ad5fde6d9e55cf5c54e241b8fb91980ca800570d2d2028ab6f3
-  data.tar.gz: 90f310a90f39dcebce8ae111aaeec53db9ea056d5e995763a58380e904ad6c17152696af05299db7a087fa55d37f8fe219c141395d12b520fe433f733eb4f279
+  metadata.gz: 1419c8437e010866124d4f3bb2edbb126475f4e9c2647f68facbb565dde6c48e2b86eb457716b16fa895d035be0f9954067b30fc79ffeebd8dcebfe275c0fa2e
+  data.tar.gz: 747042c4e73e79cf0fc114c003f0c8a3499cfcf705f2fcdf98396d211313163048be1e42d71e5cfc2ea65ce34ccda54958eb485b191bd2957a4ff2f057457263

data/.rubocop.yml

@@ -5,7 +5,7 @@ AllCops:
   SuggestExtensions: false
 Layout/SpaceBeforeBrackets: # (new in 1.7)
   Enabled: true
-Layout/LineLength: 
+Layout/LineLength:
   Max: 350
 Lint/AmbiguousAssignment: # (new in 1.7)
   Enabled: true
@@ -110,4 +110,8 @@ Metrics/MethodLength:
 Metrics/CyclomaticComplexity:
   Max: 15
 Metrics/PerceivedComplexity:
-  Max: 15
+  Max: 15
+Lint/DuplicateMethods: # Disables duplicate methods warning
+  Enabled: false
+Gemspec/RequiredRubyVersion: # Disables required ruby version warning
+  Enabled: false

data/Gemfile

@@ -1,12 +1,19 @@
 # frozen_string_literal: true
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in outboxable.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
+gem 'rake', '~> 13.0'
 
-gem "rspec", "~> 3.0"
+gem 'rspec', '~> 3.0'
+
+gem 'rubocop-rails', '~> 2.18'
+
+group :development, :test do
+  gem "sidekiq", "~> 7.0", require: true
+  gem "sidekiq-cron", "~> 1.10"
+  gem "activesupport", "~> 7.0"
+end
 
-gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -1,27 +1,47 @@
 PATH
   remote: .
   specs:
-    outboxable (0.1.2)
+    outboxable (0.1.3)
       bunny (>= 2.19.0)
       connection_pool (~> 2.3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (7.0.4.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
     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)
+    concurrent-ruby (1.2.2)
     connection_pool (2.3.0)
     diff-lcs (1.5.0)
+    et-orbi (1.2.7)
+      tzinfo
+    fugit (1.8.1)
+      et-orbi (~> 1, >= 1.2.7)
+      raabro (~> 1.4)
+    globalid (1.1.0)
+      activesupport (>= 5.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
     json (2.6.3)
+    minitest (5.18.0)
     parallel (1.22.1)
     parser (3.2.1.0)
       ast (~> 2.4.1)
+    raabro (1.4.0)
+    rack (2.2.6.4)
     rainbow (3.1.1)
     rake (13.0.6)
     rbtree (0.4.6)
+    redis-client (0.14.1)
+      connection_pool
     regexp_parser (2.7.0)
     rexml (3.2.5)
     rspec (3.12.0)
@@ -37,33 +57,51 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
-    rubocop (1.45.1)
+    rubocop (1.48.0)
       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)
+      rubocop-ast (>= 1.26.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.26.0)
+    rubocop-ast (1.27.0)
       parser (>= 3.2.1.0)
-    ruby-progressbar (1.11.0)
+    rubocop-rails (2.18.0)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 1.33.0, < 2.0)
+    ruby-progressbar (1.13.0)
     set (1.0.3)
+    sidekiq (7.0.7)
+      concurrent-ruby (< 2)
+      connection_pool (>= 2.3.0)
+      rack (>= 2.2.4)
+      redis-client (>= 0.11.0)
+    sidekiq-cron (1.10.0)
+      fugit (~> 1.8)
+      globalid (>= 1.0.1)
+      sidekiq (>= 6)
     sorted_set (1.0.3)
       rbtree
       set (~> 1.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
     unicode-display_width (2.4.2)
 
 PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
+  activesupport (~> 7.0)
   outboxable!
   rake (~> 13.0)
   rspec (~> 3.0)
-  rubocop (~> 1.21)
+  rubocop-rails (~> 2.18)
+  sidekiq (~> 7.0)
+  sidekiq-cron (~> 1.10)
 
 BUNDLED WITH
    2.4.2

data/README.md

@@ -6,7 +6,7 @@ Please take into consideration that this Gem is **opinionated**, meaning it expe
 
 ### Restrictions
 
-1. When using RabbitMQ, it only publishes events to a ***topic*** exchange. 
+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 [sidekiq-cron](https://github.com/sidekiq-cron/sidekiq-cron) to check the unpublished outboxes every 5 seconds after the initialization of the application.
@@ -25,7 +25,7 @@ If bundler is not being used to manage dependencies, install the gem by executin
 $ gem install outboxable
 ```
 
-Then run: 
+Then run:
 
 ```shell
 $ rails g outboxable:install
@@ -42,7 +42,7 @@ $ rails db:migrate
 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. 
+# 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
@@ -73,14 +73,14 @@ Outboxable.configure do |config|
   # 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_user = ENV.fetch('RABBITMQ__USERNAME')
   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). 
+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).
 
 
 
@@ -155,7 +155,7 @@ 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. 
+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.
 
 
 
@@ -196,13 +196,13 @@ Here's the schema of what could be passed to the ``outbox_configurations`` in JS
 
 
 
-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. 
+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: 
+Last but not least, run sidekiq so that the Outboxable Gem can publish the events to the broker:
 
 ```shell
 $ bundle exec sidekiq

data/Rakefile

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-require "rubocop/rake_task"
+require 'rubocop/rake_task'
 
 RuboCop::RakeTask.new
 

data/lib/generators/outboxable/install_generator.rb

@@ -2,7 +2,7 @@ module Outboxable
   class InstallGenerator < Rails::Generators::Base
     include Rails::Generators::Migration
 
-    source_root File.expand_path('../../../templates', __FILE__)
+    source_root File.expand_path('../../templates', __dir__)
 
     # Copy initializer into user app
     def copy_initializer
@@ -11,26 +11,26 @@ module Outboxable
 
     # 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)
+      target_path = 'app/models/outbox.rb'
+      if Rails.root.join(target_path).exist?
+        say_status('skipped', 'Model outbox already exists')
       else
-        say_status('skipped', "Model outbox already exists")
+        template('outbox.rb', target_path)
       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")
+      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")
+        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")
+    def self.next_migration_number(_dir)
+      Time.now.utc.strftime('%Y%m%d%H%M%S')
     end
   end
 end

data/lib/outboxable/configuration.rb

@@ -12,7 +12,7 @@ module Outboxable
     ALLOWED_MESSAGE_BROKERS = %i[rabbitmq].freeze
     ALLOWED_ORMS = %i[activerecord].freeze
 
-    attr_accessor :rabbitmq_host, 
+    attr_accessor :rabbitmq_host,
                   :rabbitmq_port,
                   :rabbitmq_user,
                   :rabbitmq_password,
@@ -31,7 +31,7 @@ module Outboxable
       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') 
+      Sidekiq::Cron::Job.create(name: 'OutboxablePollingPublisher', cron: '*/5 * * * * *', class: 'Outboxable::PollingPublisherWorker')
     end
 
     def message_broker=(message_broker)

data/lib/outboxable/polling_publisher_worker.rb

@@ -4,11 +4,13 @@ module Outboxable
     sidekiq_options queue: 'critical'
 
     def perform
-      Outbox.pending.find_in_batches(batch_size: 100).each do |batch|
+      Outbox.pending.where(last_attempted_at: [..Time.zone.now, nil]).find_in_batches(batch_size: 100).each do |batch|
         batch.each do |outbox|
+          # This is to prevent a job from being retried too many times. Worst-case scenario is 1 minute delay in jobs. 
+          outbox.update(last_attempted_at: 1.minute.from_now)
           Outboxable::Worker.perform_async(outbox.id)
         end
       end
     end
   end
-end
+end

data/lib/outboxable/rabbitmq/publisher.rb

@@ -4,34 +4,34 @@ module Outboxable
       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" 
+        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
+end

data/lib/outboxable/version.rb

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

data/lib/outboxable/worker.rb

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

data/lib/outboxable.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "outboxable/version"
+require_relative 'outboxable/version'
 
 require 'outboxable/worker'
 require 'outboxable/publishing_manager'
@@ -9,10 +9,11 @@ require 'outboxable/connection'
 require 'outboxable/configuration'
 require 'outboxable/rabbitmq/publisher'
 
+require 'active_support/concern'
 
 module Outboxable
   class Error < StandardError; end
-  
+
   extend ActiveSupport::Concern
 
   included do
@@ -21,7 +22,7 @@ module Outboxable
 
     has_many :outboxes, as: :outboxable, autosave: false
 
-    def instantiate_outbox(routing_key: )
+    def instantiate_outbox(routing_key:)
       outboxes.new(
         routing_key:,
         exchange: Outboxable.configuration.rabbitmq_event_bus_exchange,

data/lib/templates/create_outboxable_outboxes.rb

@@ -17,7 +17,7 @@ class CreateOutboxableOutboxes < ActiveRecord::Migration[7.0]
 
       t.integer :size, null: false, default: 0
 
-      t.references :outboxable, polymorphic: true, null: true 
+      t.references :outboxable, polymorphic: true, null: true
 
       t.timestamps
     end

data/lib/templates/initializer.rb

@@ -1,4 +1,4 @@
-# This monkey patch allows you to customize the message format that you publish to your broker. 
+# 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
@@ -29,7 +29,7 @@ Outboxable.configure do |config|
   # 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_user = ENV.fetch('RABBITMQ__USERNAME')
   config.rabbitmq_password = ENV.fetch('RABBITMQ__PASSWORD')
   config.rabbitmq_vhost = ENV.fetch('RABBITMQ__VHOST')
   config.rabbitmq_event_bus_exchange = ENV.fetch('EVENTBUS__EXCHANGE_NAME')

data/lib/templates/outbox.rb

@@ -2,9 +2,9 @@ class Outbox < ApplicationRecord
   attribute :allow_publish, :boolean, default: true
 
   # Callbacks
-  after_commit :publish, if: :allow_publish?
+  before_create :set_last_attempted_at
   before_save :check_publishing
-
+  after_commit :publish, if: :allow_publish?
   # Enums
   enum status: { pending: 0, published: 1, failed: 2 }
   enum size: { single: 0, batch: 1 }
@@ -17,8 +17,7 @@ class Outbox < ApplicationRecord
   # Associations
   belongs_to :outboxable, polymorphic: true, optional: true
 
-  def increment_attempt
-    self.attempts = attempts + 1
+  def set_last_attempted_at
     self.last_attempted_at = Time.zone.now
   end
 
@@ -29,4 +28,4 @@ class Outbox < ApplicationRecord
   def check_publishing
     self.allow_publish = false if published?
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: outboxable
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Brusk Awat
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-03-12 00:00:00.000000000 Z
+date: 2023-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -68,14 +68,15 @@ files:
 - lib/templates/initializer.rb
 - lib/templates/outbox.rb
 - sig/outboxable.rbs
-homepage: https://githuh.com/broosk1993/outboxable
+homepage: https://github.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
+  homepage_uri: https://github.com/broosk1993/outboxable
+  source_code_uri: https://github.com/broosk1993/outboxable
+  changelog_uri: https://github.com/broosk1993/outboxable/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -84,7 +85,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.1.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="