✨ feat: Return of the request response header

guilherme-cota-efi · guilherme-cota-efi · commit c7447ba64f07 · 2024-07-19T12:04:03.000-03:00
diff --git a/src/Efi/ApiRequest.php b/src/Efi/ApiRequest.php
@@ -68,7 +68,8 @@ public function send(string $method, string $route, string $scope, array $body)
                     'error' => $e->getResponse(),
                     'error_description' => $e->getResponse()->getBody()
                 ],
-                $e->getResponse()->getStatusCode()
+                $e->getResponse()->getStatusCode(),
+                $e->getResponse()->getHeaders()
             );
         }
     }
diff --git a/src/Efi/Auth.php b/src/Efi/Auth.php
@@ -47,7 +47,7 @@ public function authorize()
     {
         $this->initializeRequestOptions();
         $response = $this->sendAuthorizationRequest();
-        $this->processAuthorizationResponse($response);
+        $this->processAuthorizationResponse(($this->config['responseHeaders']) ? $response->body : $response);
     }
 
     /**
diff --git a/src/Efi/Config.php b/src/Efi/Config.php
@@ -54,6 +54,7 @@ public static function options(array $options): array
         $conf['sandbox'] = (bool) isset($options['sandbox']) ? filter_var($options['sandbox'], FILTER_VALIDATE_BOOLEAN) : false;
         $conf['debug'] = (bool) isset($options['debug']) ? filter_var($options['debug'], FILTER_VALIDATE_BOOLEAN) : false;
         $conf['cache'] = (bool) isset($options['cache']) ? filter_var($options['cache'], FILTER_VALIDATE_BOOLEAN) : true;
+        $conf['responseHeaders'] = (bool) isset($options['responseHeaders']) ? filter_var($options['responseHeaders'], FILTER_VALIDATE_BOOLEAN) : false;
         $conf['timeout'] = (float) isset($options['timeout']) ? $options['timeout'] : 30.0;
         $conf['clientId'] = (string) isset($options['client_id']) || isset($options['clientId']) ? $options['client_id'] ?? $options['clientId'] : null;
         $conf['clientSecret'] = (string) isset($options['client_secret']) || isset($options['clientSecret']) ? $options['client_secret'] ?? $options['clientSecret'] : null;
diff --git a/src/Efi/Exception/EfiException.php b/src/Efi/Exception/EfiException.php
@@ -14,6 +14,7 @@
  */
 class EfiException extends Exception
 {
+    private $headers;
     private $error;
     private $errorDescription;
 
@@ -23,7 +24,7 @@ class EfiException extends Exception
      * @param mixed $exception The original exception or error response.
      * @param int   $code      The error code.
      */
-    public function __construct($api, $exception, int $code)
+    public function __construct($api, $exception, int $code, array $headers)
     {
         $error = $exception;
 
@@ -52,7 +53,7 @@ public function __construct($api, $exception, int $code)
                 break;
         }
 
-        $this->handleException($exceptionClass, $error, $code);
+        $this->handleException($exceptionClass, $error, $code, $headers);
     }
 
     /**
@@ -78,13 +79,14 @@ private function parseStream(\GuzzleHttp\Psr7\Stream $stream)
      * @param array $error The error response array.
      * @param int   $code  The error code.
      */
-    private function handleException(string $exceptionClass, array $error, int $code)
+    private function handleException(string $exceptionClass, array $error, int $code, array $headers)
     {
         $exception = new $exceptionClass($error, $code);
         $this->error = $exception->error;
         $this->errorDescription = $exception->errorDescription;
         $this->code = $exception->code;
         $this->message = $exception->message;
+        $this->headers = $headers;
     }
 
     /**
diff --git a/src/Efi/Request.php b/src/Efi/Request.php
@@ -6,6 +6,7 @@
 use GuzzleHttp\Exception\ClientException;
 use GuzzleHttp\Exception\ServerException;
 use Efi\Exception\EfiException;
+use Efi\Response;
 
 class Request extends BaseModel
 {
@@ -69,7 +70,7 @@ private function verifyCertificate(string $certificate): string
 
             return $certPath;
         } else {
-            $this->throwEfiException('Certificado não encontrado', 403);
+            $this->throwEfiException('Certificado não encontrado', 403, ['headers' => []]);
         }
     }
 
@@ -85,7 +86,7 @@ private function readCertificateFile(string $certPath): string
     {
         $fileContents = file_get_contents($certPath);
         if (!$fileContents) {
-            $this->throwEfiException('Não foi possível ler o arquivo de certificado', 403);
+            $this->throwEfiException('Não foi possível ler o arquivo de certificado', 403, ['headers' => []]);
         }
         return $fileContents;
     }
@@ -107,7 +108,7 @@ private function validateCertificate(string $fileContents, string $certPath): vo
 
         $publicKey = openssl_x509_parse($fileContents);
         if (!$publicKey) {
-            $this->throwEfiException('Certificado inválido ou inativo', 403);
+            $this->throwEfiException('Certificado inválido ou inativo', 403, ['headers' => []]);
         }
 
         $this->checkCertificateEnviroment($publicKey['issuer']['CN']);
@@ -125,7 +126,7 @@ private function validateCertificate(string $fileContents, string $certPath): vo
     private function readP12Certificate(string $fileContents): array
     {
         if (!openssl_pkcs12_read($fileContents, $certData, $this->config['pwdCertificate'])) {
-            $this->throwEfiException('Não foi possível ler o arquivo de certificado p12', 403);
+            $this->throwEfiException('Não foi possível ler o arquivo de certificado p12', 403, ['headers' => []]);
         }
         return $certData;
     }
@@ -139,9 +140,9 @@ private function readP12Certificate(string $fileContents): array
     private function checkCertificateEnviroment(string $issuerCn): void
     {
         if ($this->config['sandbox'] === true && ($issuerCn === 'apis.sejaefi.com.br' || $issuerCn ===  'apis.efipay.com.br' || $issuerCn ===  'api-pix.gerencianet.com.br')) {
-            $this->throwEfiException('Certificado de produção inválido para o ambiente escolhido [homologação].', 403);
+            $this->throwEfiException('Certificado de produção inválido para o ambiente escolhido [homologação].', 403, ['headers' => []]);
         } elseif (!$this->config['sandbox'] && ($issuerCn === 'apis-h.sejaefi.com.br' || $issuerCn ===  'apis-h.efipay.com.br' || $issuerCn ===  'api-pix-h.gerencianet.com.br')) {
-            $this->throwEfiException('Certificado de homologação inválido para o ambiente escolhido [produção].', 403);
+            $this->throwEfiException('Certificado de homologação inválido para o ambiente escolhido [produção].', 403, ['headers' => []]);
         }
     }
 
@@ -156,7 +157,7 @@ private function checkCertificateExpiration(string $validToTime): void
         $today = date("Y-m-d H:i:s");
         $validTo = date('Y-m-d H:i:s', $validToTime);
         if ($validTo <= $today) {
-            $this->throwEfiException('O certificado de autenticação expirou em ' . $validTo, 403);
+            $this->throwEfiException('O certificado de autenticação expirou em ' . $validTo, 403, ['headers' => []]);
         }
     }
 
@@ -166,7 +167,7 @@ private function checkCertificateExpiration(string $validToTime): void
      * @param string $method The HTTP method.
      * @param string $route The URL route.
      * @param array $requestOptions The request options.
-     * @return mixed The response data.
+     * @return object The response data.
      * @throws EfiException If there is an EFI Pay specific error.
      */
 
@@ -180,7 +181,7 @@ public function send(string $method, string $route, array $requestOptions)
         } catch (ClientException $e) {
             throw $this->handleClientException($e);
         } catch (ServerException $se) {
-            $this->throwEfiException($se->getResponse()->getBody(), $se->getResponse()->getStatusCode());
+            $this->throwEfiException($se->getResponse()->getBody(), $se->getResponse()->getStatusCode(), $se->getResponse()->getHeaders());
         }
     }
 
@@ -228,21 +229,24 @@ private function mergeHeaders(array $requestOptions, array $defaultHeaders): arr
 
     private function processResponse($response)
     {
-        $headersResponse = $response->getHeader('Content-Type');
+        $headersResponse = $this->config['responseHeaders'] ? $response->getHeaders() : $response->getHeader('Content-Type');
 
-        if (isset($headersResponse[0]) && stristr(substr($headersResponse[0], 0, strpos($headersResponse[0], ';')), 'application/json')) {
-            return json_decode($response->getBody(), true);
+        $contentType = isset($headersResponse['Content-Type'][0]) ? $headersResponse['Content-Type'][0] : $headersResponse[0];
+
+        if (stristr($contentType, 'application/json')) {
+            $bodyResponse = json_decode($response->getBody(), true);
         } else {
             $bodyResponse = $response->getBody()->getContents();
+        }
 
-            if ($bodyResponse) {
-                return $bodyResponse;
-            } else {
-                return ["code" => $response->getStatusCode()];
-            }
+        if ($this->config['responseHeaders']) {
+            return new Response($bodyResponse ?: ["code" => $response->getStatusCode()], $headersResponse);
         }
+
+        return $bodyResponse ?: ["code" => $response->getStatusCode()];
     }
 
+
     /**
      * Handles the ClientException and creates an EFI exception.
      *
@@ -252,16 +256,18 @@ private function processResponse($response)
 
     private function handleClientException(ClientException $e): EfiException
     {
+        $responseHeaders = $e->getResponse()->getHeaders();
         if (is_array(json_decode($e->getResponse()->getBody(), true))) {
-            return new EfiException($this->config['api'], json_decode($e->getResponse()->getBody(), true), $e->getResponse()->getStatusCode());
+            return new EfiException($this->config['api'], json_decode($e->getResponse()->getBody(), true), $e->getResponse()->getStatusCode(), $responseHeaders);
         } else {
             return new EfiException(
                 $this->config['api'],
                 [
                     'error' => $e->getResponse()->getReasonPhrase(),
                     'error_description' => $e->getResponse()->getBody()
                 ],
-                $e->getResponse()->getStatusCode()
+                $e->getResponse()->getStatusCode(),
+                $responseHeaders
             );
         }
     }
@@ -273,12 +279,12 @@ private function handleClientException(ClientException $e): EfiException
      * @param int $statusCode HTTP status code.
      * @throws EfiException The EfiException.
      */
-    private function throwEfiException(string $message, int $statusCode): void
+    private function throwEfiException(string $message, int $statusCode, array $headers): void
     {
         if (is_array(json_decode($message, true))) {
-            throw new EfiException($this->config['api'], json_decode($message, true), $statusCode);
+            throw new EfiException($this->config['api'], json_decode($message, true), $statusCode, $headers);
         } else {
-            throw new EfiException($this->config['api'], ['error' => 'forbidden', 'error_description' => $message], $statusCode);
+            throw new EfiException($this->config['api'], ['error' => 'forbidden', 'error_description' => $message], $statusCode, $headers);
         }
     }
 }
diff --git a/src/Efi/Response.php b/src/Efi/Response.php
@@ -0,0 +1,38 @@
+<?php
+
+namespace Efi;
+
+/**
+ * Class for success responses in the Efí SDK.
+ */
+class Response
+{
+    public $body;
+    public $headers;
+
+    /**
+     * Initializes a new instance of the Efi Response class.
+     *
+     * @param $body The body informations of response.
+     * @param array $headers The headers informations of response.
+     */
+    public function __construct($body, array $headers) {
+        $this->body = $body;
+        $this->headers = $headers;
+    }
+
+    /**
+     * Magic getter method to access the properties of the exception.
+     *
+     * @param string $property The property name.
+     * @return mixed|null The value of the property or null if it doesn't exist.
+     */
+    public function __get($property)
+    {
+        if (property_exists($this, $property)) {
+            return $this->$property;
+        }
+
+        return null;
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -68,7 +68,8 @@ public function send(string $method, string $route, string $scope, array $body)`
`68`	`68`	`'error' => $e->getResponse(),`
`69`	`69`	`'error_description' => $e->getResponse()->getBody()`
`70`	`70`	`],`
`71`		`- $e->getResponse()->getStatusCode()`
	`71`	`+ $e->getResponse()->getStatusCode(),`
	`72`	`+ $e->getResponse()->getHeaders()`
`72`	`73`	`);`
`73`	`74`	`}`
`74`	`75`	`}`
Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ public function authorize()`
`47`	`47`	`{`
`48`	`48`	`$this->initializeRequestOptions();`
`49`	`49`	`$response = $this->sendAuthorizationRequest();`
`50`		`- $this->processAuthorizationResponse($response);`
	`50`	`+ $this->processAuthorizationResponse(($this->config['responseHeaders']) ? $response->body : $response);`
`51`	`51`	`}`
`52`	`52`
`53`	`53`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,7 @@`
`14`	`14`	`*/`
`15`	`15`	`class EfiException extends Exception`
`16`	`16`	`{`
	`17`	`+ private $headers;`
`17`	`18`	`private $error;`
`18`	`19`	`private $errorDescription;`
`19`	`20`
`@@ -23,7 +24,7 @@ class EfiException extends Exception`
`23`	`24`	`* @param mixed $exception The original exception or error response.`
`24`	`25`	`* @param int $code The error code.`
`25`	`26`	`*/`
`26`		`- public function __construct($api, $exception, int $code)`
	`27`	`+ public function __construct($api, $exception, int $code, array $headers)`
`27`	`28`	`{`
`28`	`29`	`$error = $exception;`
`29`	`30`
`@@ -52,7 +53,7 @@ public function __construct($api, $exception, int $code)`
`52`	`53`	`break;`
`53`	`54`	`}`
`54`	`55`
`55`		`- $this->handleException($exceptionClass, $error, $code);`
	`56`	`+ $this->handleException($exceptionClass, $error, $code, $headers);`
`56`	`57`	`}`
`57`	`58`
`58`	`59`	`/**`
`@@ -78,13 +79,14 @@ private function parseStream(\GuzzleHttp\Psr7\Stream $stream)`
`78`	`79`	`* @param array $error The error response array.`
`79`	`80`	`* @param int $code The error code.`
`80`	`81`	`*/`
`81`		`- private function handleException(string $exceptionClass, array $error, int $code)`
	`82`	`+ private function handleException(string $exceptionClass, array $error, int $code, array $headers)`
`82`	`83`	`{`
`83`	`84`	`$exception = new $exceptionClass($error, $code);`
`84`	`85`	`$this->error = $exception->error;`
`85`	`86`	`$this->errorDescription = $exception->errorDescription;`
`86`	`87`	`$this->code = $exception->code;`
`87`	`88`	`$this->message = $exception->message;`
	`89`	`+ $this->headers = $headers;`
`88`	`90`	`}`
`89`	`91`
`90`	`92`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@`
`6`	`6`	`use GuzzleHttp\Exception\ClientException;`
`7`	`7`	`use GuzzleHttp\Exception\ServerException;`
`8`	`8`	`use Efi\Exception\EfiException;`
	`9`	`+use Efi\Response;`
`9`	`10`
`10`	`11`	`class Request extends BaseModel`
`11`	`12`	`{`
`@@ -69,7 +70,7 @@ private function verifyCertificate(string $certificate): string`
`69`	`70`
`70`	`71`	`return $certPath;`
`71`	`72`	`} else {`
`72`		`- $this->throwEfiException('Certificado não encontrado', 403);`
	`73`	`+ $this->throwEfiException('Certificado não encontrado', 403, ['headers' => []]);`
`73`	`74`	`}`
`74`	`75`	`}`
`75`	`76`
`@@ -85,7 +86,7 @@ private function readCertificateFile(string $certPath): string`
`85`	`86`	`{`
`86`	`87`	`$fileContents = file_get_contents($certPath);`
`87`	`88`	`if (!$fileContents) {`
`88`		`- $this->throwEfiException('Não foi possível ler o arquivo de certificado', 403);`
	`89`	`+ $this->throwEfiException('Não foi possível ler o arquivo de certificado', 403, ['headers' => []]);`
`89`	`90`	`}`
`90`	`91`	`return $fileContents;`
`91`	`92`	`}`
`@@ -107,7 +108,7 @@ private function validateCertificate(string $fileContents, string $certPath): vo`
`107`	`108`
`108`	`109`	`$publicKey = openssl_x509_parse($fileContents);`
`109`	`110`	`if (!$publicKey) {`
`110`		`- $this->throwEfiException('Certificado inválido ou inativo', 403);`
	`111`	`+ $this->throwEfiException('Certificado inválido ou inativo', 403, ['headers' => []]);`
