interface: parse API remaining requests counter

Signed-off-by: Álvaro Fernández Rojas <[email protected]>

Author: Noltari

aemet_opendata/const.py

@@ -113,6 +113,7 @@
 AOD_WIND_SPEED: Final[str] = "wind-speed"
 AOD_WIND_SPEED_MAX: Final[str] = "wind-speed-max"
 
+API_HDR_REQ_COUNT: Final[str] = "Remaining-request-count"
 API_ID_PFX: Final[str] = "id"
 API_MIN_STATION_DISTANCE_KM: Final[int] = 40
 API_MIN_TOWN_DISTANCE_KM: Final[int] = 40
@@ -140,6 +141,7 @@
 
 RAW_FORECAST_DAILY: Final[str] = "forecast-daily"
 RAW_FORECAST_HOURLY: Final[str] = "forecast-hourly"
+RAW_REQ_COUNT: Final[str] = "requests-counter"
 RAW_STATIONS: Final[str] = "stations"
 RAW_TOWNS: Final[str] = "towns"
 

aemet_opendata/interface.py

@@ -41,6 +41,7 @@
     AOD_WIND_DIRECTION,
     AOD_WIND_SPEED,
     AOD_WIND_SPEED_MAX,
+    API_HDR_REQ_COUNT,
     API_MIN_STATION_DISTANCE_KM,
     API_MIN_TOWN_DISTANCE_KM,
     API_URL,
@@ -54,6 +55,7 @@
     HTTP_MAX_REQUESTS,
     RAW_FORECAST_DAILY,
     RAW_FORECAST_HOURLY,
+    RAW_REQ_COUNT,
     RAW_STATIONS,
     RAW_TOWNS,
 )
@@ -105,6 +107,7 @@ def __init__(
         self._api_raw_data = {
             RAW_FORECAST_DAILY: {},
             RAW_FORECAST_HOURLY: {},
+            RAW_REQ_COUNT: None,
             RAW_STATIONS: {},
             RAW_TOWNS: {},
         }
@@ -122,9 +125,7 @@ def __init__(
         self.station = None
         self.town = None
 
-    async def set_api_raw_data(
-        self, key: str, subkey: str | None, data: dict[str, Any] | None
-    ) -> None:
+    async def set_api_raw_data(self, key: str, subkey: str | None, data: Any) -> None:
         """Save API raw data if not empty."""
         if data is not None:
             async with self._api_raw_data_lock:
@@ -150,6 +151,10 @@ async def api_call(self, cmd: str, fetch_data: bool = False) -> dict[str, Any]:
             except ClientError as err:
                 raise AemetError(err) from err
 
+            req_count = resp.headers.get(API_HDR_REQ_COUNT)
+            if req_count is not None:
+                await self.set_api_raw_data(RAW_REQ_COUNT, None, req_count)
+
             _LOGGER.debug(
                 "api_call: cmd=%s status=%s content_type=%s",
                 cmd,
@@ -208,6 +213,10 @@ async def api_data(self, url: str) -> dict[str, Any]:
             except ClientError as err:
                 raise AemetError(err) from err
 
+            req_count = resp.headers.get(API_HDR_REQ_COUNT)
+            if req_count is not None:
+                await self.set_api_raw_data(RAW_REQ_COUNT, None, req_count)
+
             _LOGGER.debug(
                 "api_data: url=%s status=%s content_type=%s",
                 url,