V1.3.2

Author: Anghkooey

pyproject.toml

@@ -19,3 +19,10 @@ isort = "^5.12.0"
 [build-system]
 requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"
+
+[tool.ruff]
+ignore = [
+    "E501",
+    "E722",
+    "F401",
+]

setup.py

@@ -6,7 +6,7 @@
 setup(
     name="ua_alarm",
     author="user-sspmynxdvb",
-    version="1.3.1",
+    version="1.3.2",
     description="Implements api.ua_alarm.com API that returns info about Ukraine air raid alarms.",
     license="GNUv3",
     url="https://github.com/user-sspmynxdvb/ua_alarm",

ua_alarm/client.py

@@ -12,12 +12,12 @@ class Client:
 
     Methods:
         __init__(api_token: str): Initialize the UkraineAlertApiClient with an API token.
-        _make_request(method: str, endpoint: str, params: Optional[dict] = None, data: Optional[dict] = None) -> Union[types.Alert, types.AlertModification, types.RegionAlarmsHistory, types.RegionsView, types.WebHook]: Make a request to the UkraineAlert API.
-        get_alerts() -> List[types.Alert]: Get a list of alerts.
-        get_region_alerts(region_id: str|int) -> List[types.Alert]: Get alerts for a specific region.
+        _make_request(method: str, endpoint: str, params: Optional[dict] = None, data: Optional[dict] = None) -> Union[types.AlertRegionModel, types.AlertModification, types.RegionAlarmsHistory, types.RegionsViewModel, types.WebHook]: Make a request to the UkraineAlert API.
+        get_alerts() -> List[types.AlertRegionModel]: Get a list of alerts.
+        get_region_alerts(region_id: str|int) -> List[types.AlertRegionModel]: Get alerts for a specific region.
         get_alert_status() -> types.AlertModification: Get the status of alerts.
         get_region_history(region_id: str|int) -> types.RegionAlarmsHistory: Get the history of alerts for a specific region.
-        get_regions() -> types.RegionsView: Get information about regions.
+        get_regions() -> types.RegionsViewModel: Get information about regions.
         subscribe_to_webhook(webhook_data: dict) -> types.WebHook: Subscribe to a webhook.
         update_webhook(webhook_data: dict) -> None: Update an existing webhook.
         unsubscribe_from_webhook(webhook_data: dict) -> None: Unsubscribe from a webhook.
@@ -35,7 +35,7 @@ def __init__(self, api_token: str):
             "Authorization": api_token
         }
 
-    async def _make_request(self, method: str, endpoint: str, params: Optional[dict] = None, data: Optional[dict] = None) -> Union[types.Alert, types.AlertModification, types.RegionAlarmsHistory, types.RegionsView, types.WebHook]:
+    async def _make_request(self, method: str, endpoint: str, params: Optional[dict] = None, data: Optional[dict] = None) -> Union[types.AlertRegionModel, types.AlertModification, types.RegionAlarmsHistory, types.RegionsViewModel, types.WebHook]:
         """
         Makes a request to the UkraineAlert API.
 
@@ -46,7 +46,7 @@ async def _make_request(self, method: str, endpoint: str, params: Optional[dict]
             data (Optional[dict]): Optional data payload for the request.
 
         Returns:
-            Union[types.Alert, types.AlertModification, types.RegionAlarmsHistory, types.RegionsView, types.WebHook]: The response from the API based on the endpoint accessed.
+            Union[types.AlertRegionModel, types.AlertModification, types.RegionAlarmsHistory, types.RegionsViewModel, types.WebHook]: The response from the API based on the endpoint accessed.
         """
         url = f"{self.base_url}{endpoint}"
         async with ClientSession(headers=self.headers) as session:
@@ -59,30 +59,30 @@ async def _make_request(self, method: str, endpoint: str, params: Optional[dict]
                 elif endpoint == "/api/v3/alerts/regionHistory":
                     return [types.RegionAlarmsHistory(**item) for item in response_json]
                 elif endpoint == "/api/v3/regions":
-                    return types.RegionsView(**response_json)
+                    return types.RegionsViewModel(**response_json)
                 elif endpoint == "/api/v3/webhook":
                     return types.WebHook(**response_json)
                 elif "/api/v3/alerts" in endpoint:
-                    return [types.Alert(**item) for item in response_json]
+                    return [types.AlertRegionModel(**item) for item in response_json]
 
-    async def get_alerts(self) -> List[types.Alert]:
+    async def get_alerts(self) -> List[types.AlertRegionModel]:
         """
         Retrieves a list of alerts from the UkraineAlert API.
 
         Returns:
-            List[types.Alert]: A list of types.Alert objects.
+            List[types.AlertRegionModel]: A list of types.AlertRegionModel objects.
         """
         return await self._make_request("GET", "/api/v3/alerts")
 
-    async def get_region_alerts(self, region_id: str|int) -> List[types.Alert]:
+    async def get_region_alerts(self, region_id: str|int) -> List[types.AlertRegionModel]:
         """
         Retrieves alerts for a specific region from the UkraineAlert API.
 
         Args:
             region_id (str or int): The ID of the region for which alerts are requested.
 
         Returns:
-            List[types.Alert]: A list of types.Alert objects for the specified region.
+            List[types.AlertRegionModel]: A list of types.AlertRegionModel objects for the specified region.
         """
         return await self._make_request("GET", f"/api/v3/alerts/{region_id}")
 
@@ -108,12 +108,12 @@ async def get_region_history(self, region_id: str|int) -> types.RegionAlarmsHist
         params = {"regionId": region_id}
         return await self._make_request("GET", "/api/v3/alerts/regionHistory", params=params)
 
-    async def get_regions(self) -> types.RegionsView:
+    async def get_regions(self) -> types.RegionsViewModel:
         """
         Retrieves information about regions from the UkraineAlert API.
 
         Returns:
-            types.RegionsView: An object representing information about regions.
+            types.RegionsViewModel: An object representing information about regions.
         """
         return await self._make_request("GET", "/api/v3/regions")
 

ua_alarm/types/__init__.py

@@ -1,21 +1,21 @@
-from .active_alert import ActiveAlert
-from .alert_modification import AlertModification
 from .alert import Alert
-from .region_alarm import RegionAlarm
+from .alert_modification import AlertModification
+from .alert_region_model import AlertRegionModel
+from .region_alarm_model import RegionAlarmModel
 from .region_alarms_history import RegionAlarmsHistory
-from .region_view import RegionView
-from .regions_view import RegionsView
+from .region_view_model import RegionViewModel
+from .regions_view_model import RegionsViewModel
 from .time_span import TimeSpan
 from .web_hook import WebHook
 
 __all__ = [
-    'ActiveAlert', 
-    'AlertModification', 
     'Alert', 
-    'RegionAlarm', 
+    'AlertModification', 
+    'AlertRegionModel', 
+    'RegionAlarmModel', 
     'RegionAlarmsHistory', 
-    'RegionView', 
-    'RegionsView', 
+    'RegionViewModel', 
+    'RegionsViewModel', 
     'TimeSpan', 
     'WebHook',
 ]

ua_alarm/types/active_alert.py

@@ -1,13 +1,9 @@
 from pydantic import BaseModel
 from datetime import datetime
-from typing import List, Optional
-from .active_alert import ActiveAlert
-from ..enums import v2RegionType
+from ..enums import AlertType, v2RegionType
 
 class Alert(BaseModel):
-    regionId: Optional[str]
+    regionId: str
     regionType: v2RegionType
-    regionName: Optional[str]
-    regionEngName: Optional[str]
-    lastUpdate: datetime
-    activeAlerts: Optional[List[ActiveAlert]]
+    type: AlertType
+    lastUpdate: datetime

ua_alarm/types/alert.py

@@ -0,0 +1,13 @@
+from pydantic import BaseModel
+from datetime import datetime
+from typing import List, Optional
+from .alert import Alert
+from ..enums import v2RegionType
+
+class AlertRegionModel(BaseModel):
+    regionId: Optional[str]
+    regionType: v2RegionType
+    regionName: Optional[str]
+    regionEngName: Optional[str]
+    lastUpdate: datetime
+    activeAlerts: Optional[List[Alert]]

ua_alarm/types/alert_region_model.py

@@ -1,7 +1,7 @@
 from pydantic import BaseModel
 from datetime import datetime
 
-class RegionAlarm(BaseModel):
+class RegionAlarmModel(BaseModel):
     regionId: str
     startDate: datetime
     endDate: datetime

ua_alarm/types/region_alarm.py renamed to ua_alarm/types/region_alarm_model.py

@@ -1,8 +1,8 @@
 from pydantic import BaseModel
 from typing import Optional, List
-from .region_alarm import RegionAlarm
+from .region_alarm_model import RegionAlarmModel
 
 class RegionAlarmsHistory(BaseModel):
     regionId: Optional[str]
     regionName: Optional[str]
-    alarms: Optional[List[RegionAlarm]]
+    alarms: Optional[List[RegionAlarmModel]]

ua_alarm/types/region_alarms_history.py

@@ -0,0 +1,14 @@
+from pydantic import BaseModel
+from typing import Optional, List, Union
+from ..enums import v2RegionType
+
+class RegionChildModel(BaseModel):
+    regionId: str
+    regionName: str
+    regionType: v2RegionType
+
+class RegionViewModel(BaseModel):
+    regionId: Optional[str]
+    regionName: Optional[str]
+    regionType: v2RegionType
+    regionChildIds: Optional[List[Union["RegionViewModel", RegionChildModel]]]

ua_alarm/types/region_view.py

@@ -0,0 +1,6 @@
+from pydantic import BaseModel
+from typing import Optional, List
+from .region_view_model import RegionViewModel
+
+class RegionsViewModel(BaseModel):
+    states: Optional[List[RegionViewModel]]