spree_core 4.3.0 → 4.6.1

data/app/models/spree/order/digital.rb

@@ -0,0 +1,33 @@
+module Spree
+  class Order < Spree::Base
+    module Digital
+      def digital?
+        if line_items.empty?
+          false
+        else
+          line_items.all?(&:digital?)
+        end
+      end
+
+      def some_digital?
+        line_items.any?(&:digital?)
+      end
+
+      def digital_line_items
+        line_items.select(&:digital?)
+      end
+
+      def digital_links
+        digital_line_items.map(&:digital_links).flatten
+      end
+
+      def create_digital_links
+        digital_line_items.each do |line_item|
+          line_item.variant.digitals.each do |digital|
+            line_item.digital_links.create!(digital: digital)
+          end
+        end
+      end
+    end
+  end
+end

data/app/models/spree/order.rb

@@ -1,5 +1,6 @@
 require_dependency 'spree/order/checkout'
 require_dependency 'spree/order/currency_updater'
+require_dependency 'spree/order/digital'
 require_dependency 'spree/order/payments'
 require_dependency 'spree/order/store_credit'
 require_dependency 'spree/order/emails'
@@ -11,6 +12,7 @@ module Spree
 
     include Spree::Order::Checkout
     include Spree::Order::CurrencyUpdater
+    include Spree::Order::Digital
     include Spree::Order::Payments
     include Spree::Order::StoreCredit
     include Spree::Order::AddressBook
@@ -18,9 +20,20 @@ module Spree
     include Spree::Core::NumberGenerator.new(prefix: 'R')
     include Spree::Core::TokenGenerator
 
+    include NumberIdentifier
     include NumberAsParam
     include SingleStoreResource
     include MemoizedData
+    include Spree::Metadata
+    if defined?(Spree::Webhooks)
+      include Spree::Webhooks::HasWebhooks
+    end
+    if defined?(Spree::Security::Orders)
+      include Spree::Security::Orders
+    end
+    if defined?(Spree::VendorConcern)
+      include Spree::VendorConcern
+    end
 
     MEMOIZED_METHODS = %w(tax_zone)
 
@@ -54,26 +67,34 @@ module Spree
 
     checkout_flow do
       go_to_state :address
-      go_to_state :delivery
+      go_to_state :delivery, if: ->(order) { order.delivery_required? }
       go_to_state :payment, if: ->(order) { order.payment? || order.payment_required? }
       go_to_state :confirm, if: ->(order) { order.confirmation_required? }
       go_to_state :complete
       remove_transition from: :delivery, to: :confirm, unless: ->(order) { order.confirmation_required? }
     end
 
-    self.whitelisted_ransackable_associations = %w[shipments user promotions bill_address ship_address line_items store]
-    self.whitelisted_ransackable_attributes = %w[completed_at email number state payment_state shipment_state total considered_risky channel]
+    self.whitelisted_ransackable_associations = %w[shipments user created_by approver canceler promotions bill_address ship_address line_items store]
+    self.whitelisted_ransackable_attributes = %w[
+      completed_at email number state payment_state shipment_state
+      total item_total considered_risky channel
+    ]
 
     attr_reader :coupon_code
     attr_accessor :temporary_address, :temporary_credit_card
 
+    attribute :state_machine_resumed, :boolean
+
     if Spree.user_class
-      belongs_to :user, class_name: Spree.user_class.to_s, optional: true
-      belongs_to :created_by, class_name: Spree.user_class.to_s, optional: true
-      belongs_to :approver, class_name: Spree.user_class.to_s, optional: true
-      belongs_to :canceler, class_name: Spree.user_class.to_s, optional: true
+      belongs_to :user, class_name: "::#{Spree.user_class}", optional: true
     else
       belongs_to :user, optional: true
+    end
+    if Spree.admin_user_class
+      belongs_to :created_by, class_name: Spree.admin_user_class.to_s, optional: true
+      belongs_to :approver, class_name: Spree.admin_user_class.to_s, optional: true
+      belongs_to :canceler, class_name: Spree.admin_user_class.to_s, optional: true
+    else
       belongs_to :created_by, optional: true
       belongs_to :approver, optional: true
       belongs_to :canceler, optional: true
