auction_fun_core 0.8.5 → 0.8.7

data/lib/auction_fun_core/entities/auction.rb

@@ -5,6 +5,8 @@ module AuctionFunCore
     # Auction Relations class. This return simple objects with attribute readers
     # to represent data in your auction.
     class Auction < ROM::Struct
+      INQUIRER_ATTRIBUTES = Relations::Auctions::STATUSES.values.freeze
+
       def initial_bid
         Money.new(initial_bid_cents, initial_bid_currency)
       end
@@ -12,6 +14,10 @@ module AuctionFunCore
       def minimal_bid
         Money.new(minimal_bid_cents, minimal_bid_currency)
       end
+
+      def winner?
+        winner_id.present?
+      end
     end
   end
 end

data/lib/auction_fun_core/operations/auction_context/create_operation.rb

@@ -21,7 +21,8 @@ module AuctionFunCore
         end
 
         def call(attributes)
-          values = yield validate(attributes)
+          values = yield validate_contract(attributes)
+          values = yield assign_default_values(values)
 
           auction_repository.transaction do |_t|
             @auction = yield persist(values)
@@ -38,7 +39,7 @@ module AuctionFunCore
         # of the informed attributes.
         # @param attrs [Hash] auction attributes
         # @return [Dry::Monads::Result::Success, Dry::Monads::Result::Failure]
-        def validate(attrs)
+        def validate_contract(attrs)
           contract = create_contract.call(attrs)
 
           return Failure(contract.errors.to_h) if contract.failure?
@@ -46,6 +47,15 @@ module AuctionFunCore
           Success(contract.to_h)
         end
 
+        # By default, the auction status is set to 'scheduled'.
+        # @todo Refactor this method in the future to consider the status as of the auction start date.
+        # @param attrs [Hash] auction attributes
+        # @return [Dry::Monads::Result::Success]
+        def assign_default_values(attrs)
+          attrs[:status] = "scheduled"
+          Success(attrs)
+        end
+
         # Calls the auction repository class to persist the attributes in the database.
         # @param result [Hash] Auction validated attributes
         # @return [ROM::Struct::Auction]

