♻️ refactor: rename BackupData to Backup and introduce BackupInfo in data.py

- Updated imports and type annotations in `squarecloud/__init__.py`, `squarecloud/app.py`, `squarecloud/client.py`, `squarecloud/listeners/*` to reflect the renaming.
- Modified `AppCache` and `Client` methods to use `Backup` instead of `BackupData`.
- Refactored `BackupData` class to `Backup` and added `BackupInfo` class in `squarecloud/data.py`.

Author: robert-nogueira

squarecloud/__init__.py

@@ -5,7 +5,8 @@
 from .client import Client
 from .data import (
     AppData,
-    BackupData,
+    Backup,
+    BackupInfo,
     DeployData,
     DomainAnalytics,
     FileInfo,

squarecloud/app.py

@@ -10,7 +10,7 @@
 
 from .data import (
     AppData,
-    BackupData,
+    Backup,
     DeployData,
     DomainAnalytics,
     FileInfo,
@@ -46,7 +46,7 @@ def __init__(self) -> None:
         """
         self._status: StatusData | None = None
         self._logs: LogsData | None = None
-        self._backup: BackupData | None = None
+        self._backup: Backup | None = None
         self._app_data: AppData | None = None
 
     @property
@@ -72,13 +72,13 @@ def logs(self) -> LogsData:
         return self._logs
 
     @property
-    def backup(self) -> BackupData:
+    def backup(self) -> Backup:
         """
-        The backup method is a property that returns the cached BackupData of
+        The backup method is a property that returns the cached Backup of
         the application.
 
         :return: The value of the _backup attribute
-        :rtype: BackupData
+        :rtype: Backup
         """
         return self._backup
 
@@ -111,7 +111,7 @@ def update(self, *args):
         The update method is used to update the data of a given instance.
         It takes in an arbitrary number of arguments, and updates the
         corresponding data if it is one of the following types:
-        StatusData, LogsData, BackupData or AppData.
+        StatusData, LogsData, Backup or AppData.
         If any other type is provided as an argument to this function,
         a SquareException will be raised.
 
@@ -123,7 +123,7 @@ def update(self, *args):
                 self._status = arg
             elif isinstance(arg, LogsData):
                 self._logs = arg
-            elif isinstance(arg, BackupData):
+            elif isinstance(arg, Backup):
                 self._backup = arg
             elif isinstance(arg, AppData):
                 self._app_data = arg
@@ -133,7 +133,7 @@ def update(self, *args):
                     for i in [
                         StatusData,
                         LogsData,
-                        BackupData,
+                        Backup,
                         AppData,
                     ]
                 ]
@@ -463,15 +463,15 @@ async def status(self, *_args, **__kwargs) -> StatusData:
 
     @_update_cache
     @_notify_listener(Endpoint.backup())
-    async def backup(self, *_args, **__kwargs) -> BackupData:
+    async def backup(self, *_args, **__kwargs) -> Backup:
         """
         The backup function is used to create a backup of the application.
 
         :param self: Refer to the class instance
-        :return: A BackupData object
-        :rtype: BackupData
+        :return: A Backup object
+        :rtype: Backup
         """
-        backup: BackupData = await self.client.backup(self.id)
+        backup: Backup = await self.client.backup(self.id)
         return backup
 
     async def start(self) -> Response:

squarecloud/client.py

@@ -8,9 +8,9 @@
 from typing_extensions import deprecated
 
 from .app import Application
-from .data import (
+from .data import (  # BackupInfo,
     AppData,
-    BackupData,
+    Backup,
     DeployData,
     DomainAnalytics,
     FileInfo,
@@ -329,14 +329,14 @@ async def restart_app(self, app_id: str, **_kwargs) -> Response:
         return await self._http.restart_application(app_id)
 
     @_notify_listener(Endpoint.backup())
-    async def backup(self, app_id: str, **_kwargs) -> BackupData:
+    async def backup(self, app_id: str, **_kwargs) -> Backup:
         """
         The backup method is used to backup an application.
 
         :param app_id: Specify the application id
         :param _kwargs: Keyword arguments
-        :return: A BackupData object
-        :rtype: BackupData
+        :return: A Backup object
+        :rtype: Backup
 
         :raises NotFoundError: Raised when the request status code is 404
         :raises BadRequestError: Raised when the request status code is 400
@@ -347,7 +347,9 @@ async def backup(self, app_id: str, **_kwargs) -> BackupData:
         """
         response: Response = await self._http.backup(app_id)
         payload: dict[str, Any] = response.response
-        return BackupData(**payload)
+        return Backup(**payload)
+
+    # async def app_backups(self) -> list[BackupInfo]:
 
     @_notify_listener(Endpoint.delete_app())
     async def delete_app(self, app_id: str, **_kwargs) -> Response:

squarecloud/data.py

@@ -6,9 +6,6 @@
 from pydantic import confloat, conint
 from pydantic.dataclasses import dataclass
 
-# pylint: disable=too-many-instance-attributes
-# pylint: disable=invalid-name
-
 
 @dataclass(frozen=True)
 class PlanData:
@@ -197,16 +194,27 @@ def to_dict(self):
 
 
 @dataclass(frozen=True)
-class BackupData:
+class BackupInfo:
+    name: str
+    size: int
+    modified: datetime
+    key: str
+
+
+@dataclass(frozen=True)
+class Backup:
     """
     Backup data class
 
-    :ivar downloadURL: Url for download your backup
+    :ivar url: Url for download your backup
+    :ivar key: The backup's key
 
-    :type downloadURL: str
+    :type url: str
+    :type key: str
     """
 
-    downloadURL: str
+    url: str
+    key: str
 
     def to_dict(self):
         return self.__dict__.copy()
@@ -285,10 +293,17 @@ def to_dict(self):
         return self.__dict__.copy()
 
 
+@dataclass(frozen=True)
+class AnalyticsTotal:
+    visits: int
+    megabytes: float
+    bytes: int
+
+
 @dataclass(frozen=True)
 class DomainAnalytics:
     hostname: str
-    total: list[Any]
+    total: list[AnalyticsTotal]
     countries: list[Any]
     methods: list[Any]
     referers: list[Any]

squarecloud/listeners/__init__.py

@@ -165,5 +165,5 @@ def cast_to_pydantic_model(
     data.AppData,
     data.StatusData,
     data.LogsData,
-    data.BackupData,
+    data.Backup,
 ]

squarecloud/listeners/capture_listener.py

@@ -13,7 +13,7 @@
     data.AppData,
     data.StatusData,
     data.LogsData,
-    data.BackupData,
+    data.Backup,
 ]