Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

Deprecate `Order#validate_payments_attributes` and added Payment's Payment Method validation

Damian Legawiec257ff3e7a980
diff --git a/api/spec/requests/spree/api/v2/storefront/checkout_spec.rb b/api/spec/requests/spree/api/v2/storefront/checkout_spec.rb
index ea40f53afa..af9451a019 100644
--- a/api/spec/requests/spree/api/v2/storefront/checkout_spec.rb
+++ b/api/spec/requests/spree/api/v2/storefront/checkout_spec.rb
@@ -449,7 +449,7 @@ describe 'API V2 Storefront Checkout Spec', type: :request do
let(:execute) { post '/api/v2/storefront/checkout/add_store_credit', params: params, headers: headers }
before do
- create(:store_credit_payment_method)
+ create(:store_credit_payment_method, stores: [store])
execute
end
@@ -529,7 +529,7 @@ describe 'API V2 Storefront Checkout Spec', type: :request do
let!(:store_credit) { create(:store_credit, amount: order_total, user: user) }
before do
- create(:store_credit_payment_method)
+ create(:store_credit_payment_method, stores: [store])
Spree::Checkout::AddStoreCredit.call(order: order)
execute
end
diff --git a/core/app/models/spree/order.rb b/core/app/models/spree/order.rb
index 59dd733a81..52ee1b9219 100644
--- a/core/app/models/spree/order.rb
+++ b/core/app/models/spree/order.rb
@@ -617,12 +617,9 @@ 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)
diff --git a/core/app/models/spree/payment.rb b/core/app/models/spree/payment.rb
index be52a2231a..57242bc2e1 100644
--- a/core/app/models/spree/payment.rb
+++ b/core/app/models/spree/payment.rb
@@ -26,6 +26,7 @@ module Spree
validates :payment_method, presence: true
validates :source, presence: true, if: -> { payment_method&.source_required? }
+ validate :payment_method_available_for_order, on: :create
before_validation :validate_source
@@ -218,6 +219,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}")
diff --git a/core/lib/spree/testing_support/factories/order_factory.rb b/core/lib/spree/testing_support/factories/order_factory.rb
index ef6055c1b7..bd74868524 100644
--- a/core/lib/spree/testing_support/factories/order_factory.rb
+++ b/core/lib/spree/testing_support/factories/order_factory.rb
@@ -77,7 +77,10 @@ FactoryBot.define do
factory :completed_order_with_store_credit_payment do
after(:create) do |order|
- create(:store_credit_payment, amount: order.total, order: order)
+ store_credit = create(:store_credit, amount: order.total, store: order.store, user: order.user)
+ payment_method = create(:store_credit_payment_method, stores: [order.store])
+
+ create(:store_credit_payment, amount: order.total, order: order, source: store_credit, payment_method: payment_method)
end
end
diff --git a/core/lib/spree/testing_support/factories/payment_factory.rb b/core/lib/spree/testing_support/factories/payment_factory.rb
index d46f7991ed..01ad59fbd5 100644
--- a/core/lib/spree/testing_support/factories/payment_factory.rb
+++ b/core/lib/spree/testing_support/factories/payment_factory.rb
@@ -5,7 +5,7 @@ FactoryBot.define do
state { 'checkout' }
response_code { '12345' }
- association(:payment_method, factory: :credit_card_payment_method)
+ payment_method { create(:credit_card_payment_method, stores: [order.store]) }
association(:source, factory: :credit_card)
factory :payment_with_refund do
@@ -24,7 +24,7 @@ FactoryBot.define do
end
factory :store_credit_payment, class: Spree::Payment, parent: :payment do
- association(:payment_method, factory: :store_credit_payment_method)
- association(:source, factory: :store_credit)
+ payment_method { create(:store_credit_payment_method, stores: [order.store]) }
+ source { create(:store_credit, store: order.store, user: order.user) }
end
end
diff --git a/core/lib/spree/testing_support/factories/store_credit_factory.rb b/core/lib/spree/testing_support/factories/store_credit_factory.rb
index f02fa807a0..ec0ac944bc 100644
--- a/core/lib/spree/testing_support/factories/store_credit_factory.rb
+++ b/core/lib/spree/testing_support/factories/store_credit_factory.rb
@@ -8,7 +8,7 @@ FactoryBot.define do
amount { 150.00 }
currency { 'USD' }
credit_type { create(:primary_credit_type) }
- store { create(:store) }
+ store { Spree::Store.default || create(:store) }
end
factory :store_credits_order_without_user, class: Spree::Order do
diff --git a/core/spec/models/spree/gateway_spec.rb b/core/spec/models/spree/gateway_spec.rb
index 712068bfe2..717e92ce10 100644
--- a/core/spec/models/spree/gateway_spec.rb
+++ b/core/spec/models/spree/gateway_spec.rb
@@ -30,10 +30,11 @@ describe Spree::Gateway, type: :model do
end
context 'fetching payment sources' do
- let(:order) { Spree::Order.create(user_id: 1) }
+ let(:store) { create(:store) }
+ let(:order) { store.orders.create(user_id: 1) }
- let(:has_card) { create(:credit_card_payment_method) }
- let(:no_card) { create(:credit_card_payment_method) }
+ let(:has_card) { create(:credit_card_payment_method, stores: [store]) }
+ let(:no_card) { create(:credit_card_payment_method, stores: [store]) }
let(:cc) do
create(:credit_card, payment_method: has_card, gateway_customer_profile_id: 'EFWE')
diff --git a/core/spec/models/spree/order/payment_spec.rb b/core/spec/models/spree/order/payment_spec.rb
index 3a9370ecf0..ad4f9c0d2b 100644
--- a/core/spec/models/spree/order/payment_spec.rb
+++ b/core/spec/models/spree/order/payment_spec.rb
@@ -50,7 +50,7 @@ module Spree
create(
:store_credit_payment,
amount: store_credit_amount,
- payment_method: create(:store_credit_payment_method, auto_capture: false)
+ payment_method: create(:store_credit_payment_method, auto_capture: false, stores: [payment.order.store])
)
end
diff --git a/core/spec/models/spree/order/state_machine_spec.rb b/core/spec/models/spree/order/state_machine_spec.rb
index 7ab674d8b5..43e4c04aa3 100644
--- a/core/spec/models/spree/order/state_machine_spec.rb
+++ b/core/spec/models/spree/order/state_machine_spec.rb
@@ -1,7 +1,7 @@
require 'spec_helper'
describe Spree::Order, type: :model do
- let(:order) { build(:order) }
+ let(:order) { create(:order) }
before do
# Ensure state machine has been re-defined correctly
diff --git a/core/spec/models/spree/order/store_credit_spec.rb b/core/spec/models/spree/order/store_credit_spec.rb
index 8732330415..a895958ae3 100644
--- a/core/spec/models/spree/order/store_credit_spec.rb
+++ b/core/spec/models/spree/order/store_credit_spec.rb
@@ -214,8 +214,9 @@ describe 'Order' do
context 'the associated user has store credits' do
subject { order }
- let(:store_credit) { create(:store_credit) }
- let(:order) { create(:order, user: store_credit.user) }
+ let(:store) { create(:store) }
+ let(:store_credit) { create(:store_credit, store: store) }
+ let(:order) { create(:order, user: store_credit.user, store: store) }
context 'the store credit is more than the order total' do
let(:order_total) { store_credit.amount - 1 }
diff --git a/core/spec/models/spree/order_spec.rb b/core/spec/models/spree/order_spec.rb
index db9b71d70a..bed57d4d1b 100644
--- a/core/spec/models/spree/order_spec.rb
+++ b/core/spec/models/spree/order_spec.rb
@@ -948,6 +948,7 @@ describe Spree::Order, type: :model do
let!(:refund_payment) do
build(:payment, amount: -1, order: order, state: 'completed', source: payment).tap do |p|
allow(p).to receive_messages(profiles_supported?: false)
+ allow(p).to receive_messages(payment_method_available_for_order: nil)
p.save!
end
end
@@ -1157,7 +1158,7 @@ describe Spree::Order, type: :model do
end
end
- describe 'credit_card_nil_payment' do
+ describe '#credit_card_nil_payment' do
let!(:order) { create(:order_with_line_items, line_items_count: 2, store: store) }
let!(:credit_card_payment_method) { create(:simple_credit_card_payment_method, stores: [store]) }
let!(:store_credits) { create(:store_credit_payment, order: order) }
diff --git a/core/spec/models/spree/payment/store_credit_spec.rb b/core/spec/models/spree/payment/store_credit_spec.rb
index e0e74e58e7..51ef08f48c 100644
--- a/core/spec/models/spree/payment/store_credit_spec.rb
+++ b/core/spec/models/spree/payment/store_credit_spec.rb
@@ -4,11 +4,14 @@ describe 'Payment' do
context '#cancel!' do
subject { payment.cancel! }
+ let(:store) { create(:store) }
+
context 'a store credit' do
- let(:store_credit) { create(:store_credit, amount_used: captured_amount) }
+ let(:store_credit) { create(:store_credit, amount_used: captured_amount, store: store) }
let(:auth_code) { '1-SC-20141111111111' }
let(:captured_amount) { 10.0 }
- let(:payment) { create(:store_credit_payment, response_code: auth_code) }
+ let(:order) { create(:order, store: store) }
+ let(:payment) { create(:store_credit_payment, response_code: auth_code, order: order) }
let!(:capture_event) do
create(:store_credit_auth_event,
diff --git a/core/spec/models/spree/payment_method/store_credit_spec.rb b/core/spec/models/spree/payment_method/store_credit_spec.rb
index 2a10e43f49..66d0ed9699 100644
--- a/core/spec/models/spree/payment_method/store_credit_spec.rb
+++ b/core/spec/models/spree/payment_method/store_credit_spec.rb
@@ -1,7 +1,8 @@
require 'spec_helper'
describe Spree::PaymentMethod::StoreCredit do
- let(:order) { create(:order) }
+ let(:store) { create(:store) }
+ let(:order) { create(:order, store: store) }
let(:payment) { create(:payment, order: order) }
let(:gateway_options) { payment.gateway_options }
@@ -11,7 +12,7 @@ describe Spree::PaymentMethod::StoreCredit do
end
let(:auth_amount) { store_credit.amount_remaining * 100 }
- let(:store_credit) { create(:store_credit) }
+ let(:store_credit) { create(:store_credit, store: store) }
let(:gateway_options) { super().merge(originator: originator) }
let(:originator) { nil }
@@ -72,7 +73,7 @@ describe Spree::PaymentMethod::StoreCredit do
let(:authorized_amount) { capture_amount / 100.0 }
let(:auth_event) { create(:store_credit_auth_event, store_credit: store_credit, amount: authorized_amount) }
- let(:store_credit) { create(:store_credit, amount_authorized: authorized_amount) }
+ let(:store_credit) { create(:store_credit, amount_authorized: authorized_amount, store: store) }
let(:originator) { nil }
context 'with an invalid auth code' do
@@ -98,7 +99,7 @@ describe Spree::PaymentMethod::StoreCredit do
end
context 'when the currency does not match the order currency' do
- let(:store_credit) { create(:store_credit, currency: 'AUD', amount_authorized: authorized_amount) }
+ let(:store_credit) { create(:store_credit, currency: 'AUD', amount_authorized: authorized_amount, store: store) }
it 'declines the credit' do
expect(subject.success?).to be false
@@ -127,7 +128,7 @@ describe Spree::PaymentMethod::StoreCredit do
context '#void' do
subject do
- described_class.new.void(auth_code, gateway_options)
+ described_class.new(stores: [store]).void(auth_code, gateway_options)
end
let(:auth_code) { auth_event.authorization_code }
@@ -171,7 +172,7 @@ describe Spree::PaymentMethod::StoreCredit do
context '#purchase' do
it "declines a purchase if it can't find a pending credit for the correct amount" do
amount = 100.0
- store_credit = create(:store_credit)
+ store_credit = create(:store_credit, store: store)
auth_code = store_credit.generate_authorization_code
store_credit.store_credit_events.create!(action: Spree::StoreCredit::ELIGIBLE_ACTION,
amount: amount,
@@ -186,7 +187,7 @@ describe Spree::PaymentMethod::StoreCredit do
it 'captures a purchase if it can find a pending credit for the correct amount' do
amount = 100.0
- store_credit = create(:store_credit)
+ store_credit = create(:store_credit, store: store)
auth_code = store_credit.generate_authorization_code
store_credit.store_credit_events.create!(action: Spree::StoreCredit::ELIGIBLE_ACTION,
amount: amount, authorization_code: auth_code)
@@ -252,7 +253,7 @@ describe Spree::PaymentMethod::StoreCredit do
described_class.new.cancel(auth_code)
end
- let(:store_credit) { create(:store_credit, amount_used: captured_amount) }
+ let(:store_credit) { create(:store_credit, amount_used: captured_amount, store: store) }
let(:auth_code) { '1-SC-20141111111111' }
let(:captured_amount) { 10.0 }
diff --git a/core/spec/models/spree/payment_spec.rb b/core/spec/models/spree/payment_spec.rb
index f2b8c56cc9..abc9aa531b 100644
--- a/core/spec/models/spree/payment_spec.rb
+++ b/core/spec/models/spree/payment_spec.rb
@@ -1,11 +1,12 @@
require 'spec_helper'
describe Spree::Payment, type: :model do
- let(:order) { Spree::Order.create }
+ let(:store) { create(:store) }
+ let(:order) { store.orders.create }
let(:refund_reason) { create(:refund_reason) }
let(:gateway) do
- gateway = Spree::Gateway::Bogus.new(active: true)
+ gateway = Spree::Gateway::Bogus.new(active: true, stores: [store])
allow(gateway).to receive_messages source_required: true
gateway
end
@@ -42,6 +43,8 @@ describe Spree::Payment, type: :model do
# So it doesn't create log entries every time a processing method is called
allow(payment.log_entries).to receive(:create!)
+
+ allow(payment).to receive(:payment_method_available_for_order).and_return(nil)
end
describe 'Constants' do
@@ -355,6 +358,7 @@ describe Spree::Payment, type: :model do
let(:capture_amount) { original_amount - 100 }
before do
+ allow_any_instance_of(Spree::Payment).to receive(:payment_method_available_for_order).and_return(nil)
expect(payment.payment_method).to receive(:capture).with(capture_amount, payment.response_code, anything).and_return(success_response)
end
diff --git a/core/spec/models/spree/user_spec.rb b/core/spec/models/spree/user_spec.rb
index bd9e0e0640..5502628f3d 100644
--- a/core/spec/models/spree/user_spec.rb
+++ b/core/spec/models/spree/user_spec.rb
@@ -166,13 +166,14 @@ describe Spree.user_class, type: :model do
end
context 'user has several associated store credits' do
- subject { store_credit.user }
+ subject { user }
- let(:user) { create(:user) }
+ let!(:store) { create(:store, default: true) }
+ let!(:user) { create(:user) }
let(:amount) { 120.25 }
let(:additional_amount) { 55.75 }
- let(:store_credit) { create(:store_credit, user: user, amount: amount, amount_used: 0.0) }
- let!(:additional_store_credit) { create(:store_credit, user: user, amount: additional_amount, amount_used: 0.0, store: store_credit.store) }
+ let!(:store_credit) { create(:store_credit, user: user, amount: amount, amount_used: 0.0, store: store) }
+ let!(:additional_store_credit) { create(:store_credit, user: user, amount: additional_amount, amount_used: 0.0, store: store) }
context 'part of the store credit has been used' do
let(:amount_used) { 35.00 }
diff --git a/core/spec/services/spree/checkout/add_store_credit_spec.rb b/core/spec/services/spree/checkout/add_store_credit_spec.rb
index 12c20306ee..ab99f95801 100644
--- a/core/spec/services/spree/checkout/add_store_credit_spec.rb
+++ b/core/spec/services/spree/checkout/add_store_credit_spec.rb
@@ -1,13 +1,14 @@
require 'spec_helper'
describe Spree::Checkout::AddStoreCredit, type: :service do
+ let(:store) { create(:store) }
describe '#call' do
subject { described_class.call(order: order) }
let(:order_total) { 500.00 }
- before { create(:store_credit_payment_method) }
+ before { create(:store_credit_payment_method, stores: [store]) }
context 'there is no store credit' do
let(:order) { create(:store_credits_order_without_user, total: order_total) }
@@ -26,7 +27,6 @@ describe Spree::Checkout::AddStoreCredit, type: :service do
end
context 'there is enough store credit to pay for the entire order' do
- let(:store) { create(:store) }
let(:store_credit) { create(:store_credit, amount: order_total, store: store) }
let(:order) { create(:order, user: store_credit.user, total: order_total, store: store) }
@@ -59,7 +59,6 @@ describe Spree::Checkout::AddStoreCredit, type: :service do
end
context 'the available store credit is not enough to pay for the entire order' do
- let(:store) { create(:store) }
let(:expected_cc_total) { 100.0 }
let(:store_credit_total) { order_total - expected_cc_total }
let(:store_credit) { create(:store_credit, amount: store_credit_total, store: store) }
@@ -83,7 +82,6 @@ describe Spree::Checkout::AddStoreCredit, type: :service do
context 'there are multiple store credits' do
context 'they have different credit type priorities' do
- let(:store) { create(:store) }
let(:amount_difference) { 100 }
let!(:primary_store_credit) { create(:store_credit, amount: (order_total - amount_difference), store: store) }
let!(:secondary_store_credit) do
diff --git a/core/spec/services/spree/checkout/remove_store_credit_spec.rb b/core/spec/services/spree/checkout/remove_store_credit_spec.rb
index 2cd9a5700e..25ff4fe04c 100644
--- a/core/spec/services/spree/checkout/remove_store_credit_spec.rb
+++ b/core/spec/services/spree/checkout/remove_store_credit_spec.rb
@@ -12,7 +12,7 @@ describe Spree::Checkout::RemoveStoreCredit, type: :service do
let(:store_credit) { create(:store_credit, amount: order_total - 1, store: store) }
before do
- create(:store_credit_payment_method)
+ create(:store_credit_payment_method, stores: [store])
Spree::Checkout::AddStoreCredit.call(order: order)
end