Introduce a separate gateway config for Pay-by-Link payment method

CommerceWeavers · Nov 20, 2024 · fda22c7 · fda22c7
1 parent f9bda50
commit fda22c7
Show file tree

Hide file tree

Showing 19 changed files with 131 additions and 50 deletions.
diff --git a/config/config/sylius_fixtures.php b/config/config/sylius_fixtures.php
@@ -110,9 +110,9 @@
                 'pbl' => [
                     'code' => 'tpay_pbl',
                     'name' => 'Pay by Link (Tpay)',
-                    'gatewayFactory' => 'tpay',
-                    'gatewayName' => 'tpay',
-                    'gatewayConfig' => $tpayConfig + ['type' => PaymentType::PAY_BY_LINK],
+                    'gatewayFactory' => 'tpay_pbl',
+                    'gatewayName' => 'tpay_pbl',
+                    'gatewayConfig' => $tpayConfig,
                     'channels' => [
                         'FASHION_WEB',
                     ],

diff --git a/config/services/pay_by_link_payment/form.php b/config/services/pay_by_link_payment/form.php
@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Symfony\Component\DependencyInjection\Loader\Configurator;
+
+return static function(ContainerConfigurator $container): void {
+    $container->import('form/**/*.php');
+};
diff --git a/config/services/pay_by_link_payment/form/type.php b/config/services/pay_by_link_payment/form/type.php
@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Symfony\Component\DependencyInjection\Loader\Configurator;
+
+
+use CommerceWeavers\SyliusTpayPlugin\PayByLinkPayment\Form\Type\GatewayConfigurationType;
+use CommerceWeavers\SyliusTpayPlugin\PayByLinkPayment\Payum\Factory\GatewayFactory;
+
+return static function(ContainerConfigurator $container): void {
+    $services = $container->services();
+
+    $services->set('commerce_weavers_sylius_tpay.pay_by_link_payment.form.type.gateway_configuration', GatewayConfigurationType::class)
+        ->parent('commerce_weavers_sylius_tpay.form.type.abstract_tpay_gateway_configuration')
+        ->tag('sylius.gateway_configuration_type', ['label' => 'commerce_weavers_sylius_tpay.admin.gateway_name.tpay_pbl', 'type' => GatewayFactory::NAME])
+        ->tag('form.type')
+    ;
+};
diff --git a/config/services/pay_by_link_payment/payum/action.php b/config/services/pay_by_link_payment/payum/action.php
@@ -6,7 +6,7 @@
 
 use CommerceWeavers\SyliusTpayPlugin\PayByLinkPayment\Payum\Action\CreatePayByLinkTransactionAction;
 use CommerceWeavers\SyliusTpayPlugin\PayByLinkPayment\Payum\Action\GetTpayTransactionsChannelsAction;
-use CommerceWeavers\SyliusTpayPlugin\Payum\Factory\TpayGatewayFactory;
+use CommerceWeavers\SyliusTpayPlugin\PayByLinkPayment\Payum\Factory\GatewayFactory;
 
 return static function(ContainerConfigurator $container): void {
     $services = $container->services();
@@ -20,10 +20,10 @@
             service('commerce_weavers_sylius_tpay.tpay.factory.create_pay_by_link_payment_payload'),
             service('commerce_weavers_sylius_tpay.payum.factory.token.notify'),
         ])
-        ->tag('payum.action', ['factory' => TpayGatewayFactory::NAME, 'alias' => 'cw.tpay_pbl.create_pay_by_link_transaction'])
+        ->tag('payum.action', ['factory' => GatewayFactory::NAME, 'alias' => 'cw.tpay_pbl.create_pay_by_link_transaction'])
     ;
 
     $services->set(GetTpayTransactionsChannelsAction::class)
-        ->tag('payum.action', ['factory' => TpayGatewayFactory::NAME, 'alias' => 'cw.tpay_pbl.get_transactions_channels'])
+        ->tag('payum.action', ['factory' => GatewayFactory::NAME, 'alias' => 'cw.tpay_pbl.get_transactions_channels'])
     ;
 };
