[EM-390] Enhance Magento plugin to support FPX (#287)

* [EM-390] Enhance Magento plugin to support FPX * [EM-390] removed unused code and refactor * [EM-390] fix lint * [EM-390] fix lint * [EM-390] fix lint * handle errors. show error message * fix select list style * chancge FPXDataAssignObserver to FpxDataAssignObserver and some frontend validation * change "If set to specific" to "If not set to all"
omise · Jun 8, 2021 · 99ce2b3 · 99ce2b3
1 parent 934ae23
commit 99ce2b3
Show file tree

Hide file tree

Showing 42 changed files with 498 additions and 130 deletions.
diff --git a/Controller/Callback/Offsite.php b/Controller/Callback/Offsite.php
@@ -14,6 +14,7 @@
 use Omise\Payment\Model\Config\Pointsciti;
 use Omise\Payment\Model\Config\Installment;
 use Omise\Payment\Model\Config\Truemoney;
+use Omise\Payment\Model\Config\Fpx;
 use Magento\Framework\Exception\LocalizedException;
 
 class Offsite extends Action
@@ -96,7 +97,8 @@ public function execute()
                 Internetbanking::CODE,
                 Installment::CODE,
                 Truemoney::CODE,
-                Pointsciti::CODE
+                Pointsciti::CODE,
+                Fpx::CODE
             ]
         )) {
             $this->invalid(
@@ -173,6 +175,9 @@ public function execute()
                     case Pointsciti::CODE:
                         $dispPaymentMethod = "Citi Pay with Points";
                         break;
+                    case Fpx::CODE:
+                        $dispPaymentMethod = "FPX";
+                        break;
                 }
 
                 // Add transaction.

diff --git a/Gateway/Request/APMBuilder.php b/Gateway/Request/APMBuilder.php
@@ -7,6 +7,7 @@
 
 use Omise\Payment\Model\Config\Alipay;
 use Omise\Payment\Model\Config\Conveniencestore;
+use Omise\Payment\Model\Config\Fpx;
 use Omise\Payment\Model\Config\Pointsciti;
 use Omise\Payment\Model\Config\Internetbanking;
 use Omise\Payment\Model\Config\Installment;
@@ -16,6 +17,7 @@
 use Omise\Payment\Model\Config\Truemoney;
 
 use Omise\Payment\Observer\ConveniencestoreDataAssignObserver;
+use Omise\Payment\Observer\FpxDataAssignObserver;
 use Omise\Payment\Observer\InstallmentDataAssignObserver;
 use Omise\Payment\Observer\InternetbankingDataAssignObserver;
 use Omise\Payment\Observer\TruemoneyDataAssignObserver;
@@ -33,6 +35,11 @@ class APMBuilder implements BuilderInterface
      */
     const SOURCE_TYPE = 'type';
 
+    /**
+     * @var string
+     */
+    const BANK = 'bank';
+
     /**
      * @var string
      */
@@ -147,6 +154,14 @@ public function build(array $buildSubject)
                     self::SOURCE_TYPE => 'points_citi'
                 ];
                 break;
+            case Fpx::CODE:
+                $paymentInfo[self::SOURCE] = [
+                    self::SOURCE_TYPE => 'fpx',
+                    self::BANK => $method->getAdditionalInformation(
+                        FpxDataAssignObserver::BANK
+                    )
+                ];
+                break;
         }
 
         return $paymentInfo;

diff --git a/Model/Api/Capabilities.php b/Model/Api/Capabilities.php
@@ -40,4 +40,15 @@ public function isZeroInterest()
     {
         return $this->capabilities ? $this->capabilities['zero_interest_installments'] : false;
     }
+
+    /**
+     * @param string $type
+     * @return array|null
+     */
+    public function getBackendsByType(string $type)
+    {
+        return $this->capabilities ? $this->capabilities->getBackends(
+            $this->capabilities->makeBackendFilterType($type)
+        ) : null;
+    }
 }
diff --git a/Model/Capabilities.php b/Model/Capabilities.php
@@ -43,4 +43,13 @@ public function isZeroInterest()
     {
         return $this->capabilitiesAPI->isZeroInterest();
     }
+
+    /**
+     * @param string $type
+     * @return array|null
+     */
+    public function getBackendsByType(string $type)
+    {
+        return $this->capabilitiesAPI->getBackendsByType($type);
+    }
 }
