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.

Add payment links (#12531)

Łukasz Adamczyk81a37f73b0c6
diff --git a/admin/app/controllers/spree/admin/orders/payment_links_controller.rb b/admin/app/controllers/spree/admin/orders/payment_links_controller.rb
new file mode 100644
index 0000000000..4ad29af388
--- /dev/null
+++ b/admin/app/controllers/spree/admin/orders/payment_links_controller.rb
@@ -0,0 +1,33 @@
+module Spree
+ module Admin
+ module Orders
+ class PaymentLinksController < Spree::Admin::BaseController
+ include Spree::Admin::OrderConcern
+
+ before_action :load_order
+ before_action :ensure_frontend_available
+
+ def create
+ recipient_email = @order.user&.email || @order.email
+
+ if recipient_email.present?
+ Spree::OrderMailer.payment_link_email(@order.id).deliver_later
+ flash[:success] = Spree.t('admin.orders.payment_link_sent')
+ else
+ flash[:error] = Spree.t('admin.orders.no_email_present')
+ end
+
+ redirect_back fallback_location: spree.edit_admin_order_url(@order)
+ end
+
+ private
+
+ def ensure_frontend_available
+ unless Spree::Core::Engine.frontend_available? && spree.respond_to?(:checkout_state_url)
+ redirect_to spree.edit_admin_order_url(@order)
+ end
+ end
+ end
+ end
+ end
+end
diff --git a/admin/spec/controllers/spree/admin/orders/payment_links_controller_spec.rb b/admin/spec/controllers/spree/admin/orders/payment_links_controller_spec.rb
new file mode 100644
index 0000000000..a331397c6c
--- /dev/null
+++ b/admin/spec/controllers/spree/admin/orders/payment_links_controller_spec.rb
@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+RSpec.describe Spree::Admin::Orders::PaymentLinksController, type: :controller do
+ stub_authorization!
+ render_views
+
+ let(:order) { create(:order_with_line_items, state: 'payment') }
+
+ describe 'POST #create' do
+ subject { post :create, params: { order_id: order.number } }
+
+ context 'when frontend is available' do
+ let(:payment_url) { "http://shop.com/checkout/#{order.token}/payment" }
+
+ before do
+ allow(Spree::Core::Engine).to receive(:frontend_available?).and_return(true)
+ allow(spree).to receive(:checkout_state_url).and_return(payment_url)
+ end
+
+ it 'sends a payment link email' do
+ expect {
+ subject
+ perform_enqueued_jobs(except: Spree::Addresses::GeocodeAddressJob)
+ }.to change { ActionMailer::Base.deliveries.count }.by(1)
+
+ expect(flash[:success]).to eq(Spree.t('admin.orders.payment_link_sent'))
+ expect(response).to redirect_to(spree.edit_admin_order_path(order))
+
+ expect(ActionMailer::Base.deliveries.last.body).to include(payment_url)
+ end
+ end
+
+ context 'when frontend is not available' do
+ before do
+ allow(Spree::Core::Engine).to receive(:frontend_available?).and_return(false)
+ end
+
+ it 'redirects to the order edit page' do
+ subject
+ expect(response).to redirect_to(spree.edit_admin_order_path(order))
+ end
+ end
+ end
+end
diff --git a/core/config/locales/en.yml b/core/config/locales/en.yml
index eae75f70e2..845fc79998 100644
--- a/core/config/locales/en.yml
+++ b/core/config/locales/en.yml
@@ -1344,23 +1344,28 @@ en:
order_line_items: Order Line Items
order_mailer:
cancel_email:
- dear_customer: Dear %{name},
+ dear_customer: Hey %{name},
instructions: Your order has been CANCELED. Please retain this cancellation information for your records.
order_summary_canceled: Order %{number} Summary [CANCELED]
subject: Cancellation of Order
- thanks: Thank you for your business.
+ thanks: Thank you for
confirm_email:
- dear_customer: Dear %{name},
+ dear_customer: Hey %{name},
instructions: Please review and retain the following order information for your records.
order_summary: Order %{number} Summary
subject: Order Confirmation
- thanks: Thank you for your business.
+ thanks: Thank you
+ payment_link_email:
+ message: Please click the button below to pay for your order.
+ message_copy_link: 'If the button doesn''t work please copy and paste the following link to your browser:'
+ pay_for_order: Pay for order
+ subject: "Payment link for order #%{number}"
store_owner_notification_email:
heading: New Order Received
instructions: You have received a new order.
order_summary: Order %{number} Summary
subject: "%{store_name} received a new order"
- thanks: Thank you for your business.
+ thanks: Thank you
store_team: "%{store_name} Team"
subtotal: 'Subtotal:'
total: 'Order Total:'
diff --git a/core/db/migrate/20250314144210_create_spree_taggings_and_spree_tags.rb b/core/db/migrate/20250314144210_create_spree_taggings_and_spree_tags.rb
index aee40ed6fb..f9278d6a37 100644
--- a/core/db/migrate/20250314144210_create_spree_taggings_and_spree_tags.rb
+++ b/core/db/migrate/20250314144210_create_spree_taggings_and_spree_tags.rb
@@ -9,18 +9,18 @@ class CreateSpreeTaggingsAndSpreeTags < ActiveRecord::Migration[7.2]
t.string "context", limit: 128
t.datetime "created_at", precision: nil
t.string "tenant", limit: 128
- t.index ["context"], name: "index_taggings_on_context"
- t.index ["tag_id", "taggable_id", "taggable_type", "context", "tagger_id", "tagger_type"], name: "taggings_idx", unique: true
- t.index ["tag_id"], name: "index_taggings_on_tag_id"
- t.index ["taggable_id", "taggable_type", "context"], name: "taggings_taggable_context_idx"
- t.index ["taggable_id", "taggable_type", "tagger_id", "context"], name: "taggings_idy"
- t.index ["taggable_id"], name: "index_taggings_on_taggable_id"
- t.index ["taggable_type", "taggable_id"], name: "index_taggings_on_taggable_type_and_taggable_id"
- t.index ["taggable_type"], name: "index_taggings_on_taggable_type"
- t.index ["tagger_id", "tagger_type"], name: "index_taggings_on_tagger_id_and_tagger_type"
- t.index ["tagger_id"], name: "index_taggings_on_tagger_id"
- t.index ["tagger_type", "tagger_id"], name: "index_taggings_on_tagger_type_and_tagger_id"
- t.index ["tenant"], name: "index_taggings_on_tenant"
+ t.index ["context"], name: "index_spree_taggings_on_context"
+ t.index ["tag_id", "taggable_id", "taggable_type", "context", "tagger_id", "tagger_type"], name: "spree_taggings_idx", unique: true
+ t.index ["tag_id"], name: "index_spree_taggings_on_tag_id"
+ t.index ["taggable_id", "taggable_type", "context"], name: "spree_taggings_taggable_context_idx"
+ t.index ["taggable_id", "taggable_type", "tagger_id", "context"], name: "spree_taggings_idy"
+ t.index ["taggable_id"], name: "index_spree_taggings_on_taggable_id"
+ t.index ["taggable_type", "taggable_id"], name: "index_spree_taggings_on_taggable_type_and_taggable_id"
+ t.index ["taggable_type"], name: "index_spree_taggings_on_taggable_type"
+ t.index ["tagger_id", "tagger_type"], name: "index_spree_taggings_on_tagger_id_and_tagger_type"
+ t.index ["tagger_id"], name: "index_spree_taggings_on_tagger_id"
+ t.index ["tagger_type", "tagger_id"], name: "index_spree_taggings_on_tagger_type_and_tagger_id"
+ t.index ["tenant"], name: "index_spree_taggings_on_tenant"
end
create_table :spree_tags do |t|
@@ -28,7 +28,7 @@ class CreateSpreeTaggingsAndSpreeTags < ActiveRecord::Migration[7.2]
t.datetime "created_at", null: false
t.datetime "updated_at", null: false
t.integer "taggings_count", default: 0
- t.index ["name"], name: "index_tags_on_name", unique: true
+ t.index ["name"], name: "index_spree_tags_on_name", unique: true
end
if ActiveRecord::Base.connection.adapter_name == 'PostgreSQL'
diff --git a/emails/app/mailers/spree/order_mailer.rb b/emails/app/mailers/spree/order_mailer.rb
index 341c5e0fa7..b52054a923 100644
--- a/emails/app/mailers/spree/order_mailer.rb
+++ b/emails/app/mailers/spree/order_mailer.rb
@@ -22,5 +22,14 @@ module Spree
subject += "#{current_store.name} #{Spree.t('order_mailer.cancel_email.subject')} ##{@order.number}"
mail(to: @order.email, from: from_address, subject: subject, store_url: current_store.url, reply_to: reply_to_address)
end
+
+ def payment_link_email(order_id)
+ @order = Spree::Order.incomplete.not_canceled.find(order_id)
+ @current_store = @order.store
+ @checkout_payment_url = spree.checkout_state_url(@order.token, :payment, host: @current_store.url_or_custom_domain)
+
+ mail(to: @order.email, from: from_address, subject: Spree.t('order_mailer.payment_link_email.subject', number: @order.number),
+ store_url: @current_store.url_or_custom_domain, reply_to: reply_to_address)
+ end
end
end
diff --git a/emails/app/views/spree/order_mailer/payment_link_email.html.erb b/emails/app/views/spree/order_mailer/payment_link_email.html.erb
new file mode 100644
index 0000000000..c07c2e6bc3
--- /dev/null
+++ b/emails/app/views/spree/order_mailer/payment_link_email.html.erb
@@ -0,0 +1,16 @@
+<h1>
+ <%= Spree.t('order_mailer.confirm_email.dear_customer', name: name_for(@order)) %>
+</h1>
+<p>
+ <%= Spree.t('order_mailer.payment_link_email.message', store_name: @current_store.name) %>
+</p>
+<p>
+ <%= link_to Spree.t('order_mailer.payment_link_email.pay_for_order'), @checkout_payment_url, class: 'button' %>
+ <p>
+ <%= Spree.t('order_mailer.payment_link_email.message_copy_link') %>
+ <br>
+ <span style="word-break: break-all;">
+ <%= link_to @checkout_payment_url, @checkout_payment_url %>
+ </span>
+ </p>
+</p>
diff --git a/emails/spec/mailers/spree/order_mailer_spec.rb b/emails/spec/mailers/spree/order_mailer_spec.rb
index 06ae266886..9edbbb72a3 100644
--- a/emails/spec/mailers/spree/order_mailer_spec.rb
+++ b/emails/spec/mailers/spree/order_mailer_spec.rb
@@ -110,14 +110,14 @@ describe Spree::OrderMailer, type: :mailer do
context 'when order does not have customer\'s name' do
before { allow(order).to receive(:name).and_return nil }
- specify 'shows Dear Customer in confirm_email body' do
+ specify 'shows Hey Customer in confirm_email body' do
confirmation_email = described_class.confirm_email(order)
- expect(confirmation_email).to have_body_text('Dear Customer')
+ expect(confirmation_email).to have_body_text('Hey Customer')
end
- specify 'shows Dear Customer in cancel_email body' do
+ specify 'shows Hey Customer in cancel_email body' do
confirmation_email = described_class.cancel_email(order)
- expect(confirmation_email).to have_body_text('Dear Customer')
+ expect(confirmation_email).to have_body_text('Hey Customer')
end
end
@@ -126,12 +126,12 @@ describe Spree::OrderMailer, type: :mailer do
specify 'shows order\'s user name in confirm_email body' do
confirmation_email = described_class.confirm_email(order)
- expect(confirmation_email).to have_body_text('Dear Test User')
+ expect(confirmation_email).to have_body_text('Hey Test User')
end
specify 'shows order\'s user name in cancel_email body' do
confirmation_email = described_class.cancel_email(order)
- expect(confirmation_email).to have_body_text('Dear Test User')
+ expect(confirmation_email).to have_body_text('Hey Test User')
end
end
@@ -280,4 +280,22 @@ describe Spree::OrderMailer, type: :mailer do
expect(ActionMailer::Base.default_url_options[:host]).to eq(second_order.store.url)
end
end
+
+ describe '#payment_link_email' do
+ let(:payment_link_email) { described_class.payment_link_email(order_for_payment.id) }
+
+ let(:order_for_payment) { create(:order_with_line_items, store: first_store) }
+ let(:payment_url) { "http://shop.com/checkout/#{order_for_payment.token}/payment" }
+
+ before do
+ allow(Spree::Core::Engine.routes.url_helpers).to receive(:checkout_state_url).and_return(payment_url)
+ end
+
+ it 'sends an email with the payment link' do
+ expect(payment_link_email.from).to contain_exactly(first_store.mail_from_address)
+ expect(payment_link_email.to).to contain_exactly(order_for_payment.email)
+ expect(payment_link_email.subject).to eq("Payment link for order ##{order_for_payment.number}")
+ expect(payment_link_email.body).to include(payment_url)
+ end
+ end
end