data/lib/auction_fun_core/operations/auction_context/post_auction/participant_operation.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module AuctionFunCore
+  module Operations
+    module AuctionContext
+      module PostAuction
+        ##
+        # Operation class for finish auctions.
+        #
+        class ParticipantOperation < AuctionFunCore::Operations::Base
+          include Import["repos.user_context.user_repository"]
+          include Import["contracts.auction_context.post_auction.participant_contract"]
+          include Import["workers.services.mail.auction_context.post_auction.participant_mailer_job"]
+
+          def self.call(attributes, &block)
+            operation = new.call(attributes)
+
+            return operation unless block
+
+            Dry::Matcher::ResultMatcher.call(operation, &block)
+          end
+
+          ## @todo Add more actions
+          #   Send email to participant with auction statistics.
+          def call(attributes)
+            auction, participant = yield validate_contract(attributes)
+
+            user_repository.transaction do |_t|
+              yield send_participant_email_with_statistics_and_payment_instructions(auction.id, participant.id)
+            end
+
+            Success([auction, participant])
+          end
+
+          private
+
+          def validate_contract(attributes)
+            contract = participant_contract.call(attributes)
+
+            return Failure(contract.errors.to_h) if contract.failure?
+
+            Success([contract.context[:auction], contract.context[:participant]])
+          end
+
+          def send_participant_email_with_statistics_and_payment_instructions(auction_id, participant_id)
+            Success(participant_mailer_job.class.perform_async(auction_id, participant_id))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/auction_fun_core/operations/auction_context/post_auction/winner_operation.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module AuctionFunCore
+  module Operations
+    module AuctionContext
+      module PostAuction
+        ##
+        # Operation class for finish auctions.
+        #
+        class WinnerOperation < AuctionFunCore::Operations::Base
+          include Import["repos.user_context.user_repository"]
+          include Import["contracts.auction_context.post_auction.winner_contract"]
+          include Import["workers.services.mail.auction_context.post_auction.winner_mailer_job"]
+
+          def self.call(attributes, &block)
+            operation = new.call(attributes)
+
+            return operation unless block
+
+            Dry::Matcher::ResultMatcher.call(operation, &block)
+          end
+
+          ## @todo Add doc
+          def call(attributes)
+            auction, winner = yield validate_contract(attributes)
+
+            user_repository.transaction do |_t|
+              send_winner_email_with_statistics_and_payment_instructions(auction.id, winner.id)
+            end
+
+            Success([auction, winner])
+          end
+
+          private
+
+          def validate_contract(attributes)
+            contract = winner_contract.call(attributes)
+
+            return Failure(contract.errors.to_h) if contract.failure?
+
+            Success([contract.context[:auction], contract.context[:winner]])
+          end
+
+          def send_winner_email_with_statistics_and_payment_instructions(auction_id, winner_id)
+            Success(winner_mailer_job.class.perform_async(auction_id, winner_id))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/auction_fun_core/operations/auction_context/processor/finish/closed_operation.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module AuctionFunCore
+  module Operations
+    module AuctionContext
+      module Processor
+        module Finish
+          ##
+          # Operation class for finalizing a closed auction.
+          # By default, this change auction status from 'running' to 'finished'.
+          #
+          class ClosedOperation < AuctionFunCore::Operations::Base
+            include Import["repos.auction_context.auction_repository"]
+            include Import["contracts.auction_context.processor.finish.closed_contract"]
+            include Import["workers.operations.auction_context.post_auction.winner_operation_job"]
+            include Import["workers.operations.auction_context.post_auction.participant_operation_job"]
+
+            # @todo Add custom doc
+            def self.call(attributes, &block)
+              operation = new.call(attributes)
+
+              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(attributes)
+              auction = yield validate_contract(attributes)
+              summary = yield load_closed_auction_winners_and_participants(auction.id)
+              update_auction_attributes = yield update_finished_auction(auction, summary)
+
+              auction_repository.transaction do |_t|
+                auction, _ = auction_repository.update(auction.id, update_auction_attributes)
+
+                yield winner_operation(auction.id, summary.winner_id)
+
+                summary.participant_ids.each do |participant_id|
+                  yield participant_operation(auction.id, participant_id)
+                end
+
+                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_contract(attributes)
+              contract = closed_contract.call(attributes)
+
+              return Failure(contract.errors.to_h) if contract.failure?
+
+              Success(contract.context[:auction])
+            end
+
+            def load_closed_auction_winners_and_participants(auction_id)
+              summary = relation.load_closed_auction_winners_and_participants(auction_id).first
+
+              Success(summary)
+            end
+
+            def update_finished_auction(auction, summary)
+              attrs = {status: "finished"}
+              attrs[:winner_id] = summary.winner_id if summary.winner_id.present?
+
+              Success(attrs)
+            end
+
+            def relation
+              AuctionFunCore::Application[:container].relations[:auctions]
+            end
+
+            def winner_operation(auction_id, winner_id)
+              return Success() if winner_id.blank?
+
+              Success(winner_operation_job.class.perform_async(auction_id, winner_id))
+            end
+
+            def participant_operation(auction_id, participant_id)
+              Success(participant_operation_job.class.perform_async(auction_id, participant_id))
+            end
+
+            def publish_auction_finish_event(auction)
+              Application[:event].publish("auctions.finished", auction.to_h)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/auction_fun_core/operations/auction_context/processor/finish/penny_operation.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module AuctionFunCore
+  module Operations
+    module AuctionContext
+      module Processor
+        module Finish
+          ##
+          # Operation class for finalizing a penny auction.
+          # By default, this change auction status from 'running' to 'finished'.
+          #
+          class PennyOperation < AuctionFunCore::Operations::Base
+            include Import["repos.auction_context.auction_repository"]
+            include Import["contracts.auction_context.processor.finish.penny_contract"]
+            include Import["workers.operations.auction_context.post_auction.winner_operation_job"]
+            include Import["workers.operations.auction_context.post_auction.participant_operation_job"]
+
+            # @todo Add custom doc
+            def self.call(attributes, &block)
+              operation = new.call(attributes)
+
+              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(attributes)
+              auction = yield validate_contract(attributes)
+              summary = yield load_penny_auction_winners_and_participants(auction.id)
+              update_auction_attributes = yield update_finished_auction(auction, summary)
+
+              auction_repository.transaction do |_t|
+                auction, _ = auction_repository.update(auction.id, update_auction_attributes)
+
+                yield winner_operation(auction.id, summary.winner_id)
+
+                summary.participant_ids.each do |participant_id|
+                  yield participant_operation(auction.id, participant_id)
+                end
+
+                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_contract(attributes)
+              contract = penny_contract.call(attributes)
+
+              return Failure(contract.errors.to_h) if contract.failure?
+
+              Success(contract.context[:auction])
+            end
+
+            def load_penny_auction_winners_and_participants(auction_id)
+              summary = relation.load_penny_auction_winners_and_participants(auction_id).first
+
+              Success(summary)
+            end
+
+            def update_finished_auction(auction, summary)
+              attrs = {status: "finished"}
+              attrs[:winner_id] = summary.winner_id if summary.winner_id.present?
+
+              Success(attrs)
+            end
+
+            def relation
+              AuctionFunCore::Application[:container].relations[:auctions]
+            end
+
+            def winner_operation(auction_id, winner_id)
+              return Success() if winner_id.blank?
+
+              Success(winner_operation_job.class.perform_async(auction_id, winner_id))
+            end
+
+            def participant_operation(auction_id, participant_id)
+              Success(participant_operation_job.class.perform_async(auction_id, participant_id))
+            end
+
+            def publish_auction_finish_event(auction)
+              Application[:event].publish("auctions.finished", auction.to_h)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/auction_fun_core/operations/auction_context/processor/finish/standard_operation.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module AuctionFunCore
+  module Operations
+    module AuctionContext
+      module Processor
+        module Finish
+          ##
+          # Operation class for finalizing a standard auction.
+          # By default, this change auction status from 'running' to 'finished'.
+          #
+          class StandardOperation < AuctionFunCore::Operations::Base
+            include Import["repos.auction_context.auction_repository"]
+            include Import["contracts.auction_context.processor.finish.standard_contract"]
+            include Import["workers.operations.auction_context.post_auction.winner_operation_job"]
+            include Import["workers.operations.auction_context.post_auction.participant_operation_job"]
+
+            # @todo Add custom doc
+            def self.call(attributes, &block)
+              operation = new.call(attributes)
+
+              return operation unless block
+
+              Dry::Matcher::ResultMatcher.call(operation, &block)
+            end
+
+            # TODO: update doc
+            # 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 attrs [Hash] auction attributes
+            # @option auction_id [Integer] Auction ID
+            # @return [Dry::Monads::Result::Success, Dry::Monads::Result::Failure]
+            def call(attributes)
+              auction = yield validate_contract(attributes)
+              summary = yield load_standard_auction_winners_and_participants(auction.id)
+              update_auction_attributes = yield update_finished_auction(auction, summary)
+
+              auction_repository.transaction do |_t|
+                auction, _ = auction_repository.update(auction.id, update_auction_attributes)
+
+                yield winner_operation(auction.id, summary.winner_id)
+
+                summary.participant_ids.each do |participant_id|
+                  yield participant_operation(auction.id, participant_id)
+                end
+
+                publish_auction_finish_event(auction)
+              end
+
+              Success(auction)
+            end
+
+            private
+
+            # Calls the finish standard 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_contract(attributes)
+              contract = standard_contract.call(attributes)
+
+              return Failure(contract.errors.to_h) if contract.failure?
+
+              Success(contract.context[:auction])
+            end
+
+            def load_standard_auction_winners_and_participants(auction_id)
+              summary = relation.load_standard_auction_winners_and_participants(auction_id).first
+
+              Success(summary)
+            end
+
+            def update_finished_auction(auction, summary)
+              attrs = {status: "finished"}
+              attrs[:winner_id] = summary.winner_id if summary.winner_id.present?
+
+              Success(attrs)
+            end
+
+            def relation
+              AuctionFunCore::Application[:container].relations[:auctions]
+            end
+
+            def winner_operation(auction_id, winner_id)
+              return Success() if winner_id.blank?
+
+              Success(winner_operation_job.class.perform_async(auction_id, winner_id))
+            end
+
+            def participant_operation(auction_id, participant_id)
+              Success(participant_operation_job.class.perform_async(auction_id, participant_id))
+            end
+
+            def publish_auction_finish_event(auction)
+              Application[:event].publish("auctions.finished", auction.to_h)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -11,7 +11,9 @@ module AuctionFunCore
         class StartOperation < AuctionFunCore::Operations::Base
           include Import["repos.auction_context.auction_repository"]
           include Import["contracts.auction_context.processor.start_contract"]
