spree_stripe 1.8.0 → 6.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ec2a5a3cd5e0a0b8e5160018ad055ff16dd27a2eea3e8404e4906e83b9e0758
-  data.tar.gz: b51ad1b1e21337ad780f5e2269c1850b0fd1dfb39ac778db187ae0629c933944
+  metadata.gz: 6b19b020b414085c822cac14eb0e6eb3b9477e00db8133f5922cf442c597cccf
+  data.tar.gz: 7ee74de9899f55a6a6d61a6122c6e6639e5cb9913cd705b7852fe0f11939b6b1
 SHA512:
-  metadata.gz: f3f47966c0982f865f7dfa55074f4df6c2f8c90e2c5bdb656012266eb7c46ed690260b47fab15d7fabf0889fbaef8d22fbd153548d23f4316bcc6cdca4353d64
-  data.tar.gz: 4c9696c085fa47b26f0eb6c6dd06f4b855e0de02dd7ec583efea2c552e8be03c9d9f2952500001357ae04c06e0315a65374846a833d2267a7b6ed89b4b25e325
+  metadata.gz: 2c274dfb225afb9fbd665bed8af493eafbec5a24bfeddf16b3e11f0c075743778ce8cfb52de7e9f034e40f9f6d33d7c349237282946ce016595e0f0e16475dda
+  data.tar.gz: 58d8dc69605f5ddbf228233f114d36f071f79afbf336bb40b6a2d62c77a15b64e096d31ebc7133273863ddea15a65c8da4b6e9bff9672e1967981c49009d1132

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026-present, Vendo Sp. z o.o., Vendo Connect Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,126 +1,63 @@
-<p align="center">
-  <a href="https://spreecommerce.org">
-    <img alt="Spree Commerce x Stripe integration" src="https://vendo-production-res.cloudinary.com/image/upload/w_2000/q_auto/v1742930549/docs/github/Spree_Commerce_open-source_eCommerce_Stripe_payments_integration_-_Github_xlrcn8.jpg">
-  </a>
-
 # Spree Stripe
 
