auction_fun_core 0.8.5 → 0.8.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b42434481eccb486a4e38674f4219b1969e8951bd0a06430066a2ca9e9c9931d
-  data.tar.gz: a243a07a6b63c1e9a10f17a616290b1eea8c825af4a5e1a47e7f4f3515e192c6
+  metadata.gz: 3dc7fade29c1849f1e1c8d9a67cd060e0ceeac555290cf9cc3588a27eab72ee0
+  data.tar.gz: 7995c3ca65daa279c8e989771f7989e06695fcbdef4d7472c4f5aee0c02048f1
 SHA512:
-  metadata.gz: 6a3d12e06b32f527e2744f996b14716e32e6f496a5367452eeeae62425a34c7a90878c2f256e901a9a165b00325838f0bba29526580d02dc65d0240c4444d2f8
-  data.tar.gz: 4dcaa1d26811cdab77368cc5eb5567b83a5cf647e9f123ecaed217e41e908e7f1ea6e56a5fcfccc6410f04e9ba91b054fe282c41a7c7b1b5806556006f76e703
+  metadata.gz: ddfa76b5f57846ed62986520b98c367f46490c6d74aebd55b45ff033f84ddfb31f95dc370afec5159b49e93bdf678b4d63437b58bcc47e63c6461b5963aa6d31
+  data.tar.gz: eddbd9f79955aed50f5ac48605a16454bb93329e3e87fb21eb8437c0af43291b0ec84f3b29099635fa7cb89cab0e4cd0cdc8cfec433b3e003d1b69a94ace1f4a

data/CHANGELOG.md

@@ -1,5 +1,30 @@
 ## [Unreleased]
 
+## [0.8.7] - 2024-04-23
+
+### Added
+
+- Removing default values from relations;
+- Rebuild factories to not contain default values;
+- Add automated tests for auction relations;
+
+## [0.8.6] - 2024-04-23
+
+### Added
+
+- Auction finalization configured for each type of auction;
+- Add operations for winner and participant of an auction;
+- Configure background job to work with unique jobs;
+- Add 'sidekiq-unique-jobs' to be responsible for finishing penny auctions;
+
+### Changed:
+
+- General improvements on seed data;
+
+### Fixed:
+
+- NameError: uninitialized constant AuctionFunCore::Workers::ApplicationJob::Sidekiq (NameError)
+
 ## [0.8.5] - 2024-04-03
 
 ### Added

data/auction_fun_core.gemspec

@@ -49,6 +49,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "rom", "5.3.0"
   spec.add_dependency "rom-sql", "3.6.2"
   spec.add_dependency "sidekiq", "7.2.2"
+  spec.add_dependency "sidekiq-unique-jobs", "8.0.10"
   spec.add_dependency "yard", "0.9.36"
   spec.add_dependency "zeitwerk", "2.6.13"
 

data/db/migrate/20240229143000_create_auctions.rb

@@ -5,6 +5,7 @@ ROM::SQL.migration do
     create_table(:auctions) do
       primary_key :id
       foreign_key :staff_id, :staffs, null: false
+      foreign_key :winner_id, :users
       column :title, String, null: false
       column :description, :text
       column :kind, :auction_kinds, null: false

data/db/seeds.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require "pry"
 require "faker"
+require "pry"
 
 I18n.enforce_available_locales = false
 Faker::Config.locale = "pt-BR"
@@ -13,7 +13,6 @@ STOPWATCH_OPTIONS = [15, 30, 45, 60].freeze
 AuctionFunCore::Application.start(:core)
 
 # Instantiate repos
-auction_repository = AuctionFunCore::Repos::AuctionContext::AuctionRepository.new
 staff_repository = AuctionFunCore::Repos::StaffContext::StaffRepository.new
 
 # Create root staff. Create as a regular user using the normal flow and after that
