Merge pull request #51 from eclipxe13/version-0.4.5

Propuesta de compatibilidad versión 0.4.5

Author: eclipxe13

docs/CHANGELOG.md

@@ -14,6 +14,15 @@ que nombraremos así: ` Breaking . Feature . Fix `, donde:
 **Importante:** Las reglas de SEMVER no aplican si estás usando una rama (por ejemplo `main-dev`)
 o estás usando una versión cero (por ejemplo `0.18.4`).
 
+## Versión 0.4.5 2022-03-22
+
+Se compatibilizó la colocación de una consulta con el servicio de solicitud de descargas masivas
+*para CFDI de Retenciones e Información de Pagos*, anteriormente, al solicitar XML el valor del
+atributo `TipoSolicitud` debía ser `CFDI` y ahora debe ser `Retencion`.
+
+Este cambio altera la API pública, pero no se considera un cambio que rompa la compatibilidad
+porque el cambio ocurrió sobre la clase `QueryTranslator` marcada como `@internal`.
+
 ## Versión 0.4.4 2022-03-12
 
 Se actualizó el servicio de solicitud de descargas masivas (consulta) a la versión 1.2 del SAT.

src/RequestBuilder/Exceptions/RequestTypeInvalidException.php

@@ -14,7 +14,7 @@ final class RequestTypeInvalidException extends LogicException implements Reques
 
     public function __construct(string $requestType)
     {
-        parent::__construct(sprintf('The request type "%s" is not CFDI or Metadata', $requestType));
+        parent::__construct(sprintf('The request type "%s" is not CFDI, Retencion or Metadata', $requestType));
         $this->requestType = $requestType;
     }
 

src/RequestBuilder/FielRequestBuilder/FielRequestBuilder.php

@@ -97,7 +97,7 @@ public function query(string $start, string $end, string $rfcIssuer, string $rfc
         if (! in_array($rfcSigner, [$rfcReceiver, $rfcIssuer], true)) {
             throw new RfcIsNotIssuerOrReceiverException($rfcSigner, $rfcIssuer, $rfcReceiver);
         }
-        if (! in_array($requestType, ['CFDI', 'Metadata'], true)) {
+        if (! in_array($requestType, ['CFDI', 'Retencion', 'Metadata'], true)) {
             throw new RequestTypeInvalidException($requestType);
         }
 

src/Service.php

@@ -95,7 +95,8 @@ public function authenticate(): Token
     public function query(QueryParameters $parameters): QueryResult
     {
         $queryTranslator = new QueryTranslator();
-        $soapBody = $queryTranslator->createSoapRequest($this->requestBuilder, $parameters);
+        $isRetenciones = $this->endpoints->getQuery() === ServiceEndpoints::retenciones()->getQuery();
+        $soapBody = $queryTranslator->createSoapRequest($this->requestBuilder, $parameters, $isRetenciones);
         $responseBody = $this->consume(
             'http://DescargaMasivaTerceros.sat.gob.mx/ISolicitaDescargaService/SolicitaDescarga',
             $this->endpoints->getQuery(),

src/Services/Query/QueryTranslator.php

@@ -23,13 +23,19 @@ public function createQueryResultFromSoapResponse(string $content): QueryResult
         return new QueryResult($status, $requestId);
     }
 
-    public function createSoapRequest(RequestBuilderInterface $requestBuilder, QueryParameters $parameters): string
-    {
+    public function createSoapRequest(
+        RequestBuilderInterface $requestBuilder,
+        QueryParameters $parameters,
+        bool $isRetenciones
+    ): string {
         $start = $parameters->getPeriod()->getStart()->format('Y-m-d\TH:i:s');
         $end = $parameters->getPeriod()->getEnd()->format('Y-m-d\TH:i:s');
         $rfcIssuer = $parameters->getDownloadType()->isIssued() ? RequestBuilderInterface::USE_SIGNER : $parameters->getRfcMatch();
         $rfcReceiver = $parameters->getDownloadType()->isReceived() ? RequestBuilderInterface::USE_SIGNER : $parameters->getRfcMatch();
         $requestType = $parameters->getRequestType()->value();
+        if ($parameters->getRequestType()->isCfdi() && $isRetenciones) {
+            $requestType = 'Retencion';
+        }
 
         /** @noinspection PhpUnhandledExceptionInspection */
         return $requestBuilder->query($start, $end, $rfcIssuer, $rfcReceiver, $requestType);

tests/Unit/RequestBuilder/Exceptions/RequestTypeInvalidExceptionTest.php

@@ -20,7 +20,7 @@ public function testGetProperties(): void
     {
         $requestType = 'foo';
         $exception = new RequestTypeInvalidException($requestType);
-        $this->assertSame('The request type "foo" is not CFDI or Metadata', $exception->getMessage());
+        $this->assertSame('The request type "foo" is not CFDI, Retencion or Metadata', $exception->getMessage());
         $this->assertSame($requestType, $exception->getRequestType());
     }
 }

tests/Unit/Services/Query/QueryTranslatorTest.php

@@ -42,7 +42,7 @@ public function testCreateSoapRequest(): void
             RequestType::cfdi()
         );
 
-        $requestBody = $translator->createSoapRequest($requestBuilder, $query);
+        $requestBody = $translator->createSoapRequest($requestBuilder, $query, false);
         $this->assertSame(
             $this->xmlFormat(Helpers::nospaces($this->fileContents('query/request-received.xml'))),
             $this->xmlFormat($requestBody)