RPP - Payment request class for loading, sanitizing, and escaping data

changelog/rpp-6684-request-class

@@ -0,0 +1,4 @@
+Significance: minor
+Type: add
+
+Add payment request class for loading, sanitizing, and escaping data (reengineering payment process)

src/Internal/Payment/Request.php

@@ -0,0 +1,92 @@
+<?php
+/**
+ * Class Request
+ *
+ * @package WooCommerce\Payments
+ */
+
+namespace WCPay\Internal\Payment;
+
+/**
+ * Class for loading, sanitizing, and escaping data from payment requests.
+ */
+class Request {
+	/**
+	 * Request data.
+	 *
+	 * @var array
+	 */
+	private $request;
+
+	/**
+	 * The request array.
+	 *
+	 * @param  array|null $request  Request data, this can be $_POST, or WP_REST_Request::get_params().
+	 */
+	public function __construct( array $request = null ) {
+		// phpcs:ignore WordPress.Security.NonceVerification.Missing
+		$this->request = $request ?? $_POST;
+	}
+
+	/**
+	 * Get the fraud prevention token from the request.
+	 *
+	 * @return string|null
+	 */
+	public function get_fraud_prevention_token(): ?string {
+		return isset( $this->request['wcpay-fraud-prevention-token'] )
+			? sanitize_text_field( $this->request['wcpay-fraud-prevention-token'] )
+			: null;
+	}
+
+	/**
+	 * Check if the request is a WooPay preflight check.
+	 *
+	 * @return bool
+	 */
+	public function is_woopay_preflight_check(): bool {
+		return ! empty( $this->request['is-woopay-preflight-check'] );
+	}
+
+	/**
+	 * Gets the provided WooPay intent ID from POST, if any.
+	 *
+	 * @return ?string
+	 */
+	public function get_woopay_intent_id(): ?string {
+		return isset( $this->request['platform-checkout-intent'] )
+			? sanitize_text_field( $this->request['platform-checkout-intent'] )
+			: null;
+	}
+
+	/**
+	 * Gets the ID of an order from the request.
+	 *
+	 * @return int|null
+	 */
+	public function get_order_id(): ?int {
+		return isset( $this->request['order_id'] ) ? absint( $this->request['order_id'] ) : null;
+	}
+
+	/**
+	 * Gets intent ID if any.
+	 *
+	 * @return string|null
+	 */
+	public function get_intent_id(): ?string {
+		return isset( $this->request['intent_id'] )
+			? sanitize_text_field( $this->request['intent_id'] )
+			: null;
+	}
+
+	/**
+	 * Gets the ID of the provided payment method.
+	 *
+	 * @return string|null
+	 */
+	public function get_payment_method_id(): ?string {
+		return isset( $this->request['payment_method_id'] )
+			? sanitize_text_field( $this->request['payment_method_id'] )
+			: null;
+	}
+}

tests/unit/src/Internal/Payment/RequestTest.php

@@ -0,0 +1,132 @@
+<?php
+/**
+ * Class RequestTest
+ *
+ * @package WooCommerce\Payments
+ */
+
+namespace WCPay\Tests\Util;
+
+use WCPay\Internal\Payment\Request as PaymentRequest;
+use WCPAY_UnitTestCase;
+
+/**
+ * Tests for class PaymentRequestUtilTest
+ */
+class RequestTest extends WCPAY_UnitTestCase {
+	/**
+	 * System under test.
+	 *
+	 * @var PaymentRequest
+	 */
+	private $sut;
+
+	/**
+	 * @dataProvider provider_text_string_param
+	 */
+	public function test_get_fraud_prevention_token( ?string $value, ?string $expected ) {
+		$request   = is_null( $value ) ? [] : [ 'wcpay-fraud-prevention-token' => $value ];
+		$this->sut = new PaymentRequest( $request );
+		$this->assertSame( $expected, $this->sut->get_fraud_prevention_token() );
+	}
+
+	/**
+	 * @dataProvider provider_text_string_param
+	 */
+	public function test_get_woopay_intent_id( ?string $value, ?string $expected ) {
+		$request   = is_null( $value ) ? [] : [ 'platform-checkout-intent' => $value ];
+		$this->sut = new PaymentRequest( $request );
+		$this->assertSame( $expected, $this->sut->get_woopay_intent_id() );
+	}
+
+	/**
+	 * @dataProvider provider_text_string_param
+	 */
+	public function test_get_intent_id( ?string $value, ?string $expected ) {
+		$request   = is_null( $value ) ? [] : [ 'intent_id' => $value ];
+		$this->sut = new PaymentRequest( $request );
+		$this->assertSame( $expected, $this->sut->get_intent_id() );
+	}
+
+	/**
+	 * @dataProvider provider_text_string_param
+	 */
+	public function test_get_payment_method_id( ?string $value, ?string $expected ) {
+		$request   = is_null( $value ) ? [] : [ 'payment_method_id' => $value ];
+		$this->sut = new PaymentRequest( $request );
+		$this->assertSame( $expected, $this->sut->get_payment_method_id() );
+	}
+
+	public function provider_text_string_param(): array {
+		return [
+			'Param is not set'                          => [
+				'value'    => null,
+				'expected' => null,
+			],
+			'empty string'                              => [
+				'value'    => '',
+				'expected' => '',
+			],
+			'normal string'                             => [
+				'value'    => 'String-with-dash_and_underscore',
+				'expected' => 'String-with-dash_and_underscore',
+			],
+			'string will be changed after sanitization' => [
+				'value'    => " \n<tag>String-with_special_chars__@.#$%^&*()",
+				'expected' => 'String-with_special_chars__@.#$%^&*()',
+			],
+		];
+	}
+
+	public function provider_text_string_for_bool_representation(): array {
+		return [
+			'Param is not set' => [
+				'value'    => null,
+				'expected' => false,
+			],
+			'empty string'     => [
+				'value'    => '',
+				'expected' => false,
+			],
+			'any string'       => [
+				'value'    => 'any string',
+				'expected' => true,
+			],
+		];
+	}
+
+	/**
+	 * @dataProvider provider_text_string_for_bool_representation
+	 */
+	public function test_is_woopay_preflight_check( ?string $value, bool $expected ) {
+		$request   = is_null( $value ) ? [] : [ 'is-woopay-preflight-check' => $value ];
+		$this->sut = new PaymentRequest( $request );
+		$this->assertSame( $expected, $this->sut->is_woopay_preflight_check() );
+	}
+
+	/**
+	 * @dataProvider provider_test_order_id
+	 */
+	public function test_get_order_id( ?string $value, ?int $expected ) {
+		$request   = is_null( $value ) ? [] : [ 'order_id' => $value ];
+		$this->sut = new PaymentRequest( $request );
+		$this->assertSame( $expected, $this->sut->get_order_id() );
+	}
+
+	public function provider_test_order_id(): array {
+		return [
+			'Param is not set'     => [
+				'value'    => null,
+				'expected' => null,
+			],
+			'normal id'            => [
+				'value'    => '123',
+				'expected' => 123,
+			],
+			'id will be sanitized' => [
+				'value'    => '123abc',
+				'expected' => 123,
+			],
+		];
+	}
+}