Adds new version method and update checker (#168)

Author: tr4nt0r

src/aiontfy/__init__.py

@@ -23,6 +23,7 @@
     Response,
     Sound,
     Stats,
+    Version,
     ViewAction,
 )
 
@@ -48,6 +49,7 @@
     "Response",
     "Sound",
     "Stats",
+    "Version",
     "ViewAction",
     "__version__",
 ]

src/aiontfy/ntfy.py

@@ -18,6 +18,7 @@
     Notification,
     Response,
     Stats,
+    Version,
 )
 
 
@@ -397,6 +398,19 @@ async def delete_reservation(
             )
         ).success
 
+    async def version(self) -> Stats:
+        """Get server version (admin-only).
+
+        Returns
+        -------
+        Stats
+            An instance of the `Version` class containing ntfy server version.
+
+
+        """
+
+        return Version.from_json(await self._request("GET", self.url / "v1/version"))
+
     async def close(self) -> None:
         """Close session.
 

src/aiontfy/types.py

@@ -355,6 +355,15 @@ class Stats(DataClassORJSONMixin):
     messages_rate: float
 
 
+@dataclass(kw_only=True, frozen=True)
+class Version(DataClassORJSONMixin):
+    """Version response."""
+
+    version: str
+    commit: str
+    date: datetime
+
+
 @dataclass(kw_only=True, frozen=True)
 class Subscription(DataClassORJSONMixin):
     """Subscription information."""

src/aiontfy/update.py

@@ -0,0 +1,55 @@
+"""Check for latest Uptime Kuma release."""
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from aiohttp import ClientError, ClientSession
+from yarl import URL
+
+BASE_URL = URL("https://api.github.com/repos/binwiederhier/ntfy")
+
+
+@dataclass(kw_only=True)
+class LatestRelease:
+    """Latest release data."""
+
+    tag_name: str
+    name: str
+    html_url: str
+    body: str
+
+
+class UpdateChecker:
+    """Check for updates."""
+
+    def __init__(
+        self,
+        session: ClientSession,
+    ) -> None:
+        """Initialize release checker."""
+        self._session = session
+
+    async def latest_release(self) -> LatestRelease:
+        """Fetch latest release."""
+        url = BASE_URL / "releases/latest"
+        try:
+            async with self._session.get(url) as response:
+                response.raise_for_status()
+                data = await response.json()
+                return LatestRelease(
+                    tag_name=data["tag_name"],
+                    name=data["name"],
+                    html_url=data["html_url"],
+                    body=data["body"],
+                )
+        except ClientError as e:
+            msg = "Failed to fetch latest release from Github"
+            raise UpdateCheckerError(msg) from e
+        except KeyError as e:
+            msg = "Failed to parse latest release from Github response"
+            raise UpdateCheckerError(msg) from e
+
+
+class UpdateCheckerError(Exception):
+    """Exception raised for errors fetching latest release from github."""