[ECP-9525]Adding channel parameter to /paymentMethods API call

Api/AdyenPaymentMethodManagementInterface.php

@@ -22,7 +22,13 @@ interface AdyenPaymentMethodManagementInterface
      * @param string $cartId
      * @param string|null $shopperLocale
      * @param string|null $country
+     * @param string|null $channel
      * @return string
      */
-    public function getPaymentMethods(string $cartId, ?string $shopperLocale = null, ?string $country = null) :string;
+    public function getPaymentMethods(
+        string $cartId,
+        ?string $shopperLocale = null,
+        ?string $country = null,
+        ?string $channel = null
+    ) :string;
 }

Api/GuestAdyenPaymentMethodManagementInterface.php

@@ -22,7 +22,13 @@ interface GuestAdyenPaymentMethodManagementInterface
      * @param string $cartId
      * @param string|null $shopperLocale
      * @param string|null $country
+     * @param string|null $channel
      * @return string
      */
-    public function getPaymentMethods(string $cartId, ?string $shopperLocale = null, ?string $country = null): string;
+    public function getPaymentMethods(
+        string $cartId,
+        ?string $shopperLocale = null,
+        ?string $country = null,
+        ?string $channel = null
+    ): string;
 }

Helper/PaymentMethods.php

@@ -66,6 +66,8 @@ class PaymentMethods extends AbstractHelper
 
     const ADYEN_GROUP_ALTERNATIVE_PAYMENT_METHODS = 'adyen-alternative-payment-method';
 
+    const VALID_CHANNELS = ["iOS", "Android", "Web"];
+
     /*
      * Following payment methods should be enabled with their own configuration path.
      */
