Feature/var 591

Api/Config/ConfigInterface.php

@@ -28,6 +28,9 @@ interface ConfigInterface
     public const XML_PATH_GENERAL_CHECK_AVAILABLE_PAYMENT_METHODS = 'cm_payments/general/check_available_methods';
     public const XML_PATH_GENERAL_CUSTOM_SUCCESS_URL = 'cm_payments/general/custom_success_url';
     public const XML_PATH_GENERAL_CUSTOM_ERROR_URL = 'cm_payments/general/custom_error_url';
+    public const XML_PATH_GENERAL_SHIPPING_FEE_NAME = 'cm_payments/general/shipping_fee_name';
+    public const XML_PATH_GENERAL_ADJUSTMENT_FEE_NAME = 'cm_payments/general/adjustment_fee_name';
+    public const XML_PATH_PAYMENT_LOG_ALL_API_CALLS = 'cm_payments/general/log_all_calls';
     public const XML_PATH_PAYMENT_PROFILE = 'payment/cm_payments_methods/profile';
     public const XML_PATH_PAYMENT_CREDIT_CARD_PROFILE = 'payment/cm_payments_creditcard/profile';
     public const XML_PATH_PAYMENT_CREDIT_CARD_MODE = 'payment/cm_payments_creditcard/mode';
@@ -229,4 +232,19 @@ public function getCustomerSuccessUrl(): ?string;
      * @return string
      */
     public function getCustomerErrorUrl(): ?string;
+
+    /**
+     * @return string
+     */
+    public function getShippingFeeName(): ?string;
+
+    /**
+     * @return string
+     */
+    public function getAdjustmentFeeName(): ?string;
+
+    /**
+     * @return bool
+     */
+    public function isLogAllRestApiCalls(): bool;
 }

Client/ApiClient.php

@@ -11,6 +11,7 @@
 use CM\Payments\Api\Config\ConfigInterface;
 use CM\Payments\Client\Api\ApiClientInterface;
 use CM\Payments\Client\Api\RequestInterface;
+use CM\Payments\Logger\CMPaymentsLogger;
 use CM\Payments\Model\Adminhtml\Source\Mode;
 use GuzzleHttp\Client as HttpClient;
 use GuzzleHttp\Exception\GuzzleException;
@@ -34,15 +35,23 @@ class ApiClient implements ApiClientInterface
      */
     private $config;
 
