spree_stripe 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b3cc636d33d9aa8152aba43d60a15a1d3c44dca2feeafcd30c215cec823c028
-  data.tar.gz: 82cf337690f6c7f03d4770e2001e4d4dc3a273d4b84887f079e664a02788edd6
+  metadata.gz: a10e7ebb4ff5cc5960d0ecb894cfc0e15ef4ed058bf2133fc412ca9fc4c95910
+  data.tar.gz: 49fd3295806ed476343813ac3ce3356d74054bf84db8ecf9f4ade86099f139c3
 SHA512:
-  metadata.gz: 0ddd1b76f5c7991a636f78751fc43c8bc5eac6b952a91621ad928eaa66823f0b2bfa42a21ba7ba2942934c9146eb362841ad8ef7cc74f63b1422f8a2fbdf23ec
-  data.tar.gz: 9b9d768391f1e41ff1444dcf9f6faad7bab6c73c25e9712f0628171d770c3d00ef9b71d38f8be1ab471a21e979e9d5d8bd03e2b3cb8d0c68623e4d717d0f87b1
+  metadata.gz: 3ceff451db2064b42fe695aaa91b0ff7c2512fa455504ba459f84a1c788731fd490d85c3a950972a3a7942acaf9cce64a2d6d2de2ce0ace9d2bfccacccc95770
+  data.tar.gz: cd0aff0b871a315fd19b5529912ce431ab5c5c35657bab1853fd2548e80591f031f79ee81bab107f64da05f985bfad7271b288fc813a87d4a583935581ad66c0

data/app/models/spree/payment_setup_sessions/stripe.rb

@@ -0,0 +1,21 @@
+module Spree
+  class PaymentSetupSessions::Stripe < PaymentSetupSession
+    delegate :api_options, to: :payment_method
+
+    def stripe_id
+      external_id
+    end
+
+    def client_secret
+      external_client_secret
+    end
+
+    def stripe_setup_intent
+      @stripe_setup_intent ||= payment_method.retrieve_setup_intent(external_id)
+    end
+
+    def successful?
+      stripe_setup_intent.status == 'succeeded'
+    end
+  end
+end

data/app/models/spree_stripe/gateway/payment_intents.rb

@@ -5,6 +5,7 @@ module SpreeStripe
 
       DELAYED_NOTIFICATION_PAYMENT_METHOD_TYPES = %w[sepa_debit us_bank_account].freeze
       BANK_PAYMENT_METHOD_TYPES = %w[customer_balance us_bank_account].freeze
+      MANUAL_CAPTURE_METHOD = 'manual'.freeze
 
       included do
         has_many :payment_intents, class_name: 'SpreeStripe::PaymentIntent', foreign_key: 'payment_method_id', dependent: :delete_all
@@ -32,6 +33,14 @@ module SpreeStripe
         payment_intent.payment_method.type.in?(BANK_PAYMENT_METHOD_TYPES)
       end
 
+      def payment_intent_requires_capture?(payment_intent)
+        payment_intent.status == 'requires_capture'
+      end
+
+      def payment_intent_manual_capture?(payment_intent)
+        payment_intent.respond_to?(:capture_method) && payment_intent.capture_method == MANUAL_CAPTURE_METHOD
+      end
+
       # Creates a Stripe payment intent for the order
       #
       # @param amount_in_cents [Integer] the amount in cents
@@ -46,7 +55,8 @@ module SpreeStripe
           order: order,
           customer: customer_profile_id || fetch_or_create_customer(order: order)&.profile_id,
           payment_method_id: payment_method_id,
-          off_session: off_session
+          off_session: off_session,
+          capture_method: stripe_capture_method
         ).call
 
         protect_from_error do
@@ -127,8 +137,13 @@ module SpreeStripe
 
       private
 
+      def stripe_capture_method
+        auto_capture? ? nil : MANUAL_CAPTURE_METHOD
+      end
+
       def payment_intent_accepted_statuses(payment_intent)
         statuses = %w[succeeded]
+        statuses << 'requires_capture' if payment_intent_manual_capture?(payment_intent)
         statuses << 'processing' if payment_intent_delayed_notification?(payment_intent)
         statuses << 'requires_action' if payment_intent_charge_not_required?(payment_intent)
         statuses

data/app/models/spree_stripe/gateway/payment_sessions.rb

@@ -90,7 +90,8 @@ module SpreeStripe
           # Create the Payment record
           payment_session.find_or_create_payment!
 
