spree-paypal_platform 5.0.1 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a661dd4e40e71d2cba0a11105489d4eecce8bbc75936fc8213ce3508903ea8b2
-  data.tar.gz: 3323ef46afcd1734d213c672f743ee6d1f7e4eb7580a6d5facfb034bb252001d
+  metadata.gz: 3002d47c7c53f6eb690a9dbd4717e47983e47083feac8a359369378c8435d24f
+  data.tar.gz: 5b4e7e078632cd6dc4e7e2796edc696bc543c4cfd7360b3a721064fc2114b62e
 SHA512:
-  metadata.gz: f050fe6366417de127b12e0d3f1ef4cce790b79a985d1fb16ff7d27486dfb3fbdb97badb6fee18caa0ccf022dc8d54b51c5e1a6bc959fb981dc3558acf4ee933
-  data.tar.gz: 81552556697e34abd82667c5ca6950a147d674f47a0c3ce96b698788ebee690624a8941130a1586adda3c34cc434825f71e05e5cbff31e4e9f38667db860d067
+  metadata.gz: 0c8a5d07fa468eb3a275844b667ac07be8c8d5dd5878518ceb649fe0743a977a3b7b00335cb6cb885bc2d90c0d86695bbbdf3cee9eb34d0303fe2eddaeb9901e
+  data.tar.gz: a45636029c6e2888067299a8e9900f533ca6959eb79d005ca8e44187de359ca42af68d350ccbc39fa890bb285b179694479ca4812bbc795d9b3427fae6be68d8

data/CHANGELOG.md

@@ -2,16 +2,28 @@
 
 All notable changes to this project are documented in this file.
 
+## 5.1.0
+
+Full internal rename to `Spree::PaypalPlatform`.
+
+- Require path is `spree/paypal_platform`. There is no `spree/paypal_checkout`
+  require and no `Spree::PaypalCheckout` constant.
+- Engine name, table prefix, payment-session STI, admin partials, and
+  `method_type` are all `spree_paypal_platform`.
+- Migration renames `spree_paypal_checkout_orders` →
+  `spree_paypal_platform_orders` and rewrites remaining STI type strings.
+- Install generator: `bin/rails g spree:paypal_platform:install`.
+
 ## 5.0.1
 
 Published name is **`spree-paypal_platform`**. RubyGems rejected
-`spree-paypal_checkout` as too similar to the official
-`spree_paypal_checkout`. Require path and constants are unchanged
-(`spree/paypal_checkout` → `Spree::PaypalCheckout`).
+`spree-paypal_platform` as too similar to the official
+`spree_paypal_platform`. Require path and constants are unchanged
+(`spree/paypal_platform` → `Spree::PaypalPlatform`).
 
 ## 5.0.0
 
-First Aypex release. Intended published name `spree-paypal_checkout` was
+First Aypex release. Intended published name `spree-paypal_platform` was
 never accepted by RubyGems; see 5.0.1.
 
 ### Audit follow-up
@@ -20,11 +32,11 @@ never accepted by RubyGems; see 5.0.1.
 - Webhook verify now checks HTTP status and is specced for signed and unsigned paths.
 - `#authorize` raises `NotImplementedError`.
 - `#void` / `#credit` / `#cancel` specs restored; `CaptureOrder` no longer uses the `money` gem.
-- Unique index on `spree_paypal_checkout_orders.paypal_id`.
+- Unique index on `spree_paypal_platform_orders.paypal_id`.
 - Payment sources share `#display_payment_info`; OAuth/token HTTP responses must be 2xx.
 
-- Port of the `aypex-io/spree_paypal_checkout` `tongkat-fitness` fork into
-  `Spree::PaypalCheckout`, published as `spree-paypal_checkout`.
+- Port of the `aypex-io/spree_paypal_platform` `tongkat-fitness` fork into
+  `Spree::PaypalPlatform`, published as `spree-paypal_platform`.
 - Store API v3 payment sessions only. No `/api/v2/storefront/paypal_orders`.
 - Official `paypal-server-sdk` `~> 2.3`.
 - Apple Pay and Card Fields recorded as payment sources on the same gateway.

data/README.md

@@ -3,22 +3,19 @@
 PayPal Checkout for Spree 5.6+, as a single payment method covering the PayPal
 wallet, Apple Pay, and Card Fields.
 
-This is Aypex's own gem, **published as `spree-paypal_platform`**. It is **not**
-the official `spree_paypal_checkout` gem. RubyGems treats `-` and `_` as the
-same name, so `spree-paypal_checkout` was rejected as too similar. The GitHub
-repo is `aypex-io/spree-paypal_platform`; `require "spree/paypal_checkout"`
-and `Spree::PaypalCheckout` are unchanged.
+Published gem: **`spree-paypal_platform`**  
+Require: **`spree/paypal_platform`**  
+Constant: **`Spree::PaypalPlatform`**
 
-It started from that official extension (including the VAT `AMOUNT_MISMATCH`
-fix and storefront-owned address) and adds Apple Pay as a funding source of
-the same gateway.
+This is not the official `spree_paypal_checkout` gem. It started from that
+extension (VAT `AMOUNT_MISMATCH` guard, storefront-owned address) and adds
+Apple Pay as a funding source of the same gateway.
 
 ## What it is
 