@@ -128,19 +149,17 @@ module Spree
     # Needs to happen before save_permalink is called
     before_validation :ensure_store_presence
     before_validation :ensure_currency_presence
-    before_validation :uppercase_number
 
     before_validation :clone_billing_address, if: :use_billing?
     attr_accessor :use_billing
 
     before_create :create_token
     before_create :link_by_email
-    before_update :homogenize_line_item_currencies, if: :currency_changed?
+    before_update :ensure_updated_shipments, :homogenize_line_item_currencies, if: :currency_changed?
 
     with_options presence: true do
       # we want to have this case_sentive: true as changing it to false causes all SQL to use LOWER(slug)
       # which is very costly and slow on large set of records
-      validates :number, length: { maximum: 32, allow_blank: true }, uniqueness: { allow_blank: true, case_sensitive: true }
       validates :email, length: { maximum: 254, allow_blank: true }, email: { allow_blank: true }, if: :require_email
       validates :item_count, numericality: { greater_than_or_equal_to: 0, less_than: 2**31, only_integer: true, allow_blank: true }
       validates :store
@@ -181,7 +200,7 @@ module Spree
       update_hooks.add(hook)
     end
 
-    # For compatiblity with Calculator::PriceSack
+    # For compatibility with Calculator::PriceSack
     def amount
       line_items.inject(0.0) { |sum, li| sum + li.amount }
     end
@@ -212,6 +231,11 @@ module Spree
       line_items.exists?
     end
 
+    # Does this order require a physical delivery.
+    def delivery_required?
+      !digital?
+    end
+
     # Is this a free order in which case the payment step should be skipped
     def payment_required?
       total.to_f > 0.0
@@ -386,7 +410,7 @@ module Spree
 
     # Helper methods for checkout steps
     def paid?
-      payment_state == 'paid' || payment_state == 'credit_owed'
+      payments.valid.completed.size == payments.valid.size && payments.valid.sum(:amount) >= total
     end
 
     def available_payment_methods(store = nil)
@@ -476,6 +500,10 @@ module Spree
       %w(partial shipped).include?(shipment_state)
     end
 
+    def fully_shipped?
+      shipments.shipped.size == shipments.size
+    end
+
     def create_proposed_shipments
       all_adjustments.shipping.delete_all
 
@@ -618,17 +646,14 @@ module Spree
       promotions.pluck(:code).compact.first
     end
 
-    def payments_attributes=(attributes)
-      validate_payments_attributes(attributes)
-      super(attributes)
-    end
-
     def validate_payments_attributes(attributes)
+      ActiveSupport::Deprecation.warn('`Order#validate_payments_attributes` is deprecated and will be removed in Spree 5')
+
       # Ensure the payment methods specified are allowed for this user
-      payment_method_ids = available_payment_methods.map(&:id)
+      payment_method_ids = available_payment_methods.map(&:id).map(&:to_s)
 
       attributes.each do |payment_attributes|
-        payment_method_id = payment_attributes[:payment_method_id].to_i
+        payment_method_id = payment_attributes[:payment_method_id].to_s
 
         raise ActiveRecord::RecordNotFound unless payment_method_ids.include?(payment_method_id)
       end
@@ -711,7 +736,7 @@ module Spree
     end
 
     def ensure_currency_presence
-      self.currency ||= store.default_currency || Spree::Config[:currency]
+      self.currency ||= store.default_currency
     end
 
     def create_token
@@ -730,9 +755,5 @@ module Spree
     def credit_card_nil_payment?(attributes)
       payments.store_credits.present? && attributes[:amount].to_f.zero?
     end
-
-    def uppercase_number
-      number&.upcase!
-    end
   end
 end

data/app/models/spree/order_inventory.rb

@@ -120,7 +120,7 @@ module Spree
       if order.completed?
         current_on_hand = shipment.stock_location.count_on_hand(variant)
 
