ACP-2626 Refactoring after CR.

spryker · Jul 8, 2024 · f59dd43 · f59dd43
1 parent 411a547
commit f59dd43
Show file tree

Hide file tree

Showing 21 changed files with 220 additions and 220 deletions.
diff --git a/resources/api/openapi.yml b/resources/api/openapi.yml
@@ -232,10 +232,10 @@ components:
                     description: 'ID of a previous made transfer, passed to make a reverse transfer.'
                 merchantReference:
                     type: string
-                    description: 'UUID of the merchant.'
+                    description: 'ID of the merchant.'
                 orderReference:
                     type: string
-                    description: 'UUID of the sales order.'
+                    description: 'ID of the sales order.'
                 itemReference:
                     type: string
                     description: 'UUID of the sales order item.'

diff --git a/src/Spryker/Glue/AppPaymentBackendApi/Controller/PaymentsTransfersResourceController.php b/src/Spryker/Glue/AppPaymentBackendApi/Controller/PaymentsTransfersResourceController.php
@@ -18,9 +18,9 @@ class PaymentsTransfersResourceController extends AbstractController
 {
     public function postAction(GlueRequestTransfer $glueRequestTransfer): GlueResponseTransfer
     {
-        $paymentsTransmissionsRequestTransfer = $this->getFactory()->createGlueRequestPaymentMapper()->mapGlueRequestTransferToPaymentsTransmissionsRequestTransfer($glueRequestTransfer);
-        $paymentsTransmissionsResponseTransfer = $this->getFactory()->getAppPaymentFacade()->transferPayments($paymentsTransmissionsRequestTransfer);
+        $paymentTransmissionsRequestTransfer = $this->getFactory()->createGlueRequestPaymentMapper()->mapGlueRequestTransferToPaymentTransmissionsRequestTransfer($glueRequestTransfer);
+        $paymentTransmissionsResponseTransfer = $this->getFactory()->getAppPaymentFacade()->transferPayments($paymentTransmissionsRequestTransfer);
 
-        return $this->getFactory()->createGlueResponsePaymentMapper()->mapPaymentsTransmissionsResponseTransferToSingleResourceGlueResponseTransfer($paymentsTransmissionsResponseTransfer);
+        return $this->getFactory()->createGlueResponsePaymentMapper()->mapPaymentTransmissionsResponseTransferToSingleResourceGlueResponseTransfer($paymentTransmissionsResponseTransfer);
     }
 }
diff --git a/...e/AppPaymentBackendApi/Dependency/Facade/AppPaymentBackendApiToAppPaymentFacadeBridge.php b/...e/AppPaymentBackendApi/Dependency/Facade/AppPaymentBackendApiToAppPaymentFacadeBridge.php
@@ -11,8 +11,8 @@
 use Generated\Shared\Transfer\GlueRequestValidationTransfer;
 use Generated\Shared\Transfer\InitializePaymentRequestTransfer;
 use Generated\Shared\Transfer\InitializePaymentResponseTransfer;
-use Generated\Shared\Transfer\PaymentsTransmissionsRequestTransfer;
-use Generated\Shared\Transfer\PaymentsTransmissionsResponseTransfer;
+use Generated\Shared\Transfer\PaymentTransmissionsRequestTransfer;
+use Generated\Shared\Transfer\PaymentTransmissionsResponseTransfer;
 
 class AppPaymentBackendApiToAppPaymentFacadeBridge implements AppPaymentBackendApiToAppPaymentFacadeInterface
 {
@@ -39,8 +39,8 @@ public function validatePaymentConfiguration(GlueRequestTransfer $glueRequestTra
         return $this->appPaymentFacade->validatePaymentConfiguration($glueRequestTransfer);
     }
 
-    public function transferPayments(PaymentsTransmissionsRequestTransfer $paymentsTransmissionsRequestTransfer): PaymentsTransmissionsResponseTransfer
+    public function transferPayments(PaymentTransmissionsRequestTransfer $paymentTransmissionsRequestTransfer): PaymentTransmissionsResponseTransfer
     {
-        return $this->appPaymentFacade->transferPayments($paymentsTransmissionsRequestTransfer);
+        return $this->appPaymentFacade->transferPayments($paymentTransmissionsRequestTransfer);
     }
 }