-- One `Spree::PaypalCheckout::Gateway` payment method.
+- One `Spree::PaypalPlatform::Gateway` payment method.
 - Checkout goes through Spree's **Store API v3 payment sessions**
-  (`POST /api/v3/store/carts/:id/payment_sessions` → complete). There is no
-  legacy `/api/v2/storefront/paypal_orders` controller.
+  (`POST /api/v3/store/carts/:id/payment_sessions` → complete).
 - The storefront owns the address. The gem pins it with
   `SET_PROVIDED_ADDRESS` so PayPal does not re-collect it.
 - Amount breakdown sends **only `additional_tax_total`**. Sending full
@@ -27,9 +24,8 @@ the same gateway.
   [`paypal-server-sdk`](https://github.com/paypal/PayPal-Ruby-Server-SDK) gem
   (`~> 2.3`).
 
-Apple Pay is **not** a second payment method and **not** a Spree Integration.
-It is a `payment_source.apple_pay` on the same Checkout order. Extra PayPal
-wallets (Venmo, Google Pay, …) should follow the same pattern.
+Apple Pay is not a second payment method and not a Spree Integration. It is
+a `payment_source.apple_pay` on the same Checkout order.
 
 ## Installation
 
@@ -39,7 +35,7 @@ gem 'spree-paypal_platform'
 
 ```bash
 bundle install
-bin/rails g spree:paypal_checkout:install
+bin/rails g spree:paypal_platform:install
 ```
 
 The generator copies the migrations. Pass `--auto-run-migrations` to skip the
@@ -67,27 +63,20 @@ https://<store>/api/v3/webhooks/payments/<prefixed-payment-method-id>
 2. Register every storefront domain (and subdomain) that will show the button
    in the [PayPal Apple Pay domain
    registration](https://developer.paypal.com/docs/checkout/apm/apple-pay/)
-   dashboard. Unregistered domains are rejected by Apple.
+   dashboard.
 3. Headless storefronts load the PayPal JS SDK with `components=applepay`
-   (or `buttons,applepay,card-fields`) and render Apple's `ApplePaySession`.
-   The gem records the captured `payment_source.apple_pay` as
-   `Spree::PaypalCheckout::PaymentSources::ApplePay`.
-4. Safari + HTTPS only. `localhost` will not work; use a public HTTPS tunnel
-   for local testing.
-
-This gem does not ship a Next.js / Stimulus Apple Pay button. The TKF
-storefront already owns the wallet and Card Fields UI; Apple Pay belongs
-there, next to `FUNDING.PAYPAL`.
+   and render Apple's `ApplePaySession`. The gem records
+   `payment_source.apple_pay` as
+   `Spree::PaypalPlatform::PaymentSources::ApplePay`.
+4. Safari + HTTPS only.
 
 ## Coming from `spree_paypal_checkout`
 
-Existing `spree_payment_methods.type` rows store
-`SpreePaypalCheckout::Gateway`. This gem aliases that constant, so checkout
-keeps working before you migrate. The install generator also copies a
-rewrite migration that updates those STI strings to
-`Spree::PaypalCheckout::Gateway`.
-
-Replace the GitHub pin:
+Existing `spree_payment_methods.type` rows may still store
+`SpreePaypalCheckout::Gateway` or `Spree::PaypalCheckout::Gateway`. The
+install generator copies a rewrite migration that updates those STI strings
+to `Spree::PaypalPlatform::Gateway` and renames
+`spree_paypal_checkout_orders` → `spree_paypal_platform_orders`.
 
 ```ruby
 # before
@@ -97,11 +86,9 @@ gem 'spree_paypal_checkout', github: 'aypex-io/spree_paypal_checkout', branch: '
 gem 'spree-paypal_platform'
 ```
 
-Then run the install generator and bump the storefront's
-`resolveGatewayId` map if it still keys on `paypal_checkout` /
-`SpreePaypalCheckout::Gateway` — both still resolve if you keep the old
-keys, because the gateway's `api_type` becomes `paypal_checkout` either way
-(`Spree::PaypalCheckout::Gateway` → `paypal_checkout`).
+Storefront `resolveGatewayId` should map `paypal_platform` /
+`Spree::PaypalPlatform::Gateway`. Keep the old `paypal_checkout` /
+`SpreePaypalCheckout::Gateway` keys until the STI rewrite has run.
 
 ## Developing
 

data/Rakefile

@@ -21,7 +21,7 @@ task :test_app do
   # Must be the require path, not the gem name: spree_core's common:test_app
   # does a literal `require ENV['LIB_NAME']` and constantizes
   # "#{LIB_NAME.camelize}::Generators::InstallGenerator".
-  ENV['LIB_NAME'] = 'spree/paypal_checkout'
+  ENV['LIB_NAME'] = 'spree/paypal_platform'
   ENV['DB'] ||= 'postgres'
   Rake::Task['extension:test_app'].execute(install_storefront: true, install_admin: true)
 end

data/app/models/spree/payment_sessions/{paypal_checkout.rb → paypal_platform.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Spree
-  class PaymentSessions::PaypalCheckout < PaymentSession
+  class PaymentSessions::PaypalPlatform < PaymentSession
     ##
     # @return [String]
     #
@@ -84,7 +84,7 @@ module Spree
     def create_payment_source!
       return nil if paypal_payment_source.blank?
 
-      Spree::PaypalCheckout::CreateSource.new(
+      Spree::PaypalPlatform::CreateSource.new(
         paypal_payment_source: paypal_payment_source,
         gateway: payment_method,
         order: order

data/app/models/spree/{paypal_checkout → paypal_platform}/base.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
 module Spree
-  module PaypalCheckout
+  module PaypalPlatform
     ##
     # Abstract ActiveRecord base for this gem's persisted models.
     #
-    # Table names resolve through {Spree::PaypalCheckout.table_name_prefix}.
+    # Table names resolve through {Spree::PaypalPlatform.table_name_prefix}.
     #
     class Base < ::Spree.base_class
       self.abstract_class = true

data/app/models/spree/{paypal_checkout → paypal_platform}/gateway/payment_sessions.rb

@@ -3,7 +3,7 @@
 require 'net/http'
 
 module Spree
-  module PaypalCheckout
+  module PaypalPlatform
     class Gateway < ::Spree::Gateway
       ##
       # Payment-session lifecycle used by Spree 5 storefronts.
@@ -22,7 +22,7 @@ module Spree
         # @return [Class]
         #
         def payment_session_class
-          Spree::PaymentSessions::PaypalCheckout
+          Spree::PaymentSessions::PaypalPlatform
         end
 
         ##
@@ -34,7 +34,7 @@ module Spree
         # @param order [Spree::Order]
         # @param amount [Numeric, NilClass]
         # @param external_data [Hash]
-        # @return [Spree::PaymentSessions::PaypalCheckout, NilClass]
+        # @return [Spree::PaymentSessions::PaypalPlatform, NilClass]
         #
         def create_payment_session(order:, amount: nil, **_unused)
           total = amount.presence || order.total_minus_store_credits
@@ -64,7 +64,7 @@ module Spree
         end
 
         ##
-        # @param payment_session [Spree::PaymentSessions::PaypalCheckout]
+        # @param payment_session [Spree::PaymentSessions::PaypalPlatform]
         # @param amount [Numeric, NilClass]
         # @param external_data [Hash]
         # @return [TrueClass, FalseClass, NilClass]
@@ -83,7 +83,7 @@ module Spree
         #
         # Does not complete the order — that is handled by Carts::Complete.
         #
-        # @param payment_session [Spree::PaymentSessions::PaypalCheckout]
+        # @param payment_session [Spree::PaymentSessions::PaypalPlatform]
         # @param params [Hash]
         # @return [void]
         #
@@ -137,7 +137,7 @@ module Spree
           paypal_order_id = extract_order_id_from_webhook(event_type, resource)
           return nil unless paypal_order_id
 
-          payment_session = Spree::PaymentSessions::PaypalCheckout.find_by(
+          payment_session = Spree::PaymentSessions::PaypalPlatform.find_by(
             payment_method: self,
             external_id: paypal_order_id
           )

data/app/models/spree/{paypal_checkout → paypal_platform}/gateway.rb

@@ -3,7 +3,7 @@
 require 'net/http'
 
 module Spree
-  module PaypalCheckout
+  module PaypalPlatform
     ##
     # PayPal Checkout payment method.
     #
@@ -63,7 +63,7 @@ module Spree
       # @return [String]
       #
       def method_type
-        'spree_paypal_checkout'
+        'spree_paypal_platform'
       end
 
       ##
@@ -77,21 +77,21 @@ module Spree
       # @return [String]
       #
       def description_partial_name
-        'spree_paypal_checkout'
+        'spree_paypal_platform'
       end
 
       ##
       # @return [String]
       #
       def configuration_guide_partial_name
-        'spree_paypal_checkout'
+        'spree_paypal_platform'
       end
 
       ##
       # @return [String]
       #
       def source_partial_name
-        'paypal_checkout'
+        'paypal_platform'
       end
 
       ##

data/app/models/spree/{paypal_checkout → paypal_platform}/order.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Spree
-  module PaypalCheckout
+  module PaypalPlatform
     ##
     # A persisted PayPal Orders API response, used by the legacy
     # `/api/v2/storefront/paypal_orders` flow.
@@ -45,7 +45,7 @@ module Spree
       ##
       # Capture the PayPal order via the Orders API.
       #
-      # @return [Spree::PaypalCheckout::Order]
+      # @return [Spree::PaypalPlatform::Order]
       # @raise [AlreadyCapturedError] when already COMPLETED
       #
       def capture!

data/app/models/spree/{paypal_checkout → paypal_platform}/order_decorator.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Spree
-  module PaypalCheckout
+  module PaypalPlatform
     ##
     # Adds the legacy PayPal-order association onto {Spree::Order}.
     #
@@ -12,8 +12,8 @@ module Spree
       #
       def self.prepended(base)
         base.store_accessor :private_metadata, :paypal_id
-        base.has_many :paypal_checkout_orders,
-                      class_name: 'Spree::PaypalCheckout::Order',
+        base.has_many :paypal_platform_orders,
+                      class_name: 'Spree::PaypalPlatform::Order',
                       dependent: :destroy,
                       foreign_key: :order_id
       end
@@ -21,4 +21,4 @@ module Spree
   end
 end
 
-Spree::Order.prepend(Spree::PaypalCheckout::OrderDecorator)
+Spree::Order.prepend(Spree::PaypalPlatform::OrderDecorator)

data/app/models/spree/paypal_platform/payment_method_decorator.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Spree
+  module PaypalPlatform
+    ##
+    # Adds a paypal_platform scope and predicate onto {Spree::PaymentMethod}.
+    #
+    module PaymentMethodDecorator
+      ##
+      # @param base [Class]
+      # @return [void]
+      #
+      def self.prepended(base)
+        base.scope :paypal_platform, lambda {
+          where(type: Spree::PaypalPlatform.gateway_type_names)
+        }
+      end
+
+      ##
+      # @return [TrueClass, FalseClass]
+      #
+      def paypal_platform?
+        Spree::PaypalPlatform.gateway_type_names.include?(type)
+      end
+    end
+  end
+end
+
+Spree::PaymentMethod.prepend(Spree::PaypalPlatform::PaymentMethodDecorator)

data/app/models/spree/{paypal_checkout → paypal_platform}/payment_sources/apple_pay.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Spree
-  module PaypalCheckout
+  module PaypalPlatform
     module PaymentSources
       ##
       # An Apple Pay wallet used through PayPal Checkout.

data/app/models/spree/{paypal_checkout → paypal_platform}/payment_sources/card.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Spree
-  module PaypalCheckout
+  module PaypalPlatform
     module PaymentSources
       ##
       # An Advanced Credit and Debit Card (Card Fields) payment.

data/app/models/spree/{paypal_checkout → paypal_platform}/payment_sources/paypal.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Spree
-  module PaypalCheckout
+  module PaypalPlatform
     module PaymentSources
       ##
       # A PayPal wallet account captured as a Spree payment source.

data/app/models/spree/paypal_platform/store_decorator.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Spree
+  module PaypalPlatform
+    ##
+    # Looks up the store's active PayPal Checkout gateway.
+    #
+    module StoreDecorator
+      ##
+      # @return [Spree::PaypalPlatform::Gateway, NilClass]
+      #
+      def paypal_platform_gateway
+        @paypal_platform_gateway ||= payment_methods.paypal_platform.active.last
+      end
+    end
+  end
+end
+
+Spree::Store.prepend(Spree::PaypalPlatform::StoreDecorator)

data/app/presenters/spree/{paypal_checkout → paypal_platform}/order_presenter.rb

@@ -3,7 +3,7 @@
 require 'paypal_server_sdk'
 
 module Spree
-  module PaypalCheckout
+  module PaypalPlatform
     ##
     # Builds a PayPal Orders API create-order payload from a Spree order.
     #

data/app/services/spree/{paypal_checkout → paypal_platform}/capture_order.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
 module Spree
-  module PaypalCheckout
+  module PaypalPlatform
     ##
     # Captures a legacy {Order} via the PayPal Orders API and completes
     # the Spree checkout.
     #
     class CaptureOrder
       ##
-      # @param paypal_order [Spree::PaypalCheckout::Order]
+      # @param paypal_order [Spree::PaypalPlatform::Order]
       #
       def initialize(paypal_order:)
         @paypal_order = paypal_order
@@ -20,7 +20,7 @@ module Spree
       attr_reader :paypal_order, :order, :gateway, :amount
 
       ##
-      # @return [Spree::PaypalCheckout::Order]
+      # @return [Spree::PaypalPlatform::Order]
       #
       def call
         return paypal_order if order.completed? || order.canceled?

data/app/services/spree/{paypal_checkout → paypal_platform}/create_payment.rb

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
 module Spree
-  module PaypalCheckout
+  module PaypalPlatform
     ##
     # Creates the Spree::Payment for a captured legacy PayPal order.
     #
     class CreatePayment
       ##
-      # @param paypal_order [Spree::PaypalCheckout::Order]
+      # @param paypal_order [Spree::PaypalPlatform::Order]
       # @param order [Spree::Order, NilClass]
-      # @param gateway [Spree::PaypalCheckout::Gateway, NilClass]
+      # @param gateway [Spree::PaypalPlatform::Gateway, NilClass]
       # @param amount [Numeric, NilClass]
       #
       def initialize(paypal_order:, order: nil, gateway: nil, amount: nil)

data/app/services/spree/{paypal_checkout → paypal_platform}/create_source.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Spree
-  module PaypalCheckout
+  module PaypalPlatform
     ##
     # Builds a {PaymentSources} record from a PayPal Orders `payment_source`.
     #
@@ -11,7 +11,7 @@ module Spree
     class CreateSource
       ##
       # @param paypal_payment_source [Hash]
-      # @param gateway [Spree::PaypalCheckout::Gateway]
+      # @param gateway [Spree::PaypalPlatform::Gateway]
       # @param order [Spree::Order, NilClass]
       # @param user [Spree::User, NilClass]
       #

data/config/initializers/spree.rb

@@ -4,5 +4,5 @@
 # config.spree.payment_methods in its own after_initialize, and a
 # file-scope registration here would be silently clobbered.
 Rails.application.config.after_initialize do
-  Rails.application.config.spree.payment_methods << Spree::PaypalCheckout::Gateway
+  Rails.application.config.spree.payment_methods << Spree::PaypalPlatform::Gateway
 end

data/db/migrate/20250528095719_create_spree_paypal_checkout_orders.rb

@@ -17,6 +17,6 @@ class CreateSpreePaypalCheckoutOrders < ActiveRecord::Migration[7.2]
       t.timestamps
     end
 
-    add_index :spree_paypal_checkout_orders, [:order_id, :paypal_id], unique: true
+    add_index :spree_paypal_checkout_orders, %i[order_id paypal_id], unique: true
   end
 end

data/db/migrate/20260817120000_rewrite_spree_paypal_checkout_sti_types.rb

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
 class RewriteSpreePaypalCheckoutStiTypes < ActiveRecord::Migration[7.2]
-  # Hosts coming from the official / forked `spree_paypal_checkout` gem store
+  # Hosts coming from the official / forked `spree_paypal_platform` gem store
   # `SpreePaypalCheckout::Gateway` (and `…::PaymentSources::Paypal`) in STI
   # type columns. The new gem aliases those constants, so checkout keeps
   # working before this migration runs; rewriting the strings makes the
   # alias optional for the next deploy.
   LEGACY_TO_CURRENT = {
-    'SpreePaypalCheckout::Gateway' => 'Spree::PaypalCheckout::Gateway',
-    'SpreePaypalCheckout::PaymentSources::Paypal' => 'Spree::PaypalCheckout::PaymentSources::Paypal',
-    'SpreePaypalCheckout::Order' => 'Spree::PaypalCheckout::Order'
+    'SpreePaypalCheckout::Gateway' => 'Spree::PaypalPlatform::Gateway',
+    'SpreePaypalCheckout::PaymentSources::Paypal' => 'Spree::PaypalPlatform::PaymentSources::Paypal',
+    'SpreePaypalCheckout::Order' => 'Spree::PaypalPlatform::Order'
   }.freeze
 
   def up

data/db/migrate/20260817140000_rename_paypal_checkout_orders_to_paypal_platform.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+class RenamePaypalCheckoutOrdersToPaypalPlatform < ActiveRecord::Migration[7.2]
+  LEGACY_TO_CURRENT = {
+    'SpreePaypalCheckout::Gateway' => 'Spree::PaypalPlatform::Gateway',
+    'SpreePaypalCheckout::PaymentSources::Paypal' => 'Spree::PaypalPlatform::PaymentSources::Paypal',
+    'SpreePaypalCheckout::Order' => 'Spree::PaypalPlatform::Order',
+    'Spree::PaypalCheckout::Gateway' => 'Spree::PaypalPlatform::Gateway',
+    'Spree::PaypalCheckout::PaymentSources::Paypal' => 'Spree::PaypalPlatform::PaymentSources::Paypal',
+    'Spree::PaypalCheckout::PaymentSources::ApplePay' => 'Spree::PaypalPlatform::PaymentSources::ApplePay',
+    'Spree::PaypalCheckout::PaymentSources::Card' => 'Spree::PaypalPlatform::PaymentSources::Card',
+    'Spree::PaypalCheckout::Order' => 'Spree::PaypalPlatform::Order'
+  }.freeze
+
+  def up
+    if table_exists?(:spree_paypal_checkout_orders) && !table_exists?(:spree_paypal_platform_orders)
+      rename_table :spree_paypal_checkout_orders, :spree_paypal_platform_orders
+    end
+
+    rewrite_column(:spree_payment_methods, :type)
+    rewrite_column(:spree_payment_sources, :type) if column_exists?(:spree_payment_sources, :type)
+  end
+
+  def down
+    if table_exists?(:spree_paypal_platform_orders) && !table_exists?(:spree_paypal_checkout_orders)
+      rename_table :spree_paypal_platform_orders, :spree_paypal_checkout_orders
+    end
+
+    rewrite_column(:spree_payment_methods, :type, invert_mapping)
+    rewrite_column(:spree_payment_sources, :type, invert_mapping) if column_exists?(:spree_payment_sources, :type)
+  end
+
+  private
+
+  def invert_mapping
+    {
+      'Spree::PaypalPlatform::Gateway' => 'SpreePaypalCheckout::Gateway',
+      'Spree::PaypalPlatform::PaymentSources::Paypal' => 'SpreePaypalCheckout::PaymentSources::Paypal',
+      'Spree::PaypalPlatform::Order' => 'SpreePaypalCheckout::Order'
+    }
+  end
+
+  def rewrite_column(table, column, mapping = LEGACY_TO_CURRENT)
+    mapping.each do |from, to|
+      execute "UPDATE #{table} SET #{column} = #{quote(to)} WHERE #{column} = #{quote(from)}"
+    end
+  end
+end

data/lib/generators/spree/{paypal_checkout → paypal_platform}/install/install_generator.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
 module Spree
-  module PaypalCheckout
+  module PaypalPlatform
     module Generators
       ##
       # Copies this gem's migrations into the host app and optionally runs them.
       #
       class InstallGenerator < Rails::Generators::Base
-        desc 'Copies Spree::PaypalCheckout migrations into the host application and runs them.'
+        desc 'Copies Spree::PaypalPlatform migrations into the host application and runs them.'
 
         class_option :auto_run_migrations,
                      type: :boolean,
@@ -15,7 +15,7 @@ module Spree
                      desc: 'Run the copied migrations immediately instead of asking'
 
         def copy_migrations
-          rake 'spree_paypal_checkout:install:migrations'
+          rake 'spree_paypal_platform:install:migrations'
         end
 
         def run_migrations

data/lib/spree/{paypal_checkout → paypal_platform}/engine.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Spree
-  module PaypalCheckout
+  module PaypalPlatform
     ##
     # Rails engine for the PayPal Checkout payment method.
     #
@@ -10,7 +10,7 @@ module Spree
       isolate_namespace Spree
 
       # Decorators reopen existing constants, so Zeitwerk must not autoload them.
-      initializer 'spree_paypal_checkout.ignore_decorators_from_zeitwerk', before: :setup_main_autoloader do
+      initializer 'spree_paypal_platform.ignore_decorators_from_zeitwerk', before: :setup_main_autoloader do
         Rails.autoloaders.main.ignore(
           File.join(File.dirname(__FILE__), '../../../app/**/*_decorator*.rb')
         )
@@ -18,7 +18,7 @@ module Spree
 
       # engine_name generates route-helper prefixes and must be a valid Ruby
       # identifier, so it cannot contain a dash.
-      engine_name 'spree_paypal_checkout'
+      engine_name 'spree_paypal_platform'
 
       config.generators do |g|
         g.test_framework :rspec

data/lib/spree/{paypal_checkout → paypal_platform}/factories.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 FactoryBot.define do
-  factory :paypal_checkout_gateway, class: 'Spree::PaypalCheckout::Gateway' do
+  factory :paypal_platform_gateway, class: 'Spree::PaypalPlatform::Gateway' do
     name { 'PayPal Checkout' }
     association :store, factory: :store
     preferences do
@@ -14,46 +14,46 @@ FactoryBot.define do
     end
   end
 
-  factory :paypal_checkout_payment_source, class: 'Spree::PaypalCheckout::PaymentSources::Paypal' do
-    association :payment_method, factory: :paypal_checkout_gateway
+  factory :paypal_platform_payment_source, class: 'Spree::PaypalPlatform::PaymentSources::Paypal' do
+    association :payment_method, factory: :paypal_platform_gateway
     gateway_payment_profile_id { 'PAY-CUSTOMER-ID' }
   end
 
-  factory :paypal_checkout_apple_pay_source, class: 'Spree::PaypalCheckout::PaymentSources::ApplePay' do
-    association :payment_method, factory: :paypal_checkout_gateway
+  factory :paypal_platform_apple_pay_source, class: 'Spree::PaypalPlatform::PaymentSources::ApplePay' do
+    association :payment_method, factory: :paypal_platform_gateway
     gateway_payment_profile_id { 'APPLEPAY-TOKEN-1' }
     card_brand { 'VISA' }
     last_digits { '4242' }
   end
 
-  factory :paypal_checkout_payment_session, class: 'Spree::PaymentSessions::PaypalCheckout' do
+  factory :paypal_platform_payment_session, class: 'Spree::PaymentSessions::PaypalPlatform' do
     association :order, factory: :order
-    association :payment_method, factory: :paypal_checkout_gateway
+    association :payment_method, factory: :paypal_platform_gateway
     amount { order.total }
     currency { order.currency }
     status { 'pending' }
     external_id { "PAYPAL-ORDER-#{SecureRandom.hex(8).upcase}" }
     external_data do
-      JSON.parse(File.read(Spree::PaypalCheckout::Engine.root.join('spec/fixtures/paypal_order.json')))
+      JSON.parse(File.read(Spree::PaypalPlatform::Engine.root.join('spec/fixtures/paypal_order.json')))
     end
 
-    factory :completed_paypal_checkout_payment_session do
+    factory :completed_paypal_platform_payment_session do
       status { 'completed' }
       external_data do
-        JSON.parse(File.read(Spree::PaypalCheckout::Engine.root.join('spec/fixtures/captured_paypal_order.json')))
+        JSON.parse(File.read(Spree::PaypalPlatform::Engine.root.join('spec/fixtures/captured_paypal_order.json')))
       end
     end
   end
 
-  factory :paypal_checkout_order, class: 'Spree::PaypalCheckout::Order' do
+  factory :paypal_platform_order, class: 'Spree::PaypalPlatform::Order' do
     paypal_id { 'PAY-ORDER-ID' }
     order { create(:order) }
-    payment_method { create(:paypal_checkout_gateway) }
+    payment_method { create(:paypal_platform_gateway) }
     amount { order.total }
-    data { JSON.parse(File.read(Spree::PaypalCheckout::Engine.root.join('spec/fixtures/paypal_order.json'))) }
+    data { JSON.parse(File.read(Spree::PaypalPlatform::Engine.root.join('spec/fixtures/paypal_order.json'))) }
 
-    factory :captured_paypal_checkout_order do
-      data { JSON.parse(File.read(Spree::PaypalCheckout::Engine.root.join('spec/fixtures/captured_paypal_order.json'))) }
+    factory :captured_paypal_platform_order do
+      data { JSON.parse(File.read(Spree::PaypalPlatform::Engine.root.join('spec/fixtures/captured_paypal_order.json'))) }
     end
   end
 end

data/lib/spree/{paypal_checkout → paypal_platform}/version.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 module Spree
-  module PaypalCheckout
+  module PaypalPlatform
     # Major version tracks Spree's major version: 5.x supports Spree 5.x.
-    VERSION = '5.0.1'
+    VERSION = '5.1.0'
   end
 end

data/lib/spree/paypal_platform.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'spree_core'
+require 'paypal_server_sdk'
+require 'spree/paypal_platform/version'
+require 'spree/paypal_platform/engine'
+
+module Spree
+  module PaypalPlatform
+    ##
+    # Table prefix for models nested under this module.
+    #
+    # Must live on the module, not on {Base}. ActiveRecord walks
+    # `module_parents` for `table_name_prefix` and finds `Spree` first
+    # (`"spree_"`) unless this closer parent defines it.
+    #
+    # @return [String]
+    #
+    def self.table_name_prefix
+      'spree_paypal_platform_'
+    end
+
+    ##
+    # STI type names that count as this gem's gateway.
+    #
+    # Includes historical strings from the official `spree_paypal_checkout`
+    # gem and the short-lived `Spree::PaypalCheckout` name so existing
+    # payment-method rows keep matching before the rewrite migration runs.
+    #
+    # @return [Array<String>]
+    #
+    def self.gateway_type_names
+      (
+        [
+          Gateway.name,
+          'Spree::PaypalCheckout::Gateway',
+          'SpreePaypalCheckout::Gateway'
+        ] + Gateway.descendants.map(&:name)
+      ).uniq
+    end
+  end
+end

data/lib/spree-paypal_platform.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 # Bundler auto-requires a gem by its *name*, so `gem "spree-paypal_platform"`
-# in a host Gemfile issues `require "spree-paypal_platform"`. The real entry
-# point is `spree/paypal_checkout` (matching the Spree::PaypalCheckout
-# namespace), so this shim keeps the default `Bundler.require` working.
-require 'spree/paypal_checkout'
+# issues `require "spree-paypal_platform"`. The real entry point is
+# `spree/paypal_platform` (matching Spree::PaypalPlatform).
+require 'spree/paypal_platform'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spree-paypal_platform
 version: !ruby/object:Gem::Version
-  version: 5.0.1
+  version: 5.1.0
 platform: ruby
 authors:
 - Aypex
@@ -109,8 +109,7 @@ dependencies:
         version: '0'
 description: A Spree 5.6+ payment method for PayPal Checkout. Creates and captures
   PayPal Orders via payment sessions, pins the storefront address, and records PayPal
-  wallet, Apple Pay, and card sources. Published as spree-paypal_platform because
-  RubyGems rejects names too similar to the official spree_paypal_checkout gem.
+  wallet, Apple Pay, and card sources.
 email: hello@aypex.io
 executables: []
 extensions: []
@@ -120,36 +119,36 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- app/models/spree/payment_sessions/paypal_checkout.rb
-- app/models/spree/paypal_checkout/base.rb
-- app/models/spree/paypal_checkout/gateway.rb
-- app/models/spree/paypal_checkout/gateway/payment_sessions.rb
-- app/models/spree/paypal_checkout/order.rb
-- app/models/spree/paypal_checkout/order_decorator.rb
-- app/models/spree/paypal_checkout/payment_method_decorator.rb
-- app/models/spree/paypal_checkout/payment_sources/apple_pay.rb
-- app/models/spree/paypal_checkout/payment_sources/card.rb
-- app/models/spree/paypal_checkout/payment_sources/paypal.rb
-- app/models/spree/paypal_checkout/store_decorator.rb
-- app/presenters/spree/paypal_checkout/order_presenter.rb
-- app/services/spree/paypal_checkout/capture_order.rb
-- app/services/spree/paypal_checkout/create_payment.rb
-- app/services/spree/paypal_checkout/create_source.rb
-- app/views/spree/admin/payment_methods/configuration_guides/_spree_paypal_checkout.html.erb
-- app/views/spree/admin/payment_methods/descriptions/_spree_paypal_checkout.html.erb
-- app/views/spree/admin/payments/source_forms/_spree_paypal_checkout.html.erb
-- app/views/spree/payment_sources/_paypal_checkout.html.erb
+- app/models/spree/payment_sessions/paypal_platform.rb
+- app/models/spree/paypal_platform/base.rb
+- app/models/spree/paypal_platform/gateway.rb
+- app/models/spree/paypal_platform/gateway/payment_sessions.rb
+- app/models/spree/paypal_platform/order.rb
+- app/models/spree/paypal_platform/order_decorator.rb
+- app/models/spree/paypal_platform/payment_method_decorator.rb
+- app/models/spree/paypal_platform/payment_sources/apple_pay.rb
+- app/models/spree/paypal_platform/payment_sources/card.rb
+- app/models/spree/paypal_platform/payment_sources/paypal.rb
+- app/models/spree/paypal_platform/store_decorator.rb
+- app/presenters/spree/paypal_platform/order_presenter.rb
+- app/services/spree/paypal_platform/capture_order.rb
+- app/services/spree/paypal_platform/create_payment.rb
+- app/services/spree/paypal_platform/create_source.rb
+- app/views/spree/admin/payment_methods/configuration_guides/_spree_paypal_platform.html.erb
+- app/views/spree/admin/payment_methods/descriptions/_spree_paypal_platform.html.erb
+- app/views/spree/admin/payments/source_forms/_spree_paypal_platform.html.erb
+- app/views/spree/payment_sources/_paypal_platform.html.erb
 - config/initializers/spree.rb
 - db/migrate/20250528095719_create_spree_paypal_checkout_orders.rb
 - db/migrate/20260817120000_rewrite_spree_paypal_checkout_sti_types.rb
 - db/migrate/20260817130000_add_unique_index_on_paypal_checkout_order_paypal_id.rb
-- lib/generators/spree/paypal_checkout/install/install_generator.rb
-- lib/spree-paypal_checkout.rb
+- db/migrate/20260817140000_rename_paypal_checkout_orders_to_paypal_platform.rb
+- lib/generators/spree/paypal_platform/install/install_generator.rb
 - lib/spree-paypal_platform.rb
-- lib/spree/paypal_checkout.rb
-- lib/spree/paypal_checkout/engine.rb
-- lib/spree/paypal_checkout/factories.rb
-- lib/spree/paypal_checkout/version.rb
+- lib/spree/paypal_platform.rb
+- lib/spree/paypal_platform/engine.rb
+- lib/spree/paypal_platform/factories.rb
+- lib/spree/paypal_platform/version.rb
 homepage: https://github.com/aypex-io/spree-paypal_platform
 licenses:
 - MIT

data/app/models/spree/paypal_checkout/payment_method_decorator.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-module Spree
-  module PaypalCheckout
-    ##
-    # Adds a paypal_checkout scope and predicate onto {Spree::PaymentMethod}.
-    #
-    module PaymentMethodDecorator
-      ##
-      # @param base [Class]
-      # @return [void]
-      #
-      def self.prepended(base)
-        base.scope :paypal_checkout, lambda {
-          where(type: Spree::PaypalCheckout.gateway_type_names)
-        }
-      end
-
-      ##
-      # @return [TrueClass, FalseClass]
-      #
-      def paypal_checkout?
-        Spree::PaypalCheckout.gateway_type_names.include?(type)
-      end
-    end
-  end
-end
-
-Spree::PaymentMethod.prepend(Spree::PaypalCheckout::PaymentMethodDecorator)

data/app/models/spree/paypal_checkout/store_decorator.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module Spree
-  module PaypalCheckout
-    ##
-    # Looks up the store's active PayPal Checkout gateway.
-    #
-    module StoreDecorator
-      ##
-      # @return [Spree::PaypalCheckout::Gateway, NilClass]
-      #
-      def paypal_checkout_gateway
-        @paypal_checkout_gateway ||= payment_methods.paypal_checkout.active.last
-      end
-    end
-  end
-end
-
-Spree::Store.prepend(Spree::PaypalCheckout::StoreDecorator)

data/lib/spree/paypal_checkout.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-require 'spree_core'
-require 'paypal_server_sdk'
-require 'spree/paypal_checkout/version'
-require 'spree/paypal_checkout/engine'
-
-module Spree
-  module PaypalCheckout
-    ##
-    # Table prefix for models nested under this module.
-    #
-    # Must live on the module, not on {Base}. ActiveRecord walks
-    # `module_parents` for `table_name_prefix` and finds `Spree` first
-    # (`"spree_"`) unless this closer parent defines it.
-    #
-    # @return [String]
-    #
-    def self.table_name_prefix
-      'spree_paypal_checkout_'
-    end
-
-    ##
-    # STI type names that count as this gem's gateway.
-    #
-    # Includes the historical `SpreePaypalCheckout::Gateway` string from the
-    # official / forked gem so existing payment-method rows keep matching
-    # after a host switches gems, even before the type-rewrite migration
-    # runs.
-    #
-    # @return [Array<String>]
-    #
-    def self.gateway_type_names
-      (
-        [Gateway.name, 'SpreePaypalCheckout::Gateway'] + Gateway.descendants.map(&:name)
-      ).uniq
-    end
-  end
-end
-
-# Historical top-level namespace from `spree_paypal_checkout`. Existing
-# `spree_payment_methods.type` / `spree_payment_sources.type` rows store
-# `SpreePaypalCheckout::…`; this alias lets those strings constantize
-# onto the new classes.
-SpreePaypalCheckout = Spree::PaypalCheckout

data/lib/spree-paypal_checkout.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-# Bundler auto-requires a gem by its *name*, so `gem "spree-paypal_checkout"`
-# in a host Gemfile issues `require "spree-paypal_checkout"`. The real entry
-# point is `spree/paypal_checkout` (matching the Spree::PaypalCheckout
-# namespace), so this shim keeps the default `Bundler.require` working.
-require 'spree/paypal_checkout'