Add wechat pay (#434)

* Implemented WeChat Pay.

* Added tests

* Added tests for get_client_ip

* Add missing require of wechat in omise-woocommerce.

---------

Co-authored-by: Aashish <aashish@omise.co>

includes/class-omise-callback.php

@@ -31,15 +31,14 @@ public static function execute()
 		$order_id = isset( $_GET['order_id'] ) ? sanitize_text_field( $_GET['order_id'] ) : null;
 		$order = wc_get_order( $order_id );
 
-		if(!RequestHelper::validateRequest($order->get_meta('token'))) {
+		if(!RequestHelper::validate_request($order->get_meta('token'))) {
 			return wp_redirect( wc_get_checkout_url() );
 		}
 
 		$callback = new self( $order );
 		$callback->validate();
 	}
 
-
 	/**
 	 * Sometimes cancelling a transaction does not updates the status on the Omise backend
 	 * which causes the status to be pending even thought the transaction was cancelled.

includes/class-omise-payment-factory.php

@@ -41,7 +41,8 @@ class Omise_Payment_Factory {
 		'Omise_Payment_DuitNow_QR',
 		'Omise_Payment_DuitNow_OBW',
 		'Omise_Payment_Atome',
-		'Omise_Payment_PayPay'
+		'Omise_Payment_PayPay',
+		'Omise_Payment_Wechat_Pay',
 	);
 
 	/**

includes/gateway/class-omise-payment-wechat-pay.php

@@ -0,0 +1,83 @@
+<?php
+defined( 'ABSPATH' ) or die( 'No direct script access allowed.' );
+
+class Omise_Payment_Wechat_Pay extends Omise_Payment_Offsite
+{
+	public function __construct()
+	{
+		parent::__construct();
+
+		$this->id                 = 'omise_wechat_pay';
+		$this->has_fields         = true;
+		$this->method_title       = __( 'Opn Payments WeChat Pay', 'omise' );
+		$this->method_description = wp_kses(
+			__( 'Accept payment through <strong>WeChat Pay</strong> via Opn Payments payment gateway.', 'omise' ),
+			['strong' => []]
+		);
+
+		$this->init_form_fields();
+		$this->init_settings();
+
+		$this->title                = $this->get_option( 'title' );
+		$this->description          = $this->get_option( 'description' );
+		$this->restricted_countries = [ 'TH' ];
+		$this->source_type = 'wechat_pay';
+
+		add_action( 'woocommerce_api_' . $this->id . '_callback', 'Omise_Callback::execute' );
+		add_action( 'woocommerce_update_options_payment_gateways_' . $this->id, array( $this, 'process_admin_options' ) );
+		add_action( 'woocommerce_order_action_' . $this->id . '_sync_payment', array( $this, 'sync_payment' ) );
+	}
+
+    /**
+	 * @see WC_Settings_API::init_form_fields()
+	 * @see woocommerce/includes/abstracts/abstract-wc-settings-api.php
+	 */
+	public function init_form_fields()
+	{
+		$this->form_fields = array(
+			'enabled' => array(
+				'title'   => __('Enable/Disable', 'omise'),
+				'type'    => 'checkbox',
+				'label'   => __('Enable Opn Payments WeChat Pay', 'omise'),
+				'default' => 'no'
+			),
+
+			'title' => array(
+				'title'       => __('Title', 'omise'),
+				'type'        => 'text',
+				'description' => __('This controls the title the user sees during checkout.', 'omise'),
+				'default'     => __('WeChat Pay', 'omise'),
+			),
+
+			'description' => array(
+				'title'       => __('Description', 'omise'),
+				'type'        => 'textarea',
+				'description' => __('This controls the description the user sees during checkout.', 'omise')
+			),
+		);
+	}
+
+    /**
+	 * Get icons
+	 *
+	 * @see WC_Payment_Gateway::get_icon()
+	 */
+	public function get_icon()
+    {
+		$icon = Omise_Image::get_image([
+			'file' => 'wechat_pay.svg',
+			'alternate_text' => 'WeChat Pay',
+		]);
+
+		return apply_filters('woocommerce_gateway_icon', $icon, $this->id);
+	}
+
+	public function charge($order_id, $order)
+	{
+		$requestData = $this->build_charge_request(
+			$order_id, $order, $this->source_type, $this->id . "_callback"
+		);
+		$requestData['source']['ip'] = RequestHelper::get_client_ip();
+		return OmiseCharge::create($requestData);
+	}
+}

