feat(domain): add domains resource

Author: Datata1

examples/domains/list_domains.py

@@ -0,0 +1,16 @@
+import asyncio
+import logging
+from codesphere import CodesphereSDK
+
+logging.basicConfig(level=logging.INFO)
+
+
+async def main():
+    async with CodesphereSDK() as sdk:
+        domains = await sdk.domains.list(team_id=99999999)
+        for domain in domains:
+            print(domain.model_dump_json(indent=2))
+
+
+if __name__ == "__main__":
+    asyncio.run(main())

examples/workspaces/execute_command.py

@@ -2,13 +2,7 @@
 import logging
 from codesphere import CodesphereSDK
 
-# --- Logging-Konfiguration ---
 logging.basicConfig(level=logging.INFO)
-# (Optionale Logger stummschalten)
-logging.getLogger("codesphere.http_client").setLevel(logging.WARNING)
-logging.getLogger("httpx").setLevel(logging.WARNING)
-
-log = logging.getLogger(__name__)
 
 
 async def main():

src/codesphere/__init__.py

@@ -32,6 +32,13 @@
 )
 from .resources.workspace.envVars import EnvVar
 from .resources.metadata import Datacenter, Characteristic, WsPlan, Image
+from .resources.domain import (
+    Domain,
+    CustomDomainConfig,
+    DomainVerificationStatus,
+    DomainBase,
+    DomainsResource,
+)
 
 logging.getLogger("codesphere").addHandler(logging.NullHandler())
 
@@ -51,4 +58,9 @@
     "Characteristic",
     "WsPlan",
     "Image",
+    "Domain",
+    "CustomDomainConfig",
+    "DomainVerificationStatus",
+    "DomainBase",
+    "DomainsResource",
 ]

src/codesphere/client.py

@@ -8,6 +8,7 @@
 from .resources.metadata import MetadataResource
 from .resources.team import TeamsResource
 from .resources.workspace import WorkspacesResource
+from .resources.domain import DomainsResource
 
 
 class CodesphereSDK:
@@ -33,6 +34,7 @@ class CodesphereSDK:
         teams (TeamsResource): Access to Team API operations.
         workspaces (WorkspacesResource): Access to Workspace API operations.
         metadata (MetadataResource): Access to Metadata API operations.
+        domains (DomainResource): Access to Domain API operations.
     """
 
     teams: TeamsResource
@@ -44,11 +46,14 @@ class CodesphereSDK:
     metadata: MetadataResource
     """Access to the Metadata API. (e.g., `sdk.metadata.list_plans()`)"""
 
+    domains: DomainsResource
+
     def __init__(self):
         self._http_client = APIHttpClient()
         self.teams = TeamsResource(self._http_client)
         self.workspaces = WorkspacesResource(self._http_client)
         self.metadata = MetadataResource(self._http_client)
+        self.domains = DomainsResource(self._http_client)
 
     async def open(self):
         """Manually opens the underlying HTTP client session.

src/codesphere/resources/domain/__init__.py

@@ -0,0 +1,10 @@
+from .models import Domain, CustomDomainConfig, DomainVerificationStatus, DomainBase
+from .resources import DomainsResource
+
+__all__ = [
+    "Domain",
+    "CustomDomainConfig",
+    "DomainVerificationStatus",
+    "DomainBase",
+    "DomainsResource",
+]

src/codesphere/resources/domain/models.py