diff --git a/config/services/pay_by_link_payment/payum/factory.php b/config/services/pay_by_link_payment/payum/factory.php
@@ -4,12 +4,21 @@
 
 namespace Symfony\Component\DependencyInjection\Loader\Configurator;
 
+use CommerceWeavers\SyliusTpayPlugin\PayByLinkPayment\Payum\Factory\GatewayFactory;
 use CommerceWeavers\SyliusTpayPlugin\PayByLinkPayment\Payum\Factory\GetTpayTransactionsChannelsFactory;
 use CommerceWeavers\SyliusTpayPlugin\PayByLinkPayment\Payum\Factory\GetTpayTransactionsChannelsFactoryInterface;
+use Payum\Core\Bridge\Symfony\Builder\GatewayFactoryBuilder;
 
 return static function(ContainerConfigurator $container): void {
     $services = $container->services();
 
+    $services->set('commerce_weavers_sylius_tpay.pay_by_link_payment.payum.factory.gateway', GatewayFactoryBuilder::class)
+        ->args([
+            GatewayFactory::class,
+        ])
+        ->tag('payum.gateway_factory_builder', ['factory' => GatewayFactory::NAME])
+    ;
+
     $services->set('commerce_weavers_sylius_tpay.pay_by_link_payment.payum.factory.get_tpay_transactions_channels', GetTpayTransactionsChannelsFactory::class)
         ->alias(GetTpayTransactionsChannelsFactoryInterface::class, 'commerce_weavers_sylius_tpay.pay_by_link_payment.payum.factory.get_tpay_transactions_channels')
     ;

diff --git a/config/services/payum/action.php b/config/services/payum/action.php
@@ -6,6 +6,7 @@
 
 use CommerceWeavers\SyliusTpayPlugin\BlikPayment\Payum\Factory\GatewayFactory as BlikGatewayFactory;
 use CommerceWeavers\SyliusTpayPlugin\CardPayment\Payum\Factory\GatewayFactory as CardGatewayFactory;
+use CommerceWeavers\SyliusTpayPlugin\PayByLinkPayment\Payum\Factory\GatewayFactory as PayByLinkGatewayFactory;
 use CommerceWeavers\SyliusTpayPlugin\Payum\Action\Api\CreateApplePayTransactionAction;
 use CommerceWeavers\SyliusTpayPlugin\Payum\Action\Api\CreateGooglePayTransactionAction;
 use CommerceWeavers\SyliusTpayPlugin\Payum\Action\Api\CreateRedirectBasedTransactionAction;
@@ -31,6 +32,7 @@
         ])
         ->tag('payum.action', ['factory' => BlikGatewayFactory::NAME, 'alias' => 'cw.tpay_blik.capture'])
         ->tag('payum.action', ['factory' => CardGatewayFactory::NAME, 'alias' => 'cw.tpay_card.capture'])
+        ->tag('payum.action', ['factory' => PayByLinkGatewayFactory::NAME, 'alias' => 'cw.tpay_pbl.capture'])
         ->tag('payum.action', ['factory' => TpayGatewayFactory::NAME, 'alias' => 'cw.tpay.capture'])
     ;
 
@@ -74,24 +76,28 @@
         ])
         ->tag('payum.action', ['factory' => BlikGatewayFactory::NAME, 'alias' => 'cw.tpay_blik.notify'])
         ->tag('payum.action', ['factory' => CardGatewayFactory::NAME, 'alias' => 'cw.tpay_card.notify'])
+        ->tag('payum.action', ['factory' => PayByLinkGatewayFactory::NAME, 'alias' => 'cw.tpay_pbl.notify'])
         ->tag('payum.action', ['factory' => TpayGatewayFactory::NAME, 'alias' => 'cw.tpay.notify'])
     ;
 
     $services->set(GetStatusAction::class)
         ->tag('payum.action', ['factory' => BlikGatewayFactory::NAME, 'alias' => 'cw.tpay_blik.get_status'])
         ->tag('payum.action', ['factory' => CardGatewayFactory::NAME, 'alias' => 'cw.tpay_card.get_status'])
+        ->tag('payum.action', ['factory' => PayByLinkGatewayFactory::NAME, 'alias' => 'cw.tpay_pbl.get_status'])
         ->tag('payum.action', ['factory' => TpayGatewayFactory::NAME, 'alias' => 'cw.tpay.get_status'])
     ;
 
     $services->set(PartialRefundAction::class)
         ->tag('payum.action', ['factory' => BlikGatewayFactory::NAME, 'alias' => 'cw.tpay_blik.partial_refund'])
         ->tag('payum.action', ['factory' => CardGatewayFactory::NAME, 'alias' => 'cw.tpay_card.partial_refund'])
+        ->tag('payum.action', ['factory' => PayByLinkGatewayFactory::NAME, 'alias' => 'cw.tpay_pbl.partial_refund'])
         ->tag('payum.action', ['factory' => TpayGatewayFactory::NAME, 'alias' => 'cw.tpay.partial_refund'])
     ;
 
     $services->set(RefundAction::class)
         ->tag('payum.action', ['factory' => BlikGatewayFactory::NAME, 'alias' => 'cw.tpay_blik.refund'])
         ->tag('payum.action', ['factory' => CardGatewayFactory::NAME, 'alias' => 'cw.tpay_card.refund'])
+        ->tag('payum.action', ['factory' => PayByLinkGatewayFactory::NAME, 'alias' => 'cw.tpay_pbl.refund'])
         ->tag('payum.action', ['factory' => TpayGatewayFactory::NAME, 'alias' => 'cw.tpay.refund'])
     ;
 
@@ -105,6 +111,7 @@
     $services->set(ResolveNextRouteAction::class)
         ->tag('payum.action', ['factory' => BlikGatewayFactory::NAME, 'alias' => 'cw.tpay_blik.resolve_next_route'])
         ->tag('payum.action', ['factory' => CardGatewayFactory::NAME, 'alias' => 'cw.tpay_card.resolve_next_route'])
+        ->tag('payum.action', ['factory' => PayByLinkGatewayFactory::NAME, 'alias' => 'cw.tpay_pbl.resolve_next_route'])
         ->tag('payum.action', ['factory' => TpayGatewayFactory::NAME, 'alias' => 'cw.tpay.resolve_next_route'])
     ;
 };
diff --git a/src/PayByLinkPayment/Form/Type/GatewayConfigurationType.php b/src/PayByLinkPayment/Form/Type/GatewayConfigurationType.php
@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CommerceWeavers\SyliusTpayPlugin\PayByLinkPayment\Form\Type;
+
+use CommerceWeavers\SyliusTpayPlugin\Form\Type\AbstractTpayGatewayConfigurationType;
+
+final class GatewayConfigurationType extends AbstractTpayGatewayConfigurationType
+{
+}
diff --git a/src/PayByLinkPayment/Payum/Factory/GatewayFactory.php b/src/PayByLinkPayment/Payum/Factory/GatewayFactory.php
@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CommerceWeavers\SyliusTpayPlugin\PayByLinkPayment\Payum\Factory;
+
+use CommerceWeavers\SyliusTpayPlugin\Payum\Factory\TpayGatewayFactory;
+
+final class GatewayFactory extends TpayGatewayFactory
+{
+    public const NAME = 'tpay_pbl';
+
+    public function getName(): string
+    {
+        return self::NAME;
+    }
+}
diff --git a/src/Tpay/Provider/ValidTpayChannelListProvider.php b/src/Tpay/Provider/ValidTpayChannelListProvider.php
@@ -5,6 +5,7 @@
 namespace CommerceWeavers\SyliusTpayPlugin\Tpay\Provider;
 
 use CommerceWeavers\SyliusTpayPlugin\PayByLinkPayment\Payum\Exception\UnableToGetBankListException;
+use CommerceWeavers\SyliusTpayPlugin\PayByLinkPayment\Payum\Factory\GatewayFactory;
 use CommerceWeavers\SyliusTpayPlugin\Repository\PaymentMethodRepositoryInterface;
 use CommerceWeavers\SyliusTpayPlugin\Tpay\PayGroup;
 use CommerceWeavers\SyliusTpayPlugin\Tpay\PaymentType;
@@ -31,8 +32,6 @@ public function __construct(
 
     public function provide(): array
     {
-        $availableChannels = $this->availableTpayApiBankListProvider->provide();
-
         /** @var PaymentMethodInterface[] $paymentMethods */
         $paymentMethods = $this->paymentMethodRepository->findByChannelAndGatewayConfigNameWithGatewayConfig(
             $this->channelContext->getChannel(),
@@ -41,8 +40,20 @@ public function provide(): array
 
         Assert::notEmpty($paymentMethods, 'There is no payment method of Tpay type available');
 
+        /** @var PaymentMethodInterface[] $payByLinkPaymentMethods */
+        $payByLinkPaymentMethods = $this->paymentMethodRepository->findByChannelAndGatewayConfigNameWithGatewayConfig(
+            $this->channelContext->getChannel(),
+            GatewayFactory::NAME,
+        );
+
+        if ([] === $payByLinkPaymentMethods) {
+            throw new UnableToGetBankListException(
+                'Bank list cannot be retrieved if there is no payment method with PayByLink type configured',
+            );
+        }
+
+        $availableChannels = $this->availableTpayApiBankListProvider->provide();
         $paymentMethodsToRemoveByGroupId = [];
-        $hasPblPaymentAvailable = false;
         foreach ($paymentMethods as $paymentMethod) {
             /** @var (GatewayConfigInterface&CryptedInterface)|null $tpayGatewayConfig */
             $tpayGatewayConfig = $paymentMethod->getGatewayConfig();
@@ -58,10 +69,6 @@ public function provide(): array
                 continue;
             }
 
-            if ($hasPblPaymentAvailable === false && $config['type'] === PaymentType::PAY_BY_LINK) {
-                $hasPblPaymentAvailable = true;
-            }
-
             match ($config['type']) {
                 PaymentType::VISA_MOBILE => array_push(
                     $paymentMethodsToRemoveByGroupId,
@@ -76,12 +83,6 @@ public function provide(): array
             };
         }
 
-        if (!$hasPblPaymentAvailable) {
-            throw new UnableToGetBankListException(
-                'Bank list cannot be retrieved if there is no payment method with PayByLink type configured',
-            );
-        }
-
         return array_filter($availableChannels, static function (array $channel) use ($paymentMethodsToRemoveByGroupId): bool {
             $groupId = (int) $channel['groups'][0]['id'];
 

diff --git a/src/Tpay/Resolver/TpayTransactionChannelResolver.php b/src/Tpay/Resolver/TpayTransactionChannelResolver.php
@@ -4,6 +4,7 @@
 
 namespace CommerceWeavers\SyliusTpayPlugin\Tpay\Resolver;
 
+use CommerceWeavers\SyliusTpayPlugin\PayByLinkPayment\Payum\Factory\GatewayFactory;
 use CommerceWeavers\SyliusTpayPlugin\PayByLinkPayment\Payum\Factory\GetTpayTransactionsChannelsFactoryInterface;
 use CommerceWeavers\SyliusTpayPlugin\PayByLinkPayment\Payum\Request\GetTpayTransactionsChannels;
 use Payum\Core\Model\ArrayObject;
@@ -30,7 +31,7 @@ public function __construct(
 
     public function resolve(): array
     {
-        $gateway = $this->payum->getGateway('tpay');
+        $gateway = $this->payum->getGateway(GatewayFactory::NAME);
 
         $value = $this->getTpayTransactionsChannelsFactory?->createNewEmpty()
             ?? new GetTpayTransactionsChannels(new ArrayObject());

diff --git a/templates/shop/cart/complete/_payByLink.html.twig b/templates/shop/cart/complete/_payByLink.html.twig
@@ -1,7 +1,6 @@
 {% set payment = order.lastCartPayment() %}
 
-{% if payment is not null and
-    cw_tpay_get_gateway_config_value(payment.method.gatewayConfig, 'type') == constant('CommerceWeavers\\SyliusTpayPlugin\\Tpay\\PaymentType::PAY_BY_LINK')
+{% if payment is not null and payment.method.gatewayConfig.gatewayName == 'tpay_pbl'
 %}
     <div class="bank-container">
         {% for bank in banks %}

diff --git a/templates/shop/order/pay/_payByLink.html.twig b/templates/shop/order/pay/_payByLink.html.twig
@@ -1,6 +1,4 @@
-{% if cw_tpay_get_gateway_config_value(method.gatewayConfig, 'type') == constant('CommerceWeavers\\SyliusTpayPlugin\\Tpay\\PaymentType::PAY_BY_LINK')
-    and form.vars.value.state != 'cart'
-%}
+{% if method.gatewayConfig.gatewayName == 'tpay_pbl' and form.vars.value.state != 'cart' %}
     <div class="ui stackable grid" style="display: none;" data-payment-details="pay_by_link">
         {% include '@CommerceWeaversSyliusTpayPlugin/shop/payment/_payByLink.html.twig' %}
     </div>

diff --git a/tests/Api/DataFixtures/shop/blik_payment_method.yml b/tests/Api/DataFixtures/shop/blik_payment_method.yml
@@ -50,7 +50,6 @@ Sylius\Bundle\PayumBundle\Model\GatewayConfig:
             client_id: 'encrypted_<getenv("TPAY_CLIENT_ID")>'
             client_secret: 'encrypted_<getenv("TPAY_CLIENT_SECRET")>'
             cards_api: 'encrypted_<getenv("TPAY_CARDS_API")>'
-            type: 'card'
             production_mode: false
             encrypted: true
     gateway_tpay_blik:
@@ -62,12 +61,11 @@ Sylius\Bundle\PayumBundle\Model\GatewayConfig:
             production_mode: false
             encrypted: true
     gateway_tpay_pbl:
-        gatewayName: 'tpay'
-        factoryName: 'tpay'
+        gatewayName: 'tpay_pbl'
+        factoryName: 'tpay_pbl'
         config:
             client_id: 'encrypted_<getenv("TPAY_CLIENT_ID")>'
             client_secret: 'encrypted_<getenv("TPAY_CLIENT_SECRET")>'
-            type: 'pay_by_link'
             production_mode: false
             encrypted: true
 

diff --git a/tests/Api/DataFixtures/shop/paying_for_orders_by_card/payment_method.yml b/tests/Api/DataFixtures/shop/paying_for_orders_by_card/payment_method.yml
@@ -52,7 +52,6 @@ Sylius\Bundle\PayumBundle\Model\GatewayConfig:
             client_id: 'encrypted_<getenv("TPAY_CLIENT_ID")>'
             client_secret: 'encrypted_<getenv("TPAY_CLIENT_SECRET")>'
             cards_api: 'encrypted_<getenv("TPAY_CARDS_API")>'
-            type: 'card'
             production_mode: false
             encrypted: true
     gateway_tpay_blik:
@@ -64,12 +63,11 @@ Sylius\Bundle\PayumBundle\Model\GatewayConfig:
             production_mode: false
             encrypted: true
     gateway_tpay_pbl:
-        gatewayName: 'tpay'
-        factoryName: 'tpay'
+        gatewayName: 'tpay_pbl'
+        factoryName: 'tpay_pbl'
         config:
             client_id: 'encrypted_<getenv("TPAY_CLIENT_ID")>'
             client_secret: 'encrypted_<getenv("TPAY_CLIENT_SECRET")>'
-            type: 'pay_by_link'
             production_mode: false
             encrypted: true
     gateway_tpay_visa_mobile:

diff --git a/tests/E2E/Resources/fixtures/common/payment_method.yaml b/tests/E2E/Resources/fixtures/common/payment_method.yaml
@@ -78,8 +78,8 @@ Sylius\Bundle\PayumBundle\Model\GatewayConfig:
             production_mode: false
             encrypted: true
     gateway_tpay_pbl:
-        gatewayName: 'tpay'
-        factoryName: 'tpay'
+        gatewayName: 'tpay_pbl'
+        factoryName: 'tpay_pbl'
         config:
             client_id: 'encrypted_<getenv("TPAY_CLIENT_ID")>'
             client_secret: 'encrypted_<getenv("TPAY_CLIENT_SECRET")>'

diff --git a/tests/Unit/Tpay/Provider/ValidTpayChannelListProviderTest.php b/tests/Unit/Tpay/Provider/ValidTpayChannelListProviderTest.php
@@ -120,26 +120,20 @@ public function test_it_throws_exception_if_there_is_no_gateway_config_that_is_p
         $this->expectExceptionMessage('Bank list cannot be retrieved if there is no payment method with PayByLink type configured');
 
         $notTpayBasedPaymentMethod = $this->prophesize(PaymentMethodInterface::class);
-        $notTpayBasedGatewayConfig = $this->prophesize(GatewayConfig::class);
-        $notTpayBasedGatewayConfigConfig = [
-            'type' => 'visa_mobile',
-        ];
-        $notTpayBasedPaymentMethod->getGatewayConfig()->willReturn($notTpayBasedGatewayConfig);
-
-        $this->availableTpayApiBankListProvider->provide()->willReturn(self::BANK_LIST);
 
         $channel = $this->prophesize(ChannelInterface::class);
         $this->channelContext->getChannel()->willReturn($channel->reveal());
 
-        $notTpayBasedGatewayConfig->decrypt($this->cypher)->shouldBeCalled();
-        $notTpayBasedGatewayConfig->getConfig()->willReturn($notTpayBasedGatewayConfigConfig);
-
         $this->paymentMethodRepository
             ->findByChannelAndGatewayConfigNameWithGatewayConfig($channel, 'tpay')
             ->willReturn([
                 $notTpayBasedPaymentMethod
             ])
         ;
+        $this->paymentMethodRepository
+            ->findByChannelAndGatewayConfigNameWithGatewayConfig($channel, 'tpay_pbl')
+            ->willReturn([])
+        ;
 
         $this->createTestSubject()->provide();
     }
@@ -167,6 +161,12 @@ public function test_it_returns_all_available_payments_if_only_tpay_payment_meth
                 $tpayBasedPaymentMethod->reveal(),
             ])
         ;
+        $this->paymentMethodRepository
+            ->findByChannelAndGatewayConfigNameWithGatewayConfig($channel, 'tpay_pbl')
+            ->willReturn([
+                $this->prophesize(PaymentMethodInterface::class)->reveal(),
+            ])
+        ;
 
         $result = $this->createTestSubject()->provide();
 
@@ -205,6 +205,12 @@ public function test_it_returns_valid_payments_according_to_available_tpay_payme
                 $anotherTpayPblPaymentMethod->reveal(),
             ])
         ;
+        $this->paymentMethodRepository
+            ->findByChannelAndGatewayConfigNameWithGatewayConfig($channel, 'tpay_pbl')
+            ->willReturn([
+                $this->prophesize(PaymentMethodInterface::class)->reveal(),
+            ])
+        ;
 
         $result = $this->createTestSubject()->provide();
 
@@ -247,6 +253,12 @@ public function test_it_returns_valid_payments_even_if_gateway_config_lacks_type
                 $anotherTpayPblPaymentMethod->reveal(),
             ])
         ;
+        $this->paymentMethodRepository
+            ->findByChannelAndGatewayConfigNameWithGatewayConfig($channel, 'tpay_pbl')
+            ->willReturn([
+                $this->prophesize(PaymentMethodInterface::class)->reveal(),
+            ])
+        ;
 
         $result = $this->createTestSubject()->provide();