SDK-1755:Add http exception response (#230)

* SDK-1755:Add http exception response

* SDK-1755-Add-unit-tests

* SDK-1755:Add abstract Yoti Exception

* SDK-1755:Add response to exceptions

* SDK-1755:Fix phpDoc

* SDK-1755:Fix phpDoc

* SDK-1755:Fix strict comparison

* SDK-1755 Add response to exceptions

Co-authored-by: Rodion Liuborets <[email protected]>

Author: LuborRod

src/Aml/Result.php

@@ -4,6 +4,7 @@
 
 namespace Yoti\Aml;
 
+use Psr\Http\Message\ResponseInterface;
 use Yoti\Exception\AmlException;
 use Yoti\Util\Json;
 
@@ -45,13 +46,14 @@ class Result
      * AmlResult constructor.
      *
      * @param array<string, bool> $result
+     * @param ResponseInterface $response
      *
      * @throws \Yoti\Exception\AmlException
      */
-    public function __construct(array $result)
+    public function __construct(array $result, ResponseInterface $response)
     {
         $this->rawResult = $result;
-        $this->setAttributes();
+        $this->setAttributes($response);
     }
 
     /**
@@ -87,13 +89,15 @@ public function isOnWatchList(): bool
     /**
      * Set attribute values.
      *
+     * @param ResponseInterface $response
+     *
      * @throws \Yoti\Exception\AmlException
      */
-    private function setAttributes(): void
+    private function setAttributes(ResponseInterface $response): void
     {
         $result = $this->rawResult;
         // Check if no attribute is missing from the result
-        self::checkAttributes($result);
+        self::checkAttributes($result, $response);
 
         $this->onPepList = (bool) $result[self::ON_PEP_LIST_KEY];
         $this->onFraudList = (bool) $result[self::ON_FRAUD_LIST_KEY];
@@ -104,10 +108,11 @@ private function setAttributes(): void
      * Check if all the attributes are included in the result.
      *
      * @param array<string, bool> $result
+     * @param ResponseInterface $response
      *
      * @throws \Yoti\Exception\AmlException
      */
-    public static function checkAttributes(array $result): void
+    public static function checkAttributes(array $result, ResponseInterface $response): void
     {
         $expectedAttributes = [
             self::ON_PEP_LIST_KEY,
@@ -119,7 +124,7 @@ public static function checkAttributes(array $result): void
 
         // Throw an error if any expected attribute is missing.
         if (count($missingAttr) > 0) {
-            throw new AmlException('Missing attributes from the result: ' . implode(',', $missingAttr));
+            throw new AmlException('Missing attributes from the result: ' . implode(',', $missingAttr), $response);
         }
     }
 

src/Aml/Service.php

@@ -21,19 +21,19 @@ class Service
     private $sdkId;
 
     /**
-     * @var \Yoti\Util\PemFile
+     * @var PemFile
      */
     private $pemFile;
 
     /**
-     * @var \Yoti\Util\Config
+     * @var Config
      */
     private $config;
 
     /**
      * @param string $sdkId
-     * @param \Yoti\Util\PemFile $pemFile
-     * @param \Yoti\Util\Config $config
+     * @param PemFile $pemFile
+     * @param Config $config
      */
     public function __construct(string $sdkId, PemFile $pemFile, Config $config)
     {
@@ -43,11 +43,11 @@ public function __construct(string $sdkId, PemFile $pemFile, Config $config)
     }
 
     /**
-     * @param \Yoti\Aml\Profile $amlProfile
+     * @param Profile $amlProfile
      *
-     * @return \Yoti\Aml\Result
+     * @return Result
      *
-     * @throws \Yoti\Exception\AmlException
+     * @throws AmlException
      */
     public function performCheck(Profile $amlProfile): Result
     {
@@ -65,15 +65,15 @@ public function performCheck(Profile $amlProfile): Result
         $this->validateAmlResult($response);
 
         // Set and return result
-        return new Result(Json::decode((string) $response->getBody()));
+        return new Result(Json::decode((string)$response->getBody()), $response);
     }
 
     /**
      * Handle request result.
      *
-     * @param \Psr\Http\Message\ResponseInterface $response
+     * @param ResponseInterface $response
      *
-     * @throws \Yoti\Exception\AmlException
+     * @throws AmlException
      */
     private function validateAmlResult(ResponseInterface $response): void
     {
@@ -84,13 +84,13 @@ private function validateAmlResult(ResponseInterface $response): void
             return;
         }
 
-        throw new AmlException($this->getErrorMessage($response));
+        throw new AmlException($this->getErrorMessage($response), $response);
     }
 
     /**
      * Get error message from the response.
      *
-     * @param \Psr\Http\Message\ResponseInterface $response
+     * @param ResponseInterface $response
      *
      * @return string
      */
@@ -106,9 +106,9 @@ private function getErrorMessage(ResponseInterface $response): string
             return $statusCodeMessage;
         }
 
-        $jsonData = Json::decode((string) $response->getBody());
+        $jsonData = Json::decode((string)$response->getBody());
 
-        $errorCode = isset($jsonData['code']) ? $jsonData['code'] : 'Error';
+        $errorCode = $jsonData['code'] ?? 'Error';
 
         // Throw the error message that's included in the response.
         if (isset($jsonData['errors'][0]['property']) && isset($jsonData['errors'][0]['message'])) {

src/DocScan/DocScanClient.php

@@ -15,6 +15,7 @@
 use Yoti\DocScan\Session\Retrieve\Instructions\ContactProfileResponse;
 use Yoti\DocScan\Session\Retrieve\Instructions\InstructionsResponse;
 use Yoti\DocScan\Support\SupportedDocumentsResponse;
+use Yoti\Exception\PemFileException;
 use Yoti\Media\Media;
 use Yoti\Util\Config;
 use Yoti\Util\Env;
@@ -47,7 +48,7 @@ class DocScanClient
      * @param array<string, mixed> $options (optional)
      *   SDK configuration options - {@see \Yoti\Util\Config} for available options.
      *
-     * @throws \Yoti\Exception\PemFileException
+     * @throws PemFileException
      */
     public function __construct(
         string $sdkId,
@@ -102,7 +103,6 @@ public function deleteSession(string $sessionId): void
         $this->docScanService->deleteSession($sessionId);
     }
 
-
     /**
      * Retrieves media related to a Yoti Doc Scan session based
      * on the supplied media ID.

src/DocScan/Exception/DocScanException.php

@@ -4,106 +4,8 @@
 
 namespace Yoti\DocScan\Exception;
 
-use Psr\Http\Message\ResponseInterface;
-use Yoti\Util\Json;
+use Yoti\Exception\base\YotiException;
 
-class DocScanException extends \Exception
+class DocScanException extends YotiException
 {
-    /**
-     * @var ResponseInterface|null
-     */
-    private $response;
-
-    /**
-     * DocScanException constructor.
-     * @param string $message
-     * @param ResponseInterface|null $response
-     * @param \Throwable|null $previous
-     */
-    public function __construct($message = "", ?ResponseInterface $response = null, \Throwable $previous = null)
-    {
-        parent::__construct($this->formatMessage($message, $response), 0, $previous);
-
-        $this->response = $response;
-    }
-
-    /**
-     * Returns the HTTP response object returned
-     * from the Doc Scan API.
-     *
-     * @return ResponseInterface|null
-     */
-    public function getResponse(): ?ResponseInterface
-    {
-        return $this->response;
-    }
-
-    /**
-     * @param string $message
-     * @param ResponseInterface|null $response
-     *
-     * @return string
-     */
-    private function formatMessage(string $message, ?ResponseInterface $response): string
-    {
-        if (
-            $response === null ||
-            !$response->hasHeader('Content-Type') ||
-            $response->getHeader('Content-Type')[0] !== 'application/json'
-        ) {
-            return $message;
-        }
-
-        $jsonData = Json::decode((string) $response->getBody(), false);
-        $formattedResponse = $this->formatResponse($jsonData);
-        if ($formattedResponse !== null) {
-            return sprintf('%s - %s', $message, $formattedResponse);
-        }
-
-        return $message;
-    }
-
-    /**
-     * @param \stdClass $jsonData
-     *
-     * @return string|null
-     */
-    private function formatResponse(\stdClass $jsonData): ?string
-    {
-        if (!isset($jsonData->message) || !isset($jsonData->code)) {
-            return null;
-        }
-
-        $responseMessage = sprintf('%s - %s', $jsonData->code, $jsonData->message);
-
-        $propertyErrors = $this->formatPropertyErrors($jsonData);
-        if (count($propertyErrors) > 0) {
-            return sprintf('%s: %s', $responseMessage, implode(', ', $propertyErrors));
-        }
-
-        return $responseMessage;
-    }
-
-    /**
-     * @param \stdClass $jsonData
-     *
-     * @return string[]
-     */
-    private function formatPropertyErrors(\stdClass $jsonData): array
-    {
-        if (!isset($jsonData->errors) || !is_array($jsonData->errors)) {
-            return [];
-        }
-
-        return array_reduce(
-            $jsonData->errors,
-            function ($carry, $error): array {
-                if (isset($error->property) && isset($error->message)) {
-                    $carry[] = sprintf('%s "%s"', $error->property, $error->message);
-                }
-                return $carry;
-            },
-            []
-        );
-    }
 }

src/DocScan/Service.php

@@ -380,7 +380,7 @@ public function fetchInstructionsContactProfile(string $sessionId): ContactProfi
 
         self::assertResponseIsSuccess($response);
 
-        $result = Json::decode((string)$response->getBody());
+        $result = Json::decode((string) $response->getBody());
 
         return new ContactProfileResponse($result);
     }

src/Exception/ActivityDetailsException.php

@@ -4,6 +4,8 @@
 
 namespace Yoti\Exception;
 
-class ActivityDetailsException extends \Exception
+use Yoti\Exception\base\YotiException;
+
+class ActivityDetailsException extends YotiException
 {
 }

src/Exception/AmlException.php

@@ -4,6 +4,8 @@
 
 namespace Yoti\Exception;
 
-class AmlException extends \Exception
+use Yoti\Exception\base\YotiException;
+
+class AmlException extends YotiException
 {
 }

src/Exception/ShareUrlException.php

@@ -4,6 +4,8 @@
 
 namespace Yoti\Exception;
 
-class ShareUrlException extends \Exception
+use Yoti\Exception\base\YotiException;
+
+class ShareUrlException extends YotiException
 {
 }