spree_cm_commissioner 2.9.8 → 2.9.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8eb692e530b34906dfca4d757e6382b9b643e18760fd38ba31507ceb24bb687b
-  data.tar.gz: 782a651003a7817fb539def0a19697d434978c51f7f48c0f2184b48fe87c1260
+  metadata.gz: 391b15d7aada08289da9a21d18a9d48d461ecf1fe0c36a361a276df201455a5e
+  data.tar.gz: af3f07ac5d9e449cb5300949dbbcdcb80981b78b41f0aa23a396ce6cdd49e68b
 SHA512:
-  metadata.gz: '090263c66bf5f79ea0edfcf6602185b0d80120f33308b2d0193cacf3bb2ebc5036543f1e1000b4e823a243a31cd3dc2eaf3e4b8772c6717d16891554b3da96a0'
-  data.tar.gz: 3540311c234819a354e154a532b7745e91ebf1faf7b15bcc40a5a6def80ea069d3820759b328decb2328f6ad60190a12686d5c23c0951c864ee89215160fd4a1
+  metadata.gz: 49e38586ae76dfcf37be8bb6f9c4ddef60a2ef694f491ffb648b5903070dd0932c2efb1d936f3c5a6b4c1af16355b2ddc26e4706cc04c7ed32bed0908ed88db5
+  data.tar.gz: be58778bd8a6124b8b3c914e9c0c83a44dce42a75c1df0f677ef00868bc388f3fa88518828e1833b701366eedf551e03a30528919a2c1f8ea16aec108d92b8fe

data/Gemfile.lock

@@ -34,7 +34,7 @@ GIT
 PATH
   remote: .
   specs:
-    spree_cm_commissioner (2.9.8)
+    spree_cm_commissioner (2.9.9)
       activerecord-multi-tenant
       activerecord_json_validator (~> 2.1, >= 2.1.3)
       aws-sdk-cloudfront

data/app/controllers/concerns/spree_cm_commissioner/content_cachable.rb

@@ -33,6 +33,7 @@ module SpreeCmCommissioner
       ShowContestantsController
       VotePackagesController
       ShowEliminationSessionsController
+      PaymentMethodsController
     ].freeze
 
     # Priority 3: Moderate Freshness (30 minutes)

data/app/controllers/spree/api/v2/storefront/payment_methods_controller.rb

@@ -0,0 +1,40 @@
+module Spree
+  module Api
+    module V2
+      module Storefront
+        # Order & user independent catalog of the payment methods a vendor accepts.
+        # Takes vendor_id as a required query param. See
+        # Spree::Api::V2::Tenant::PaymentMethodsController for the caching caveat
+        # that comes with that, and for what this deliberately leaves out.
+        class PaymentMethodsController < Spree::Api::V2::ResourceController
+          # override
+          def index
+            render_serialized_payload do
+              collection_serializer.new(collection).serializable_hash
+            end
+          end
+
+          # override
+          def collection
+            @collection ||= SpreeCmCommissioner::PaymentMethods::Find.new(
+              vendor: vendor,
+              store: current_store,
+              type: params[:type]
+            ).execute
+          end
+
+          # override
+          def collection_serializer
+            ::Spree::V2::Storefront::PaymentMethodSerializer
+          end
+
+          private
+
+          def vendor
+            @vendor ||= ::Spree::Vendor.active.find(params[:vendor_id])
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/spree/api/v2/tenant/payment_methods_controller.rb

@@ -0,0 +1,54 @@
+module Spree
+  module Api
+    module V2
+      module Tenant
+        # Order & user independent catalog of the payment methods a vendor accepts.
+        #
+        # vendor_id is a required query param. A vendor id is globally unique and
+        # belongs to exactly one tenant, so it is what identifies tenant, vendor and
+        # store here — the tenant itself comes from the Doorkeeper token, not the URL.
+        #
+        # IMPORTANT for caching (see SpreeCmCommissioner::ContentCachable): the CDN
+        # must include vendor_id in its cache key. If query strings are stripped,
+        # every vendor collapses into one cache entry and the wrong payment methods
+        # are served. Moving to /vendors/:vendor_id/payment_methods would remove that
+        # dependency — tracked as a follow-up.
+        #
+        # For the per-order truth (store credit, early adopter, payout filtering)
+        # use CartPaymentMethodGroupsController instead.
+        class PaymentMethodsController < BaseController
+          # override
+          def index
+            render_serialized_payload do
+              collection_serializer.new(collection).serializable_hash
+            end
+          end
+
+          # override
+          def collection
+            @collection ||= SpreeCmCommissioner::PaymentMethods::Find.new(
+              vendor: vendor,
+              store: current_store,
+              type: params[:type]
+            ).execute
+          end
+
+          # override
+          def collection_serializer
+            Spree::V2::Tenant::PaymentMethodSerializer
+          end
+
+          private
+
+          # Scoped to the token's tenant, so a token from another tenant gets a 404
+          # rather than a cache hit on someone else's vendor.
+          def vendor
+            @vendor ||= MultiTenant.with(@tenant) do
+              ::Spree::Vendor.active.find(params[:vendor_id])
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/app/finders/spree_cm_commissioner/payment_methods/find.rb

