spree-paypal_platform 5.1.3 → 5.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b451e198e6215856080bd410bfdcec699ad02835c638a02d7a33ee933f21f27
-  data.tar.gz: 183989e5effcb3cc16461b8f7e0401a284d630d546e6304aa8d65730f3bce7be
+  metadata.gz: 4de54a54a0c7dd935c012bf20c72711b0bf78959b2556acebfacc3c0eb14e930
+  data.tar.gz: 94c506e594ce38d454fdff782d1dad610582b81e59e658d1bce232b29cf7344c
 SHA512:
-  metadata.gz: 6a6c113d998c9538d07ebd9a6b483a37f1c26fa3502257dfa2855c94990ab307d8889a32f132cea4e29a0064812b9cbff221ae665ae0c06c9f101454cb5605b0
-  data.tar.gz: 2dd052e117e6aff4facf62c72f63a0f00bedb7f0b7a466db880d49b48efba99bc058d9c3f1022a4cdbd71f552d73117edb0dd4ef7bfe9e1a14a53361d1ff6759
+  metadata.gz: abdce2d88ae3c2fb939cb6ce006bf1b6a654fadf98436df56ff3771c7f79b55c66e28fea31934bdc20310877b2f875c4e19fe0be873b4d15b1a05cfeee45af7c
+  data.tar.gz: 8c4d81e0b0f6e8d80da95c7febc3c6acaefda891d4dce1c5722ea0a9a0700da8f9beaeccb2dbe046ce0fd320b4dac0bccffa6a555cbd2e1356d719ce3d7077dc

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## 5.1.5
+
+- Gift cards and store credit: the PayPal order is created for the amount
+  due (`total_minus_store_credits`), not the full order total. Before, PayPal
+  charged the full total while Spree recorded the gift card as paying part
+  of it, so the customer paid twice for that part. A partial charge is sent
+  as a plain amount, without the breakdown and items that sum to the full
+  total.
+- Completing a session refuses to capture when the PayPal order amount no
+  longer matches the amount due (e.g. a gift card was applied, or the cart
+  changed, after the PayPal order was created). The session fails and the
+  storefront creates a new one.
+
+## 5.1.4
+
+- `enable_card_fields` preference (checkbox, default on).
+- Storefront sees `enable_apple_pay` and `enable_card_fields` on the payment
+  method (`public_preferences`) and on the payment session `external_data`.
+- Client token is not requested when Card Fields are disabled.
+
 ## 5.1.3
 
 Remove the unused `apple_pay_domain` preference. Domain registration is

data/README.md

@@ -48,7 +48,8 @@ Then add a **PayPal** payment method in admin and set:
 | `client_id` / `client_secret` | REST app credentials from the PayPal Developer Dashboard |
 | `webhook_secret` | PayPal webhook ID (used as the verify-webhook `webhook_id`) |
 | `test_mode` | Sandbox vs live |
-| `enable_apple_pay` | Advertise Apple Pay to headless storefronts (default on) |
+| `enable_apple_pay` | Offer Apple Pay on the storefront (default on) |
+| `enable_card_fields` | Offer Card Fields on the storefront (default on) |
 
 Webhook URL is the standard Spree v3 payments webhook:
 

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

@@ -42,13 +42,18 @@ module Spree
           return nil if total.zero?
 
           protect_from_error do
-            order_presenter = OrderPresenter.new(order)
+            order_presenter = OrderPresenter.new(order, amount: total)
             paypal_response = client.orders.create_order(order_presenter.to_json)
 
             session_data = paypal_response.data.as_json
 