diff --git a/...ppPaymentBackendApi/Dependency/Facade/AppPaymentBackendApiToAppPaymentFacadeInterface.php b/...ppPaymentBackendApi/Dependency/Facade/AppPaymentBackendApiToAppPaymentFacadeInterface.php
@@ -11,14 +11,14 @@
 use Generated\Shared\Transfer\GlueRequestValidationTransfer;
 use Generated\Shared\Transfer\InitializePaymentRequestTransfer;
 use Generated\Shared\Transfer\InitializePaymentResponseTransfer;
-use Generated\Shared\Transfer\PaymentsTransmissionsRequestTransfer;
-use Generated\Shared\Transfer\PaymentsTransmissionsResponseTransfer;
+use Generated\Shared\Transfer\PaymentTransmissionsRequestTransfer;
+use Generated\Shared\Transfer\PaymentTransmissionsResponseTransfer;
 
 interface AppPaymentBackendApiToAppPaymentFacadeInterface
 {
     public function initializePayment(InitializePaymentRequestTransfer $initializePaymentRequestTransfer): InitializePaymentResponseTransfer;
 
     public function validatePaymentConfiguration(GlueRequestTransfer $glueRequestTransfer): GlueRequestValidationTransfer;
 
-    public function transferPayments(PaymentsTransmissionsRequestTransfer $paymentsTransmissionsRequestTransfer): PaymentsTransmissionsResponseTransfer;
+    public function transferPayments(PaymentTransmissionsRequestTransfer $paymentTransmissionsRequestTransfer): PaymentTransmissionsResponseTransfer;
 }
diff --git a/src/Spryker/Glue/AppPaymentBackendApi/Mapper/Payment/GlueRequestPaymentMapper.php b/src/Spryker/Glue/AppPaymentBackendApi/Mapper/Payment/GlueRequestPaymentMapper.php
@@ -9,7 +9,7 @@
 
 use Generated\Shared\Transfer\GlueRequestTransfer;
 use Generated\Shared\Transfer\InitializePaymentRequestTransfer;
-use Generated\Shared\Transfer\PaymentsTransmissionsRequestTransfer;
+use Generated\Shared\Transfer\PaymentTransmissionsRequestTransfer;
 use GuzzleHttp\RequestOptions;
 
 class GlueRequestPaymentMapper implements GlueRequestPaymentMapperInterface
@@ -31,18 +31,18 @@ public function mapGlueRequestTransferToInitializePaymentRequestTransfer(
         return $initializePaymentRequestTransfer;
     }
 
-    public function mapGlueRequestTransferToPaymentsTransmissionsRequestTransfer(
+    public function mapGlueRequestTransferToPaymentTransmissionsRequestTransfer(
         GlueRequestTransfer $glueRequestTransfer
-    ): PaymentsTransmissionsRequestTransfer {
+    ): PaymentTransmissionsRequestTransfer {
         $metaData = $glueRequestTransfer->getMeta();
 
         /** @phpstan-var array<string, mixed> */
         $requestData = json_decode((string)$glueRequestTransfer->getContent(), true);
 
-        $paymentsTransmissionsRequestTransfer = new PaymentsTransmissionsRequestTransfer();
-        $paymentsTransmissionsRequestTransfer->fromArray($requestData, true);
-        $paymentsTransmissionsRequestTransfer->setTenantIdentifier($metaData[static::HEADER_TENANT_IDENTIFIER][0] ?? ($metaData['x-store-reference'][0] ?? ''));
+        $paymentTransmissionsRequestTransfer = new PaymentTransmissionsRequestTransfer();
+        $paymentTransmissionsRequestTransfer->fromArray($requestData, true);
+        $paymentTransmissionsRequestTransfer->setTenantIdentifier($metaData[static::HEADER_TENANT_IDENTIFIER][0] ?? ($metaData['x-store-reference'][0] ?? ''));
 
-        return $paymentsTransmissionsRequestTransfer;
+        return $paymentTransmissionsRequestTransfer;
     }
 }
