CMP-41 - Code improvements, bug fixing

Author: Ivan Tagil

Controller/Adminhtml/Action/CheckApiConnection.php

@@ -8,14 +8,13 @@
 
 namespace CM\Payments\Controller\Adminhtml\Action;
 
-use CM\Payments\Api\Service\ApiTestServiceInterfaceFactory;
 use CM\Payments\Api\Service\ApiTestServiceInterface;
+use GuzzleHttp\Exception\GuzzleException;
 use Magento\Backend\App\Action;
 use Magento\Backend\App\Action\Context;
 use Magento\Framework\Controller\Result\Json as JsonResult;
 use Magento\Framework\Controller\Result\JsonFactory as JsonResultFactory;
 use Magento\Framework\Exception\NoSuchEntityException;
-use GuzzleHttp\Exception\GuzzleException;
 
 class CheckApiConnection extends Action
 {
@@ -25,26 +24,26 @@ class CheckApiConnection extends Action
     private $jsonResultFactory;
 
     /**
-     * @var ApiTestServiceInterfaceFactory
+     * @var ApiTestServiceInterface
      */
-    private $apiTestServiceFactory;
+    private $apiTestService;
 
     /**
      * CheckApiConnection constructor
      *
      * @param Context $context
      * @param JsonResultFactory $jsonResultFactory
-     * @param ApiTestServiceInterfaceFactory $apiTestServiceFactory
+     * @param ApiTestServiceInterface $apiTestService
      */
     public function __construct(
         Context $context,
         JsonResultFactory $jsonResultFactory,
-        ApiTestServiceInterfaceFactory $apiTestServiceFactory
+        ApiTestServiceInterface $apiTestService
     ) {
         parent::__construct($context);
 
         $this->jsonResultFactory = $jsonResultFactory;
-        $this->apiTestServiceFactory = $apiTestServiceFactory;
+        $this->apiTestService = $apiTestService;
     }
 
     /**
@@ -54,79 +53,35 @@ public function execute(): JsonResult
     {
         /** @var JsonResult $jsonResult */
         $jsonResult = $this->jsonResultFactory->create();
+        $success = true;
 
-        $apiConnectionData = $this->getRequest()->getParams();
-        $errors = $this->validateData($apiConnectionData);
-
-        if (!$errors) {
-            $success = true;
+        try {
+            $resultData = $this->apiTestService->testApiConnection();
 
-            try {
-                /** @var ApiTestServiceInterface $apiTestService */
-                $apiTestService = $this->apiTestServiceFactory->create(
-                    [
-                        'apiConnectionData' => [
-                            'mode' => $apiConnectionData['mode'],
-                            'merchantName' => $apiConnectionData['merchant_name'],
-                            'merchantPassword' => $apiConnectionData['merchant_password'],
-                            'merchantKey' => $apiConnectionData['merchant_key']
-                        ]
-                    ]
-                );
-
-                $result = $apiTestService->testApiConnection();
-
-                if (!is_array($result)) {
-                    $data = [
-                        'success' => false,
-                        'connectionResult' => __("The connection was unsuccessful. Please, check your credentials.")
-                    ];
-                } else {
-                    $data = [
-                        'success' => $success,
-                        'connectionResult' => __("The connection was successful. Your credentials are valid.")
-                    ];
-                }
-            } catch (GuzzleException|NoSuchEntityException $e) {
+            if (!empty($resultData['errors'])) {
+                array_unshift($resultData['errors'], __("The connection was unsuccessful."));
+                $data = [
+                    'success' => false,
+                    'connectionResult' => implode('<br />', $resultData['errors'])
+                ];
+            } elseif (!is_array($resultData['result'])) {
                 $data = [
                     'success' => false,
-                    'connectionResult' => $e->getMessage()
+                    'connectionResult' => __("The connection was unsuccessful. Please, check your credentials.")
+                ];
+            } else {
+                $data = [
+                    'success' => $success,
+                    'connectionResult' => __("The connection was successful. Your credentials are valid.")
                 ];
             }
-        } else {
-            array_unshift($errors, __("The connection was unsuccessful."));
+        } catch (GuzzleException | NoSuchEntityException $e) {
             $data = [
                 'success' => false,
-                'connectionResult' => implode('<br />', $errors)
+                'connectionResult' => $e->getMessage()
             ];
         }
 
         return $jsonResult->setData(['result' => $data]);
     }
-
-    /**
-     * @param array $apiConnectionData
-     * @return array
-     */
-    private function validateData(array $apiConnectionData): array
-    {
-        $errors = [];
-        if (empty($apiConnectionData['mode'])) {
-            $errors[] = __("The 'Api mode' was not recognized. Please, check the data.");
-        }
-
-        if (empty($apiConnectionData['merchant_name'])) {
-            $errors[] = __("The 'Merchant Name' was not recognized. Please, check the data.");
-        }
-
-        if (empty($apiConnectionData['merchant_password'])) {
-            $errors[] = __("The 'Merchant Password' was not recognized. Please, check the data.");
-        }
-
-        if (empty($apiConnectionData['merchant_key'])) {
-            $errors[] = __("The 'Merchant Key' was not recognized. Please, check the data.");
-        }
-
-        return $errors;
-    }
 }

Service/ApiTestService.php

@@ -13,6 +13,8 @@
 use CM\Payments\Client\ApiClient;
 use CM\Payments\Model\Adminhtml\Source\Mode;
 use GuzzleHttp\Client as HttpClient;
+use CM\Payments\Api\Config\ConfigInterface;
+use Magento\Framework\Exception\NoSuchEntityException;
 
 class ApiTestService implements ApiTestServiceInterface
 {
@@ -21,33 +23,59 @@ class ApiTestService implements ApiTestServiceInterface
      */
     private $apiConnectionData;
 
+    /**
+     * @var ConfigInterface
+     */
+    private $config;
+
     /**
      * ApiTestService constructor
      *
-     * @param array $apiConnectionData
+     * @param ConfigInterface $config
      */
     public function __construct(
-        array $apiConnectionData
+        ConfigInterface $config
     ) {
-        $this->apiConnectionData = $apiConnectionData;
+        $this->config = $config;
+
+        try {
+            $this->apiConnectionData = [
+                'mode' => $this->config->getMode(),
+                'merchantName' => $this->config->getMerchantName(),
+                'merchantPassword' => $this->config->getMerchantPassword(),
+                'merchantKey' => $this->config->getMerchantKey()
+            ];
+        } catch (NoSuchEntityException $e) {
+            $this->apiConnectionData = [];
+        }
     }
 
     /**
      * @inheritDoc
      */
     public function testApiConnection(): array
     {
+        $resultData = ['errors' => [], 'result' => null];
         $options = [
             'json' => ['date' => date('Y-m-d')]
         ];
 
-        $guzzleResponse = $this->getClient()->request(
-            RequestInterface::HTTP_GET,
-            'orders',
-            $options
-        );
+        if (!empty($this->apiConnectionData)) {
+            $errors = $this->validateData($this->apiConnectionData);
+            $resultData['errors'] = $errors;
 
-        return \GuzzleHttp\json_decode($guzzleResponse->getBody()->getContents(), true);
+            if (empty($errors)) {
+                $guzzleResponse = $this->getClient()->request(
+                    RequestInterface::HTTP_GET,
+                    'orders',
+                    $options
+                );
+
+                $resultData['result'] = \GuzzleHttp\json_decode($guzzleResponse->getBody()->getContents(), true);
+            }
+        }
+
+        return $resultData;
     }
 
     /**
@@ -62,6 +90,7 @@ private function getClient(): HttpClient
             $this->apiConnectionData['merchantName'] .
                 ':' . $this->apiConnectionData['merchantPassword']
         );
+
         return new HttpClient(
             [
                 'base_uri' => $baseApiUrl,
@@ -71,4 +100,29 @@ private function getClient(): HttpClient
             ]
         );
     }
+
+    /**
+     * @return array
+     */
+    private function validateData(): array
+    {
+        $errors = [];
+        if (empty($this->apiConnectionData['mode'])) {
+            $errors[] = __("The 'Api mode' was not recognized. Please, check the data.");
+        }
+
+        if (empty($this->apiConnectionData['merchantName'])) {
+            $errors[] = __("The 'Merchant Name' was not recognized. Please, check the data.");
+        }
+
+        if (empty($this->apiConnectionData['merchantPassword'])) {
+            $errors[] = __("The 'Merchant Password' was not recognized. Please, check the data.");
+        }
+
+        if (empty($this->apiConnectionData['merchantKey'])) {
+            $errors[] = __("The 'Merchant Key' was not recognized. Please, check the data.");
+        }
+
+        return $errors;
+    }
 }

view/adminhtml/templates/system/config/button/check_api_connection.phtml

@@ -25,8 +25,6 @@
                 "сmpayments-check-api-connection": {
                     "component": "CM_Payments/js/system/action/check-api-connection",
                     "config": {
-                        "wrapperContainerSelector": ".cmpayments-result-check-api-connection-wrapper",
-                        "modeContainerSelector": "#cm_payments_general_api_details_mode",
                         "checkApiConnectionUrl": "<?= $escaper->escapeUrl($block->getApiConnectionCheckUrl()) ?>",
                         "resultContainerSelector": ".cmpayments-check-api-connection-result"
                     }

view/adminhtml/web/js/system/action/api-details-config.js

@@ -32,7 +32,7 @@ define([
          */
         changeApiDetailsMode: function () {
             let modeContainerId = $(this).closest('tr').attr('id'),
-                parentTable = $(this).parents().find('table'),
+                parentTable = $(this).closest('table'),
                 mode = $(this).val();
             parentTable.find('tr').each(function () {
                 let containerId = $(this).attr('id');