feat: Add ability to know the payment method related to a fee plan (#225)

* feat: Add ability to know the payment method related to a fee plan

* feat: refactor interface

* feat: add test and more conditions

* fix: review

* fix: remove unused use

---------

Co-authored-by: Benjamin Freoua <benjamin.freoua@getalma.eu>

Author: webaaz

src/Domain/Entity/PaymentPlanTrait.php

@@ -2,6 +2,8 @@
 
 namespace Alma\API\Domain\Entity;
 
+use Alma\API\Domain\ValueObject\PaymentMethod;
+
 /**
  * Trait PaymentPlanTrait
  *
@@ -24,6 +26,25 @@ public function getPlanKey(): string
         );
     }
 
+    /**
+     * Get the payment method this payment plan applies to.
+     *
+     * @return string
+     */
+    public function getPaymentMethod(): string
+    {
+        if ($this->isCredit()) {
+            $paymentMethod = PaymentMethod::CREDIT;
+        } elseif ($this->isPnXOnly()) {
+            $paymentMethod = PaymentMethod::PNX;
+        } elseif ($this->isPayLaterOnly()) {
+            $paymentMethod = PaymentMethod::PAY_LATER;
+        } else {
+            $paymentMethod = PaymentMethod::PAY_NOW;
+        }
+        return $paymentMethod;
+    }
+
     /**
      * Check if a payment plan is "pay later" compliant.
      * Warning, a payment plan can be both un-compliant with "pay later" nor "PnX".

src/Domain/Repository/GatewayRepositoryInterface.php

@@ -3,5 +3,5 @@
 namespace Alma\API\Domain\Repository;
 
 interface GatewayRepositoryInterface {
-    public function findAllAlmaGateways(): array;
+    public function findOrderedAlmaGateways(): array;
 }

src/Domain/ValueObject/PaymentMethod.php

@@ -14,4 +14,4 @@ final class PaymentMethod
     public const PAY_NOW = 'paynow';
     public const CREDIT = 'credit';
     public const PNX = 'pnx';
-}
+}

tests/Unit/Infrastructure/CurlClientTest.php

@@ -89,9 +89,6 @@ public function stringToStream(string $string): Stream
         return new Stream($resourceFromString);
     }
 
-    /**
-     * @throws ClientException
-     */
     public function testConfig()
     {
         $client = new CurlClient($this->clientConfiguration);

tests/Unit/Infrastructure/Endpoint/Entity/PaymentPlanTraitTest.php

@@ -22,8 +22,8 @@ public static function paymentPlanProvider(): array
                     'plan_key' => 'general_4_0_0',
                     'is_pay_later_only' => false,
                     'is_pnx_only' => true,
-                    'is_both_pnx_and_pay_later' => false,
                     'is_pay_now' => false,
+                    'payment_method' => 'pnx',
                 ]
             ],
             'paylater_deferred_months' => [
@@ -37,8 +37,8 @@ public static function paymentPlanProvider(): array
                     'plan_key' => 'general_1_0_3',
                     'is_pay_later_only' => true,
                     'is_pnx_only' => false,
-                    'is_both_pnx_and_pay_later' => false,
                     'is_pay_now' => false,
+                    'payment_method' => 'paylater',
                 ]
             ],
             'paylater_deferred_days' => [
@@ -52,23 +52,8 @@ public static function paymentPlanProvider(): array
                     'plan_key' => 'general_1_30_0',
                     'is_pay_later_only' => true,
                     'is_pnx_only' => false,
-                    'is_both_pnx_and_pay_later' => false,
-                    'is_pay_now' => false,
-                ]
-            ],
-            'pnx_and_paylater' => [
-                'params' => [
-                    'kind' => 'general',
-                    'installments_count' => 3,
-                    'deferred_days' => 15,
-                    'deferred_months' => 0,
-                ],
-                'expected' => [
-                    'plan_key' => 'general_3_15_0',
-                    'is_pay_later_only' => false,
-                    'is_pnx_only' => false,
-                    'is_both_pnx_and_pay_later' => true,
                     'is_pay_now' => false,
+                    'payment_method' => 'paylater',
                 ]
             ],
             'pay_now' => [
@@ -82,8 +67,8 @@ public static function paymentPlanProvider(): array
                     'plan_key' => 'general_1_0_0',
                     'is_pay_later_only' => false,
                     'is_pnx_only' => false,
-                    'is_both_pnx_and_pay_later' => false,
                     'is_pay_now' => true,
+                    'payment_method' => 'paynow',
                 ]
             ]
         ];
@@ -135,7 +120,7 @@ public function getDeferredMonths(): int
         $this->assertEquals($expected['plan_key'], $paymentPlanImplementation->getPlanKey());
         $this->assertEquals($expected['is_pay_later_only'], $paymentPlanImplementation->isPayLaterOnly());
         $this->assertEquals($expected['is_pnx_only'], $paymentPlanImplementation->isPnXOnly());
-        $this->assertEquals($expected['is_both_pnx_and_pay_later'], $paymentPlanImplementation->isBothPnxAndPayLater());
         $this->assertEquals($expected['is_pay_now'], $paymentPlanImplementation->isPayNow());
+        $this->assertEquals($expected['payment_method'], $paymentPlanImplementation->getPaymentMethod());
     }
 }