PAYOSWXP-47: payolution: migrate payment-filter

… from event-listener to standardized payment-filter functionality
PAYONE-GmbH · Mar 21, 2024 · 1b20ec3 · 1b20ec3
1 parent a5cd02e
commit 1b20ec3
Show file tree

Hide file tree

Showing 7 changed files with 149 additions and 251 deletions.
diff --git a/src/Components/PaymentFilter/DefaultPaymentFilterService.php b/src/Components/PaymentFilter/DefaultPaymentFilterService.php
@@ -21,8 +21,8 @@ class DefaultPaymentFilterService implements PaymentFilterServiceInterface
      * @param class-string<AbstractPayonePaymentHandler> $paymentHandlerClass
      */
     public function __construct(
-        private readonly SystemConfigService $systemConfigService,
-        private readonly string $paymentHandlerClass,
+        protected readonly SystemConfigService $systemConfigService,
+        protected readonly string $paymentHandlerClass,
         private readonly ?array $allowedCountries = null,
         private readonly ?array $allowedB2bCountries = null,
         private readonly ?array $allowedCurrencies = null,

diff --git a/src/Components/PaymentFilter/PayolutionPaymentMethodFilter.php b/src/Components/PaymentFilter/PayolutionPaymentMethodFilter.php
@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PayonePayment\Components\PaymentFilter;
+
+use PayonePayment\Components\ConfigReader\ConfigReader;
+use PayonePayment\Components\PaymentFilter\Exception\PaymentMethodNotAllowedException;
+use PayonePayment\PaymentHandler\PayonePayolutionInvoicingPaymentHandler;
+use Shopware\Core\Checkout\Payment\PaymentMethodCollection;
+use Shopware\Core\System\SalesChannel\SalesChannelContext;
+
+class PayolutionPaymentMethodFilter extends DefaultPaymentFilterService
+{
+    protected function additionalChecks(PaymentMethodCollection $methodCollection, PaymentFilterContext $filterContext): void
+    {
+        if (empty($this->getPaymentHandlerConfiguration($filterContext->getSalesChannelContext(), 'CompanyName'))) {
+            throw new PaymentMethodNotAllowedException('Payolution: missing merchant-company name.');
+        }
+
+        if ($this->paymentHandlerClass === PayonePayolutionInvoicingPaymentHandler::class
+            && !($this->getPaymentHandlerConfiguration($filterContext->getSalesChannelContext(), 'TransferCompanyData'))
+        ) {
+            throw new PaymentMethodNotAllowedException('Payolution Invoicing: Missing configuration.');
+        }
+    }
+
+    private function getPaymentHandlerConfiguration(SalesChannelContext $context, string $configKey): mixed
+    {
+        return $this->getConfiguration($context, ConfigReader::getConfigKeyByPaymentHandler($this->paymentHandlerClass, $configKey));
+    }
+
+    private function getConfiguration(SalesChannelContext $context, string $configName): mixed
+    {
+        return $this->systemConfigService->get($configName, $context->getSalesChannel()->getId());
+    }
+}
diff --git a/src/DependencyInjection/listeners.xml b/src/DependencyInjection/listeners.xml
@@ -42,12 +42,6 @@
             <tag name="kernel.event_subscriber"/>
         </service>
 
-        <service id="PayonePayment\EventListener\CheckoutConfirmPayolutionEventListener">
-            <argument type="service" id="PayonePayment\Components\ConfigReader\ConfigReader" />
-
-            <tag name="kernel.event_subscriber"/>
-        </service>
-
         <service id="PayonePayment\EventListener\CheckoutConfirmTemplateEventListener">
             <tag name="kernel.event_subscriber"/>
         </service>

diff --git a/src/DependencyInjection/payment_method_filter.xml b/src/DependencyInjection/payment_method_filter.xml
@@ -147,5 +147,25 @@
             <tag name="payone.payment_method.filter"/>
         </service>
 
+        <service id="payone.payment_filter_method.payolution.invoice"
+                 class="PayonePayment\Components\PaymentFilter\PayolutionPaymentMethodFilter">
+            <argument key="$systemConfigService" type="service" id="Shopware\Core\System\SystemConfig\SystemConfigService" />
+            <argument key="$paymentHandlerClass">PayonePayment\PaymentHandler\PayonePayolutionInvoicingPaymentHandler</argument>
+            <tag name="payone.payment_method.filter"/>
+        </service>
+
+        <service id="payone.payment_filter_method.payolution.debit"
+                 class="PayonePayment\Components\PaymentFilter\PayolutionPaymentMethodFilter">
+            <argument key="$systemConfigService" type="service" id="Shopware\Core\System\SystemConfig\SystemConfigService" />
+            <argument key="$paymentHandlerClass">PayonePayment\PaymentHandler\PayonePayolutionDebitPaymentHandler</argument>
+            <tag name="payone.payment_method.filter"/>
+        </service>
+
+        <service id="payone.payment_filter_method.payolution.installment"
+                 class="PayonePayment\Components\PaymentFilter\PayolutionPaymentMethodFilter">
+            <argument key="$systemConfigService" type="service" id="Shopware\Core\System\SystemConfig\SystemConfigService" />
+            <argument key="$paymentHandlerClass">PayonePayment\PaymentHandler\PayonePayolutionInstallmentPaymentHandler</argument>
+            <tag name="payone.payment_method.filter"/>
+        </service>
     </services>
 </container>
diff --git a/src/EventListener/CheckoutConfirmPayolutionEventListener.php b/src/EventListener/CheckoutConfirmPayolutionEventListener.php
diff --git a/tests/Components/PaymentFilter/PayolutionPaymentFilterTest.php b/tests/Components/PaymentFilter/PayolutionPaymentFilterTest.php
@@ -0,0 +1,90 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PayonePayment\Components\PaymentFilter;
+
+use PayonePayment\Configuration\ConfigurationPrefixes;
+use PayonePayment\PaymentHandler\PayonePayolutionDebitPaymentHandler;
+use PayonePayment\PaymentHandler\PayonePayolutionInstallmentPaymentHandler;
+use PayonePayment\PaymentHandler\PayonePayolutionInvoicingPaymentHandler;
+use PayonePayment\TestCaseBase\ConfigurationHelper;
+use Shopware\Core\System\Currency\CurrencyEntity;
+
+/**
+ * @covers \PayonePayment\Components\PaymentFilter\PayolutionPaymentMethodFilter
+ */
+class PayolutionPaymentFilterTest extends AbstractPaymentFilterTest
+{
+    use ConfigurationHelper;
+
+    protected function setUp(): void
+    {
+        foreach ($this->getPaymentHandlerClasses() as $handlerClass) {
+            $this->setPayoneConfig($this->getContainer(), ConfigurationPrefixes::CONFIGURATION_PREFIXES[$handlerClass] . 'CompanyName', 'the-company');
+        }
+        $this->setPayoneConfig($this->getContainer(), 'payolutionInvoicingTransferCompanyData', true);
+    }
+
+    protected function getFilterService(?string $paymentHandlerClass = null): PaymentFilterServiceInterface
+    {
+        $serviceId = match ($paymentHandlerClass) {
+            PayonePayolutionInvoicingPaymentHandler::class => 'payone.payment_filter_method.payolution.invoice',
+            PayonePayolutionDebitPaymentHandler::class => 'payone.payment_filter_method.payolution.debit',
+            PayonePayolutionInstallmentPaymentHandler::class => 'payone.payment_filter_method.payolution.installment',
+        };
+
+        if (!$serviceId) {
+            throw new \RuntimeException('unknown payment-handler: ' . $paymentHandlerClass);
+        }
+
+        return $this->getContainer()->get($serviceId);
+    }
+
+    protected function getDisallowedBillingCountry(): ?string
+    {
+        return null;
+    }
+
+    protected function getAllowedBillingCountry(): string
+    {
+        return 'DE';
+    }
+
+    protected function getDisallowedCurrency(): ?CurrencyEntity
+    {
+        return null;
+    }
+
+    protected function getAllowedCurrency(): CurrencyEntity
+    {
+        $currency = $this->createMock(CurrencyEntity::class);
+        $currency->method('getIsoCode')->willReturn('EUR');
+
+        return $currency;
+    }
+
+    protected function getTooLowValue(): ?float
+    {
+        return null;
+    }
+
+    protected function getTooHighValue(): ?float
+    {
+        return null;
+    }
+
+    protected function getAllowedValue(): float
+    {
+        return 100.0;
+    }
+
+    protected function getPaymentHandlerClasses(): array
+    {
+        return [
+            PayonePayolutionInvoicingPaymentHandler::class,
+            PayonePayolutionDebitPaymentHandler::class,
+            PayonePayolutionInstallmentPaymentHandler::class,
+        ];
+    }
+}