-          # Process the payment state
+          # `else` covers requires_capture (manual capture), processing (delayed-notification
+          # banks), and requires_action (bank transfer awaiting funds) — all auth-only states.
           payment = payment_session.payment
           if payment.present? && !payment.completed?
             if payment_intent_successful?(stripe_pi)
@@ -128,7 +129,9 @@ module SpreeStripe
         return if order.bill_address.present? && order.bill_address.valid?
 
         country_iso = address.country
-        country = Spree::Country.find_by(iso: country_iso) || Spree::Country.default
+        country = (country_iso.present? && Spree::Country.by_iso(country_iso)) ||
+                  order.store.default_market&.default_country ||
+                  Spree::Country.by_iso('US')
 
         order.bill_address ||= Spree::Address.new(country: country, user: order.user)
         order.bill_address.quick_checkout = true

data/app/models/spree_stripe/gateway/payment_setup_sessions.rb

@@ -0,0 +1,63 @@
+module SpreeStripe
+  class Gateway < ::Spree::Gateway
+    module PaymentSetupSessions
+      extend ActiveSupport::Concern
+
+      def setup_session_supported?
+        true
+      end
+
+      def payment_setup_session_class
+        Spree::PaymentSetupSessions::Stripe
+      end
+
+      def create_payment_setup_session(customer:, external_data: {})
+        gateway_customer = fetch_or_create_customer(user: customer)
+
+        setup_intent_response = create_setup_intent(gateway_customer.profile_id)
+        ephemeral_key_response = create_ephemeral_key(gateway_customer.profile_id)
+
+        payment_setup_session_class.create!(
+          customer: customer,
+          payment_method: self,
+          status: 'pending',
+          external_id: setup_intent_response.params['id'],
+          external_client_secret: setup_intent_response.authorization,
+          external_data: external_data.to_h.stringify_keys.merge(
+            'customer_id' => gateway_customer.profile_id,
+            'ephemeral_key_secret' => ephemeral_key_response&.params&.dig('secret')
+          ).compact
+        )
+      end
+
+      def complete_payment_setup_session(setup_session:, params: {})
+        stripe_setup_intent = retrieve_setup_intent(setup_session.external_id)
+
+        if stripe_setup_intent.status == 'succeeded'
+          setup_session.process if setup_session.can_process?
+
+          stripe_payment_method = stripe_setup_intent.payment_method
+
+          source = SpreeStripe::CreateSource.new(
+            stripe_payment_method_details: stripe_payment_method,
+            stripe_payment_method_id: stripe_payment_method.id,
+            stripe_billing_details: stripe_payment_method.billing_details,
+            gateway: self,
+            user: setup_session.customer
+          ).call
+
+          setup_session.payment_source = source
+          setup_session.complete unless setup_session.completed?
+        else
+          setup_session.fail if setup_session.can_fail?
+        end
+
+        setup_session
+      end
+
+      def retrieve_setup_intent(setup_intent_id)
+        send_request { |opts| Stripe::SetupIntent.retrieve({ id: setup_intent_id, expand: ['payment_method'] }, opts) }
+      end
+    end
+  end
+end

data/app/models/spree_stripe/gateway.rb

@@ -2,11 +2,18 @@ module SpreeStripe
   class Gateway < ::Spree::Gateway
     include SpreeStripe::Gateway::PaymentIntents
     include SpreeStripe::Gateway::PaymentSessions
+    include SpreeStripe::Gateway::PaymentSetupSessions
     include SpreeStripe::Gateway::Tax if defined?(SpreeStripe::Gateway::Tax)
 
     preference :publishable_key, :password
     preference :secret_key, :password
 
+    WEBHOOK_EVENT_ACTIONS = {
+      'payment_intent.succeeded' => :captured,
+      'payment_intent.amount_capturable_updated' => :authorized,
+      'payment_intent.payment_failed' => :failed
+    }.freeze
+
     has_one_attached :apple_developer_merchantid_domain_association, service: Spree.private_storage_service_name
 
     validates :preferred_secret_key, :preferred_publishable_key, presence: true
@@ -29,20 +36,16 @@ module SpreeStripe
     def parse_webhook_event(raw_body, headers)
       event = verify_webhook_signature(raw_body, headers)
 
+      action = WEBHOOK_EVENT_ACTIONS[event.type]
+      return nil unless action
+
       payment_session = Spree::PaymentSessions::Stripe.find_by(
         payment_method: self,
         external_id: event.data.object[:id]
       )
       return nil unless payment_session
 
