spree-paypal_platform 5.1.0 → 5.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3002d47c7c53f6eb690a9dbd4717e47983e47083feac8a359369378c8435d24f
-  data.tar.gz: 5b4e7e078632cd6dc4e7e2796edc696bc543c4cfd7360b3a721064fc2114b62e
+  metadata.gz: 8a5221aa76bed440ec3e3c43943dd19d5230363f0af8a2b019de30451b6b5a17
+  data.tar.gz: 211d91d6bdbfaa92915b5c83902e41da2945a07701fc4165be9fc33951ce85d4
 SHA512:
-  metadata.gz: 0c8a5d07fa468eb3a275844b667ac07be8c8d5dd5878518ceb649fe0743a977a3b7b00335cb6cb885bc2d90c0d86695bbbdf3cee9eb34d0303fe2eddaeb9901e
-  data.tar.gz: a45636029c6e2888067299a8e9900f533ca6959eb79d005ca8e44187de359ca42af68d350ccbc39fa890bb285b179694479ca4812bbc795d9b3427fae6be68d8
+  metadata.gz: 7a3000e8e2ba28578737283bdff1c0c12aee5bb13504d3491cea317e690da1accd91dfa49ff965683dbdaec7397ab6b56a5b898d3495c0d14e505f5a2cb83a52
+  data.tar.gz: 94bb3f74f6bcbde9703a52e9d483d01991c1c0a07b9b4af1ee9879ce06dd374ebd9ef7d90a9c6b6a942da4b97b497be348c7fdd27c87cf4da4b5aaec1eee4c0b

data/CHANGELOG.md

@@ -1,46 +1,20 @@
 # Changelog
 
-All notable changes to this project are documented in this file.
+## 5.1.2
 
-## 5.1.0
+- Completing a session GETs the PayPal order first and skips capture when
+  it is already `COMPLETED` (Apple Pay `confirmOrder`).
+- `CreateSource` accepts an empty `payment_source.paypal` hash from the
+  create-order echo so checkout can finish after PayPal has taken payment.
 
-Full internal rename to `Spree::PaypalPlatform`.
+## 5.1.1
 
-- 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`.
+First release.
 
-## 5.0.1
-
-Published name is **`spree-paypal_platform`**. RubyGems rejected
-`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_platform` was
-never accepted by RubyGems; see 5.0.1.
-
-### Audit follow-up
-
-- Do not log PayPal request bodies; client logging is WARN without bodies/headers.
-- 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_platform_orders.paypal_id`.
-- Payment sources share `#display_payment_info`; OAuth/token HTTP responses must be 2xx.
-
-- 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.
-- Keeps the VAT `AMOUNT_MISMATCH` guard (additional tax only) and
-  `SET_PROVIDED_ADDRESS` storefront-owned shipping.
-- STI alias + rewrite migration for hosts coming from
-  `SpreePaypalCheckout::Gateway`.
+- `Spree::PaypalPlatform::Gateway` for Spree 5.6+
+- PayPal wallet, Apple Pay, and Card Fields on one payment method
+- Store API v3 payment sessions
+- `SET_PROVIDED_ADDRESS` so the storefront owns shipping
+- VAT-safe amount breakdown (`additional_tax_total` only)
+- Official `paypal-server-sdk` `~> 2.3`
+- One migration: create `spree_paypal_platform_orders`

data/README.md

@@ -70,26 +70,6 @@ https://<store>/api/v3/webhooks/payments/<prefixed-payment-method-id>
    `Spree::PaypalPlatform::PaymentSources::ApplePay`.
 4. Safari + HTTPS only.
 
-## Coming from `spree_paypal_checkout`
-
-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
-gem 'spree_paypal_checkout', github: 'aypex-io/spree_paypal_checkout', branch: 'tongkat-fitness'
-
-# after
-gem 'spree-paypal_platform'
-```
-
-Storefront `resolveGatewayId` should map `paypal_platform` /
-`Spree::PaypalPlatform::Gateway`. Keep the old `paypal_checkout` /
-`SpreePaypalCheckout::Gateway` keys until the STI rewrite has run.
-
 ## Developing
 
 ```bash

data/app/models/spree/paypal_platform/gateway/payment_sessions.rb

@@ -89,11 +89,15 @@ module Spree
         #
         def complete_payment_session(payment_session:, **_unused)
           paypal_order_id = payment_session.external_id
-
-          response = client.orders.capture_order({
-                                                   'id' => paypal_order_id,
-                                                   'prefer' => 'return=representation'
-                                                 })
+          lookup = { 'id' => paypal_order_id, 'prefer' => 'return=representation' }
+
+          fetched = client.orders.get_order(lookup)
+          response =
+            if fetched.data.status == 'COMPLETED'
+              fetched
+            else
+              client.orders.capture_order(lookup)
+            end
 
           payment_session.update!(external_data: response.data.as_json)
 