-          include Import["workers.operations.auction_context.processor.finish_operation_job"]
+          include Import["workers.operations.auction_context.processor.finish.closed_operation_job"]
+          include Import["workers.operations.auction_context.processor.finish.penny_operation_job"]
+          include Import["workers.operations.auction_context.processor.finish.standard_operation_job"]
 
           # @todo Add custom doc
           def self.call(attributes, &block)
@@ -28,10 +30,10 @@ module AuctionFunCore
           # @option opts [Integer] :stopwatch auction stopwatch
           # @return [ROM::Struct::Auction] auction object
           def call(attributes)
-            attrs = yield validate(attributes)
+            auction, attrs = yield validate_contract(attributes)
 
             auction_repository.transaction do |_t|
-              @auction, _ = auction_repository.update(attrs[:auction_id], update_params(attrs))
+              @auction, _ = auction_repository.update(auction.id, update_params(auction, attrs))
 
               yield publish_auction_start_event(@auction)
               yield scheduled_finished_auction(@auction)
@@ -46,36 +48,46 @@ module AuctionFunCore
           # of the informed attributes.
           # @param attributes [Hash] auction attributes
           # @return [Dry::Monads::Result::Success, Dry::Monads::Result::Failure]
-          def validate(attributes)
+          def validate_contract(attributes)
             contract = start_contract.call(attributes)
 
             return Failure(contract.errors.to_h) if contract.failure?
 
