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.

Fix store credit payments on checkout (#12493)

Łukasz Adamczykbfb1ca5e28d8
diff --git a/admin/spec/controllers/spree/admin/orders_controller_spec.rb b/admin/spec/controllers/spree/admin/orders_controller_spec.rb
index d0d17abbb9..10055a91ef 100644
--- a/admin/spec/controllers/spree/admin/orders_controller_spec.rb
+++ b/admin/spec/controllers/spree/admin/orders_controller_spec.rb
@@ -121,7 +121,10 @@ RSpec.describe Spree::Admin::OrdersController, type: :controller do
describe '#edit' do
subject { get :edit, params: { id: order.number } }
- let(:order) { create(:order_ready_to_ship) }
+ let(:order) { create(:order_ready_to_ship, total: 100, with_payment: false) }
+
+ let!(:invalid_payment) { create(:payment, state: 'invalid', amount: 100, order: order) }
+ let!(:valid_payment) { create(:payment, state: 'completed', amount: 100, order: order) }
it 'shows an order' do
subject
@@ -129,11 +132,10 @@ RSpec.describe Spree::Admin::OrdersController, type: :controller do
expect(assigns[:order]).to eq(order)
expect(assigns[:line_items]).to eq(order.line_items)
expect(assigns[:shipments]).to eq(order.shipments)
- expect(assigns[:payments]).to eq(order.payments)
+ expect(assigns[:payments]).to contain_exactly(valid_payment, invalid_payment)
end
end
-
describe '#cancel' do
subject(:cancel) { put :cancel, params: { id: order.number } }
diff --git a/core/app/models/spree/order/store_credit.rb b/core/app/models/spree/order/store_credit.rb
index 31fee7ab1c..c669d42467 100644
--- a/core/app/models/spree/order/store_credit.rb
+++ b/core/app/models/spree/order/store_credit.rb
@@ -10,9 +10,7 @@ module Spree
end
def covered_by_store_credit?
- return false unless user
-
- user.total_available_store_credit >= total
+ user.present? && total_applied_store_credit.positive? && total_applied_store_credit >= total
end
alias covered_by_store_credit covered_by_store_credit?
diff --git a/core/app/models/spree/payment_method.rb b/core/app/models/spree/payment_method.rb
index cc34d21564..4447a4780f 100644
--- a/core/app/models/spree/payment_method.rb
+++ b/core/app/models/spree/payment_method.rb
@@ -95,8 +95,8 @@ module Spree
# Custom PaymentMethod/Gateway can redefine this method to check method
# availability for concrete order.
- def available_for_order?(_order)
- true
+ def available_for_order?(order)
+ !order.covered_by_store_credit?
end
def available_for_store?(store)
diff --git a/core/app/services/spree/checkout/add_store_credit.rb b/core/app/services/spree/checkout/add_store_credit.rb
index 57ff4f2649..b58e4ff390 100644
--- a/core/app/services/spree/checkout/add_store_credit.rb
+++ b/core/app/services/spree/checkout/add_store_credit.rb
@@ -17,7 +17,12 @@ module Spree
apply_store_credits(remaining_total)
end
- @order.reload.payments.store_credits.valid.any? ? success(@order) : failure(@order)
+ if @order.reload.payments.store_credits.valid.any?
+ @order.updater.run_hooks
+ success(@order)
+ else
+ failure(@order)
+ end
end
private
diff --git a/core/app/views/spree/shared/_payment.html.erb b/core/app/views/spree/shared/_payment.html.erb
index baee5df433..e963c8efd4 100644
--- a/core/app/views/spree/shared/_payment.html.erb
+++ b/core/app/views/spree/shared/_payment.html.erb
@@ -1,5 +1,5 @@
<% source = payment.source %>
-<div class="d-flex flex items-top gap-2">
+<div class="d-flex flex items-center align-items-center gap-2">
<% if source.is_a?(Spree::CreditCard) %>
<div class="flex-shrink-0">
<% # display wallet icon, eg. Apple Pay, Google Pay, etc. %>
@@ -21,7 +21,7 @@
</div>
</div>
<% elsif payment_method_icon_tag(payment.payment_method.payment_icon_name).present? %>
- <div class="d-flex flex align-items-center">
+ <div class="d-flex flex align-items-center items-center">
<div><%= payment_method_icon_tag(payment.payment_method.payment_icon_name) %></div>
<div class="mx-2"><%= Spree.t(:store_credit_name) %></div>
</div>
diff --git a/core/spec/models/spree/order/store_credit_spec.rb b/core/spec/models/spree/order/store_credit_spec.rb
index 4bf2e05121..4dfebbe0bf 100644
--- a/core/spec/models/spree/order/store_credit_spec.rb
+++ b/core/spec/models/spree/order/store_credit_spec.rb
@@ -150,27 +150,25 @@ describe 'Order' do
describe '#covered_by_store_credit' do
context "order doesn't have an associated user" do
- subject { create(:store_credits_order_without_user) }
+ subject { order.covered_by_store_credit? }
- it 'returns false' do
- expect(subject.covered_by_store_credit).to be false
- end
+ let(:order) { create(:store_credits_order_without_user) }
+
+ it { is_expected.to be(false) }
end
context 'order has an associated user' do
- subject { create(:order, user: user) }
+ subject { order.covered_by_store_credit? }
+ let(:order) { create(:order, user: user, total: order_total) }
let(:user) { create(:user) }
+ let(:order_total) { 10.0 }
context 'user has enough store credit to pay for the order' do
- before do
- allow(user).to receive(:total_available_store_credit).and_return(10.0)
- allow(subject).to receive(:total).and_return(5.0)
- end
+ let!(:store_credit_payment) { create(:store_credit_payment, order: order, source: store_credit, amount: 10.0) }
+ let(:store_credit) { create(:store_credit, amount: 10.0, store: order.store, user: order.user) }
- it 'returns true' do
- expect(subject.covered_by_store_credit).to be true
- end
+ it { is_expected.to be(true) }
end
context 'user does not have enough store credit to pay for the order' do
@@ -179,9 +177,12 @@ describe 'Order' do
allow(subject).to receive(:total).and_return(5.0)
end
- it 'returns false' do
- expect(subject.covered_by_store_credit).to be false
- end
+ it { is_expected.to be(false) }
+ end
+
+ context 'order total is zero' do
+ let(:order_total) { 0.0 }
+ it { is_expected.to be(false) }
end
end
end
diff --git a/core/spec/models/spree/payment_method_spec.rb b/core/spec/models/spree/payment_method_spec.rb
index 57550255ce..fd8f2fdc16 100644
--- a/core/spec/models/spree/payment_method_spec.rb
+++ b/core/spec/models/spree/payment_method_spec.rb
@@ -126,6 +126,29 @@ describe Spree::PaymentMethod, type: :model do
end
end
+ describe '#available_for_order?' do
+ subject { payment_method.available_for_order?(order) }
+
+ let(:payment_method) { create(:credit_card_payment_method) }
+ let(:order) { create(:order, total: 100) }
+
+ context 'when the order is not covered by store credit' do
+ it { is_expected.to be(true) }
+ end
+
+ context 'when the order is partially covered by store credit' do
+ let!(:store_credit_payment) { create(:store_credit_payment, order: order, amount: 50) }
+
+ it { is_expected.to be(true) }
+ end
+
+ context 'when the order is fully covered by store credit' do
+ let!(:store_credit_payment) { create(:store_credit_payment, order: order, amount: 100) }
+
+ it { is_expected.to be(false) }
+ end
+ end
+
describe '#available_for_store?' do
let!(:store_1) { create(:store) }
let!(:pm) { create(:credit_card_payment_method, stores: [store]) }
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 a31771dece..43f17861ea 100644
--- a/core/spec/services/spree/checkout/add_store_credit_spec.rb
+++ b/core/spec/services/spree/checkout/add_store_credit_spec.rb
@@ -8,7 +8,10 @@ describe Spree::Checkout::AddStoreCredit, type: :service do
let(:order_total) { 500.00 }
- before { create(:store_credit_payment_method, stores: [store]) }
+ before do
+ create(:store_credit_payment_method, stores: [store])
+ allow(order.updater).to receive(:run_hooks)
+ end
context 'there is no store credit' do
let(:order) { create(:store_credits_order_without_user, total: order_total) }
@@ -28,37 +31,41 @@ describe Spree::Checkout::AddStoreCredit, type: :service do
it 'returns error' do
expect(subject.success?).to eq(false)
expect(subject.error.to_s).to eq('User does not have any Store Credits available')
+ expect(order.updater).not_to have_received(:run_hooks)
end
end
context 'there is enough store credit to pay for the entire order' do
+ subject { described_class.call(order: order, amount: requested_amount) }
+
let(:store_credit) { create(:store_credit, amount: order_total, store: store) }
let(:order) { create(:order, user: store_credit.user, total: order_total, store: store) }
context 'with no amount specified' do
- before do
- subject
- order.reload
- end
+ let(:requested_amount) { nil }
it 'creates a store credit payment for the full amount' do
- expect(order.payments.count).to eq 1
+ expect(subject).to be_success
+
+ expect(order.reload.payments.count).to eq 1
expect(order.payments.first).to be_store_credit
expect(order.payments.first.amount).to eq order_total
+
+ expect(order.updater).to have_received(:run_hooks)
end
end
context 'with store credit amount specified' do
let(:requested_amount) { 300.0 }
- before do
- described_class.call(order: order, amount: requested_amount)
- end
-
it 'creates a store credit payment for the specified amount' do
- expect(order.payments.count).to eq 1
+ expect(subject).to be_success
+
+ expect(order.reload.payments.count).to eq 1
expect(order.payments.first).to be_store_credit
expect(order.payments.first.amount).to eq requested_amount
+
+ expect(order.updater).to have_received(:run_hooks)
end
end
end
@@ -74,45 +81,47 @@ describe Spree::Checkout::AddStoreCredit, type: :service do
# callbacks recalculate total based on line items
# this ensures the total is what we expect
order.update_column(:total, order_total)
- subject
- order.reload
end
it 'creates a store credit payment for the available amount' do
- expect(order.payments.count).to eq 1
+ expect(subject).to be_success
+
+ expect(order.reload.payments.count).to eq 1
expect(order.payments.first).to be_store_credit
expect(order.payments.first.amount).to eq store_credit_total
+
+ expect(order.updater).to have_received(:run_hooks)
end
end
context 'there are multiple store credits' do
- context 'they have different credit type priorities' do
- let(:amount_difference) { 100 }
- let!(:primary_store_credit) { create(:store_credit, amount: (order_total - amount_difference), store: store) }
- let!(:secondary_store_credit) do
- create(:store_credit, amount: order_total, user: primary_store_credit.user,
- credit_type: create(:secondary_credit_type), store: store)
- end
- let(:order) { create(:order, user: primary_store_credit.user, total: order_total, store: store) }
+ let(:amount_difference) { 100 }
+ let!(:primary_store_credit) { create(:store_credit, amount: (order_total - amount_difference), store: store) }
+ let!(:secondary_store_credit) do
+ create(:store_credit, amount: order_total, user: primary_store_credit.user,
+ credit_type: create(:secondary_credit_type), store: store)
+ end
+ let(:order) { create(:order, user: primary_store_credit.user, total: order_total, store: store) }
- before do
- Timecop.scale(3600)
- subject
- order.reload
- end
+ before do
+ Timecop.scale(3600)
+ end
- after { Timecop.return }
+ after { Timecop.return }
- it 'uses the primary store credit type over the secondary' do
- primary_payment = order.payments.first
- secondary_payment = order.payments.last
+ it 'uses the primary store credit type over the secondary' do
+ expect(subject).to be_success
- expect(order.payments.size).to eq 2
- expect(primary_payment.source).to eq primary_store_credit
- expect(secondary_payment.source).to eq secondary_store_credit
- expect(primary_payment.amount).to eq(order_total - amount_difference)
- expect(secondary_payment.amount).to eq(amount_difference)
- end
+ primary_payment = order.reload.payments.first
+ secondary_payment = order.payments.last
+
+ expect(order.payments.size).to eq 2
+ expect(primary_payment.source).to eq primary_store_credit
+ expect(secondary_payment.source).to eq secondary_store_credit
+ expect(primary_payment.amount).to eq(order_total - amount_difference)
+ expect(secondary_payment.amount).to eq(amount_difference)
+
+ expect(order.updater).to have_received(:run_hooks)
end
end
end
diff --git a/storefront/app/helpers/spree/checkout_helper.rb b/storefront/app/helpers/spree/checkout_helper.rb
index f64fd716ab..a55f1f5625 100644
--- a/storefront/app/helpers/spree/checkout_helper.rb
+++ b/storefront/app/helpers/spree/checkout_helper.rb
@@ -30,7 +30,7 @@ module Spree
end
def checkout_available_payment_methods
- @checkout_available_payment_methods ||= @order.available_payment_methods
+ @checkout_available_payment_methods ||= @order.available_payment_methods.reject(&:store_credit?)
end
def checkout_started?
diff --git a/storefront/app/views/themes/default/spree/checkout/complete.html.erb b/storefront/app/views/themes/default/spree/checkout/complete.html.erb
index a92544893a..c3fc33b57b 100644
--- a/storefront/app/views/themes/default/spree/checkout/complete.html.erb
+++ b/storefront/app/views/themes/default/spree/checkout/complete.html.erb
@@ -15,11 +15,11 @@
</p>
</div>
- <% if @order.payments.any? %>
+ <% if @order.payments.valid.any? %>
<div class="border p-3 mt-4 rounded-md">
<h5 class="mb-3 font-bold pb-3 border-b font-body"><%= Spree.t(:payment) %></h5>
- <div class="flex mb-3 text-sm items-center">
- <%= render partial: 'spree/shared/payment', collection: @order.payments %>
+ <div class="flex mb-3 text-sm gap-4 items-top">
+ <%= render partial: 'spree/shared/payment', collection: @order.payments.valid %>
</div>
<div class="mt-3 border-t pt-3">
<span class="text-sm"><%= Spree.t(:status) %></span>
diff --git a/storefront/spec/controllers/spree/checkout_controller_spec.rb b/storefront/spec/controllers/spree/checkout_controller_spec.rb
index 457b19b27b..33a82e0ce9 100644
--- a/storefront/spec/controllers/spree/checkout_controller_spec.rb
+++ b/storefront/spec/controllers/spree/checkout_controller_spec.rb
@@ -1097,4 +1097,46 @@ describe Spree::CheckoutController, type: :controller do
end
end
end
+
+ describe '#apply_store_credit' do
+ let!(:order) { create(:order_with_line_items, store: store, user: user) }
+ let(:user) { create(:user) }
+
+ let!(:payment_method) { create(:store_credit_payment_method) }
+ let!(:store_credit) { create(:store_credit, user: user, amount: 12.34) }
+
+ it 'adds the store credit to the order' do
+ post :apply_store_credit, params: { token: order.token }
+
+ expect(response).to redirect_to spree.checkout_path(order.token)
+
+ expect(order.payments.count).to eq(1)
+ expect(order.payments.first).to be_checkout
+ expect(order.payments.first.source).to eq(store_credit)
+ expect(order.payments.first.payment_method).to eq(payment_method)
+ expect(order.payments.first.amount).to eq(12.34)
+ end
+ end
+
+ describe '#remove_store_credit' do
+ let!(:order) { create(:order_with_line_items, store: store, user: user) }
+ let(:user) { create(:user) }
+
+ let!(:payment_method) { create(:store_credit_payment_method) }
+ let!(:store_credit) { create(:store_credit, user: user, amount: 12.34) }
+
+ let!(:store_credit_payment) { create(:store_credit_payment, order: order, source: store_credit, payment_method: payment_method, amount: 12.34) }
+
+ it 'removes the store credit from the order' do
+ post :remove_store_credit, params: { token: order.token }
+
+ expect(response).to redirect_to spree.checkout_path(order.token)
+
+ expect(order.reload.payments.count).to eq(1)
+ expect(order.payments.first).to be_invalid
+ expect(order.payments.first.source).to eq(store_credit)
+ expect(order.payments.first.payment_method).to eq(payment_method)
+ expect(order.payments.first.amount).to eq(12.34)
+ end
+ end
end