✨ feat: added endpoints "LAST_DEPLOYS" and "GITHUB_INTEGRATION"

Author: robert-nogueira

pyproject.toml

@@ -28,13 +28,6 @@ pre-commit = "^3.3.3"
 ruff = "^0.0.289"
 memory-profiler = "^0.61.0"
 
-[tool.poetry.group.doc.dependencies]
-mkdocs-material = "^9.1.21"
-mkdocstrings = "^0.22.0"
-mkdocstrings-python = "^1.2.1"
-termynal = "^0.11.0"
-mkdocs-table-reader-plugin = "^2.0.1"
-
 [build-system]
 requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"

squarecloud/app.py

@@ -1,10 +1,19 @@
+from __future__ import annotations
+
 from abc import ABC
 from io import BytesIO
 from typing import TYPE_CHECKING, Callable
 
 from pydantic import PositiveInt
 
-from .data import AppData, BackupData, FileInfo, LogsData, StatusData
+from .data import (
+    AppData,
+    BackupData,
+    DeployData,
+    FileInfo,
+    LogsData,
+    StatusData,
+)
 from .errors import SquareException
 from .file import File
 from .http import Endpoint, HTTPClient, Response
@@ -609,3 +618,32 @@ async def delete_file(self, path: str, **kwargs) -> Response:
                 endpoint=endpoint, response=response
             )
         return response
+
+    async def last_deploys(self, **kwargs) -> list[list[DeployData]]:
+        """
+        The last_deploys function returns a list of the last deploys for this
+        application.
+
+        :param self: Represent the instance of the class
+        :param: Pass in keyword arguments as a dictionary
+        :return: A list of DeployData objects
+        """
+        response: list[list[DeployData]] = await self.client.last_deploys(
+            self.id, avoid_listener=True,
+        )
+        return response
+
+    async def github_integration(self, access_token: str, **kwargs) -> str:
+        """
+        The create_github_integration function returns a webhook to integrate
+        with a GitHub repository.
+
+        :param self: Access the properties of the class
+        :param access_token: str: Authenticate the user with GitHub
+        :param kwargs: Pass in additional arguments to the function
+        :return: A string containing the webhook url
+        """
+        webhook: str = await self.client.github_integration(
+            self.id, access_token, avoid_listener=True,
+        )
+        return webhook

squarecloud/client.py

@@ -10,6 +10,7 @@
 from .data import (
     AppData,
     BackupData,
+    DeployData,
     FileInfo,
     LogsData,
     StatisticsData,
@@ -583,3 +584,38 @@ async def app_data(self, app_id: str, **kwargs) -> AppData:
                 endpoint=endpoint, response=response
             )
         return AppData(**response.response)
+
+    async def last_deploys(
+        self, app_id: str, **kwargs
+    ) -> list[list[DeployData]]:
+        """
+        The last_deploys function returns a list of DeployData objects.
+
+        :param self: Represent the instance of a class
+        :param app_id: str: Specify the app id
+        :param kwargs: Pass a variable number of keyword arguments to the
+        function
+        :return: A list of DeployData objects
+        """
+        response: Response = await self._http.get_last_deploys(app_id)
+        if not kwargs.get('avoid_listener'):
+            endpoint: Endpoint = response.route.endpoint
+            await self._listener.on_request(
+                endpoint=endpoint, response=response
+            )
+        data = response.response
+        return [[DeployData(**deploy) for deploy in _] for _ in data]
+
+    async def github_integration(
+        self, app_id: str, access_token: str, **kwargs
+    ) -> str:
+        response: Response = await self._http.create_github_integration(
+            app_id=app_id, github_access_token=access_token
+        )
+        if not kwargs.get('avoid_listener'):
+            endpoint: Endpoint = response.route.endpoint
+            await self._listener.on_request(
+                endpoint=endpoint, response=response
+            )
+        data = response.response
+        return data.get('webhook')

squarecloud/data.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+from datetime import datetime
 from typing import Any, Dict, Literal
 
 from pydantic import conint
@@ -120,7 +121,6 @@ class UserData:
     :ivar id: User ID;
     :ivar tag: Username
     :ivar plan: User plan
-    :ivar blocklist: Whether to user is blocked
     :ivar email: User email
 
     :type id: conint(ge=0)
@@ -268,16 +268,21 @@ class StatisticsData:
     :ivar apps: Amount of apps hosted
     :ivar websites: Amount of websites hosted
     :ivar ping: Service ping
-    :ivar time: Time
 
     :type users: conint(ge=0)
     :type apps: conint(ge=0)
     :type websites: conint(ge=0)
     :type ping: conint(ge=0)
-    :type time: conint(ge=0)
     """
 
     users: conint(ge=0)
     apps: conint(ge=0)
     websites: conint(ge=0)
     ping: conint(ge=0)
+
+
+@dataclass(frozen=True)
+class DeployData:
+    id: str
+    state: str
+    date: datetime

squarecloud/errors.py

@@ -45,7 +45,6 @@ class BadRequestError(RequestError):
 
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
-        self.message = 'Bad request: 400'
 
 
 class ApplicationNotFound(SquareException):
@@ -197,3 +196,8 @@ class MissingVersion(InvalidConfig):
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
         self.message = 'Version value is missing in the config file'
+
+
+class InvalidAccessToken(RequestError):
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)

squarecloud/http/endpoints.py

@@ -55,6 +55,14 @@ class Endpoint:
             'METHOD': 'DELETE',
             'PATH': '/apps/{app_id}/files/delete?path={path}',
         },
+        'LAST_DEPLOYS': {
+            'METHOD': 'GET',
+            'PATH': '/apps/{app_id}/deploy/list',
+        },
+        'GITHUB_INTEGRATION': {
+            'METHOD': 'POST',
+            'PATH': '/apps/{app_id}/deploy/git-webhook',
+        },
     }
 
     def __init__(self, name: str) -> None:
@@ -71,7 +79,7 @@ def __init__(self, name: str) -> None:
         :return: None
         """
 
