outboxable 0.1.7 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b35b65aa492459dcaf6262e1f1a531eeccdf5a146ba1007d1a47068c55f44337
-  data.tar.gz: a74c84eed72b6bd893ef6d9afc79917618adc9cde39d5afef5ba83bf99f9dd1d
+  metadata.gz: 6289db937af7c6072908dce5da1a44a5145c9a4065bcd3705f847ea39e6c7c57
+  data.tar.gz: 89a5d2581f353528fd78e0c19443163d625d2981fa443b5db99a31554001e93d
 SHA512:
-  metadata.gz: 303468322166f4c59132e3e405d005f1e40e1d36802a493b6ddcd0fed54ab831770a7cc8f19d52f08ecd3c5644181bf9cdb4f46a47c1adc6a39662332da091a1
-  data.tar.gz: 51c9e821c2b7b908ea9358793d4e0007faabe324f03de74d7dca882a720bc77ecbd2aa0d5933ce360f25403ebb79c780977e8f156e24bf616324587aef8b27b0
+  metadata.gz: dcefad48f356f8d18e44ac7431464f3b1687505fa6241e4d472ad67f215a00e0b5d0da5f690b028aae34c97564d60c5db1c331a37151b02c69d5b60823c029e9
+  data.tar.gz: 810dd5e03320ddc4812e5f15db86521fe3e29f4dc69bb92d64dbff822cceddccb71c25e99573edf8cf6d191aa8992d58e7a8fd144a28598def81b63e6614c567

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    outboxable (0.1.6)
+    outboxable (1.0.0)
       bunny (>= 2.19.0)
       connection_pool (~> 2.3.0)
+      simple_enum (>= 2.3)
 
 GEM
   remote: https://rubygems.org/
@@ -84,6 +85,8 @@ GEM
       fugit (~> 1.8)
       globalid (>= 1.0.1)
       sidekiq (>= 6)
+    simple_enum (2.3.2)
+      activesupport (>= 4.0.0)
     sorted_set (1.0.3)
       rbtree
       set (~> 1.0)

data/lib/generators/outboxable/install_generator.rb

@@ -3,24 +3,37 @@ module Outboxable
     include Rails::Generators::Migration
 
     source_root File.expand_path('../../templates', __dir__)
+    class_option :orm, type: :string, default: 'activerecord'
+
+    def initialize
+      super
+
+      @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('initializer.rb', 'config/initializers/z_outboxable.rb')
+      copy_file('activerecod_initializer.rb', 'config/initializers/z_outboxable.rb') if @orm == 'activerecord'
+      copy_file('mongoid_initializer.rb', 'config/initializers/z_outboxable.rb') if @orm == 'mongoid'
     end
 
     # Copy user information (model & Migrations) into user app
     def create_user_model
       target_path = 'app/models/outbox.rb'
+
       if Rails.root.join(target_path).exist?
         say_status('skipped', 'Model outbox already exists')
       else
-        template('outbox.rb', target_path)
+        template('activerecrod_outbox.rb', target_path) if @orm == 'activerecord'
+        template('mongoid_outbox.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_outboxable_outboxes')
         say_status('skipped', 'Migration create_outboxable_outboxes already exists')
       else

data/lib/outboxable/configuration.rb

@@ -10,7 +10,7 @@ module Outboxable
 
   class Configuration
     ALLOWED_MESSAGE_BROKERS = %i[rabbitmq].freeze
-    ALLOWED_ORMS = %i[activerecord].freeze
+    ALLOWED_ORMS = %i[activerecord mongoid].freeze
 
     attr_accessor :rabbitmq_host,
                   :rabbitmq_port,

data/lib/outboxable/polling_publisher_worker.rb

@@ -4,13 +4,25 @@ module Outboxable
     sidekiq_options queue: 'critical'
 
     def perform
+      Outboxable.configuration.orm == :mongoid ? perform_mongoid : perform_activerecord
+    end
+
+    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)
-          outbox.update(last_attempted_at: 1.minute.from_now, status: :processing)
+          outbox.update(last_attempted_at: 1.minute.from_now, status: :processing, allow_publish: false)
         end
       end
     end