@@ -0,0 +1,59 @@
+module SpreeCmCommissioner
+  module PaymentMethods
+    # Order & user independent lookup of the payment methods a vendor accepts.
+    #
+    # Mirrors the scope selection of Vpago::OrderDecorator#available_payment_methods,
+    # minus everything that depends on the order or the current user, so the result
+    # is safe to cache on the vendor id alone:
+    #
+    #   - available_for_order?  (only Spree::PaymentMethod::StoreCredit varies, on user balance)
+    #   - available_on_frontend_for_early_adopter  (user attribute)
+    #   - support_payout?       (order line items)
+    #   - preferred_payment_method_id  (user, affects sort only)
+    #
+    # Callers needing the per-order truth must keep using
+    # Spree::Api::V2::*::CartPaymentMethodGroupsController.
+    class Find
+      attr_reader :vendor, :store, :type
+
+      def initialize(vendor:, store: nil, type: nil)
+        @vendor = vendor
+        @store = store
+        @type = type
+      end
+
+      def execute
+        return mini_app_scope if type.present?
+
+        scope.reject(&:mini_app?)
+      end
+
+      private
+
+      def scope
+        @scope ||= source.available_on_front_end.order(:position).to_a
+      end
+
+      # Vendors without their own payment methods fall back to the store's,
+      # same as Vpago::OrderDecorator#available_payment_methods.
+      def source
+        vendor_payment_methods.exists? ? vendor_payment_methods : store_payment_methods
+      end
+
+      def vendor_payment_methods
+        @vendor_payment_methods ||= vendor&.payment_methods || Spree::PaymentMethod.none
+      end
+
+      def store_payment_methods
+        (store || Spree::Store.default).payment_methods
+      end
+
+      def mini_app_scope
+        mapped_type = SpreeCmCommissioner::PaymentMethodTypeMapper.call(type)
+        return [] if mapped_type.blank?
+
+        scope.select { |payment_method| payment_method.mini_app? && payment_method.type == mapped_type }
+      end
+    end
+  end
+end

data/app/serializers/spree/v2/storefront/user_serializer_decorator.rb

@@ -7,7 +7,8 @@ module Spree
                           :country_code, :otp_enabled, :otp_email, :otp_phone_number,
                           :confirm_pin_code_enabled, :tenant_id,
                           :login, :qr_data, :qr_data_version, :qr_data_invalidated_at,
-                          :unread_notifications_count, :request_orders_count
+                          :unread_notifications_count, :request_orders_count,
+                          :preferred_payment_method_id
 
           base.attribute :has_incomplete_guest_info, &:has_incomplete_guest_info?
 

data/app/serializers/spree/v2/tenant/user_serializer.rb

@@ -6,7 +6,7 @@ module Spree
                    :public_metadata, :completed_orders,
                    :phone_number, :intel_phone_number, :country_code,
                    :otp_enabled, :otp_email, :otp_phone_number,
-                   :confirm_pin_code_enabled
+                   :confirm_pin_code_enabled, :preferred_payment_method_id
 
         has_one :profile, serializer: Spree::V2::Tenant::AssetSerializer
         has_many :device_tokens, serializer: Spree::V2::Tenant::UserDeviceTokenSerializer

data/app/services/spree_cm_commissioner/api_caches/invalidate.rb

@@ -9,7 +9,8 @@ module SpreeCmCommissioner
         'Spree::Menu' => Spree::Menu,
         'Spree::Taxon' => Spree::Taxon,
         'Spree::Product' => Spree::Product,
-        'Spree::Vendor' => Spree::Vendor
+        'Spree::Vendor' => Spree::Vendor,
+        'Spree::PaymentMethod' => Spree::PaymentMethod
       }.freeze
 
       # eg. 'Spree::Product', 123 or 'Spree::Product', nil
