✨ feat: added support to new endpoints in cli and wrapper

Author: robert-nogueira

squarecloud/app.py

@@ -10,6 +10,7 @@
     AppData,
     BackupData,
     DeployData,
+    DomainAnalytics,
     FileInfo,
     LogsData,
     StatusData,
@@ -619,3 +620,15 @@ async def github_integration(self, access_token: str) -> str:
             avoid_listener=True,
         )
         return webhook
+
+    async def domain_analytics(self) -> DomainAnalytics:
+        analytics: DomainAnalytics = await self.client.domain_analytics(
+            self.id, avoid_listener=True
+        )
+        return analytics
+
+    async def set_custom_domain(self, custom_domain: str):
+        response: Response = await self.client.set_custom_domain(
+            self.id, custom_domain, avoid_listener=True
+        )
+        return response

squarecloud/cli/__init__.py

@@ -3,7 +3,7 @@
 
 import click
 
-__version__ = '3.1.5'
+__version__ = '3.2.1'
 
 
 def run_async(func):

squarecloud/cli/app.py

@@ -14,6 +14,8 @@
 from squarecloud.data import (
     AppData,
     BackupData,
+    DeployData,
+    DomainAnalytics,
     LogsData,
     StatusData,
     UploadData,
@@ -88,7 +90,7 @@ async def get_app_status(ctx: Context):
 
         table = Table(title='Status', header_style='purple')
 
-        status_list = status.__slots__
+        status_list = status.to_dict()
         for s in status_list:
             table.add_column(s.capitalize(), justify='center')
         table.add_row(
@@ -158,7 +160,7 @@ async def app_data(ctx: Context):
         data: AppData = await client.app_data(app_id)
         table = Table(title='Status', header_style='purple')
 
-        status_list = data.__slots__
+        status_list = data.to_dict()
         for s in status_list:
             table.add_column(s.capitalize(), justify='center')
         table.add_row(
@@ -329,3 +331,98 @@ async def commit(ctx: Context, file: BufferedReader):
             style='green',
         )
     )
+
+
+@app_group.command(name='last-deploys')
+@click.pass_context
+@run_async
+async def last_deploys(ctx: Context):
+    with Console().status('loading'):
+        client: Client = ctx.obj['client']
+        app_id = ctx.obj['app_id']
+        deploys: list[list[DeployData]] = await client.last_deploys(app_id)
+    if not deploys:
+        print(
+            Panel(
+                'You do not have any recent deploys for this application',
+                title='No deploys',
+                title_align='left',
+                style='red',
+            ),
+        )
+        return
+    for deploy in deploys:
+        table = Table(header_style='purple')
+
+        attr_list = deploy[0].__dict__
+        for s in attr_list:
+            table.add_column(s.capitalize(), justify='center')
+
+        for d in deploy:
+            table.add_row(
+                *[str(getattr(d, attr)) for attr in attr_list],
+                style='green',
+            )
+
+        print(table)
+
+
+@app_group.command(name='github-integration')
+@click.argument('access_token', type=click.STRING)
+@click.pass_context
+@run_async
+async def github_integration(ctx: Context, access_token: str):
+    with Console().status('loading'):
+        client: Client = ctx.obj['client']
+        app_id = ctx.obj['app_id']
+        webhook_url: str = await client.github_integration(
+            app_id, access_token
+        )
+    print(
+        Panel(
+            webhook_url,
+            title='Webhook url',
+            border_style='purple',
+            style='green',
+        )
+    )
+
+
+@app_group.command(name='custom-domain')
+@click.argument('domain', type=click.STRING)
+@click.pass_context
+@run_async
+async def custom_domain(ctx: Context, domain: str):
+    with Console().status('loading'):
+        client: Client = ctx.obj['client']
+        app_id = ctx.obj['app_id']
+        await client.set_custom_domain(app_id, domain)
+    print(
+        Panel(
+            f'Domain defined to "{domain}"',
+            title='Success',
+            border_style='purple',
+            style='green',
+        )
+    )
+
+
+@app_group.command(name='domain-analytics')
+@click.pass_context
+@run_async
+async def domain_analytics(ctx: Context):
+    with Console().status('loading'):
+        client: Client = ctx.obj['client']
+        app_id = ctx.obj['app_id']
+        analytics: DomainAnalytics = await client.domain_analytics(app_id)
+        table = Table(title='Status', header_style='purple')
+
+        attr_list = analytics.to_dict()
+        for s in attr_list:
+            table.add_column(s.capitalize(), justify='center')
+        table.add_row(
+            *[str(getattr(analytics, attr)) for attr in attr_list],
+            style='green',
+        )
+
+    print(table)

squarecloud/client.py

@@ -11,6 +11,7 @@
     AppData,
     BackupData,
     DeployData,
+    DomainAnalytics,
     FileInfo,
     LogsData,
     StatisticsData,
@@ -92,17 +93,9 @@ def create_config_file(
 
 
 class Client(AbstractClient):
-    """A client for interacting with the SquareCloud API.
-
-    :ivar api_key: the api key for the client
-    :ivar debug: weather the debug messages is enabled
-
-    :type api_key: str
-    :type debug: bool
-    """
+    """A client for interacting with the SquareCloud API."""
 
     def __init__(self, api_key: str, debug: bool = True) -> None:
-
         """
         The __init__ function is called when the class is instantiated.
         It sets up the instance of the class, and defines all of its
@@ -619,3 +612,28 @@ async def github_integration(
             )
         data = response.response
         return data.get('webhook')
+
+    async def set_custom_domain(
+        self, app_id: str, custom_domain: str, **kwargs
+    ) -> Response:
+        response: Response = await self._http.update_custom_domain(
+            app_id=app_id, custom_domain=custom_domain
+        )
+        if not kwargs.get('avoid_listener'):
+            endpoint: Endpoint = response.route.endpoint
+            await self._listener.on_request(
+                endpoint=endpoint, response=response
+            )
+        return response
+
+    async def domain_analytics(self, app_id: str, **kwargs) -> DomainAnalytics:
+        response: Response = await self._http.domain_analytics(
+            app_id=app_id,
+        )
+        if not kwargs.get('avoid_listener'):
+            endpoint: Endpoint = response.route.endpoint
+            await self._listener.on_request(
+                endpoint=endpoint, response=response
+            )
+        analytics: DomainAnalytics = DomainAnalytics(**response.response)
+        return analytics

squarecloud/data.py

@@ -29,6 +29,9 @@ class PlanData:
     memory: Dict[str, Any]
     duration: Dict[str, Any] | None
 
+    def to_dict(self):
+        return self.__dict__
+
 
 # @dataclass(frozen=True)
 class Language(TypedDict):
@@ -72,8 +75,11 @@ class StatusData:
     uptime: conint(ge=0) | None = None
     time: conint(ge=0) | None = None
 
+    def to_dict(self):
+        return self.__dict__
+
 
-@dataclass(frozen=True, slots=True)
+@dataclass(frozen=True)
 class AppData:
     """
     Application data class
@@ -112,6 +118,9 @@ class AppData:
     custom: str | None = None
     desc: str | None = None
 
+    def to_dict(self):
+        return self.__dict__
+
 
 @dataclass(frozen=True)
 class UserData:
@@ -134,6 +143,9 @@ class UserData:
     plan: PlanData
     email: str | None = None
 
+    def to_dict(self):
+        return self.__dict__
+
 
 @dataclass(frozen=True)
 class LogsData:
@@ -189,6 +201,9 @@ async def example():
         """
         return isinstance(other, LogsData) and self.logs == other.logs
 
+    def to_dict(self):
+        return self.__dict__
+
 
 @dataclass(frozen=True)
 class BackupData:
@@ -202,6 +217,9 @@ class BackupData:
 
     downloadURL: str
 
+    def to_dict(self):
+        return self.__dict__
+
 
 @dataclass(frozen=True)
 class UploadData:
@@ -233,6 +251,9 @@ class UploadData:
     subdomain: str | None = None
     description: str | None = None
 
+    def to_dict(self):
+        return self.__dict__
+
 
 @dataclass(frozen=True)
 class FileInfo:
@@ -258,6 +279,9 @@ class FileInfo:
     lastModified: conint(ge=0) | float
     path: str
 
+    def to_dict(self):
+        return self.__dict__
+
 
 @dataclass(frozen=True)
 class StatisticsData:
@@ -280,9 +304,33 @@ class StatisticsData:
     websites: conint(ge=0)
     ping: conint(ge=0)
 
+    def to_dict(self):
+        return self.__dict__
+
 
 @dataclass(frozen=True)
 class DeployData:
     id: str
     state: str
     date: datetime
+
+    def to_dict(self):
+        return self.__dict__
+
+
+@dataclass(frozen=True)
+class DomainAnalytics:
+    hostname: str
+    total: list[Any]
+    countries: list[Any]
+    methods: list[Any]
+    referers: list[Any]
+    browsers: list[Any]
+    deviceTypes: list[Any]
+    operatingSystems: list[Any]
+    agents: list[Any]
+    hosts: list[Any]
+    paths: list[Any]
+
+    def to_dict(self):
+        return self.__dict__

squarecloud/errors.py

@@ -15,7 +15,7 @@ class RequestError(SquareException):
     """raised when a request fails"""
 
     def __init__(
-        self, route: str, status_code: int, code: str, *args, **kwargs
+            self, route: str, status_code: int, code: str, *args, **kwargs
     ):
         self.route = route
         self.status = status_code
@@ -29,7 +29,9 @@ class AuthenticationFailure(RequestError):
 
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
-        self.message = 'Authentication failed: Invalid API token'
+        self.message = (
+            'Authentication failed: ' 'Invalid API token or access denied'
+        )
 
 
 class NotFoundError(RequestError):
@@ -199,5 +201,20 @@ def __init__(self, *args, **kwargs):
 
 
 class InvalidAccessToken(RequestError):
-    def __init__(self, *args, **kwargs):
+    """
+    raised when the GitHub access token provided by the user is invalid.
+    """
+
+
+def __init__(self, *args, **kwargs):
+    super().__init__(*args, **kwargs)
+
+
+class InvalidDomain(RequestError):
+    """
+    raised when an invalid domain is provided
+    """
+
+    def __init__(self, domain: str, *args, **kwargs):
         super().__init__(*args, **kwargs)
+        self.message = f'{domain} is a invalid custom domain'