-      case event.type
-      when 'payment_intent.succeeded'
-        { action: :captured, payment_session: payment_session, metadata: { stripe_event: event } }
-      when 'payment_intent.payment_failed'
-        { action: :failed, payment_session: payment_session, metadata: { stripe_event: event } }
-      else
-        nil
-      end
+      { action: action, payment_session: payment_session, metadata: { stripe_event: event } }
     end
 
     def provider_class
@@ -106,7 +109,7 @@ module SpreeStripe
       protect_from_error do
         stripe_payment_intent = retrieve_payment_intent(payment_intent_id)
 
-        response = if stripe_payment_intent.status == 'requires_capture'
+        response = if payment_intent_requires_capture?(stripe_payment_intent)
                      capture_payment_intent(payment_intent_id, amount_in_cents)
                    elsif stripe_payment_intent.status == 'succeeded'
                      stripe_payment_intent

data/app/presenters/spree_stripe/payment_intent_presenter.rb

@@ -2,13 +2,14 @@ module SpreeStripe
   class PaymentIntentPresenter
     SETUP_FUTURE_USAGE = 'off_session'
 
-    def initialize(amount:, order:, customer: nil, payment_method_id: nil, off_session: false)
+    def initialize(amount:, order:, customer: nil, payment_method_id: nil, off_session: false, capture_method: nil)
       @amount = amount
       @order = order
       @customer = customer
       @ship_address = order.ship_address
       @payment_method_id = payment_method_id
       @off_session = off_session
+      @capture_method = capture_method
     end
 
     def call
@@ -19,6 +20,7 @@ module SpreeStripe
                 end
 
       payload = payload.deep_merge(basic_payload)
+      payload = payload.merge(capture_method: SpreeStripe::Gateway::PaymentIntents::MANUAL_CAPTURE_METHOD) if manual_capture?
 
       return payload unless ship_address
 
@@ -49,7 +51,11 @@ module SpreeStripe
 
     private
 
