Merge pull request #12 from lamoda/feature/get-state-additional-info

add additionalFields in GetState response

Author: retvain

.gitignore

@@ -1,4 +1,6 @@
 vendor/
 composer.lock
 
+.idea
+
 .php_cs.cache

src/TerminalResponse.php

@@ -81,6 +81,11 @@ final class TerminalResponse
      */
     private $errorCode = '';
 
+    /**
+     * @var array|null
+     */
+    private $additionalInfo;
+
     /**
      * @param string $success Operation success flag
      * @param mixed $orderId Payment ID in Merchant system
@@ -116,6 +121,11 @@ public function getRrn(): ?string
         return $this->rrn;
     }
 
+    public function getAdditionalInfo(): ?array
+    {
+        return $this->additionalInfo;
+    }
+
     public function getSessionId(): string
     {
         return $this->sessionId;
@@ -159,6 +169,11 @@ public function setRrn(string $rrn): void
         $this->rrn = $rrn;
     }
 
+    public function setAdditionalInfo(array $additionalInfo): void
+    {
+        $this->additionalInfo = $additionalInfo;
+    }
+
     public function isNewState(): bool
     {
         return $this->isStateEqual(static::STATE_NEW);

src/TerminalResponseBuilder.php

@@ -16,7 +16,9 @@ public static function parseTransportResponse(
         string $transportResponse,
         PaytureOperation $operation
     ): TerminalResponse {
-        $attributes = self::parseAttributesFromXmlResponse($transportResponse, self::mapOperationToRootNode($operation));
+        $response = self::parseXmlResponse($transportResponse, self::mapOperationToRootNode($operation));
+
+        $attributes = $response['@attributes'];
 
         if (!isset($attributes['Success'])) {
             throw InvalidResponseException::becauseUndefinedSuccessAttribute();
@@ -48,13 +50,17 @@ public static function parseTransportResponse(
             $result->setRrn($attributes['RRN']);
         }
 
+        if (isset($response['AddInfo'])) {
+            $result->setAdditionalInfo($response['AddInfo']);
+        }
+
         return $result;
     }
 
     /**
      * @throws InvalidResponseException
      */
-    private static function parseAttributesFromXmlResponse(string $xml, string $operation): array
+    private static function parseXmlResponse(string $xml, string $operation): array
     {
         $oldUseInternalXmlErrors = libxml_use_internal_errors(true);
         $rootNode = simplexml_load_string($xml);
@@ -74,7 +80,26 @@ private static function parseAttributesFromXmlResponse(string $xml, string $oper
             throw InvalidResponseException::becauseEmptyAttributes();
         }
 
-        return $data['@attributes'];
+        $result = [];
+        $result['@attributes'] = $data['@attributes'];
+
+        if (isset($data['AddInfo'])) {
+            $result['AddInfo'] = self::parseAddInfo($data['AddInfo']);
+        }
+
+        return $result;
+    }
+
+    private static function parseAddInfo(array $rawAddInfo): array
+    {
+        $result = [];
+
+        foreach ($rawAddInfo as $info) {
+            $infoArray = (array) $info;
+            $result[$infoArray['@attributes']['Key']] = $infoArray['@attributes']['Value'];
+        }
+
+        return $result;
     }
 
     private static function mapOperationToRootNode(PaytureOperation $operation): string

tests/Unit/PaytureInPayTerminalTest.php

@@ -173,6 +173,42 @@ public function testGetState(): void
         self::assertEquals($orderId, $response->getOrderId());
     }
 
+    public function testGetStateWithAdditionalInfo(): void
+    {
+        $rrn = '003770024290';
+        $orderId = 'Order-123';
+        $this->transport->expects($this->once())
+            ->method('request')
+            ->with(
+                PaytureOperation::GET_STATE(),
+                'apim',
+                [
+                    'Key' => 'MerchantKey',
+                    'OrderId' => $orderId,
+                ]
+            )->willReturn('<GetState Success="True" OrderId="'.$orderId.'" State="Refunded" 
+                Forwarded="False" MerchantContract="Merchant" Amount="12464" RRN="'.$rrn.'" VWUserLgn="123@ya.ru" 
+                CardId="bd712147-48da-2ffc-ef31-8341806c65cf" PANMask="521885xxxxxx5484">
+                <AddInfo Key="PaymentSystem" Value="MasterCard" />
+                <AddInfo Key="BankHumanName" Value="SBERBANK" />
+                <AddInfo Key="BankCountryCode" Value="RU" />
+                <AddInfo Key="BankCity" Value="" />
+                </GetState>');
+
+        $response = $this->terminal->getState($orderId);
+
+        self::assertTrue($response->isSuccess());
+        self::assertTrue($response->isRefundedState());
+        self::assertEquals($rrn, $response->getRrn());
+        self::assertEquals($orderId, $response->getOrderId());
+        self::assertEquals([
+            'BankCity' => '',
+            'BankHumanName' => 'SBERBANK',
+            'PaymentSystem' => 'MasterCard',
+            'BankCountryCode' => 'RU'
+        ], $response->getAdditionalInfo());
+    }
+
     public function testCreatingPaymentUrl(): void
     {
         self::assertEquals(