feat(#5): endpoints now return more semantic responses when errors occur

Author: ArielMAJ

api/database/models/model_base.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from datetime import datetime
-from typing import Any, List
+from typing import Any, List, Union
 
 from fastapi_async_sqlalchemy import db
 from sqlalchemy import DateTime, MetaData, select
@@ -30,6 +30,8 @@ class ModelBase(DeclarativeBase):
     async def new(cls, **kwargs) -> Self:
         obj: Self = cls(**kwargs)
         await obj.save()
+        await db.session.flush()
+        await db.session.refresh(obj)
         return obj
 
     @classmethod
@@ -55,7 +57,7 @@ async def get(
         return result.scalars().first()
 
     @classmethod
-    async def get_by_id(cls, id: int) -> Self:
+    async def get_by_id(cls, id: int) -> Union[Self, None]:
         return await cls.get(cls.id == id)
 
     async def save(self) -> None:
@@ -66,15 +68,5 @@ async def update(self, **kwargs):
             setattr(self, attr, value)
         await self.save()
 
-    @classmethod
-    async def update_by_id(cls, id: int, **kwargs):
-        obj = await cls.get_by_id(id)
-        await obj.update(**kwargs)
-
     async def delete(self):
         await db.session.delete(self)
-
-    @classmethod
-    async def delete_by_id(cls, id: int):
-        obj = await cls.get_by_id(id)
-        await obj.delete()

api/entrypoints/user.py

@@ -1,25 +1,25 @@
 from typing import List
 
-from api.schemas.user import UserCreate
+from api.schemas.user import UserCreate, UserOut
 from api.services.user_service import UserService
 from fastapi import APIRouter
 
 router = APIRouter()
 
 
-@router.get("/", response_model=List[UserCreate])
-async def get_users() -> List[UserCreate]:
+@router.get("/", response_model=List[UserOut])
+async def get_users() -> List[UserOut]:
     """
     Retrieve a list of all users.
 
     Returns:
         List[User]: A list of User objects.
     """
-    return await UserService.get_all()
+    return await UserService().get_all()
 
 
-@router.get("/{user_id}", response_model=UserCreate)
-async def get_user(user_id: int):
+@router.get("/{user_id}", response_model=UserOut)
+async def get_user(user_id: int) -> UserOut:
     """
     Retrieve a user by ID.
 
@@ -29,10 +29,10 @@ async def get_user(user_id: int):
     Returns:
         User: The User object.
     """
-    return await UserService.get_user(user_id)
+    return await UserService().get_user(user_id)
 
 
-@router.post("/", response_model=UserCreate)
+@router.post("/", response_model=UserOut)
 async def create_user(user: UserCreate):
     """
     Create a new user.
@@ -43,11 +43,11 @@ async def create_user(user: UserCreate):
     Returns:
         User: The created User object.
     """
-    return await UserService.create_user(user)
+    return await UserService().create_user(user)
 
 
 @router.put("/{user_id}", response_model=None)
-async def update_user(user_id: int, user: UserCreate):
+async def update_user(user_id: int, user: UserCreate) -> None:
     """
     Update a user by ID.
 
@@ -58,15 +58,15 @@ async def update_user(user_id: int, user: UserCreate):
     Returns:
         User: The updated User object.
     """
-    return await UserService.update_user(user_id, user)
+    return await UserService().update_user(user_id, user)
 
 
-@router.delete("/{user_id}")
-async def delete_user(user_id: int):
+@router.delete("/{user_id}", response_model=None)
+async def delete_user(user_id: int) -> None:
     """
     Delete a user by ID.
 
     Args:
         user_id (int): The ID of the user.
     """
-    return await UserService.delete_user(user_id)
+    return await UserService().delete_user(user_id)

api/exceptions/http_exceptions.py

@@ -0,0 +1,10 @@
+from api.database.models.model_base import ModelBase
+from fastapi import HTTPException, status
+
+
+class NotFoundException(HTTPException):
+    def __init__(self, model: ModelBase):
+        super().__init__(
+            status_code=status.HTTP_404_NOT_FOUND,
+            detail=f"{model.__name__} not found",
+        )

api/schemas/base_db_schema.py

@@ -0,0 +1,20 @@
+from datetime import datetime
+from typing import Optional
+
+from pydantic import BaseModel, field_serializer
+
+
+class BaseDBSchema(BaseModel):
+    id: int
+    created_at: datetime
+    updated_at: datetime
+    deleted_at: Optional[datetime]
+
+    class Config:
+        orm_mode = True
+
+    @field_serializer("created_at", "updated_at", "deleted_at")
+    def serialize_dt(self, dt: Optional[datetime]):
+        if not dt:
+            return dt
+        return dt.strftime("%d-%m-%Y %H:%M:%S")

api/schemas/user.py

@@ -1,7 +1,13 @@
+from api.schemas.base_db_schema import BaseDBSchema
 from pydantic import BaseModel
 
 
 class UserCreate(BaseModel):
     name: str
     email: str
     password: str
+
+
+class UserOut(BaseDBSchema):
+    name: str
+    email: str

api/services/user_service.py

@@ -1,13 +1,13 @@
-from typing import List
+from typing import List, Union
 
 from api.database.models.users import User
+from api.exceptions.http_exceptions import NotFoundException
 from api.schemas.user import UserCreate
 from loguru import logger
 
 
 class UserService:
-    @staticmethod
-    async def get_all() -> List[UserCreate]:
+    async def get_all(self) -> List[User]:
         """
         Retrieve a list of all users.
 
@@ -16,8 +16,7 @@ async def get_all() -> List[UserCreate]:
         """
         return await User.get_all()
 
-    @staticmethod
-    async def get_user(user_id: int):
+    async def get_user(self, user_id: int) -> User:
         """
         Retrieve a user by ID.
 
@@ -27,10 +26,12 @@ async def get_user(user_id: int):
         Returns:
             User: The User object.
         """
-        return await User.get_by_id(user_id)
+        user: Union[User, None] = await User.get_by_id(user_id)
+        if not user:
+            raise NotFoundException(User)
+        return user
 
-    @staticmethod
-    async def create_user(user: UserCreate):
+    async def create_user(self, user: UserCreate) -> User:
         """
         Create a new user.
 
@@ -43,8 +44,7 @@ async def create_user(user: UserCreate):
         logger.info(user.model_dump())
         return await User.new(**user.model_dump())
 
-    @staticmethod
-    async def update_user(user_id: int, user: UserCreate):
+    async def update_user(self, user_id: int, updated_user: UserCreate):
         """
         Update a user by ID.
 
@@ -55,15 +55,17 @@ async def update_user(user_id: int, user: UserCreate):
         Returns:
             User: The updated User object.
         """
-        return await User.update_by_id(user_id, **user.model_dump())
+        user: User = await self.get_user(user_id)
+        return await user.update(**updated_user.model_dump())
 
-    @staticmethod
-    async def delete_user(user_id: int):
+    async def delete_user(self, user_id: int):
         """
         Delete a user by ID.
 
         Args:
             user_id (int): The ID of the user.
         """
-        await User.delete_by_id(user_id)
+
+        user: User = await self.get_user(user_id)
+        await user.delete()
         return {"message": "User deleted successfully"}