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.

Move logic for creating and managing payments from the admin controller to the model

Łukasz Adamczyk5816b29ce89c
diff --git a/admin/app/controllers/spree/admin/payments_controller.rb b/admin/app/controllers/spree/admin/payments_controller.rb
index 46b6542a82..e8a5e1e757 100644
--- a/admin/app/controllers/spree/admin/payments_controller.rb
+++ b/admin/app/controllers/spree/admin/payments_controller.rb
@@ -9,12 +9,7 @@ module Spree
def new
payment_method = params[:payment_method_id] ? @payment_methods.find { |pm| pm.id.to_s == params[:payment_method_id].to_s } : @payment_methods.first
- @payment = @order.payments.build(
- amount: @order.total - @order.payment_total,
- payment_method: payment_method
- )
-
- @payment_max_amount = payment_method.store_credit? ? [@user_store_credits.first.amount_remaining, @payment.amount].min : @payment.amount
+ @payment = @order.payments.build(payment_method: payment_method)
if payment_method.try(:source_required?)
source_class = (payment_method.try(:payment_source_class) || Spree::CreditCard)
@@ -117,10 +112,7 @@ module Spree
def load_data
@payment_methods = @order.collect_backend_payment_methods
-
- if @payment_methods.any?(&:store_credit?)
- @user_store_credits = @order.user.store_credits.available.for_store(current_store).sort_by(&:amount_remaining).reverse
- end
+ @store_credits = @order.available_store_credits if @payment_methods.any?(&:store_credit?)
end
end
end
diff --git a/admin/app/views/spree/admin/payments/new.html.erb b/admin/app/views/spree/admin/payments/new.html.erb
index 27b824eff4..3e75ff9ebd 100644
--- a/admin/app/views/spree/admin/payments/new.html.erb
+++ b/admin/app/views/spree/admin/payments/new.html.erb
@@ -14,8 +14,8 @@
<%= f.label :amount, Spree.t(:amount) %>
<div class="input-group">
<%= f.number_field :amount,
- value: @payment_max_amount,
- max: @payment_max_amount,
+ value: @payment.max_amount,
+ max: @payment.max_amount,
step: '.01',
class: 'form-control',
required: true %>
diff --git a/admin/app/views/spree/admin/payments/source_forms/_store_credit.html.erb b/admin/app/views/spree/admin/payments/source_forms/_store_credit.html.erb
index 0ff4915594..46a1bf65b4 100644
--- a/admin/app/views/spree/admin/payments/source_forms/_store_credit.html.erb
+++ b/admin/app/views/spree/admin/payments/source_forms/_store_credit.html.erb
@@ -1,11 +1,11 @@
<% if @order.could_use_store_credit? %>
<ul class="list-group mb-3">
<%= f.fields_for :source, @payment.source do |source_form| %>
- <% @user_store_credits.each do |credit| %>
+ <% @store_credits.each do |credit| %>
<li class="list-group-item p-0">
<%= source_form.label :id, value: credit.id, class: "form-check-label d-flex align-items-center gap-3 px-3 py-3 w-100 cursor-pointer hover-light" do %>
<div class="form-check flex align-items-center">
- <%= source_form.radio_button :id, credit.id, class: "form-check-input", checked: @payment.source.id == credit.id || @user_store_credits.first.id == credit.id %>
+ <%= source_form.radio_button :id, credit.id, class: "form-check-input", checked: @payment.source.id == credit.id || @store_credits.first.id == credit.id %>
</div>
<div class="font-weight-normal">
<%= Spree.t('admin.store_credit.amount_remaining_of_total', amount: credit.display_amount_remaining, total: credit.display_amount).html_safe %>
diff --git a/core/app/models/spree/order/store_credit.rb b/core/app/models/spree/order/store_credit.rb
index a76a5c2608..31fee7ab1c 100644
--- a/core/app/models/spree/order/store_credit.rb
+++ b/core/app/models/spree/order/store_credit.rb
@@ -22,6 +22,12 @@ module Spree
user.total_available_store_credit(currency, store)
end
+ def available_store_credits
+ return Spree::StoreCredit.none if user.nil?
+
+ user.store_credits.for_store(store).where(currency: currency).available.sort_by(&:amount_remaining).reverse
+ end
+
def could_use_store_credit?
return false if Spree::PaymentMethod::StoreCredit.available.empty?
diff --git a/core/app/models/spree/payment.rb b/core/app/models/spree/payment.rb
index 9cc25002c4..b0c2fdb10f 100644
--- a/core/app/models/spree/payment.rb
+++ b/core/app/models/spree/payment.rb
@@ -37,6 +37,8 @@ module Spree
before_validation :validate_source
+ after_initialize :set_amount, if: -> { new_record? && order.present? && !amount_changed? }
+
after_save :create_payment_profile, if: :profiles_supported?
# update the order totals, etc.
@@ -134,6 +136,17 @@ module Spree
payment_method.payment_source_class.unscoped { super }
end
+ def max_amount
+ return amount if payment_method.nil? || order&.user.nil?
+
+ if payment_method.store_credit?
+ store_credits = order.available_store_credits
+ store_credits.any? ? [store_credits.first.amount_remaining, amount].min : amount
+ else
+ amount
+ end
+ end
+
def amount=(amount)
self[:amount] =
case amount
@@ -227,6 +240,10 @@ module Spree
private
+ def set_amount
+ self.amount = order.total - order.payment_total
+ end
+
def after_void
# Implement your logic here
end
diff --git a/core/spec/models/spree/order/store_credit_spec.rb b/core/spec/models/spree/order/store_credit_spec.rb
index bbcd777c2c..4bf2e05121 100644
--- a/core/spec/models/spree/order/store_credit_spec.rb
+++ b/core/spec/models/spree/order/store_credit_spec.rb
@@ -241,6 +241,29 @@ describe 'Order' do
end
end
+ describe '#available_store_credits' do
+ subject { order.available_store_credits }
+
+ context 'order does not have an associated user' do
+ let(:order) { create(:store_credits_order_without_user) }
+
+ it { is_expected.to be_empty }
+ end
+
+ context 'order has an associated user' do
+ let(:order) { create(:order, user: user, currency: 'USD') }
+ let(:user) { create(:user) }
+
+ let!(:store_credit_1) { create(:store_credit, user: user, amount: 10, currency: 'USD') }
+ let!(:store_credit_2) { create(:store_credit, user: user, amount: 15, currency: 'USD') }
+ let!(:store_credit_3) { create(:store_credit, user: user, amount: 20, currency: 'EUR') }
+
+ it 'returns the user available store credits' do
+ expect(subject).to eq([store_credit_2, store_credit_1])
+ end
+ end
+ end
+
describe '#could_use_store_credit?' do
let!(:store_credit_payment_method) { create(:store_credit_payment_method) }
diff --git a/core/spec/models/spree/payment_spec.rb b/core/spec/models/spree/payment_spec.rb
index af63d62a67..00cf4d7dc8 100644
--- a/core/spec/models/spree/payment_spec.rb
+++ b/core/spec/models/spree/payment_spec.rb
@@ -80,6 +80,35 @@ describe Spree::Payment, type: :model do
end
end
+ describe 'after_initialize :set_amount' do
+ subject { payment.amount }
+
+ context 'when associated with an order' do
+ let(:order) { create(:order, payment_total: 10, total: 45) }
+ let(:payment) { described_class.new(order: order) }
+
+ it 'sets the amount to the order total minus the payment total' do
+ expect(subject).to eq(order.total - order.payment_total)
+ end
+
+ context 'when the amount is already set' do
+ let(:payment) { described_class.new(order: order, amount: 10) }
+
+ it 'does not set the amount' do
+ expect(subject).to eq(10)
+ end
+ end
+ end
+
+ context 'when not associated with an order' do
+ let(:payment) { described_class.new }
+
+ it 'does not set the amount' do
+ expect(subject).to eq(0)
+ end
+ end
+ end
+
context '.risky' do
let!(:payment_1) { create(:payment, avs_response: 'Y', cvv_response_code: 'M', cvv_response_message: 'Match') }
let!(:payment_2) { create(:payment, avs_response: 'Y', cvv_response_code: 'M', cvv_response_message: '') }