diff --git a/src/Spryker/Glue/AppPaymentBackendApi/Mapper/Payment/GlueRequestPaymentMapperInterface.php b/src/Spryker/Glue/AppPaymentBackendApi/Mapper/Payment/GlueRequestPaymentMapperInterface.php
@@ -9,15 +9,15 @@
 
 use Generated\Shared\Transfer\GlueRequestTransfer;
 use Generated\Shared\Transfer\InitializePaymentRequestTransfer;
-use Generated\Shared\Transfer\PaymentsTransmissionsRequestTransfer;
+use Generated\Shared\Transfer\PaymentTransmissionsRequestTransfer;
 
 interface GlueRequestPaymentMapperInterface
 {
     public function mapGlueRequestTransferToInitializePaymentRequestTransfer(
         GlueRequestTransfer $glueRequestTransfer
     ): InitializePaymentRequestTransfer;
 
-    public function mapGlueRequestTransferToPaymentsTransmissionsRequestTransfer(
+    public function mapGlueRequestTransferToPaymentTransmissionsRequestTransfer(
         GlueRequestTransfer $glueRequestTransfer
-    ): PaymentsTransmissionsRequestTransfer;
+    ): PaymentTransmissionsRequestTransfer;
 }
diff --git a/src/Spryker/Glue/AppPaymentBackendApi/Mapper/Payment/GlueResponsePaymentMapper.php b/src/Spryker/Glue/AppPaymentBackendApi/Mapper/Payment/GlueResponsePaymentMapper.php
@@ -12,7 +12,7 @@
 use Generated\Shared\Transfer\GlueResourceTransfer;
 use Generated\Shared\Transfer\GlueResponseTransfer;
 use Generated\Shared\Transfer\InitializePaymentResponseTransfer;
-use Generated\Shared\Transfer\PaymentsTransmissionsResponseTransfer;
+use Generated\Shared\Transfer\PaymentTransmissionsResponseTransfer;
 use Symfony\Component\HttpFoundation\Response;
 
 class GlueResponsePaymentMapper implements GlueResponsePaymentMapperInterface
@@ -25,15 +25,15 @@ public function mapInitializePaymentResponseTransferToSingleResourceGlueResponse
         return $this->addInitializePaymentResponseTransferToGlueResponse($initializePaymentResponseTransfer, $glueResponseTransfer);
     }
 