+
+    def perform_mongoid
+      Outbox.pending.where(last_attempted_at: [..Time.zone.now, 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.id)
+        outbox.update(last_attempted_at: 1.minute.from_now, status: :processing, allow_publish: false)
+      end
+    end
   end
 end

data/lib/outboxable/version.rb

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

data/lib/outboxable.rb

@@ -20,7 +20,7 @@ module Outboxable
     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
+    has_many :outboxes, as: :outboxable, dependent: :destroy
 
     def instantiate_outbox(routing_key:)
       outboxes.new(

data/lib/templates/{outbox.rb → activerecrod_outbox.rb}

@@ -1,9 +1,9 @@
 class Outbox < ApplicationRecord
   attribute :allow_publish, :boolean, default: true
 
+  before_save :check_publishing
   # Callbacks
   before_create :set_last_attempted_at
-  before_save :check_publishing
   after_commit :publish, if: :allow_publish?
   # Enums
   enum status: { pending: 0, processing: 1, published: 2, failed: 3 }
@@ -21,7 +21,7 @@ class Outbox < ApplicationRecord
 
   def publish
     Outboxable::Worker.perform_async(id)
-    update(status: :processing, last_attempted_at: 1.minute.from_now)
+    update(status: :processing, last_attempted_at: 1.minute.from_now, allow_publish: false)
   end
 
   def check_publishing

data/lib/templates/mongoid_initializer..rb

@@ -0,0 +1,38 @@
+require 'simple_enum/mongoid'
+
+# 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 = :mongoid
+
+  # 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__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

data/lib/templates/mongoid_outbox.rb

@@ -0,0 +1,56 @@
+class Outbox
+  include Mongoid::Document
+  include Mongoid::Timestamps
+  include SimpleEnum::Mongoid
+
+  attr_accessor :allow_publish
+
+  # Fields
+  field :status, type: String, default: 'pending'
+  field :size, type: String, default: 'single'
+
+  field :exchange, type: String, default: ''
+  field :routing_key, type: String, default: ''
+
+  field :attempts, type: Integer, default: 0
+
+  field :last_attempted_at, type: DateTime, default: nil
+
+  field :retry_at, type: DateTime, default: nil
+
+  field :payload, type: Hash, default: {}
+  field :headers, type: Hash, default: {}
+
+  before_save :check_publishing
+
+  # Callbacks
+  before_create :set_last_attempted_at
+  after_commit :publish, if: :allow_publish?
+
+  # Enums
+  as_enum :status, { pending: 0, processing: 1, published: 2, failed: 3 }, pluralize_scopes: false, map: :string
+  as_enum :size, { single: 0, batch: 1 }, pluralize_scopes: false, map: :string
+
+  # Validations
+  validates :payload, :exchange, :routing_key, presence: true
+
+  # Associations
+  belongs_to :outboxable, polymorphic: true, optional: true
+
+  def set_last_attempted_at
+    self.last_attempted_at = 10.seconds.from_now
+  end
+
+  def publish
+    Outboxable::Worker.perform_async(id)
+    update(status: :processing, last_attempted_at: 1.minute.from_now, allow_publish: false)
+  end
+
+  def check_publishing
+    self.allow_publish = false if published?
+  end
+
+  def allow_publish
+    @allow_publish || true
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: outboxable
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 1.0.0
 platform: ruby
 authors:
 - Brusk Awat
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.3.0
+- !ruby/object:Gem::Dependency
+  name: simple_enum
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.3'
 description: The Outboxable Gem is tailored for Rails applications to implement the
   transactional outbox pattern. It currently only supports ActiveRecord.
 email:
@@ -64,9 +78,11 @@ files:
 - lib/outboxable/rabbitmq/publisher.rb
 - lib/outboxable/version.rb
 - lib/outboxable/worker.rb
+- lib/templates/activerecord_initializer.rb
+- lib/templates/activerecrod_outbox.rb
 - lib/templates/create_outboxable_outboxes.rb
-- lib/templates/initializer.rb
-- lib/templates/outbox.rb
+- lib/templates/mongoid_initializer..rb
+- lib/templates/mongoid_outbox.rb
 - sig/outboxable.rbs
 homepage: https://github.com/broosk1993/outboxable
 licenses: