Merge pull request #49 from pplotka/configurable-transaction-description

Make transaction description configurable.

Author: rafalmal

src/Action/CaptureAction.php

@@ -25,9 +25,11 @@
 use Payum\Core\Security\GenericTokenFactoryAwareInterface;
 use Payum\Core\Security\GenericTokenFactoryInterface;
 use Payum\Core\Security\TokenInterface;
+use Sylius\Bundle\PayumBundle\Provider\PaymentDescriptionProviderInterface;
 use Sylius\Component\Core\Model\CustomerInterface;
 use Sylius\Component\Core\Model\OrderInterface;
 use Sylius\Component\Core\Model\OrderItemInterface;
+use Sylius\Component\Core\Model\PaymentInterface;
 use Webmozart\Assert\Assert;
 
 final class CaptureAction implements ActionInterface, ApiAwareInterface, GenericTokenFactoryAwareInterface, GatewayAwareInterface
@@ -37,12 +39,18 @@ final class CaptureAction implements ActionInterface, ApiAwareInterface, Generic
     /** @var OpenPayUBridgeInterface */
     private $openPayUBridge;
 
+    /** @var PaymentDescriptionProviderInterface */
+    private $paymentDescriptionProvider;
+
     /** @var GenericTokenFactoryInterface */
     private $tokenFactory;
 
-    public function __construct(OpenPayUBridgeInterface $openPayUBridge)
-    {
+    public function __construct(
+        OpenPayUBridgeInterface $openPayUBridge,
+        PaymentDescriptionProviderInterface $paymentDescriptionProvider
+    ) {
         $this->openPayUBridge = $openPayUBridge;
+        $this->paymentDescriptionProvider = $paymentDescriptionProvider;
     }
 
     /**
@@ -67,12 +75,14 @@ public function execute($request): void
     {
         RequestNotSupportedException::assertSupports($this, $request);
         $model = $request->getModel();
+        /** @var PaymentInterface $payment */
+        $payment = $request->getFirstModel();
         /** @var OrderInterface $orderData */
-        $order = $request->getFirstModel()->getOrder();
+        $order = $payment->getOrder();
 
         /** @var TokenInterface $token */
         $token = $request->getToken();
-        $payUdata = $this->prepareOrder($token, $order);
+        $payUdata = $this->prepareOrder($token, $order, $payment);
 
         $result = $this->openPayUBridge->create($payUdata);
 
@@ -116,7 +126,7 @@ public function supports($request): bool
             && $request->getModel() instanceof ArrayObject;
     }
 
-    private function prepareOrder(TokenInterface $token, OrderInterface $order): array
+    private function prepareOrder(TokenInterface $token, OrderInterface $order, PaymentInterface $payment): array
     {
         $notifyToken = $this->tokenFactory->createNotifyToken($token->getGatewayName(), $token->getDetails());
         $payUdata = [];
@@ -125,7 +135,7 @@ private function prepareOrder(TokenInterface $token, OrderInterface $order): arr
         $payUdata['notifyUrl'] = $notifyToken->getTargetUrl();
         $payUdata['customerIp'] = $order->getCustomerIp();
         $payUdata['merchantPosId'] = OpenPayU_Configuration::getMerchantPosId();
-        $payUdata['description'] = $order->getNumber();
+        $payUdata['description'] = $this->paymentDescriptionProvider->getPaymentDescription($payment);
         $payUdata['currencyCode'] = $order->getCurrencyCode();
         $payUdata['totalAmount'] = $order->getTotal();
         /** @var CustomerInterface $customer */

src/Provider/PaymentDescriptionProvider.php

@@ -0,0 +1,24 @@
+<?php
+
+/*
+ * This file was created by developers working at BitBag
+ * Do you need more information about us and what we do? Visit our https://bitbag.io website!
+ * We are hiring developers from all over the world. Join us and start your new, exciting adventure and become part of us: https://bitbag.io/career
+*/
+
+declare(strict_types=1);
+
+namespace BitBag\SyliusPayUPlugin\Provider;
+
+use Sylius\Bundle\PayumBundle\Provider\PaymentDescriptionProviderInterface;
+use Sylius\Component\Core\Model\PaymentInterface;
+
+final class PaymentDescriptionProvider implements PaymentDescriptionProviderInterface
+{
+    public function getPaymentDescription(PaymentInterface $payment): string
+    {
+        $order = $payment->getOrder();
+
+        return $order->getNumber();
+    }
+}

src/Resources/config/services/action.xml

@@ -6,6 +6,7 @@
 
         <service id="bitbag.payu_plugin.action.capture" class="BitBag\SyliusPayUPlugin\Action\CaptureAction">
             <argument type="service" id="bitbag.payu_plugin.bridge.open_payu"/>
+            <argument type="service" id="bitbag.payu_plugin.provider.payment_description_provider"/>
             <tag name="payum.action" factory="payu" alias="payum.action.capture"/>
         </service>
 

src/Resources/config/services/provider.xml

@@ -0,0 +1,10 @@
+<container xmlns="http://symfony.com/schema/dic/services" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+           xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
+    <services>
+
+        <defaults public="true" autoconfigure="false" autowire="false"/>
+
+        <service id="bitbag.payu_plugin.provider.payment_description_provider" class="BitBag\SyliusPayUPlugin\Provider\PaymentDescriptionProvider">
+        </service>
+    </services>
+</container>

tests/spec/Action/CaptureActionSpec.php

@@ -21,15 +21,18 @@
 use Payum\Core\Request\Capture;
 use Payum\Core\Security\TokenInterface;
 use PhpSpec\ObjectBehavior;
+use Sylius\Bundle\PayumBundle\Provider\PaymentDescriptionProviderInterface;
 use Sylius\Component\Core\Model\CustomerInterface;
 use Sylius\Component\Core\Model\OrderInterface;
 use Sylius\Component\Core\Model\OrderItemInterface;
 
 final class CaptureActionSpec extends ObjectBehavior
 {
-    function let(OpenPayUBridgeInterface $openPayUBridge): void
-    {
-        $this->beConstructedWith($openPayUBridge);
+    function let(
+        OpenPayUBridgeInterface $openPayUBridge,
+        PaymentDescriptionProviderInterface $paymentDescriptionProvider
+    ): void {
+        $this->beConstructedWith($openPayUBridge, $paymentDescriptionProvider);
     }
 
     function it_is_initializable(): void