@@ -0,0 +1,115 @@
+"""
+Pydantic models for the Domain resource.
+"""
+
+from __future__ import annotations
+import logging
+from typing import Optional
+from pydantic import BaseModel, ConfigDict, Field
+from pydantic.alias_generators import to_camel
+
+from ...utils import update_model_fields
+from ...core import _APIOperationExecutor, APIOperation, AsyncCallable
+
+log = logging.getLogger(__name__)
+
+camel_config = ConfigDict(
+    alias_generator=to_camel,
+    populate_by_name=True,
+)
+
+
+class DomainBase(BaseModel):
+    model_config = camel_config
+
+    name: str
+    team_id: int
+    data_center_id: int
+    workspaces: dict[str, list[int]]
+    certificate_request_status: CertificateRequestStatus
+    dns_entries: DNSEntries
+    domain_verification_status: DomainVerificationStatus
+    custom_config_revision: Optional[int] = None
+    custom_config: Optional[CustomDomainConfig] = None
+
+
+class CertificateRequestStatus(BaseModel):
+    model_config = camel_config
+    issued: bool
+    reason: Optional[str] = None
+
+
+class DNSEntries(BaseModel):
+    model_config = camel_config
+    a: str
+    cname: str
+    txt: str
+
+
+class DomainVerificationStatus(BaseModel):
+    model_config = camel_config
+    verified: bool
+    reason: Optional[str] = None
+
+
+class CustomDomainConfig(BaseModel):
+    max_body_size_mb: int
+    max_connection_timeout: int
+    use_regex: bool
+    restricted: bool
+
+
+class Domain(DomainBase, _APIOperationExecutor):
+    update_domain_op: AsyncCallable[None] = Field(
+        default=APIOperation(
+            method="PATCH",
+            endpoint_template="/domains/team/{team_id}/domain/{name}",
+            response_model=DomainBase,
+        ),
+        exclude=True,
+    )
+
+    update_workspace_connections_op: AsyncCallable[None] = Field(
+        default=APIOperation(
+            method="PUT",
+            endpoint_template="/domains/team/{team_id}/domain/{name}/workspace-connections",
+            response_model=DomainBase,
+        ),
+        exclude=True,
+    )
+
+    verify_domain_op: AsyncCallable[None] = Field(
+        default=APIOperation(
+            method="POST",
+            endpoint_template="/domains/team/{team_id}/domain/{name}/verify",
+            response_model=DomainVerificationStatus,
+        ),
+        exclude=True,
+    )
+
+    delete_domain_op: AsyncCallable[None] = Field(
+        default=APIOperation(
+            method="DELETE",
+            endpoint_template="/domains/team/{team_id}/domain/{name}",
+            response_model=DomainBase,
+        ),
+        exclude=True,
+    )
+
+    async def update_domain(self, data: CustomDomainConfig) -> DomainBase:
+        await self.update_domain_op(data=data)
+        update_model_fields(target=self.custom_config, source=data)
+
+    async def update_workspace_connections(
+        self, data: dict[str, list[int]]
+    ) -> DomainBase:
+        response = await self.update_workspace_connections_op(data=data)
+        update_model_fields(target=self, source=response)
+
+    async def verify_status(self) -> DomainVerificationStatus:
+        response = await self.verify_domain_op()
+        update_model_fields(target=self.domain_verification_status, source=response)
+        return response
+
+    async def delete(self) -> None:
+        await self.delete_domain_op()

src/codesphere/resources/domain/resources.py

@@ -0,0 +1,40 @@
+from typing import List, Protocol
+
+from .models import Domain
+
+from ...core import APIOperation, ResourceBase
+
+
+class ListDomainsCallable(Protocol):
+    async def __call__(self, *, team_id: int) -> List[Domain]: ...
+
+
+class GetDomainCallable(Protocol):
+    async def __call__(self, *, team_id: int, domain_name: str) -> Domain: ...
+
+
+class CreateDomainCallable(Protocol):
+    async def __call__(self, *, team_id: int, domain_name: str) -> Domain: ...
+
+
+class DomainsResource(ResourceBase):
+    list: ListDomainsCallable
+    list = APIOperation(
+        method="GET",
+        endpoint_template="/domains/team/{team_id}",
+        response_model=List[Domain],
+    )
+
+    get: GetDomainCallable
+    get = APIOperation(
+        method="GET",
+        endpoint_template="/domains/team/{team_id}/domain/{domain_name}",
+        response_model=Domain,
+    )
+
+    create: CreateDomainCallable
+    create = APIOperation(
+        method="POST",
+        endpoint_template="/domains/team/{team_id}/domain/{domain_name}",
+        response_model=Domain,
+    )

src/codesphere/resources/workspace/models.py

@@ -4,6 +4,7 @@
 from pydantic import BaseModel, Field
 from typing import Dict, Optional, List
 
+from ...utils import update_model_fields
 from ...core import _APIOperationExecutor, APIOperation, AsyncCallable
 from .envVars import EnvVar, WorkspaceEnvVarManager
 
@@ -117,10 +118,7 @@ async def update(self, data: WorkspaceUpdate) -> None:
             data (WorkspaceUpdate): The payload with fields to update.
         """
         await self.update_op(data=data)
-        update_data = data.model_dump(exclude_unset=True)
-        log.debug(f"Updating local workspace state (id={self.id}) with: {update_data}")
-        for key, value in update_data.items():
-            setattr(self, key, value)
+        update_model_fields(target=self, source=data)
 
     async def delete(self) -> None:
         """Deletes this workspace."""
@@ -133,17 +131,6 @@ async def get_status(self) -> WorkspaceStatus:
     async def execute_command(
         self, command: str, env: Optional[Dict[str, str]] = None
     ) -> CommandOutput:
-        """
-        Führt einen Befehl in diesem Workspace aus.
-
-        Args:
-            command (str): Der Bash-Befehl (z.B. "ls -la").
-            env (Dict[str, str], optional): Env Vars, die nur
-                für diesen Befehl gesetzt werden.
-
-        Returns:
-            CommandOutput: Ein Objekt mit stdout und stderr.
-        """
         command_data = CommandInput(command=command, env=env)
         return await self.execute_command_op(data=command_data)
 

src/codesphere/utils.py

@@ -0,0 +1,16 @@
+import logging
+from pydantic import BaseModel
+from typing import Any, Dict
+
+log = logging.getLogger(__name__)
+
+
+def update_model_fields(target: BaseModel, source: BaseModel) -> Dict[str, Any]:
+    update_data = source.model_dump(exclude_unset=True)
+
+    log.debug(f"Updating {target.__class__.__name__} with data: {update_data}")
+
+    for key, value in update_data.items():
+        setattr(target, key, value)
+
+    return update_data