@@ -44,6 +43,19 @@ AuctionFunCore::Operations::StaffContext::RegistrationOperation.call(common_staf
   result.success { |staff| @staff = staff }
 end
 
+# Add some users
+100.times do
+  attributes = {
+    name: Faker::Name.name, email: Faker::Internet.unique.email,
+    phone: Faker::PhoneNumber.unique.cell_phone_in_e164, password: "password",
+    password_confirmation: "password"
+  }
+  AuctionFunCore::Operations::UserContext::RegistrationOperation.call(attributes) do |result|
+    result.failure { |failure| raise "Error to create user: #{failure}" }
+    result.success { |user| puts "Create user with: #{user.to_h}" }
+  end
+end
+
 # Create some standard auctions
 (1..15).each do |i|
   attributes = {
@@ -53,7 +65,31 @@ end
   }
   AuctionFunCore::Operations::AuctionContext::CreateOperation.call(attributes) do |result|
     result.failure { |failure| raise "Error to create standard auction: #{failure}" }
-    result.success { |auction| puts "Create standard auction with: #{auction.to_h}" }
+    result.success do |auction|
+      @auction = auction
+      puts "Create standard auction with: #{auction.to_h}"
+    end
+  end
+
+  # Create auctions that have no bid. Multiples if 7
+  next if (i % 7).zero?
+
+  # Increase the value of each new bid by 10%
+  @current_bid = @auction.minimal_bid_cents
+  @minimal_percentage = 0.1
+  # Create some bids for standard auctions based on total users
+  (2..100).to_a.sample(rand(1..100)).each_with_index do |user_id, index|
+    @current_bid = index.zero? ? @current_bid : (@current_bid + (@current_bid * @minimal_percentage)).round(half: :up)
+    bid_params = {
+      auction_id: @auction.id,
+      user_id: user_id,
+      value_cents: @current_bid
+    }
+
+    AuctionFunCore::Operations::BidContext::CreateBidStandardOperation.call(bid_params) do |result|
+      result.failure { |failure| raise "Error to create bid: #{failure}" }
+      result.success { |bid| puts "Create standard bid with: #{bid.to_h}" }
+    end
   end
 end
 
@@ -65,52 +101,67 @@ end
 
   attributes = {
     staff_id: @staff.id, title: Faker::Commerce.product_name, description: Faker::Lorem.paragraph_by_chars,
-    kind: "penny", started_at: started_at, finished_at: finished_at, stopwatch: stopwatch
+    kind: "penny", started_at: started_at, finished_at: finished_at, stopwatch: stopwatch,
+    initial_bid_cents: (i * 100), minimal_bid_cents: (i * 100)
   }
   AuctionFunCore::Operations::AuctionContext::CreateOperation.call(attributes) do |result|
     result.failure { |failure| raise "Error to create penny auction: #{failure}" }
-    result.success { |auction| puts "Create penny auction with: #{auction.to_h}" }
+    result.success do |auction|
+      @auction = auction
+      puts "Create penny auction with: #{auction.to_h}"
+    end
+  end
+
+  # Create auctions that have no bid. Multiples if 7
+  next if (i % 7).zero?
+
+  # Create some bids for penny auctions based on total users
+  (2..100).to_a.sample(rand(1..100)).each do |user_id|
+    bid_params = {
+      auction_id: @auction.id,
+      user_id: user_id,
+      value_cents: @auction.minimal_bid_cents
+    }
+
+    AuctionFunCore::Operations::BidContext::CreateBidPennyOperation.call(bid_params) do |result|
+      result.failure { |failure| raise "Error to create bid: #{failure}" }
+      result.success { |bid| puts "Create penny bid with: #{bid.to_h}" }
+    end
   end
 end
 
 # Create some closed auctions
-(1..3).each do |i|
+(1..5).each do |i|
   attributes = {
-    staff_id: @staff.id, title: Faker::Commerce.product_name, kind: "closed",
-    started_at: i.hour.from_now, finished_at: i.day.from_now.end_of_day,
+    staff_id: @staff.id, title: Faker::Commerce.product_name, description: Faker::Lorem.paragraph_by_chars,
+    kind: "closed", started_at: i.hour.from_now, finished_at: i.day.from_now.end_of_day,
     initial_bid_cents: (i * 1000)
   }
   AuctionFunCore::Operations::AuctionContext::CreateOperation.call(attributes) do |result|
     result.failure { |failure| raise "Error to create closed auction: #{failure}" }
-    result.success { |auction| puts "Create closed auction with: #{auction.to_h}" }
+    result.success do |auction|
+      @auction = auction
+      puts "Create closed auction with: #{auction.to_h}"
+    end
   end
-end
-
-# Add some users
-100.times do
-  attributes = {
-    name: Faker::Name.name, email: Faker::Internet.unique.email,
-    phone: Faker::PhoneNumber.unique.cell_phone_in_e164, password: "password",
-    password_confirmation: "password"
-  }
-  AuctionFunCore::Operations::UserContext::RegistrationOperation.call(attributes) do |result|
-    result.failure { |failure| raise "Error to create user: #{failure}" }
-    result.success { |user| puts "Create user with: #{user.to_h}" }
-  end
-end
-
-# Create some bids
-auction_repository.all.each do |auction|
-  next if auction.id.even?
-
-  bid_params = {
-    auction_id: auction.id,
-    user_id: rand(2..100),
-    value_cents: auction.minimal_bid_cents + (auction.minimal_bid_cents * 0.10)
-  }
 
-  "AuctionFunCore::Operations::BidContext::CreateBid#{auction.kind.capitalize}Operation".constantize.call(bid_params) do |result|
-    result.failure { |failure| raise "Error to create bid: #{failure}" }
-    result.success { |bid| puts "Create bid with: #{bid.to_h}" }
+  # Create auctions that have no bid. Pair numbers
+  next if i.even?
+
+  @minimal_bid = @auction.minimal_bid_cents
+  # Create some bids for closed auctions based on total users
+  (2..100).to_a.sample(rand(1..100)).each_with_index do |user_id, index|
+    # Choosing a random value for the bid, obeying the rule that it has to be just greater than the minimum bid.
+    random_bid = index.zero? ? @minimal_bid : rand((@minimal_bid + 1)..10_000).round
+    bid_params = {
+      auction_id: @auction.id,
+      user_id: user_id,
+      value_cents: random_bid
+    }
+
+    AuctionFunCore::Operations::BidContext::CreateBidClosedOperation.call(bid_params) do |result|
+      result.failure { |failure| raise "Error to create bid: #{failure}" }
+      result.success { |bid| puts "Create closed bid with: #{bid.to_h}" }
+    end
   end
 end

data/i18n/en-US/contracts/contracts.en-US.yml

@@ -70,3 +70,12 @@ en-US:
         auction_context:
           create:
             finished_at: "must be after started time"
+          post_auction:
+            participant:
+              none: "there was no participation from this user in the auction reported"
+            winner:
+              wrong: "was not the winner of this auction"
+          processor:
+            finish:
+              invalid_kind: "auction with invalid type"
+              invalid_status: "auction with invalid status"

data/i18n/en-US/mail/application.en-US.yml

@@ -0,0 +1,59 @@
+en-US:
+  date:
+    abbr_day_names:
+      - Sun
+      - Mon
+      - Tue
+      - Wed
+      - Thu
+      - Fri
+      - Sat
+    abbr_month_names:
+      -
+      - Jan
+      - Feb
+      - Mar
+      - Apr
+      - May
+      - Jun
+      - Jul
+      - Aug
+      - Sep
+      - Oct
+      - Nov
+      - Dec
+    day_names:
+      - Sunday
+      - Monday
+      - Tuesday
+      - Wednesday
+      - Thursday
+      - Friday
+      - Saturday
+    formats:
+      default: "%Y-%m-%d"
+      long: "%B %d, %Y"
+      short: "%b %d"
+    month_names:
+      -
+      - January
+      - February
+      - March
+      - April
+      - May
+      - June
+      - July
+      - August
+      - September
+      - October
+      - November
+      - December
+    order:
+      - :year
+      - :month
+      - :day
+  application:
+    general:
+      hello: "Hi %{name}"
+      app_name: "AuctionFun"
+      team: "Team AuctionFun"

data/i18n/en-US/mail/auction_context/post_auction/participant.en-US.yml

@@ -0,0 +1,13 @@
+en-US:
+  mail:
+    auction_context:
+      post_auction:
+        participant_mailer:
+          subject: "Thank you for participating in the auction %{title}"
+          body:
+            description: "Thank you for participating in the auction <b>%{title}</b>! Although you weren't the winner this time, we would like to recognize your efforts and share some statistics on your performance:"
+            stats:
+              auction_total_bids: "Total auction bids: %{auction_total_bids}"
+              winner_bid: "Winner bid: %{winner_bid}"
+              auction_date: "Auction Date"
+            regards: "We hope you found the experience enriching and invite you to participate in our future auctions. Follow our website and social media to stay up to date with upcoming opportunities."

data/i18n/en-US/mail/auction_context/post_auction/winner.en-US.yml

@@ -0,0 +1,13 @@
+en-US:
+  mail:
+    auction_context:
+      post_auction:
+        winner_mailer:
+          subject: "Congratulations! You are the winner of the auction %{title}!"
+          body:
+            description: "We are very happy to inform you that you were the winner of our auction <b>%{title}</b>! Your bid was the highest, and you are now the new owner of item. Below is some information and statistics about the auction:"
+            item:
+              title: "Auctioned item: <b>%{title}</b>"
+              winner_bid: "Your Winning Bid: %{winner_bid}"
+              auction_total_bids: "Total Number of Bids: %{auction_total_bids}"
+              auction_date: "Auction Date"

data/i18n/pt-BR/contracts/contracts.pt-BR.yml

@@ -70,3 +70,12 @@ pt-BR:
         auction_context:
           create:
             finished_at: "deve ser depois da hora de início"
+          post_auction:
+            participant:
+              none: "não houve nenhuma participação deste usuário no leilão informado"
+            winner:
+              wrong: "não foi o vencedor deste leilão"
+          processor:
+            finish:
+              invalid_kind: "leilão com tipo inválido"
+              invalid_status: "leilão com status inválido"

data/i18n/pt-BR/mail/application.pt-BR.yml

@@ -0,0 +1,59 @@
+pt-BR:
+  date:
+    abbr_day_names:
+      - Dom
+      - Seg
+      - Ter
+      - Qua
+      - Qui
+      - Sex
+      - Sáb
+    abbr_month_names:
+      -
+      - Jan
+      - Fev
+      - Mar
+      - Abr
+      - Mai
+      - Jun
+      - Jul
+      - Ago
+      - Set
+      - Out
+      - Nov
+      - Dez
+    day_names:
+      - Domingo
+      - Segunda-feira
+      - Terça-feira
+      - Quarta-feira
+      - Quinta-feira
+      - Sexta-feira
+      - Sábado
+    formats:
+      default: "%d/%m/%Y"
+      long: "%d de %B de %Y"
+      short: "%d de %B"
+    month_names:
+      -
+      - Janeiro
+      - Fevereiro
+      - Março
+      - Abril
+      - Maio
+      - Junho
+      - Julho
+      - Agosto
+      - Setembro
+      - Outubro
+      - Novembro
+      - Dezembro
+    order:
+      - :day
+      - :month
+      - :year
+  application:
+    general:
+      hello: "Olá %{name}"
+      app_name: "AuctionFun"
+      team: "Time AuctionFun"

data/i18n/pt-BR/mail/auction_context/post_auction/participant.pt-BR.yml

@@ -0,0 +1,13 @@
+pt-BR:
+  mail:
+    auction_context:
+      post_auction:
+        participant_mailer:
+          subject: "Sua participação no leilão %{title}"
+          body:
+            description: "Agradecemos por participar do leilão <b>%{title}</b>! Embora você não tenha sido o vencedor desta vez, gostaríamos de reconhecer o seu empenho e compartilhar algumas estatísticas do seu desempenho:"
+            stats:
+              auction_total_bids: "Total de lances do leilão: %{auction_total_bids}"
+              winner_bid: "Lance vencedor: %{winner_bid}"
+              auction_date: "Data do Leilão"
+            regards: "Esperamos que você tenha encontrado a experiência enriquecedora e convidamos você a participar de nossos futuros leilões. Acompanhe nosso site e redes sociais para ficar por dentro das próximas oportunidades."

data/i18n/pt-BR/mail/auction_context/post_auction/winner.pt-BR.yml

@@ -0,0 +1,13 @@
+pt-BR:
+  mail:
+    auction_context:
+      post_auction:
+        winner_mailer:
+          subject: "Parabéns! Você é o vencedor do leilão %{title}!"
+          body:
+            description: "Estamos muito felizes em informar que você foi o vencedor do leilão <b>%{title}</b>! Seu lance foi o maior, e agora você é o novo proprietário do item. Abaixo estão algumas informações e estatísticas sobre o leilão:"
+            item:
+              title: "Item Arrematado: <b>%{title}</b>"
+              winner_bid: "Seu Lance Vencedor: %{winner_bid}"
+              auction_total_bids: "Número Total de Lances: %{auction_total_bids}"
+              auction_date: "Data do Leilão"

data/i18n/pt-BR/mail/user_context/registration.pt-BR.yml

@@ -1,9 +1,5 @@
 pt-BR:
   mail:
-    general:
-      hello: "Olá %{name}"
-      app_name: "AuctionFun"
-      team: "Time AuctionFun"
     user_context:
       registration:
         subject: "Bem vindo a AuctionFun"

data/lib/auction_fun_core/contracts/auction_context/post_auction/participant_contract.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module AuctionFunCore
+  module Contracts
+    module AuctionContext
+      module PostAuction
+        ##
+        # Contract class for validate participation auction.
+        #
+        class ParticipantContract < Contracts::ApplicationContract
+          I18N_SCOPE = "contracts.errors.custom.auction_context.post_auction.participation"
+
+          option :auction_repository, default: proc { Repos::AuctionContext::AuctionRepository.new }
+          option :user_repository, default: proc { Repos::UserContext::UserRepository.new }
+          option :bid_repository, default: proc { Repos::BidContext::BidRepository.new }
+
+          params do
+            required(:auction_id).filled(:integer)
+            required(:participant_id).filled(:integer)
+          end
+
+          rule(:auction_id) do |context:|
+            context[:auction] ||= auction_repository.by_id(value)
+            key.failure(I18n.t("contracts.errors.custom.not_found")) unless context[:auction]
+          end
+
+          rule(:participant_id) do |context:|
+            context[:participant] ||= user_repository.by_id(value)
+            key.failure(I18n.t("contracts.errors.custom.not_found")) unless context[:participant]
+          end
+
+          rule(:auction_id, :participant_id) do |context:|
+            next if (rule_error?(:auction_id) || schema_error?(:auction_id)) || (rule_error?(:winner_id) || schema_error?(:winner_id))
+            next if bid_repository.exists?(auction_id: values[:auction_id], user_id: values[:participant_id])
+
+            key(:participant_id).failure(I18n.t("none", scope: I18N_SCOPE))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/auction_fun_core/contracts/auction_context/post_auction/winner_contract.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module AuctionFunCore
+  module Contracts
+    module AuctionContext
+      module PostAuction
+        ##
+        # Contract class for validate winner auction.
+        #
+        class WinnerContract < Contracts::ApplicationContract
+          I18N_SCOPE = "contracts.errors.custom.auction_context.post_auction.winner"
+
+          option :auction_repository, default: proc { Repos::AuctionContext::AuctionRepository.new }
+          option :user_repository, default: proc { Repos::UserContext::UserRepository.new }
+
+          params do
+            required(:auction_id).filled(:integer)
+            required(:winner_id).filled(:integer)
+          end
+
+          rule(:auction_id) do |context:|
+            context[:auction] ||= auction_repository.by_id(value)
+            key.failure(I18n.t("contracts.errors.custom.not_found")) unless context[:auction]
+          end
+
+          rule(:winner_id) do |context:|
+            context[:winner] ||= user_repository.by_id(value)
+            key.failure(I18n.t("contracts.errors.custom.not_found")) unless context[:winner]
+          end
+
+          rule(:auction_id, :winner_id) do |context:|
+            next if (rule_error?(:auction_id) || schema_error?(:auction_id)) || (rule_error?(:winner_id) || schema_error?(:winner_id))
+            next if context[:auction].winner_id == values[:winner_id]
+
+            key(:winner_id).failure(I18n.t("wrong", scope: I18N_SCOPE))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/auction_fun_core/contracts/auction_context/processor/finish/closed_contract.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module AuctionFunCore
+  module Contracts
+    module AuctionContext
+      module Processor
+        module Finish
+          ##
+          # Contract class for finishing closed auctions.
+          #
+          class ClosedContract < Contracts::ApplicationContract
+            I18N_SCOPE = "contracts.errors.custom.auction_context.processor.finish"
+
+            option :auction_repository, 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_repository.by_id(value)
+              key.failure(I18n.t("contracts.errors.custom.not_found")) unless context[:auction]
+            end
+
+            # Validation for kind.
+            #
+            rule do |context:|
+              next if context[:auction].present? && context[:auction].kind == "closed"
+
+              key(:base).failure(I18n.t("invalid_kind", scope: I18N_SCOPE))
+            end
+
+            # Validation for status.
+            #
+            rule do |context:|
+              next if context[:auction].present? && context[:auction].status == "running"
+
+              key(:base).failure(I18n.t("invalid_status", scope: I18N_SCOPE))
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/auction_fun_core/contracts/auction_context/processor/finish/penny_contract.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module AuctionFunCore
+  module Contracts
+    module AuctionContext
+      module Processor
+        module Finish
+          ##
+          # Contract class for finishing penny auctions.
+          #
+          class PennyContract < Contracts::ApplicationContract
+            I18N_SCOPE = "contracts.errors.custom.auction_context.processor.finish"
+
+            option :auction_repository, 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_repository.by_id(value)
+
+              key.failure(I18n.t("contracts.errors.custom.not_found")) unless context[:auction]
+            end
+
+            # Validation for kind.
+            #
+            rule do |context:|
+              next if context[:auction].present? && context[:auction].kind == "penny"
+
+              key(:base).failure(I18n.t("invalid_kind", scope: I18N_SCOPE))
+            end
+
+            # Validation for status.
+            #
+            rule do |context:|
+              next if context[:auction].present? && context[:auction].status == "running"
+
+              key(:base).failure(I18n.t("invalid_status", scope: I18N_SCOPE))
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/auction_fun_core/contracts/auction_context/processor/finish/standard_contract.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module AuctionFunCore
+  module Contracts
+    module AuctionContext
+      module Processor
+        module Finish
+          ##
+          # Contract class for finishing standard auctions.
+          #
+          class StandardContract < Contracts::ApplicationContract
+            I18N_SCOPE = "contracts.errors.custom.auction_context.processor.finish"
+
+            option :auction_repository, 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_repository.by_id(value)
+
+              key.failure(I18n.t("contracts.errors.custom.not_found")) unless context[:auction]
+            end
+
+            # Validation for kind.
+            #
+            rule do |context:|
+              next if context[:auction].present? && context[:auction].kind == "standard"
+
+              key(:base).failure(I18n.t("invalid_kind", scope: I18N_SCOPE))
+            end
+
+            # Validation for status.
+            #
+            rule do |context:|
+              next if context[:auction].present? && context[:auction].status == "running"
+
+              key(:base).failure(I18n.t("invalid_status", scope: I18N_SCOPE))
+            end
+          end
+        end
+      end
+    end
+  end
+end