spree_paypal_checkout 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef8dfb2e6f13c0334979a7af8f62d21882bdb0e2a717e36328aec335194d8767
-  data.tar.gz: d2f23cb259fb7f2c55b3c4af5fc98d48e9625f46ec239a351f9e6896f002302e
+  metadata.gz: bfb11878efce5e64446b6e83c9f16a69b64203ff47ce9ca601f1404b6f0ed017
+  data.tar.gz: 86705e3ed5b1c0314c2518c793edc022d5149e64a32d710919455b0e3ef4fe42
 SHA512:
-  metadata.gz: 2bca77d66f83220e40a00cb7edbba2560948384c46a4033ac2b3e1dd92d7e08235f366f3f57c867e1a790539e3e48d521ca61fd1899f9283dd5ad9105c1ed4b2
-  data.tar.gz: ec63da1f24b8a6885f8da03d4a7fcbd212eb5cfba45d1f42922dffe167549fd84625b97ab2349820d8bc484c5cf97b5423b842044dc34e5819f6d5e2815cff0d
+  metadata.gz: fb11160ee57ed3ab5275c2e32c8d13463b74149002ed2297cd95045f53dc3101c8a1f97fff3b8424c4d0ae6e5ba5003c623ad2d12d4226183dbb30aa8c5a4c95
+  data.tar.gz: 74a7e4a0cdd3f55e976bb948ee8bc8a9799b55ec076319c353720342ffb0b80e087f0229e1046e0fc6f4b74dae88ff019ad1231f6a8f127ddbdfff1cc73dba23

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

@@ -0,0 +1,22 @@
+module Spree
+  class PaymentSetupSessions::PaypalCheckout < PaymentSetupSession
+    # PayPal's Vault API uses setup tokens (temporary) that get exchanged for
+    # permanent payment tokens once the buyer approves on PayPal.
+    def paypal_setup_token_id
+      external_id
+    end
+
+    def paypal_payment_token_id
+      external_data&.dig('payment_token', 'id')
+    end
+
+    # The approve link the storefront redirects the buyer to.
+    def approve_link
+      Array(external_data&.dig('links')).find { |l| l['rel'] == 'approve' }&.dig('href')
+    end
+
+    def successful?
+      status == 'completed'
+    end
+  end
+end

data/app/models/spree_paypal_checkout/gateway/payment_setup_sessions.rb

@@ -0,0 +1,116 @@
+module SpreePaypalCheckout
+  class Gateway < ::Spree::Gateway
+    module PaymentSetupSessions
+      extend ActiveSupport::Concern
+
+      def setup_session_supported?
+        true
+      end
+
+      def payment_setup_session_class
+        Spree::PaymentSetupSessions::PaypalCheckout
+      end
+
+      # Creates a PayPal Vault setup token (temporary, awaiting buyer approval)
+      # and persists a Spree::PaymentSetupSessions::PaypalCheckout record.
+      #
+      # @param customer [Spree::User] the customer to vault the PayPal account for
+      # @param external_data [Hash] optional :return_url and :cancel_url for the
+      #   PayPal redirect flow
+      # @return [Spree::PaymentSetupSessions::PaypalCheckout]
+      def create_payment_setup_session(customer:, external_data: {})
+        return_url = external_data[:return_url] || external_data['return_url'] || default_setup_return_url
+        cancel_url = external_data[:cancel_url] || external_data['cancel_url'] || default_setup_cancel_url
+
+        protect_from_error do
+          response = client.vault.create_setup_token(
+            SpreePaypalCheckout::SetupTokenPresenter.new(
+              customer: customer,
+              return_url: return_url,
+              cancel_url: cancel_url
+            ).to_h
+          )
+
+          payment_setup_session_class.create!(
+            customer: customer,
+            payment_method: self,
+            status: 'pending',
+            external_id: response.data.id,
+            external_data: response.data.as_json.merge(
+              'return_url' => return_url,
+              'cancel_url' => cancel_url
+            )
+          )
+        end
+      end
+
+      # Completes a setup session by exchanging the approved setup token for a
+      # permanent payment token, creates a Spree::PaymentSource representing the
+      # vaulted PayPal account, and transitions the session.
+      #
+      # @param setup_session [Spree::PaymentSetupSessions::PaypalCheckout]
+      # @param params [Hash] unused — PayPal needs no params beyond the setup_session
+      def complete_payment_setup_session(setup_session:, params: {})
+        protect_from_error do
+          response = client.vault.create_payment_token(
+            'body' => {
+              'payment_source' => {
+                'token' => {
+                  'id' => setup_session.external_id,
+                  'type' => 'SETUP_TOKEN'
+                }
+              }
+            }
+          )
+
+          payment_token = response.data
+
+          setup_session.payment_source = build_payment_source_from_token(setup_session, payment_token)
+          setup_session.update!(
+            external_data: setup_session.external_data.to_h.merge('payment_token' => payment_token.as_json)
+          )
+          setup_session.complete if setup_session.can_complete?
+        rescue PaypalServerSdk::APIException => e
+          setup_session.fail if setup_session.can_fail?
+          raise Spree::Core::GatewayError, "PayPal Vault error: #{e.message}"
+        end
+
+        setup_session
+      end
+
+      private
+
+      def build_payment_source_from_token(setup_session, payment_token)
+        paypal = payment_token.as_json.dig('payment_source', 'paypal') || {}
+        account_id = paypal['email_address'] || payment_token.id
+
+        source = SpreePaypalCheckout::PaymentSources::Paypal.find_or_initialize_by(
+          payment_method: self,
+          gateway_payment_profile_id: payment_token.id
+        )
+        source.update!(
+          user: setup_session.customer,
+          email: paypal['email_address'],
+          name: [paypal.dig('name', 'given_name'), paypal.dig('name', 'surname')].compact.join(' ').strip.presence,
+          account_id: account_id,
+          account_status: paypal['account_status']
+        )
+        source
+      end
+
+      def default_setup_return_url
+        store = stores.first
+        return nil unless store
+
+        "#{store.storefront_url}/paypal/payment_setup_sessions/return"
+      end
+
+      def default_setup_cancel_url
+        store = stores.first
+        return nil unless store
+
+        "#{store.storefront_url}/paypal/payment_setup_sessions/cancel"
+      end
+    end
+  end
+end

