meteocatpy 0.0.15 → 0.0.17

package/CHANGELOG.md

@@ -1,3 +1,33 @@
+## [0.0.17](https://github.com/figorr/meteocatpy/compare/v0.0.16...v0.0.17) (2024-12-29)
+
+
+### Bug Fixes
+
+* 0.0.17 ([ea316af](https://github.com/figorr/meteocatpy/commit/ea316aff268970420dce1c7337d8e7b45859f13c))
+* add alerts feature request ([b5f664c](https://github.com/figorr/meteocatpy/commit/b5f664c2b305130bf55cd9a88ac2c007443e1f67))
+* add alerts test ([72a95a6](https://github.com/figorr/meteocatpy/commit/72a95a66f39908831255c06a6361512c3efcaffb))
+* add alerts url ([1a61bdb](https://github.com/figorr/meteocatpy/commit/1a61bdbe919c45239278d80471d003660ffb53e8))
+* add info station url ([759f0db](https://github.com/figorr/meteocatpy/commit/759f0db95dcc00c8a99d269cdce1eadc7dfe4284))
+* add infostation feature request ([d30ec37](https://github.com/figorr/meteocatpy/commit/d30ec3796e4be27a2601abdbb7c1c50ada8fa485))
+* add quotes feature request ([012fba3](https://github.com/figorr/meteocatpy/commit/012fba30febd6ac76c46ac684ff2f5f25f520acd))
+* add quotes url ([27950fb](https://github.com/figorr/meteocatpy/commit/27950fbf3eb488566e2f5955cb7b8a53a63a77ee))
+* fix alerts test ([742a70e](https://github.com/figorr/meteocatpy/commit/742a70ed584dcc6febb66a3c1b9a3b85574ebd18))
+* fix description ([b41fe6a](https://github.com/figorr/meteocatpy/commit/b41fe6a23385d5fe0e445ad8453bf94ae4cdd623))
+* fix python version from 3.7 to 3.12 and asyncio_default_fixture_loop_scope ([08a8f2e](https://github.com/figorr/meteocatpy/commit/08a8f2ed5a6768f7aa01e2d9959372bc756e501c))
+* ignore alerts json file ([68abbf3](https://github.com/figorr/meteocatpy/commit/68abbf3bb20d4fdfadaf55c8774dec29aa699bcd))
+* new repo file structure ([a6d62b8](https://github.com/figorr/meteocatpy/commit/a6d62b8acca9cadaff96fc1631f71903e2925479))
+
+## [0.0.16](https://github.com/figorr/meteocatpy/compare/v0.0.15...v0.0.16) (2024-12-28)
+
+
+### Bug Fixes
+
+* 0.0.16 ([a59edbc](https://github.com/figorr/meteocatpy/commit/a59edbcff6297346113b411405122b9fe6e9fe14))
+* fix installation at README ([15e4651](https://github.com/figorr/meteocatpy/commit/15e46517254c0f9bdd82adf8038a17ae6e4339d5))
+* ignore uvi test json file ([87189ce](https://github.com/figorr/meteocatpy/commit/87189cea76510a75fa41c015aa522075ba71d19f))
+* improve data recovery when invalid date ([3b72e7e](https://github.com/figorr/meteocatpy/commit/3b72e7e1aeb34485e1226c56f2b6cce385b19f38))
+* json file name ([6e97de1](https://github.com/figorr/meteocatpy/commit/6e97de1d585c17936b316eb1fcc1b5ac2b5275d9))
+
 ## [0.0.15](https://github.com/figorr/meteocatpy/compare/v0.0.14...v0.0.15) (2024-12-13)
 
 

package/README.md

@@ -17,14 +17,14 @@ pip install meteocatpy
 ```
 
 ```bash
-from meteocatpy.client import MeteocatClient
+from meteocatpy.town import MeteocatTown
 
 # Replace 'tu_api_key' with your actual API key
 api_key = "tu_api_key"
-client = MeteocatClient(api_key)
+town_client = MeteocatTown(api_key)
 
 # Get a list of municipalities (asynchronous call)
-municipis = await client.get_municipis()
+municipios_data = await town_client.get_municipis()
 print(municipis)
 ```
 

package/filetree.txt

@@ -15,16 +15,20 @@
 └── meteocatpy/
     ├── README.md
     ├── __init__.py
+    ├── alerts.py
     ├── const.py
     ├── data.py
     ├── exceptions.py
     ├── forecast.py
     ├── helpers.py
+    ├── infostation.py
     ├── py.typed
+    ├── quotes.py
     ├── stations.py
     ├── symbols.py
     ├── town.py
     ├── townstations.py
+    ├── uvi.py
     ├── variables.py
     ├── version.py
 ├── package-lock.json
@@ -38,11 +42,15 @@
 └── tests/
     ├── data_test.py
     ├── import_test.py
+    ├── integration_test_alerts.py
     ├── integration_test_complete.py
     ├── integration_test_forecast.py
+    ├── integration_test_infostation.py
+    ├── integration_test_quotes.py
     ├── integration_test_station_data.py
     ├── integration_test_stations.py
     ├── integration_test_symbols.py
     ├── integration_test_town.py
     ├── integration_test_town_stations.py
+    ├── integration_test_uvi.py
     ├── integration_test_variables.py

package/meteocatpy/alerts.py

@@ -0,0 +1,111 @@
+import aiohttp
+import logging
+import re
+from datetime import datetime
+from .const import BASE_URL, ALERTS_URL
+from .exceptions import (
+    BadRequestError,
+    ForbiddenError,
+    TooManyRequestsError,
+    InternalServerError,
+    UnknownAPIError,
+)
+
+_LOGGER = logging.getLogger(__name__)
+
+class MeteocatAlerts:
+    """Clase para interactuar con los datos de estaciones de la API de Meteocat."""
+
+    def __init__(self, api_key: str):
+        """
+        Inicializa la clase MeteocatAlerts.
+
+        Args:
+            api_key (str): Clave de API para autenticar las solicitudes.
+        """
+        self.api_key = api_key
+        self.headers = {
+            "Content-Type": "application/json",
+            "X-Api-Key": self.api_key,
+        }
+    
+    @staticmethod
+    def get_current_date():
+        """
+        Obtiene la fecha actual en formato numérico.
+
+        Returns:
+            tuple: Año (YYYY), mes (MM), día (DD) como enteros.
+        """
+        now = datetime.now()
+        return now.year, now.month, now.day
+
+    async def get_alerts(self):
+        """
+        Obtiene los datos meteorológicos de alertas desde la API de Meteocat.
+
+        Args:
+            any (str): Año de la consulta.
+            mes (str): Mes de la consulta.
+            dia (str): Día de la consulta.
+
+        Returns:
+            dict: Datos de alertas meteorológicas.
+        """
+        any, mes, dia = self.get_current_date()  # Calcula la fecha actual
+        url = f"{BASE_URL}{ALERTS_URL}".format(
+            any=any, mes=f"{mes:02d}", dia=f"{dia:02d}"
+        )
+    
+        async with aiohttp.ClientSession() as session:
+            try:
+                async with session.get(url, headers=self.headers) as response:
+                    if response.status == 200:
+                        return await response.json()
+
+                    # Gestionar errores según el código de estado
+                    if response.status == 400:
+                        error_data = await response.json()
+                        # Intentar extraer la última fecha válida del mensaje de error
+                        if "message" in error_data:
+                            match = re.search(r'entre (\d{2}-\d{2}-\d{4}) i', error_data["message"])
+                            if match:
+                                last_valid_date = match.group(1)  # Captura la última fecha válida
+                                dia, mes, any = map(int, last_valid_date.split('-'))
+                                # Intentar nuevamente con la última fecha válida
+                                new_url = f"{BASE_URL}{ALERTS_URL}".format(
+                                    any=any, mes=f"{mes:02d}", dia=f"{dia:02d}"
+                                )
+                                async with session.get(new_url, headers=self.headers) as new_response:
+                                    if new_response.status == 200:
+                                        return await new_response.json()
+                                    raise UnknownAPIError(
+                                        f"Failed with the valid date {last_valid_date}: {await new_response.text()}"
+                                    )
+                        raise BadRequestError(await response.json())
+                    elif response.status == 403:
+                        error_data = await response.json()
+                        if error_data.get("message") == "Forbidden":
+                            raise ForbiddenError(error_data)
+                        elif error_data.get("message") == "Missing Authentication Token":
+                            raise ForbiddenError(error_data)
+                    elif response.status == 429:
+                        raise TooManyRequestsError(await response.json())
+                    elif response.status == 500:
+                        raise InternalServerError(await response.json())
+                    else:
+                        raise UnknownAPIError(
+                            f"Unexpected error {response.status}: {await response.text()}"
+                        )
+
+            except aiohttp.ClientError as e:
+                raise UnknownAPIError(
+                    message=f"Error al conectar con la API de Meteocat: {str(e)}",
+                    status_code=0,
+                )
+
+            except Exception as ex:
+                raise UnknownAPIError(
+                    message=f"Error inesperado: {str(ex)}",
+                    status_code=0,
+                )

package/meteocatpy/const.py

@@ -4,8 +4,11 @@ MUNICIPIS_LIST_URL = "/referencia/v1/municipis"
 MUNICIPIS_HORA_URL = "/pronostic/v1/municipalHoraria/{codi}"
 MUNICIPIS_DIA_URL = "/pronostic/v1/municipal/{codi}"
 SYMBOLS_URL = "/referencia/v1/simbols"
+QUOTES_URL = "/quotes/v1/consum-actual"
 STATIONS_LIST_URL = "/xema/v1/estacions/metadades"
+INFO_STATION_URL = "/xema/v1/estacions/{codi_estacio}/metadades"
 STATIONS_MUNICIPI_URL = "/xema/v1/representatives/metadades/municipis/{codi_municipi}/variables/{codi_variable}"
 VARIABLES_URL = "/xema/v1/variables/mesurades/metadades"
 STATION_DATA_URL = "/xema/v1/estacions/mesurades/{codiEstacio}/{any}/{mes}/{dia}"
 UVI_DATA_URL = "/pronostic/v1/uvi/{codi_municipi}"
+ALERTS_URL = "/pronostic/v2/smp/episodis-oberts?data={any}-{mes}-{dia}Z"

package/meteocatpy/data.py

@@ -1,5 +1,6 @@
 import aiohttp
 import logging
+import re
 from datetime import datetime
 from .variables import MeteocatVariables
 from .const import BASE_URL, STATION_DATA_URL
@@ -64,6 +65,23 @@ class MeteocatStationData:
 
                     # Gestionar errores según el código de estado
                     if response.status == 400:
+                        error_data = await response.json()
+                        # Intentar extraer la última fecha válida del mensaje de error
+                        if "message" in error_data:
+                            match = re.search(r'entre (\d{2}-\d{2}-\d{4}) i', error_data["message"])
+                            if match:
+                                last_valid_date = match.group(1)  # Captura la última fecha válida
+                                dia, mes, any = map(int, last_valid_date.split('-'))
+                                # Intentar nuevamente con la última fecha válida
+                                new_url = f"{BASE_URL}{STATION_DATA_URL}".format(
+                                    codiEstacio=station_id, any=any, mes=f"{mes:02d}", dia=f"{dia:02d}"
+                                )
+                                async with session.get(new_url, headers=self.headers) as new_response:
+                                    if new_response.status == 200:
+                                        return await new_response.json()
+                                    raise UnknownAPIError(
+                                        f"Failed with the valid date {last_valid_date}: {await new_response.text()}"
+                                    )
                         raise BadRequestError(await response.json())
                     elif response.status == 403:
                         error_data = await response.json()

package/meteocatpy/infostation.py

@@ -0,0 +1,63 @@
+import aiohttp
+from .const import BASE_URL, INFO_STATION_URL
+from .exceptions import BadRequestError, ForbiddenError, TooManyRequestsError, InternalServerError, UnknownAPIError
+
+class MeteocatInfoStation:
+    """Clase para interactuar con la lista de municipios de la API de Meteocat."""
+
+    def __init__(self, api_key: str):
+        """
+        Inicializa la clase MeteocatTown.
+
+        Args:
+            api_key (str): Clave de API para autenticar las solicitudes.
+        """
+        self.api_key = api_key
+        self.headers = {
+            "Content-Type": "application/json",
+            "X-Api-Key": self.api_key,
+        }
+
+    async def get_infostation(self, station_id: str):
+        """
+        Obtiene los metadatos de la estación desde la API de Meteocat.
+
+        Returns:
+            dict: Datos de la estación. Nombre, coordenadas, altitud, provincia, comarca, etc.
+        """
+        url = f"{BASE_URL}{INFO_STATION_URL}".format(
+            codi_estacio=station_id
+        )
+        async with aiohttp.ClientSession() as session:
+            try:
+                async with session.get(url, headers=self.headers) as response:
+                    if response.status == 200:
+                        return await response.json()
+
+                    # Gestionar errores según el código de estado
+                    if response.status == 400:
+                        raise BadRequestError(await response.json())
+                    elif response.status == 403:
+                        error_data = await response.json()
+                        if error_data.get("message") == "Forbidden":
+                            raise ForbiddenError(error_data)
+                        elif error_data.get("message") == "Missing Authentication Token":
+                            raise ForbiddenError(error_data)
+                    elif response.status == 429:
+                        raise TooManyRequestsError(await response.json())
+                    elif response.status == 500:
+                        raise InternalServerError(await response.json())
+                    else:
+                        raise UnknownAPIError(f"Unexpected error {response.status}: {await response.text()}")
+            
+            except aiohttp.ClientError as e:
+                raise UnknownAPIError(
+                    message=f"Error al conectar con la API de Meteocat: {str(e)}",
+                    status_code=0,
+                )
+
+            except Exception as ex:
+                raise UnknownAPIError(
+                    message=f"Error inesperado: {str(ex)}",
+                    status_code=0,
+                )

package/meteocatpy/quotes.py

@@ -0,0 +1,71 @@
+import aiohttp
+from .const import BASE_URL, QUOTES_URL
+from .exceptions import (
+    BadRequestError,
+    ForbiddenError,
+    TooManyRequestsError,
+    InternalServerError,
+    UnknownAPIError
+)
+
+class MeteocatQuotes:
+    """
+    Clase para interactuar con la API de Meteocat y obtener las cuotas de peticiones realizadas."""
+
+    def __init__(self, api_key: str):
+        """
+        Inicializa la clase MeteocatStations.
+
+        Args:
+            api_key (str): Clave de API para autenticar las solicitudes.
+        """
+        self.api_key = api_key
+        self.headers = {
+            "Content-Type": "application/json",
+            "X-Api-Key": self.api_key,
+        }
+
+    async def get_quotes(self):
+        """
+        Obtiene la lista de cuotas.
+
+        Returns:
+            dict: Lista de cuotas.
+        """
+        url = f"{BASE_URL}{QUOTES_URL}"
+        async with aiohttp.ClientSession() as session:
+            try:
+                async with session.get(url, headers=self.headers) as response:
+                    if response.status == 200:
+                        return await response.json()
+
+                    # Gestionar errores según el código de estado
+                    if response.status == 400:
+                        raise BadRequestError(await response.json())
+                    elif response.status == 403:
+                        error_data = await response.json()
+                        if error_data.get("message") == "Forbidden":
+                            raise ForbiddenError(error_data)
+                        elif error_data.get("message") == "Missing Authentication Token":
+                            raise ForbiddenError(error_data)
+                    elif response.status == 429:
+                        raise TooManyRequestsError(await response.json())
+                    elif response.status == 500:
+                        raise InternalServerError(await response.json())
+                    else:
+                        raise UnknownAPIError(
+                            f"Unexpected error {response.status}: {await response.text()}"
+                        )
+
+            except aiohttp.ClientError as e:
+                raise UnknownAPIError(
+                    message=f"Error al conectar con la API de Meteocat: {str(e)}",
+                    status_code=0,
+                )
+
+            except Exception as ex:
+                raise UnknownAPIError(
+                    message=f"Error inesperado: {str(ex)}",
+                    status_code=0,
+                )
+

package/meteocatpy/version.py

@@ -1,2 +1,2 @@
 # version.py
-__version__ = "0.0.15"
+__version__ = "0.0.17"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "meteocatpy",
-  "version": "0.0.15",
+  "version": "0.0.17",
   "description": "[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)\r [![Python version compatibility](https://img.shields.io/pypi/pyversions/meteocatpy)](https://pypi.org/project/meteocatpy)\r [![pipeline status](https://gitlab.com/figorr/meteocatpy/badges/master/pipeline.svg)](https://gitlab.com/figorr/meteocatpy/commits/master)",
   "main": "index.js",
   "directories": {

package/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "meteocatpy"
-version = "0.0.15"
+version = "0.0.17"
 description = "Script para obtener datos meteorológicos de la API de Meteocat"
 authors = ["figorr <jdcuartero@yahoo.es>"]
 license = "Apache-2.0"

package/setup.cfg

@@ -14,6 +14,7 @@ show_missing = true
 testpaths = tests
 norecursedirs = .git
 asyncio_mode = auto
+asyncio_default_fixture_loop_scope = function
 addopts =
     -p syrupy
     --strict
@@ -55,7 +56,7 @@ forced_separate = tests
 combine_as_imports = true
 
 [mypy]
-python_version = 3.7
+python_version = 3.12
 ignore_errors = true
 follow_imports = silent
 ignore_missing_imports = true

package/tests/integration_test_alerts.py

@@ -0,0 +1,39 @@
+import os
+import pytest
+import json
+from dotenv import load_dotenv
+from meteocatpy.alerts import MeteocatAlerts
+
+# Cargar variables desde el archivo .env
+load_dotenv()
+
+# Obtener los valores del archivo .env
+API_KEY = os.getenv("METEOCAT_API_KEY")
+
+# Asegúrate de que las variables estén definidas
+assert API_KEY, "API Key is required"
+
+@pytest.mark.asyncio
+async def test_alerts():
+    # Crear una instancia de MeteocatAlerts con la API Key
+    alerts_client = MeteocatAlerts(API_KEY)
+
+    try:
+        # Obtener los datos de las alertas
+        alerts_data = await alerts_client.get_alerts()
+    except Exception as e:
+        pytest.fail(f"Failed to fetch alerts: {e}")
+
+    # Crear la carpeta si no existe
+    os.makedirs('tests/files', exist_ok=True)
+
+    # Guardar los datos de las alertas en un archivo JSON
+    with open('tests/files/alerts.json', 'w', encoding='utf-8') as f:
+        json.dump(alerts_data, f, ensure_ascii=False, indent=4)
+
+    # Validar la respuesta
+    assert isinstance(alerts_data, list), "Alerts data should be a list"
+    if not alerts_data:
+        # Mensaje indicando que no hay alertas activas
+        print("No active alerts.")
+        assert alerts_data == [], "No active alerts."

package/tests/integration_test_infostation.py

@@ -0,0 +1,34 @@
+import os
+import pytest
+import json
+from dotenv import load_dotenv
+from meteocatpy.infostation import MeteocatInfoStation
+
+# Cargar variables desde el archivo .env
+load_dotenv()
+
+# Obtener los valores del archivo .env
+API_KEY = os.getenv("METEOCAT_API_KEY")
+STATION_CODI_TEST = os.getenv("STATION_CODI_TEST")
+
+# Asegúrate de que las variables estén definidas
+assert API_KEY, "API Key is required"
+assert STATION_CODI_TEST, "Station codi test is required"
+
+@pytest.mark.asyncio
+async def test_infostation():
+    # Crear una instancia de MeteocatInfoStation con la API Key
+    infostation_client = MeteocatInfoStation(API_KEY)
+
+    # Obtener los datos de la estación
+    station_data = await infostation_client.get_infostation(STATION_CODI_TEST)
+
+    # Crear la carpeta si no existe
+    os.makedirs('tests/files', exist_ok=True)
+    
+    # Guardar los datos de las estaciones en un archivo JSON
+    with open(f'tests/files/station_{STATION_CODI_TEST}_info.json', 'w', encoding='utf-8') as f:
+        json.dump(station_data, f, ensure_ascii=False, indent=4)
+    
+    # Verificar que los datos no estén vacíos
+    assert station_data, "Estaciones info is empty"

package/tests/integration_test_quotes.py

@@ -0,0 +1,32 @@
+import os
+import pytest
+import json
+from dotenv import load_dotenv
+from meteocatpy.quotes import MeteocatQuotes
+
+# Cargar variables desde el archivo .env
+load_dotenv()
+
+# Obtener los valores del archivo .env
+API_KEY = os.getenv("METEOCAT_API_KEY")
+
+# Asegúrate de que las variables estén definidas
+assert API_KEY, "API Key is required"
+
+@pytest.mark.asyncio
+async def test_quotes():
+    # Crear una instancia de MeteocatQuotes con la API Key
+    quotes_client = MeteocatQuotes(API_KEY)
+
+    # Obtener las cuotas
+    quotes_data = await quotes_client.get_quotes()
+
+    # Crear la carpeta si no existe
+    os.makedirs('tests/files', exist_ok=True)
+    
+    # Guardar los datos de las cuotas en un archivo JSON
+    with open('tests/files/quotes.json', 'w', encoding='utf-8') as f:
+        json.dump(quotes_data, f, ensure_ascii=False, indent=4)
+    
+    # Verificar que las cuotas no estén vacías
+    assert quotes_data, "Quotes data is empty"

package/tests/integration_test_uvi.py

@@ -8,7 +8,7 @@ from meteocatpy.uvi import MeteocatUviData
 load_dotenv()
 
 # Obtener los valores del archivo .env
-API_KEY = os.getenv("METEOCAT_API_KEY")
+API_KEY = os.getenv("METEOCAT_API_KEY_TEST")
 MUNICIPI_CODI_TEST = os.getenv("MUNICIPI_CODI_TEST")
 
 # Asegúrate de que las variables estén definidas
@@ -27,7 +27,7 @@ async def test_municipis():
     os.makedirs('tests/files', exist_ok=True)
     
     # Guardar los datos del índice UVI en un archivo JSON
-    with open(f'tests/files/uvi_index_{MUNICIPI_CODI_TEST}.json', 'w', encoding='utf-8') as f:
+    with open(f'tests/files/uvi_{MUNICIPI_CODI_TEST}_data.json', 'w', encoding='utf-8') as f:
         json.dump(uvi_data, f, ensure_ascii=False, indent=4)
     
     # Verificar que los datos del índice UVI no estén vacíos