-        endpoint: Dict[str, Dict[str, Any]] = self.ENDPOINTS_V2[name]
+        endpoint: Dict[str, Any] = self.ENDPOINTS_V2[name]
         self.name: str = name
         self.method: str = endpoint['METHOD']
         self.path: str = endpoint['PATH']
@@ -231,6 +239,19 @@ def statistics(cls) -> Endpoint:
         """
         return cls('STATISTICS')
 
+    @classmethod
+    def last_deploys(cls):
+        """
+        The last_deploys function returns a list of the last deploys that have
+        been made.
+        """
+
+        return cls('LAST_DEPLOYS')
+
+    @classmethod
+    def github_integration(cls):
+        return cls('GITHUB_INTEGRATION')
+
 
 # pylint: disable=too-few-public-methods
 class Router:

squarecloud/http/http_client.py

@@ -11,6 +11,7 @@
     BadMemory,
     BadRequestError,
     FewMemory,
+    InvalidAccessToken,
     InvalidDisplayName,
     InvalidMain,
     InvalidMemory,
@@ -64,7 +65,7 @@ def __repr__(self):
         return f'{Response.__name__}({self.data})'
 
 
-def _get_upload_error(code: str) -> type[RequestError]:
+def _get_upload_error(code: str) -> type[RequestError] | None:
     errors = {
         'FEW_MEMORY': FewMemory,
         'BAD_MEMORY': BadMemory,
@@ -78,10 +79,11 @@ def _get_upload_error(code: str) -> type[RequestError]:
         'MISSING_MEMORY': MissingMemory,
         'INVALID_VERSION': InvalidVersion,
         'MISSING_VERSION': MissingVersion,
+        'INVALID_ACCESS_TOKEN': InvalidAccessToken,
     }
     error_class = errors.get(code, None)
     if error_class is None:
-        return RequestError
+        return
     else:
         return error_class
 
@@ -138,13 +140,6 @@ async def request(self, route: Router, **kwargs) -> Response | bytes:
 
                 if status_code == 200:
                     logger.debug(msg='request to route: ', extra=extra)
-                    if code and route.endpoint in (
-                        Endpoint.commit(),
-                        Endpoint.upload(),
-                    ):
-                        error = _get_upload_error(
-                            code,
-                        )
                     extra.pop('code')
                     response: Response = Response(data=data, route=route)
                 elif status_code == 404:
@@ -165,6 +160,9 @@ async def request(self, route: Router, **kwargs) -> Response | bytes:
                     error = TooManyRequests
                 else:
                     error = RequestError
+
+                if _ := _get_upload_error(code):
+                    error = _
                 if error:
                     raise error(
                         **extra_error_kwargs,
@@ -375,7 +373,7 @@ async def get_statistics(self) -> Response:
         The get_statistics function returns the statistics of the current
         market.
 
-        :param self: Access the attributes and methods of a class
+        :param self: Represent the instance of a class
         :return: A Response object
         """
         route: Router = Router(Endpoint.statistics())
@@ -392,6 +390,37 @@ async def get_app_data(self, app_id: str) -> Response:
         get data
         :return: A Response object
         """
-        route: Router = Router(Endpoint('APP_DATA'), app_id=app_id)
+        route: Router = Router(Endpoint.app_data(), app_id=app_id)
+        response: Response = await self.request(route)
+        return response
+
+    async def get_last_deploys(self, app_id: str) -> Response:
+        """
+        The get_last_deploys function returns the last deploys of an
+        application.
+
+        :param self: Represent the instance of a class
+        :param app_id: str: Specify the application id
+        :return: A Response object
+        """
+        route: Router = Router(Endpoint.last_deploys(), app_id=app_id)
         response: Response = await self.request(route)
         return response
+
+    async def create_github_integration(
+        self, app_id: str, github_access_token: str
+    ) -> Response:
+        """
+        The create_github_integration function returns a webhook to integrate
+        with a GitHub repository.
+
+        :param self: Represent the instance of a class
+        :param app_id: str: Identify the app that you want to create a GitHub
+        integration for
+        :param github_access_token: str: Authenticate the user
+        :return: A response object
+        """
+        route: Router = Router(Endpoint.github_integration(), app_id=app_id)
+        body = {'access_token': github_access_token}
+        response: Response = await self.request(route, json=body)
+        return response

tests/__init__.py

@@ -9,6 +9,8 @@
 load_dotenv()
 client = squarecloud.Client(os.getenv('KEY'))
 
+GITHUB_ACCESS_TOKEN: str = os.getenv('GITHUB_ACCESS_TOKEN')
+
 
 def create_zip(include_squarecloud_app: bool = True):
     buffer = io.BytesIO()

tests/test_app.py

@@ -1,6 +1,6 @@
 import pytest
 
-from . import client
+from . import client, GITHUB_ACCESS_TOKEN
 
 
 @pytest.mark.asyncio
@@ -13,3 +13,5 @@ async def test_basic_usage(self):
         await app.logs()
         await app.backup()
         await app.data()
+        await app.github_integration(GITHUB_ACCESS_TOKEN)
+        await app.last_deploys()