apexdevkit 1.3.10__tar.gz → 1.3.12__tar.gz

{apexdevkit-1.3.10 → apexdevkit-1.3.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: apexdevkit
-Version: 1.3.10
+Version: 1.3.12
 Summary: Apex Development Tools for python.
 Author: Apex Dev
 Author-email: dev@apex.ge

{apexdevkit-1.3.10 → apexdevkit-1.3.12}/apexdevkit/error.py

@@ -38,3 +38,12 @@ class ExistsError(Exception):
 @dataclass
 class DoesNotExistError(Exception):
     id: Any = "unknown"
+
+
+@dataclass
+class ForbiddenError(Exception):
+    item: Any = field(default_factory=UnknownItem)
+
+    @property
+    def id(self) -> Any:
+        return self.item.id

{apexdevkit-1.3.10 → apexdevkit-1.3.12}/apexdevkit/fastapi/router.py

@@ -1,11 +1,11 @@
 from dataclasses import dataclass, field
 from functools import cached_property
-from typing import Annotated, Any, Iterable, Self, TypeVar
+from typing import Annotated, Any, Iterable, Protocol, Self, TypeVar
 
 from fastapi import APIRouter, Depends, Path
 from fastapi.responses import JSONResponse
 
-from apexdevkit.error import DoesNotExistError, ExistsError
+from apexdevkit.error import DoesNotExistError, ExistsError, ForbiddenError
 from apexdevkit.fastapi.schema import DataclassFields, RestfulSchema, SchemaFields
 from apexdevkit.fastapi.service import RawCollection, RawItem, RestfulService
 from apexdevkit.testing import RestfulName
@@ -55,6 +55,13 @@ class RestfulResponse:
             error=f"An item<{name}> with the {e} already exists.",
         )
 
+    def forbidden(self, e: ForbiddenError) -> dict[str, Any]:
+        return self._response(
+            403,
+            data={"id": str(e.id)},
+            error="Forbidden",
+        )
+
     def created_one(self, item: Any) -> dict[str, Any]:
         return self._response(201, item)
 
@@ -71,14 +78,34 @@ class RestfulResponse:
 T = TypeVar("T")
 
 
+class RestfulServiceInfra(Protocol):
+    def service_for(self, parent_id: str) -> RestfulService:
+        pass
+
+
+@dataclass(frozen=True)
+class SingleRestfulServiceInfra:
+    service: RestfulService
+
+    def service_for(self, parent_id: str) -> RestfulService:
+        return self.service
+
+
 @dataclass
 class RestfulRouter:
-    service: RestfulService
+    service: RestfulService | None = None
 
     router: APIRouter = field(default_factory=APIRouter)
 
     name: RestfulName = field(init=False)
     fields: SchemaFields = field(init=False)
+    infra: RestfulServiceInfra = field(init=False)
+
+    parent: str = field(init=False, default="")
+
+    def __post_init__(self) -> None:
+        if self.service:
+            self.infra = SingleRestfulServiceInfra(self.service)
 
     @cached_property
     def response(self) -> RestfulResponse:
@@ -92,6 +119,10 @@ class RestfulRouter:
     def id_alias(self) -> str:
         return self.name.singular + "_id"
 
+    @property
+    def parent_id_alias(self) -> str:
+        return self.parent + "_id"
+
     @property
     def item_path(self) -> str:
         return "/{" + self.id_alias + "}"
@@ -111,7 +142,27 @@ class RestfulRouter:
 
         return self
 
+    def with_parent(self, name: str) -> Self:
+        self.parent = name
+
+        return self
+
+    def with_service(self, value: RestfulService) -> Self:
+        self.infra = SingleRestfulServiceInfra(value)
+
+        return self
+
+    def with_infra(self, value: RestfulServiceInfra) -> Self:
+        self.infra = value
+
+        return self
+
     def with_create_one_endpoint(self, is_documented: bool = True) -> Self:
+        parent_id_type = Annotated[
+            str,
+            Path(alias=self.parent_id_alias, default_factory=str),
+        ]
+
         item_type = Annotated[
             RawItem,
             Depends(self.schema.for_create_one()),
@@ -124,9 +175,11 @@ class RestfulRouter:
             response_model=self.schema.for_item(),
             include_in_schema=is_documented,
         )
-        def create_one(item: item_type) -> _Response:
+        def create_one(parent_id: parent_id_type, item: item_type) -> _Response:
+            service = self.infra.service_for(parent_id)
+
             try:
-                item = self.service.create_one(item)
+                item = service.create_one(item)
             except ExistsError as e:
                 return JSONResponse(self.response.exists(e), 409)
 
@@ -135,6 +188,11 @@ class RestfulRouter:
         return self
 
     def with_create_many_endpoint(self, is_documented: bool = True) -> Self:
+        parent_id_type = Annotated[
+            str,
+            Path(alias=self.parent_id_alias, default_factory=str),
+        ]
+
         collection_type = Annotated[
             RawCollection,
             Depends(self.schema.for_create_many()),
@@ -147,9 +205,11 @@ class RestfulRouter:
             response_model=self.schema.for_collection(),
             include_in_schema=is_documented,
         )
-        def create_many(items: collection_type) -> _Response:
+        def create_many(parent_id: parent_id_type, items: collection_type) -> _Response:
+            service = self.infra.service_for(parent_id)
+
             try:
-                return self.response.created_many(self.service.create_many(items))
+                return self.response.created_many(service.create_many(items))
             except ExistsError as e:
                 return JSONResponse(self.response.exists(e), 409)
 
@@ -157,6 +217,10 @@ class RestfulRouter:
 
     def with_read_one_endpoint(self, is_documented: bool = True) -> Self:
         id_type = Annotated[str, Path(alias=self.id_alias)]
+        parent_id_type = Annotated[
+            str,
+            Path(alias=self.parent_id_alias, default_factory=str),
+        ]
 
         @self.router.get(
             self.item_path,
@@ -165,15 +229,22 @@ class RestfulRouter:
             response_model=self.schema.for_item(),
             include_in_schema=is_documented,
         )
-        def read_one(item_id: id_type) -> _Response:
+        def read_one(parent_id: parent_id_type, item_id: id_type) -> _Response:
+            service = self.infra.service_for(parent_id)
+
             try:
-                return self.response.found_one(self.service.read_one(item_id))
+                return self.response.found_one(service.read_one(item_id))
             except DoesNotExistError as e:
                 return JSONResponse(self.response.not_found(e), 404)
 
         return self
 
     def with_read_all_endpoint(self, is_documented: bool = True) -> Self:
+        parent_id_type = Annotated[
+            str,
+            Path(alias=self.parent_id_alias, default_factory=str),
+        ]
+
         @self.router.get(
             "",
             status_code=200,
@@ -181,12 +252,18 @@ class RestfulRouter:
             response_model=self.schema.for_collection(),
             include_in_schema=is_documented,
         )
-        def read_all() -> _Response:
-            return self.response.found_many(list(self.service.read_all()))
+        def read_all(parent_id: parent_id_type) -> _Response:
+            service = self.infra.service_for(parent_id)
+
+            return self.response.found_many(list(service.read_all()))
 
         return self
 
     def with_update_one_endpoint(self, is_documented: bool = True) -> Self:
+        parent_id_type = Annotated[
+            str,
+            Path(alias=self.parent_id_alias, default_factory=str),
+        ]
         id_type = Annotated[str, Path(alias=self.id_alias)]
         update_type = Annotated[
             RawItem,
@@ -200,17 +277,29 @@ class RestfulRouter:
             response_model=self.schema.for_no_data(),
             include_in_schema=is_documented,
         )
-        def update_one(item_id: id_type, updates: update_type) -> _Response:
+        def update_one(
+            parent_id: parent_id_type,
+            item_id: id_type,
+            updates: update_type,
+        ) -> _Response:
+            service = self.infra.service_for(parent_id)
+
             try:
-                self.service.update_one(item_id, **updates)
+                service.update_one(item_id, **updates)
             except DoesNotExistError as e:
                 return JSONResponse(self.response.not_found(e), 404)
+            except ForbiddenError as e:
+                return JSONResponse(self.response.forbidden(e), 403)
 
             return self.response.ok()
 
         return self
 
     def with_update_many_endpoint(self, is_documented: bool = True) -> Self:
+        parent_id_type = Annotated[
+            str,
+            Path(alias=self.parent_id_alias, default_factory=str),
+        ]
         collection_type = Annotated[
             RawCollection,
             Depends(self.schema.for_update_many()),
@@ -223,14 +312,20 @@ class RestfulRouter:
             response_model=self.schema.for_no_data(),
             include_in_schema=is_documented,
         )
-        def update_many(items: collection_type) -> _Response:
-            self.service.update_many(items)
+        def update_many(parent_id: parent_id_type, items: collection_type) -> _Response:
+            service = self.infra.service_for(parent_id)
+
+            service.update_many(items)
 
             return self.response.ok()
 
         return self
 
     def with_delete_one_endpoint(self, is_documented: bool = True) -> Self:
+        parent_id_type = Annotated[
+            str,
+            Path(alias=self.parent_id_alias, default_factory=str),
+        ]
         id_type = Annotated[str, Path(alias=self.id_alias)]
 
         @self.router.delete(
@@ -240,9 +335,11 @@ class RestfulRouter:
             response_model=self.schema.for_no_data(),
             include_in_schema=is_documented,
         )
-        def delete_one(item_id: id_type) -> _Response:
+        def delete_one(parent_id: parent_id_type, item_id: id_type) -> _Response:
+            service = self.infra.service_for(parent_id)
+
             try:
-                self.service.delete_one(item_id)
+                service.delete_one(item_id)
             except DoesNotExistError as e:
                 return JSONResponse(self.response.not_found(e), 404)
 

{apexdevkit-1.3.10 → apexdevkit-1.3.12}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "apexdevkit"
-version = "1.3.10"
+version = "1.3.12"
 description = "Apex Development Tools for python."
 authors = ["Apex Dev <dev@apex.ge>"]
 readme = "README.md"