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 creating Payments in admin with the Store Credit Payment Method

Łukasz Adamczyk5bc26954beb4
diff --git a/admin/app/controllers/spree/admin/payments_controller.rb b/admin/app/controllers/spree/admin/payments_controller.rb
index 67a202c08e..46b6542a82 100644
--- a/admin/app/controllers/spree/admin/payments_controller.rb
+++ b/admin/app/controllers/spree/admin/payments_controller.rb
@@ -10,10 +10,12 @@ module Spree
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_minus_store_credits - @order.payment_total,
+ 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
+
if payment_method.try(:source_required?)
source_class = (payment_method.try(:payment_source_class) || Spree::CreditCard)
@payment.source = source_class&.new
@@ -115,6 +117,10 @@ 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
end
end
end
diff --git a/admin/app/javascript/spree/admin/application.js b/admin/app/javascript/spree/admin/application.js
index 7d4f314f74..65d84bdf63 100644
--- a/admin/app/javascript/spree/admin/application.js
+++ b/admin/app/javascript/spree/admin/application.js
@@ -80,7 +80,6 @@ import AddressAutocompleteController from 'spree/core/controllers/address_autoco
import AddressFormController from 'spree/core/controllers/address_form_controller'
import EnableButtonController from 'spree/core/controllers/enable_button_controller'
-
application.register('active-storage-upload', ActiveStorageUpload)
application.register('address-autocomplete', AddressAutocompleteController)
application.register('address-form', AddressFormController)
diff --git a/admin/app/views/spree/admin/orders/_payments.html.erb b/admin/app/views/spree/admin/orders/_payments.html.erb
index 3343f26b6b..b279964e7c 100644
--- a/admin/app/views/spree/admin/orders/_payments.html.erb
+++ b/admin/app/views/spree/admin/orders/_payments.html.erb
@@ -46,7 +46,7 @@
</div>
<% end %>
-<% if @order.payment_required? && @order.bill_address.present? && @order.payment_total < @order.total_minus_store_credits && can?(:create, Spree::Payment.new(order: @order)) %>
+<% if @order.payment_required? && @order.bill_address.present? && @order.payment_total < @order.total && can?(:create, Spree::Payment.new(order: @order)) %>
<div class="card mb-4">
<div class="card-header justify-content-between">
<h5 class="card-title"><%= Spree.t(:payments) %></h5>
diff --git a/admin/app/views/spree/admin/payments/new.html.erb b/admin/app/views/spree/admin/payments/new.html.erb
index 0ac2a67e84..27b824eff4 100644
--- a/admin/app/views/spree/admin/payments/new.html.erb
+++ b/admin/app/views/spree/admin/payments/new.html.erb
@@ -13,7 +13,12 @@
<div class="form-group mb-3">
<%= f.label :amount, Spree.t(:amount) %>
<div class="input-group">
- <%= f.number_field :amount, value: @order.total_minus_store_credits - @order.payment_total, max: @order.total_minus_store_credits - @order.payment_total, step: ".01", class: 'form-control', required: true %>
+ <%= f.number_field :amount,
+ value: @payment_max_amount,
+ max: @payment_max_amount,
+ step: '.01',
+ class: 'form-control',
+ required: true %>
<div class="input-group-append">
<span class="input-group-text"><%= currency_symbol(@order.currency) %></span>
</div>
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
new file mode 100644
index 0000000000..0ff4915594
--- /dev/null
+++ b/admin/app/views/spree/admin/payments/source_forms/_store_credit.html.erb
@@ -0,0 +1,22 @@
+<% 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| %>
+ <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 %>
+ </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 %>
+ </div>
+ <% end %>
+ </li>
+ <% end %>
+ <% end %>
+ </ul>
+<% else %>
+ <div class="alert alert-danger w-100">
+ <%= Spree.t('admin.user.no_store_credit') %>
+ </div>
+<% end %>
diff --git a/admin/app/views/spree/admin/payments/source_forms/_storecredit.html.erb b/admin/app/views/spree/admin/payments/source_forms/_storecredit.html.erb
deleted file mode 100644
index 781fe757eb..0000000000
--- a/admin/app/views/spree/admin/payments/source_forms/_storecredit.html.erb
+++ /dev/null
@@ -1,9 +0,0 @@
-<% if @order.could_use_store_credit? %>
- <div class="alert alert-info text-center" data-hook="admin_payment_store_credit_available">
- <h4><%= Spree.t('admin.user.available_store_credit', amount: @order.display_total_available_store_credit) %></h4>
- </div>
-<% else %>
- <div class="alert alert-danger text-center" data-hook="admin_payment_no_store_credit">
- <h4><strong><%= Spree.t('admin.user.no_store_credit') %></strong></h4>
- </div>
-<% end %>
diff --git a/admin/app/views/spree/admin/shared/_payment.html.erb b/admin/app/views/spree/admin/shared/_payment.html.erb
index 18e9fd4b38..0f0ce392ef 100644
--- a/admin/app/views/spree/admin/shared/_payment.html.erb
+++ b/admin/app/views/spree/admin/shared/_payment.html.erb
@@ -23,7 +23,7 @@
<% if payment.try(:gateway_dashboard_payment_url).present? %>
<%= link_to_with_icon 'eye', Spree.t(:details), payment.gateway_dashboard_payment_url, class: 'dropdown-item', target: '_blank' %>
<% end %>
- <% if payment.source.is_a?(Spree::StoreCredit) && payment.source.gift_card %>
+ <% if payment.source.is_a?(Spree::StoreCredit) && payment.source.respond_to?(:gift_card) && payment.source.gift_card.present? %>
<%= link_to_with_icon 'eye', Spree.t(:details), spree.edit_admin_gift_card_path(payment.source.gift_card), class: 'dropdown-item' %>
<% end %>
diff --git a/admin/config/locales/en.yml b/admin/config/locales/en.yml
index 38ffa62983..2077ef7fb7 100644
--- a/admin/config/locales/en.yml
+++ b/admin/config/locales/en.yml
@@ -176,6 +176,8 @@ en:
wrong_destination: Wrong destination
stock_transfers:
add_products_tip: You need to select a destination location first
+ store_credit:
+ amount_remaining_of_total: "<strong>%{amount}</strong> remaining (<strong>%{total}</strong> total)"
store_form:
customer_support_email_help: This email is visible to your Store visitors in the Footer section
new_order_notifications_email_help: If you want to receive an email notification every time someone places an Order please provide an email address for that notification to be sent to
@@ -215,9 +217,8 @@ en:
manual_info: Curate products manually. You can add or remove them in bulk.
url: URL
user:
- available_store_credit: User has %{amount} in Store Credit available.
last_order_placed: Last order placed
- no_store_credit: User has no Store Credit available.
+ no_store_credit: Customer has no Store Credit available
users:
filters:
search_placeholder: Search customers by email or name
diff --git a/admin/spec/controllers/spree/admin/payments_controller_spec.rb b/admin/spec/controllers/spree/admin/payments_controller_spec.rb
index b9c619e1ef..b2a000de5e 100644
--- a/admin/spec/controllers/spree/admin/payments_controller_spec.rb
+++ b/admin/spec/controllers/spree/admin/payments_controller_spec.rb
@@ -260,5 +260,59 @@ RSpec.describe Spree::Admin::PaymentsController, type: :controller do
expect(response).to redirect_to(spree.edit_admin_order_path(order))
end
end
+
+ context 'when using the store credit' do
+ let!(:payment_method) { create(:store_credit_payment_method) }
+ let!(:store_credit) { create(:store_credit, user: order.user, amount: 12.34) }
+
+ let(:params) do
+ {
+ order_id: order.number,
+ payment: {
+ amount: '12.34',
+ payment_method_id: payment_method.id.to_s,
+ source_attributes: {
+ id: store_credit.id
+ }
+ }
+ }
+ end
+
+ let(:order_payment) { order.payments.first }
+
+ it 'processes the payment correctly' do
+ subject
+
+ expect(response).to redirect_to(spree.edit_admin_order_path(order))
+
+ expect(order.reload.state).to eq('payment')
+ expect(order.payment_total).to eq(12.34)
+
+ expect(order.payments.count).to eq(1)
+ expect(order_payment).to be_completed
+ expect(order_payment.source).to eq(store_credit)
+ expect(order_payment.payment_method).to eq(payment_method)
+ expect(order_payment.amount).to eq(12.34)
+ end
+
+ context 'when the store credit is not enough' do
+ let!(:store_credit) { create(:store_credit, user: order.user, amount: 10.00) }
+
+ it 'does not process payment' do
+ subject
+
+ expect(response).to render_template(:new)
+ expect(response.status).to eq(422)
+
+ expect(flash[:error]).to eq('Store credit amount remaining is not sufficient and Unable to capture more than authorized amount')
+
+ expect(order.reload.payments.count).to eq(1)
+ expect(order_payment).to be_failed
+ expect(order_payment.source).to eq(store_credit)
+ expect(order_payment.payment_method).to eq(payment_method)
+ expect(order_payment.amount).to eq(12.34)
+ end
+ end
+ end
end
end
diff --git a/core/app/models/spree/payment.rb b/core/app/models/spree/payment.rb
index e1f01ec73a..9cc25002c4 100644
--- a/core/app/models/spree/payment.rb
+++ b/core/app/models/spree/payment.rb
@@ -172,7 +172,7 @@ module Spree
return
end
- source.payment_method_id = payment_method.id
+ source.payment_method_id = payment_method.id if source.respond_to?(:payment_method_id)
source.user_id = order.user_id if order
end
end
diff --git a/core/app/models/spree/payment_method/store_credit.rb b/core/app/models/spree/payment_method/store_credit.rb
index 86ceae1d2e..1ab35e1fce 100644
--- a/core/app/models/spree/payment_method/store_credit.rb
+++ b/core/app/models/spree/payment_method/store_credit.rb
@@ -118,7 +118,7 @@ module Spree
authorization: auth_code || response
)
else
- ActiveMerchant::Billing::Response.new(false, store_credit.errors.full_messages.join, {}, {})
+ ActiveMerchant::Billing::Response.new(false, store_credit.errors.full_messages.to_sentence, {}, {})
end
end
end
diff --git a/core/app/models/spree/store_credit.rb b/core/app/models/spree/store_credit.rb
index eddc1b13d8..57385f202d 100644
--- a/core/app/models/spree/store_credit.rb
+++ b/core/app/models/spree/store_credit.rb
@@ -40,7 +40,7 @@ module Spree
scope :order_by_priority, -> { includes(:credit_type).order('spree_store_credit_types.priority ASC') }
scope :not_authorized, -> { where(amount_authorized: 0) }
- scope :not_used, -> { where(amount_authorized: 0) }
+ scope :not_used, -> { where("#{Spree::StoreCredit.table_name}.amount_used < #{Spree::StoreCredit.table_name}.amount") }
scope :available, -> { not_authorized.not_used }
after_save :store_event
@@ -49,7 +49,7 @@ module Spree
attr_accessor :action, :action_amount, :action_originator, :action_authorization_code
extend Spree::DisplayMoney
- money_methods :amount, :amount_used
+ money_methods :amount, :amount_used, :amount_remaining
self.whitelisted_ransackable_attributes = %w[user_id created_by_id amount currency type_id]
self.whitelisted_ransackable_associations = %w[type user created_by]
diff --git a/core/app/views/spree/shared/_payment.html.erb b/core/app/views/spree/shared/_payment.html.erb
index 3a303ac646..baee5df433 100644
--- a/core/app/views/spree/shared/_payment.html.erb
+++ b/core/app/views/spree/shared/_payment.html.erb
@@ -12,17 +12,18 @@
<p class="mb-0"><%= Spree.t(:expires) %> <%= source.month %> / <%= source.year %></p>
</div>
<% elsif source.is_a?(Spree::StoreCredit) %>
- <% if source.gift_card %>
+ <% if source.respond_to?(:gift_card) && source.gift_card.present? %>
<div class="d-flex flex rounded bg-light px-3 py-2 mb-3 align-items-center">
<%= icon('gift', height: 30, class: 'mr-3 text-muted') %>
<div>
- <p class="mb-1">Gift card: <strong><%= source.gift_card.code.upcase %></strong></p>
+ <p class="mb-1"><%= Spree.t(:gift_card) %>: <strong><%= source.gift_card.code.upcase %></strong></p>
<%= @order.display_gift_card_total %>
</div>
</div>
- <% else %>
- <div class="rounded bg-light px-3 py-2 mb-3">
- <%= Spree.t(:store_credits) %>: <%= @order.display_total_applied_store_credit.abs %>
+ <% elsif payment_method_icon_tag(payment.payment_method.payment_icon_name).present? %>
+ <div class="d-flex flex align-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>
<% end %>
<% elsif source.present? %>
diff --git a/core/config/locales/en.yml b/core/config/locales/en.yml
index 7802d8ccd7..4817dc4895 100644
--- a/core/config/locales/en.yml
+++ b/core/config/locales/en.yml
@@ -1946,7 +1946,6 @@ en:
unable_to_find: Could not find store credit
unable_to_find_for_action: 'Could not find store credit for auth code: %{auth_code} for action: %{action}'
unable_to_void: 'Unable to void code: %{auth_code}'
- user_has_no_store_credits: User does not have any available store credit
store_credits: Store Credits
store_default: Default store
store_details: Store details
diff --git a/storefront/app/helpers/spree/checkout_helper.rb b/storefront/app/helpers/spree/checkout_helper.rb
index 9b5b2d7330..f64fd716ab 100644
--- a/storefront/app/helpers/spree/checkout_helper.rb
+++ b/storefront/app/helpers/spree/checkout_helper.rb
@@ -52,7 +52,7 @@ module Spree
end
def can_use_store_credit_on_checkout?(order)
- order.could_use_store_credit? && !order.gift_card.present?
+ order.could_use_store_credit? && (!order.respond_to?(:gift_card) || !order.gift_card.present?)
end
end
end