apexdevkit 1.6.5__tar.gz → 1.7.1__tar.gz

{apexdevkit-1.6.5 → apexdevkit-1.7.1}/PKG-INFO

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

{apexdevkit-1.6.5 → apexdevkit-1.7.1}/apexdevkit/fastapi/resource.py

@@ -1,25 +1,20 @@
 from dataclasses import dataclass
-from functools import cached_property
 from typing import Any, Callable
 
 from starlette.responses import JSONResponse
 
 from apexdevkit.error import DoesNotExistError, ExistsError, ForbiddenError
 from apexdevkit.fastapi.response import RestfulResponse
-from apexdevkit.testing import RestfulName
 
 _Response = JSONResponse | dict[str, Any]
+_Endpoint = Callable[..., _Response]
 
 
 @dataclass
 class RestfulResource:
-    name: RestfulName
+    response: RestfulResponse
 
-    @cached_property
-    def response(self) -> RestfulResponse:
-        return RestfulResponse(name=self.name)
-
-    def create_one(self, Service, Item) -> Callable[..., _Response]:  # type: ignore
+    def create_one(self, Service, Item) -> _Endpoint:  # type: ignore
         def endpoint(service: Service, item: Item) -> _Response:
             try:
                 item = service.create_one(item)
@@ -32,7 +27,7 @@ class RestfulResource:
 
         return endpoint
 
-    def create_many(self, Service, Collection) -> Callable[..., _Response]:  # type: ignore
+    def create_many(self, Service, Collection) -> _Endpoint:  # type: ignore
         def endpoint(service: Service, items: Collection) -> _Response:
             try:
                 return self.response.created_many(service.create_many(items))
@@ -43,7 +38,7 @@ class RestfulResource:
 
         return endpoint
 
-    def read_one(self, Service, ItemId) -> Callable[..., _Response]:  # type: ignore
+    def read_one(self, Service, ItemId) -> _Endpoint:  # type: ignore
         def endpoint(service: Service, item_id: ItemId) -> _Response:
             try:
                 return self.response.found_one(service.read_one(item_id))
@@ -54,7 +49,7 @@ class RestfulResource:
 
         return endpoint
 
-    def read_all(self, Service) -> Callable[..., _Response]:  # type: ignore
+    def read_all(self, Service) -> _Endpoint:  # type: ignore
         def endpoint(service: Service) -> _Response:
             try:
                 return self.response.found_many(list(service.read_all()))
@@ -63,7 +58,7 @@ class RestfulResource:
 
         return endpoint
 
-    def update_one(self, Service, ItemId, Updates) -> Callable[..., _Response]:  # type: ignore
+    def update_one(self, Service, ItemId, Updates) -> _Endpoint:  # type: ignore
         def endpoint(service: Service, item_id: ItemId, updates: Updates) -> _Response:
             try:
                 service.update_one(item_id, **updates)
@@ -76,7 +71,7 @@ class RestfulResource:
 
         return endpoint
 
-    def update_many(self, Service, Collection) -> Callable[..., _Response]:  # type: ignore
+    def update_many(self, Service, Collection) -> _Endpoint:  # type: ignore
         def endpoint(service: Service, items: Collection) -> _Response:
             try:
                 service.update_many(items)
@@ -89,7 +84,7 @@ class RestfulResource:
 
         return endpoint
 
-    def replace_one(self, Service, Item) -> Callable[..., _Response]:  # type: ignore
+    def replace_one(self, Service, Item) -> _Endpoint:  # type: ignore
         def endpoint(service: Service, item: Item) -> _Response:
             try:
                 service.replace_one(item)
@@ -102,7 +97,7 @@ class RestfulResource:
 
         return endpoint
 
-    def replace_many(self, Service, Collection) -> Callable[..., _Response]:  # type: ignore
+    def replace_many(self, Service, Collection) -> _Endpoint:  # type: ignore
         def endpoint(service: Service, items: Collection) -> _Response:
             try:
                 service.replace_many(items)
@@ -115,7 +110,7 @@ class RestfulResource:
 
         return endpoint
 