-        if current_on_hand.negative? && current_on_hand.abs < removed_backordered
+        if current_on_hand&.negative? && current_on_hand.abs < removed_backordered
           shipment.stock_location.restock_backordered variant, current_on_hand.abs, shipment
         else
           shipment.stock_location.restock_backordered variant, removed_backordered, shipment

data/app/models/spree/order_merger.rb

@@ -54,7 +54,7 @@ module Spree
 
     # Change the error messages as you choose.
     def handle_error(line_item)
-      order.errors[:base] << line_item.errors.full_messages
+      order.errors.add(:base, line_item.errors.full_messages)
     end
 
     def persist_merge

data/app/models/spree/order_promotion.rb

@@ -3,7 +3,7 @@ module Spree
     belongs_to :order, class_name: 'Spree::Order'
     belongs_to :promotion, class_name: 'Spree::Promotion'
 
-    delegate :name, :description, :code, to: :promotion
+    delegate :name, :description, :code, :public_metadata, to: :promotion
     delegate :currency, to: :order
 
     extend Spree::DisplayMoney

data/app/models/spree/payment/processing.rb

@@ -72,7 +72,7 @@ module Spree
       end
 
       def cancel!
-        response = payment_method.cancel(response_code)
+        response = payment_method.cancel(response_code, self)
         handle_response(response, :void, :failure)
       end
 
@@ -152,6 +152,7 @@ module Spree
       def protect_from_connection_error
         yield
       rescue ActiveMerchant::ConnectionError => e
+        failure!
         gateway_error(e)
       end
 

data/app/models/spree/payment.rb

@@ -3,14 +3,21 @@ require_dependency 'spree/payment/processing'
 module Spree
   class Payment < Spree::Base
     include Spree::Core::NumberGenerator.new(prefix: 'P', letters: true, length: 7)
+    include NumberIdentifier
+    include NumberAsParam
+    include Metadata
+    if defined?(Spree::Webhooks)
+      include Spree::Webhooks::HasWebhooks
+    end
+    if defined?(Spree::Security::Payments)
+      include Spree::Security::Payments
+    end
 
     include Spree::Payment::Processing
 
-    include NumberAsParam
-
     NON_RISKY_AVS_CODES = ['B', 'D', 'H', 'J', 'M', 'Q', 'T', 'V', 'X', 'Y'].freeze
     RISKY_AVS_CODES     = ['A', 'C', 'E', 'F', 'G', 'I', 'K', 'L', 'N', 'O', 'P', 'R', 'S', 'U', 'W', 'Z'].freeze
-    INVALID_STATES      = %w(failed invalid).freeze
+    INVALID_STATES      = %w(failed invalid void).freeze
 
     with_options inverse_of: :payments do
       belongs_to :order, class_name: 'Spree::Order', touch: true
@@ -25,8 +32,8 @@ module Spree
     has_many :refunds, inverse_of: :payment
 
     validates :payment_method, presence: true
-    validates :number, uniqueness: { case_sensitive: true }
     validates :source, presence: true, if: -> { payment_method&.source_required? }
+    validate :payment_method_available_for_order, on: :create
 
     before_validation :validate_source
 
@@ -66,6 +73,9 @@ module Spree
     scope :store_credits, -> { where(source_type: Spree::StoreCredit.to_s) }
     scope :not_store_credits, -> { where(arel_table[:source_type].not_eq(Spree::StoreCredit.to_s).or(arel_table[:source_type].eq(nil))) }
 
+    self.whitelisted_ransackable_associations = %w[payment_method order source]
+    self.whitelisted_ransackable_attributes = %w[number amount state response_code avs_response cvv_response_code cvv_response_message]
+
     # transaction_id is much easier to understand
     def transaction_id
       response_code
@@ -95,10 +105,12 @@ module Spree
       event :complete do
         transition from: [:processing, :pending, :checkout], to: :completed
       end
+      after_transition to: :completed, do: :after_completed
       event :void do
         transition from: [:pending, :processing, :completed, :checkout], to: :void
       end
-      # when the card brand isnt supported
+      after_transition to: :void, do: :after_void
+      # when the card brand isn't supported
       event :invalidate do
         transition from: [:checkout], to: :invalid
       end