@@ -84,7 +85,8 @@ module SpreeCmCommissioner
             '/api/v2/storefront/vendors/:id*',
             '/api/v2/storefront/accommodations/:id*',
             '/api/v2/storefront/accommodations/:slug*'
-          ]
+          ],
+          'Spree::PaymentMethod' => payment_method_patterns
         }
       end
 
@@ -107,12 +109,31 @@ module SpreeCmCommissioner
             '/api/v2/tenant/vendors/*',
             '/api/v2/storefront/vendors/*',
             '/api/v2/storefront/accommodations/*'
-          ]
+          ],
+          'Spree::PaymentMethod' => payment_method_patterns
         }
       end
 
       private
 
+      # Deliberately broad, and identical for single-record and all-record
+      # invalidation: a payment method is either vendor-owned or store-level, and a
+      # store-level one is served for every vendor through the fallback in
+      # SpreeCmCommissioner::PaymentMethods::Find. From the record alone we cannot
+      # tell which vendors are affected.
+      #
+      # vendor_id is a query param, so the trailing `*` is what clears every
+      # vendor's cached variant of this path in one go.
+      #
+      # Payment methods change a handful of times a year, so a broad invalidation
+      # is cheap.
+      def payment_method_patterns
+        [
+          '/api/v2/tenant/payment_methods*',
+          '/api/v2/storefront/payment_methods*'
+        ]
+      end
+
       # eg. updated_at: Fri, 26 Dec 2025 10:40:56.505450000 +07 +07:00
       def refresh_record_cache_key(record)
         # rubocop:disable Rails/SkipsModelValidations

data/config/routes.rb

@@ -532,6 +532,7 @@ Spree::Core::Engine.add_routes do
       namespace :tenant do
         resource :token, controller: :access_tokens, only: [:create]
         resources :vendors
+        resources :payment_methods, only: %i[index]
         resources :products
         resources :taxons, only: %i[index show], id: /.+/
         resources :ad_campaigns, only: [:index]
@@ -757,6 +758,7 @@ Spree::Core::Engine.add_routes do
           resources :vendor_photos
           resources :events
         end
+        resources :payment_methods, only: %i[index]
         resource :homepage_data, only: [:show]
         resources :homepage_sections, only: [:index]
         resources :order_qrs, only: [:show]

data/lib/spree_cm_commissioner/version.rb

@@ -1,5 +1,5 @@
 module SpreeCmCommissioner
-  VERSION = '2.9.8'.freeze
+  VERSION = '2.9.9'.freeze
 
   module_function
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spree_cm_commissioner
 version: !ruby/object:Gem::Version
-  version: 2.9.8
+  version: 2.9.9
 platform: ruby
 authors:
 - You
@@ -1004,6 +1004,7 @@ files:
 - app/controllers/spree/api/v2/storefront/order_promotions_controller.rb
 - app/controllers/spree/api/v2/storefront/order_qrs_controller.rb
 - app/controllers/spree/api/v2/storefront/order_request_notifications_controller.rb
+- app/controllers/spree/api/v2/storefront/payment_methods_controller.rb
 - app/controllers/spree/api/v2/storefront/pending_line_items_controller.rb
 - app/controllers/spree/api/v2/storefront/pin_code_checkers_controller.rb
 - app/controllers/spree/api/v2/storefront/pin_code_generators_controller.rb
@@ -1074,6 +1075,7 @@ files:
 - app/controllers/spree/api/v2/tenant/my_votes_controller.rb
 - app/controllers/spree/api/v2/tenant/notifications_controller.rb
 - app/controllers/spree/api/v2/tenant/order_histories_controller.rb
+- app/controllers/spree/api/v2/tenant/payment_methods_controller.rb
 - app/controllers/spree/api/v2/tenant/pin_code_checkers_controller.rb
 - app/controllers/spree/api/v2/tenant/pin_code_generators_controller.rb
 - app/controllers/spree/api/v2/tenant/popular_route_places_controller.rb
@@ -1201,6 +1203,7 @@ files:
 - app/finders/spree_cm_commissioner/orders/find.rb
 - app/finders/spree_cm_commissioner/orders/find_by_all_state.rb
 - app/finders/spree_cm_commissioner/orders/find_by_state.rb
+- app/finders/spree_cm_commissioner/payment_methods/find.rb
 - app/finders/spree_cm_commissioner/payment_methods/group_by_bank.rb
 - app/finders/spree_cm_commissioner/places/find_with_route.rb
 - app/finders/spree_cm_commissioner/products/find_decorator.rb