-    def delete_one(self, Service, ItemId) -> Callable[..., _Response]:  # type: ignore
+    def delete_one(self, Service, ItemId) -> _Endpoint:  # type: ignore
         def endpoint(service: Service, item_id: ItemId) -> _Response:
             try:
                 service.delete_one(item_id)

{apexdevkit-1.6.5 → apexdevkit-1.7.1}/apexdevkit/fastapi/response.py

@@ -3,94 +3,35 @@ from __future__ import annotations
 from dataclasses import dataclass
 from typing import Any, Iterable
 
-from fastapi import status
-from fastapi.responses import JSONResponse
-
 from apexdevkit.error import DoesNotExistError, ExistsError, ForbiddenError
 from apexdevkit.testing import RestfulName
 
 
-class SuccessResponse(dict[str, Any]):
-    def __init__(self, status_code: int, **kwargs: Any):
-        super().__init__(
-            {
-                "status": "success",
-                "code": status_code,
-                "data": {**kwargs},
-            }
-        )
-
-
-class ResourceFound(SuccessResponse):
-    def __init__(self, **kwargs: Any):
-        super().__init__(status_code=status.HTTP_200_OK, **kwargs)
-
-
-class ResourceCreated(SuccessResponse):
-    def __init__(self, **kwargs: Any):
-        super().__init__(status_code=status.HTTP_201_CREATED, **kwargs)
-
-
-class ErrorResponse(JSONResponse):
-    def __init__(self, status_code: int, message: str, **kwargs: Any):
-        content = {
-            "status": "fail",
-            "code": status_code,
-            "error": {"message": message},
-        }
-
-        if kwargs:
-            content["data"] = {**kwargs}
-
-        super().__init__(status_code=status_code, content=content)
-
-
-class BadRequest(ErrorResponse):
-    def __init__(self, message: str, **kwargs: Any) -> None:
-        super().__init__(
-            status_code=status.HTTP_400_BAD_REQUEST,
-            message=message,
-            **kwargs,
-        )
-
-
-class ResourceNotFound(ErrorResponse):
-    def __init__(self, message: str):
-        super().__init__(status_code=status.HTTP_404_NOT_FOUND, message=message)
-
-
-class ResourceExists(ErrorResponse):
-    def __init__(self, message: str, **kwargs: Any):
-        super().__init__(
-            status_code=status.HTTP_409_CONFLICT,
-            message=message,
-            **kwargs,
-        )
-
-
 @dataclass
 class RestfulResponse:
     name: RestfulName
 
-    def _response(self, code: int, data: Any, error: str = "") -> dict[str, Any]:
-        content: dict[str, Any] = {"code": code, "status": "success"}
+    def ok(self) -> dict[str, Any]:
+        return self._response(200, data=None)
 
-        if error:
-            content["status"] = "fail"
-            content["error"] = {"message": error}
+    def found_one(self, item: Any) -> dict[str, Any]:
+        return self._response(200, item)
 
-        match data:
-            case None:
-                content["data"] = {}
-            case list():
-                content["data"] = {self.name.plural: data, "count": len(data)}
-            case _:
-                content["data"] = {self.name.singular: data}
+    def found_many(self, items: list[Any]) -> dict[str, Any]:
+        return self._response(200, items)
 
-        return content
+    def created_one(self, item: Any) -> dict[str, Any]:
+        return self._response(201, item)
 
-    def ok(self) -> dict[str, Any]:
-        return self._response(200, data=None)
+    def created_many(self, items: Iterable[Any]) -> dict[str, Any]:
+        return self._response(201, list(items))
+
+    def forbidden(self, e: ForbiddenError) -> dict[str, Any]:
+        return self._response(
+            403,
+            data={"id": str(e.id)},
+            error=e.message,
+        )
 
     def not_found(self, e: DoesNotExistError) -> dict[str, Any]:
         name = self.name.singular.capitalize()
@@ -110,21 +51,19 @@ 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=e.message,
-        )
-
-    def created_one(self, item: Any) -> dict[str, Any]:
-        return self._response(201, item)
+    def _response(self, code: int, data: Any, error: str = "") -> dict[str, Any]:
+        content: dict[str, Any] = {"code": code, "status": "success"}
 
