test and bugs fixes

squarecloud/app.py

@@ -42,6 +42,7 @@ class AppCache:
         '_logs',
         '_backup',
         '_app_data',
+        '_snapshot'
     )
 
     def __init__(self) -> None:
@@ -56,6 +57,7 @@ def __init__(self) -> None:
         self._status: StatusData | None = None
         self._logs: LogsData | None = None
         self._backup: Snapshot | None = None
+        self._snapshot: Snapshot | None = None
         self._app_data: AppData | None = None
 
     @property
@@ -92,6 +94,17 @@ def backup(self) -> Snapshot:
         """
         return self._backup
 
+    @property
+    def snapshot(self) -> Snapshot:
+        """
+        The snapshot method is a property that returns the cached Snapshot of
+        the application.
+
+        :return: The value of the _snapshot attribute
+        :rtype: Snapshot
+        """
+        return self._snapshot
+
     @property
     def app_data(self) -> AppData:
         """
@@ -115,6 +128,7 @@ def clear(self) -> None:
         self._logs = None
         self._backup = None
         self._app_data = None
+        self._snapshot = None
 
     def update(self, *args) -> None:
         """
@@ -135,6 +149,7 @@ def update(self, *args) -> None:
                 self._logs = arg
             elif isinstance(arg, Snapshot):
                 self._backup = arg
+                self._snapshot = arg
             elif isinstance(arg, AppData):
                 self._app_data = arg
             else:
@@ -473,7 +488,7 @@ async def backup(self, *_args, **_kwargs) -> Snapshot:
         """
         backup: Snapshot = await self.client.snapshot(self.id)
         return backup
-    
+
     @_update_cache
     @_notify_listener(Endpoint.snapshot())
     async def snapshot(self, *_args, **_kwargs) -> Snapshot:
@@ -657,7 +672,7 @@ async def github_integration(self, access_token: str) -> str:
     async def domain_analytics(self) -> DomainAnalytics:
         """
         Retrieve analytics data for the application's domain.
-        
+
         :param self: Refer to the instance of the class.
         :returns: An instance of :class:`DomainAnalytics` containing analytics data for the domain.
         :rtype: DomainAnalytics
@@ -686,11 +701,11 @@ async def set_custom_domain(self, custom_domain: str) -> Response:
     async def all_backups(self) -> list[SnapshotInfo]:
         backups: list[SnapshotInfo] = await self.client.all_app_snapshots(self.id)
         return backups
-    
+
     async def all_snapshots(self) -> list[SnapshotInfo]:
         """
         Retrieve all snapshots of the application.
-        
+
         :return: A list of SnapshotInfo objects representing all snapshots of the application.
         :rtype: list[SnapshotInfo]
         """
@@ -701,15 +716,15 @@ async def all_snapshots(self) -> list[SnapshotInfo]:
     async def move_file(self, origin: str, dest: str) -> Response:
         """
         Moves a file from the origin path to the destination path within the application.
-        
+
         :param origin: The source path of the file to be moved.
         :type origin: str
         :param dest: The destination path where the file should be moved.
         :type dest: str
         :return: A Response object containing the result of the file move operation.
         :rtype: Response
         """
-        
+
         return await self.client.move_app_file(self.id, origin, dest)
 
     async def current_integration(self) -> Response:
@@ -719,13 +734,13 @@ async def current_integration(self) -> Response:
     async def dns_records(self) -> list[DNSRecord]:
         """
         Retrieve the DNS records associated with the application.
-        
+
         :returns: A list of DNSRecord objects representing the DNS records.
         :rtype: list[DNSRecord]
         """
-        
+
         return await self.client.dns_records(self.id)
-    
+
     async def get_envs(self) -> dict[str, str]:
         """
         Get environment variables of the application.
@@ -745,7 +760,7 @@ async def set_envs(self, envs: dict[str, str]) -> dict[str,str]:
         :rtype: dict[str, str]
         """
         return await self.client.set_app_envs(self.id, envs)
-    
+
     async def delete_envs(self, keys: list[str]) -> dict[str,str]:
         """
         Deletes environment variables from the application.
