inboxable 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1207d628727126924ff331738cd526e2dc676964fae984d2b53c6cf97a664418
-  data.tar.gz: 7163397c6d3bd6c90e3beca17957943dd38866d677b4c4057ddf1a14bcff9f33
+  metadata.gz: b4d81533a77f953ec0b2e7b5b7b86dee4da59cfec008aedad5a9234a8303d7dd
+  data.tar.gz: ac85e6bb520fed77412e3c233dd6ac9385f828244f744d79da820a964c3f2e55
 SHA512:
-  metadata.gz: a0e65af5f85b964269d7e20525754ec0ebe8152ea9e3d946480af9ad29c973756a70bbd97a4034d11eb38bc97b777e618b58daae4afc19825c99c00ec21c3e3a
-  data.tar.gz: b9da958286397e8b9fc7f165af001a5a234d4e582cf971b6fc6f21f29574078928cb12c6d6b52c99e5187c3867a540af0aca4be82e942c675c910217e8545b9f
+  metadata.gz: 84cbdd6b4070185a8ce0322225c76b4490b0ec78e415c924c47ba0bc0c0a632170e9ba946a17cebb992b372422cd2a3ef05890b8a6baeb8f67e365779539c007
+  data.tar.gz: ad3d25d9823c1a45288c49b402b2f92de3ff519415a02bbe3a40ced00b8c2f2316e795e6282911869c8136158552be696caa26d52543c5fbb288edb93184269d

data/CHANGELOG.md

@@ -1,5 +1,16 @@
-## [Unreleased]
+# Changelog
+This file is used to list changes made in each version of the inboxable gem.
 
-## [0.1.0] - 2024-01-21
+## Inboxable 0.1.2 (2024-01-22)
 
-- Initial release
+* Added scope for each status key in the `Inbox` model to fetch the
+    corresponding records.
+
+## Inboxable 0.1.1 (2024-01-22)
+
+* Added `inbox_model` configuration to the `Configuration` class to allow for custom
+    inbox models.
+
+## Inboxable 0.1.0 (2024-01-22)
+
+* Initial release

data/README.md

@@ -80,7 +80,9 @@ The options are as follows:
 
 ## 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.
+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.
+
+If you would like to use a different name for the Inbox model. You can configure it by setting the `inbox_model` config to the name of you custom defined model. See the [Configuration](#configuration) section below for more information.
 
 ### Fields & Attributes
 
@@ -123,7 +125,8 @@ The Inboxable gem provides a number of configuration options that can be used to
 ---
 | Option | Description | Default Value    | Applied To                                           |
 | --- | --- |------------------|---|
-| `orm` | The ORM that is used in the application. | `:active_record` | `/config/initializers/inboxable.rb`                  |
+| `orm` | The ORM that is used in the application. | `:active_record` | `/config/initializers/z_inboxable.rb`                  |
+| `inbox_model` | The name of the Inbox model. | `Inbox` | `/config/initializers/z_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. |

data/lib/inboxable/configuration.rb

@@ -2,7 +2,7 @@ module Inboxable
   class Configuration
     ALLOWED_ORMS = %i[activerecord mongoid].freeze
 
-    attr_accessor :orm
+    attr_accessor :orm, :inbox_model
 
     def initialize
       raise Error, 'Sidekiq is not available. Unfortunately, sidekiq must be available for Inboxable to work' unless Object.const_defined?('Sidekiq')
@@ -23,5 +23,9 @@ module Inboxable
     def orm
       @orm || :activerecord
     end
+
+    def inbox_model
+      @inbox_model || 'Inbox'
+    end
   end
 end

data/lib/inboxable/polling_receiver_worker.rb

@@ -9,10 +9,10 @@ module Inboxable
     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|
+      Inboxable.inbox_model.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)
@@ -22,9 +22,9 @@ module Inboxable
 
     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|
+      Inboxable.inbox_model.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)

data/lib/inboxable/version.rb

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

data/lib/inboxable.rb

@@ -10,6 +10,10 @@ module Inboxable
   class << self
     attr_accessor :configuration
 
+    def inbox_model
+      @configuration.inbox_model.constantize
+    end
+
     def configure
       @configuration ||= Configuration.new
       yield(@configuration) if block_given?

data/lib/templates/mongoid_inbox.rb

@@ -19,6 +19,10 @@ class Inbox
 
   as_enum :status, %i[pending processed failed], field: { type: String, default: 'pending' }, map: :string
 
+  statuses.each_key do |key|
+    scope key, -> { where(status_cd: key) }
+  end
+
   validates :processor_class_name, presence: true
 
   after_create :process, if: proc { |resource| resource.allow_processing == true }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inboxable
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Muhammad Nawzad