data/app/presenters/spree_paypal_checkout/setup_token_presenter.rb

@@ -0,0 +1,37 @@
+module SpreePaypalCheckout
+  # Builds the body of a PayPal Vault /v3/vault/setup-tokens request for tokenizing
+  # a buyer's PayPal account without an immediate purchase.
+  class SetupTokenPresenter
+    def initialize(customer:, return_url:, cancel_url:)
+      @customer = customer
+      @return_url = return_url
+      @cancel_url = cancel_url
+    end
+
+    def to_h
+      {
+        'body' => {
+          'payment_source' => {
+            'paypal' => {
+              'usage_type' => 'MERCHANT',
+              'experience_context' => {
+                'return_url' => return_url,
+                'cancel_url' => cancel_url
+              }
+            }
+          }
+        }.merge(customer_payload)
+      }
+    end
+
+    private
+
+    attr_reader :customer, :return_url, :cancel_url
+
+    def customer_payload
+      return {} unless customer&.id
+
+      { 'customer' => { 'id' => "customer_#{customer.id}" } }
+    end
+  end
+end

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

@@ -1,6 +1,7 @@
 <div class="alert alert-info">
   <p class="mb-0">
     To find your <strong>Client ID</strong> and <strong>Client Secret</strong>, go to the 
-    <%= external_link_to 'PayPal dashboard', 'https://www.paypal.com/mep/merchantapps/setup/checkout/apicredentials', class: 'alert-link' %>
+    <%= external_link_to 'PayPal Developer Dashboard', 'https://developer.paypal.com/dashboard/', class: 'alert-link' %>.
+    For more information, see the <%= external_link_to 'PayPal REST API documentation', 'https://developer.paypal.com/api/rest/', class: 'alert-link' %>.
   </p>
 </div>

data/lib/spree_paypal_checkout/version.rb

@@ -1,5 +1,5 @@
 module SpreePaypalCheckout
-  VERSION = '0.7.0'.freeze
+  VERSION = '0.7.1'.freeze
 
   def gem_version
     Gem::Version.new(VERSION)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spree_paypal_checkout
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Vendo Connect Inc.
@@ -121,15 +121,18 @@ files:
 - app/javascript/spree_paypal_checkout/application.js
 - app/javascript/spree_paypal_checkout/controllers/checkout_paypal_controller.js
 - app/models/spree/payment_sessions/paypal_checkout.rb
+- app/models/spree/payment_setup_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/gateway/payment_setup_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/paypal.rb
 - app/models/spree_paypal_checkout/store_decorator.rb
 - app/presenters/spree_paypal_checkout/order_presenter.rb
+- app/presenters/spree_paypal_checkout/setup_token_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
@@ -157,9 +160,9 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/spree/spree_paypal_checkout/issues
-  changelog_uri: https://github.com/spree/spree_paypal_checkout/releases/tag/v0.7.0
+  changelog_uri: https://github.com/spree/spree_paypal_checkout/releases/tag/v0.7.1
   documentation_uri: https://docs.spreecommerce.org/
-  source_code_uri: https://github.com/spree/spree_paypal_checkout/tree/v0.7.0
+  source_code_uri: https://github.com/spree/spree_paypal_checkout/tree/v0.7.1
 rdoc_options: []
 require_paths:
 - lib