auction_fun_core 0.8.7 → 0.8.9

data/lib/auction_fun_core/workers/operations/auction_context/post_auction/winner_operation_job.rb

@@ -6,13 +6,17 @@ module AuctionFunCore
       module AuctionContext
         module PostAuction
           ##
-          # BackgroundJob class for call finish auction operation.
+          # Background job class responsible for performing winner operations after an finished auction.
           class WinnerOperationJob < Workers::ApplicationJob
             include Import["repos.user_context.user_repository"]
             include Import["repos.auction_context.auction_repository"]
             include Import["operations.auction_context.post_auction.winner_operation"]
 
-            # @todo Add detailed documentation
+            # Executes the winner operation for the specified auction and winner.
+            #
+            # @param auction_id [Integer] The ID of the auction.
+            # @param winner_id [Integer] The ID of the winner.
+            # @param retry_count [Integer] The current retry count for the job.
             def perform(auction_id, winner_id, retry_count = 0)
               auction = auction_repository.by_id!(auction_id)
               winner = user_repository.by_id!(winner_id)

data/lib/auction_fun_core/workers/operations/auction_context/pre_auction/auction_start_reminder_operation_job.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module AuctionFunCore
+  module Workers
+    module Operations
+      module AuctionContext
+        module PreAuction
+          ##
+          # Background job class responsible for sending auction start reminders
+          class AuctionStartReminderOperationJob < Workers::ApplicationJob
+            include Import["repos.user_context.user_repository"]
+            include Import["repos.auction_context.auction_repository"]
+
+            # Executes the auction start reminder operation for the specified auction.
+            #
+            # @param auction_id [Integer] The ID of the auction.
+            # @param retry_count [Integer] The current retry count for the job.
+            # @return [void]
+            def perform(auction_id, retry_count = 0)
+              auction = auction_repository.by_id!(auction_id)
+
+              auction_start_reminder_operation.call(auction_id: auction.id)
+            rescue => e
+              capture_exception(e, {auction_id: auction_id, retry_count: retry_count})
+              raise if retry_count >= MAX_RETRIES
+
+              interval = backoff_exponential_job(retry_count)
+              self.class.perform_at(interval, auction_id, retry_count + 1)
+            end
+
+            private
+
+            # Retrieves the auction start reminder operation.
+            #
+            # @return [Class] The auction start reminder operation class.
+            def auction_start_reminder_operation
+              AuctionFunCore::Operations::AuctionContext::PreAuction::AuctionStartReminderOperation
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/auction_fun_core/workers/operations/auction_context/processor/finish/closed_operation_job.rb

@@ -7,13 +7,16 @@ module AuctionFunCore
         module Processor
           module Finish
             ##
-            # BackgroundJob class for call finish closed auction operation.
-            #
+            # Background job class responsible for call finish closed auction operation.
             class ClosedOperationJob < Workers::ApplicationJob
               include Import["repos.auction_context.auction_repository"]
               include Import["operations.auction_context.processor.finish.closed_operation"]
 
-              # @todo Add detailed documentation
+              # Executes the operation to finish a closed auction.
+              #
+              # @param auction_id [Integer] The ID of the closed auction.
+              # @param retry_count [Integer] The current retry count for the job.
+              # @return [void]
               def perform(auction_id, retry_count = 0)
                 auction = auction_repository.by_id!(auction_id)
 

data/lib/auction_fun_core/workers/operations/auction_context/processor/finish/penny_operation_job.rb

@@ -7,8 +7,7 @@ module AuctionFunCore
         module Processor
           module Finish
             ##
-            # BackgroundJob class for call finish penny auction operation.
-            #
+            # Background job class responsible for call finish penny auction operation.
             class PennyOperationJob < Workers::ApplicationJob
               include Sidekiq::Worker
               include Import["repos.auction_context.auction_repository"]
@@ -16,7 +15,11 @@ module AuctionFunCore
 
               sidekiq_options queue: "default", lock: :until_executed, on_conflict: :replace
 
-              # @todo Add detailed documentation
+              # Executes the operation to finish a penny auction.
+              #
+              # @param auction_id [Integer] The ID of the penny auction.
+              # @param retry_count [Integer] The current retry count for the job.
+              # @return [void]
               def perform(auction_id, retry_count = 0)
                 auction = auction_repository.by_id!(auction_id)
 

data/lib/auction_fun_core/workers/operations/auction_context/processor/finish/standard_operation_job.rb

@@ -7,13 +7,17 @@ module AuctionFunCore
         module Processor
           module Finish
             ##
-            # BackgroundJob class for call finish standard auction operation.
+            # Background job class responsible for call finish standard auction operation.
             #
             class StandardOperationJob < Workers::ApplicationJob
               include Import["repos.auction_context.auction_repository"]
               include Import["operations.auction_context.processor.finish.standard_operation"]
 
-              # @todo Add detailed documentation
+              # Executes the operation to finish a standard auction.
+              #
+              # @param auction_id [Integer] The ID of the standard auction.
+              # @param retry_count [Integer] The current retry count for the job.
+              # @return [void]
               def perform(auction_id, retry_count = 0)
                 auction = auction_repository.by_id!(auction_id)
 

data/lib/auction_fun_core/workers/operations/auction_context/processor/start_operation_job.rb

@@ -6,13 +6,16 @@ module AuctionFunCore
       module AuctionContext
         module Processor
           ##
-          # BackgroundJob class for call start auction operation.
-          #
+          # Background job class responsible for call start auction operation.
           class StartOperationJob < AuctionFunCore::Workers::ApplicationJob
             include Import["repos.auction_context.auction_repository"]
             include Import["operations.auction_context.processor.start_operation"]
 
-            # @todo Add detailed documentation
+            # Executes the operation to start an auction.
+            #
+            # @param auction_id [Integer] The ID of the auction to start.
+            # @param retry_count [Integer] The current retry count for the job.
+            # @return [void]
             def perform(auction_id, retry_count = 0)
               auction = auction_repository.by_id!(auction_id)
 

data/lib/auction_fun_core/workers/services/mail/auction_context/post_auction/participant_mailer_job.rb

@@ -7,14 +7,17 @@ module AuctionFunCore
         module AuctionContext
           module PostAuction
             ##
-            # Background job class responsible for adding emails to the queue.
-            #
+            # Background job class responsible for queuing participant emails.
             class ParticipantMailerJob < AuctionFunCore::Workers::ApplicationJob
               include Import["repos.user_context.user_repository"]
               include Import["repos.auction_context.auction_repository"]
 
-              # @param auction_id [Integer] auction ID
-              # @param participant_id [Integer] user ID
+              # Reads the statistics of a participant in an auction and sends it by email.
+              #
+              # @param auction_id [Integer] The ID of the auction.
+              # @param participant_id [Integer] The ID of the participant.
+              # @param retry_count [Integer] The current retry count for the job.
+              # @return [void]
               def perform(auction_id, participant_id, retry_count = 0)
                 auction = auction_repository.by_id!(auction_id)
                 participant = user_repository.by_id!(participant_id)
@@ -32,13 +35,15 @@ module AuctionFunCore
 
               private
 
-              # Since the shipping code structure does not follow project conventions,
-              # making the default injection dependency would be more complicated.
-              # Therefore, here I directly explain the class to be called.
+              # Directly specifies the class to be called due to non-standard dependency injection.
+              # @return [Class] The participant mailer class.
               def participant_mailer
                 AuctionFunCore::Services::Mail::AuctionContext::PostAuction::ParticipantMailer
               end
 
+              # Retrieves the relation for loading participant statistics.
+              #
+              # @return [ROM::Relation] The relation object.
               def relation
                 AuctionFunCore::Application[:container].relations[:auctions]
               end

data/lib/auction_fun_core/workers/services/mail/auction_context/post_auction/winner_mailer_job.rb

@@ -13,8 +13,12 @@ module AuctionFunCore
               include Import["repos.user_context.user_repository"]
               include Import["repos.auction_context.auction_repository"]
 
-              # @param auction_id [Integer] auction ID
-              # @param winner_id [Integer] user ID
+              # Reads the statistics of a winner in an auction and sends it by email.
+              #
+              # @param auction_id [Integer] The ID of the auction.
+              # @param winner_id [Integer] The ID of the winner.
+              # @param retry_count [Integer] The current retry count for the job.
+              # @return [void]
               def perform(auction_id, winner_id, retry_count = 0)
                 auction = auction_repository.by_id!(auction_id)
                 winner = user_repository.by_id!(winner_id)
@@ -32,13 +36,15 @@ module AuctionFunCore
 
               private
 
-              # Since the shipping code structure does not follow project conventions,
-              # making the default injection dependency would be more complicated.
-              # Therefore, here I directly explain the class to be called.
+              # Directly specifies the class to be called due to non-standard dependency injection.
+              # @return [Class] The winner mailer class.
               def winner_mailer
                 AuctionFunCore::Services::Mail::AuctionContext::PostAuction::WinnerMailer
               end
 
+              # Retrieves the relation for loading winner statistics.
+              #
+              # @return [ROM::Relation] The relation object.
               def relation
                 AuctionFunCore::Application[:container].relations[:auctions]
               end

data/lib/auction_fun_core/workers/services/mail/auction_context/pre_auction/auction_start_reminder_mailer_job.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module AuctionFunCore
+  module Workers
+    module Services
+      module Mail
+        module AuctionContext
+          module PreAuction
+            ##
+            # Background job class responsible for adding auction start emails to the queue.
+            class AuctionStartReminderMailerJob < AuctionFunCore::Workers::ApplicationJob
+              include Import["repos.user_context.user_repository"]
+              include Import["repos.auction_context.auction_repository"]
+
+              # Executes the operation of sending an email to the participant notifying
+              # them of the start of the auction.
+              #
+              # @param auction_id [Integer] The ID of the standard auction.
+              # @param participant_id [Integer] The ID of the participant
+              # @param retry_count [Integer] The current retry count for the job.
+              # @return [void]
+              def perform(auction_id, participant_id, retry_count = 0)
+                auction = auction_repository.by_id!(auction_id)
+                participant = user_repository.by_id!(participant_id)
+
+                auction_start_reminder_mailer.new(auction, participant).deliver
+              rescue => e
+                capture_exception(e, {auction_id: auction_id, participant_id: participant_id, retry_count: retry_count})
+                raise e if retry_count >= MAX_RETRIES
+
+                interval = backoff_exponential_job(retry_count)
+                self.class.perform_at(interval, auction_id, participant_id, retry_count + 1)
+              end
+
+              private
+
+              # Directly specifies the class to be called due to non-standard dependency injection.
+              # @return [Class] The auction start reminder mailer class.
+              def auction_start_reminder_mailer
+                AuctionFunCore::Services::Mail::AuctionContext::PreAuction::AuctionStartReminderMailer
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/auction_fun_core/workers/services/mail/user_context/registration_mailer_job.rb

@@ -6,12 +6,15 @@ module AuctionFunCore
       module Mail
         module UserContext
           ##
-          # Background job class responsible for adding emails to the queue.
-          #
+          # Background job class responsible for queuing registration emails.
           class RegistrationMailerJob < AuctionFunCore::Workers::ApplicationJob
             include Import["repos.user_context.user_repository"]
 
-            # @param user_id [Integer] user ID
+            # Initializes a new RegistrationMailerJob instance.
+            #
+            # @param user_id [Integer] The ID of the user.
+            # @param retry_count [Integer] The current retry count for the job.
+            # @return [void]
             def perform(user_id, retry_count = 0)
               user = user_repository.by_id!(user_id)
 
@@ -26,9 +29,8 @@ module AuctionFunCore
 
             private
 
-            # Since the shipping code structure does not follow project conventions,
-            # making the default injection dependency would be more complicated.
-            # Therefore, here I directly explain the class to be called.
+            # Directly specifies the class to be called due to non-standard dependency injection.
+            # @return [Class] The registration mailer class.
             def registration_mailer
               AuctionFunCore::Services::Mail::UserContext::RegistrationMailer
             end

data/system/providers/background_job.rb

@@ -8,22 +8,28 @@ AuctionFunCore::Application.register_provider(:background_job) do
 
   start do
     Sidekiq.configure_server do |config|
+      # Set up Sidekiq server configuration
       config.redis = {url: target[:settings].redis_url}
       config.logger = target[:settings].logger
       config.average_scheduled_poll_interval = 3
 
+      # Configure client middleware for uniqueness
       config.client_middleware do |chain|
         chain.add SidekiqUniqueJobs::Middleware::Client
       end
 
+      # Configure server middleware for uniqueness
       config.server_middleware do |chain|
         chain.add SidekiqUniqueJobs::Middleware::Server
       end
 
+      # Configure Sidekiq Unique Jobs for the server
       SidekiqUniqueJobs::Server.configure(config)
     end
 
+    # Configure client middleware for uniqueness
     Sidekiq.configure_client do |config|
+      # Set up Sidekiq client configuration
       config.redis = {url: target[:settings].redis_url}
 
       config.client_middleware do |chain|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: auction_fun_core
 version: !ruby/object:Gem::Version
-  version: 0.8.7
+  version: 0.8.9
 platform: ruby
 authors:
 - Ricardo Pacheco
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-22 00:00:00.000000000 Z
+date: 2024-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -312,11 +312,13 @@ files:
 - i18n/en-US/mail/application.en-US.yml
 - i18n/en-US/mail/auction_context/post_auction/participant.en-US.yml
 - i18n/en-US/mail/auction_context/post_auction/winner.en-US.yml
+- i18n/en-US/mail/auction_context/pre_auction/auction_start_reminder.en-US.yml
 - i18n/en-US/mail/user_context/registration.en-US.yml
 - i18n/pt-BR/contracts/contracts.pt-BR.yml
 - i18n/pt-BR/mail/application.pt-BR.yml
 - i18n/pt-BR/mail/auction_context/post_auction/participant.pt-BR.yml
 - i18n/pt-BR/mail/auction_context/post_auction/winner.pt-BR.yml
+- i18n/pt-BR/mail/auction_context/pre_auction/auction_start_reminder.pt-BR.yml
 - i18n/pt-BR/mail/user_context/registration.pt-BR.yml
 - lib/auction_fun_core.rb
 - lib/auction_fun_core/business/configuration.rb
@@ -333,6 +335,7 @@ files:
 - lib/auction_fun_core/contracts/auction_context/create_contract.rb
 - lib/auction_fun_core/contracts/auction_context/post_auction/participant_contract.rb
 - lib/auction_fun_core/contracts/auction_context/post_auction/winner_contract.rb
+- lib/auction_fun_core/contracts/auction_context/pre_auction/auction_start_reminder_contract.rb
 - lib/auction_fun_core/contracts/auction_context/processor/finish/closed_contract.rb
 - lib/auction_fun_core/contracts/auction_context/processor/finish/penny_contract.rb
 - lib/auction_fun_core/contracts/auction_context/processor/finish/standard_contract.rb
@@ -357,6 +360,7 @@ files:
 - lib/auction_fun_core/operations/auction_context/create_operation.rb
 - lib/auction_fun_core/operations/auction_context/post_auction/participant_operation.rb
 - lib/auction_fun_core/operations/auction_context/post_auction/winner_operation.rb
+- lib/auction_fun_core/operations/auction_context/pre_auction/auction_start_reminder_operation.rb
 - lib/auction_fun_core/operations/auction_context/processor/finish/closed_operation.rb
 - lib/auction_fun_core/operations/auction_context/processor/finish/penny_operation.rb
 - lib/auction_fun_core/operations/auction_context/processor/finish/standard_operation.rb
@@ -383,8 +387,10 @@ files:
 - lib/auction_fun_core/repos/user_context/user_repository.rb
 - lib/auction_fun_core/services/mail/auction_context/post_auction/participant_mailer.rb
 - lib/auction_fun_core/services/mail/auction_context/post_auction/winner_mailer.rb
+- lib/auction_fun_core/services/mail/auction_context/pre_auction/auction_start_reminder_mailer.rb
 - lib/auction_fun_core/services/mail/templates/auction_context/post_auction/participant.html.erb
 - lib/auction_fun_core/services/mail/templates/auction_context/post_auction/winner.html.erb
+- lib/auction_fun_core/services/mail/templates/auction_context/pre_auction/auction_start_reminder.html.erb
 - lib/auction_fun_core/services/mail/templates/layout.html.erb
 - lib/auction_fun_core/services/mail/templates/user_context/registration.html.erb
 - lib/auction_fun_core/services/mail/user_context/registration_mailer.rb
@@ -392,12 +398,14 @@ files:
 - lib/auction_fun_core/workers/application_job.rb
 - lib/auction_fun_core/workers/operations/auction_context/post_auction/participant_operation_job.rb
 - lib/auction_fun_core/workers/operations/auction_context/post_auction/winner_operation_job.rb
+- lib/auction_fun_core/workers/operations/auction_context/pre_auction/auction_start_reminder_operation_job.rb
 - lib/auction_fun_core/workers/operations/auction_context/processor/finish/closed_operation_job.rb
 - lib/auction_fun_core/workers/operations/auction_context/processor/finish/penny_operation_job.rb
 - lib/auction_fun_core/workers/operations/auction_context/processor/finish/standard_operation_job.rb
 - lib/auction_fun_core/workers/operations/auction_context/processor/start_operation_job.rb
 - lib/auction_fun_core/workers/services/mail/auction_context/post_auction/participant_mailer_job.rb
 - lib/auction_fun_core/workers/services/mail/auction_context/post_auction/winner_mailer_job.rb
+- lib/auction_fun_core/workers/services/mail/auction_context/pre_auction/auction_start_reminder_mailer_job.rb
 - lib/auction_fun_core/workers/services/mail/user_context/registration_mailer_job.rb
 - lib/tasks/database.rake
 - system/providers/background_job.rb