spree-paypal_platform 5.1.2 → 5.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a5221aa76bed440ec3e3c43943dd19d5230363f0af8a2b019de30451b6b5a17
-  data.tar.gz: 211d91d6bdbfaa92915b5c83902e41da2945a07701fc4165be9fc33951ce85d4
+  metadata.gz: 10754110031d42b6574e51b4eef1c1cb1adcc5a0d09b7c203d8620eae06acae8
+  data.tar.gz: e7d3ea6129314c8cf7d2083370a8997bdd09aa655cfd826d96145378a60865ae
 SHA512:
-  metadata.gz: 7a3000e8e2ba28578737283bdff1c0c12aee5bb13504d3491cea317e690da1accd91dfa49ff965683dbdaec7397ab6b56a5b898d3495c0d14e505f5a2cb83a52
-  data.tar.gz: 94bb3f74f6bcbde9703a52e9d483d01991c1c0a07b9b4af1ee9879ce06dd374ebd9ef7d90a9c6b6a942da4b97b497be348c7fdd27c87cf4da4b5aaec1eee4c0b
+  metadata.gz: 0e97ad651a97eba76344f666a171ad211583608a8ce307ca80fd507f5452e6a07ca2e81f04af9f4fce14594a5c507d1e95facce00eb0d334d7ea34c5b499ba2c
+  data.tar.gz: 001c8dec98b5eed5f48c20cc398b453daeaca65829b81d49bb7aa40cc33b3b6ab06beeadf2c77b6ab2dd71612216f9f877dde3d8ed3723edec956fd3d5b4a2d9

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 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
+in the PayPal dashboard, not this field.
+
 ## 5.1.2
 
 - Completing a session GETs the PayPal order first and skips capture when

data/README.md

@@ -48,8 +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) |
-| `apple_pay_domain` | Domain registered with PayPal for Apple Pay |
+| `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

@@ -47,8 +47,13 @@ module Spree
 
             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,

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

@@ -23,7 +23,7 @@ module Spree
       preference :webhook_secret, :string
       preference :test_mode, :boolean, default: true
       preference :enable_apple_pay, :boolean, default: true
-      preference :apple_pay_domain, :string
+      preference :enable_card_fields, :boolean, default: true
 
       validates :preferred_client_id, :preferred_client_secret, presence: true
 
@@ -106,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]
       #
@@ -280,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/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, then set <em>Apple pay domain</em> below. 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.2'
+    VERSION = '5.1.4'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spree-paypal_platform
 version: !ruby/object:Gem::Version
-  version: 5.1.2
+  version: 5.1.4
 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