data/app/services/spree/paypal_platform/create_source.rb

@@ -27,7 +27,7 @@ module Spree
       # @raise [ArgumentError] when the payload has no known wallet key
       #
       def call
-        if paypal_payment_source[:paypal].present?
+        if paypal_payment_source.key?(:paypal)
           create_paypal_source
         elsif paypal_payment_source[:apple_pay].present?
           create_apple_pay_source
@@ -43,10 +43,11 @@ module Spree
       attr_reader :gateway, :user, :paypal_payment_source, :order
 
       def create_paypal_source
-        wallet = paypal_payment_source[:paypal]
+        wallet = paypal_payment_source[:paypal] || {}
+        profile_id = wallet[:account_id].presence || "paypal-#{order&.number || 'guest'}"
         source = PaymentSources::Paypal.find_or_initialize_by(
           payment_method: gateway,
-          gateway_payment_profile_id: wallet[:account_id]
+          gateway_payment_profile_id: profile_id
         )
         source.update!(
           user: user,

data/db/migrate/{20250528095719_create_spree_paypal_checkout_orders.rb → 20250528095719_create_spree_paypal_platform_orders.rb}

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-class CreateSpreePaypalCheckoutOrders < ActiveRecord::Migration[7.2]
+class CreateSpreePaypalPlatformOrders < ActiveRecord::Migration[7.2]
   def change
-    create_table :spree_paypal_checkout_orders do |t|
+    create_table :spree_paypal_platform_orders do |t|
       t.references :order, null: false
       t.references :payment_method, null: false
       t.string :paypal_id, null: false
@@ -17,6 +17,7 @@ class CreateSpreePaypalCheckoutOrders < ActiveRecord::Migration[7.2]
       t.timestamps
     end
 
-    add_index :spree_paypal_checkout_orders, %i[order_id paypal_id], unique: true
+    add_index :spree_paypal_platform_orders, %i[order_id paypal_id], unique: true
+    add_index :spree_paypal_platform_orders, :paypal_id, unique: true
   end
 end

data/lib/spree/paypal_platform/version.rb

@@ -3,6 +3,6 @@
 module Spree
   module PaypalPlatform
     # Major version tracks Spree's major version: 5.x supports Spree 5.x.
-    VERSION = '5.1.0'
+    VERSION = '5.1.2'
   end
 end

data/lib/spree/paypal_platform.rb

@@ -23,20 +23,10 @@ module Spree
     ##
     # 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
+      ([Gateway.name] + Gateway.descendants.map(&:name)).uniq
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spree-paypal_platform
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 5.1.2
 platform: ruby
 authors:
 - Aypex
@@ -139,10 +139,7 @@ files:
 - 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
-- db/migrate/20260817140000_rename_paypal_checkout_orders_to_paypal_platform.rb
+- db/migrate/20250528095719_create_spree_paypal_platform_orders.rb
 - lib/generators/spree/paypal_platform/install/install_generator.rb
 - lib/spree-paypal_platform.rb
 - lib/spree/paypal_platform.rb

data/db/migrate/20260817120000_rewrite_spree_paypal_checkout_sti_types.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-class RewriteSpreePaypalCheckoutStiTypes < ActiveRecord::Migration[7.2]
-  # 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::PaypalPlatform::Gateway',
-    'SpreePaypalCheckout::PaymentSources::Paypal' => 'Spree::PaypalPlatform::PaymentSources::Paypal',
-    'SpreePaypalCheckout::Order' => 'Spree::PaypalPlatform::Order'
-  }.freeze
-
-  def up
-    rewrite_column(:spree_payment_methods, :type)
-    rewrite_column(:spree_payment_sources, :type) if column_exists?(:spree_payment_sources, :type)
-  end
-
-  def down
-    rewrite_column(:spree_payment_methods, :type, LEGACY_TO_CURRENT.invert)
-    rewrite_column(:spree_payment_sources, :type, LEGACY_TO_CURRENT.invert) if column_exists?(:spree_payment_sources, :type)
-  end
-
-  private
-
-  def rewrite_column(table, column, mapping = LEGACY_TO_CURRENT)
-    mapping.each do |from, to|
-      reversible_update = "UPDATE #{table} SET #{column} = #{quote(to)} WHERE #{column} = #{quote(from)}"
-      execute reversible_update
-    end
-  end
-end

data/db/migrate/20260817130000_add_unique_index_on_paypal_checkout_order_paypal_id.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-class AddUniqueIndexOnPaypalCheckoutOrderPaypalId < ActiveRecord::Migration[7.2]
-  def change
-    add_index :spree_paypal_checkout_orders, :paypal_id, unique: true
-  end
-end

data/db/migrate/20260817140000_rename_paypal_checkout_orders_to_paypal_platform.rb

@@ -1,48 +0,0 @@
-# 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