auction_fun_core 0.8.5

data/db/migrate/20240229143000_create_auctions.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+ROM::SQL.migration do
+  change do
+    create_table(:auctions) do
+      primary_key :id
+      foreign_key :staff_id, :staffs, null: false
+      column :title, String, null: false
+      column :description, :text
+      column :kind, :auction_kinds, null: false
+      column :status, :auction_statuses, null: false
+      column :started_at, DateTime, null: false
+      column :finished_at, DateTime
+      column :stopwatch, Integer, null: false, default: 0
+      column :initial_bid_cents, Integer, null: false, default: 0
+      column :initial_bid_currency, String, null: false, default: "USD"
+      column :minimal_bid_cents, Integer, null: false, default: 0
+      column :minimal_bid_currency, String, null: false, default: "USD"
+      column :metadata, :jsonb, null: false, default: "{}"
+      column :statistics, :jsonb, null: false, default: "{}"
+
+      column :created_at, DateTime, null: false
+      column :updated_at, DateTime, null: false
+    end
+
+    add_index :auctions, %i[staff_id], name: "idx_admin"
+    add_index :auctions, %i[kind status], name: "idx_kind_status"
+  end
+end

data/db/migrate/20240304144422_create_bids.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+ROM::SQL.migration do
+  change do
+    create_table :bids do
+      primary_key :id
+      foreign_key :user_id, :users, null: false
+      foreign_key :auction_id, :auctions, null: false
+
+      column :value_cents, Integer, null: false, default: 0
+      column :value_currency, String, null: false, default: "USD"
+
+      column :created_at, DateTime, null: false
+      column :updated_at, DateTime, null: false
+    end
+
+    add_index :bids, %i[auction_id user_id], name: "idx_user_auction"
+  end
+end

data/db/seeds.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+require "pry"
+require "faker"
+
+I18n.enforce_available_locales = false
+Faker::Config.locale = "pt-BR"
+
+# Constants
+STOPWATCH_OPTIONS = [15, 30, 45, 60].freeze
+
+# Start application
+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
+# just change the type directly in the db.
+
+root_staff_attributes = {
+  kind: "root", name: "Root Bot", email: "rootbot@auctionfun.net",
+  phone: Faker::PhoneNumber.unique.cell_phone_in_e164,
+  password: "password", password_confirmation: "password"
+}
+
+AuctionFunCore::Operations::StaffContext::RegistrationOperation.call(root_staff_attributes) do |result|
+  result.failure { |failure| raise "Error to create root staff: #{failure}" }
+  result.success { |root| @root = root }
+end
+staff_repository.update(@root.id, kind: "root")
+
+# Add common staff
+
+common_staff_attributes = {
+  name: "Staff Bot", email: "staffbot@auctionfun.net",
+  phone: Faker::PhoneNumber.unique.cell_phone_in_e164,
+  password: "password", password_confirmation: "password"
+}
+
+AuctionFunCore::Operations::StaffContext::RegistrationOperation.call(common_staff_attributes) do |result|
+  result.failure { |failure| raise "Error to create common staff: #{failure}" }
+  result.success { |staff| @staff = staff }
+end
+
+# Create some standard auctions
+(1..15).each do |i|
+  attributes = {
+    staff_id: @staff.id, title: Faker::Commerce.product_name, description: Faker::Lorem.paragraph_by_chars,
+    kind: "standard", started_at: i.hour.from_now, finished_at: i.day.from_now,
+    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 standard auction: #{failure}" }
+    result.success { |auction| puts "Create standard auction with: #{auction.to_h}" }
+  end
+end
+
+# Create some penny auctions
+(1..10).each do |i|
+  stopwatch = STOPWATCH_OPTIONS.sample
+  started_at = i.hour.from_now
+  finished_at = started_at + stopwatch.seconds
+
+  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
+  }
+  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}" }
+  end
+end
+
+# Create some closed auctions
+(1..3).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,
+    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}" }
+  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}" }
+  end
+end

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

