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.

Added `PaymentMethod#session_required?`

Damian Legawiec2ed68d45d8a5
diff --git a/backend/engines/api/app/serializers/spree/api/v3/payment_method_serializer.rb b/backend/engines/api/app/serializers/spree/api/v3/payment_method_serializer.rb
index 0746f65e4c..4d6b01f2ed 100644
--- a/backend/engines/api/app/serializers/spree/api/v3/payment_method_serializer.rb
+++ b/backend/engines/api/app/serializers/spree/api/v3/payment_method_serializer.rb
@@ -2,9 +2,13 @@ module Spree
module Api
module V3
class PaymentMethodSerializer < BaseSerializer
- typelize name: :string, description: 'string | null', type: :string
+ typelize name: :string, description: 'string | null', type: :string, session_required: :boolean
attributes :name, :description, :type
+
+ attribute :session_required do |payment_method|
+ payment_method.session_required?
+ end
end
end
end
diff --git a/backend/engines/api/spec/controllers/spree/api/v3/store/orders/payment_methods_controller_spec.rb b/backend/engines/api/spec/controllers/spree/api/v3/store/orders/payment_methods_controller_spec.rb
index e755c9bfaf..eb2bd1b70c 100644
--- a/backend/engines/api/spec/controllers/spree/api/v3/store/orders/payment_methods_controller_spec.rb
+++ b/backend/engines/api/spec/controllers/spree/api/v3/store/orders/payment_methods_controller_spec.rb
@@ -28,6 +28,14 @@ RSpec.describe Spree::Api::V3::Store::Orders::PaymentMethodsController, type: :c
expect(json_response['data'].map { |pm| pm['id'] }).not_to include(backend_only_pm.prefixed_id)
end
+ it 'includes session_required in the response' do
+ get :index, params: { order_id: order.to_param }
+
+ pm = json_response['data'].find { |p| p['id'] == payment_method.prefixed_id }
+ expect(pm).to have_key('session_required')
+ expect(pm['session_required']).to eq(payment_method.session_required?)
+ end
+
it 'includes payment method count in meta' do
get :index, params: { order_id: order.to_param }
diff --git a/backend/engines/core/app/models/spree/gateway/bogus.rb b/backend/engines/core/app/models/spree/gateway/bogus.rb
index 5fce1e9539..9a98a885ea 100644
--- a/backend/engines/core/app/models/spree/gateway/bogus.rb
+++ b/backend/engines/core/app/models/spree/gateway/bogus.rb
@@ -84,6 +84,10 @@ module Spree
CreditCard
end
+ def session_required?
+ true
+ end
+
def payment_session_class
PaymentSession::Bogus
end
diff --git a/backend/engines/core/app/models/spree/payment_method.rb b/backend/engines/core/app/models/spree/payment_method.rb
index 57ffc6a613..860f659681 100644
--- a/backend/engines/core/app/models/spree/payment_method.rb
+++ b/backend/engines/core/app/models/spree/payment_method.rb
@@ -28,6 +28,7 @@ module Spree
has_many :payments, class_name: 'Spree::Payment', inverse_of: :payment_method, dependent: :nullify
has_many :credit_cards, class_name: 'Spree::CreditCard', dependent: :destroy # CCs are soft deleted
+ has_many :payment_sessions, class_name: 'Spree::PaymentSession', dependent: :destroy
has_many :gateway_customers, class_name: 'Spree::GatewayCustomer', dependent: :destroy
def self.providers
@@ -101,6 +102,10 @@ module Spree
true
end
+ def session_required?
+ false
+ end
+
def show_in_admin?
true
end
diff --git a/backend/engines/core/spec/models/spree/gateway/bogus_spec.rb b/backend/engines/core/spec/models/spree/gateway/bogus_spec.rb
index 1167b180ef..ed3d05af82 100644
--- a/backend/engines/core/spec/models/spree/gateway/bogus_spec.rb
+++ b/backend/engines/core/spec/models/spree/gateway/bogus_spec.rb
@@ -9,5 +9,9 @@ module Spree
bogus.disable_customer_profile(cc)
expect(cc.gateway_customer_profile_id).to be_nil
end
+
+ describe '#session_required?' do
+ it { expect(bogus.session_required?).to be true }
+ end
end
end
diff --git a/backend/engines/core/spec/models/spree/payment_method_spec.rb b/backend/engines/core/spec/models/spree/payment_method_spec.rb
index 05c9fbb8aa..2c2caf4c85 100644
--- a/backend/engines/core/spec/models/spree/payment_method_spec.rb
+++ b/backend/engines/core/spec/models/spree/payment_method_spec.rb
@@ -175,6 +175,12 @@ describe Spree::PaymentMethod, type: :model do
it { expect(payment_method.source_required?).to be true }
end
+ describe '#session_required?' do
+ it 'returns false by default' do
+ expect(build(:payment_method).session_required?).to be false
+ end
+ end
+
describe '#payment_source_class' do
let(:payment_method) { build(:credit_card_payment_method) }
diff --git a/packages/sdk/src/types/generated/StorePaymentMethod.ts b/packages/sdk/src/types/generated/StorePaymentMethod.ts
index ce77537010..37afc28aef 100644
--- a/packages/sdk/src/types/generated/StorePaymentMethod.ts
+++ b/packages/sdk/src/types/generated/StorePaymentMethod.ts
@@ -1,4 +1,4 @@
-// Typelizer digest 43dd8a30560bdc20d9cf25fb3cc9d770
+// Typelizer digest 931266553a60a4640576d6c7764360d7
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
@@ -7,6 +7,7 @@ type StorePaymentMethod = {
name: string;
description: string | null;
type: string;
+ session_required: boolean;
}
export default StorePaymentMethod;
diff --git a/packages/sdk/src/types/generated/StorePaymentSession.ts b/packages/sdk/src/types/generated/StorePaymentSession.ts
index f87d74e663..271a940b2b 100644
--- a/packages/sdk/src/types/generated/StorePaymentSession.ts
+++ b/packages/sdk/src/types/generated/StorePaymentSession.ts
@@ -1,4 +1,4 @@
-// Typelizer digest placeholder
+// Typelizer digest 825c17296299923dcddc259430189b15
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
import type {StorePaymentMethod, StorePayment} from '@/types'
@@ -6,18 +6,18 @@ import type {StorePaymentMethod, StorePayment} from '@/types'
type StorePaymentSession = {
id: string;
status: string;
- amount: string;
currency: string;
external_id: string;
external_data: Record<string, unknown>;
- expires_at: string | null;
customer_external_id: string | null;
- payment_method_id: string;
- order_id: string;
+ expires_at: string | null;
created_at: string;
updated_at: string;
+ amount: string;
+ payment_method_id: string;
+ order_id: string;
payment_method: StorePaymentMethod;
- payment: StorePayment;
+ payment?: StorePayment;
}
export default StorePaymentSession;
diff --git a/packages/sdk/src/types/generated/index.ts b/packages/sdk/src/types/generated/index.ts
index 0d7d07b73f..3bf3e8e219 100644
--- a/packages/sdk/src/types/generated/index.ts
+++ b/packages/sdk/src/types/generated/index.ts
@@ -1,4 +1,4 @@
-// Typelizer digest dc6d3f1a1a2c4d62edbbdfb58b1824c3
+// Typelizer digest 4db1ab7a8a6084893650abac3ad9657d
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
export type { default as StoreAddress } from './StoreAddress'