@@ -229,12 +231,18 @@ public function __construct(
      * @param int $quoteId
      * @param string|null $country
      * @param string|null $shopperLocale
+     * @param string|null $channel
      * @return string
      * @throws AdyenException
      * @throws LocalizedException
      * @throws NoSuchEntityException
      */
-    public function getPaymentMethods(int $quoteId, ?string $country = null, ?string $shopperLocale = null): string
+    public function getPaymentMethods(
+        int $quoteId,
+        ?string $country = null,
+        ?string $shopperLocale = null,
+        ?string $channel = null
+    ): string
     {
         // get quote from quoteId
         $quote = $this->quoteRepository->getActive($quoteId);
@@ -245,7 +253,7 @@ public function getPaymentMethods(int $quoteId, ?string $country = null, ?string
 
         $this->setQuote($quote);
 
-        return $this->fetchPaymentMethods($country, $shopperLocale);
+        return $this->fetchPaymentMethods($country, $shopperLocale, $channel);
     }
 
     /**
@@ -327,12 +335,17 @@ public function removePaymentMethodsActivation(string $scope, int $scopeId): voi
     /**
      * @param string|null $country
      * @param string|null $shopperLocale
+     * @param string|null $channel
      * @return string
      * @throws AdyenException
      * @throws LocalizedException
      * @throws NoSuchEntityException
      */
-    protected function fetchPaymentMethods(?string $country = null, ?string $shopperLocale = null): string
+    protected function fetchPaymentMethods(
+        ?string $country = null,
+        ?string $shopperLocale = null,
+        ?string $channel = null
+    ): string
     {
         $quote = $this->getQuote();
         $store = $quote->getStore();
@@ -342,7 +355,14 @@ protected function fetchPaymentMethods(?string $country = null, ?string $shopper
             return json_encode([]);
         }
 
-        $requestData = $this->getPaymentMethodsRequest($merchantAccount, $store, $quote, $shopperLocale, $country);
+        $requestData = $this->getPaymentMethodsRequest(
+            $merchantAccount,
+            $store,
+            $quote,
+            $shopperLocale,
+            $country,
+            $channel
+        );
         $responseData = $this->getPaymentMethodsResponse($requestData, $store);
         if (empty($responseData['paymentMethods'])) {
             return json_encode([]);
@@ -526,6 +546,7 @@ protected function getCurrentShopperReference(): ?string
      * @param Quote $quote
      * @param string|null $shopperLocale
      * @param string|null $country
+     * @param string|null $channel
      * @return array
      * @throws AdyenException
      */
@@ -534,15 +555,18 @@ protected function getPaymentMethodsRequest(
         Store $store,
         Quote $quote,
         ?string $shopperLocale = null,
-        ?string $country = null
+        ?string $country = null,
+        ?string $channel = null
     ): array {
         $currencyCode = $this->chargedCurrency->getQuoteAmountCurrency($quote)->getCurrencyCode();
 
+        $channel = in_array($channel, self::VALID_CHANNELS, true) ? $channel : "Web";
+
         $paymentMethodRequest = [
-            "channel" => "Web",
+            "channel" => $channel ?? "Web",
             "merchantAccount" => $merchantAccount,
             "countryCode" => $country ?? $this->getCurrentCountryCode($store),
-            "shopperLocale" => $shopperLocale ?: $this->adyenHelper->getCurrentLocaleCode($store->getId()),
+            "shopperLocale" => $shopperLocale ?? $this->adyenHelper->getCurrentLocaleCode($store->getId()),
             "amount" => [
                 "currency" => $currencyCode
             ]

Helper/PaymentMethodsFilter.php

@@ -15,6 +15,7 @@
 use Adyen\Payment\Model\Ui\AdyenPosCloudConfigProvider;
 use Magento\Quote\Api\CartRepositoryInterface;
 use Magento\Quote\Api\Data\CartInterface;
+use Magento\Framework\App\RequestInterface;
 
 class PaymentMethodsFilter
 {
@@ -31,18 +32,24 @@ class PaymentMethodsFilter
     ];
 
     private PaymentMethods $paymentMethods;
+    private RequestInterface $request;
 
     public function __construct(
-        PaymentMethods $paymentMethods
+        PaymentMethods $paymentMethods,
+        RequestInterface $request
     ) {
         $this->paymentMethods = $paymentMethods;
+        $this->request = $request;
     }
 
     public function sortAndFilterPaymentMethods(array $magentoPaymentMethods, CartInterface $quote): array
     {
+        $channel = $this->request->getParam('channel');
         $adyenPaymentMethodsResponse = $this->paymentMethods->getPaymentMethods(
             $quote->getId(),
-            $quote->getBillingAddress()->getCountryId()
+            $quote->getBillingAddress()->getCountryId(),
+            null,
+            $channel
         );
 
         $adyenPaymentMethodsDecoded = json_decode($adyenPaymentMethodsResponse, true);

Model/Api/AdyenPaymentMethodManagement.php

@@ -24,8 +24,13 @@ public function __construct(
         $this->paymentMethodsHelper = $paymentMethodsHelper;
     }
 
-    public function getPaymentMethods(string $cartId, ?string $shopperLocale = null, ?string $country = null) : string
+    public function getPaymentMethods(
+        string $cartId,
+        ?string $shopperLocale = null,
+        ?string $country = null,
+        ?string $channel = null
+    ) : string
     {
-        return $this->paymentMethodsHelper->getPaymentMethods($cartId, $country, $shopperLocale);
+        return $this->paymentMethodsHelper->getPaymentMethods($cartId, $country, $shopperLocale, $channel);
     }
 }

Model/Api/GuestAdyenPaymentMethodManagement.php

@@ -28,10 +28,15 @@ public function __construct(
         $this->paymentMethodsHelper = $paymentMethodsHelper;
     }
 
-    public function getPaymentMethods(string $cartId, ?string $shopperLocale = null, ?string $country = null): string {
+    public function getPaymentMethods(
+        string $cartId,
+        ?string $shopperLocale = null,
+        ?string $country = null,
+        ?string $channel = null
+    ): string {
         $quoteIdMask = $this->quoteIdMaskFactory->create()->load($cartId, 'masked_id');
         $quoteId = $quoteIdMask->getQuoteId();
 
-        return $this->paymentMethodsHelper->getPaymentMethods($quoteId, $country, $shopperLocale);
+        return $this->paymentMethodsHelper->getPaymentMethods($quoteId, $country, $shopperLocale, $channel);
     }
 }

Model/Resolver/GetAdyenPaymentMethods.php

@@ -58,6 +58,7 @@ public function resolve(
         $maskedCartId = $args['cart_id'];
         $shopperLocale = $args['shopper_locale'] ?? null;
         $country = $args['country'] ?? null;
+        $channel = $args['channel'] ?? null;
 
         $currentUserId = $context->getUserId();
         $storeId = (int)$context->getExtensionAttributes()->getStore()->getId();
@@ -68,7 +69,8 @@ public function resolve(
             $adyenPaymentMethodsResponse = $this->paymentMethodsHelper->getPaymentMethods(
                 intval($cart->getId()),
                 $country,
-                $shopperLocale
+                $shopperLocale,
+                $channel
             );
 
             return $adyenPaymentMethodsResponse ? $this->preparePaymentMethodGraphQlResponse($adyenPaymentMethodsResponse) : [];

Test/Unit/Helper/PaymentMethodsFilterTest.php

@@ -18,6 +18,7 @@
 use Magento\Quote\Api\CartRepositoryInterface;
 use Magento\Quote\Api\Data\CartInterface;
 use Magento\Sales\Model\Order\Address;
+use Magento\Framework\App\RequestInterface;
 
 class PaymentMethodsFilterTest extends AbstractAdyenTestCase
 {
@@ -175,17 +176,20 @@ public function testSortAndFilterPaymentMethods(): void
             ])
         ]);
 
-        $cartRepositoryInterfaceMock = $this->createConfiguredMock(CartRepositoryInterface::class, [
-            'get' => $quoteMock
-        ]);
+        $channel = 'iOS';
 
         $paymentMethodsHelperMock = $this->createConfiguredMock(PaymentMethods::class, [
             'getPaymentMethods' => self::PAYMENT_METHODS_RESPONSE
         ]);
 
+        $RequestInterfaceMock = $this->getMockBuilder(RequestInterface::class)
+            ->getMockForAbstractClass();
+
+        $RequestInterfaceMock->method('getParam')->with('channel')->willReturn($channel);
+
         $paymentMethodsFilterHelper = $this->createPaymentMethodsFilterHelper(
             $paymentMethodsHelperMock,
-            $cartRepositoryInterfaceMock
+            $RequestInterfaceMock
         );
 
         $sortedMagentoPaymentMethods =
@@ -201,16 +205,16 @@ public function testSortAndFilterPaymentMethods(): void
 
     protected function createPaymentMethodsFilterHelper(
         $paymentMethodsHelperMock = null,
-        $cartRepositoryInterfaceMock = null
+        $RequestInterfaceMock = null
     ): PaymentMethodsFilter {
         if (is_null($paymentMethodsHelperMock)) {
             $paymentMethodsHelperMock = $this->createMock(PaymentMethods::class);
         }
 
-        if (is_null($cartRepositoryInterfaceMock)) {
-            $cartRepositoryInterfaceMock = $this->createMock(CartRepositoryInterface::class);
+        if (is_null($RequestInterfaceMock)) {
+            $RequestInterfaceMock = $this->createMock(RequestInterface::class);
         }
 
-        return new PaymentMethodsFilter($paymentMethodsHelperMock, $cartRepositoryInterfaceMock);
+        return new PaymentMethodsFilter($paymentMethodsHelperMock, $RequestInterfaceMock);
     }
 }

Test/Unit/Model/Api/AdyenPaymentMethodManagementTest.php

@@ -0,0 +1,48 @@
+<?php
+
+
+namespace Adyen\Payment\Test\Unit\Model\Api;
+
+use Adyen\Payment\Helper\PaymentMethods;
+use Adyen\Payment\Model\Api\AdyenPaymentMethodManagement;
+use Adyen\Payment\Test\Unit\AbstractAdyenTestCase;
+use PHPUnit\Framework\MockObject\MockObject;
+
+class AdyenPaymentMethodManagementTest extends AbstractAdyenTestCase
+{
+    /** @var PaymentMethods|MockObject */
+    private $paymentMethodsHelperMock;
+
+    /** @var AdyenPaymentMethodManagement */
+    private $adyenPaymentMethodManagement;
+
+    protected function setUp(): void
+    {
+        $this->paymentMethodsHelperMock = $this->createMock(PaymentMethods::class);
+
+        $this->adyenPaymentMethodManagement = new AdyenPaymentMethodManagement(
+            $this->paymentMethodsHelperMock
+        );
+    }
+
+    public function testGetPaymentMethods(): void
+    {
+        $cartId = '12345';
+        $shopperLocale = 'en_US';
+        $country = 'US';
+        $channel = 'web';
+
+        // Define the expected result
+        $expectedResult = '["payment_method_1", "payment_method_2"]';
+
+        $this->paymentMethodsHelperMock->expects($this->once())
+            ->method('getPaymentMethods')
+            ->with($cartId, $country, $shopperLocale, $channel)
+            ->willReturn($expectedResult);
+
+        $result = $this->adyenPaymentMethodManagement->getPaymentMethods($cartId, $shopperLocale, $country, $channel);
+
+        // Assert that the result matches the expected result
+        $this->assertEquals($expectedResult, $result);
+    }
+}

Test/Unit/Model/Api/GuestAdyenPaymentMethodManagementTest.php

@@ -0,0 +1,56 @@
+<?php
+
+namespace Adyen\Payment\Test\Unit\Model\Api;
+
+use Adyen\Payment\Model\Api\GuestAdyenPaymentMethodManagement;
+use Adyen\Payment\Helper\PaymentMethods;
+use Adyen\Payment\Test\Unit\AbstractAdyenTestCase;
+use Magento\Quote\Model\QuoteIdMask;
+use Magento\Quote\Model\QuoteIdMaskFactory;
+
+class GuestAdyenPaymentMethodManagementTest extends AbstractAdyenTestCase
+{
+    /** @var QuoteIdMaskFactory|\PHPUnit\Framework\MockObject\MockObject */
+    private $quoteIdMaskFactoryMock;
+
+    /** @var PaymentMethods|\PHPUnit\Framework\MockObject\MockObject */
+    private $paymentMethodsHelperMock;
+
+    /** @var GuestAdyenPaymentMethodManagement */
+    private $guestAdyenPaymentMethodManagement;
+
+    protected function setUp(): void
+    {
+        $this->quoteIdMaskFactoryMock = $this->createGeneratedMock(QuoteIdMaskFactory::class, ['create']);
+        $this->paymentMethodsHelperMock = $this->createMock(PaymentMethods::class);
+
+        $this->guestAdyenPaymentMethodManagement = new GuestAdyenPaymentMethodManagement(
+            $this->quoteIdMaskFactoryMock,
+            $this->paymentMethodsHelperMock
+        );
+    }
+
+    public function testGetPaymentMethods()
+    {
+        $cartId = '123';
+        $quoteId = 123;
+        $shopperLocale = 'en_US';
+        $country = 'US';
+        $channel = 'Web';
+        $expectedPaymentMethods = 'sample_payment_methods';
+
+        $quoteIdMaskMock = $this->createGeneratedMock(QuoteIdMask::class, ['load', 'getQuoteId']);
+        $quoteIdMaskMock->method('load')->willReturn($quoteIdMaskMock);
+        $quoteIdMaskMock->method('getQuoteId')->willReturn($quoteId);
+        $this->quoteIdMaskFactoryMock->method('create')->willReturn($quoteIdMaskMock);
+
+        $this->paymentMethodsHelperMock->expects($this->once())
+            ->method('getPaymentMethods')
+            ->with($quoteId, $country, $shopperLocale, $channel)
+            ->willReturn($expectedPaymentMethods);
+
+        $result = $this->guestAdyenPaymentMethodManagement->getPaymentMethods($cartId, $shopperLocale, $country, $channel);
+
+        $this->assertEquals($expectedPaymentMethods, $result);
+    }
+}