feat: get3DFormData support for form data generation without card.

default value of $createWithoutCard is set to true for backward compatibility. In the next major version it will be false. These changes are fix to backward compatibility break on commit ec4e461
mewebstudio · Dec 24, 2024 · 1f460d3 · 1f460d3
1 parent 4eca22c
commit 1f460d3
Show file tree

Hide file tree

Showing 29 changed files with 94 additions and 48 deletions.
diff --git a/docs/PRE-AUTH-POST-EXAMPLE.md b/docs/PRE-AUTH-POST-EXAMPLE.md
@@ -115,7 +115,8 @@ try {
         $order,
         $paymentModel,
         $transactionType,
-        $card
+        $card,
+        false
     );
 } catch (\Exception|\Error $e) {
     var_dump($e);

diff --git a/docs/THREED-PAYMENT-EXAMPLE.md b/docs/THREED-PAYMENT-EXAMPLE.md
@@ -225,7 +225,8 @@ try {
         $order,
         $paymentModel,
         $transactionType,
-        $card
+        $card,
+        false
     );
 } catch (\InvalidArgumentException $e) {
     // örneğin kart bilgisi sağlanmadığında bu exception'i alırsınız.

diff --git a/docs/THREED-SECURE-AND-PAY-PAYMENT-IN-MODALBOX-EXAMPLE.md b/docs/THREED-SECURE-AND-PAY-PAYMENT-IN-MODALBOX-EXAMPLE.md
@@ -144,7 +144,8 @@ try {
         $order,
         $paymentModel,
         $transactionType,
-        $card
+        $card,
+        false
     );
 } catch (\InvalidArgumentException $e) {
     // örneğin kart bilgisi sağlanmadığında bu exception'i alırsınız.

diff --git a/examples/_common-codes/3d/form.php b/examples/_common-codes/3d/form.php
@@ -163,7 +163,7 @@ function (RequestDataPreparedEvent $requestDataPreparedEvent): void {
 // ============================================================================================
 
 try {
-    $formData = $pos->get3DFormData($order, $paymentModel, $transaction, $card);
+    $formData = $pos->get3DFormData($order, $paymentModel, $transaction, $card, false);
     //dd($formData);
 } catch (\InvalidArgumentException $e) {
     // örneğin kart bilgisi sağlanmadığında bu exception'i alırsınız.

diff --git a/src/Gateways/AbstractGateway.php b/src/Gateways/AbstractGateway.php
@@ -655,15 +655,20 @@ protected function is3DAuthSuccess(array $responseData): bool
      * @param PosInterface::MODEL_3D_*                                          $paymentModel
      * @param PosInterface::TX_TYPE_PAY_AUTH|PosInterface::TX_TYPE_PAY_PRE_AUTH $txType
      * @param CreditCardInterface|null                                          $card
+     * @param bool                                                              $createWithoutCard
      *
      * @throws \InvalidArgumentException when inputs are not valid
      */
-    protected function check3DFormInputs(string $paymentModel, string $txType, CreditCardInterface $card = null): void
+    protected function check3DFormInputs(string $paymentModel, string $txType, CreditCardInterface $card = null, bool $createWithoutCard = false): void
     {
         if (!self::isSupportedTransaction($txType, $paymentModel)) {
             throw new \LogicException('Bu banka altyapısı sağlanan ödeme modelini ya da işlem tipini desteklenmiyor.');
         }
 
+        if ($createWithoutCard) {
+            return;
+        }
+
         if ((PosInterface::MODEL_3D_SECURE === $paymentModel || PosInterface::MODEL_3D_PAY === $paymentModel)
             && !$card instanceof \Mews\Pos\Entity\Card\CreditCardInterface) {
             throw new \InvalidArgumentException('Bu ödeme modeli için kart bilgileri zorunlu!');

diff --git a/src/Gateways/AkbankPos.php b/src/Gateways/AkbankPos.php
@@ -158,9 +158,9 @@ public function make3DHostPayment(Request $request, array $order, string $txType
     /**
      * @inheritDoc
      */
-    public function get3DFormData(array $order, string $paymentModel, string $txType, CreditCardInterface $creditCard = null): array
+    public function get3DFormData(array $order, string $paymentModel, string $txType, CreditCardInterface $creditCard = null, bool $createWithoutCard = true): array
     {
-        $this->check3DFormInputs($paymentModel, $txType, $creditCard);
+        $this->check3DFormInputs($paymentModel, $txType, $creditCard, $createWithoutCard);
 
         $this->logger->debug('preparing 3D form data');
 

diff --git a/src/Gateways/EstPos.php b/src/Gateways/EstPos.php
@@ -155,9 +155,9 @@ public function make3DHostPayment(Request $request, array $order, string $txType
     /**
      * @inheritDoc
      */
-    public function get3DFormData(array $order, string $paymentModel, string $txType, CreditCardInterface $creditCard = null): array
+    public function get3DFormData(array $order, string $paymentModel, string $txType, CreditCardInterface $creditCard = null, bool $createWithoutCard = true): array
     {
-        $this->check3DFormInputs($paymentModel, $txType, $creditCard);
+        $this->check3DFormInputs($paymentModel, $txType, $creditCard, $createWithoutCard);
 
         $this->logger->debug('preparing 3D form data');
 

diff --git a/src/Gateways/GarantiPos.php b/src/Gateways/GarantiPos.php
@@ -125,9 +125,9 @@ public function make3DPayPayment(Request $request, array $order, string $txType)
     /**
      * @inheritDoc
      */
-    public function get3DFormData(array $order, string $paymentModel, string $txType, CreditCardInterface $creditCard = null): array
+    public function get3DFormData(array $order, string $paymentModel, string $txType, CreditCardInterface $creditCard = null, bool $createWithoutCard = true): array
     {
-        $this->check3DFormInputs($paymentModel, $txType, $creditCard);
+        $this->check3DFormInputs($paymentModel, $txType, $creditCard, $createWithoutCard);
 
         $this->logger->debug('preparing 3D form data');
 

diff --git a/src/Gateways/InterPos.php b/src/Gateways/InterPos.php
@@ -159,9 +159,9 @@ public function orderHistory(array $order): PosInterface
     /**
      * @inheritDoc
      */
-    public function get3DFormData(array $order, string $paymentModel, string $txType, CreditCardInterface $creditCard = null): array
+    public function get3DFormData(array $order, string $paymentModel, string $txType, CreditCardInterface $creditCard = null, bool $createWithoutCard = true): array
     {
-        $this->check3DFormInputs($paymentModel, $txType, $creditCard);
+        $this->check3DFormInputs($paymentModel, $txType, $creditCard, $createWithoutCard);
 
         $this->logger->debug('preparing 3D form data');
 

diff --git a/src/Gateways/KuveytPos.php b/src/Gateways/KuveytPos.php
@@ -132,9 +132,9 @@ public function orderHistory(array $order): PosInterface
      *
      * @throws SoapFault
      */
-    public function get3DFormData(array $order, string $paymentModel, string $txType, CreditCardInterface $creditCard = null): array
+    public function get3DFormData(array $order, string $paymentModel, string $txType, CreditCardInterface $creditCard = null, bool $createWithoutCard = true): array
     {
-        $this->check3DFormInputs($paymentModel, $txType, $creditCard);
+        $this->check3DFormInputs($paymentModel, $txType, $creditCard, $createWithoutCard);
 
         $this->logger->debug('preparing 3D form data');
 

diff --git a/src/Gateways/PayFlexCPV4Pos.php b/src/Gateways/PayFlexCPV4Pos.php
@@ -174,9 +174,9 @@ public function orderHistory(array $order): PosInterface
     /**
      * {@inheritDoc}
      */
-    public function get3DFormData(array $order, string $paymentModel, string $txType, CreditCardInterface $creditCard = null): array
+    public function get3DFormData(array $order, string $paymentModel, string $txType, CreditCardInterface $creditCard = null, bool $createWithoutCard = true): array
     {
-        $this->check3DFormInputs($paymentModel, $txType, $creditCard);
+        $this->check3DFormInputs($paymentModel, $txType, $creditCard, $createWithoutCard);
 
         /** @var array{CommonPaymentUrl: string|null, PaymentToken: string|null, ErrorCode: string|null, ResponseMessage: string|null} $data */
         $data = $this->registerPayment($order, $txType, $paymentModel, $creditCard);

diff --git a/src/Gateways/PayFlexV4Pos.php b/src/Gateways/PayFlexV4Pos.php
@@ -156,7 +156,7 @@ public function orderHistory(array $order): PosInterface
     /**
      * {@inheritDoc}
      */
-    public function get3DFormData(array $order, string $paymentModel, string $txType, CreditCardInterface $creditCard = null): array
+    public function get3DFormData(array $order, string $paymentModel, string $txType, CreditCardInterface $creditCard = null, bool $createWithoutCard = true): array
     {
         $this->check3DFormInputs($paymentModel, $txType, $creditCard);
 

diff --git a/src/Gateways/PayForPos.php b/src/Gateways/PayForPos.php
@@ -166,9 +166,9 @@ public function orderHistory(array $order): PosInterface
     /**
      * {@inheritDoc}
      */
-    public function get3DFormData(array $order, string $paymentModel, string $txType, CreditCardInterface $creditCard = null): array
+    public function get3DFormData(array $order, string $paymentModel, string $txType, CreditCardInterface $creditCard = null, bool $createWithoutCard = true): array
     {
-        $this->check3DFormInputs($paymentModel, $txType, $creditCard);
+        $this->check3DFormInputs($paymentModel, $txType, $creditCard, $createWithoutCard);
 
         $this->logger->debug('preparing 3D form data');
 

diff --git a/src/Gateways/PosNet.php b/src/Gateways/PosNet.php
@@ -164,7 +164,7 @@ public function make3DHostPayment(Request $request, array $order, string $txType
     /**
      * @inheritDoc
      */
-    public function get3DFormData(array $order, string $paymentModel, string $txType, CreditCardInterface $creditCard = null): array
+    public function get3DFormData(array $order, string $paymentModel, string $txType, CreditCardInterface $creditCard = null, bool $createWithoutCard = true): array
     {
         $this->check3DFormInputs($paymentModel, $txType, $creditCard);
 

diff --git a/src/Gateways/PosNetV1Pos.php b/src/Gateways/PosNetV1Pos.php
@@ -146,9 +146,9 @@ public function make3DHostPayment(Request $request, array $order, string $txType
     /**
      * @inheritDoc
      */
-    public function get3DFormData(array $order, string $paymentModel, string $txType, CreditCardInterface $creditCard = null): array
+    public function get3DFormData(array $order, string $paymentModel, string $txType, CreditCardInterface $creditCard = null, bool $createWithoutCard = true): array
     {
-        $this->check3DFormInputs($paymentModel, $txType, $creditCard);
+        $this->check3DFormInputs($paymentModel, $txType, $creditCard, $createWithoutCard);
 
         $this->logger->debug('preparing 3D form data');
 

diff --git a/src/Gateways/ToslaPos.php b/src/Gateways/ToslaPos.php
@@ -143,9 +143,9 @@ public function make3DHostPayment(Request $request, array $order, string $txType
     /**
      * @inheritDoc
      */
-    public function get3DFormData(array $order, string $paymentModel, string $txType, CreditCardInterface $creditCard = null): array
+    public function get3DFormData(array $order, string $paymentModel, string $txType, CreditCardInterface $creditCard = null, bool $createWithoutCard = true): array
     {
-        $this->check3DFormInputs($paymentModel, $txType, $creditCard);
+        $this->check3DFormInputs($paymentModel, $txType, $creditCard, $createWithoutCard);
 
         $data = $this->registerPayment($order, $paymentModel, $txType);
 

diff --git a/src/Gateways/VakifKatilimPos.php b/src/Gateways/VakifKatilimPos.php
@@ -99,9 +99,9 @@ public function make3DHostPayment(Request $request, array $order, string $txType
     /**
      * @inheritDoc
      */
-    public function get3DFormData(array $order, string $paymentModel, string $txType, CreditCardInterface $creditCard = null): array
+    public function get3DFormData(array $order, string $paymentModel, string $txType, CreditCardInterface $creditCard = null, bool $createWithoutCard = true): array
     {
-        $this->check3DFormInputs($paymentModel, $txType, $creditCard);
+        $this->check3DFormInputs($paymentModel, $txType, $creditCard, $createWithoutCard);
 
         $this->logger->debug('preparing 3D form data');
 

diff --git a/src/PosInterface.php b/src/PosInterface.php
@@ -118,6 +118,7 @@ interface PosInterface
      * @param string                   $paymentModel
      * @param string                   $txType
      * @param CreditCardInterface|null $creditCard
+     * @param bool                     $createWithoutCard 3D ve 3D_PAY ödemelerde kart bilgisi olmadan 3D formu oluşturulmasına izin verir.
      *
      * @return array{gateway: string, method: 'POST'|'GET', inputs: array<string, string>}
      *
@@ -128,7 +129,7 @@ interface PosInterface
      * @throws UnsupportedTransactionTypeException
      * @throws ClientExceptionInterface
      */
-    public function get3DFormData(array $order, string $paymentModel, string $txType, ?CreditCardInterface $creditCard = null): array;
+    public function get3DFormData(array $order, string $paymentModel, string $txType, ?CreditCardInterface $creditCard = null, bool $createWithoutCard = true): array;
 
     /**
      * Regular Payment

diff --git a/tests/Unit/DataMapper/RequestDataMapper/AkbankPosRequestDataMapperTest.php b/tests/Unit/DataMapper/RequestDataMapper/AkbankPosRequestDataMapperTest.php
@@ -39,7 +39,6 @@ class AkbankPosRequestDataMapperTest extends TestCase
 
     private array $order;
 
-    /** @var MockObject|EventDispatcherInterface */
     private EventDispatcherInterface $dispatcher;
 
     protected function setUp(): void

diff --git a/tests/Unit/Gateways/AkbankPosTest.php b/tests/Unit/Gateways/AkbankPosTest.php
@@ -404,14 +404,15 @@ public function testGet3DFormDataWithBadInputs(
         string $paymentModel,
         string $txType,
         bool   $isWithCard,
+        bool   $createWithoutCard,
         string $expectedExceptionClass
     ): void
     {
         $card = $isWithCard ? $this->card : null;
 
         $this->expectException($expectedExceptionClass);
 
-        $this->pos->get3DFormData($order, $paymentModel, $txType, $card);
+        $this->pos->get3DFormData($order, $paymentModel, $txType, $card, $createWithoutCard);
     }
 
     /**
@@ -875,20 +876,23 @@ public static function threeDFormDataBadInputsProvider(): array
                 'paymentModel'           => PosInterface::MODEL_3D_SECURE,
                 'txType'                 => PosInterface::TX_TYPE_PAY_AUTH,
                 'isWithCard'             => false,
+                'create_with_card'       => false,
                 'expectedExceptionClass' => \InvalidArgumentException::class,
             ],
             '3d_pay_without_card' => [
                 'order'                  => ['id' => '2020110828BC'],
                 'paymentModel'           => PosInterface::MODEL_3D_PAY,
                 'txType'                 => PosInterface::TX_TYPE_PAY_AUTH,
                 'isWithCard'             => false,
+                'create_with_card'       => false,
                 'expectedExceptionClass' => \InvalidArgumentException::class,
             ],
             'unsupported_payment_model' => [
                 'order'                  => ['id' => '2020110828BC'],
                 'paymentModel'           => PosInterface::MODEL_3D_PAY_HOSTING,
                 'txType'                 => PosInterface::TX_TYPE_PAY_AUTH,
                 'isWithCard'             => false,
+                'create_with_card'       => true,
                 'expectedExceptionClass' => \LogicException::class,
             ],
         ];

diff --git a/tests/Unit/Gateways/EstPosTest.php b/tests/Unit/Gateways/EstPosTest.php
@@ -186,14 +186,15 @@ public function testGet3DFormDataWithBadInputs(
         string $paymentModel,
         string $txType,
         bool   $isWithCard,
+        bool   $createWithoutCard,
         string $expectedExceptionClass
     ): void
     {
         $card = $isWithCard ? $this->card : null;
 
         $this->expectException($expectedExceptionClass);
 
-        $this->pos->get3DFormData($order, $paymentModel, $txType, $card);
+        $this->pos->get3DFormData($order, $paymentModel, $txType, $card, $createWithoutCard);
     }
 
     /**
@@ -831,13 +832,15 @@ public static function threeDFormDataBadInputsProvider(): array
                 'paymentModel'           => PosInterface::MODEL_3D_SECURE,
                 'txType'                 => PosInterface::TX_TYPE_PAY_AUTH,
                 'isWithCard'             => false,
+                'create_with_card'       => false,
                 'expectedExceptionClass' => \InvalidArgumentException::class,
             ],
             '3d_pay_without_card' => [
                 'order'                  => ['id' => '2020110828BC'],
                 'paymentModel'           => PosInterface::MODEL_3D_PAY,
                 'txType'                 => PosInterface::TX_TYPE_PAY_AUTH,
                 'isWithCard'             => false,
+                'create_with_card'       => false,
                 'expectedExceptionClass' => \InvalidArgumentException::class,
             ],
         ];

diff --git a/tests/Unit/Gateways/GarantiPosTest.php b/tests/Unit/Gateways/GarantiPosTest.php
@@ -175,14 +175,15 @@ public function testGet3DFormDataWithBadInputs(
         string $paymentModel,
         string $txType,
         bool   $isWithCard,
+        bool   $createWithoutCard,
         string $expectedExceptionClass
     ): void
     {
         $card = $isWithCard ? $this->card : null;
 
         $this->expectException($expectedExceptionClass);
 
-        $this->pos->get3DFormData($order, $paymentModel, $txType, $card);
+        $this->pos->get3DFormData($order, $paymentModel, $txType, $card, $createWithoutCard);
     }
 
     /**
@@ -741,25 +742,28 @@ public static function orderHistoryRequestDataProvider(): array
     public static function threeDFormDataBadInputsProvider(): array
     {
         return [
-            '3d_secure_without_card' => [
+            '3d_secure_without_card'    => [
                 'order'                  => ['id' => '2020110828BC'],
                 'paymentModel'           => PosInterface::MODEL_3D_SECURE,
                 'txType'                 => PosInterface::TX_TYPE_PAY_AUTH,
                 'isWithCard'             => false,
+                'create_with_card'       => false,
                 'expectedExceptionClass' => \InvalidArgumentException::class,
             ],
-            '3d_pay_without_card' => [
+            '3d_pay_without_card'       => [
                 'order'                  => ['id' => '2020110828BC'],
                 'paymentModel'           => PosInterface::MODEL_3D_PAY,
                 'txType'                 => PosInterface::TX_TYPE_PAY_AUTH,
                 'isWithCard'             => false,
+                'create_with_card'       => false,
                 'expectedExceptionClass' => \InvalidArgumentException::class,
             ],
             'unsupported_payment_model' => [
                 'order'                  => ['id' => '2020110828BC'],
                 'paymentModel'           => PosInterface::MODEL_3D_HOST,
                 'txType'                 => PosInterface::TX_TYPE_PAY_AUTH,
                 'isWithCard'             => false,
+                'create_with_card'       => true,
                 'expectedExceptionClass' => \LogicException::class,
             ],
         ];