-            Success(contract.to_h)
+            Success([contract.context[:auction], contract.to_h])
           end
 
           # Updates the status of the auction and depending on the type of auction,
           # it already sets the final date.
           # @param attrs [Hash] auction attributes
           # @return [Hash]
-          def update_params(attrs)
-            return {status: "running"} unless attrs[:kind] == "penny"
+          def update_params(auction, attrs)
+            return {kind: auction.kind, status: "running"} unless attrs[:kind] == "penny"
 
-            {status: "running", finished_at: attrs[:stopwatch].seconds.from_now}
+            {kind: auction.kind, status: "running", finished_at: attrs[:stopwatch].seconds.from_now}
           end
 
           def publish_auction_start_event(auction)
             Success(Application[:event].publish("auctions.started", auction.to_h))
           end
 
+          # TODO: Added a small delay to perform operations (such as sending broadcasts and/or other operations).
           # Calls the background job class that will schedule the finish of the auction.
-          # Added a small delay to perform operations (such as sending broadcasts and/or other operations).
+          # In the case of the penny auction, the end of the auction occurs after the first timer resets.
           # @param auction [ROM::Struct::Auction]
           # @return [String] sidekiq jid
           def scheduled_finished_auction(auction)
-            return Success() if auction.kind == "penny"
+            perform_at = auction.finished_at
 
-            Success(finish_operation_job.class.perform_at(auction.finished_at, auction.id))
+            case auction.kind
+            in "penny"
+              perform_at = auction.started_at + auction.stopwatch.seconds
+
+              Success(penny_operation_job.class.perform_at(perform_at, auction.id))
+            in "standard"
+              Success(standard_operation_job.class.perform_at(perform_at, auction.id))
+            in "closed"
+              Success(closed_operation_job.class.perform_at(perform_at, auction.id))
+            end
           end
         end
       end

data/lib/auction_fun_core/operations/bid_context/create_bid_penny_operation.rb

@@ -7,8 +7,10 @@ module AuctionFunCore
       # Operation class for create new bids for penny auctions.
       #
       class CreateBidPennyOperation < AuctionFunCore::Operations::Base
-        include Import["contracts.bid_context.create_bid_penny_contract"]
         include Import["repos.bid_context.bid_repository"]
+        include Import["repos.auction_context.auction_repository"]
+        include Import["contracts.bid_context.create_bid_penny_contract"]
+        include Import["workers.operations.auction_context.processor.finish.penny_operation_job"]
 
         # @todo Add custom doc
         def self.call(attributes, &block)