-    attr_reader :order, :amount, :customer, :ship_address, :payment_method_id
+    attr_reader :order, :amount, :customer, :ship_address, :payment_method_id, :capture_method
+
+    def manual_capture?
+      capture_method.to_s == SpreeStripe::Gateway::PaymentIntents::MANUAL_CAPTURE_METHOD
+    end
 
     def basic_payload
       {

data/app/services/spree_stripe/webhook_handlers/base.rb

@@ -0,0 +1,19 @@
+module SpreeStripe
+  module WebhookHandlers
+    class Base
+      # Delay before processing a webhook to give the storefront's own session-complete
+      # request a chance to land first, avoiding double-processing of the same payment.
+      ENQUEUE_DELAY = 10.seconds
+
+      private
+
+      def enqueue_complete_order_from_session(stripe_id)
+        payment_session = Spree::PaymentSessions::Stripe.find_by(external_id: stripe_id)
+        return nil if payment_session.nil?
+
+        SpreeStripe::CompleteOrderFromSessionJob.set(wait: ENQUEUE_DELAY).perform_later(payment_session.id)
+        payment_session
+      end
+    end
+  end
+end

data/app/services/spree_stripe/webhook_handlers/payment_intent_amount_capturable_updated.rb

@@ -0,0 +1,13 @@
+module SpreeStripe
+  module WebhookHandlers
+    # Fires when a manual-capture PaymentIntent transitions to `requires_capture`
+    # (i.e. the funds have been authorized but not yet captured). For new
+    # PaymentSession-based flows we hand off to CompleteOrderFromSessionJob,
+    # which authorizes the Spree::Payment and completes the order.
+    class PaymentIntentAmountCapturableUpdated < Base
+      def call(event)
+        enqueue_complete_order_from_session(event.data.object[:id])
+      end
+    end
+  end
+end

data/app/services/spree_stripe/webhook_handlers/payment_intent_succeeded.rb

@@ -1,21 +1,16 @@
 module SpreeStripe
   module WebhookHandlers
-    class PaymentIntentSucceeded
+    class PaymentIntentSucceeded < Base
       def call(event)
         stripe_id = event.data.object[:id]
 
-        # New system: PaymentSession
-        payment_session = Spree::PaymentSessions::Stripe.find_by(external_id: stripe_id)
-        if payment_session.present?
-          SpreeStripe::CompleteOrderFromSessionJob.set(wait: 10.seconds).perform_later(payment_session.id)
-          return
-        end
+        return if enqueue_complete_order_from_session(stripe_id)
 
         # Legacy system: PaymentIntent
         payment_intent = SpreeStripe::PaymentIntent.find_by(stripe_id: stripe_id)
         return if payment_intent.nil?
 
-        SpreeStripe::CompleteOrderJob.set(wait: 10.seconds).perform_later(payment_intent.id)
+        SpreeStripe::CompleteOrderJob.set(wait: ENQUEUE_DELAY).perform_later(payment_intent.id)
       end
     end
   end

data/config/initializers/stripe.rb

@@ -8,6 +8,7 @@ Stripe.set_app_info('Spree Stripe', version: Spree.version, url: 'https://spreec
 Rails.application.config.after_initialize do
   StripeEvent.configure do |events|
     events.subscribe 'payment_intent.succeeded', SpreeStripe::WebhookHandlers::PaymentIntentSucceeded.new
+    events.subscribe 'payment_intent.amount_capturable_updated', SpreeStripe::WebhookHandlers::PaymentIntentAmountCapturableUpdated.new
     events.subscribe 'payment_intent.payment_failed', SpreeStripe::WebhookHandlers::PaymentIntentPaymentFailed.new
     events.subscribe 'setup_intent.succeeded', SpreeStripe::WebhookHandlers::SetupIntentSucceeded.new
   end

data/lib/spree_stripe/configuration.rb

@@ -1,6 +1,11 @@
 module SpreeStripe
   class Configuration < Spree::Preferences::Configuration
-    preference :supported_webhook_events, :array, default: %w[payment_intent.payment_failed payment_intent.succeeded setup_intent.succeeded]
+    preference :supported_webhook_events, :array, default: %w[
+      payment_intent.amount_capturable_updated
+      payment_intent.payment_failed
+      payment_intent.succeeded
+      setup_intent.succeeded
+    ]
     preference :use_legacy_payment_intents, :boolean, default: false
     preference :use_legacy_webhook_handlers, :boolean, default: false
   end

data/lib/spree_stripe/version.rb

@@ -1,5 +1,5 @@
 module SpreeStripe
-  VERSION = '1.6.0'.freeze
+  VERSION = '1.7.0'.freeze
 
   def gem_version
     Gem::Version.new(VERSION)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spree_stripe
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Vendo Connect Inc., Vendo Sp. z o.o.
@@ -184,6 +184,7 @@ files:
 - app/jobs/spree_stripe/register_domain_job.rb
 - app/jobs/spree_stripe/update_customer_job.rb
 - app/models/spree/payment_sessions/stripe.rb
+- app/models/spree/payment_setup_sessions/stripe.rb
 - app/models/spree_stripe/base.rb
 - app/models/spree_stripe/calculators/stripe_tax.rb
 - app/models/spree_stripe/credit_card_decorator.rb
@@ -191,6 +192,7 @@ files:
 - app/models/spree_stripe/gateway.rb
 - app/models/spree_stripe/gateway/payment_intents.rb
 - app/models/spree_stripe/gateway/payment_sessions.rb
+- app/models/spree_stripe/gateway/payment_setup_sessions.rb
 - app/models/spree_stripe/gateway_customer_decorator.rb
 - app/models/spree_stripe/order_decorator.rb
 - app/models/spree_stripe/payment_decorator.rb
@@ -223,6 +225,8 @@ files:
 - app/services/spree_stripe/create_source.rb
 - app/services/spree_stripe/register_domain.rb
 - app/services/spree_stripe/update_customer.rb
+- app/services/spree_stripe/webhook_handlers/base.rb
+- app/services/spree_stripe/webhook_handlers/payment_intent_amount_capturable_updated.rb
 - app/services/spree_stripe/webhook_handlers/payment_intent_payment_failed.rb
 - app/services/spree_stripe/webhook_handlers/payment_intent_succeeded.rb
 - app/services/spree_stripe/webhook_handlers/setup_intent_succeeded.rb
@@ -284,9 +288,9 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/spree/spree_stripe/issues
-  changelog_uri: https://github.com/spree/spree_stripe/releases/tag/v1.6.0
+  changelog_uri: https://github.com/spree/spree_stripe/releases/tag/v1.7.0
   documentation_uri: https://docs.spreecommerce.org/
-  source_code_uri: https://github.com/spree/spree_stripe/tree/v1.6.0
+  source_code_uri: https://github.com/spree/spree_stripe/tree/v1.7.0
 rdoc_options: []
 require_paths:
 - lib