`111`	`112`	`}`
`112`	`113`
`113`	`114`	`$this->checkCertificateEnviroment($publicKey['issuer']['CN']);`
`@@ -125,7 +126,7 @@ private function validateCertificate(string $fileContents, string $certPath): vo`
`125`	`126`	`private function readP12Certificate(string $fileContents): array`
`126`	`127`	`{`
`127`	`128`	`if (!openssl_pkcs12_read($fileContents, $certData, $this->config['pwdCertificate'])) {`
`128`		`- $this->throwEfiException('Não foi possível ler o arquivo de certificado p12', 403);`
	`129`	`+ $this->throwEfiException('Não foi possível ler o arquivo de certificado p12', 403, ['headers' => []]);`
`129`	`130`	`}`
`130`	`131`	`return $certData;`
`131`	`132`	`}`
`@@ -139,9 +140,9 @@ private function readP12Certificate(string $fileContents): array`
`139`	`140`	`private function checkCertificateEnviroment(string $issuerCn): void`
`140`	`141`	`{`
`141`	`142`	`if ($this->config['sandbox'] === true && ($issuerCn === 'apis.sejaefi.com.br' \|\| $issuerCn === 'apis.efipay.com.br' \|\| $issuerCn === 'api-pix.gerencianet.com.br')) {`
`142`		`- $this->throwEfiException('Certificado de produção inválido para o ambiente escolhido [homologação].', 403);`
	`143`	`+ $this->throwEfiException('Certificado de produção inválido para o ambiente escolhido [homologação].', 403, ['headers' => []]);`
`143`	`144`	`} elseif (!$this->config['sandbox'] && ($issuerCn === 'apis-h.sejaefi.com.br' \|\| $issuerCn === 'apis-h.efipay.com.br' \|\| $issuerCn === 'api-pix-h.gerencianet.com.br')) {`
`144`		`- $this->throwEfiException('Certificado de homologação inválido para o ambiente escolhido [produção].', 403);`
	`145`	`+ $this->throwEfiException('Certificado de homologação inválido para o ambiente escolhido [produção].', 403, ['headers' => []]);`
`145`	`146`	`}`
`146`	`147`	`}`
`147`	`148`
`@@ -156,7 +157,7 @@ private function checkCertificateExpiration(string $validToTime): void`
`156`	`157`	`$today = date("Y-m-d H:i:s");`
`157`	`158`	`$validTo = date('Y-m-d H:i:s', $validToTime);`
`158`	`159`	`if ($validTo <= $today) {`
`159`		`- $this->throwEfiException('O certificado de autenticação expirou em ' . $validTo, 403);`
	`160`	`+ $this->throwEfiException('O certificado de autenticação expirou em ' . $validTo, 403, ['headers' => []]);`
`160`	`161`	`}`
`161`	`162`	`}`
`162`	`163`
`@@ -166,7 +167,7 @@ private function checkCertificateExpiration(string $validToTime): void`
`166`	`167`	`* @param string $method The HTTP method.`
`167`	`168`	`* @param string $route The URL route.`
`168`	`169`	`* @param array $requestOptions The request options.`
`169`		`- * @return mixed The response data.`
	`170`	`+ * @return object The response data.`
`170`	`171`	`* @throws EfiException If there is an EFI Pay specific error.`
`171`	`172`	`*/`
`172`	`173`
`@@ -180,7 +181,7 @@ public function send(string $method, string $route, array $requestOptions)`
`180`	`181`	`} catch (ClientException $e) {`
`181`	`182`	`throw $this->handleClientException($e);`
`182`	`183`	`} catch (ServerException $se) {`
`183`		`- $this->throwEfiException($se->getResponse()->getBody(), $se->getResponse()->getStatusCode());`
	`184`	`+ $this->throwEfiException($se->getResponse()->getBody(), $se->getResponse()->getStatusCode(), $se->getResponse()->getHeaders());`