@@ -0,0 +1,72 @@
+en-US:
+  contracts:
+    errors:
+      or: "or"
+      array?: "must be an array"
+      empty?: "must be empty"
+      excludes?: "must not include %{value}"
+      excluded_from?:
+        arg:
+          default: "must not be one of: %{list}"
+          range: "must not be one of: %{list_left} - %{list_right}"
+      exclusion?: "must not be one of: %{list}"
+      eql?: "must be equal to %{left}"
+      not_eql?: "must not be equal to %{left}"
+      filled?: "must be filled"
+      format?: "is in invalid format"
+      number?: "must be a number"
+      odd?: "must be odd"
+      even?: "must be even"
+      gt?: "must be greater than %{num}"
+      gteq?: "must be greater than or equal to %{num}"
+      hash?: "must be a hash"
+      included_in?:
+        arg:
+          default: "must be one of: %{list}"
+          range: "must be one of: %{list_left} - %{list_right}"
+      inclusion?: "must be one of: %{list}"
+      includes?: "must include %{value}"
+      bool?: "must be boolean"
+      true?: "must be true"
+      false?: "must be false"
+      int?: "must be an integer"
+      float?: "must be a float"
+      decimal?: "must be a decimal"
+      date?: "must be a date"
+      date_time?: "must be a date time"
+      time?: "must be a time"
+      key?: "is required"
+      attr?: "is required"
+      lt?: "must be less than %{num}"
+      lteq?: "must be less than or equal to %{num}"
+      max_size?: "size cannot be greater than %{num}"
+      min_size?: "size cannot be less than %{num}"
+      none?: "cannot be defined"
+      str?: "must be a string"
+      type?: "must be %{type}"
+      size?:
+        arg:
+          default: "size must be %{size}"
+          range: "size must be within %{size_left} - %{size_right}"
+        value:
+          string:
+            arg:
+              default: "length must be %{size}"
+              range: "length must be within %{size_left} - %{size_right}"
+      custom:
+        default:
+          taken: "has already been taken"
+          not_found: "not found"
+          password_confirmation: "doesn't match password"
+          login_not_found: "Invalid credentials"
+          inactive_account: "Your account is suspended or inactive"
+          future: "must be in the future"
+        macro:
+          email_format: "need to be a valid email"
+          login_format: "invalid login"
+          name_format: "must be between %{min} and %{max} characters"
+          password_format: "must be between %{min} and %{max} characters"
+          phone_format: "need to be a valid mobile number"
+        auction_context:
+          create:
+            finished_at: "must be after started time"

data/i18n/en-US/mail/user_context/registration.en-US.yml

@@ -0,0 +1,11 @@
+en-US:
+  mail:
+    general:
+      hello: "Hi %{name}"
+      app_name: "AuctionFun"
+      team: "Team AuctionFun"
+    user_context:
+      registration:
+        subject: "Welcome to AuctionFun"
+        body:
+          description: "Welcome to our platform! We are delighted to have you on board. If you have any questions or need assistance, feel free to reach out."

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

@@ -0,0 +1,72 @@
+pt-BR:
+  contracts:
+    errors:
+      or: "ou"
+      array?: "deve ser um array"
+      empty?: "deve ficar vazio"
+      excludes?: "não deve incluir %{value}"
+      excluded_from?:
+        arg:
+          default: "não deve ser um de: %{list}"
+          range: "não deve ser um de: %{list_left} - %{list_right}"
+      exclusion?: "não deve ser um de: %{list}"
+      eql?: "deve ser igual a %{left}"
+      not_eql?: "não deve ser igual a %{left}"
+      filled?: "deve ser preenchido"
+      format?: "está em formato inválido"
+      number?: "deve ser um número"
+      odd?: "deve ser ímpar"
+      even?: "deve ser par"
+      gt?: "deve ser maior que %{num}"
+      gteq?: "deve ser maior ou igual a %{num}"
+      hash?: "deve ser do tipo hash"
+      included_in?:
+        arg:
+          default: "deve ser um de: %{list}"
+          range: "deve ser um de: %{list_left} - %{list_right}"
+      inclusion?: "deve ser um de: %{list}"
+      includes?: "deve incluir %{value}"
+      bool?: "deve ser booleano"
+      true?: "deve ser verdadeiro"
+      false?: "deve ser falso"
+      int?: "deve ser um número inteiro"
+      float?: "deve ser um número real"
+      decimal?: "deve ser um número decimal"
+      date?: "deve ser no formato de data"
+      date_time?: "deve ser no formato de data e hora"
+      time?: "deve ser no formato de tempo"
+      key?: "é requerido"
+      attr?: "é requerido"
+      lt?: "deve ser menor que %{num}"
+      lteq?: "deve ser menor ou igual a %{num}"
+      max_size?: "tamanho não pode ser maior que %{num}"
+      min_size?: "tamanho não pode ser menor que %{num}"
+      none?: "não pode ser definido"
+      str?: "deve ser do tipo texto"
+      type?: "deve ser do tipo %{type}"
+      size?:
+        arg:
+          default: "tamanho deve ser %{size}"
+          range: "tamanho deve ser entre %{size_left} e %{size_right}"
+        value:
+          string:
+            arg:
+              default: "deve ser %{size} caracteres"
+              range: "deve ser entre %{size_left} e %{size_right} caracteres"
+      custom:
+        default:
+          taken: "não está disponível"
+          not_found: "não encontrado"
+          password_confirmation: "não corresponde à senha"
+          login_not_found: "Credenciais inválidas"
+          inactive_account: "Sua conta está suspensa ou inativa"
+          future: "deve ser no futuro"
+        macro:
+          email_format: "não é um email válido"
+          login_format: "login inválido"
+          name_format: "deve ter entre %{min} e %{max} caracteres"
+          password_format: "deve ter entre %{min} e %{max} caracteres"
+          phone_format: "não é um número de celular válido"
+        auction_context:
+          create:
+            finished_at: "deve ser depois da hora de início"

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

