outboxable 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ff24c145223dcc558818028a2866583266372e1a52cbb0dc63661fdad5f94ea
-  data.tar.gz: 64e19fa685b3f77a85c10bc60f9754a32bbe8534b9aaa5cb153253aefb5bbcb1
+  metadata.gz: d6b86cd386f79a70ee20e31ea49d2078df347b515858a8585dfa424a008651f6
+  data.tar.gz: 53074d0ba82ac19955a754090f788b326221b1e1a487b185fe0aac330fd927f4
 SHA512:
-  metadata.gz: 9dca7a575abbc63e9b033e3726229ce8abe6254ea049f220f66c9b675c4395efbfdac1a12da0dc5c31f50a65bfdab939ee23809c24d9e2182864fdd0b703754f
-  data.tar.gz: 6673eabf79e2daa9b36bd93c84589dc68f796a22c8b82cf93d035cd9eaaa1b3ba523ee16c9c121c719befe9b1527b3bf32a6c2467ee023b9bfd527b209575ef3
+  metadata.gz: 20f03367d91067dc952bfbc45b4038a4b0e944a695f2a3dae4613ded3e139c655d3af1bb56f0f25148c900f1ebe26de8c52a61b1d1e8dde12c5179ada5c41751
+  data.tar.gz: 227e6a787c3567b512be1cb1dcf2d66ab532046019fb6f86f6ef4a1f243088388947ab73b00a5f453dd36f2da97e59c24b9a1909514e612ac9cd291a84c28609

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    outboxable (1.0.2)
+    outboxable (1.0.3)
       bunny (>= 2.19.0)
       connection_pool (~> 2.3.0)
 

data/README.md

@@ -1,6 +1,6 @@
 # Outboxable
 
-The Outboxable Gem is tailored for Rails applications to implement the transactional outbox pattern. It currently only supports ActiveRecord.
+The Outboxable Gem is tailored for Rails applications to implement the transactional outbox pattern. It supports both ActiveRecord and Mongoid.
 
 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.
 
@@ -25,13 +25,19 @@ If bundler is not being used to manage dependencies, install the gem by executin
 $ gem install outboxable
 ```
 
-Then run:
+For use with ActiveRecord, run:
 
 ```shell
-$ rails g outboxable:install
+$ rails g outboxable:install --orm activerecord
 ```
 
-The command above will add a migration file and the Outbox model. You will need then to run the migrations:
+For use with Mongoid, run: 
+
+```shell
+$ rails g outboxable:install --orm mongoid
+```
+
+The command above will add a migration file and the Outbox model. You will need then to run the migrations (ActiveRecord only):
 
 ```shell
 $ rails db:migrate
@@ -64,7 +70,7 @@ module Outboxable
 end
 
 Outboxable.configure do |config|
-  # Specify the ORM you are using. For now, only ActiveRecord is supported.
+  # Specify the ORM you are using. Supported values are :activerecord and :mongoid
   config.orm = :activerecord
 
   # Specify the message broker you are using. For now, only RabbitMQ is supported.
@@ -208,6 +214,12 @@ Last but not least, run sidekiq so that the Outboxable Gem can publish the event
 $ bundle exec sidekiq
 ```
 
+
+
+### Mongoid
+
+The Outboxable gem works smoothly with Mongoid. It is to be noted that when used with Mongoid, Outboxable does not use the `_id` as the idempotency key. It creates a field called ``idempotency_key`` which is a UUID generated at the time of the insertion of the document.
+
 ## 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.

data/lib/outboxable/configuration.rb

@@ -6,12 +6,6 @@ module Outboxable
   def self.configure
     self.configuration ||= Configuration.new
     yield(configuration)
-
-    # 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', args: [{ orm: configuration.orm }])
   end
 
   class Configuration
@@ -32,6 +26,12 @@ module Outboxable
       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)

data/lib/outboxable/polling_publisher_worker.rb

@@ -1,27 +1,25 @@
 module Outboxable
   class PollingPublisherWorker
     include Sidekiq::Job
-    sidekiq_options queue: 'critical'
 
-    def perform(args)
-      orm = args['orm']
-      orm == 'mongoid' ? perform_mongoid(orm) : perform_activerecord(orm)
+    def perform
+      Outboxable.configuration.orm == :mongoid ? perform_mongoid : perform_activerecord
     end
 
-    def perform_activerecord(orm)
+    def perform_activerecord
       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.
-          Outboxable::Worker.perform_async(outbox.id, orm)
+          ::Outboxable::Worker.perform_async(outbox.id)
           outbox.update(last_attempted_at: 1.minute.from_now, status: :processing, allow_publish: false)
         end
       end
     end
 
-    def perform_mongoid(orm)
-      Outbox.pending.where(last_attempted_at: [..Time.zone.now, nil]).each do |outbox|
+    def perform_mongoid
+      Outbox.pending.any_of({ last_attempted_at: ..Time.zone.now }, { last_attempted_at: nil }).each do |outbox|
         # This is to prevent a job from being retried too many times. Worst-case scenario is 1 minute delay in jobs.
-        Outboxable::Worker.perform_async(outbox.idempotency_key, orm)
+        ::Outboxable::Worker.perform_async(outbox.idempotency_key)
         outbox.update(last_attempted_at: 1.minute.from_now, status: :processing, allow_publish: false)
       end
     end

data/lib/outboxable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Outboxable
-  VERSION = '1.0.2'
+  VERSION = '1.0.3'
 end

data/lib/outboxable/worker.rb

@@ -4,9 +4,9 @@ module Outboxable
   class Worker
     include ::Sidekiq::Job
 
-    def perform(outbox_id, orm)
-      Outboxable::PublishingManager.publish(resource: Outbox.find(outbox_id)) if orm == 'activerecord'
-      Outboxable::PublishingManager.publish(resource: Outbox.find_by!(idempotency_key: outbox_id)) if orm == 'mongoid'
+    def perform(outbox_id)
+      Outboxable::PublishingManager.publish(resource: Outbox.find(outbox_id)) if Outboxable.configuration.orm == :activerecord
+      Outboxable::PublishingManager.publish(resource: Outbox.find_by!(idempotency_key: outbox_id)) if Outboxable.configuration.orm == :mongoid
     end
   end
 end

data/lib/outboxable.rb

@@ -3,14 +3,15 @@
 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'
 
 require 'active_support/concern'
 
+require 'outboxable/publishing_manager'
+require 'outboxable/polling_publisher_worker'
+
 module Outboxable
   class Error < StandardError; end
 

data/lib/templates/activerecord_initializer.rb

@@ -23,7 +23,7 @@ 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.
+  # Specify the ORM you are using. Supported values are :activerecord and :mongoid
   config.message_broker = :rabbitmq
 
   # RabbitMQ configurations

data/lib/templates/mongoid_initializer.rb

@@ -23,7 +23,7 @@ Outboxable.configure do |config|
   # Specify the ORM you are using. For now, only ActiveRecord is supported.
   config.orm = :mongoid
 
-  # Specify the message broker you are using. For now, only RabbitMQ is supported.
+  # Specify the ORM you are using. Supported values are :activerecord and :mongoid
   config.message_broker = :rabbitmq
 
   # RabbitMQ configurations

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: outboxable
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Brusk Awat
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-04-13 00:00:00.000000000 Z
+date: 2023-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny