auction_fun_core 0.8.5 → 0.8.9

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module AuctionFunCore
+  module Workers
+    module Operations
+      module AuctionContext
+        module Processor
+          module Finish
+            ##
+            # Background job class responsible for call finish penny auction operation.
+            class PennyOperationJob < Workers::ApplicationJob
+              include Sidekiq::Worker
+              include Import["repos.auction_context.auction_repository"]
+              include Import["operations.auction_context.processor.finish.penny_operation"]
+
+              sidekiq_options queue: "default", lock: :until_executed, on_conflict: :replace
+
+              # 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)
+
+                penny_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
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module AuctionFunCore
+  module Workers
+    module Operations
+      module AuctionContext
+        module Processor
+          module Finish
+            ##
+            # 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"]
+
+              # 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)
+
+                standard_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
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module AuctionFunCore
+  module Workers
+    module Services
+      module Mail
+        module AuctionContext
+          module PostAuction
+            ##
+            # 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"]
+
+              # 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)
+
+                statistics = relation.load_participant_statistics.call(auction.id, participant.id).first
+
+                participant_mailer.new(auction, participant, statistics).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 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
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module AuctionFunCore
+  module Workers
+    module Services
+      module Mail
+        module AuctionContext
+          module PostAuction
+            ##
+            # Background job class responsible for adding emails to the queue.
+            #
+            class WinnerMailerJob < AuctionFunCore::Workers::ApplicationJob
+              include Import["repos.user_context.user_repository"]
+              include Import["repos.auction_context.auction_repository"]
+
+              # 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)
+
+                statistics = relation.load_winner_statistics.call(auction_id, winner_id).first
+
+                winner_mailer.new(auction, winner, statistics).deliver
+              rescue => e
+                capture_exception(e, {auction_id: auction_id, winner_id: winner_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, winner_id, retry_count + 1)
+              end
+
+              private
+
+              # 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
+            end
+          end
+        end
+      end
+    end
+  end
+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

@@ -3,13 +3,38 @@
 AuctionFunCore::Application.register_provider(:background_job) do
   prepare do
     require "sidekiq"
+    require "sidekiq-unique-jobs"
   end
 
   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|
+        chain.add SidekiqUniqueJobs::Middleware::Client
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: auction_fun_core
 version: !ruby/object:Gem::Version
-  version: 0.8.5
+  version: 0.8.9
 platform: ruby
 authors:
 - Ricardo Pacheco
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-03 00:00:00.000000000 Z
+date: 2024-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -234,6 +234,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 7.2.2
+- !ruby/object:Gem::Dependency
+  name: sidekiq-unique-jobs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 8.0.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 8.0.10
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -295,8 +309,16 @@ files:
 - db/migrate/20240304144422_create_bids.rb
 - db/seeds.rb
 - i18n/en-US/contracts/contracts.en-US.yml
+- 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
@@ -311,7 +333,12 @@ files:
 - lib/auction_fun_core/commands/user_context/create_user.rb
 - lib/auction_fun_core/contracts/application_contract.rb
 - lib/auction_fun_core/contracts/auction_context/create_contract.rb
-- lib/auction_fun_core/contracts/auction_context/processor/finish_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
 - lib/auction_fun_core/contracts/auction_context/processor/pause_contract.rb
 - lib/auction_fun_core/contracts/auction_context/processor/start_contract.rb
 - lib/auction_fun_core/contracts/auction_context/processor/unpause_contract.rb
@@ -331,7 +358,12 @@ files:
 - lib/auction_fun_core/events/app.rb
 - lib/auction_fun_core/events/listener.rb
 - lib/auction_fun_core/operations/auction_context/create_operation.rb
-- lib/auction_fun_core/operations/auction_context/processor/finish_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
 - lib/auction_fun_core/operations/auction_context/processor/pause_operation.rb
 - lib/auction_fun_core/operations/auction_context/processor/start_operation.rb
 - lib/auction_fun_core/operations/auction_context/processor/unpause_operation.rb
@@ -353,13 +385,27 @@ files:
 - lib/auction_fun_core/repos/bid_context/bid_repository.rb
 - lib/auction_fun_core/repos/staff_context/staff_repository.rb
 - 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
 - lib/auction_fun_core/version.rb
 - lib/auction_fun_core/workers/application_job.rb
-- lib/auction_fun_core/workers/operations/auction_context/processor/finish_operation_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

data/lib/auction_fun_core/contracts/auction_context/processor/finish_contract.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module AuctionFunCore
-  module Contracts
-    module AuctionContext
-      module Processor
-        ##
-        # Contract class for finish auctions.
-        #
-        class FinishContract < Contracts::ApplicationContract
-          option :auction_repo, default: proc { Repos::AuctionContext::AuctionRepository.new }
-
-          params do
-            required(:auction_id).filled(:integer)
-          end
-
-          # Validation for auction.
-          # Validates if the auction exists in the database.
-          rule(:auction_id) do |context:|
-            context[:auction] ||= auction_repo.by_id(value)
-            key.failure(I18n.t("contracts.errors.custom.not_found")) unless context[:auction]
-          end
-        end
-      end
-    end
-  end
-end

data/lib/auction_fun_core/operations/auction_context/processor/finish_operation.rb

@@ -1,61 +0,0 @@
-# frozen_string_literal: true
-
-module AuctionFunCore
-  module Operations
-    module AuctionContext
-      module Processor
-        ##
-        # Operation class for dispatch finish auction.
-        # By default, this change auction status from 'running' to 'finished'.
-        #
-        class FinishOperation < AuctionFunCore::Operations::Base
-          include Import["repos.auction_context.auction_repository"]
-          include Import["contracts.auction_context.processor.finish_contract"]
-
-          # @todo Add custom doc
-          def self.call(auction_id, &block)
-            operation = new.call(auction_id)
-
-            return operation unless block
-
-            Dry::Matcher::ResultMatcher.call(operation, &block)
-          end
-
-          # It only performs the basic processing of completing an auction.
-          # It just changes the status at the database level and triggers the finished event.
-          # @param auction_id [Integer] Auction ID
-          # @return [Dry::Monads::Result::Success, Dry::Monads::Result::Failure]
-          def call(auction_id)
-            yield validate(auction_id: auction_id)
-
-            auction_repository.transaction do |_t|
-              @auction, _ = auction_repository.update(auction_id, status: "finished")
-
-              publish_auction_finish_event(@auction)
-            end
-
-            Success(@auction)
-          end
-
-          private
-
-          # Calls the finish contract class to perform the validation
-          # of the informed attributes.
-          # @param attributes [Hash] auction attributes
-          # @return [Dry::Monads::Result::Success, Dry::Monads::Result::Failure]
-          def validate(attributes)
-            contract = finish_contract.call(attributes)
-
-            return Failure(contract.errors.to_h) if contract.failure?
-
-            Success(contract.to_h)
-          end
-
-          def publish_auction_finish_event(auction)
-            Application[:event].publish("auctions.finished", auction.to_h)
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-module AuctionFunCore
-  module Workers
-    module Operations
-      module AuctionContext
-        module Processor
-          ##
-          # BackgroundJob class for call finish auction operation.
-          #
-          class FinishOperationJob < Workers::ApplicationJob
-            include Import["repos.auction_context.auction_repository"]
-            include Import["operations.auction_context.processor.finish_operation"]
-
-            # @todo Add detailed documentation
-            def perform(auction_id, retry_count = 0)
-              auction = auction_repository.by_id!(auction_id)
-
-              finish_operation.call(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
-          end
-        end
-      end
-    end
-  end
-end