@@ -0,0 +1,12 @@
+pt-BR:
+  mail:
+    general:
+      hello: "Olá %{name}"
+      app_name: "AuctionFun"
+      team: "Time AuctionFun"
+    user_context:
+      registration:
+        subject: "Bem vindo a AuctionFun"
+        body:
+          description: "Bem-vindo/a à nossa plataforma! Estamos encantados por tê-lo/a conosco. Se tiver alguma dúvida ou precisar de ajuda, não hesite em entrar em contato."
+          email_confirmation_token: "Esse é o seu token de confirmação: <b>%{token}</b>"

data/lib/auction_fun_core/business/configuration.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module AuctionFunCore
+  module Business
+    module Configuration
+      AUCTION_KINDS = Relations::Auctions::KINDS.values
+      AUCTION_STATUSES = Relations::Auctions::STATUSES.values
+      AUCTION_MIN_TITLE_LENGTH = 6
+      AUCTION_MAX_TITLE_LENGTH = 255
+      AUCTION_STOPWATCH_MIN_VALUE = 15
+      AUCTION_STOPWATCH_MAX_VALUE = 60
+      MIN_NAME_LENGTH = 6
+      MAX_NAME_LENGTH = 128
+      MIN_PASSWORD_LENGTH = 6
+      MAX_PASSWORD_LENGTH = 128
+    end
+  end
+end

data/lib/auction_fun_core/business/token_generator.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module AuctionFunCore
+  module Business
+    # Responsible for generating interaction tokens with system users for general operations.
+    module TokenGenerator
+      def self.generate_email_token(length = 20)
+        rlength = (length * 3) / 4
+        SecureRandom.urlsafe_base64(rlength).tr("lIO0", "sxyz")
+      end
+
+      def self.generate_phone_token(length = 6)
+        rand(0o00000..999_999).to_s.rjust(length, "0")
+      end
+    end
+  end
+end

data/lib/auction_fun_core/commands/auction_context/create_auction.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module AuctionFunCore
+  module Commands
+    module AuctionContext
+      ##
+      # Abstract base class for insert new tuples on auctions table.
+      # @abstract
+      class CreateAuction < ROM::Commands::Create[:sql]
+        relation :auctions
+        register_as :create
+        result :one
+
+        use :timestamps
+        timestamp :created_at, :updated_at
+      end
+    end
+  end
+end

data/lib/auction_fun_core/commands/auction_context/delete_auction.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module AuctionFunCore
+  module Commands
+    module AuctionContext
+      ##
+      # Abstract base class for removes tuples in auctions table.
+      # @abstract
+      class DeleteAuction < ROM::Commands::Delete[:sql]
+        relation :auctions
+        register_as :delete
+      end
+    end
+  end
+end

data/lib/auction_fun_core/commands/auction_context/update_auction.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module AuctionFunCore
+  module Commands
+    module AuctionContext
+      ##
+      # Abstract base class for updates all tuples in its auctions table with new attributes
+      # @abstract
+      class UpdateAuction < ROM::Commands::Update[:sql]
+        relation :auctions
+        register_as :update
+
+        use :timestamps
+        timestamp :updated_at
+      end
+    end
+  end
+end