@@ -756,7 +771,7 @@ async def delete_envs(self, keys: list[str]) -> dict[str,str]:
         :rtype: dict[str, str]
         """
         return await self.client.delete_app_envs(self.id, keys)
-    
+
     async def overwrite_env(self, envs: dict[str, str]) -> dict[str,str]:
         """
         Overwrites the environment variables for the application.
@@ -766,4 +781,4 @@ async def overwrite_env(self, envs: dict[str, str]) -> dict[str,str]:
         :return: A dictionary of the environment variables.
         :rtype: dict[str, str]
         """
-        return await self.client.overwrite_app_envs(self.id, envs)
+        return await self.client.overwrite_app_envs(self.id, envs)

squarecloud/client.py

@@ -64,6 +64,10 @@ def __init__(
         """
         self.log_level = log_level
         self._api_key = api_key
+
+        if not isinstance(self._api_key, str):
+            raise TypeError("api_key must be str")
+
         self._http = HTTPClient(api_key=api_key)
         self.logger = logger
         logger.setLevel(log_level)

squarecloud/data.py

@@ -40,7 +40,7 @@ class PlanData(BaseDataClass):
 
     name: str
     memory: dict[str, Any]
-    duration: dict[str, Any] | None
+    duration: int | None
 
 
 class Language(BaseDataClass):
@@ -139,6 +139,7 @@ class UserData(BaseDataClass):
     name: str
     plan: PlanData
     email: str | None = None
+    locale: str | None = None
 
 
 class LogsData(BaseDataClass):
@@ -306,13 +307,13 @@ def date_time(self) -> datetime:
             return datetime.fromisoformat(self.date)
     class ExtraBaseAnalytics(BaseAnalytics):
         type: str
-    class Visits(BaseAnalytics): 
+    class Visits(BaseAnalytics):
         pass
-    class Countries(ExtraBaseAnalytics): 
+    class Countries(ExtraBaseAnalytics):
         pass
     class Devices(ExtraBaseAnalytics):
         pass
-    class Os(ExtraBaseAnalytics): 
+    class Os(ExtraBaseAnalytics):
         pass
     class Browsers(ExtraBaseAnalytics):
         pass

squarecloud/errors.py

@@ -217,6 +217,15 @@ def __init__(self, domain: str, *args, **kwargs) -> None:
         self.message = f'"{domain}" is a invalid custom domain'
 
 
+class InvalidSubdomain(RequestError):
+    """
+    raised when an invalid subdomain is provided
+    """
+
+    def __init__(self, *args, **kwargs) -> None:
+        super().__init__(*args, **kwargs)
+        self.message = 'The provided subdomain is invalid or already in use.'
+
 class InvalidStart(InvalidConfig):
     def __init__(self, *args, **kwargs) -> None:
         super().__init__(*args, **kwargs)

squarecloud/http/http_client.py

@@ -28,6 +28,7 @@
     NotFoundError,
     RequestError,
     TooManyRequests,
+    InvalidSubdomain
 )
 from ..logger import logger
 from .endpoints import Endpoint, Router
@@ -82,7 +83,7 @@ def _get_error(code: str) -> type[RequestError] | None:
         'FEW_MEMORY': FewMemory,
         'BAD_MEMORY': BadMemory,
         'MISSING_CONFIG': MissingConfigFile,
-        'MISSING_DEPENDENCIES_FILE': MissingDependenciesFile,
+        'INVALID_DEPENDENCY': MissingDependenciesFile,
         'MISSING_MAIN': MissingMainFile,
         'INVALID_MAIN': InvalidMain,
         'INVALID_DISPLAY_NAME': InvalidDisplayName,
@@ -94,11 +95,10 @@ def _get_error(code: str) -> type[RequestError] | None:
         'INVALID_ACCESS_TOKEN': InvalidAccessToken,
         'REGEX_VALIDATION': InvalidDomain,
         'INVALID_START': InvalidStart,
+        'INVALID_SUBDOMAIN': InvalidSubdomain
     }
-    error_class = errors.get(code, None)
-    if error_class is None:
-        return None
-    return error_class
+    return errors.get(code, None)
+
 
 
 class HTTPClient:

tests/__init__.py

@@ -21,7 +21,7 @@ def create_zip(config: ConfigFile | str):
     with zipfile.ZipFile(buffer, 'w') as zip_file:
         zip_file.writestr('requirements.txt', 'discord.py')
 
