SDK-2377 added failure reasons to idv

getyoti · Jun 20, 2024 · 6748e2d · 6748e2d
1 parent 5ad4d8b
commit 6748e2d
Show file tree

Hide file tree

Showing 8 changed files with 135 additions and 15 deletions.
diff --git a/.php-cs-fixer.cache b/.php-cs-fixer.cache
diff --git a/src/DocScan/Session/Retrieve/IdentityProfile/FailureReasonResponse.php b/src/DocScan/Session/Retrieve/IdentityProfile/FailureReasonResponse.php
@@ -7,21 +7,30 @@ class FailureReasonResponse
     /**
      * @var string
      */
-    private $stringCode;
-
+    private $reasonCode;
     /**
-     * @param string $stringCode
+     * @var RequirementNotMetDetails
      */
-    public function __construct(string $stringCode)
+    private $requirementsNotMetDetails;
+    public function __construct(array $data)
     {
-        $this->stringCode = $stringCode;
+        $this->reasonCode = $data["reason_code"];
+        $this->requirementsNotMetDetails = new RequirementNotMetDetails($data["requirements_not_met_details"]);
     }
 
     /**
      * @return string
      */
-    public function getStringCode(): string
+    public function getReasonCode(): string
+    {
+        return $this->reasonCode;
+    }
+    /**
+     * @return RequirementNotMetDetails
+     */
+    public function getRequirementNotMetDetails(): RequirementNotMetDetails
     {
-        return $this->stringCode;
+        return $this->requirementsNotMetDetails;
     }
+
 }