-            client_token = generate_client_token
-            session_data['client_token'] = client_token if client_token.present?
+            session_data['enable_apple_pay'] = apple_pay_enabled?
+            session_data['enable_card_fields'] = card_fields_enabled?
+
+            if card_fields_enabled?
+              client_token = generate_client_token
+              session_data['client_token'] = client_token if client_token.present?
+            end
 
             payment_session_class.create!(
               order: order,
@@ -96,6 +101,7 @@ module Spree
             if fetched.data.status == 'COMPLETED'
               fetched
             else
+              ensure_amount_matches!(payment_session, fetched)
               client.orders.capture_order(lookup)
             end
 
@@ -161,6 +167,26 @@ module Spree
 
         private
 
+        ##
+        # Refuses to capture a PayPal order whose amount no longer matches what
+        # is due — e.g. a gift card was applied, or the cart changed, after the
+        # PayPal order was created. Capturing would take the stale amount; the
+        # storefront recreates the session instead.
+        #
+        # @raise [Spree::Core::GatewayError]
+        #
+        def ensure_amount_matches!(payment_session, fetched)
+          value = fetched.data.as_json.dig('purchase_units', 0, 'amount', 'value')
+          return if value.blank?
+
+          due = payment_session.order.total_minus_store_credits
+          return if value.to_d == due.to_d
+
+          payment_session.fail if payment_session.can_fail?
+          raise Spree::Core::GatewayError,
+                "PayPal order amount #{value} does not match the amount due #{due}"
+        end
+
         def extract_order_id_from_webhook(event_type, resource)
           case event_type
           when /\ACHECKOUT\.ORDER\./

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

@@ -23,6 +23,7 @@ module Spree
       preference :webhook_secret, :string
       preference :test_mode, :boolean, default: true
       preference :enable_apple_pay, :boolean, default: true
+      preference :enable_card_fields, :boolean, default: true
 
       validates :preferred_client_id, :preferred_client_secret, presence: true
 
@@ -105,6 +106,15 @@ module Spree
         preferred_enable_apple_pay
       end
 
+      ##
+      # Whether the storefront should offer Card Fields for this method.
+      #
+      # @return [TrueClass, FalseClass]
+      #
+      def card_fields_enabled?
+        preferred_enable_card_fields
+      end
+
       ##
       # @return [String, NilClass]
       #
@@ -279,6 +289,12 @@ module Spree
         end
       end
 
+      protected
+
+      def public_preference_keys
+        %i[enable_apple_pay enable_card_fields]
+      end
+
       private
 
       def find_order(order_id)

data/app/presenters/spree/paypal_platform/order_presenter.rb

@@ -18,9 +18,13 @@ module Spree
 
       ##
       # @param order [Spree::Order]
+      # @param amount [Numeric, NilClass] what PayPal should charge; defaults to
+      #   the order total. Less than the total when a gift card or store credit
+      #   pays part of the order.
       #
-      def initialize(order)
+      def initialize(order, amount: nil)
         @order = order
+        @amount = amount
       end
 
       attr_reader :order
@@ -41,15 +45,29 @@ module Spree
       private
 
       def purchase_unit
-        args = {
-          amount: amount_with_breakdown,
-          items: items
-        }
+        # A gift card or store credit pays part of the order, so the breakdown
+        # and items (which always sum to the full order total) can't describe
+        # what PayPal charges. PayPal accepts an amount on its own.
+        args =
+          if partial_charge?
+            { amount: PaypalServerSdk::AmountWithBreakdown.new(currency_code: order.currency.upcase,
+                                                               value: charge_amount.to_s) }
+          else
+            { amount: amount_with_breakdown, items: items }
+          end
         args[:shipping] = shipping_details if shipping_details
 
         PaypalServerSdk::PurchaseUnitRequest.new(**args)
       end
 
+      def charge_amount
+        @amount.presence || order.total
+      end
+
+      def partial_charge?
+        charge_amount.to_d != order.total.to_d
+      end
+
       # NOTE: the breakdown only sends additional (non-included) tax — sending
       # the full tax_total double-counts VAT on tax-inclusive markets and
       # trips AMOUNT_MISMATCH. Do not change to order.tax_total.

data/app/serializers/spree/api/v3/payment_method_serializer_decorator.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Spree
+  module Api
+    module V3
+      ##
+      # Exposes non-secret payment-method preferences to the storefront.
+      #
+      module PaymentMethodSerializerDecorator
+        def self.prepended(base)
+          base.attribute :public_preferences, &:public_preferences
+        end
+      end
+    end
+  end
+end
+
+Spree::Api::V3::PaymentMethodSerializer.prepend(
+  Spree::Api::V3::PaymentMethodSerializerDecorator
+)

data/app/views/spree/admin/payment_methods/configuration_guides/_spree_paypal_platform.html.erb

@@ -11,6 +11,7 @@
     <strong>Apple Pay</strong> is a funding source of this same PayPal method, not a second payment method.
     Register every storefront domain that will show the Apple Pay button in the
     <%= external_link_to 'PayPal Apple Pay domain registration', 'https://developer.paypal.com/docs/checkout/apm/apple-pay/', class: 'alert-link' %>
-    dashboard. The button only renders in Safari over HTTPS.
+    dashboard. Use the checkboxes below to offer Card Fields and Apple Pay
+    on the storefront. The Apple Pay button only renders in Safari over HTTPS.
   </p>
 </div>

data/lib/spree/paypal_platform/factories.rb

@@ -9,7 +9,8 @@ FactoryBot.define do
         client_id: ENV.fetch('PAYPAL_CLIENT_ID', 'client_id_test'),
         client_secret: ENV.fetch('PAYPAL_CLIENT_SECRET', 'client_secret_test'),
         test_mode: true,
-        enable_apple_pay: true
+        enable_apple_pay: true,
+        enable_card_fields: 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.3'
+    VERSION = '5.1.5'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spree-paypal_platform
 version: !ruby/object:Gem::Version
-  version: 5.1.3
+  version: 5.1.5
 platform: ruby
 authors:
 - Aypex
@@ -131,6 +131,7 @@ files:
 - 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/serializers/spree/api/v3/payment_method_serializer_decorator.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
@@ -168,7 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.16
+rubygems_version: 4.0.20
 specification_version: 4
 summary: PayPal Checkout for Spree, including Apple Pay and Card Fields
 test_files: []