-        zip_file.writestr('main.py', "print('ok')")
+        zip_file.writestr('main.py', "print('ok')\nwhile True:pass")
 
         zip_file.writestr('squarecloud.app', config)
 

tests/test_app.py

@@ -3,7 +3,7 @@
 import pytest
 
 import squarecloud
-from squarecloud import BackupInfo
+from squarecloud import SnapshotInfo
 from squarecloud.app import Application
 from squarecloud.http import Response
 from tests import GITHUB_ACCESS_TOKEN
@@ -24,12 +24,12 @@ async def test_app_status(self, app: Application):
     async def test_app_logs(self, app: Application):
         assert isinstance(await app.logs(), squarecloud.LogsData)
 
-    async def test_app_backup(self, app: Application):
-        assert isinstance(await app.backup(), squarecloud.Backup)
+    async def test_app_snapshot(self, app: Application):
+        assert isinstance(await app.snapshot(), squarecloud.Snapshot)
 
-    async def test_download_backup(self, app: Application):
-        backup = await app.backup()
-        zip_file = await backup.download()
+    async def test_download_snapshot(self, app: Application):
+        snapshot = await app.snapshot()
+        zip_file = await snapshot.download()
         assert isinstance(zip_file, ZipFile)
 
     async def test_app_github_integration(self, app: Application):
@@ -49,10 +49,10 @@ async def test_domain_analytics(self, app: Application):
     async def test_set_custom_domain(self, app: Application):
         assert isinstance(await app.set_custom_domain('test.com.br'), str)
 
-    async def test_get_all_backups(self, app: Application):
-        backups = await app.all_backups()
-        assert isinstance(backups, list)
-        assert isinstance(backups[0], BackupInfo)
+    async def test_get_all_snapshots(self, app: Application):
+        snapshots = await app.all_snapshots()
+        assert isinstance(snapshots, list)
+        assert isinstance(snapshots[0], SnapshotInfo)
 
     async def test_move_file(self, app: Application):
         response = await app.move_file('main.py', 'test.py')

tests/test_app_data.py

@@ -3,7 +3,7 @@
 import pytest
 
 from squarecloud.app import Application
-from squarecloud.data import Backup, LogsData, StatusData
+from squarecloud.data import Snapshot, LogsData, StatusData
 
 
 @pytest.mark.asyncio(scope='session')
@@ -25,19 +25,19 @@ async def test_status(self, app: Application):
         assert cache.status is None
         sleep(10)
 
-    async def test_backup(self, app: Application):
+    async def test_snapshot(self, app: Application):
         cache = app.cache
 
-        assert cache.backup is None
+        assert cache.snapshot is None
 
-        backup = await app.backup(update_cache=False)
-        assert cache.backup is None
+        snapshot = await app.snapshot(update_cache=False)
+        assert cache.snapshot is None
 
-        cache.update(backup)
-        assert isinstance(cache.backup, Backup)
+        cache.update(snapshot)
+        assert isinstance(cache.snapshot, Snapshot)
 
         cache.clear()
-        assert cache.backup is None
+        assert cache.snapshot is None
 
     async def test_logs(self, app: Application):
         cache = app.cache

tests/test_capture_listeners.py

@@ -7,7 +7,7 @@
 
 from squarecloud import Endpoint, errors
 from squarecloud.app import Application
-from squarecloud.data import Backup, LogsData, StatusData
+from squarecloud.data import Snapshot, LogsData, StatusData
 from squarecloud.listeners import Listener
 
 
@@ -36,14 +36,14 @@ async def capture_status(before, after):
 
         await app.status()
 
-    @_clear_listener_on_rerun(Endpoint.backup())
-    async def test_capture_backup(self, app: Application):
-        @app.capture(Endpoint.backup(), force_raise=True)
-        async def capture_backup(before, after):
+    @_clear_listener_on_rerun(Endpoint.snapshot())
+    async def test_capture_snapshot(self, app: Application):
+        @app.capture(Endpoint.snapshot(), force_raise=True)
+        async def capture_snapshot(before, after):
             assert before is None
-            assert isinstance(after, Backup)
+            assert isinstance(after, Snapshot)
 
-        await app.backup()
+        await app.snapshot()
 
     @_clear_listener_on_rerun(Endpoint.logs())
     async def test_capture_logs(self, app: Application):