spree_cm_commissioner 1.11.0.pre.pre4 → 1.13.0

data/app/finders/spree_cm_commissioner/accommodations/find_variant.rb

@@ -1,35 +0,0 @@
-module SpreeCmCommissioner
-  module Accommodations
-    class FindVariant
-      attr_reader :vendor_id, :from_date, :to_date, :number_of_guests
-
-      def initialize(vendor_id:, from_date:, to_date:, number_of_adults:, number_of_kids:)
-        @vendor_id = vendor_id
-        @from_date = from_date
-        @to_date = to_date
-        @number_of_guests = number_of_adults.to_i + number_of_kids.to_i
-      end
-
-      def execute
-        Spree::Variant
-          .joins(:inventory_items)
-          .where(vendor_id: vendor_id)
-          .where(inventory_items: { inventory_date: date_range_excluding_checkout })
-          .where('CAST(public_metadata->\'cm_options\'->>\'number-of-adults\' AS INTEGER) +
-                  CAST(public_metadata->\'cm_options\'->>\'number-of-kids\' AS INTEGER) >= ?', number_of_guests
-          )
-          .where('inventory_items.quantity_available > 0')
-          .distinct
-      end
-
-      private
-
-      # Why? check_out date is not considered to be charged
-      # For example, if you check in on 2023-10-01 and check out on 2023-10-02,
-      # you will be charged for one night (2023-10-01).
-      def date_range_excluding_checkout
-        from_date..to_date.prev_day
-      end
-    end
-  end
-end

data/app/interactors/spree_cm_commissioner/ensure_correct_product_type.rb

@@ -1,40 +0,0 @@
-module SpreeCmCommissioner
-  class EnsureCorrectProductType < BaseInteractor
-    def call
-      Spree::Product
-        .left_joins(variants_including_master: %i[inventory_items line_items])
-        .where(
-          'spree_variants.product_type IS NULL OR
-          spree_variants.product_type != spree_products.product_type OR
-
-          cm_inventory_items.product_type IS NULL OR
-          cm_inventory_items.product_type != spree_products.product_type OR
-
-          spree_line_items.product_type IS NULL OR
-          spree_line_items.product_type != spree_products.product_type OR
-
-          spree_products.product_type IS NOT NULL
-          '
-        )
-        .distinct.find_each do |product|
-        sync_product_type_for(product)
-      end
-    end
-
-    def sync_product_type_for(product)
-      product_type = Spree::Variant.product_types[product.product_type]
-
-      product.variants_including_master
-             .where('spree_variants.product_type IS NULL OR spree_variants.product_type != ?', product_type)
-             .update_all(product_type: product_type) # rubocop:disable Rails/SkipsModelValidations
-
-      product.line_items
-             .where('spree_line_items.product_type IS NULL OR spree_line_items.product_type != ?', product_type)
-             .update_all(product_type: product_type) # rubocop:disable Rails/SkipsModelValidations
-
-      product.inventory_items
-             .where('cm_inventory_items.product_type IS NULL OR cm_inventory_items.product_type != ?', product_type)
-             .update_all(product_type: product_type) # rubocop:disable Rails/SkipsModelValidations
-    end
-  end
-end

data/app/interactors/spree_cm_commissioner/inventory_item_syncer.rb

@@ -1,25 +0,0 @@
-module SpreeCmCommissioner
-  class InventoryItemSyncer < BaseInteractor
-    # inventory_id_and_quantities = [{ inventory_id: inventory_item1.id, quantity: 5 } ]
-    delegate :inventory_id_and_quantities, to: :context
-
-    def call
-      ActiveRecord::Base.transaction do
-        inventory_items.each do |inventory_item|
-          quantity = inventory_id_and_quantities.find { |item| item[:inventory_id] == inventory_item.id }&.dig(:quantity) || 0
-          adjust_quantity_available(inventory_item, quantity)
-        end
-      end
-    end
-
-    private
-
-    def adjust_quantity_available(inventory_item, quantity)
-      inventory_item.update!(quantity_available: inventory_item.quantity_available + quantity)
-    end
-
-    def inventory_items
-      @inventory_items ||= InventoryItem.where(id: inventory_id_and_quantities.pluck(:inventory_id))
-    end
-  end
-end

data/app/interactors/spree_cm_commissioner/stock/inventory_items_adjuster.rb

@@ -1,13 +0,0 @@
-module SpreeCmCommissioner
-  module Stock
-    class InventoryItemsAdjuster < BaseInteractor
-      delegate :variant, :quantity, to: :context
-
-      def call
-        variant.inventory_items.active.find_each do |inventory_item|
-          inventory_item.adjust_quantity!(quantity)
-        end
-      end
-    end
-  end
-end

data/app/interactors/spree_cm_commissioner/stock/inventory_items_generator.rb

@@ -1,15 +0,0 @@
-module SpreeCmCommissioner
-  module Stock
-    class InventoryItemsGenerator < BaseInteractor
-      delegate :variant, to: :context
-
-      def call
-        if variant.permanent_stock?
-          SpreeCmCommissioner::Stock::PermanentInventoryItemsGenerator.call(variant_ids: [variant.id])
-        else
-          variant.create_default_non_permanent_inventory_item! unless variant.default_inventory_item_exist?
-        end
-      end
-    end
-  end
-end

data/app/interactors/spree_cm_commissioner/stock/permanent_inventory_items_generator.rb

@@ -1,75 +0,0 @@
-module SpreeCmCommissioner
-  module Stock
-    class PermanentInventoryItemsGenerator < BaseInteractor
-      delegate :variant_ids, to: :context
-
-      def variants_per_batch = 1000
-
-      def pre_inventory_days_for(variant)
-        context.pre_inventory_days || variant.pre_inventory_days
-      end
-
-      def call
-        variants.in_batches(of: variants_per_batch) do |batch|
-          generate_inventory_items_for_batch(batch)
-        end
-      end
-
-      private
-
-      def generate_inventory_items_for_batch(batch)
-        total_on_hand_by_variant = total_on_hand_for(batch)
-        batch.each do |variant|
-          count_on_hand = total_on_hand_by_variant[variant.id] || 0
-          generate_inventory_items_for_variant(variant, count_on_hand)
-        end
-      end
-
-      def generate_inventory_items_for_variant(variant, count_on_hand)
-        inventory_dates_for(variant).each do |inventory_date|
-          next if inventory_exist?(variant, inventory_date)
-
-          create_inventory_item(variant, inventory_date, count_on_hand)
-        end
-      end
-
-      def inventory_dates_for(variant)
-        start_date = Time.zone.tomorrow
-        end_date = Time.zone.today + pre_inventory_days_for(variant)
-
-        (start_date..end_date)
-      end
-
-      def inventory_exist?(variant, inventory_date)
-        variant.inventory_items.exists?(inventory_date: inventory_date)
-      end
-
-      def create_inventory_item(variant, inventory_date, count_on_hand)
-        variant.inventory_items.create!(
-          inventory_date: inventory_date,
-          quantity_available: count_on_hand,
-          max_capacity: count_on_hand,
-          product_type: variant.product_type
-        )
-      end
-
-      # Returns a hash: { variant_id => total_on_hand, ... }
-      def total_on_hand_for(variants)
-        variant_ids = variants.pluck(:id)
-
-        Spree::StockItem
-          .joins(:stock_location)
-          .where(deleted_at: nil, variant_id: variant_ids)
-          .where(spree_stock_locations: { active: true })
-          .group(:variant_id)
-          .sum(:count_on_hand)
-      end
-
-      def variants
-        scope = Spree::Variant.active.with_permanent_stock.where(is_master: false)
-        scope = scope.where(id: variant_ids) if variant_ids.present?
-        scope
-      end
-    end
-  end
-end

data/app/interactors/spree_cm_commissioner/stock/stock_movement_creator.rb

@@ -1,24 +0,0 @@
-module SpreeCmCommissioner
-  module Stock
-    class StockMovementCreator < BaseInteractor
-      delegate :variant_id, :stock_location_id, :current_store, :stock_movement_params, to: :context
-
-      def call
-        variant = current_store.variants.find(variant_id)
-
-        return context.fail!(message: Spree.t(:doesnt_track_inventory)) unless variant.track_inventory?
-
-        stock_location = Spree::StockLocation.find(stock_location_id)
-        stock_movement = stock_location.stock_movements.build(stock_movement_params)
-        stock_movement.stock_item = stock_location.set_up_stock_item(variant)
-
-        if stock_movement.save
-          SpreeCmCommissioner::Stock::InventoryItemsAdjusterJob.perform_later(variant_id: variant.id, quantity: stock_movement.quantity)
-          context.stock_movement = stock_movement
-        else
-          context.fail!(message: stock_movement.errors.full_messages.join(', '))
-        end
-      end
-    end
-  end
-end

data/app/interactors/spree_cm_commissioner/user_roles_assigner.rb

@@ -1,22 +0,0 @@
-module SpreeCmCommissioner
-  class UserRolesAssigner < BaseInteractor
-    delegate :user_id, :role_ids, to: :context
-
-    def call
-      context.fail!(message: I18n.t('user_roles_assigner.user_not_found')) unless user
-      context.fail!(message: I18n.t('user_roles_assigner.roles_empty')) if role_ids.blank?
-      update_roles
-    end
-
-    private
-
-    def user
-      @user ||= Spree::User.find_by(id: user_id)
-    end
-
-    def update_roles
-      user.role_users.where.not(role_id: role_ids).destroy_all
-      role_ids.each { |role_id| user.role_users.find_or_create_by(role_id: role_id) }
-    end
-  end
-end

data/app/jobs/spree_cm_commissioner/ensure_correct_product_type_job.rb

@@ -1,7 +0,0 @@
-module SpreeCmCommissioner
-  class EnsureCorrectProductTypeJob < ApplicationJob
-    def perform
-      SpreeCmCommissioner::EnsureCorrectProductType.call
-    end
-  end
-end

data/app/jobs/spree_cm_commissioner/inventory_item_syncer_job.rb

@@ -1,7 +0,0 @@
-module SpreeCmCommissioner
-  class InventoryItemSyncerJob < ApplicationUniqueJob
-    def perform(inventory_id_and_quantities:)
-      InventoryItemSyncer.call(inventory_id_and_quantities:)
-    end
-  end
-end

data/app/jobs/spree_cm_commissioner/stock/inventory_items_adjuster_job.rb

@@ -1,11 +0,0 @@
-module SpreeCmCommissioner
-  module Stock
-    class InventoryItemsAdjusterJob < ApplicationUniqueJob
-      def perform(variant_id:, quantity:)
-        variant = Spree::Variant.find(variant_id)
-
-        SpreeCmCommissioner::Stock::InventoryItemsAdjuster.call(variant: variant, quantity: quantity)
-      end
-    end
-  end
-end

data/app/jobs/spree_cm_commissioner/stock/inventory_items_generator_job.rb

@@ -1,11 +0,0 @@
-module SpreeCmCommissioner
-  module Stock
-    class InventoryItemsGeneratorJob < ApplicationUniqueJob
-      def perform(variant_id:)
-        variant = Spree::Variant.find(variant_id)
-
-        SpreeCmCommissioner::Stock::InventoryItemsGenerator.call(variant: variant)
-      end
-    end
-  end
-end

data/app/jobs/spree_cm_commissioner/stock/permanent_inventory_items_generator_job.rb

@@ -1,9 +0,0 @@
-module SpreeCmCommissioner
-  module Stock
-    class PermanentInventoryItemsGeneratorJob < ApplicationUniqueJob
-      def perform
-        SpreeCmCommissioner::Stock::PermanentInventoryItemsGenerator.call
-      end
-    end
-  end
-end

data/app/models/spree_cm_commissioner/inventory.rb

@@ -1,11 +0,0 @@
-module SpreeCmCommissioner
-  class Inventory
-    include ActiveModel::Model
-
-    attr_accessor :variant_id, :inventory_date, :quantity_available, :max_capacity, :product_type
-
-    validates :variant_id, presence: true
-    validates :quantity_available, numericality: { only_integer: true, greater_than_or_equal_to: 0 }, allow_nil: true
-    validates :max_capacity, numericality: { only_integer: true, greater_than_or_equal_to: 0 }, allow_nil: true
-  end
-end

data/app/models/spree_cm_commissioner/inventory_item.rb

@@ -1,56 +0,0 @@
-module SpreeCmCommissioner
-  class InventoryItem < ApplicationRecord
-    include SpreeCmCommissioner::ProductType
-
-    # Association
-    belongs_to :variant, class_name: 'Spree::Variant'
-
-    # Validation
-    validates :quantity_available, numericality: { greater_than_or_equal_to: 0 }
-    validates :max_capacity, numericality: { greater_than_or_equal_to: 0 } # Originally inventory of each variant.
-    validates :inventory_date, presence: true, if: :permanent_stock?
-    validates :variant_id, uniqueness: { scope: :inventory_date, message: -> (object, _data) { "The variant is taken on #{object.inventory_date}" } }
-
-    # Scope
-    scope :active, -> { where(inventory_date: nil).or(where('inventory_date >= ?', Time.zone.today)) }
-
-    before_save -> { self.product_type = variant.product_type }, if: -> { product_type.nil? }
-
-    # This method is only used when admin update stock
-    def adjust_quantity!(quantity)
-      with_lock do
-        self.max_capacity = max_capacity + quantity
-        self.quantity_available = [0, quantity_available + quantity].max
-        save!
-
-        # When user has been searched or booked a product, it has cached the quantity in redis,
-        # So we need to update redis cache if inventory key has been created in redis
-        adjust_quantity_in_redis(quantity)
-      end
-    end
-
-    def adjust_quantity_in_redis(quantity)
-      SpreeCmCommissioner.redis_pool.with do |redis|
-        cached_quantity_available = redis.get("inventory:#{id}")
-        # ignore if redis doesn't exist
-        return if cached_quantity_available.nil? # rubocop:disable Lint/NonLocalExitFromIterator
-
-        if quantity.positive?
-          redis.incrby("inventory:#{id}", quantity)
-        else
-          redis.decrby("inventory:#{id}", quantity.abs)
-        end
-      end
-    end
-
-    def active?
-      inventory_date.nil? || inventory_date >= Time.zone.today
-    end
-
-    def redis_expired_in
-      expired_in = 31_536_000 # 1 year for normal stock
-      expired_in = Time.parse(inventory_date.to_s).end_of_day.to_i - Time.zone.now.to_i if inventory_date.present?
-      [expired_in, 0].max
-    end
-  end
-end

data/app/models/spree_cm_commissioner/redis_stock/cached_inventory_items_builder.rb

@@ -1,40 +0,0 @@
-module SpreeCmCommissioner
-  module RedisStock
-    class CachedInventoryItemsBuilder
-      attr_reader :inventory_items
-
-      def initialize(inventory_items)
-        @inventory_items = inventory_items
-      end
-
-      # output: [ CachedInventoryItem(...), CachedInventoryItem(...) ]
-      def call
-        keys = inventory_items.map { |item| "inventory:#{item.id}" }
-        return [] unless keys.any?
-
-        counts = SpreeCmCommissioner.redis_pool.with { |redis| redis.mget(*keys) }
-        inventory_items.map.with_index do |inventory_item, i|
-          ::SpreeCmCommissioner::CachedInventoryItem.new(
-            inventory_key: keys[i],
-            active: inventory_item.active?,
-            quantity_available: cache_inventory(keys[i], inventory_item, counts[i]),
-            inventory_item_id: inventory_item.id,
-            variant_id: inventory_item.variant_id
-          )
-        end
-      end
-
-      private
-
-      def cache_inventory(key, inventory_item, count_in_redis)
-        return count_in_redis.to_i if count_in_redis.present?
-
-        SpreeCmCommissioner.redis_pool.with do |redis|
-          redis.set(key, inventory_item.quantity_available, ex: inventory_item.redis_expired_in)
-        end
-
-        inventory_item.quantity_available
-      end
-    end
-  end
-end

data/app/models/spree_cm_commissioner/redis_stock/inventory_updater.rb

@@ -1,126 +0,0 @@
-module SpreeCmCommissioner
-  module RedisStock
-    class InventoryUpdater
-      class UnableToRestock < StandardError; end
-      class UnableToUnstock < StandardError; end
-
-      def initialize(line_item_ids)
-        @line_item_ids = line_item_ids
-      end
-
-      def unstock!
-        keys, quantities, inventory_ids = extract_inventory_data
-
-        raise UnableToUnstock, Spree.t(:insufficient_stock_lines_present) unless unstock(keys, quantities)
-
-        inventory_id_and_quantities = inventory_ids.map.with_index do |inventory_id, i|
-          { inventory_id: inventory_id, quantity: -quantities[i] }
-        end
-
-        schedule_sync_inventory(inventory_id_and_quantities)
-      end
-
-      def restock!
-        keys, quantities, inventory_ids = extract_inventory_data
-
-        raise UnableToRestock unless restock(keys, quantities)
-
-        inventory_id_and_quantities = inventory_ids.map.with_index do |inventory_id, i|
-          { inventory_id: inventory_id, quantity: quantities[i] }
-        end
-
-        schedule_sync_inventory(inventory_id_and_quantities)
-      end
-
-      private
-
-      # only unstock or restock when variants is available, track inventory, not backorderable & not need_confirmation.
-      # otherwise, we can ignore them.
-      def line_items
-        return @line_items if defined?(@line_items)
-
-        @line_items = Spree::LineItem.where(id: @line_item_ids).includes(variant: :stock_items)
-        @line_items = @line_items.map do |line_item|
-          next unless line_item.variant.available?
-          next unless line_item.variant.should_track_inventory?
-          next if line_item.variant.backorderable?
-          next if line_item.variant.need_confirmation?
-
-          line_item
-        end.compact
-      end
-
-      def unstock(keys, quantities)
-        SpreeCmCommissioner.redis_pool.with do |redis|
-          redis.eval(unstock_redis_script, keys: keys, argv: quantities)
-        end.positive?
-      end
-
-      def restock(keys, quantities)
-        SpreeCmCommissioner.redis_pool.with do |redis|
-          redis.eval(restock_redis_script, keys: keys, argv: quantities)
-        end.positive?
-      end
-
-      # Return: [CachedInventoryItem(...), CachedInventoryItem(...)]
-      def cached_inventory_items
-        @cached_inventory_items ||= SpreeCmCommissioner::RedisStock::LineItemsCachedInventoryItemsBuilder.new(line_item_ids: line_items.pluck(:id))
-                                                                                                         .call.values.flatten
-      end
-
-      def extract_inventory_data
-        keys = []
-        quantities = []
-        inventory_ids = []
-
-        cached_inventory_items.each do |cached_inventory_item|
-          keys << cached_inventory_item.inventory_key
-          quantities << line_items.find { |item| item.variant_id == cached_inventory_item.variant_id }.quantity
-          inventory_ids << cached_inventory_item.inventory_item_id
-        end
-
-        [keys, quantities, inventory_ids]
-      end
-
-      def unstock_redis_script
-        <<~LUA
-          local keys = KEYS
-          local quantities = ARGV
-
-          -- Check availability first
-          for i, key in ipairs(keys) do
-            local current = tonumber(redis.call('GET', key) or 0)
-            if current - tonumber(quantities[i]) < 0 then
-              return 0
-            end
-          end
-
-          -- Apply updates
-          for i, key in ipairs(keys) do
-            redis.call('DECRBY', key, tonumber(quantities[i]))
-          end
-
-          return 1
-        LUA
-      end
-
-      def restock_redis_script
-        <<~LUA
-          local keys = KEYS
-          local quantities = ARGV
-
-          -- Apply restock updates
-          for i, key in ipairs(keys) do
-            redis.call('INCRBY', key, tonumber(quantities[i]))
-          end
-
-          return 1
-        LUA
-      end
-
-      def schedule_sync_inventory(inventory_id_and_quantities)
-        SpreeCmCommissioner::InventoryItemSyncerJob.perform_later(inventory_id_and_quantities:)
-      end
-    end
-  end
-end

data/app/models/spree_cm_commissioner/redis_stock/line_items_cached_inventory_items_builder.rb

@@ -1,36 +0,0 @@
-module SpreeCmCommissioner
-  module RedisStock
-    class LineItemsCachedInventoryItemsBuilder
-      attr_reader :line_item_ids
-
-      def initialize(line_item_ids:)
-        @line_item_ids = line_item_ids
-      end
-
-      # return list of inventory items group by :line_item_id:
-      # {
-      #   1: [ CachedInventoryItem(...), CachedInventoryItem(...) ],
-      #   2: [ CachedInventoryItem(...), CachedInventoryItem(...) ],
-      # }
-      def call
-        cached_inventory_items.group_by do |cached_inventory_item|
-          line_item = line_items.find { |item| item.variant_id == cached_inventory_item.variant_id }
-          line_item.id
-        end
-      end
-
-      def cached_inventory_items
-        @cached_inventory_items ||= SpreeCmCommissioner::RedisStock::CachedInventoryItemsBuilder.new(inventory_items)
-                                                                                                .call
-      end
-
-      def inventory_items
-        @inventory_items ||= line_items.flat_map(&:inventory_items)
-      end
-
-      def line_items
-        @line_items ||= Spree::LineItem.where(id: line_item_ids).includes(:inventory_items)
-      end
-    end
-  end
-end

data/app/models/spree_cm_commissioner/redis_stock/variant_cached_inventory_items_builder.rb

@@ -1,27 +0,0 @@
-module SpreeCmCommissioner
-  module RedisStock
-    class VariantCachedInventoryItemsBuilder
-      attr_reader :variant_id, :from_date, :to_date
-
-      def initialize(variant_id:, from_date: nil, to_date: nil)
-        @variant_id = variant_id
-        @from_date = from_date
-        @to_date = to_date
-      end
-
-      # output: [ CachedInventoryItem(...), CachedInventoryItem(...) ]
-      def call
-        ::SpreeCmCommissioner::RedisStock::CachedInventoryItemsBuilder.new(inventory_items).call
-      end
-
-      def inventory_items
-        variant = Spree::Variant.find(variant_id)
-
-        inventory_items = variant.inventory_items
-        inventory_items.where(inventory_date: from_date..to_date) if variant.permanent_stock?
-
-        inventory_items
-      end
-    end
-  end
-end

data/app/models/spree_cm_commissioner/stock/order_availability_checker.rb

@@ -1,44 +0,0 @@
-# On top of SpreeCmCommissioner::Stock::AvailabilityChecker, this class does the same thing but in bulk check with redis.
-# Which mean, it check basic condition with db first, once pass, it check with redis.
-module SpreeCmCommissioner
-  module Stock
-    class OrderAvailabilityChecker
-      attr_reader :order
-
-      def initialize(order)
-        @order = order
-      end
-
-      def can_supply_all?
-        insufficient_stock_lines.empty?
-      end
-
-      def insufficient_stock_lines
-        cached_inventory_items_group_by_line_item_id.map do |line_item_id, cached_inventory_items|
-          line_item = order.line_items.find { |item| item.id == line_item_id }
-          line_item unless sufficient_stock_for?(line_item, cached_inventory_items)
-        end.compact
-      end
-
-      # {
-      #   1: [ {inventory_key: "inventory:1", active: true, quantity_available: 5, inventory_item_id: 1, variant_id: 1}],
-      #   2: [ {inventory_key: "inventory:2", active: true, quantity_available: 5, inventory_item_id: 2, variant_id: 2}],
-      # }
-      def cached_inventory_items_group_by_line_item_id
-        @cached_inventory_items_group_by_line_item_id ||=
-          ::SpreeCmCommissioner::RedisStock::LineItemsCachedInventoryItemsBuilder.new(
-            line_item_ids: order.line_items.pluck(:id)
-          ).call
-      end
-
-      def sufficient_stock_for?(line_item, cached_inventory_items)
-        return false unless line_item.variant.available?
-        return true unless line_item.variant.should_track_inventory?
-        return true if line_item.variant.backorderable?
-        return true if line_item.variant.need_confirmation?
-
-        cached_inventory_items.all? { |item| item.active? && item.quantity_available >= line_item.quantity }
-      end
-    end
-  end
-end

data/app/request_schemas/spree_cm_commissioner/variant_request_schema.rb

@@ -1,19 +0,0 @@
-module SpreeCmCommissioner
-  class VariantRequestSchema < ApplicationRequestSchema
-    params do
-      required(:from_date).value(:date)
-      required(:to_date).value(:date)
-      required(:adult).value(:integer)
-      required(:children).value(:integer)
-    end
-
-    rule(:from_date, :to_date) do
-      from_date = values[:from_date]
-      to_date   = values[:to_date]
-
-      key.failure(:must_be_in_future) if from_date < Time.zone.today
-      key.failure(:must_be_later_than_start_date) if from_date > to_date
-      key.failure(:stay_is_too_long) if (to_date - from_date).to_i > ENV.fetch('ACCOMMODATION_MAX_STAY_DAYS', 10).to_i
-    end
-  end
-end