Handle free trial for paypal

Vault account without payment

modules/ppcp-button/resources/js/button.js

@@ -16,6 +16,7 @@ import {
 } from "./modules/Helper/CheckoutMethodState";
 import {hide, setVisible} from "./modules/Helper/Hiding";
 import {isChangePaymentPage} from "./modules/Helper/Subscriptions";
+import FreeTrialHandler from "./modules/ActionHandler/FreeTrialHandler";
 
 const buttonsSpinner = new Spinner('.ppc-button-wrapper');
 
@@ -23,8 +24,17 @@ const bootstrap = () => {
     const errorHandler = new ErrorHandler(PayPalCommerceGateway.labels.error.generic);
     const spinner = new Spinner();
     const creditCardRenderer = new CreditCardRenderer(PayPalCommerceGateway, errorHandler, spinner);
-    const onSmartButtonClick = data => {
+
+    const freeTrialHandler = new FreeTrialHandler(PayPalCommerceGateway, spinner, errorHandler);
+
+    const onSmartButtonClick = (data, actions) => {
         window.ppcpFundingSource = data.fundingSource;
+
+        const isFreeTrial = PayPalCommerceGateway.is_free_trial_cart;
+        if (isFreeTrial) {
+            freeTrialHandler.handle();
+            return actions.reject();
+        }
     };
     const onSmartButtonsInit = () => {
         buttonsSpinner.unblock();
@@ -112,6 +122,7 @@ document.addEventListener(
             if (
                 !['checkout', 'pay-now'].includes(PayPalCommerceGateway.context)
                 || isChangePaymentPage()
+                || (PayPalCommerceGateway.is_free_trial_cart && vaulted_paypal_email !== '')
             ) {
                 return;
             }

modules/ppcp-button/resources/js/modules/ActionHandler/FreeTrialHandler.js

@@ -0,0 +1,39 @@
+import {PaymentMethods} from "../Helper/CheckoutMethodState";
+import errorHandler from "../ErrorHandler";
+
+class FreeTrialHandler {
+    constructor(
+        config,
+        spinner,
+        errorHandler
+    ) {
+        this.config = config;
+        this.spinner = spinner;
+        this.errorHandler = errorHandler;
+    }
+
+    handle()
+    {
+        this.spinner.block();
+
+        fetch(this.config.ajax.vault_paypal.endpoint, {
+            method: 'POST',
+            body: JSON.stringify({
+                nonce: this.config.ajax.vault_paypal.nonce,
+                return_url: location.href
+            }),
+        }).then(res => {
+            this.spinner.unblock()
+            return res.json();
+        }).then(data => {
+            if (!data.success) {
+                console.error(data);
+                this.errorHandler.message(data.data.message);
+                throw Error(data.data.message);
+            }
+
+            location.href = data.data.approve_link;
+        });
+    }
+}
+export default FreeTrialHandler;

modules/ppcp-button/resources/js/modules/ContextBootstrap/CheckoutBootstap.js

@@ -86,13 +86,16 @@ class CheckoutBootstap {
         const isCard = currentPaymentMethod === PaymentMethods.CARDS;
         const isSavedCard = isCard && isSavedCardSelected();
         const isNotOurGateway = !isPaypal && !isCard;
+        const isFreeTrial = PayPalCommerceGateway.is_free_trial_cart;
+        const hasVaultedPaypal = PayPalCommerceGateway.vaulted_paypal_email !== '';
 
-        setVisible(this.standardOrderButtonSelector, isNotOurGateway || isSavedCard, true);
-        setVisible(this.gateway.button.wrapper, isPaypal);
-        setVisible(this.gateway.messages.wrapper, isPaypal);
+        setVisible(this.standardOrderButtonSelector,  (isPaypal && isFreeTrial && hasVaultedPaypal) || isNotOurGateway || isSavedCard, true);
+        setVisible('.ppcp-vaulted-paypal-details', isPaypal);
+        setVisible(this.gateway.button.wrapper, isPaypal && !(isFreeTrial && hasVaultedPaypal));
+        setVisible(this.gateway.messages.wrapper, isPaypal && !isFreeTrial);
         setVisible(this.gateway.hosted_fields.wrapper, isCard && !isSavedCard);
 
-        if (isPaypal) {
+        if (isPaypal && !isFreeTrial) {
             this.messages.render();
         }
 

modules/ppcp-button/services.php

@@ -18,6 +18,7 @@ use WooCommerce\PayPalCommerce\Button\Endpoint\ChangeCartEndpoint;
 use WooCommerce\PayPalCommerce\Button\Endpoint\CreateOrderEndpoint;
 use WooCommerce\PayPalCommerce\Button\Endpoint\DataClientIdEndpoint;
 use WooCommerce\PayPalCommerce\Button\Endpoint\RequestData;
+use WooCommerce\PayPalCommerce\Button\Endpoint\StartPayPalVaultingEndpoint;
 use WooCommerce\PayPalCommerce\Button\Exception\RuntimeException;
 use WooCommerce\PayPalCommerce\Button\Helper\EarlyOrderHandler;
 use WooCommerce\PayPalCommerce\Button\Helper\MessagesApply;
@@ -85,7 +86,8 @@ return array(
 			$environment,
 			$payment_token_repository,
 			$settings_status,
-			$currency
+			$currency,
+			$container->get( 'woocommerce.logger.woocommerce' )
 		);
 	},
 	'button.url'                        => static function ( ContainerInterface $container ): string {
@@ -169,6 +171,13 @@ return array(
 			$logger
 		);
 	},
+	'button.endpoint.vault-paypal'      => static function( ContainerInterface $container ) : StartPayPalVaultingEndpoint {
+		return new StartPayPalVaultingEndpoint(
+			$container->get( 'button.request-data' ),
+			$container->get( 'api.endpoint.payment-token' ),
+			$container->get( 'woocommerce.logger.woocommerce' )
+		);
+	},
 	'button.helper.three-d-secure'      => static function ( ContainerInterface $container ): ThreeDSecure {
 		$logger = $container->get( 'woocommerce.logger.woocommerce' );
 		return new ThreeDSecure( $logger );

modules/ppcp-button/src/Assets/SmartButton.php

@@ -9,6 +9,9 @@ declare(strict_types=1);
 
 namespace WooCommerce\PayPalCommerce\Button\Assets;
 
+use Exception;
+use Psr\Log\LoggerInterface;
+use WooCommerce\PayPalCommerce\ApiClient\Entity\PaymentToken;
 use WooCommerce\PayPalCommerce\ApiClient\Factory\PayerFactory;
 use WooCommerce\PayPalCommerce\ApiClient\Helper\DccApplies;
 use WooCommerce\PayPalCommerce\Button\Endpoint\ApproveOrderEndpoint;
@@ -16,9 +19,11 @@ use WooCommerce\PayPalCommerce\Button\Endpoint\ChangeCartEndpoint;
 use WooCommerce\PayPalCommerce\Button\Endpoint\CreateOrderEndpoint;
 use WooCommerce\PayPalCommerce\Button\Endpoint\DataClientIdEndpoint;
 use WooCommerce\PayPalCommerce\Button\Endpoint\RequestData;
+use WooCommerce\PayPalCommerce\Button\Endpoint\StartPayPalVaultingEndpoint;
 use WooCommerce\PayPalCommerce\Button\Helper\MessagesApply;
 use WooCommerce\PayPalCommerce\Onboarding\Environment;
 use WooCommerce\PayPalCommerce\Session\SessionHandler;
+use WooCommerce\PayPalCommerce\Subscription\FreeTrialHandlerTrait;
 use WooCommerce\PayPalCommerce\Subscription\Helper\SubscriptionHelper;
 use WooCommerce\PayPalCommerce\Vaulting\PaymentTokenRepository;
 use WooCommerce\PayPalCommerce\WcGateway\Gateway\CreditCardGateway;
@@ -30,6 +35,8 @@ use WooCommerce\PayPalCommerce\WcGateway\Settings\Settings;
  */
 class SmartButton implements SmartButtonInterface {
 
+	use FreeTrialHandlerTrait;
+
 	/**
 	 * The Settings status helper.
 	 *
@@ -128,6 +135,20 @@ class SmartButton implements SmartButtonInterface {
 	 */
 	private $currency;
 
+	/**
+	 * The logger.
+	 *
+	 * @var LoggerInterface
+	 */
+	private $logger;
+
+	/**
+	 * Cached payment tokens.
+	 *
+	 * @var PaymentToken[]|null
+	 */
+	private $payment_tokens = null;
+
 	/**
 	 * SmartButton constructor.
 	 *
@@ -145,6 +166,7 @@ class SmartButton implements SmartButtonInterface {
 	 * @param PaymentTokenRepository $payment_token_repository The payment token repository.
 	 * @param SettingsStatus         $settings_status The Settings status helper.
 	 * @param string                 $currency 3-letter currency code of the shop.
+	 * @param LoggerInterface        $logger The logger.
 	 */
 	public function __construct(
 		string $module_url,
@@ -160,7 +182,8 @@ class SmartButton implements SmartButtonInterface {
 		Environment $environment,
 		PaymentTokenRepository $payment_token_repository,
 		SettingsStatus $settings_status,
-		string $currency
+		string $currency,
+		LoggerInterface $logger
 	) {
 
 		$this->module_url               = $module_url;
@@ -177,6 +200,7 @@ class SmartButton implements SmartButtonInterface {
 		$this->payment_token_repository = $payment_token_repository;
 		$this->settings_status          = $settings_status;
 		$this->currency                 = $currency;
+		$this->logger                   = $logger;
 	}
 
 	/**
@@ -262,6 +286,38 @@ class SmartButton implements SmartButtonInterface {
 				2
 			);
 		}
+
+		if ( $this->is_free_trial_cart() ) {
+			add_action(
+				'woocommerce_review_order_after_submit',
+				function () {
+					$vaulted_email = $this->get_vaulted_paypal_email();
+					if ( ! $vaulted_email ) {
+						return;
+					}
+
+					?>
+					<div class="ppcp-vaulted-paypal-details">
+						<?php
+						echo wp_kses_post(
+							sprintf(
+							// translators: %1$s - email, %2$s, %3$s - HTML tags for a link.
+								esc_html__(
+									'Using %2$s%1$s%3$s PayPal.',
+									'woocommerce-paypal-payments'
+								),
+								$vaulted_email,
+								'<b>',
+								'</b>'
+							)
+						);
+						?>
+					</div>
+					<?php
+				}
+			);
+		}
+
 		return true;
 	}
 
@@ -671,6 +727,8 @@ class SmartButton implements SmartButtonInterface {
 	private function localize_script(): array {
 		global $wp;
 
+		$is_free_trial_cart = $this->is_free_trial_cart();
+
 		$this->request_data->enqueue_nonce_fix();
 		$localize = array(
 			'script_attributes'              => $this->attributes(),
@@ -696,9 +754,15 @@ class SmartButton implements SmartButtonInterface {
 					'endpoint' => \WC_AJAX::get_endpoint( ApproveOrderEndpoint::ENDPOINT ),
 					'nonce'    => wp_create_nonce( ApproveOrderEndpoint::nonce() ),
 				),
+				'vault_paypal'  => array(
+					'endpoint' => \WC_AJAX::get_endpoint( StartPayPalVaultingEndpoint::ENDPOINT ),
+					'nonce'    => wp_create_nonce( StartPayPalVaultingEndpoint::nonce() ),
+				),
 			),
 			'enforce_vault'                  => $this->has_subscriptions(),
 			'can_save_vault_token'           => $this->can_save_vault_token(),
+			'is_free_trial_cart'             => $is_free_trial_cart,
+			'vaulted_paypal_email'           => ( is_checkout() && $is_free_trial_cart ) ? $this->get_vaulted_paypal_email() : '',
 			'bn_codes'                       => $this->bn_codes(),
 			'payer'                          => $this->payerData(),
 			'button'                         => array(
@@ -1126,4 +1190,37 @@ class SmartButton implements SmartButtonInterface {
         // phpcs:ignore WordPress.PHP.StrictComparisons.LooseComparison
 		return WC()->cart->get_cart_contents_total() == 0;
 	}
+
+	/**
+	 * Retrieves all payment tokens for the user, via API or cached if already queried.
+	 *
+	 * @return PaymentToken[]
+	 */
+	private function get_payment_tokens(): array {
+		if ( null === $this->payment_tokens ) {
+			$this->payment_tokens = $this->payment_token_repository->all_for_user_id( get_current_user_id() );
+		}
+
+		return $this->payment_tokens;
+	}
+
+	/**
+	 * Returns the vaulted PayPal email or empty string.
+	 *
+	 * @return string
+	 */
+	private function get_vaulted_paypal_email(): string {
+		try {
+			$tokens = $this->get_payment_tokens();
+
+			foreach ( $tokens as $token ) {
+				if ( isset( $token->source()->paypal ) ) {
+					return $token->source()->paypal->payer->email_address;
+				}
+			}
+		} catch ( Exception $exception ) {
+			$this->logger->error( 'Failed to get PayPal vaulted email. ' . $exception->getMessage() );
+		}
+		return '';
+	}
 }

modules/ppcp-button/src/ButtonModule.php

@@ -16,6 +16,7 @@ use WooCommerce\PayPalCommerce\Button\Endpoint\ApproveOrderEndpoint;
 use WooCommerce\PayPalCommerce\Button\Endpoint\ChangeCartEndpoint;
 use WooCommerce\PayPalCommerce\Button\Endpoint\CreateOrderEndpoint;
 use WooCommerce\PayPalCommerce\Button\Endpoint\DataClientIdEndpoint;
+use WooCommerce\PayPalCommerce\Button\Endpoint\StartPayPalVaultingEndpoint;
 use WooCommerce\PayPalCommerce\Button\Helper\EarlyOrderHandler;
 use Interop\Container\ServiceProviderInterface;
 use Psr\Container\ContainerInterface;
@@ -107,6 +108,15 @@ class ButtonModule implements ModuleInterface {
 				$endpoint->handle_request();
 			}
 		);
+		add_action(
+			'wc_ajax_' . StartPayPalVaultingEndpoint::ENDPOINT,
+			static function () use ( $container ) {
+				$endpoint = $container->get( 'button.endpoint.vault-paypal' );
+				assert( $endpoint instanceof StartPayPalVaultingEndpoint );
+
+				$endpoint->handle_request();
+			}
+		);
 
 		add_action(
 			'wc_ajax_' . ChangeCartEndpoint::ENDPOINT,

modules/ppcp-button/src/Endpoint/StartPayPalVaultingEndpoint.php

@@ -0,0 +1,110 @@
+<?php
+/**
+ * The endpoint for starting vaulting of PayPal account (for free trial).
+ *
+ * @package WooCommerce\PayPalCommerce\Button\Endpoint
+ */
+
+declare(strict_types=1);
+
+namespace WooCommerce\PayPalCommerce\Button\Endpoint;
+
+use Exception;
+use Psr\Log\LoggerInterface;
+use WooCommerce\PayPalCommerce\ApiClient\Endpoint\PaymentTokenEndpoint;
+use WooCommerce\PayPalCommerce\ApiClient\Exception\PayPalApiException;
+
+/**
+ * Class StartPayPalVaultingEndpoint.
+ */
+class StartPayPalVaultingEndpoint implements EndpointInterface {
+
+
+	const ENDPOINT = 'ppc-vault-paypal';
+
+	/**
+	 * The Request Data Helper.
+	 *
+	 * @var RequestData
+	 */
+	private $request_data;
+
+	/**
+	 * The PaymentTokenEndpoint.
+	 *
+	 * @var PaymentTokenEndpoint
+	 */
+	private $payment_token_endpoint;
+
+	/**
+	 * The logger.
+	 *
+	 * @var LoggerInterface
+	 */
+	private $logger;
+
+	/**
+	 * StartPayPalVaultingEndpoint constructor.
+	 *
+	 * @param RequestData          $request_data The Request Data Helper.
+	 * @param PaymentTokenEndpoint $payment_token_endpoint The PaymentTokenEndpoint.
+	 * @param LoggerInterface      $logger The logger.
+	 */
+	public function __construct(
+		RequestData $request_data,
+		PaymentTokenEndpoint $payment_token_endpoint,
+		LoggerInterface $logger
+	) {
+		$this->request_data           = $request_data;
+		$this->payment_token_endpoint = $payment_token_endpoint;
+		$this->logger                 = $logger;
+	}
+
+	/**
+	 * Returns the nonce.
+	 *
+	 * @return string
+	 */
+	public static function nonce(): string {
+		return self::ENDPOINT;
+	}
+
+	/**
+	 * Handles the request.
+	 *
+	 * @return bool
+	 */
+	public function handle_request(): bool {
+		try {
+			$data = $this->request_data->read_request( $this->nonce() );
+
+			$user_id = get_current_user_id();
+
+			$return_url = $data['return_url'];
+
+			$links = $this->payment_token_endpoint->start_paypal_token_creation(
+				$user_id,
+				$return_url,
+				$return_url
+			);
+
+			wp_send_json_success(
+				array(
+					'approve_link' => $links->approve_link(),
+				)
+			);
+
+			return true;
+		} catch ( Exception $error ) {
+			$this->logger->error( 'Failed to start PayPal vaulting: ' . $error->getMessage() );
+
+			wp_send_json_error(
+				array(
+					'name'    => is_a( $error, PayPalApiException::class ) ? $error->name() : '',
+					'message' => $error->getMessage(),
+				)
+			);
+			return false;
+		}
+	}
+}