@@ -196,6 +208,14 @@ module Spree
 
     private
 
+    def after_void
+      # this method is prepended in api/ to queue Webhooks requests
+    end
+
+    def after_completed
+      # this method is prepended in api/ to queue Webhooks requests
+    end
+
     def has_invalid_state?
       INVALID_STATES.include?(state)
     end
@@ -219,6 +239,13 @@ module Spree
       !errors.present?
     end
 
+    def payment_method_available_for_order
+      return if payment_method.blank?
+      return if order.blank?
+
+      errors.add(:payment_method, :invalid) if !payment_method.available_for_order?(order) || !payment_method.available_for_store?(order.store)
+    end
+
     def add_source_error(field, message)
       field_name = I18n.t("activerecord.attributes.#{source.class.to_s.underscore}.#{field}")
       errors.add(Spree.t(source.class.to_s.demodulize.underscore), "#{field_name} #{message}")

data/app/models/spree/payment_capture_event.rb

@@ -1,5 +1,9 @@
 module Spree
   class PaymentCaptureEvent < Spree::Base
+    if defined?(Spree::Webhooks)
+      include Spree::Webhooks::HasWebhooks
+    end
+
     belongs_to :payment, class_name: 'Spree::Payment'
 
     def display_amount

data/app/models/spree/payment_method/store_credit.rb

@@ -74,7 +74,7 @@ module Spree
       handle_action(action, :credit, auth_code)
     end
 
-    def cancel(auth_code)
+    def cancel(auth_code, _payment = nil)
       store_credit_event = StoreCreditEvent.find_by(authorization_code: auth_code,
                                                     action: Spree::StoreCredit::CAPTURE_ACTION)
       store_credit = store_credit_event.try(:store_credit)

data/app/models/spree/payment_method.rb

@@ -4,6 +4,10 @@ module Spree
     acts_as_list
 
     include MultiStoreResource
+    include Spree::Metadata
+    if defined?(Spree::Security::PaymentMethods)
+      include Spree::Security::PaymentMethods
+    end
 
     DISPLAY = [:both, :front_end, :back_end].freeze
 
@@ -14,7 +18,8 @@ module Spree
 
     validates :name, presence: true
 
-    has_and_belongs_to_many :stores
+    has_many :store_payment_methods, class_name: 'Spree::StorePaymentMethod'
+    has_many :stores, class_name: 'Spree::Store', through: :store_payment_methods
 
     with_options dependent: :restrict_with_error do
       has_many :payments, class_name: 'Spree::Payment', inverse_of: :payment_method

data/app/models/spree/payment_source.rb

@@ -0,0 +1,10 @@
+module Spree
+  class PaymentSource < Spree::Base
+    include Metadata
+
+    belongs_to :payment_method, class_name: 'Spree::PaymentMethod'
+    belongs_to :user, class_name: 'Spree::User', optional: true
+
+    validates_uniqueness_of :gateway_payment_profile_id, scope: :type
+  end
+end

data/app/models/spree/preference.rb

@@ -1,5 +1,10 @@
 class Spree::Preference < Spree::Base
   serialize :value
 
-  validates :key, presence: true, uniqueness: { case_sensitive: false, allow_blank: true }
+  validates :key, presence: true,
+                  uniqueness: { case_sensitive: false, allow_blank: true, scope: spree_base_uniqueness_scope }
+
+  if defined?(Spree::Security::Preferences)
+    include Spree::Security::Preferences
+  end
 end

data/app/models/spree/price.rb

@@ -1,6 +1,9 @@
 module Spree
   class Price < Spree::Base
     include VatPriceCalculation
+    if defined?(Spree::Webhooks)
+      include Spree::Webhooks::HasWebhooks
+    end
 
     acts_as_paranoid
 
@@ -66,7 +69,7 @@ module Spree
     private
 
     def ensure_currency
-      self.currency ||= Spree::Config[:currency]
+      self.currency ||= Spree::Store.default.default_currency
     end
   end
 end