Choose custom auth user

Author: mslaursen

fastapi_forge/dtos.py

@@ -313,6 +313,10 @@ def _validate_models(self) -> Self:
             msg = "Cannot use built-in auth if PostgreSQL is not enabled."
             raise ValueError(msg)
 
+        if self.use_builtin_auth and self.get_auth_model() is None:
+            msg = "Cannot use built-in auth if no auth model is defined."
+            raise ValueError(msg)
+
         for model in self.models:
             for relationship in model.relationships:
                 if relationship.target_model not in model_names_set:
@@ -364,3 +368,11 @@ def has_cycle(node):
                 )
 
         return self
+
+    def get_auth_model(self) -> Model | None:
+        if not self.use_builtin_auth:
+            return None
+        for model in self.models:
+            if model.metadata.is_auth_model:
+                return model
+        return None

fastapi_forge/forge.py

@@ -37,17 +37,26 @@ async def build_project(spec: ProjectSpec) -> None:
 
         template_path = str(_get_template_path())
 
+        extra_context = {
+            **spec.model_dump(exclude={"models"}),
+            "models": {
+                "models": [model.model_dump() for model in spec.models],
+            },
+        }
+
+        if spec.use_builtin_auth:
+            auth_user = spec.get_auth_model()
+            if auth_user:
+                extra_context["auth_model"] = auth_user.model_dump()
+            else:
+                logger.warning("No AuthUser model found in the project spec.")
+
         cookiecutter(
             template_path,
             output_dir=str(Path.cwd()),
             no_input=True,
             overwrite_if_exists=True,
-            extra_context={
-                **spec.model_dump(exclude={"models"}),
-                "models": {
-                    "models": [model.model_dump() for model in spec.models],
-                },
-            },
+            extra_context=extra_context,
         )
         logger.info(f"Project '{spec.project_name}' created successfully.")
 

fastapi_forge/template/cookiecutter.json

@@ -20,6 +20,7 @@
     "models": {
         "models": []
     },
+    "auth_model": null,
     "_extensions": [
         "local_extensions.camel_to_snake"
     ]

fastapi_forge/template/{{cookiecutter.project_name}}/src/__main__.py

@@ -1,6 +1,7 @@
 from src.settings import settings
 
 
+
 if __name__ == "__main__":
     import uvicorn
 

fastapi_forge/template/{{cookiecutter.project_name}}/src/dependencies/auth_dependencies.py

@@ -1,11 +1,12 @@
-{%- if cookiecutter.use_builtin_auth %}
+from typing import Annotated
+
 from fastapi import Depends, HTTPException, Request
 from fastapi.security import HTTPBearer as _HTTPBearer
-from src.dtos.auth_user_dtos import AuthUserDTO
-from src.daos import GetDAOs
+
 from src import exceptions
+from src.daos import GetDAOs
+from src.dtos.{{ cookiecutter.auth_model.name }}_dtos import {{ cookiecutter.auth_model.name_cc }}DTO
 from src.utils import auth_utils
-from typing import Annotated
 
 
 class HTTPBearer(_HTTPBearer):
@@ -20,7 +21,8 @@ async def __call__(self, request: Request) -> str | None:  # type: ignore
             obj = await super().__call__(request)
             return obj.credentials if obj else None
         except HTTPException:
-            raise exceptions.Http401("Missing token.")
+            msg = "Missing token."
+            raise exceptions.Http401(msg)
 
 
 auth_scheme = HTTPBearer()
@@ -37,17 +39,17 @@ def get_token(token: str = Depends(auth_scheme)) -> str:
 async def get_current_user(
     token: GetToken,
     daos: GetDAOs,
-) -> AuthUserDTO:
+) -> {{ cookiecutter.auth_model.name_cc }}DTO:
     """Get current user from token data."""
     token_data = auth_utils.decode_token(token)
 
-    user = await daos.auth_user.filter_first(id=token_data.user_id)
+    user = await daos.{{ cookiecutter.auth_model.name }}.filter_first(id=token_data.user_id)
 
     if not user:
-        raise exceptions.Http404("Decoded user not found.")
+        msg = "Decoded user not found."
+        raise exceptions.Http404(msg)
 
-    return AuthUserDTO.model_validate(user)
+    return {{ cookiecutter.auth_model.name_cc }}DTO.model_validate(user)
 
 
-GetCurrentUser = Annotated[AuthUserDTO, Depends(get_current_user)]
-{% endif %}
+GetCurrentUser = Annotated[{{ cookiecutter.auth_model.name_cc }}DTO, Depends(get_current_user)]

fastapi_forge/template/{{cookiecutter.project_name}}/src/routes/auth_routes.py

@@ -1,7 +1,7 @@
 {%- if cookiecutter.use_builtin_auth %}
 from fastapi import APIRouter
 from src.dtos.auth_dtos import UserLoginDTO, UserCreateDTO, LoginResponse, TokenData
-from src.dtos.auth_user_dtos import AuthUserDTO, AuthUserInputDTO
+from src.dtos.{{ cookiecutter.auth_model.name }}_dtos import {{ cookiecutter.auth_model.name_cc }}DTO, {{ cookiecutter.auth_model.name_cc }}InputDTO
 from src.dtos import DataResponse, CreatedResponse
 from src.daos import GetDAOs
 from src import exceptions
@@ -19,7 +19,7 @@ async def login(
 ) -> DataResponse[LoginResponse]:
     """Login by email and password."""
 
-    user = await daos.auth_user.filter_first(email=input_dto.email)
+    user = await daos.{{ cookiecutter.auth_model.name }}.filter_first(email=input_dto.email)
 
     if user is None:
         raise exceptions.Http401("Wrong email or password")
@@ -47,13 +47,13 @@ async def register(
 ) -> DataResponse:
     """Register by email and password."""
 
-    user = await daos.auth_user.filter_first(email=input_dto.email)
+    user = await daos.{{ cookiecutter.auth_model.name }}.filter_first(email=input_dto.email)
 
     if user:
         raise exceptions.Http401("User already exists")
 
-    user_id = await daos.auth_user.create(
-        AuthUserInputDTO(
+    user_id = await daos.{{ cookiecutter.auth_model.name }}.create(
+        {{ cookiecutter.auth_model.name_cc }}InputDTO(
             email=input_dto.email,
             password=auth_utils.hash_password(
                 input_dto.password.get_secret_value(),
@@ -72,7 +72,7 @@ async def register(
 @router.get("/users/me", status_code=200)
 async def get_current_user(
     current_user: GetCurrentUser,
-) -> DataResponse[AuthUserDTO]:
+) -> DataResponse[{{ cookiecutter.auth_model.name_cc }}DTO]:
     """Get current user."""
 
     return DataResponse(data=current_user)