@@ -21,10 +23,13 @@ module AuctionFunCore
 
         # @todo Add custom doc
         def call(attributes)
-          values = yield validate(attributes)
+          auction, values = yield validate_contract(attributes)
 
           bid_repository.transaction do |_t|
             @bid = yield persist(values)
+            updated_auction = yield update_end_auction(auction)
+
+            yield reschedule_end_auction(updated_auction)
             yield publish_bid_created(@bid)
           end
 
@@ -35,19 +40,42 @@ module AuctionFunCore
         # of the informed attributes.
         # @param attrs [Hash] bid attributes
         # @return [Dry::Monads::Result::Success, Dry::Monads::Result::Failure]
-        def validate(attrs)
+        def validate_contract(attrs)
           contract = create_bid_penny_contract.call(attrs)
 
           return Failure(contract.errors.to_h) if contract.failure?
 
-          Success(contract.to_h)
+          Success([contract.context[:auction], contract.to_h])
+        end
+
+        # Updates the end time of an auction if it has already started.
+        #
+        # This method checks whether an auction is currently running. If the auction is running,
+        # it calculates a new end time based on the current time and the duration specified
+        # by the auction's stopwatch. The auction's finish time is then updated in the repository.
+        # If the auction has not started, it returns the auction as is without any modifications.
+        #
+        # @param auction [ROM::Struct::Auction] An instance of Auction to be checked and potentially updated.
+        # @return [Dry::Monads::Result::Success<ROM::Struct::Auction>, Dry::Monads::Result::Failure]
+        def update_end_auction(auction)
+          return Success(auction) unless started_auction?(auction)
+
+          updated_attributes = {
+            finished_at: Time.current + auction.stopwatch.seconds,
+            kind: auction.kind,
+            status: auction.status
+          }
+
+          updated_auction, _ = auction_repository.update(auction.id, updated_attributes)
+
+          Success(updated_auction)
         end
 
         # Calls the bid repository class to persist the attributes in the database.
         # @param result [Hash] Bid validated attributes
-        # @return [ROM::Struct::Bid]
-        def persist(result)
-          Success(bid_repository.create(result))
+        # @return [Dry::Monads::Result::Success<ROM::Struct::Bid>, Dry::Monads::Result::Failure]
+        def persist(values)
+          Success(bid_repository.create(values))
         end
 
         # Triggers the publication of event *bids.created*.
@@ -58,6 +86,28 @@ module AuctionFunCore
 
           Success()
         end
+
+        # TODO: Added a small delay to perform operations (such as sending broadcasts and/or other operations).
+        # Reschedules the end time of an auction's background job if the auction has already started.
+        #
+        # This method checks if the auction is running. If so, it schedules a background job to
+        # execute at the auction's current finish time using the job class defined by the
+        # penny_operation_job attribute of the auction. If the auction has not started, it
+        # simply returns a Success object with no parameters.
+        #
+        # @return [Dry::Monads::Result::Success<ROM::Struct::Auction>, Dry::Monads::Result::Success<String>]
+        def reschedule_end_auction(auction)
+          # binding.pry
+          return Success(auction) unless started_auction?(auction)
+
+          perform_at = auction.finished_at
+
+          Success(penny_operation_job.class.perform_at(perform_at, auction.id))
+        end
+
+        def started_auction?(auction)
+          auction.status == "running"
+        end
       end
     end
   end

data/lib/auction_fun_core/operations/staff_context/registration_operation.rb

@@ -21,6 +21,7 @@ module AuctionFunCore
         # @todo Add custom doc
         def call(attributes)
           values = yield validate_contract(attributes)
+          values = yield assign_default_values(values)
           values_with_encrypt_password = yield encrypt_password(values)
 
           staff_repository.transaction do |_t|
@@ -44,6 +45,15 @@ module AuctionFunCore
           Success(contract.to_h)
         end
 
+        # By default, there can only be a single root staff. All other members have their type set to 'common'.
+        # @param attrs [Hash] user attributes
+        # @return [Dry::Monads::Result::Success]
+        def assign_default_values(attrs)
+          attrs[:kind] = "common"
+
+          Success(attrs)
+        end
+
         # Transforms the password attribute, encrypting it to be saved in the database.
         # @param result [Hash] Staff valid contract attributes
         # @return [Hash] Valid staff database