Se estandarizó gran parte del código. Se reestructuró la carpeta tests y sus archivos. Se modificó algunos tests, reduciendo la cantidad de variables de entorno necesarias. Se modificó el script de Makefile para ejecutar los tests. Se añadió scrutinizer.yml.

Author: SantiagoFiol

.github/workflows/ci.yml

@@ -35,9 +35,7 @@ jobs:
           APIGATEWAY_API_TOKEN: ${{ secrets.APIGATEWAY_API_TOKEN }}
           TEST_CONTRIBUYENTE_RUT: ${{ vars.TEST_CONTRIBUYENTE_IDENTIFICADOR }} # Variable necesaria para test_contribuyentes.
         run: |
-          python3 tests/run.py sii.test_actividades_economicas
-          python3 tests/run.py sii.test_contribuyentes
-          python3 tests/run.py sii.test_indicadores
+          make tests_readonly
 
       - name: Upload pytest result report
         if: failure()

.gitignore

@@ -23,3 +23,4 @@ tests/*.json
 tests/*.csv
 tests/*.pdf
 tests/*.html
+tests/archivos/sii/*

.scrutinizer.yml

@@ -0,0 +1,29 @@
+checks:
+  python: true
+
+build:
+  nodes:
+    analysis:
+      tests:
+        override:
+          - python-scrutinizer-run
+          - command: make tests_readonly
+            coverage:
+              file: var/tests-coverage.xml
+              format: clover
+      environment:
+        python:
+          version: 3.11.10
+  dependencies:
+    before:
+      - pip install -r requirements.txt
+
+filter:
+  paths:
+    - apigatewaycl/*
+  excluded_paths:
+    - resources/*
+    - tests/*
+    - tools/*
+    - var/*
+    - vendor/*

Makefile

@@ -12,6 +12,13 @@ install-dev:
 tests: install-dev
 	python tests/run.py
 
+tests_readonly:
+	python3 tests/run.py sii.actividades.test_listar_actividades_economicas
+	python3 tests/run.py sii.contribuyentes.test_obtener_situacion_tributaria
+	python3 tests/run.py sii.indicadores_uf.test_obtener_uf_anual
+	python3 tests/run.py sii.indicadores_uf.test_obtener_uf_mensual
+	python3 tests/run.py sii.indicadores_uf.test_obtener_uf_diario
+
 docs:
 	sphinx-apidoc -o docs apigatewaycl && sphinx-build -b html docs docs/_build/html
 

apigatewaycl/api_client/__init__.py

@@ -17,25 +17,29 @@
 # <http://www.gnu.org/licenses/lgpl.html>.
 #
 
-from os import getenv
 from requests.exceptions import Timeout, ConnectionError, RequestException, HTTPError
+from os import getenv
 from abc import ABC
+
 import urllib.parse
 import urllib
 import requests
 import base64
 import json
-import time
 import re
 
 class ApiClient:
     '''
     Cliente para interactuar con la API de API Gateway.
 
-    :param str token: Token de autenticación del usuario. Si no se proporciona, se intentará obtener de una variable de entorno.
-    :param str url: URL base de la API. Si no se proporciona, se usará una URL por defecto.
-    :param str version: Versión de la API. Si no se proporciona, se usará una versión por defecto.
-    :param bool raise_for_status: Si se debe lanzar una excepción automáticamente para respuestas de error HTTP. Por defecto es True.
+    :param str token: Token de autenticación del usuario. Si no se proporciona,
+    se intentará obtener de una variable de entorno.
+    :param str url: URL base de la API. Si no se proporciona, se usará una
+    URL por defecto.
+    :param str version: Versión de la API. Si no se proporciona, se usará
+    una versión por defecto.
+    :param bool raise_for_status: Si se debe lanzar una excepción automáticamente
+    para respuestas de error HTTP. Por defecto es True.
     '''
 
     __DEFAULT_URL = 'https://apigateway.cl'
@@ -71,7 +75,9 @@ def __validate_url(self, url):
         :rtype: str
         :raises ApiException: Si la URL no es válida o está ausente.
         '''
-        return str(url).strip() if url else getenv('APIGATEWAY_API_URL', self.__DEFAULT_URL).strip()
+        return str(url).strip() if url else getenv(
+            'APIGATEWAY_API_URL',
+            self.__DEFAULT_URL).strip()
 
     def __generate_headers(self):
         '''
@@ -97,9 +103,12 @@ def __request(self, method, resource, data = None, headers = None):
         :param dict headers: Cabeceras adicionales para la solicitud (opcional).
         :return: Respuesta de la solicitud.
         :rtype: requests.Response
-        :raises ApiException: Si el método HTTP no es soportado o si hay un error de conexión.
+        :raises ApiException: Si el método HTTP no es soportado o si hay
+        un error de conexión.
         '''
-        api_path = '/api/%(version)s%(resource)s' % {'version': self.version, 'resource': resource}
+        api_path = '/api/%(version)s%(resource)s' % {
+            'version': self.version, 'resource': resource
+        }
         full_url = urllib.parse.urljoin(self.url + '/', api_path.lstrip('/'))
         headers = headers or {}
         headers = {**self.headers, **headers}
@@ -109,11 +118,17 @@ def __request(self, method, resource, data = None, headers = None):
             response = requests.request(method, full_url, data = data, headers = headers)
             return self.__check_and_return_response(response)
         except ConnectionError as error:
-            raise ApiException('Error de conexión: %(error)s' % {'error': error})
+            raise ApiException('Error de conexión: %(error)s' % {
+                'error': error
+            })
         except Timeout as error:
-            raise ApiException('Error de timeout: %(error)s' % {'error': error})
+            raise ApiException('Error de timeout: %(error)s' % {
+                'error': error
+            })
         except RequestException as error:
-            raise ApiException('Error en la solicitud: %(error)s' % {'error': error})
+            raise ApiException('Error en la solicitud: %(error)s' % {
+                'error': error
+            })
 
     def __check_and_return_response(self, response):
         '''
@@ -130,10 +145,18 @@ def __check_and_return_response(self, response):
             except HTTPError as error:
                 try:
                     error = response.json()
-                    message = error.get('message', '') or error.get('exception', '') or 'Error desconocido.'
+                    message = error.get(
+                        'message', ''
+                    ) or error.get(
+                        'exception', ''
+                    ) or 'Error desconocido.'
                 except json.decoder.JSONDecodeError:
-                    message = 'Error al decodificar los datos en JSON: %(response)s' % {'response': response.text}
-                raise ApiException('Error HTTP: %(message)s' % {'message': message})
+                    message = 'Error al decodificar los datos en JSON: %(response)s' % {
+                        'response': response.text
+                    }
+                raise ApiException('Error HTTP: %(message)s' % {
+                    'message': message
+                })
         return response
 
     def get(self, resource, headers = None):
@@ -212,9 +235,14 @@ def __str__(self):
         :return: Una cadena que representa el error de una manera clara y concisa.
         '''
         if self.code is not None:
-            return "[API Gateway] Error %(code)s: %(message)s" % {'code': self.code, 'message': self.message}
+            return "[API Gateway] Error %(code)s: %(message)s" % {
+                'code': self.code,
+                'message': self.message
+            }
         else:
-            return "[API Gateway] %(message)s" % {'message': self.message}
+            return "[API Gateway] %(message)s" % {
+                'message': self.message
+            }
 
 class ApiBase(ABC):
     '''
@@ -229,8 +257,20 @@ class ApiBase(ABC):
 
     auth = {}
 
-    def __init__(self, api_token = None, api_url = None, api_version = None, api_raise_for_status = True, **kwargs):
-        self.client = ApiClient(api_token, api_url, api_version, api_raise_for_status)
+    def __init__(
+            self,
+            api_token = None,
+            api_url = None,
+            api_version = None,
+            api_raise_for_status = True,
+            **kwargs
+        ):
+        self.client = ApiClient(
+            api_token,
+            api_url,
+            api_version,
+            api_raise_for_status
+        )
         self.__setup_auth(kwargs)
 
     def __setup_auth(self, kwargs):
@@ -243,11 +283,26 @@ def __setup_auth(self, kwargs):
         clave = kwargs.get('clave')
         if identificador and clave:
             if self.__is_auth_pass(identificador):
-                self.auth = {'pass': {'rut': identificador, 'clave': clave}}
+                self.auth = {
+                    'pass': {
+                        'rut': identificador,
+                        'clave': clave
+                    }
+                }
             elif self.__is_auth_cert_data(identificador):
-                self.auth = {'cert': {'cert-data': identificador, 'pkey-data': clave}}
+                self.auth = {
+                    'cert': {
+                        'cert-data': identificador,
+                        'pkey-data': clave
+                    }
+                }
             elif self.__is_auth_file_data(identificador):
-                self.auth = {'cert': {'file-data': identificador, 'file-pass': clave}}
+                self.auth = {
+                    'cert': {
+                        'file-data': identificador,
+                        'file-pass': clave
+                    }
+                }
             else:
                 raise ApiException('No se han proporcionado las credenciales de autentificación.')
 
@@ -382,4 +437,3 @@ def _get_auth_pass(self):
         else:
             raise ApiException('auth.pass or auth.cert missing.')
         return self.auth
-

apigatewaycl/api_client/sii/actividades_economicas.py

@@ -20,16 +20,19 @@
 '''
 Módulo para obtener las actividades económicas del SII.
 
-Para más información sobre la API, consulte la `documentación completa de Actividades Económicas <https://developers.apigateway.cl/#e64eb128-173a-48c7-ab0b-b6152e59c327>`_.
+Para más información sobre la API, consulte la `documentación completa de
+Actividades Económicas <https://developers.apigateway.cl/#e64eb128-173a-48c7-ab0b-b6152e59c327>`_.
 '''
 
 from .. import ApiBase
 
 class ActividadesEconomicas(ApiBase):
     '''
-    Cliente específico para interactuar con los endpoints de actividades económicas de la API de API Gateway.
+    Cliente específico para interactuar con los endpoints de actividades
+    económicas de la API de API Gateway.
 
-    Provee métodos para obtener listados de actividades económicas, tanto de primera como de segunda categoría.
+    Provee métodos para obtener listados de actividades económicas, tanto
+    de primera como de segunda categoría.
     '''
 
     def listado(self, categoria = None):

apigatewaycl/api_client/sii/bhe.py

@@ -18,9 +18,11 @@
 #
 
 '''
-Módulo para interactuar con Boletas de Honorarios Electrónicas, tanto emitidas como recibidas, del SII.
+Módulo para interactuar con Boletas de Honorarios Electrónicas, tanto
+emitidas como recibidas, del SII.
 
-Para más información sobre la API, consulte la `documentación completa de las BHE <https://developers.apigateway.cl/#4df9775f-2cd3-4b35-80a5-373f2501230c>`_.
+Para más información sobre la API, consulte la `documentación completa de las
+BHE <https://developers.apigateway.cl/#4df9775f-2cd3-4b35-80a5-373f2501230c>`_.
 '''
 
 from .. import ApiBase

apigatewaycl/api_client/sii/bte.py

@@ -20,7 +20,8 @@
 '''
 Módulo para la emisión de Boletas de Terceros Electrónicas del SII.
 
-Para más información sobre la API, consulte la `documentación completa de las BTE <https://developers.apigateway.cl/#e08f50ab-5509-48ab-81ab-63fc8e5985e1>`_.
+Para más información sobre la API, consulte la `documentación completa de las
+BTE <https://developers.apigateway.cl/#e08f50ab-5509-48ab-81ab-63fc8e5985e1>`_.
 '''
 
 from .. import ApiBase
@@ -48,7 +49,9 @@ def documentos(self, emisor, periodo, pagina = None):
         :return: Respuesta JSON con los documentos BTE.
         :rtype: list[dict]
         '''
-        url = '/sii/bte/emitidas/documentos/%(emisor)s/%(periodo)s' % {'emisor': emisor, 'periodo': periodo}
+        url = '/sii/bte/emitidas/documentos/%(emisor)s/%(periodo)s' % {
+            'emisor': emisor, 'periodo': periodo
+        }
         if pagina is not None:
             url += '?pagina=%(pagina)s' % {
                 'pagina': pagina,
@@ -124,7 +127,9 @@ def receptor_tasa(self, emisor, receptor, periodo = None):
         body = {
             'auth': self._get_auth_pass()
         }
-        url = '/sii/bte/emitidas/receptor_tasa/%(emisor)s/%(receptor)s' % {'emisor': emisor, 'receptor': receptor}
+        url = '/sii/bte/emitidas/receptor_tasa/%(emisor)s/%(receptor)s' % {
+            'emisor': emisor, 'receptor': receptor
+        }
         if periodo:
             url += '?periodo=%(periodo)s' % {'periodo': periodo}
         response = self.client.post(url, data = body)

apigatewaycl/api_client/sii/contribuyentes.py

@@ -20,14 +20,16 @@
 '''
 Módulo para obtener datos de los contribuyentes a través del SII.
 
-Para más información sobre la API, consulte la `documentación completa de los Contribuyentes <https://developers.apigateway.cl/#c88f90b6-36bb-4dc2-ba93-6e418ff42098>`_.
+Para más información sobre la API, consulte la `documentación completa de los
+Contribuyentes <https://developers.apigateway.cl/#c88f90b6-36bb-4dc2-ba93-6e418ff42098>`_.
 '''
 
 from .. import ApiBase
 
 class Contribuyentes(ApiBase):
     '''
-    Cliente específico para interactuar con los endpoints de contribuyentes de la API de API Gateway.
+    Cliente específico para interactuar con los endpoints de contribuyentes
+    de la API de API Gateway.
 
     Hereda de ApiBase y utiliza su funcionalidad para realizar solicitudes a la API.
     '''
@@ -40,7 +42,9 @@ def situacion_tributaria(self, rut):
         :return: Respuesta JSON con la situación tributaria del contribuyente.
         :rtype: dict
         '''
-        url = '/sii/contribuyentes/situacion_tributaria/tercero/%(rut)s' % {'rut': rut}
+        url = '/sii/contribuyentes/situacion_tributaria/tercero/%(rut)s' % {
+            'rut': rut
+        }
         response = self.client.get(url)
         return response.json()
 
@@ -52,6 +56,8 @@ def verificar_rut(self, serie):
         :return: Respuesta JSON con la verificación del RUT.
         :rtype: dict
         '''
-        url = '/sii/contribuyentes/rut/verificar/%(serie)s' % {'serie': serie}
+        url = '/sii/contribuyentes/rut/verificar/%(serie)s' % {
+            'serie': serie
+        }
         response = self.client.get(url)
         return response.json()