diff --git a/src/DocScan/Session/Retrieve/IdentityProfile/RequirementNotMetDetails.php b/src/DocScan/Session/Retrieve/IdentityProfile/RequirementNotMetDetails.php
@@ -0,0 +1,76 @@
+<?php
+
+namespace Yoti\DocScan\Session\Retrieve\IdentityProfile;
+
+class RequirementNotMetDetails
+{
+    /**
+     * @var string
+     */
+    private $failureType;
+    /**
+     * @var string
+     */
+    private $documentType;
+    /**
+     * @var string
+     */
+    private $documentCountryIsoCode;
+    /**
+     * @var string
+     */
+    private $auditId;
+    /**
+     * @var string
+     */
+    private $details;
+
+    /**
+     * @param array $data
+     */
+    public function __construct(array $data)
+    {
+        $this->failureType = $data[0]["failure_type"];
+        $this->details = $data[0]["details"];
+        $this->auditId = $data[0]["audit_id"];
+        $this->documentCountryIsoCode = $data[0]["document_country_iso_code"];
+        $this->documentType = $data[0]["document_type"];
+    }
+
+    /**
+     * @return string
+     */
+    public function getFailureType(): string
+    {
+        return $this->failureType;
+    }
+    /**
+     * @return string
+     */
+    public function getDetails(): string
+    {
+        return $this->details;
+    }
+    /**
+     * @return string
+     */
+    public function getAuditId(): string
+    {
+        return $this->auditId;
+    }
+    /**
+     * @return string
+     */
+    public function getDocumentCountryIsoCode(): string
+    {
+        return $this->documentCountryIsoCode;
+    }
+    /**
+     * @return string
+     */
+    public function getDocumentType(): string
+    {
+        return $this->documentType;
+    }
+
+}
diff --git a/src/DocScan/Session/Retrieve/IdentityProfileResponse.php b/src/DocScan/Session/Retrieve/IdentityProfileResponse.php
@@ -35,7 +35,7 @@ public function __construct(array $sessionData)
         $this->result = $sessionData['result'];
 
         if (isset($sessionData['failure_reason'])) {
-            $this->failureReason = new FailureReasonResponse($sessionData['failure_reason']['reason_code']);
+            $this->failureReason = new FailureReasonResponse($sessionData['failure_reason']);
         }
 
         if (isset($sessionData['identity_profile_report'])) {

diff --git a/tests/DocScan/DocScanClientTest.php b/tests/DocScan/DocScanClientTest.php
@@ -513,7 +513,7 @@ public function testParseIdentityProfileResponse()
         $this->assertEquals('someStringHere', $sessionResult->getIdentityProfile()->getSubjectId());
         $this->assertEquals(
             'MANDATORY_DOCUMENT_COULD_NOT_BE_PROVIDED',
-            $sessionResult->getIdentityProfile()->getFailureReason()->getStringCode()
+            $sessionResult->getIdentityProfile()->getFailureReason()->getReasonCode()
         );
 
         $this->assertEquals(

diff --git a/tests/DocScan/Session/Retrieve/GetSessionResultTest.php b/tests/DocScan/Session/Retrieve/GetSessionResultTest.php
@@ -43,6 +43,16 @@ class GetSessionResultTest extends TestCase
         'result' => 'SOME_ANOTHER_STRING',
         'failure_reason' => [
             'reason_code' => 'ANOTHER_STRING',
+            'requirements_not_met_details' => [
+                0 => [
+                        'failure_type' => 'ANOTHER_STRING',
+                        'document_type' => 'ANOTHER_STRING',
+                        'document_country_iso_code' => 'ANOTHER_STRING',
+                        'audit_id' => 'ANOTHER_STRING',
+                        'details' => 'ANOTHER_STRING'
+                    ]
+
+            ]
         ],
         'identity_profile_report' => [],
     ];

diff --git a/tests/DocScan/Session/Retrieve/IdentityProfileResponseTest.php b/tests/DocScan/Session/Retrieve/IdentityProfileResponseTest.php
@@ -13,6 +13,11 @@ class IdentityProfileResponseTest extends TestCase
 {
     private const RESULT = 'DONE';
     private const SUBJECT_ID = 'someStringHere';
+    private const FAILURE_TYPE = 'someStringHere';
+    private const DOCUMENT_TYPE = 'someStringHere';
+    private const DOCUMENT_COUNTRY_ISO_CODE = 'someStringHere';
+    private const AUDIT_ID = 'someStringHere';
+    private const DETAILS = 'someStringHere';
     private const REASON_CODE = 'MANDATORY_DOCUMENT_COULD_NOT_BE_PROVIDED';
     private const IDENTITY_PROFILE_REPORT = [
         'trust_framework' => 'UK_TFIDA',
@@ -47,17 +52,28 @@ public function shouldCreatedCorrectly(): void
             'result' => self::RESULT,
             'failure_reason' => [
                 'reason_code' => self::REASON_CODE,
+                'requirements_not_met_details' => [
+                    0 => [
+                        'failure_type' => self::FAILURE_TYPE,
+                        'document_type' => self::DOCUMENT_TYPE,
+                        'document_country_iso_code' => self::DOCUMENT_COUNTRY_ISO_CODE,
+                        'audit_id' => self::AUDIT_ID,
+                        'details' => self::DETAILS
+                        ]
+                ]
             ],
             'identity_profile_report' => self::IDENTITY_PROFILE_REPORT,
         ];
 
         $result = new IdentityProfileResponse($testData);
-
         $this->assertEquals(self::RESULT, $result->getResult());
         $this->assertEquals(self::SUBJECT_ID, $result->getSubjectId());
         $this->assertEquals((object)self::IDENTITY_PROFILE_REPORT, $result->getIdentityProfileReport());
-
         $this->assertInstanceOf(FailureReasonResponse::class, $result->getFailureReason());
-        $this->assertEquals(self::REASON_CODE, $result->getFailureReason()->getStringCode());
+        $this->assertEquals(self::REASON_CODE, $result->getFailureReason()->getReasonCode());
+        $this->assertEquals(self::FAILURE_TYPE, $result->getFailureReason()->getRequirementNotMetDetails()->getFailureType());
+        //$this->assertEquals(self::DOCUMENT_TYPE, $result->getFailureReason()->getRequirementNotMetDetails()->getDocumentType());
+        //$this->assertEquals(self::AUDIT_ID, $result->getFailureReason()->getRequirementNotMetDetails()->getAuditId());
+        //$this->assertEquals(self::DETAILS, $result->getFailureReason()->getRequirementNotMetDetails()->getDetails());
     }
 }
diff --git a/tests/sample-data/sessionResultIdentityProfileResult.json b/tests/sample-data/sessionResultIdentityProfileResult.json
@@ -9,7 +9,16 @@
     "subject_id": "someStringHere",
     "result": "DONE",
     "failure_reason": {
-      "reason_code": "MANDATORY_DOCUMENT_COULD_NOT_BE_PROVIDED"
+      "reason_code": "MANDATORY_DOCUMENT_COULD_NOT_BE_PROVIDED",
+      "requirements_not_met_details": [
+        {
+          "failure_type": "someStringHere",
+          "document_type": "someStringHere",
+          "document_country_iso_code": "someStringHere",
+          "audit_id": "someStringHere",
+          "details": "someStringHere"
+        }
+      ]
     },
     "identity_profile_report": {
       "trust_framework": "UK_TFIDA",
@@ -31,4 +40,4 @@
       }
     }
   }
-}
+}