NTR: PIHPS-205 - add new payment method blik

.github/actions/build-plugin/action.yml

@@ -8,7 +8,7 @@ runs:
     - name: Start Docker
       shell: bash
       run: |
-        docker run --rm --name shop --env NODE_VERSION=18 --env PHP_VERSION=8.1 -d dockware/dev:6.5.8.2
+        docker run --rm --name shop --env NODE_VERSION=18 --env PHP_VERSION=8.1 -d dockware/dev:6.5.8.4
         sleep 20
         docker logs shop
 

.github/workflows/ci_pipe.yml

@@ -340,7 +340,7 @@ jobs:
       fail-fast: false
       matrix:
         include:
-          - shopware: '6.5.8.2'
+          - shopware: '6.5.8.4'
             php: '8.2'
           - shopware: '6.5.6.1'
             php: '8.2'

.github/workflows/nightly_pipe.yml

@@ -334,7 +334,7 @@ jobs:
       fail-fast: false
       matrix:
         include:
-          - shopware: '6.5.8.2'
+          - shopware: '6.5.8.4'
             php: '8.2'
           - shopware: '6.5.6.1'
             php: '8.2'

.github/workflows/pr_pipe.yml

@@ -333,7 +333,7 @@ jobs:
       fail-fast: false
       matrix:
         include:
-          - shopware: '6.5.8.2'
+          - shopware: '6.5.8.4'
             php: '8.2'
           - shopware: '6.5.5.2'
             php: '8.2'

src/Components/MollieLimits/Service/MollieLimitsRemover.php → src/Components/MollieAvailability/Service/MolliePaymentMethodAvailabilityRemover.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Kiener\MolliePayments\Components\MollieLimits\Service;
+namespace Kiener\MolliePayments\Components\MollieAvailability\Service;
 
 use Exception;
 use Kiener\MolliePayments\Exception\MissingCartServiceException;
@@ -22,7 +22,7 @@
 use Symfony\Component\HttpFoundation\Exception\BadRequestException;
 use Symfony\Component\HttpFoundation\RequestStack;
 
-class MollieLimitsRemover extends PaymentMethodRemover
+class MolliePaymentMethodAvailabilityRemover extends PaymentMethodRemover
 {
     /**
      * @var ActivePaymentMethodsProviderInterface
@@ -65,6 +65,8 @@ public function removePaymentMethods(PaymentMethodRouteResponse $originalData, S
         if (!$this->isAllowedRoute()) {
             return $originalData;
         }
+        $billingAddress = null;
+        $countryIsoCode = null;
 
         if ($this->isCartRoute()) {
             try {
@@ -77,8 +79,13 @@ public function removePaymentMethods(PaymentMethodRouteResponse $originalData, S
             }
 
             $price = $cart->getPrice()->getTotalPrice();
+            $customer = $context->getCustomer();
+            if ($customer !== null) {
+                $billingAddress = $customer->getDefaultBillingAddress();
+            }
         }
 
+
         if ($this->isOrderRoute()) {
             try {
                 $order = $this->getOrder($context->getContext());
@@ -90,15 +97,27 @@ public function removePaymentMethods(PaymentMethodRouteResponse $originalData, S
             }
 
             $price = $order->getAmountTotal();
+
+            $billingAddress = $order->getBillingAddress();
         }
 
         if (!isset($price)) {
             return $originalData;
         }
 
+        if ($billingAddress !== null) {
+            $billingCountry = $billingAddress->getCountry();
+            if ($billingCountry !== null) {
+                $countryIsoCode = $billingCountry->getIso();
+            }
+        }
+
+
+
         $availableMolliePayments = $this->paymentMethodsProvider->getActivePaymentMethodsForAmount(
             $price,
             $context->getCurrency()->getIsoCode(),
+            (string) $countryIsoCode,
             [
                 $context->getSalesChannel()->getId(),
             ]

src/Handler/Method/BlikPayment.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace Kiener\MolliePayments\Handler\Method;
+
+use Kiener\MolliePayments\Handler\PaymentHandler;
+use Mollie\Api\Types\PaymentMethod;
+use Shopware\Core\Checkout\Customer\CustomerEntity;
+use Shopware\Core\Checkout\Order\OrderEntity;
+use Shopware\Core\System\Locale\LocaleEntity;
+use Shopware\Core\System\SalesChannel\SalesChannelContext;
+
+class BlikPayment extends PaymentHandler
+{
+    public const PAYMENT_METHOD_NAME = 'blik';
+    public const PAYMENT_METHOD_DESCRIPTION = 'Blik';
+
+    /** @var string */
+    protected $paymentMethod = self::PAYMENT_METHOD_NAME;
+
+
+    /**
+     * @param array<mixed> $orderData
+     * @param OrderEntity $orderEntity
+     * @param SalesChannelContext $salesChannelContext
+     * @param CustomerEntity $customer
+     * @return array<mixed>
+     */
+    public function processPaymentMethodSpecificParameters(array $orderData, OrderEntity $orderEntity, SalesChannelContext $salesChannelContext, CustomerEntity $customer): array
+    {
+        return $orderData;
+    }
+}