`184`	`185`	`}`
`185`	`186`	`}`
`186`	`187`
`@@ -228,21 +229,24 @@ private function mergeHeaders(array $requestOptions, array $defaultHeaders): arr`
`228`	`229`
`229`	`230`	`private function processResponse($response)`
`230`	`231`	`{`
`231`		`- $headersResponse = $response->getHeader('Content-Type');`
	`232`	`+ $headersResponse = $this->config['responseHeaders'] ? $response->getHeaders() : $response->getHeader('Content-Type');`
`232`	`233`
`233`		`- if (isset($headersResponse[0]) && stristr(substr($headersResponse[0], 0, strpos($headersResponse[0], ';')), 'application/json')) {`
`234`		`- return json_decode($response->getBody(), true);`
	`234`	`+ $contentType = isset($headersResponse['Content-Type'][0]) ? $headersResponse['Content-Type'][0] : $headersResponse[0];`
	`235`	`+`
	`236`	`+ if (stristr($contentType, 'application/json')) {`
	`237`	`+ $bodyResponse = json_decode($response->getBody(), true);`
`235`	`238`	`} else {`
`236`	`239`	`$bodyResponse = $response->getBody()->getContents();`
	`240`	`+ }`
`237`	`241`
`238`		`- if ($bodyResponse) {`
`239`		`- return $bodyResponse;`
`240`		`- } else {`
`241`		`- return ["code" => $response->getStatusCode()];`
`242`		`- }`
	`242`	`+ if ($this->config['responseHeaders']) {`
	`243`	`+ return new Response($bodyResponse ?: ["code" => $response->getStatusCode()], $headersResponse);`
`243`	`244`	`}`
	`245`	`+`
	`246`	`+ return $bodyResponse ?: ["code" => $response->getStatusCode()];`
`244`	`247`	`}`
`245`	`248`
	`249`	`+`
`246`	`250`	`/**`
`247`	`251`	`* Handles the ClientException and creates an EFI exception.`
`248`	`252`	`*`
`@@ -252,16 +256,18 @@ private function processResponse($response)`
`252`	`256`
`253`	`257`	`private function handleClientException(ClientException $e): EfiException`
`254`	`258`	`{`
	`259`	`+ $responseHeaders = $e->getResponse()->getHeaders();`
`255`	`260`	`if (is_array(json_decode($e->getResponse()->getBody(), true))) {`
`256`		`- return new EfiException($this->config['api'], json_decode($e->getResponse()->getBody(), true), $e->getResponse()->getStatusCode());`
	`261`	`+ return new EfiException($this->config['api'], json_decode($e->getResponse()->getBody(), true), $e->getResponse()->getStatusCode(), $responseHeaders);`
`257`	`262`	`} else {`
`258`	`263`	`return new EfiException(`
`259`	`264`	`$this->config['api'],`
`260`	`265`	`[`
`261`	`266`	`'error' => $e->getResponse()->getReasonPhrase(),`
`262`	`267`	`'error_description' => $e->getResponse()->getBody()`
`263`	`268`	`],`
`264`		`- $e->getResponse()->getStatusCode()`
	`269`	`+ $e->getResponse()->getStatusCode(),`
	`270`	`+ $responseHeaders`
`265`	`271`	`);`
`266`	`272`	`}`
`267`	`273`	`}`
`@@ -273,12 +279,12 @@ private function handleClientException(ClientException $e): EfiException`
`273`	`279`	`* @param int $statusCode HTTP status code.`
`274`	`280`	`* @throws EfiException The EfiException.`
`275`	`281`	`*/`
`276`		`- private function throwEfiException(string $message, int $statusCode): void`
	`282`	`+ private function throwEfiException(string $message, int $statusCode, array $headers): void`
`277`	`283`	`{`
`278`	`284`	`if (is_array(json_decode($message, true))) {`
`279`		`- throw new EfiException($this->config['api'], json_decode($message, true), $statusCode);`
	`285`	`+ throw new EfiException($this->config['api'], json_decode($message, true), $statusCode, $headers);`
`280`	`286`	`} else {`
`281`		`- throw new EfiException($this->config['api'], ['error' => 'forbidden', 'error_description' => $message], $statusCode);`
	`287`	`+ throw new EfiException($this->config['api'], ['error' => 'forbidden', 'error_description' => $message], $statusCode, $headers);`
`282`	`288`	`}`
`283`	`289`	`}`
`284`	`290`	`}`