-This is the official Stripe payment gateway extension for [Spree Commerce](https://spreecommerce.org) [open-source eCommerce platform](https://spreecommerce.org/). 
-
-This Stripe integration is bundled in the [Spree Starter](https://github.com/spree/spree_starter/) for your development convenience. 
-
-Or you could follow the [installation instructions](https://spreecommerce.org/docs/integrations/payments/stripe).
-
-If you like what you see, consider giving this repo a GitHub star :star:
-
-Thank you for supporting Spree open-source :heart:
-
-> [!TIP]
-> Looking for a [Stripe Connect integration](#looking-for-a-stripe-connect-integration-for-spree) for Spree? It's available with the [Enterprise Edition](https://spreecommerce.org/spree-commerce-version-comparison-community-edition-vs-enterprise-edition/).
-
-## Features
-
-- Support for quick checkout using Apple Pay, Google Pay, Stripe Link
-- Support for 3D Secure and other security standards
-- Support for off-session payments
-- Support for Storefront API integration (see the API docs [here](https://spreecommerce.org/docs/api-reference/storefront/stripe)).
-- Accept payments in over 130 currencies
-- Accept Credit Cards, Apple Pay, Google Pay, and more
-- Accept SEPA Direct Debit payments
-- Accept iDEAL payments
-- Accept SOFORT payments
-- Accept Bancontact payments
-- Accept Alipay payments
-- Accept WeChat Pay payments
-- Accept Afterpay, Klarna, Affirm, and more
-
-## What's new?
-
-### Installment (BNPL) payments indicator on PDP (Product Detail Page)
-
-![Spree_x_Stripe_-_BNPL_Installment_payments_Product_Card_PDP_Product_Detail_Page](https://vendo-production-res.cloudinary.com/image/upload/w_2000/q_auto/v1742983146/docs/github/Spree_x_Stripe_-_BNPL_Installment_payments_Product_Card_PDP_Product_Detail_Page_amhfkw.jpg)
-
-### Quick payment options on the cart (Apple Pay, Google Pay, Link)
-
-![Apple_Pay_Google_Pay_Link_-_Quick_payment_options_on_the_cart](https://vendo-production-res.cloudinary.com/image/upload/w_2000/q_auto/v1742930027/docs/github/Spree_x_Stripe_-_Apple_Pay_Google_Pay_Link_-_Quick_payment_options_on_the_cart_aw45x9.jpg)
-
-### Quick payments bypassing checkout 1st step (Apple Pay, Google Pay, Link)
-
-![Apple_Pay_Google_Pay_Link_-_Quick_payments_bypassing_checkout](https://vendo-production-res.cloudinary.com/image/upload/w_2000/q_auto/v1742930027/docs/github/Spree_x_Stripe_-_Apple_Pay_Google_Pay_Link_-_Quick_payments_bypassing_checkout_on_Cart_n6gbh6.jpg)
+Official [Stripe](https://stripe.com) payment gateway for
+[Spree Commerce](https://spreecommerce.org), built on Spree's payment session
+API.
 
-### Various payment options on the payment step (cards, BNPL, Apple Pay, Google Pay, Link)
-
-![Quick payments bypassing checkout 1st step (Apple Pay, Google_Pay, Link)](https://vendo-production-res.cloudinary.com/image/upload/w_2000/q_auto/v1742930027/docs/github/Spree_x_Stripe_-_Apple_Pay_Google_Pay_Link_-_Checkout_payment_step_rxxnr9.jpg)
+Supports card payments plus Klarna, Affirm, Afterpay, Alipay, iDEAL, Link,
+SEPA Direct Debit, Przelewy24 and bank transfers, along with Apple Pay and
+Google Pay quick checkout. Customers can save payment methods for later use
+through setup sessions.
 
 ## Installation
 
-1. Add this extension to your Gemfile with this line:
-
-    ```ruby
-    bundle add spree_stripe
-    ```
-
-2. Run the install generator
-
-    ```ruby
-    bundle exec rails g spree_stripe:install
-    ```
-
-3. Restart your server
-
-  If your server was running, restart it so that it can find the assets properly.
-
-  This Stripe integration is also bundled in the [Spree Starter](https://github.com/spree/spree_starter/) for your development convenience.
+Add the gem to your `Gemfile`:
 
-## Developing
+```ruby
+gem 'spree_stripe'
+```
 
-1. Create a dummy app
+Then run `bundle install`. The gateway registers itself — there is nothing to
+generate and no migrations to run.
 
-    ```bash
-    bundle update
-    bundle exec rake test_app
-    ```
+## Configuration
 
-2. Add your new code
-3. Run tests
+Create a Stripe payment method in the admin dashboard and enter your
+publishable and secret keys. Everything else is automatic:
 
-    ```bash
-    bundle exec rspec
-    ```
+- The webhook endpoint is registered with Stripe on save, and its signing
+  secret is stored on the payment method.
+- Your storefront domains are registered with Stripe so Apple Pay and Google
+  Pay can offer themselves at checkout.
 
-When testing your applications integration with this extension you may use it's factories.
-Simply add this require statement to your spec_helper:
+Set `STRIPE_SIGNING_SECRET` to verify webhooks forwarded by the Stripe CLI
+during local development.
 
-```ruby
-require 'spree_stripe/factories'
-```
+## Upgrading from spree_stripe 1.x
 
-## Releasing a new version
+Signing secrets used to live in their own tables. Move them onto the payment
+method with:
 
-```shell
-bundle exec gem bump -p -t
-bundle exec gem release
+```bash
+bundle exec rake spree:upgrade:migrate_stripe_webhook_keys
 ```
 
-For more options please see [gem-release README](https://github.com/svenfuchs/gem-release)
+This runs as part of `rake spree:upgrade`. Until it does, gateways carrying a
+pre-6.0 webhook endpoint will reject incoming webhooks.
 
-## Contributing
+Applications still using the Rails storefront checkout, the legacy
+`stripe_event` webhook path, or Stripe Tax should complete the payment session
+migration before upgrading — those paths ship only in the 1.x series.
 
-If you'd like to contribute, please take a look at the
-[instructions](CONTRIBUTING.md) for installing dependencies and crafting a good
-pull request.
+## Testing
 
-Copyright (c) 2026 [Vendo Connect Inc.](https://getvendo.com), released under [MIT](https://github.com/spree/spree_stripe/blob/main/LICENSE).
+The suite runs offline against recorded VCR cassettes:
 
-## Looking for a Stripe Connect integration for Spree?
-
-Spree Commerce [Enterprise Edition](https://spreecommerce.org/spree-commerce-version-comparison-community-edition-vs-enterprise-edition/) comes with a fully automated Stripe Connect integration for a [multi-vendor marketplace use case](https://spreecommerce.org/marketplace-ecommerce/):
-
-- Automated split payments between marketplace and vendors
-- Support for multiple payment methods including cards and digital wallets
-- Configurable marketplace fees and commission structures
-- Automated payouts to vendors
-- Comprehensive transaction reporting
-- Built-in fraud prevention tools
+```bash
+bundle exec rake test_app   # once
+bundle exec rspec
+```
 
-Feel free to [reach out](https://spreecommerce.org/get-started/) to learn more.
+Set `RECORD_VCR=1` with real Stripe test credentials to record new
+interactions. Note that renaming a `:vcr`-tagged example changes its cassette
+path, so it will re-record rather than reuse the old file.

data/Rakefile

@@ -1,27 +1,15 @@
-require 'bundler'
-Bundler::GemHelper.install_tasks
-
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
 require 'rspec/core/rake_task'
-require 'spree/testing_support/extension_rake'
+require 'spree/testing_support/common_rake'
 
 RSpec::Core::RakeTask.new
 
-task :default do
-  if Dir['spec/dummy'].empty?
-    Rake::Task[:test_app].invoke
-    Dir.chdir('../../')
-  end
-  Rake::Task[:spec].invoke
-end
+task default: :spec
 
-desc 'Generates a dummy app for testing'
+desc "Generates a dummy app for testing"
 task :test_app do
   ENV['LIB_NAME'] = 'spree_stripe'
-  Rake::Task['extension:test_app'].execute(
-    install_storefront: true,
-    install_admin: true
-  )
-  system({ 'BUNDLE_GEMFILE' => File.expand_path('Gemfile', __dir__) }, 'rails g spree_posts:install')
-  system({ 'BUNDLE_GEMFILE' => File.expand_path('Gemfile', __dir__) }, 'rails g spree_legacy_api_v2:install')
-  system({ 'BUNDLE_GEMFILE' => File.expand_path('Gemfile', __dir__) }, 'rails g spree_legacy_product_properties:install')
+  Rake::Task['common:test_app'].invoke
 end

data/app/jobs/spree_stripe/base_job.rb

@@ -1,5 +1,5 @@
 module SpreeStripe
   class BaseJob < Spree::BaseJob
-    queue_as SpreeStripe.queue
+    queue_as { SpreeStripe.queue }
   end
 end

data/app/jobs/spree_stripe/create_webhook_endpoint_job.rb

@@ -1,7 +1,22 @@
 module SpreeStripe
   class CreateWebhookEndpointJob < BaseJob
-    def perform(payment_method_id)
-      Spree::PaymentMethod.find(payment_method_id).create_webhook_endpoint
+    # @param connect [Boolean] true registers the connected-accounts endpoint,
+    #   which a marketplace holds alongside its payment one
+    def perform(payment_method_id, connect: false)
+      # Both endpoints store their credentials in the one serialised
+      # `preferences` column, so concurrent jobs would drop each other's
+      # signing secret. Locked on load because `with_lock` refuses a record
+      # with unsaved changes, and reading a preference populates its default.
+      Spree::PaymentMethod.transaction do
+        payment_method = Spree::PaymentMethod.lock.find_by(id: payment_method_id)
+        next if payment_method.blank?
+
+        if connect
+          payment_method.create_connect_webhook_endpoint
+        else
+          payment_method.create_webhook_endpoint
+        end
+      end
     end
   end
 end

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

@@ -2,7 +2,6 @@ module Spree
   class PaymentSessions::Stripe < PaymentSession
     delegate :api_options, to: :payment_method
 
-    # Duck-type interface consumed by the CompleteOrder and CreatePayment services
     def stripe_id
       external_id
     end
@@ -31,23 +30,58 @@ module Spree
     end
 
     def successful?
-      stripe_payment_intent.status == 'succeeded'
+      payment_method.payment_intent_successful?(stripe_payment_intent)
     end
 
     def charge_not_required?
       payment_method.payment_intent_charge_not_required?(stripe_payment_intent)
     end
 
-    def find_or_create_payment!(metadata = {})
-      return unless persisted?
-      return payment if payment.present?
+    # Warms everything settlement reads from Stripe — the intent, its charge,
+    # and the gateway customer a card source needs — so the webhook path's
+    # locked settlement does no Stripe I/O.
+    def prepare_for_settlement!
+      stripe_charge
+      payment_method.fetch_or_create_customer(order: owner) if owner&.customer
+      self
+    end
+
+    # Core creates the payment; Stripe only says what instrument it was paid
+    # with. The charge and customer are already warmed by
+    # +prepare_for_settlement!+, so this does no Stripe I/O inside the lock.
+    #
+    # @return [Spree::PaymentSource, nil]
+    def payment_source_for_settlement
+      charge = stripe_charge
+
+      if charge.present?
+        SpreeStripe::CreateSource.new(
+          owner: owner,
+          stripe_payment_method_details: charge.payment_method_details,
+          stripe_payment_method_id: charge.payment_method,
+          stripe_billing_details: charge.billing_details,
+          gateway: payment_method
+        ).call
+      elsif charge_not_required?
+        # Bank transfers settle with no charge object, so the instrument has
+        # to come off the intent instead.
+        intent = stripe_payment_intent
+
+        SpreeStripe::CreateSource.new(
+          owner: owner,
+          stripe_payment_method_details: intent.payment_method,
+          stripe_payment_method_id: intent.payment_method.id,
+          stripe_billing_details: nil,
+          gateway: payment_method
+        ).call
+      end
+    end
 
-      SpreeStripe::CreatePayment.new(
-        order: order,
-        payment_intent: self,
-        gateway: payment_method,
-        amount: amount
-      ).call
+    # Keeps the charge reference alongside whatever the caller passed.
+    def apply_settlement_metadata(payment, metadata)
+      super
+      charge = stripe_charge
+      payment.metadata['stripe_charge_id'] = charge.id if charge.present?
     end
   end
 end