PHPSDK-192 Add isWallet method to PaymentMethod (#403)

Author: Miguel-MultiSafepay

src/Api/PaymentMethods/PaymentMethod.php

@@ -29,6 +29,7 @@ class PaymentMethod
     public const TOKENIZATION_KEY = 'tokenization';
     public const TOKENIZATION_MODELS_KEY = 'models';
     public const IS_ENABLED_KEY = 'is_enabled';
+    public const IS_WALLET_KEY = 'is_wallet';
     public const SHOPPING_CART_REQUIRED_KEY = 'shopping_cart_required';
     public const PREFERRED_COUNTRIES_KEY = 'preferred_countries';
     public const ALLOWED_COUNTRIES_KEY = 'allowed_countries';
@@ -120,6 +121,11 @@ class PaymentMethod
      */
     private $manualCapture;
 
+    /**
+     * @var bool
+     */
+    private $isWallet;
+
     /**
      * Transaction constructor.
      * @param array $data
@@ -142,6 +148,7 @@ public function __construct(array $data)
         $this->iconUrls = $data[self::ICON_URLS_KEY] ?? '';
         $this->requiredCustomerData = $data[self::REQUIRED_CUSTOMER_DATA_KEY] ?? null;
         $this->manualCapture = $data[self::MANUAL_CAPTURE_KEY] ?? [];
+        $this->isWallet = (bool)($data[self::IS_WALLET_KEY] ?? false);
     }
 
     /**
@@ -374,6 +381,14 @@ public function isCoupon()
         return $this->getType() === self::COUPON_TYPE;
     }
 
+    /**
+     * @return bool
+     */
+    public function isWallet(): bool
+    {
+        return $this->isWallet;
+    }
+
     /**
      * Return an array with the payment method object information
      *
@@ -393,6 +408,7 @@ public function getData(): array
             self::ALLOWED_CURRENCIES_KEY => $this->allowedCurrencies,
             self::ALLOWED_COUNTRIES_KEY => $this->allowedCountries,
             self::APPS_KEY => $this->apps,
+            self::IS_WALLET_KEY => $this->isWallet,
             self::TOKENIZATION_KEY => [
                 self::IS_ENABLED_KEY => $this->tokenization[self::IS_ENABLED_KEY] ?? false,
                 self::TOKENIZATION_MODELS_KEY => [

tests/Unit/Api/PaymentMethods/PaymentMethodTest.php

@@ -1,11 +1,13 @@
 <?php declare(strict_types=1);
 namespace MultiSafepay\Tests\Unit\Api\PaymentMethods;
 
+use Exception;
 use MultiSafepay\Api\PaymentMethodManager;
 use MultiSafepay\Api\PaymentMethods\PaymentMethod;
 use MultiSafepay\Exception\InvalidDataInitializationException;
 use MultiSafepay\Tests\Integration\MockClient;
 use PHPUnit\Framework\TestCase;
+use Psr\Http\Client\ClientExceptionInterface;
 
 /**
  * Class PaymentMethodTest
@@ -23,9 +25,11 @@ class PaymentMethodTest extends TestCase
      */
     private $wrongData;
 
-
     /**
      * Test normal initialization
+     *
+     * @throws Exception
+     * @throws ClientExceptionInterface
      */
     public function testNormalInitialization()
     {
@@ -50,6 +54,9 @@ public function testNormalInitialization()
 
     /**
      * Test wrong initialization
+     *
+     * @throws Exception
+     * @throws ClientExceptionInterface
      */
     public function testIncompleteData()
     {
@@ -151,6 +158,65 @@ public function testGetDataIncludesManualCaptureWhenEnabled()
         $this->assertTrue($result[PaymentMethod::MANUAL_CAPTURE_KEY][PaymentMethod::IS_ENABLED_KEY]);
         $this->assertTrue($result[PaymentMethod::MANUAL_CAPTURE_KEY][PaymentMethod::SUPPORTED_KEY]);
     }
+    
+    /**
+     * Test if the wallet payment method is detected from the payload
+     *
+     * @throws InvalidDataInitializationException
+     */
+    public function testIsWalletReturnsTrueWhenPayloadMarksWallet()
+    {
+        $data = $this->getValidData();
+        $data[PaymentMethod::IS_WALLET_KEY] = true;
+        
+        $paymentMethod = new PaymentMethod($data);
+        
+        $this->assertTrue($paymentMethod->isWallet());
+    }
+    
+    /**
+     * Test if a non-wallet payment method is detected from the payload
+     *
+     * @throws InvalidDataInitializationException
+     */
+    public function testIsWalletReturnsFalseWhenPayloadDoesNotMarkWallet()
+    {
+        $paymentMethod = new PaymentMethod($this->getValidData());
+        
+        $this->assertFalse($paymentMethod->isWallet());
+    }
+    
+    /**
+     * Test if wallet defaults to false when payload omits is_wallet
+     *
+     * @throws InvalidDataInitializationException
+     */
+    public function testIsWalletReturnsFalseWhenIsWalletKeyIsMissing()
+    {
+        $data = $this->getValidData();
+        unset($data[PaymentMethod::IS_WALLET_KEY]);
+        
+        $paymentMethod = new PaymentMethod($data);
+        
+        $this->assertFalse($paymentMethod->isWallet());
+    }
+    
+    /**
+     * Test if getData includes wallet flag
+     *
+     * @throws InvalidDataInitializationException
+     */
+    public function testGetDataIncludesIsWallet()
+    {
+        $data = $this->getValidData();
+        $data[PaymentMethod::IS_WALLET_KEY] = true;
+        
+        $paymentMethod = new PaymentMethod($data);
+        $result = $paymentMethod->getData();
+        
+        $this->assertArrayHasKey(PaymentMethod::IS_WALLET_KEY, $result);
+        $this->assertTrue($result[PaymentMethod::IS_WALLET_KEY]);
+    }
 
     /**
      * @return array
@@ -205,6 +271,7 @@ private function getValidData(): array
                 PaymentMethod::ICON_URLS_VECTOR_KEY => 'https://example.com/visa.svg',
             ],
             PaymentMethod::ALLOWED_CURRENCIES_KEY => ['EUR'],
+            PaymentMethod::IS_WALLET_KEY => false,
         ];
     }