-    def created_many(self, items: Iterable[Any]) -> dict[str, Any]:
-        return self._response(201, list(items))
+        if error:
+            content["status"] = "fail"
+            content["error"] = {"message": error}
 
-    def found_one(self, item: Any) -> dict[str, Any]:
-        return self._response(200, item)
+        match data:
+            case None:
+                content["data"] = {}
+            case list():
+                content["data"] = {self.name.plural: data, "count": len(data)}
+            case _:
+                content["data"] = {self.name.singular: data}
 
-    def found_many(self, items: list[Any]) -> dict[str, Any]:
-        return self._response(200, items)
+        return content

{apexdevkit-1.6.5 → apexdevkit-1.7.1}/apexdevkit/fastapi/router.py

@@ -7,6 +7,7 @@ from fastapi.responses import JSONResponse
 
 from apexdevkit.fastapi.builder import RestfulServiceBuilder
 from apexdevkit.fastapi.resource import RestfulResource
+from apexdevkit.fastapi.response import RestfulResponse
 from apexdevkit.fastapi.schema import RestfulSchema, SchemaFields
 from apexdevkit.fastapi.service import RawCollection, RawItem, RestfulService
 from apexdevkit.testing import RestfulName
@@ -16,7 +17,7 @@ _Response = JSONResponse | dict[str, Any]
 T = TypeVar("T")
 
 
-class Dependable(Protocol):
+class Dependency(Protocol):  # pragma: no cover
     def as_dependable(self) -> type[RestfulService]:
         pass
 
@@ -42,7 +43,7 @@ class RestfulRouter:
 
     @property
     def resource(self) -> RestfulResource:
-        return RestfulResource(self.name)
+        return RestfulResource(RestfulResponse(self.name))
 
     @property
     def id_alias(self) -> str:
@@ -64,13 +65,13 @@ class RestfulRouter:
 
     def with_create_one_endpoint(
         self,
-        dependable: Dependable,
+        dependency: Dependency,
         is_documented: bool = True,
     ) -> Self:
         self.router.add_api_route(
             "",
             self.resource.create_one(
-                Service=dependable.as_dependable(),
+                Service=dependency.as_dependable(),
                 Item=Annotated[
                     RawItem,
                     Depends(self.schema.for_create_one()),
@@ -87,12 +88,14 @@ class RestfulRouter:
         return self
 
     def with_create_many_endpoint(
-        self, dependable: Dependable, is_documented: bool = True
+        self,
+        dependency: Dependency,
+        is_documented: bool = True,
     ) -> Self:
         self.router.add_api_route(
             "/batch",
             self.resource.create_many(
-                Service=dependable.as_dependable(),
+                Service=dependency.as_dependable(),
                 Collection=Annotated[
                     RawCollection,
                     Depends(self.schema.for_create_many()),
@@ -109,12 +112,14 @@ class RestfulRouter:
         return self
 
     def with_read_one_endpoint(
-        self, dependable: Dependable, is_documented: bool = True
+        self,
+        dependency: Dependency,
+        is_documented: bool = True,
     ) -> Self:
         self.router.add_api_route(
             self.item_path,
             self.resource.read_one(
-                Service=dependable.as_dependable(),
+                Service=dependency.as_dependable(),
                 ItemId=Annotated[
                     str,
                     Path(alias=self.id_alias),
@@ -131,12 +136,14 @@ class RestfulRouter:
         return self
 
     def with_read_all_endpoint(
-        self, dependable: Dependable, is_documented: bool = True
+        self,
+        dependency: Dependency,
+        is_documented: bool = True,
     ) -> Self:
         self.router.add_api_route(
             "",
             self.resource.read_all(
-                Service=dependable.as_dependable(),
+                Service=dependency.as_dependable(),
             ),
             methods=["GET"],
             status_code=200,
@@ -149,12 +156,14 @@ class RestfulRouter:
         return self
 
     def with_update_one_endpoint(
-        self, dependable: Dependable, is_documented: bool = True
+        self,
+        dependency: Dependency,
+        is_documented: bool = True,
     ) -> Self:
         self.router.add_api_route(
             self.item_path,
             self.resource.update_one(
-                Service=dependable.as_dependable(),
+                Service=dependency.as_dependable(),
                 ItemId=Annotated[
                     str,
                     Path(alias=self.id_alias),
@@ -175,12 +184,14 @@ class RestfulRouter:
         return self
 
     def with_update_many_endpoint(
-        self, dependable: Dependable, is_documented: bool = True
+        self,
+        dependency: Dependency,
+        is_documented: bool = True,
     ) -> Self:
         self.router.add_api_route(
             "",
             self.resource.update_many(
-                Service=dependable.as_dependable(),
+                Service=dependency.as_dependable(),
                 Collection=Annotated[
                     RawCollection,
                     Depends(self.schema.for_update_many()),
@@ -197,12 +208,14 @@ class RestfulRouter:
         return self
 
     def with_replace_one_endpoint(
-        self, dependable: Dependable, is_documented: bool = True
+        self,
+        dependency: Dependency,
+        is_documented: bool = True,
     ) -> Self:
         self.router.add_api_route(
             "",
             self.resource.replace_one(
-                Service=dependable.as_dependable(),
+                Service=dependency.as_dependable(),
                 Item=Annotated[
                     RawItem,
                     Depends(self.schema.for_replace_one()),
@@ -219,12 +232,14 @@ class RestfulRouter:
         return self
 
     def with_replace_many_endpoint(
-        self, dependable: Dependable, is_documented: bool = True
+        self,
+        dependency: Dependency,
+        is_documented: bool = True,
     ) -> Self:
         self.router.add_api_route(
             "/batch",
             self.resource.replace_many(
-                Service=dependable.as_dependable(),
+                Service=dependency.as_dependable(),
                 Collection=Annotated[
                     RawCollection,
                     Depends(self.schema.for_replace_many()),
@@ -241,12 +256,14 @@ class RestfulRouter:
         return self
 
     def with_delete_one_endpoint(
-        self, dependable: Dependable, is_documented: bool = True
+        self,
+        dependency: Dependency,
+        is_documented: bool = True,
     ) -> Self:
         self.router.add_api_route(
             self.item_path,
             self.resource.delete_one(
-                Service=dependable.as_dependable(),
+                Service=dependency.as_dependable(),
                 ItemId=Annotated[
                     str,
                     Path(alias=self.id_alias),
@@ -269,15 +286,15 @@ class RestfulRouter:
 
         return self
 
-    def default(self, dependable: Dependable) -> Self:
+    def default(self, dependency: Dependency) -> Self:
         return (
-            self.with_create_one_endpoint(dependable)
-            .with_create_many_endpoint(dependable)
-            .with_read_one_endpoint(dependable)
-            .with_read_all_endpoint(dependable)
-            .with_update_one_endpoint(dependable)
-            .with_update_many_endpoint(dependable)
-            .with_delete_one_endpoint(dependable)
+            self.with_create_one_endpoint(dependency)
+            .with_create_many_endpoint(dependency)
+            .with_read_one_endpoint(dependency)
+            .with_read_all_endpoint(dependency)
+            .with_update_one_endpoint(dependency)
+            .with_update_many_endpoint(dependency)
+            .with_delete_one_endpoint(dependency)
         )
 
     def build(self) -> APIRouter:

{apexdevkit-1.6.5 → apexdevkit-1.7.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "apexdevkit"
-version = "1.6.5"
+version = "1.7.1"
 description = "Apex Development Tools for python."
 authors = ["Apex Dev <dev@apex.ge>"]
 readme = "README.md"
@@ -25,7 +25,10 @@ ruff = "*"
 python_version = "3.11"
 ignore_missing_imports = true
 strict = true
-exclude = ["apexdevkit/fastapi/schema.py", "apexdevkit/fastapi/dependable.py"]
+exclude = [
+    "apexdevkit/fastapi/schema.py",
+    "apexdevkit/fastapi/dependable.py",
+]
 
 [tool.ruff]
 target-version = "py311"