Se modificaron los workflow ci.yml y -scrutinizer.yml para incluir algunos tests nuevos. Se reestructuró en gran medida la carpeta de tests. Se añadieron tests nuevos relacionados con DTEs reales, temporales y recibidos, además de 3 tests para pagos y cobros masivos. Se estandarizaron formatos de strings, largos de código y largos de documentación. Se corrigió la documentación de pruebas unitarias (dev.unittest.rst). Se añadió una clase padre o abstract a cada conjunto de tests. Se añadieron servicios al API Client (el archivo dte.py contiene algunos servicios nuevos y probados). Se añadieron comandos en Makefile para los tests.

Author: SantiagoFiol

.github/workflows/ci.yml

@@ -36,6 +36,7 @@ jobs:
           LIBREDTE_RUT: ${{ vars.LIBREDTE_RUT }}
         run: |
           make tests_dte_temp
+          make tests_cobros
 
       - name: Upload pytest result report
         if: failure()

.gitignore

@@ -22,3 +22,4 @@ tests/*.json
 tests/*.csv
 tests/*.pdf
 tests/*.html
+tests/archivos/dte_facturacion/*

.scrutinizer.yml

@@ -6,7 +6,7 @@ build:
     analysis:
       tests:
         override:
-          - php-scrutinizer-run
+          - python-scrutinizer-run
           - command: make tests_dte_temp
             coverage:
               file: var/tests-coverage.xml

Makefile

@@ -12,8 +12,20 @@ install-dev:
 tests: install-dev
 	python tests/run.py
 
+tests_dte:
+	python3 tests/run.py dte_facturacion
+
+tests_dte_real:
+	python3 tests/run.py dte_facturacion.dte_real
+
+tests_dte_rec:
+	python3 tests/run.py dte_facturacion.dte_recibidos
+
 tests_dte_temp:
-	python3 tests/run.py dte_facturacion.test_generar_dte_temporal
+	python3 tests/run.py dte_facturacion.dte_temp
+
+tests_cobros:
+	python3 tests/run.py pagos_cobros_masivos
 
 docs:
 	sphinx-apidoc -o docs libredte && sphinx-build -b html docs docs/_build/html

docs/dev.unittest.rst

@@ -20,17 +20,18 @@ Para ejecutar todas las pruebas, utilizar el siguiente comando:
 
     python3 tests/run.py
 
-También es posible ejecutar un archivo de pruebas específico, indicando el archivo a utilizar. Ejemplo:
+También es posible ejecutar un archivo de pruebas específico, indicando el archivo a utilizar. Ejemplos:
 
 .. code:: shell
 
-    python3 tests/run.py dte_facturacion.test_generar_dte_temporal
+    python3 tests/run.py dte_facturacion.dte_temp.test_emitir_dte_temp
+    python3 tests/run.py pagos_cobros_masivos.test_buscar_cobro_programado
 
 Además puedes elegir una única prueba específica, utilizando la ruta completa:
 
 .. code:: shell
 
-    python3 tests/run.py dte_facturacion.test_buscar_documento_emitido.TestBuscarDocumentoEmitido.test_dte_buscar_documento_emitido
+    python3 tests/run.py dte_facturacion.test_emitir_dte_temp.TestEmitirDteTemp.test_emitir_dte_temp
 
 .. important::
     Para el ejemplo anterior, se necesita tener al menos 1 DTE emitido.

libredte/api_client/__init__.py

@@ -27,19 +27,19 @@ class Cobros(ApiBase):
     como obtener información sobre cobros específicos y realizar pagos de cobros.
     """
 
-    def get_cobro(self, emisor, cobro):
+    def get_cobros(self, emisor, filtros):
         """
-        Obtiene la información de un cobro específico.
+        Obtiene la información de varios cobros.
 
-        Realiza una solicitud POST para buscar información sobre un cobro dado
-        el identificador del emisor y los datos del cobro.
+        Realiza una solicitud POST para buscar información sobre múltiples cobros
+        dado el identificador del emisor y filtros de los cobros.
 
-        :param str emisor: Identificador del emisor del cobro.
-        :param dict cobro: Datos del cobro a buscar.
+        :param str emisor: Identificador del emisor de los cobros.
+        :param dict filtros: Datos de filtrado de cobros.
         :return: Respuesta JSON con la información del cobro.
         """
         url = "/pagos/cobros/buscar/%(emisor)s" % {'emisor' : emisor}
-        return self.client.post(url, data=cobro)
+        return self.client.post(url, data = filtros)
 
     def pagar_cobro(self, codigo, emisor, pagar_cobro):
         """
@@ -58,14 +58,15 @@ def pagar_cobro(self, codigo, emisor, pagar_cobro):
             'codigo' : codigo,
             'emisor' : emisor
         }
-        return self.client.post(url, data=pagar_cobro)
+        return self.client.post(url, data = pagar_cobro)
 
     def get_cobro_dte_temporal(self, receptor, dte, codigo, emisor):
         """
         Obtiene la información de cobro asociada a un DTE temporal específico.
 
-        Realiza una solicitud POST para buscar información de cobro basada en un DTE temporal,
-        dado el RUT del receptor, el tipo de DTE, el código del DTE temporal, y el RUT del emisor.
+        Realiza una solicitud POST para buscar información de cobro basada en un
+        DTE temporal, dado el RUT del receptor, el tipo de DTE, el código del
+        DTE temporal, y el RUT del emisor.
 
         :param str receptor: RUT del receptor asociado al DTE temporal.
         :param str dte: Tipo de DTE temporal.
@@ -85,8 +86,8 @@ def get_cobro_dte_real(self, dte, folio, emisor):
         """
         Obtiene la información de cobro asociada a un DTE real específico.
 
-        Envia una solicitud POST para buscar información de cobro basada en un DTE real,
-        dado el tipo de DTE, el folio del DTE, y el RUT del emisor.
+        Envia una solicitud POST para buscar información de cobro basada en un
+        DTE real, dado el tipo de DTE, el folio del DTE, y el RUT del emisor.
 
         :param str dte: Tipo de DTE real.
         :param str folio: Folio del DTE real.
@@ -104,10 +105,10 @@ def get_cobro_info(self, codigo, emisor):
         """
         Obtiene información detallada de un cobro específico.
 
-        Realiza una solicitud POST para recuperar detalles completos sobre un cobro,
-        identificado por su código y el RUT del emisor. Esta información puede incluir
-        detalles del estado del cobro, montos, fechas relevantes, entre otros datos
-        específicos del cobro consultado.
+        Realiza una solicitud POST para recuperar detalles completos sobre un
+        cobro, identificado por su código y el RUT del emisor. Esta información
+        puede incluir detalles del estado del cobro, montos, fechas relevantes,
+        entre otros datos específicos del cobro consultado.
 
         :param str codigo: Código único que identifica el cobro.
         :param str emisor: RUT del emisor asociado al cobro.

libredte/api_client/cobros.py

@@ -23,11 +23,12 @@ class Dte(ApiBase):
     """
     Clase para interactuar con los endpoints de DTE de la API.
 
-    Esta clase hereda de ApiBase y proporciona métodos específicos para operaciones relacionadas con DTE,
-    como obtener información del receptor, emitir y generar DTEs, tanto temporales como reales, y enviar DTEs por correo electrónico.
+    Esta clase hereda de ApiBase y proporciona métodos específicos para operaciones
+    relacionadas con DTE, como obtener información del receptor, emitir y
+    generar DTEs, tanto temporales como reales, y enviar DTEs por correo electrónico.
     """
 
-    def emitir_dte_temporal(self, dte_temporal, filtros=None):
+    def emitir_dte_temporal(self, dte_temporal, filtros = None):
         """
         Emite un DTE temporal.
 
@@ -37,9 +38,9 @@ def emitir_dte_temporal(self, dte_temporal, filtros=None):
         """
         filtros = '' if filtros is None else urlencode(filtros)
         url = "/dte/documentos/emitir?%(filtros)s" % {'filtros' : filtros}
-        return self.client.post(url, data=dte_temporal)
+        return self.client.post(url, data = dte_temporal)
 
-    def get_dte_temporal(self, receptor, dte, codigo, emisor, filtros=None):
+    def get_dte_temporal(self, receptor, dte, codigo, emisor, filtros = None):
         """
         Obtiene información de un DTE temporal específico.
 
@@ -68,7 +69,8 @@ def delete_dte_temporal(self, receptor, dte, codigo, emisor):
         :param str dte: Tipo de DTE.
         :param str codigo: Código del DTE temporal.
         :param str emisor: RUT del emisor.
-        :return: Respuesta JSON con un boolean que retorna verdadero si se eliminó el DTE temporal.
+        :return: Respuesta JSON con un boolean que retorna verdadero si se
+        eliminó el DTE temporal.
         """
         url = "/dte/dte_tmps/eliminar/%(receptor)s/%(dte)s/%(codigo)s/%(emisor)s" % {
             'receptor' : receptor,
@@ -78,18 +80,19 @@ def delete_dte_temporal(self, receptor, dte, codigo, emisor):
         }
         return self.client.get(url)
 
-    def emitir_dte_real(self, dte_real, filtros=None):
+    def emitir_dte_real(self, dte_real, filtros = None):
         """
-        Genera un DTE real a partir de los datos proporcionados, correspondientes aun dte temporal.
+        Genera un DTE real a partir de los datos proporcionados, correspondientes
+        a un dte temporal.
 
         :param dict dte_real: Datos del DTE real a generar.
         :return: Respuesta JSON del DTE real generado.
         """
         filtros = '' if filtros is None else urlencode(filtros)
         url = "/dte/documentos/generar?%(filtros)s" % {'filtros' : filtros}
-        return self.client.post(url, data=dte_real)
+        return self.client.post(url, data = dte_real)
 
-    def get_dte_real(self, dte, folio, emisor, filtros=None):
+    def get_dte_real(self, dte, folio, emisor, filtros = None):
         """
         Obtiene información de un DTE real específico.
 
@@ -125,7 +128,7 @@ def dte_temporal_enviar_email(self, receptor, dte, codigo, emisor, data_email):
             'codigo' : codigo,
             'emisor' : emisor
         }
-        return self.client.post(url, data=data_email)
+        return self.client.post(url, data = data_email)
 
     def dte_real_enviar_email(self, dte, folio, emisor, data_email):
         """
@@ -142,9 +145,9 @@ def dte_real_enviar_email(self, dte, folio, emisor, data_email):
             'folio' : folio,
             'emisor' : emisor
         }
-        return self.client.post(url, data=data_email)
+        return self.client.post(url, data = data_email)
 
-    def get_pdf_real(self, dte, folio, emisor, filtros=None):
+    def get_pdf_dte_real(self, dte, folio, emisor, filtros = None):
         """
         Obtiene el PDF de un DTE real específico.
 
@@ -172,9 +175,9 @@ def get_dte_emitidos(self, emisor, filtros):
         :return: Respuesta JSON con los DTEs emitidos que coinciden con los filtros.
         """
         url = "/dte/dte_emitidos/buscar/%(emisor)s" % {'emisor' : emisor}
-        return self.client.post(url, data=filtros)
+        return self.client.post(url, data = filtros)
 
-    def dte_emitidos_actualizar_estado(self, dte, folio, emisor, filtros=None):
+    def dte_emitidos_actualizar_estado(self, dte, folio, emisor, filtros = None):
         """
         Actualiza el estado de un DTE emitido.
 
@@ -200,9 +203,9 @@ def dte_emitidos_consultar(self, filtros):
         :param dict filtros: Filtros de búsqueda para aplicar en la consulta.
         :return: Respuesta JSON con los DTEs emitidos que coinciden con los filtros.
         """
-        return self.client.post('/dte/dte_emitidos/consultar', data=filtros)
+        return self.client.post('/dte/dte_emitidos/consultar', data = filtros)
 
-    def dte_emitidos_ted(self, dte, folio, emisor, filtros=None):
+    def dte_emitidos_ted(self, dte, folio, emisor, filtros = None):
         """
         Obtiene el TED (Timbre Electrónico de DTE) de un DTE emitido.
 
@@ -221,7 +224,7 @@ def dte_emitidos_ted(self, dte, folio, emisor, filtros=None):
         }
         return self.client.get(url)
 
-    def listar_dtes_temporales(self, emisor, filtros):
+    def get_dte_temporales(self, emisor, filtros):
         """
         Obtiene un listado de DTEs temporales.
 
@@ -230,34 +233,26 @@ def listar_dtes_temporales(self, emisor, filtros):
         :return: Respuesta JSON con la lista del DTEs temporales.
         """
         url = "/dte/dte_tmps/buscar/%(emisor)s" % {'emisor' : emisor}
-        return self.client.post(url, data=filtros)
+        return self.client.post(url, data = filtros)
 
-    def listar_dtes_emitidos(self, emisor, filtros):
-        """
-        Obtiene un listado de DTEs emitidos (reales).
-
-        :param str emisor: RUT del emisor.
-        :param dict filtros: Parámetros adicionales para la consulta (opcional).
-        :return: Respuesta JSON con la lista del DTEs emitidos.
-        """
-        url = "/dte/dte_emitidos/buscar/%(emisor)s" % {'emisor' : emisor}
-        return self.client.post(url, data=filtros)
-
-    def listar_dtes_recibidos(self, receptor, filtros):
+    def get_dte_recibidos(self, receptor, filtros):
         """
         Obtiene un listado de DTEs recibidos.
 
         :param str receptor: RUT del receptor.
         :param dict filtros: Parámetros adicionales para la consulta (opcional).
         :return: Respuesta JSON con la lista del DTEs recibidos.
         """
-        url = "/dte/dte_recibidos/buscar/%(receptor)s" % {'receptor' : receptor}
-        return self.client.post(url, data=filtros)
+        url = "/dte/dte_recibidos/buscar/%(receptor)s" % {
+            'receptor' : receptor
+        }
+        return self.client.post(url, data = filtros)
 
-    def get_pdf_temporal(self, receptor, dte, codigo, emisor, filtros=None):
+    def get_pdf_dte_temporal(self, receptor, dte, codigo, emisor, filtros = None):
         """
-        Obtiene el PDF de un DTE real específico.
+        Obtiene el PDF de un DTE temporal específico.
 
+        :param str receptor: RUT del receptor.
         :param str dte: Tipo de DTE.
         :param str codigo: Código del DTE.
         :param str emisor: RUT del emisor.
@@ -274,6 +269,24 @@ def get_pdf_temporal(self, receptor, dte, codigo, emisor, filtros=None):
         }
         return self.client.get(url)
 
+    def get_xml_dte_temporal(self, receptor, dte, codigo, emisor):
+        """
+        Obtiene un XML de un DTE temporal.
+
+        :param str receptor: RUT del receptor.
+        :param str dte: Tipo de DTE.
+        :param str codigo: Codigo del DTE emitido.
+        :param str emisor: RUT del emisor.
+        :return: Respuesta codificada en base64 con el XML del DTE emitido.
+        """
+        url = "/dte/dte_tmps/xml/%(receptor)s/%(dte)s/%(codigo)s/%(emisor)s" % {
+            'receptor': receptor,
+            'dte' : dte,
+            'codigo' : codigo,
+            'emisor' : emisor
+        }
+        return self.client.get(url)
+
     def get_xml_dte_real(self, dte, folio, emisor):
         """
         Obtiene un XML de un DTE emitido.
@@ -308,7 +321,7 @@ def get_xml_dte_recibido(self, emisor, dte, folio, receptor):
         }
         return self.client.get(url)
 
-    def get_dte_recibido(self, emisor, dte, folio, receptor, filtros=None):
+    def get_dte_recibido(self, emisor, dte, folio, receptor, filtros = None):
         """
         Obtiene información de un DTE temporal específico.
 

libredte/api_client/dte.py

@@ -31,13 +31,17 @@ def get_moneda_cambios(self, to, day):
         """
         Obtiene la tasa de cambio de moneda de USD a otra moneda en una fecha específica.
 
-        Este método realiza una solicitud GET para obtener la tasa de cambio desde USD
-        hacia la moneda especificada por el usuario para una fecha dada. Es útil para
-        consultas de conversiones de moneda históricas o actuales.
+        Este método realiza una solicitud GET para obtener la tasa de cambio desde
+        USD hacia la moneda especificada por el usuario para una fecha dada. Es
+        útil para consultas de conversiones de moneda históricas o actuales.
 
         :param str to: Código de la moneda destino a la cual se desea convertir USD.
         :param str day: Fecha de la consulta de la tasa de cambio.
-        :return: Respuesta JSON con la tasa de cambio desde USD a la moneda especificada en la fecha indicada.
+        :return: Respuesta JSON con la tasa de cambio desde USD a la moneda
+        especificada en la fecha indicada.
         """
-        url = "/sistema/general/moneda_cambios/tasa/USD/%(to)s/%(day)s" % {'to' : to, 'day' : day}
+        url = "/sistema/general/moneda_cambios/tasa/USD/%(to)s/%(day)s" % {
+            'to' : to,
+            'day' : day
+        }
         return self.client.get(url)