data/lib/auction_fun_core/commands/bid_context/create_bid.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module AuctionFunCore
+  module Commands
+    module BidContext
+      ##
+      # Abstract base class for insert new tuples on bids table.
+      # @abstract
+      class CreateBid < ROM::Commands::Create[:sql]
+        relation :bids
+        register_as :create
+        result :one
+
+        use :timestamps
+        timestamp :created_at, :updated_at
+      end
+    end
+  end
+end

data/lib/auction_fun_core/commands/bid_context/delete_bid.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module AuctionFunCore
+  module Commands
+    module BidContext
+      ##
+      # Abstract base class for removes tuples in bids table.
+      # @abstract
+      class DeleteBid < ROM::Commands::Delete[:sql]
+        relation :bids
+        register_as :delete
+      end
+    end
+  end
+end

data/lib/auction_fun_core/commands/bid_context/update_bid.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module AuctionFunCore
+  module Commands
+    module BidContext
+      ##
+      # Abstract base class for updates all tuples in its bids table with new attributes
+      # @abstract
+      class UpdateBid < ROM::Commands::Update[:sql]
+        relation :bids
+        register_as :update
+
+        use :timestamps
+        timestamp :updated_at
+      end
+    end
+  end
+end

data/lib/auction_fun_core/commands/staff_context/create_staff.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module AuctionFunCore
+  module Commands
+    module StaffContext
+      ##
+      # Abstract base class for insert new tuples on staffs table.
+      # @abstract
+      class CreateStaff < ROM::Commands::Create[:sql]
+        relation :staffs
+        register_as :create
+        result :one
+
+        use :timestamps
+        timestamp :created_at, :updated_at
+      end
+    end
+  end
+end

data/lib/auction_fun_core/commands/user_context/create_user.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module AuctionFunCore
+  module Commands
+    module UserContext
+      ##
+      # Abstract base class for insert new tuples on users table.
+      # @abstract
+      class CreateUser < ROM::Commands::Create[:sql]
+        relation :users
+        register_as :create
+        result :one
+
+        use :timestamps
+        timestamp :created_at, :updated_at
+      end
+    end
+  end
+end

data/lib/auction_fun_core/contracts/application_contract.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "phonelib"
+
+module AuctionFunCore
+  module Contracts
+    # Abstract base class for contracts.
+    # @abstract
+    class ApplicationContract < Dry::Validation::Contract
+      include AuctionFunCore::Business::Configuration
+
+      I18N_MACRO_SCOPE = "contracts.errors.custom.macro"
+      EMAIL_REGEX = /\A[\w+\-.]+@[a-z\d-]+(\.[a-z\d-]+)*\.[a-z]+\z/i
+
+      config.messages.backend = :i18n
+      config.messages.default_locale = I18n.default_locale
+      config.messages.top_namespace = "contracts"
+      config.messages.load_paths << Application.root.join("i18n/#{I18n.default_locale}/contracts/contracts.#{I18n.default_locale}.yml").to_s
+
+      register_macro(:email_format) do
+        next if EMAIL_REGEX.match?(value)
+
+        key.failure(I18n.t(:email_format, scope: I18N_MACRO_SCOPE))
+      end
+
+      register_macro(:login_format) do
+        next if EMAIL_REGEX.match?(value) || Phonelib.parse(value).valid?
+
+        key.failure(I18n.t(:login_format, scope: I18N_MACRO_SCOPE))
+      end
+
+      register_macro(:name_format) do
+        next if value.length.between?(MIN_NAME_LENGTH, MAX_NAME_LENGTH)
+
+        key.failure(
+          I18n.t(:name_format, scope: I18N_MACRO_SCOPE, min: MIN_NAME_LENGTH, max: MAX_NAME_LENGTH)
+        )
+      end
+
+      register_macro(:phone_format) do
+        next if ::Phonelib.parse(value).valid?
+
+        key.failure(I18n.t(:phone_format, scope: I18N_MACRO_SCOPE))
+      end
+
+      register_macro(:password_format) do
+        next if value.length.between?(MIN_PASSWORD_LENGTH, MAX_PASSWORD_LENGTH)
+
+        key.failure(
+          I18n.t(:password_format, scope: I18N_MACRO_SCOPE, min: MIN_PASSWORD_LENGTH, max: MAX_PASSWORD_LENGTH)
+        )
+      end
+    end
+  end
+end