includes/libraries/omise-plugin/helpers/request.php

@@ -1,5 +1,5 @@
 <?php
-if (! class_exists('RequestHelper')) {
+if (!class_exists('RequestHelper')) {
     class RequestHelper
     {
         /**
@@ -9,7 +9,7 @@ class RequestHelper
          * 
          * Ref: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Sec-Fetch-Site
          */
-        public static function isUserOriginated()
+        public static function is_user_originated()
         {
             $fetch_site = sanitize_text_field($_SERVER['HTTP_SEC_FETCH_SITE']);
 
@@ -20,17 +20,58 @@ public static function isUserOriginated()
         /**
          * @param string|null $order_token
          */
-        public static function validateRequest($order_token = null)
+        public static function validate_request($order_token = null)
         {
-            $token = isset( $_GET['token'] ) ? sanitize_text_field( $_GET['token'] ) : null;
+            $token = isset($_GET['token']) ? sanitize_text_field($_GET['token']) : null;
 
             // For all payment except offline and OCBC PAO.
             if ($token) {
                 return $token === $order_token;
             }
 
             // For offline payment methods does not include token in the return URI.
-            return !self::isUserOriginated();
+            return !self::is_user_originated();
+        }
+
+        public static function get_client_ip()
+        {
+            $headersToCheck = [
+                // Check for a client using a shared internet connection
+                'HTTP_CLIENT_IP',
+
+                // Check if the proxy is used for IP/IPs
+                'HTTP_X_FORWARDED_FOR',
+
+                // check for other possible forwarded IP headers
+                'HTTP_X_FORWARDED',
+                'HTTP_FORWARDED_FOR',
+                'HTTP_FORWARDED',
+            ];
+
+            foreach($headersToCheck as $header) {
+                if (empty($_SERVER[$header])) {
+                    continue;
+                }
+
+                if ($header === 'HTTP_X_FORWARDED_FOR') {
+                    return self::process_forwarded_for_header($_SERVER[$header]);
+                }
+
+                return $_SERVER[$header];
+            }
+
+            // return default remote IP address
+            return $_SERVER['REMOTE_ADDR'];
+        }
+
+        private static function process_forwarded_for_header($forwardedForHeader)
+        {
+            // Split if multiple IP addresses exist and get the last IP address
+            if (strpos($forwardedForHeader, ',') !== false) {
+                $multiple_ips = explode(",", $forwardedForHeader);
+                return trim(current($multiple_ips));
+            }
+            return $forwardedForHeader;
         }
     }
 }

omise-woocommerce.php

@@ -224,6 +224,7 @@ private function include_classes()
 		require_once OMISE_WOOCOMMERCE_PLUGIN_PATH . '/includes/gateway/class-omise-payment.php';
 		require_once OMISE_WOOCOMMERCE_PLUGIN_PATH . '/includes/gateway/class-omise-payment-atome.php';
 		require_once OMISE_WOOCOMMERCE_PLUGIN_PATH . '/includes/gateway/class-omise-payment-paypay.php';
+		require_once OMISE_WOOCOMMERCE_PLUGIN_PATH . '/includes/gateway/class-omise-payment-wechat-pay.php';
 		require_once OMISE_WOOCOMMERCE_PLUGIN_PATH . '/includes/libraries/omise-php/lib/Omise.php';
 		require_once OMISE_WOOCOMMERCE_PLUGIN_PATH . '/includes/libraries/omise-plugin/Omise.php';
 		require_once OMISE_WOOCOMMERCE_PLUGIN_PATH . '/includes/class-omise-ajax-actions.php';

phpunit.xml

@@ -24,4 +24,12 @@
             <directory suffix=".php">vendor</directory>
         </exclude>
     </coverage>
+	<php>
+		<server name="HTTP_CLIENT_IP" value="192.168.1.1"/>
+		<server name="HTTP_X_FORWARDED_FOR" value="192.168.1.2"/>
+		<server name="HTTP_X_FORWARDED" value="192.168.1.3"/>
+		<server name="HTTP_FORWARDED_FOR" value="192.168.1.4"/>
+		<server name="HTTP_FORWARDED" value="192.168.1.5"/>
+		<server name="REMOTE_ADDR" value="192.168.1.6"/>
+	</php>
 </phpunit>

tests/unit/includes/gateway/bootstrap-test-setup.php

@@ -2,7 +2,6 @@
 
 use PHPUnit\Framework\TestCase;
 
-
 abstract class Bootstrap_Test_Setup extends TestCase
 {
     public $sourceType;

tests/unit/includes/gateway/class-omise-payment-wechat-pay-test.php

@@ -0,0 +1,48 @@
+<?php
+
+require_once __DIR__ . '/class-omise-offsite-test.php';
+
+class Omise_Payment_Wechat_Pay_Test extends Omise_Offsite_Test
+{
+    public function setUp(): void
+    {
+        parent::setUp();
+        $this->sourceType = 'wechat_pay';
+
+        Brain\Monkey\setUp();
+        Brain\Monkey\Functions\stubs([
+            'apply_filters' => function () {
+                return Omise_Image::get_image([
+                    'file' => 'wechat_pay.svg',
+                    'alternate_text' => 'WeChat Pay',
+                ]);
+            },
+        ]);
+
+        require_once __DIR__ . '/../../../../includes/libraries/omise-plugin/helpers/request.php';
+        require_once __DIR__ . '/../../../../includes/gateway/class-omise-payment-wechat-pay.php';
+    }
+
+    public function test_restricted_countries_field_has_required_countries()
+    {
+        $obj = new Omise_Payment_Wechat_Pay();
+        $expectedCountries = ['TH'];
+
+        $this->assertEqualsCanonicalizing($expectedCountries, $obj->restricted_countries);
+        unset($expectedCountries);
+    }
+
+    public function test_charge()
+    {
+        $obj = new Omise_Payment_Wechat_Pay();
+        $this->getChargeTest($obj);
+    }
+
+    public function test_get_icon()
+    {
+        $obj = new Omise_Payment_Wechat_Pay();
+        $res = $obj->get_icon();
+        $expected = "<img src='/wechat_pay.svg' class='Omise-Image' style='width: 30px; max-height: 30px;' alt='WeChat Pay' />";
+        $this->assertEquals($expected, trim($res));
+    }
+}

tests/unit/includes/libraries/omise-plugin/helpers/request-test.php

@@ -0,0 +1,51 @@
+<?php
+
+use PHPUnit\Framework\TestCase;
+
+class RequestHelperTest extends TestCase
+{
+    public function setUp(): void
+    {
+        require_once __DIR__ . '/../../../../../../includes/libraries/omise-plugin/helpers/request.php';
+    }
+
+    /**
+     * @dataProvider get_client_ip_data_provider
+     * @covers RequestHelper
+     */
+    public function test_get_client_ip($serverArrKeyToTest)
+    {
+        $ipHeaderKeys = [
+            'HTTP_CLIENT_IP',
+            'HTTP_X_FORWARDED_FOR',
+            'HTTP_X_FORWARDED',
+            'HTTP_FORWARDED_FOR',
+            'HTTP_FORWARDED',
+            'REMOTE_ADDR',
+        ];
+
+        foreach($ipHeaderKeys as $ipHeaderKey) {
+            if ($ipHeaderKey !== $serverArrKeyToTest) {
+                $_SERVER[$ipHeaderKey] = null;
+            }
+        }
+
+        $res = RequestHelper::get_client_ip();
+        $this->assertEquals($_SERVER[$serverArrKeyToTest], $res);
+    }
+
+    /**
+	 * Data provider for toSubunitReturnCorrectFormat
+	 */
+	public function get_client_ip_data_provider()
+	{
+        return [
+            ['HTTP_CLIENT_IP'],
+            ['HTTP_X_FORWARDED_FOR'],
+            ['HTTP_X_FORWARDED'],
+            ['HTTP_FORWARDED_FOR'],
+            ['HTTP_FORWARDED'],
+            ['REMOTE_ADDR'],
+        ];
+    }
+}