-    public function mapPaymentsTransmissionsResponseTransferToSingleResourceGlueResponseTransfer(
-        PaymentsTransmissionsResponseTransfer $paymentsTransmissionsResponseTransfer
+    public function mapPaymentTransmissionsResponseTransferToSingleResourceGlueResponseTransfer(
+        PaymentTransmissionsResponseTransfer $paymentTransmissionsResponseTransfer
     ): GlueResponseTransfer {
         $glueResponseTransfer = new GlueResponseTransfer();
 
-        if ($paymentsTransmissionsResponseTransfer->getIsSuccessful() === false) {
+        if ($paymentTransmissionsResponseTransfer->getIsSuccessful() === false) {
             $glueResponseTransfer->setHttpStatus(Response::HTTP_BAD_REQUEST);
             $glueResponseTransfer->addError((new GlueErrorTransfer())->setMessage(
-                $paymentsTransmissionsResponseTransfer->getMessageOrFail(),
+                $paymentTransmissionsResponseTransfer->getMessageOrFail(),
             ));
 
             return $glueResponseTransfer;
@@ -44,7 +44,7 @@ public function mapPaymentsTransmissionsResponseTransferToSingleResourceGlueResp
 
         $glueResponseTransfer->setHttpStatus(Response::HTTP_OK);
         $glueResponseTransfer->addResource($glueResourceTransfer);
-        $glueResponseTransfer->setContent($this->generateTransfersResponseContent($paymentsTransmissionsResponseTransfer));
+        $glueResponseTransfer->setContent($this->generateTransfersResponseContent($paymentTransmissionsResponseTransfer));
 
         return $glueResponseTransfer;
     }
@@ -63,21 +63,21 @@ protected function addInitializePaymentResponseTransferToGlueResponse(
         return $glueResponseTransfer;
     }
 
-    protected function generateTransfersResponseContent(PaymentsTransmissionsResponseTransfer $paymentsTransmissionsResponseTransfer): string
+    protected function generateTransfersResponseContent(PaymentTransmissionsResponseTransfer $paymentTransmissionsResponseTransfer): string
     {
         $responseContent = [
             'transfers' => [],
         ];
 
-        foreach ($paymentsTransmissionsResponseTransfer->getPaymentsTransmissions() as $paymentsTransmission) {
+        foreach ($paymentTransmissionsResponseTransfer->getPaymentTransmissions() as $paymentTransmission) {
             $responseContent['transfers'][] = [
-                'isSuccessful' => $paymentsTransmission->getIsSuccessful(),
-                'failureMessage' => $paymentsTransmission->getMessage(),
-                'merchantReference' => $paymentsTransmission->getMerchantReference(),
-                'orderReference' => $paymentsTransmission->getOrderReference(),
-                'orderItems' => $this->formatOrderItemsForTransferResponse($paymentsTransmission->getOrderItems()),
-                'amount' => $paymentsTransmission->getAmount(),
-                'transferId' => $paymentsTransmission->getTransferId(), // Return the transfer identifier as transaction id to be known on the Tenant side. May be empty in case oif a failure
+                'isSuccessful' => $paymentTransmission->getIsSuccessful(),
+                'failureMessage' => $paymentTransmission->getMessage(),
+                'merchantReference' => $paymentTransmission->getMerchantReference(),
+                'orderReference' => $paymentTransmission->getOrderReference(),
+                'orderItems' => $this->formatOrderItemsForTransferResponse($paymentTransmission->getOrderItems()),
+                'amount' => $paymentTransmission->getAmount(),
+                'transferId' => $paymentTransmission->getTransferId(), // Return the transfer identifier as transaction id to be known on the Tenant side. May be empty in case oif a failure
             ];
         }
 

diff --git a/src/Spryker/Glue/AppPaymentBackendApi/Mapper/Payment/GlueResponsePaymentMapperInterface.php b/src/Spryker/Glue/AppPaymentBackendApi/Mapper/Payment/GlueResponsePaymentMapperInterface.php
@@ -9,15 +9,15 @@
 
 use Generated\Shared\Transfer\GlueResponseTransfer;
 use Generated\Shared\Transfer\InitializePaymentResponseTransfer;
-use Generated\Shared\Transfer\PaymentsTransmissionsResponseTransfer;
+use Generated\Shared\Transfer\PaymentTransmissionsResponseTransfer;
 
 interface GlueResponsePaymentMapperInterface
 {
     public function mapInitializePaymentResponseTransferToSingleResourceGlueResponseTransfer(
         InitializePaymentResponseTransfer $initializePaymentResponseTransfer
     ): GlueResponseTransfer;
 
-    public function mapPaymentsTransmissionsResponseTransferToSingleResourceGlueResponseTransfer(
-        PaymentsTransmissionsResponseTransfer $paymentsTransmissionsResponseTransfer
+    public function mapPaymentTransmissionsResponseTransferToSingleResourceGlueResponseTransfer(
+        PaymentTransmissionsResponseTransfer $paymentTransmissionsResponseTransfer
     ): GlueResponseTransfer;
 }
diff --git a/src/Spryker/Shared/AppPayment/Transfer/app_payment.transfer.xml b/src/Spryker/Shared/AppPayment/Transfer/app_payment.transfer.xml
@@ -304,20 +304,20 @@
         <property name="tenantIdentifier" type="string"/>
     </transfer>
 
-    <transfer name="PaymentsTransmissionsRequest" strict="true">
+    <transfer name="PaymentTransmissionsRequest" strict="true">
         <property name="appConfig" type="AppConfig"/>
         <property name="tenantIdentifier" type="string"/>
         <property name="transactionId" type="string"/>
         <property name="transferId" type="string"/>
         <property name="orderItems" type="OrderItem[]" singular="orderItem"/>
-        <property name="paymentsTransmissions" type="PaymentTransmission[]" singular="paymentTransmission"/>
-        <property name="failedPaymentsTransmissions" type="PaymentTransmission[]" singular="failedPaymentTransmission"/>
+        <property name="paymentTransmissions" type="PaymentTransmission[]" singular="paymentTransmission"/>
+        <property name="failedPaymentTransmissions" type="PaymentTransmission[]" singular="failedPaymentTransmission"/>
     </transfer>
 
-    <transfer name="PaymentsTransmissionsResponse" strict="true">
+    <transfer name="PaymentTransmissionsResponse" strict="true">
         <property name="isSuccessful" type="bool"/>
         <property name="message" type="string"/>
-        <property name="paymentsTransmissions" type="PaymentTransmission[]" singular="paymentTransmission"/>
+        <property name="paymentTransmissions" type="PaymentTransmission[]" singular="paymentTransmission"/>
     </transfer>
 
 </transfers>
diff --git a/src/Spryker/Shared/AppPaymentBackendApi/Transfer/app_payment_backend_api.transfer.xml b/src/Spryker/Shared/AppPaymentBackendApi/Transfer/app_payment_backend_api.transfer.xml
@@ -7,13 +7,13 @@
     <transfer name="InitializePaymentResponse" strict="true">
     </transfer>
 
-    <transfer name="PaymentsTransmissionsRequest" strict="true">
+    <transfer name="PaymentTransmissionsRequest" strict="true">
         <property name="appConfig" type="AppConfig"/>
         <property name="tenantIdentifier" type="string"/>
         <property name="transactionId" type="string"/>
         <property name="transferId" type="string"/>
         <property name="orderItems" type="OrderItem[]" singular="orderItem"/>
-        <property name="paymentsTransmissions" type="PaymentTransmission[]" singular="paymentTransmission"/>
+        <property name="paymentTransmissions" type="PaymentTransmission[]" singular="paymentTransmission"/>
     </transfer>
 
     <transfer name="OrderItem" strict="true">
@@ -24,9 +24,9 @@
         <property name="amount" type="string" description="Amount in lowest denominator (cents, YEN). When negative money has to be refunded, when positive money has to be transferred."/>
     </transfer>
 
-    <transfer name="PaymentsTransmissionsResponse" strict="true">
+    <transfer name="PaymentTransmissionsResponse" strict="true">
         <property name="message" type="string"/>
-        <property name="paymentsTransmissions" type="PaymentTransmission[]" singular="paymentTransmission"/>
+        <property name="paymentTransmissions" type="PaymentTransmission[]" singular="paymentTransmission"/>
     </transfer>
 
     <transfer name="PaymentTransmission" strict="true">

diff --git a/src/Spryker/Zed/AppPayment/AppPaymentDependencyProvider.php b/src/Spryker/Zed/AppPayment/AppPaymentDependencyProvider.php
@@ -19,8 +19,8 @@
 use Generated\Shared\Transfer\PaymentPageResponseTransfer;
 use Generated\Shared\Transfer\PaymentStatusRequestTransfer;
 use Generated\Shared\Transfer\PaymentStatusResponseTransfer;
-use Generated\Shared\Transfer\PaymentsTransmissionsRequestTransfer;
-use Generated\Shared\Transfer\PaymentsTransmissionsResponseTransfer;
+use Generated\Shared\Transfer\PaymentTransmissionsRequestTransfer;
+use Generated\Shared\Transfer\PaymentTransmissionsResponseTransfer;
 use Generated\Shared\Transfer\RefundPaymentRequestTransfer;
 use Generated\Shared\Transfer\RefundPaymentResponseTransfer;
 use Generated\Shared\Transfer\WebhookRequestTransfer;
@@ -139,9 +139,9 @@ public function getPaymentPage(PaymentPageRequestTransfer $paymentPageRequestTra
                 return (new PaymentPageResponseTransfer())->setIsSuccessful(true);
             }
 
-            public function transferPayments(PaymentsTransmissionsRequestTransfer $paymentsTransmissionsRequestTransfer): PaymentsTransmissionsResponseTransfer
+            public function transferPayments(PaymentTransmissionsRequestTransfer $paymentTransmissionsRequestTransfer): PaymentTransmissionsResponseTransfer
             {
-                return (new PaymentsTransmissionsResponseTransfer())->setIsSuccessful(true);
+                return (new PaymentTransmissionsResponseTransfer())->setIsSuccessful(true);
             }
         };
         // @codeCoverageIgnoreEnd
@@ -184,7 +184,7 @@ protected function addPaymentsTransmissionRequestExtenderPlugins(Container $cont
     }
 
     /**
-     * @return array<\Spryker\Zed\AppPayment\Dependency\Plugin\PaymentsTransmissionsRequestExtenderPluginInterface>
+     * @return array<\Spryker\Zed\AppPayment\Dependency\Plugin\PaymentTransmissionsRequestExtenderPluginInterface>
      */
     protected function getPaymentsTransmissionRequestExtenderPlugins(): array
     {

diff --git a/src/Spryker/Zed/AppPayment/Business/AppPaymentBusinessFactory.php b/src/Spryker/Zed/AppPayment/Business/AppPaymentBusinessFactory.php
@@ -77,7 +77,7 @@ public function createPaymentTransfer(): PaymentTransfer
             $this->getRepository(),
             $this->getConfig(),
             $this->createAppConfigLoader(),
-            $this->getPaymentsTransmissionsRequestExtenderPlugins(),
+            $this->getPaymentTransmissionsRequestExtenderPlugins(),
         );
     }
 
@@ -139,11 +139,11 @@ public function createWebhookMessageSender(): WebhookMessageSender
     }
 
     /**
-     * @return array<\Spryker\Zed\AppPayment\Dependency\Plugin\PaymentsTransmissionsRequestExtenderPluginInterface>
+     * @return array<\Spryker\Zed\AppPayment\Dependency\Plugin\PaymentTransmissionsRequestExtenderPluginInterface>
      */
-    protected function getPaymentsTransmissionsRequestExtenderPlugins(): array
+    protected function getPaymentTransmissionsRequestExtenderPlugins(): array
     {
-        /** @phpstan-var array<\Spryker\Zed\AppPayment\Dependency\Plugin\PaymentsTransmissionsRequestExtenderPluginInterface> */
+        /** @phpstan-var array<\Spryker\Zed\AppPayment\Dependency\Plugin\PaymentTransmissionsRequestExtenderPluginInterface> */
         return $this->getProvidedDependency(AppPaymentDependencyProvider::PLUGINS_PAYMENTS_TRANSMISSIONS_REQUEST_EXPANDER);
     }
 

diff --git a/src/Spryker/Zed/AppPayment/Business/AppPaymentFacade.php b/src/Spryker/Zed/AppPayment/Business/AppPaymentFacade.php
@@ -17,8 +17,8 @@
 use Generated\Shared\Transfer\PaymentCollectionDeleteCriteriaTransfer;
 use Generated\Shared\Transfer\PaymentPageRequestTransfer;
 use Generated\Shared\Transfer\PaymentPageResponseTransfer;
-use Generated\Shared\Transfer\PaymentsTransmissionsRequestTransfer;
-use Generated\Shared\Transfer\PaymentsTransmissionsResponseTransfer;
+use Generated\Shared\Transfer\PaymentTransmissionsRequestTransfer;
+use Generated\Shared\Transfer\PaymentTransmissionsResponseTransfer;
 use Generated\Shared\Transfer\RedirectRequestTransfer;
 use Generated\Shared\Transfer\RedirectResponseTransfer;
 use Generated\Shared\Transfer\RefundPaymentTransfer;
@@ -144,8 +144,8 @@ public function deletePaymentCollection(
         $this->getEntityManager()->deletePaymentCollection($paymentCollectionDeleteCriteriaTransfer);
     }
 
-    public function transferPayments(PaymentsTransmissionsRequestTransfer $paymentsTransmissionsRequestTransfer): PaymentsTransmissionsResponseTransfer
+    public function transferPayments(PaymentTransmissionsRequestTransfer $paymentTransmissionsRequestTransfer): PaymentTransmissionsResponseTransfer
     {
-        return $this->getFactory()->createPayment()->transferPayments($paymentsTransmissionsRequestTransfer);
+        return $this->getFactory()->createPayment()->transferPayments($paymentTransmissionsRequestTransfer);
     }
 }