src/Resources/app/administration/src/snippet/de-DE.json

@@ -76,7 +76,7 @@
           "failed": "Die Zahlungsarten konnten nicht aktualisiert werden."
         },
         "mollieLimits": {
-          "link": "Öffne Mollie Zahlungs Limits"
+          "link": "Zeige Mollie-Verfügbarkeitregeln für Zahlungsmethoden"
         }
       },
       "rounding": {

src/Resources/app/administration/src/snippet/en-GB.json

@@ -76,7 +76,7 @@
           "failed": "The payment methods couldn't be updated."
         },
         "mollieLimits": {
-          "link": "Open Mollie Payment Limits"
+          "link": "Show mollie availability rules for payment methods"
         }
       },
       "rounding": {

src/Resources/app/administration/src/snippet/nl-NL.json

@@ -76,7 +76,7 @@
           "failed": "De betaalmethoden konden niet worden geupdated."
         },
         "mollieLimits": {
-          "link": "Open betalingslimieten van Mollie"
+          "link": "Toon Mollie-beschikbaarheidsregels voor betaalmethoden"
         }
       },
       "rounding": {

src/Resources/config/config.xml

@@ -165,12 +165,12 @@
         <input-field type="bool">
             <name>useMolliePaymentMethodLimits</name>
             <defaultValue>false</defaultValue>
-            <label>Use Mollie Payment Method Limits</label>
-            <label lang="de-DE">Mollies Limits für Zahlungsarten verwenden</label>
-            <label lang="nl-NL">Mollie's limieten voor betaalmethoden gebruiken</label>
-            <helpText>Automatically hides payment methods in the checkout based on the limits of Mollie. For instance, if you can only accept credit card payments up to 500 euros, the checkout for a cart of 600 euros will not display credit card as a payment method.</helpText>
-            <helpText lang="de-DE">Blendet automatisch Zahlungsart im Checkout basierend auf den Limits von Mollie aus. Wenn Sie beispielsweise nur Kreditkartenzahlungen bis zu 500 Euro akzeptieren können, wird an der Kasse für einen Warenkorb von 600 Euro keine Kreditkarte als Zahlungsarte angezeigt.</helpText>
-            <helpText lang="nl-NL">Verbergt automatisch betaalmethoden in de checkout op basis van Mollie's limieten. Als je bijvoorbeeld alleen creditcardbetalingen tot 500 euro kan accepteren, wordt bij een winkelwagen van 600 euro geen creditcard weergegeven als betaalmethode bij het afrekenen.</helpText>
+            <label>Use Mollie's availability rules for payment methods</label>
+            <label lang="de-DE">Mollies Verfügbarkeitsregeln für Zahlungsarten verwenden</label>
+            <label lang="nl-NL">Gebruik de beschikbaarheidsregels van Mollie voor betaalmethoden</label>
+            <helpText>Automatically hides payment methods in the checkout based on the availability rules for payment methods. Only active payment methods from your mollie dashboard will be shown. If the payment method has a cart limit, currency restriction or billing address restriction, it will be hidden during checkout.</helpText>
+            <helpText lang="de-DE">Blendet automatisch Zahlungsart im Checkout basierend auf Verfügbarkeitsregeln von Mollie. Es werden nur die aktiven Zahlungsarten aus dem Mollie Dashboard angezeigt. Wenn die Zahlungsart eine Einschränkung auf den Warenkorbwert, Währung oder Rechnungsadresse hat, wird diese auch ausgeblendet.</helpText>
+            <helpText lang="nl-NL">Automatische betalingsmethode wordt verborgen tijdens het afrekenen op basis van beschikbaarheidsregels van Mollie. Alleen actieve betalingsmethoden uit het Mollie-dashboard worden weergegeven. Als de betalingsmethode beperkingen heeft op de winkelwagenwaarde, valuta of factuuradres, wordt deze ook verborgen.</helpText>
         </input-field>
         <input-field type="text">
             <name>formatOrderNumber</name>

src/Resources/config/services/handlers.xml

@@ -183,5 +183,13 @@
             <tag name="shopware.payment.method.async"/>
         </service>
 
+        <!-- Blick PaymentHandler -->
+        <service id="Kiener\MolliePayments\Handler\Method\BlikPayment">
+            <argument type="service" id="mollie_payments.logger"/>
+            <argument type="service" id="service_container"/>
+            <tag name="shopware.payment.method.async"/>
+        </service>
+
+
     </services>
 </container>

src/Resources/config/services/payment.xml

@@ -17,7 +17,8 @@
             <tag name="mollie_payments.payment_method.remover.sw64"/>
         </service>
 
-        <service id="Kiener\MolliePayments\Components\MollieLimits\Service\MollieLimitsRemover">
+
+        <service id="Kiener\MolliePayments\Components\MollieAvailability\Service\MolliePaymentMethodAvailabilityRemover">
             <argument type="service" id="service_container"/>
             <argument type="service" id="request_stack"/>
             <argument type="service" id="Kiener\MolliePayments\Service\OrderService"/>

src/Service/Payment/Provider/ActivePaymentMethodsProvider.php

@@ -48,10 +48,11 @@ public function __construct(MollieApiFactory $mollieApiFactory, MollieOrderPrice
      *
      * @param float $price
      * @param string $currency
+     * @param string $billingCountryCode
      * @param array<mixed> $salesChannelIDs
      * @return Method[]
      */
-    public function getActivePaymentMethodsForAmount(float $price, string $currency, array $salesChannelIDs): array
+    public function getActivePaymentMethodsForAmount(float $price, string $currency, string $billingCountryCode, array $salesChannelIDs): array
     {
         if ($price < 0.01) {
             return [];
@@ -61,9 +62,13 @@ public function getActivePaymentMethodsForAmount(float $price, string $currency,
             'amount' => [
                 'value' => $this->priceFormatter->formatValue($price),
                 'currency' => strtoupper($currency),
-            ]
+            ],
         ];
 
+        if (mb_strlen($billingCountryCode) > 0) {
+            $params['billingCountry'] = $billingCountryCode;
+        }
+
         return $this->getActivePaymentMethods($params, $salesChannelIDs);
     }
 

src/Service/Payment/Provider/ActivePaymentMethodsProviderInterface.php

@@ -9,10 +9,11 @@
 interface ActivePaymentMethodsProviderInterface
 {
     /**
-     * @param float         $price
-     * @param string        $currency
+     * @param float $price
+     * @param string $currency
+     * @param string $billingCountryCode
      * @param array<string> $salesChannelIDs
      * @return array<Method>
      */
-    public function getActivePaymentMethodsForAmount(float $price, string $currency, array $salesChannelIDs): array;
+    public function getActivePaymentMethodsForAmount(float $price, string $currency, string $billingCountryCode, array $salesChannelIDs): array;
 }

src/Service/PaymentMethodService.php

@@ -8,6 +8,7 @@
 use Kiener\MolliePayments\Handler\Method\BankTransferPayment;
 use Kiener\MolliePayments\Handler\Method\BelfiusPayment;
 use Kiener\MolliePayments\Handler\Method\BilliePayment;
+use Kiener\MolliePayments\Handler\Method\BlikPayment;
 use Kiener\MolliePayments\Handler\Method\CreditCardPayment;
 use Kiener\MolliePayments\Handler\Method\EpsPayment;
 use Kiener\MolliePayments\Handler\Method\GiftCardPayment;
@@ -417,6 +418,7 @@ public function getPaymentHandlers(): array
             In3Payment::class,
             PosPayment::class,
             TwintPayment::class,
+            BlikPayment::class,
             // IngHomePayPayment::class, // not allowed anymore
             // DirectDebitPayment::class, // only allowed when updating subsriptions, aka => not allowed anymore
         ];

tests/Cypress/cypress/e2e/storefront/payment-methods/blik.cy.js

@@ -0,0 +1,43 @@
+import Devices from "Services/utils/Devices";
+import Session from "Services/utils/Session"
+// ------------------------------------------------------
+import PaymentAction from "Actions/storefront/checkout/PaymentAction";
+import DummyBasketScenario from "Scenarios/DummyBasketScenario";
+// ------------------------------------------------------
+
+
+const devices = new Devices();
+const session = new Session();
+
+const paymentAction = new PaymentAction();
+const scenarioDummyBasket = new DummyBasketScenario(1);
+
+const device = devices.getFirstDevice();
+
+
+describe('Blik payment method', () => {
+
+    context(devices.getDescription(device), () => {
+
+        before(function () {
+            devices.setDevice(device);
+        })
+
+        beforeEach(() => {
+            session.resetBrowserSession();
+            devices.setDevice(device);
+        });
+
+        it('Blik is existing in checkout', () => {
+
+            scenarioDummyBasket.execute();
+
+            paymentAction.switchPaymentMethod('Blik');
+
+            // payment would only work using currency CHF which cannot be done at the moment
+        })
+
+    })
+
+})
+

tests/PHPUnit/Service/MollieApi/Builder/Payments/BlikOrderBuilderTest.php

@@ -0,0 +1,68 @@
+<?php declare(strict_types=1);
+
+namespace MolliePayments\Tests\Service\MollieApi\Builder\Payments;
+
+use DateTime;
+use DateTimeZone;
+use Faker\Extension\Container;
+use Kiener\MolliePayments\Handler\Method\BlikPayment;
+use Kiener\MolliePayments\Handler\Method\KlarnaPayLaterPayment;
+use Kiener\MolliePayments\Handler\Method\TwintPayment;
+use Kiener\MolliePayments\Service\MollieApi\Builder\MollieOrderPriceBuilder;
+use Mollie\Api\Types\PaymentMethod;
+use MolliePayments\Tests\Fakes\FakeContainer;
+use MolliePayments\Tests\Service\MollieApi\Builder\AbstractMollieOrderBuilder;
+use Shopware\Core\Checkout\Cart\Price\Struct\CartPrice;
+use Shopware\Core\Framework\Uuid\Uuid;
+use Shopware\Core\System\Currency\CurrencyEntity;
+
+class BlikOrderBuilderTest extends AbstractMollieOrderBuilder
+{
+    public function testOrderBuild(): void
+    {
+        $redirectWebhookUrl = 'https://foo';
+        $this->router->method('generate')->willReturn($redirectWebhookUrl);
+
+
+        $this->paymentHandler = new BlikPayment(
+            $this->loggerService,
+            new FakeContainer()
+        );
+
+        $transactionId = Uuid::randomHex();
+        $amountTotal = 27.0;
+        $taxStatus = CartPrice::TAX_STATE_GROSS;
+        $currencyISO = 'EUR';
+
+        $currency = new CurrencyEntity();
+        $currency->setId(Uuid::randomHex());
+        $currency->setIsoCode($currencyISO);
+
+        $orderNumber = 'foo number';
+        $lineItems = $this->getDummyLineItems();
+
+        $order = $this->getOrderEntity($amountTotal, $taxStatus, $currencyISO, $lineItems, $orderNumber);
+
+        $actual = $this->builder->buildOrderPayload($order, $transactionId, $this->paymentHandler::PAYMENT_METHOD_NAME, $this->salesChannelContext, $this->paymentHandler, []);
+
+        $expectedOrderLifeTime = (new DateTime())->setTimezone(new DateTimeZone('UTC'))
+            ->modify(sprintf('+%d day', $this->expiresAt))
+            ->format('Y-m-d');
+
+        $expected = [
+            'amount' => (new MollieOrderPriceBuilder())->build($amountTotal, $currencyISO),
+            'locale' => $this->localeCode,
+            'method' => $this->paymentHandler::PAYMENT_METHOD_NAME,
+            'orderNumber' => $orderNumber,
+            'payment' => ['webhookUrl' => $redirectWebhookUrl],
+            'redirectUrl' => $redirectWebhookUrl,
+            'webhookUrl' => $redirectWebhookUrl,
+            'lines' => $this->getExpectedLineItems($taxStatus, $lineItems, $currency),
+            'billingAddress' => $this->getExpectedTestAddress($this->address, $this->email),
+            'shippingAddress' => $this->getExpectedTestAddress($this->address, $this->email),
+            'expiresAt' => $expectedOrderLifeTime
+        ];
+
+        self::assertSame($expected, $actual);
+    }
+}