diff --git a/Model/Config/Fpx.php b/Model/Config/Fpx.php
@@ -0,0 +1,13 @@
+<?php
+
+namespace Omise\Payment\Model\Config;
+
+use Omise\Payment\Model\Config\Config;
+
+class Fpx extends Config
+{
+
+    const CODE = 'omise_offsite_fpx';
+
+    const TYPE = 'fpx';
+}
diff --git a/Model/Ui/CapabilitiesConfigProvider.php b/Model/Ui/CapabilitiesConfigProvider.php
@@ -5,6 +5,7 @@
 use Magento\Payment\Api\PaymentMethodListInterface;
 use Magento\Store\Model\StoreManagerInterface;
 use Omise\Payment\Model\Capabilities;
+use Omise\Payment\Model\Config\Fpx;
 use Omise\Payment\Model\Config\Installment as OmiseInstallmentConfig;
 
 class CapabilitiesConfigProvider implements ConfigProviderInterface
@@ -34,14 +35,20 @@ public function __construct(
     public function getConfig()
     {
         $listOfActivePaymentMethods = $this->_paymentLists->getActiveList($this->_storeManager->getStore()->getId());
+        $configs = [];
         foreach ($listOfActivePaymentMethods as $method) {
-            if ($method->getCode() === OmiseInstallmentConfig::CODE) {
-                return [
-                    'installment_backends' => $this->capabilities->retrieveInstallmentBackends(),
-                    'is_zero_interest' => $this->capabilities->isZeroInterest()
-                ];
+            switch ($method->getCode()) {
+                case OmiseInstallmentConfig::CODE:
+                    $configs['installment_backends'] = $this->capabilities->retrieveInstallmentBackends();
+                    $configs['is_zero_interest'] = $this->capabilities->isZeroInterest();
+                    break;
+                case Fpx::CODE:
+                    $backendsFpx = $this->capabilities->getBackendsByType(Fpx::TYPE);
+                    $configs['fpx']['banks'] = $backendsFpx ? current($backendsFpx)->banks : [];
+                    break;
             }
         }
-        return [];
+
+        return $configs;
     }
 }
diff --git a/Observer/ConveniencestoreDataAssignObserver.php b/Observer/ConveniencestoreDataAssignObserver.php
@@ -5,7 +5,7 @@
 use Magento\Payment\Observer\AbstractDataAssignObserver;
 use Magento\Quote\Api\Data\PaymentInterface;
 
-class ConveniencestoreDataAssignObserver extends AbstractDataAssignObserver
+class ConveniencestoreDataAssignObserver extends OffsiteDataAssignObserver
 {
     /**
      * @var string
@@ -22,29 +22,4 @@ class ConveniencestoreDataAssignObserver extends AbstractDataAssignObserver
         self::EMAIL,
         self::CUSTOMER_NAME
     ];
-
-    /**
-     * @param \Magento\Framework\Event\Observer $observer
-     */
-    public function execute(Observer $observer)
-    {
-        $dataObject = $this->readDataArgument($observer);
-
-        $additionalData = $dataObject->getData(PaymentInterface::KEY_ADDITIONAL_DATA);
-
-        if (! is_array($additionalData)) {
-            return;
-        }
-
-        $paymentInfo = $this->readPaymentModelArgument($observer);
-
-        foreach ($this->additionalInformationList as $additionalInformationKey) {
-            if (isset($additionalData[$additionalInformationKey])) {
-                $paymentInfo->setAdditionalInformation(
-                    $additionalInformationKey,
-                    $additionalData[$additionalInformationKey]
-                );
-            }
-        }
-    }
 }
diff --git a/Observer/FpxDataAssignObserver.php b/Observer/FpxDataAssignObserver.php
@@ -0,0 +1,18 @@
+<?php
+
+namespace Omise\Payment\Observer;
+
+class FpxDataAssignObserver extends OffsiteDataAssignObserver
+{
+    /**
+     * @var string
+     */
+    const BANK   = 'bank';
+
+    /**
+     * @var array
+     */
+    protected $additionalInformationList = [
+        self::BANK
+    ];
+}
diff --git a/Observer/InstallmentDataAssignObserver.php b/Observer/InstallmentDataAssignObserver.php
@@ -5,7 +5,7 @@
 use Magento\Payment\Observer\AbstractDataAssignObserver;
 use Magento\Quote\Api\Data\PaymentInterface;
 
-class InstallmentDataAssignObserver extends AbstractDataAssignObserver
+class InstallmentDataAssignObserver extends OffsiteDataAssignObserver
 {
     /**
      * @var string
@@ -24,29 +24,4 @@ class InstallmentDataAssignObserver extends AbstractDataAssignObserver
         self::OFFSITE,
         self::TERMS
     ];
-
-    /**
-     * @param \Magento\Framework\Event\Observer $observer
-     */
-    public function execute(Observer $observer)
-    {
-        $dataObject = $this->readDataArgument($observer);
-
-        $additionalData = $dataObject->getData(PaymentInterface::KEY_ADDITIONAL_DATA);
-
-        if (! is_array($additionalData)) {
-            return;
-        }
-
-        $paymentInfo = $this->readPaymentModelArgument($observer);
-
-        foreach ($this->additionalInformationList as $additionalInformationKey) {
-            if (isset($additionalData[$additionalInformationKey])) {
-                $paymentInfo->setAdditionalInformation(
-                    $additionalInformationKey,
-                    $additionalData[$additionalInformationKey]
-                );
-            }
-        }
-    }
 }
diff --git a/Observer/InternetbankingDataAssignObserver.php b/Observer/InternetbankingDataAssignObserver.php
@@ -5,7 +5,7 @@
 use Magento\Payment\Observer\AbstractDataAssignObserver;
 use Magento\Quote\Api\Data\PaymentInterface;
 
-class InternetbankingDataAssignObserver extends AbstractDataAssignObserver
+class InternetbankingDataAssignObserver extends OffsiteDataAssignObserver
 {
     /**
      * @var string
@@ -18,29 +18,4 @@ class InternetbankingDataAssignObserver extends AbstractDataAssignObserver
     protected $additionalInformationList = [
         self::OFFSITE
     ];
-
-    /**
-     * @param \Magento\Framework\Event\Observer $observer
-     */
-    public function execute(Observer $observer)
-    {
-        $dataObject = $this->readDataArgument($observer);
-
-        $additionalData = $dataObject->getData(PaymentInterface::KEY_ADDITIONAL_DATA);
-
-        if (! is_array($additionalData)) {
-            return;
-        }
-
-        $paymentInfo = $this->readPaymentModelArgument($observer);
-
-        foreach ($this->additionalInformationList as $additionalInformationKey) {
-            if (isset($additionalData[$additionalInformationKey])) {
-                $paymentInfo->setAdditionalInformation(
-                    $additionalInformationKey,
-                    $additionalData[$additionalInformationKey]
-                );
-            }
-        }
-    }
 }
diff --git a/Observer/OffsiteDataAssignObserver.php b/Observer/OffsiteDataAssignObserver.php
@@ -0,0 +1,40 @@
+<?php
+
+namespace Omise\Payment\Observer;
+
+use Magento\Framework\Event\Observer;
+use Magento\Payment\Observer\AbstractDataAssignObserver;
+use Magento\Quote\Api\Data\PaymentInterface;
+
+class OffsiteDataAssignObserver extends AbstractDataAssignObserver
+{
+    /**
+     * @var array
+     */
+    protected $additionalInformationList = [];
+
+    /**
+     * @param \Magento\Framework\Event\Observer $observer
+     */
+    public function execute(Observer $observer)
+    {
+        $dataObject = $this->readDataArgument($observer);
+
+        $additionalData = $dataObject->getData(PaymentInterface::KEY_ADDITIONAL_DATA);
+
+        if (!is_array($additionalData)) {
+            return;
+        }
+
+        $paymentInfo = $this->readPaymentModelArgument($observer);
+
+        foreach ($this->additionalInformationList as $additionalInformationKey) {
+            if (isset($additionalData[$additionalInformationKey])) {
+                $paymentInfo->setAdditionalInformation(
+                    $additionalInformationKey,
+                    $additionalData[$additionalInformationKey]
+                );
+            }
+        }
+    }
+}
diff --git a/Observer/TruemoneyDataAssignObserver.php b/Observer/TruemoneyDataAssignObserver.php
@@ -5,7 +5,7 @@
 use Magento\Payment\Observer\AbstractDataAssignObserver;
 use Magento\Quote\Api\Data\PaymentInterface;
 
-class TruemoneyDataAssignObserver extends AbstractDataAssignObserver
+class TruemoneyDataAssignObserver extends OffsiteDataAssignObserver
 {
     /**
      * @var string
@@ -18,29 +18,4 @@ class TruemoneyDataAssignObserver extends AbstractDataAssignObserver
     protected $additionalInformationList = [
         self::PHONE_NUMBER
     ];
-
-    /**
-     * @param \Magento\Framework\Event\Observer $observer
-     */
-    public function execute(Observer $observer)
-    {
-        $dataObject = $this->readDataArgument($observer);
-
-        $additionalData = $dataObject->getData(PaymentInterface::KEY_ADDITIONAL_DATA);
-
-        if (! is_array($additionalData)) {
-            return;
-        }
-
-        $paymentInfo = $this->readPaymentModelArgument($observer);
-
-        foreach ($this->additionalInformationList as $additionalInformationKey) {
-            if (isset($additionalData[$additionalInformationKey])) {
-                $paymentInfo->setAdditionalInformation(
-                    $additionalInformationKey,
-                    $additionalData[$additionalInformationKey]
-                );
-            }
-        }
-    }
 }