+    /**
+     * @var CMPaymentsLogger
+     */
+    private CMPaymentsLogger $logger;
+
     /**
      * ApiClient constructor.
      *
+     * @param CMPaymentsLogger $logger
      * @param ConfigInterface $config
      */
     public function __construct(
-        ConfigInterface $config
+        ConfigInterface $config,
+        CMPaymentsLogger $logger
     ) {
         $this->config = $config;
+        $this->logger = $logger;
     }
 
     /**
@@ -74,6 +83,18 @@ public function execute(RequestInterface $request): array
             $response = \GuzzleHttp\json_decode($response, true);
         }
 
+        if ($this->config->isLogAllRestApiCalls()) {
+            $this->logger->debug(
+                'CM REST request:',
+                [
+                    'method' => $request->getRequestMethod(),
+                    'endpoint' => $request->getEndpoint(),
+                    'options' => \json_encode($options, JSON_PRETTY_PRINT),
+                    'response' => \json_encode($response, JSON_PRETTY_PRINT)
+                ]
+            );
+        }
+
         return $response;
     }
 

Config/Config.php

@@ -105,6 +105,43 @@ public function getCustomerErrorUrl(): ?string
         );
     }
 
+    /**
+     * @inheritDoc
+     */
+    public function getShippingFeeName(): ?string
+    {
+        return $this->getConfig(
+            self::XML_PATH_GENERAL_SHIPPING_FEE_NAME,
+            ScopeInterface::SCOPE_STORES,
+            (string)$this->storeManager->getStore()->getId()
+        );
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getAdjustmentFeeName(): ?string
+    {
+        return $this->getConfig(
+            self::XML_PATH_GENERAL_ADJUSTMENT_FEE_NAME,
+            ScopeInterface::SCOPE_STORES,
+            (string)$this->storeManager->getStore()->getId()
+        );
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function isLogAllRestApiCalls(): bool
+    {
+        return $this->getConfig(
+            self::XML_PATH_PAYMENT_LOG_ALL_API_CALLS,
+            ScopeInterface::SCOPE_STORES,
+            (string)$this->storeManager->getStore()->getId(),
+            true
+        );
+    }
+
     /**
      * @inheritDoc
      */

Service/Order/Item/AddOrderItemsAdjustmentService.php

@@ -8,6 +8,7 @@
 
 namespace CM\Payments\Service\Order\Item;
 
+use CM\Payments\Api\Config\ConfigInterface;
 use CM\Payments\Api\Service\Order\Item\AddOrderItemsAdjustmentServiceInterface;
 use CM\Payments\Client\Model\Request\OrderItemCreate;
 use CM\Payments\Client\Model\Request\OrderItemCreateFactory as ClientOrderItemCreateFactory;
@@ -29,15 +30,23 @@ class AddOrderItemsAdjustmentService implements AddOrderItemsAdjustmentServiceIn
      */
     private $clientOrderItemCreateFactory;
 
+    /**
+     * @var ConfigInterface
+     */
+    private ConfigInterface $config;
+
     /**
      * AddOrderItemsAdjustmentObserver constructor
      *
      * @param ClientOrderItemCreateFactory $clientOrderItemCreateFactory
+     * @param ConfigInterface $config
      */
     public function __construct(
-        ClientOrderItemCreateFactory $clientOrderItemCreateFactory
+        ClientOrderItemCreateFactory $clientOrderItemCreateFactory,
+        ConfigInterface $config
     ) {
         $this->clientOrderItemCreateFactory = $clientOrderItemCreateFactory;
+        $this->config = $config;
     }
 
     /**
@@ -63,8 +72,8 @@ public function execute(
             $orderItemCreate->setItemId(count($orderItemsCreateRequest->getPayload()) + 1);
             $orderItemCreate->setType(OrderItemsRequestBuilderInterface::TYPE_DISCOUNT);
             $orderItemCreate->setSku(OrderItemsRequestBuilderInterface::ITEM_ADJUSTMENT_FEE_SKU);
-            $orderItemCreate->setName(OrderItemsRequestBuilderInterface::ITEM_ADJUSTMENT_FEE_NAME);
-            $orderItemCreate->setDescription(OrderItemsRequestBuilderInterface::ITEM_ADJUSTMENT_FEE_NAME);
+            $orderItemCreate->setName($this->config->getAdjustmentFeeName());
+            $orderItemCreate->setDescription($this->config->getAdjustmentFeeName());
             $orderItemCreate->setQuantity(1);
             $orderItemCreate->setUnitAmount((int)round($difference));
             $orderItemCreate->setAmount((int)round($difference));

Service/OrderItemsRequestBuilder.php

@@ -8,6 +8,7 @@
 
 namespace CM\Payments\Service;
 
+use CM\Payments\Api\Config\ConfigInterface;
 use CM\Payments\Api\Service\Order\Item\Request\RequestPartByOrderItemInterface;
 use CM\Payments\Api\Service\Order\Item\Request\RequestPartByQuoteItemInterface;
 use CM\Payments\Api\Service\OrderItemsRequestBuilderInterface;
@@ -40,22 +41,30 @@ class OrderItemsRequestBuilder implements OrderItemsRequestBuilderInterface
      */
     private $quoteItemRequestParts;
 
+    /**
+     * @var ConfigInterface
+     */
+    private ConfigInterface $config;
+
     /**
      * OrderItemsRequestBuilder constructor
      *
      * @param ClientOrderItemCreateFactory $clientOrderItemCreateFactory
      * @param OrderItemsCreateRequestFactory $orderItemsCreateRequestFactory
+     * @param ConfigInterface $config
      * @param RequestPartByOrderItemInterface[] $orderItemRequestParts
      * @param RequestPartByQuoteItemInterface[] $quoteItemRequestParts
      */
     public function __construct(
         ClientOrderItemCreateFactory $clientOrderItemCreateFactory,
         OrderItemsCreateRequestFactory $orderItemsCreateRequestFactory,
+        ConfigInterface $config,
         array $orderItemRequestParts,
         array $quoteItemRequestParts
     ) {
         $this->clientOrderItemCreateFactory = $clientOrderItemCreateFactory;
         $this->orderItemsCreateRequestFactory = $orderItemsCreateRequestFactory;
+        $this->config = $config;
         $this->orderItemRequestParts = $orderItemRequestParts;
         $this->quoteItemRequestParts = $quoteItemRequestParts;
     }
@@ -79,9 +88,9 @@ public function create(string $orderKey, array $orderItems): OrderItemsCreateReq
         }
 
         return $this->orderItemsCreateRequestFactory->create([
-                                                                 'orderKey' => $orderKey,
-                                                                 'orderItems' => $orderItemsCreate
-                                                             ]);
+            'orderKey' => $orderKey,
+            'orderItems' => $orderItemsCreate
+        ]);
     }
 
     /**
@@ -103,8 +112,8 @@ private function addDynamicOrderItems(array $orderItems): array
                 $shippingItem->setIsVirtual(0);
                 $shippingItem->setItemId($lastItem[0]->getItemId() + 1);
                 $shippingItem->setSku(self::ITEM_SHIPPING_FEE_SKU);
-                $shippingItem->setName(self::ITEM_SHIPPING_FEE_NAME);
-                $shippingItem->setDescription(self::ITEM_SHIPPING_FEE_NAME);
+                $shippingItem->setName($this->config->getShippingFeeName());
+                $shippingItem->setDescription($this->config->getShippingFeeName());
                 $shippingItem->setQtyOrdered(1);
 
                 $orderItems[] = $shippingItem;
@@ -133,9 +142,9 @@ public function createByQuoteItems(string $orderKey, array $quoteItems): OrderIt
         }
 
         return $this->orderItemsCreateRequestFactory->create([
-                                                                 'orderKey' => $orderKey,
-                                                                 'orderItems' => $orderItemsCreate
-                                                             ]);
+            'orderKey' => $orderKey,
+            'orderItems' => $orderItemsCreate
+        ]);
     }
 
     /**
@@ -157,8 +166,8 @@ private function addDynamicQuoteItems(array $quoteItems): array
                 $shippingItem->setIsVirtual(0);
                 $shippingItem->setItemId($lastItem[0]->getItemId() + 1);
                 $shippingItem->setSku(self::ITEM_SHIPPING_FEE_SKU);
-                $shippingItem->setName(self::ITEM_SHIPPING_FEE_NAME);
-                $shippingItem->setDescription(self::ITEM_SHIPPING_FEE_NAME);
+                $shippingItem->setName($this->config->getShippingFeeName());
+                $shippingItem->setDescription($this->config->getShippingFeeName());
                 $shippingItem->setQty(1);
 
                 $quoteItems[] = $shippingItem;

Test/Integration/Service/Order/Item/AddOrderItemsAdjustmentServiceTest.php

@@ -153,8 +153,8 @@ private function getOrderItemCreate(int $unitAmount, int $amount, string $curren
         $orderItemCreate->setItemId(2);
         $orderItemCreate->setType(OrderItemsRequestBuilderInterface::TYPE_DISCOUNT);
         $orderItemCreate->setSku(OrderItemsRequestBuilderInterface::ITEM_ADJUSTMENT_FEE_SKU);
-        $orderItemCreate->setName(OrderItemsRequestBuilderInterface::ITEM_ADJUSTMENT_FEE_NAME);
-        $orderItemCreate->setDescription(OrderItemsRequestBuilderInterface::ITEM_ADJUSTMENT_FEE_NAME);
+        $orderItemCreate->setName('CM Adjustment Fee');
+        $orderItemCreate->setDescription('CM Adjustment Fee');
         $orderItemCreate->setQuantity(1);
         $orderItemCreate->setUnitAmount($unitAmount);
         $orderItemCreate->setAmount($amount);

etc/adminhtml/system.xml

@@ -59,6 +59,12 @@
                     <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
                     <config_path>cm_payments/general/check_available_methods</config_path>
                 </field>
+                <field id="log_all_calls" translate="label" type="select" sortOrder="40" showInDefault="1"
+                       showInWebsite="1" showInStore="1" canRestore="1">
+                    <label>Log all outgoing rest api calls</label>
+                    <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
+                    <config_path>cm_payments/general/log_all_calls</config_path>
+                </field>
             </group>
 
             <group id="api_details" translate="label" type="text" sortOrder="30" showInDefault="1" showInWebsite="1"
@@ -141,7 +147,21 @@
                     <label>Error Redirect Path</label>
                     <config_path>cm_payments/general/custom_error_url</config_path>
                 </field>
+            </group>
 
+            <group id="fee_labels" translate="label" type="text" sortOrder="50" showInDefault="1" showInWebsite="1"
+                   showInStore="1">
+                <label><![CDATA[Fee Labels]]></label>
+                <field id="shipping_fee_name" translate="label" type="text" sortOrder="1" showInDefault="1"
+                       showInWebsite="1" showInStore="1" canRestore="1">
+                    <label>Shipping Fee Name</label>
+                    <config_path>cm_payments/general/shipping_fee_name</config_path>
+                </field>
+                <field id="adjustment_fee_name" translate="label" type="text" sortOrder="2" showInDefault="1"
+                       showInWebsite="1" showInStore="1" canRestore="1">
+                    <label>Adjustment Fee Name</label>
+                    <config_path>cm_payments/general/adjustment_fee_name</config_path>
+                </field>
             </group>
         </section>
 

etc/config.xml

@@ -17,6 +17,9 @@
                 <live_merchant_password backend_model="Magento\Config\Model\Config\Backend\Encrypted" />
                 <update_on_result_page>1</update_on_result_page>
                 <check_available_methods>1</check_available_methods>
+                <shipping_fee_name>CM Shipping Fee</shipping_fee_name>
+                <adjustment_fee_name>CM Adjustment Fee</adjustment_fee_name>
+                <log_all_calls>0</log_all_calls>
             </general>
         </cm_payments>
         <payment>