feat: preregistration api (#89)

* pre registration api를 구현했습니다.
* pre_registration 테이블이 추가가 안되어있어 마이그레이션 파일을 추가했습니다.

Author: mjy926

wacruit/src/apps/pre_registration/__init__.py

@@ -0,0 +1 @@
+from .views import v3_router as router

wacruit/src/apps/pre_registration/exceptions.py

@@ -0,0 +1,16 @@
+from wacruit.src.apps.common.exceptions import WacruitException
+
+
+class PreRegistNotActiveException(WacruitException):
+    def __init__(self):
+        super().__init__(status_code=404, detail="활성화된 사전 알림이 존재하지 않습니다.")
+
+
+class PreRegistNotExistException(WacruitException):
+    def __init__(self):
+        super().__init__(status_code=404, detail="해당하는 사전 알림이 존재하지 않습니다.")
+
+
+class PreRegistAlreadyExistException(WacruitException):
+    def __init__(self):
+        super().__init__(status_code=409, detail="활성화된 사전 알림이 이미 존재합니다.")

wacruit/src/apps/pre_registration/repositories.py

@@ -0,0 +1,51 @@
+from fastapi import Depends
+from sqlalchemy import delete
+from sqlalchemy import select
+from sqlalchemy import true
+from sqlalchemy.orm import Session
+
+from wacruit.src.apps.pre_registration.models import PreRegistration
+from wacruit.src.database.connection import get_db_session
+from wacruit.src.database.connection import Transaction
+
+
+class PreRegistrationRepository:
+    def __init__(
+        self,
+        session: Session = Depends(get_db_session),
+        transaction: Transaction = Depends(),
+    ) -> None:
+        self.session = session
+        self.transaction = transaction
+
+    def get_pre_registration_by_id(
+        self, pre_registration_id: int
+    ) -> PreRegistration | None:
+        query = select(PreRegistration).where(PreRegistration.id == pre_registration_id)
+        return self.session.execute(query).scalar_one_or_none()
+
+    def get_active_pre_registration(self) -> PreRegistration | None:
+        query = select(PreRegistration).where(PreRegistration.is_active == true())
+        return self.session.execute(query).scalar_one_or_none()
+
+    def get_pre_registration(self) -> list[PreRegistration]:
+        return list(self.session.execute(select(PreRegistration)).scalars())
+
+    def create_pre_registration(
+        self, pre_registration: PreRegistration
+    ) -> PreRegistration:
+        with self.transaction:
+            self.session.add(pre_registration)
+        return pre_registration
+
+    def update_pre_registration(
+        self, pre_registration: PreRegistration
+    ) -> PreRegistration:
+        with self.transaction:
+            self.session.merge(pre_registration)
+        return pre_registration
+
+    def delete_pre_registration(self, pre_registration_id: int) -> None:
+        self.session.execute(
+            delete(PreRegistration).where(PreRegistration.id == pre_registration_id)
+        )

wacruit/src/apps/pre_registration/schemas.py

@@ -0,0 +1,23 @@
+from pydantic import BaseModel
+
+
+class CreatePreRegistrationRequest(BaseModel):
+    url: str
+    generation: str
+    is_active: bool
+
+
+class UpdatePreRegistrationRequest(BaseModel):
+    url: str | None = None
+    generation: str | None = None
+    is_active: bool | None = None
+
+
+class PreRegistrationResponse(BaseModel):
+    id: int
+    url: str
+    generation: str
+    is_active: bool
+
+    class Config:
+        orm_mode = True

wacruit/src/apps/pre_registration/services.py

@@ -0,0 +1,77 @@
+from typing import Annotated
+
+from fastapi import Depends
+
+from wacruit.src.apps.pre_registration.exceptions import PreRegistAlreadyExistException
+from wacruit.src.apps.pre_registration.exceptions import PreRegistNotActiveException
+from wacruit.src.apps.pre_registration.exceptions import PreRegistNotExistException
+from wacruit.src.apps.pre_registration.models import PreRegistration
+from wacruit.src.apps.pre_registration.repositories import PreRegistrationRepository
+from wacruit.src.apps.pre_registration.schemas import CreatePreRegistrationRequest
+from wacruit.src.apps.pre_registration.schemas import UpdatePreRegistrationRequest
+
+
+class PreRegistrationService:
+    def __init__(
+        self,
+        pre_registration_repository: Annotated[PreRegistrationRepository, Depends()],
+    ):
+        self.pre_registration_repository = pre_registration_repository
+
+    def check_active_pre_registration(self) -> bool:
+        pre_registration = (
+            self.pre_registration_repository.get_active_pre_registration()
+        )
+        if pre_registration is None:
+            return False
+        return True
+
+    def get_active_pre_registration(self) -> PreRegistration:
+        pre_registration = (
+            self.pre_registration_repository.get_active_pre_registration()
+        )
+        if pre_registration is None:
+            raise PreRegistNotActiveException
+        return pre_registration
+
+    def get_pre_registration(self) -> list[PreRegistration]:
+        pre_registration_list = self.pre_registration_repository.get_pre_registration()
+        return pre_registration_list
+
+    def create_pre_registration(
+        self, req: CreatePreRegistrationRequest
+    ) -> PreRegistration:
+        if req.is_active and (self.check_active_pre_registration()):
+            raise PreRegistAlreadyExistException
+        to_create = PreRegistration(
+            url=req.url, generation=req.generation, is_active=req.is_active
+        )
+        pre_registration = self.pre_registration_repository.create_pre_registration(
+            to_create
+        )
+        return pre_registration
+
+    def update_pre_registration(
+        self, pre_registration_id: int, req: UpdatePreRegistrationRequest
+    ) -> PreRegistration:
+        pre_registration = self.pre_registration_repository.get_pre_registration_by_id(
+            pre_registration_id
+        )
+        if pre_registration is None:
+            raise PreRegistNotExistException
+        if req.is_active and (self.check_active_pre_registration()):
+            raise PreRegistAlreadyExistException
+
+        for key, value in req.dict(exclude_none=True).items():
+            setattr(pre_registration, key, value)
+        return self.pre_registration_repository.update_pre_registration(
+            pre_registration
+        )
+
+    def delete_pre_registration(self, pre_registration_id: int) -> None:
+        pre_registration = self.pre_registration_repository.get_pre_registration_by_id(
+            pre_registration_id
+        )
+        if pre_registration is None:
+            raise PreRegistNotExistException
+        self.pre_registration_repository.delete_pre_registration(pre_registration_id)

wacruit/src/apps/pre_registration/views.py

@@ -0,0 +1,64 @@
+from http import HTTPStatus
+from typing import Annotated
+
+from fastapi import APIRouter
+from fastapi import Depends
+
+from wacruit.src.apps.common.schemas import ListResponse
+from wacruit.src.apps.pre_registration.models import PreRegistration
+from wacruit.src.apps.pre_registration.schemas import CreatePreRegistrationRequest
+from wacruit.src.apps.pre_registration.schemas import PreRegistrationResponse
+from wacruit.src.apps.pre_registration.schemas import UpdatePreRegistrationRequest
+from wacruit.src.apps.pre_registration.services import PreRegistrationService
+from wacruit.src.apps.user.dependencies import AdminUser
+
+v3_router = APIRouter(prefix="/v3/pre-registration", tags=["preregistration"])
+
+
+@v3_router.get("/active", status_code=HTTPStatus.OK)
+def get_active_pre_registration(
+    pre_registration_service: Annotated[PreRegistrationService, Depends()]
+) -> PreRegistrationResponse:
+    pre_registration = pre_registration_service.get_active_pre_registration()
+    return PreRegistrationResponse.from_orm(pre_registration)
+
+
+@v3_router.get("", status_code=HTTPStatus.OK)
+def get_pre_registration(
+    admin_user: AdminUser,
+    pre_registration_service: Annotated[PreRegistrationService, Depends()],
+) -> ListResponse[PreRegistrationResponse]:
+    pre_registration_list = pre_registration_service.get_pre_registration()
+    return ListResponse(
+        items=[PreRegistrationResponse.from_orm(item) for item in pre_registration_list]
+    )
+
+
+@v3_router.post("", status_code=HTTPStatus.CREATED)
+def create_pre_registration(
+    admin_user: AdminUser,
+    request: CreatePreRegistrationRequest,
+    pre_registration_service: Annotated[PreRegistrationService, Depends()],
+) -> PreRegistrationResponse:
+    res = pre_registration_service.create_pre_registration(request)
+    return PreRegistrationResponse.from_orm(res)
+
+
+@v3_router.patch("/{pre_registration_id}", status_code=HTTPStatus.OK)
+def update_pre_registration(
+    admin_user: AdminUser,
+    request: UpdatePreRegistrationRequest,
+    pre_registration_id: int,
+    pre_registration_service: Annotated[PreRegistrationService, Depends()],
+) -> PreRegistrationResponse:
+    res = pre_registration_service.update_pre_registration(pre_registration_id, request)
+    return PreRegistrationResponse.from_orm(res)
+
+
+@v3_router.delete("/{pre_registration_id}", status_code=HTTPStatus.NO_CONTENT)
+def delete_pre_registration(
+    admin_user: AdminUser,
+    pre_registration_id: int,
+    pre_registration_service: Annotated[PreRegistrationService, Depends()],
+) -> None:
+    pre_registration_service.delete_pre_registration(pre_registration_id)

wacruit/src/apps/router.py

@@ -6,6 +6,7 @@
 from wacruit.src.apps import history
 from wacruit.src.apps import member
 from wacruit.src.apps import portfolio
+from wacruit.src.apps import pre_registration
 from wacruit.src.apps import problem
 from wacruit.src.apps import project
 from wacruit.src.apps import recruiting
@@ -35,3 +36,4 @@
 api_router.include_router(review.router)
 api_router.include_router(faq.router)
 api_router.include_router(timeline.router)
+api_router.include_router(pre_registration.router)

wacruit/src/database/__init__.py

@@ -13,3 +13,4 @@
 import wacruit.src.apps.faq.models  # isort: skip
 import wacruit.src.apps.history.models  # isort: skip
 import wacruit.src.apps.timeline.models  # isort: skip
+import wacruit.src.apps.pre_registration.models  # isort: skip

wacruit/src/database/migrations/versions/2025_07_18_2104-9dd2ff558a82_add_pre_registration_table.py

@@ -0,0 +1,34 @@
+"""add pre_registration table
+
+Revision ID: 9dd2ff558a82
+Revises: c9b5e993e78b
+Create Date: 2025-07-18 21:04:38.078619
+
+"""
+from alembic import op
+import sqlalchemy as sa
+
+# revision identifiers, used by Alembic.
+revision = "9dd2ff558a82"
+down_revision = "c9b5e993e78b"
+branch_labels = None
+depends_on = None
+
+
+def upgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.create_table(
+        "pre_registration",
+        sa.Column("id", sa.Integer(), nullable=False),
+        sa.Column("url", sa.String(length=255), nullable=False),
+        sa.Column("generation", sa.String(length=30), nullable=False),
+        sa.Column("is_active", sa.Boolean(), nullable=False),
+        sa.PrimaryKeyConstraint("id"),
+    )
+    # ### end Alembic commands ###
+
+
+def downgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_table("pre_registration")
+    # ### end Alembic commands ###