feat: add student_sheet API #7

Author: kathmandu777

fastapi/app/api/v1/__init__.py

@@ -1,2 +1,3 @@
 from .auth import AuthAPI
+from .student_sheet import StudentSheetAPI
 from .user import UserAPI

fastapi/app/api/v1/student_sheet.py

@@ -0,0 +1,58 @@
+from typing import List, Optional
+from uuid import UUID
+
+from app.core.exceptions import (
+    ApiException,
+    NotFoundObjectMatchingUuid,
+    PermissionDenied,
+)
+from app.crud import StudentSheetCRUD
+from app.models import StudentSheet
+from app.schemas import UpdateStudentSheetSchema
+
+from fastapi import Request
+
+
+class StudentSheetAPI:
+    @classmethod
+    def gets(cls, request: Request) -> List[StudentSheet]:
+        return StudentSheetCRUD(request.state.db_session).gets_by_user_uuid(
+            request.user.uuid
+        )
+
+    @classmethod
+    def get(cls, request: Request, uuid: UUID) -> Optional[StudentSheet]:
+        obj = StudentSheetCRUD(request.state.db_session).get_by_uuid(uuid)
+        if obj is None:
+            raise ApiException(NotFoundObjectMatchingUuid(StudentSheet, uuid))
+        if obj.user_uuid != request.user.uuid:
+            raise ApiException(PermissionDenied())
+        return obj
+
+    @classmethod
+    def create(cls, request: Request, schema: UpdateStudentSheetSchema) -> StudentSheet:
+        data = schema.dict()
+        data["user_uuid"] = request.user.uuid
+        return StudentSheetCRUD(request.state.db_session).create(data)
+
+    @classmethod
+    def update(
+        cls, request: Request, uuid: UUID, schema: UpdateStudentSheetSchema
+    ) -> StudentSheet:
+        obj = StudentSheetCRUD(request.state.db_session).get_by_uuid(uuid)
+        if not obj:
+            raise ApiException(NotFoundObjectMatchingUuid(StudentSheet, uuid))
+        if obj.user_uuid != request.user.uuid:
+            raise ApiException(PermissionDenied)
+        data = schema.dict()
+        data["user_uuid"] = request.user.uuid
+        return StudentSheetCRUD(request.state.db_session).update(uuid, data)
+
+    @classmethod
+    def delete(cls, request: Request, uuid: UUID) -> None:
+        obj = StudentSheetCRUD(request.state.db_session).get_by_uuid(uuid)
+        if not obj:
+            raise ApiException(NotFoundObjectMatchingUuid(StudentSheet, uuid))
+        if obj.user_uuid != request.user.uuid:
+            raise ApiException(PermissionDenied)
+        return StudentSheetCRUD(request.state.db_session).delete_by_uuid(uuid)

fastapi/app/crud/__init__.py

@@ -1 +1,2 @@
+from .student_sheet import StudentSheetCRUD
 from .user import UserCRUD

fastapi/app/crud/student_sheet.py

@@ -0,0 +1,43 @@
+from typing import List, Optional
+from uuid import UUID
+
+from app.core.exceptions import ApiException, NotFoundObjectMatchingUuid, create_error
+from app.db.database import get_db_session
+from app.models import StudentSheet
+from sqlalchemy.orm import scoped_session
+
+from .base import BaseCRUD
+
+db_session = get_db_session()
+
+
+class StudentSheetCRUD(BaseCRUD):
+    def __init__(self, db_session: scoped_session):
+        super().__init__(db_session, StudentSheet)
+
+    def gets_by_user_uuid(self, user_uuid: str) -> List[StudentSheet]:
+        return self.get_query().filter_by(user_uuid=user_uuid).all()
+
+    def get_by_user_uuid_and_name(
+        self, user_uuid: str, name: str
+    ) -> Optional[StudentSheet]:
+        return self.get_query().filter_by(user_uuid=user_uuid, name=name).first()
+
+    def create(self, data: dict = {}) -> StudentSheet:
+        if self.get_by_user_uuid_and_name(data["user_uuid"], data["name"]) is not None:
+            raise ApiException(
+                create_error(f"StudentSheet with name {data['name']} already exists")
+            )
+        return super().create(data)
+
+    def update(self, uuid: UUID, data: dict = {}) -> StudentSheet:
+        update_obj = self.get_by_uuid(uuid)
+        if update_obj is None:
+            raise ApiException(NotFoundObjectMatchingUuid(self.model, uuid))
+
+        new_data_obj = self.get_by_user_uuid_and_name(data["user_uuid"], data["name"])
+        if new_data_obj is not None and new_data_obj.uuid != update_obj.uuid:
+            raise ApiException(
+                create_error(f"StudentSheet with name {data['name']} already exists")
+            )
+        return super().update(uuid, data)

fastapi/app/db/migrations/versions/20220103_175531_student_sheet.py

@@ -0,0 +1,50 @@
+"""student_sheet
+
+Revision ID: 8bf6f6f70d43
+Revises: c2dc0f9395d6
+Create Date: 2022-01-03 17:55:31.902638+09:00
+
+"""
+import sqlalchemy as sa
+from alembic import op
+from sqlalchemy.dialects import postgresql
+
+# revision identifiers, used by Alembic.
+revision = "8bf6f6f70d43"
+down_revision = "c2dc0f9395d6"
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.create_table(
+        "student_sheets",
+        sa.Column("uuid", postgresql.UUID(as_uuid=True), nullable=False),
+        sa.Column(
+            "created_at",
+            postgresql.TIMESTAMP(timezone=True),
+            server_default=sa.text("CURRENT_TIMESTAMP"),
+            nullable=False,
+            comment="登録日時",
+        ),
+        sa.Column(
+            "updated_at",
+            postgresql.TIMESTAMP(timezone=True),
+            nullable=True,
+            comment="最終更新日時",
+        ),
+        sa.Column("is_active", sa.BOOLEAN(), server_default="true", nullable=False),
+        sa.Column("name", sa.VARCHAR(length=100), nullable=False),
+        sa.Column("user_uuid", postgresql.UUID(as_uuid=True), nullable=False),
+        sa.ForeignKeyConstraint(["user_uuid"], ["users.uuid"], ondelete="CASCADE"),
+        sa.PrimaryKeyConstraint("uuid"),
+        sa.UniqueConstraint("name", "user_uuid"),
+    )
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_table("student_sheets")
+    # ### end Alembic commands ###

fastapi/app/models/__init__.py

@@ -1 +1,2 @@
+from .student_sheet import StudentSheet
 from .user import User

fastapi/app/models/student_sheet.py

@@ -0,0 +1,19 @@
+from sqlalchemy import Column, ForeignKey, VARCHAR
+from sqlalchemy.dialects.postgresql import UUID
+from sqlalchemy.schema import UniqueConstraint
+
+from .base import BaseModelMixin
+
+
+class StudentSheet(BaseModelMixin):
+    __tablename__ = "student_sheets"
+    __table_args__ = UniqueConstraint("name", "user_uuid"), {}
+
+    MAX_LENGTH_NAME = 100
+    name = Column(VARCHAR(MAX_LENGTH_NAME), nullable=False)
+
+    user_uuid = Column(
+        UUID(as_uuid=True),
+        ForeignKey("users.uuid", ondelete="CASCADE"),
+        nullable=False,
+    )

fastapi/app/models/user.py

@@ -1,4 +1,5 @@
 from sqlalchemy import BOOLEAN, VARCHAR, Column, String
+from sqlalchemy.orm import relationship
 
 from .base import BaseModelMixin
 
@@ -14,3 +15,5 @@ class User(BaseModelMixin):
     firebase_uid = Column(VARCHAR(MAX_LENGTH_FIREBASE_UID), unique=True, nullable=True)
 
     is_admin = Column(BOOLEAN, nullable=False, default=False)
+
+    student_sheets = relationship("StudentSheet", backref="user", cascade="all")

fastapi/app/routers/v1/__init__.py

@@ -1,8 +1,12 @@
 from fastapi import APIRouter
 
 from .auth import auth_router
+from .studnet_sheet import student_sheet_router
 from .user import user_router
 
 api_v1_router = APIRouter()
 api_v1_router.include_router(user_router, prefix="/users", tags=["users"])
 api_v1_router.include_router(auth_router, prefix="/auth", tags=["auth"])
+api_v1_router.include_router(
+    student_sheet_router, prefix="/student-sheets", tags=["student sheets"]
+)

fastapi/app/routers/v1/studnet_sheet.py

@@ -0,0 +1,58 @@
+from typing import List, Optional
+from uuid import UUID
+
+from app.api.v1 import StudentSheetAPI
+from app.dependencies.auth import login_required
+from app.models import StudentSheet
+from app.schemas import (
+    CreateStudentSheetSchema,
+    ReadStudentSheetSchema,
+    UpdateStudentSheetSchema,
+)
+
+from fastapi import APIRouter, Depends, Request
+
+student_sheet_router = APIRouter()
+
+
+@student_sheet_router.get(
+    "/",
+    response_model=List[ReadStudentSheetSchema],
+    dependencies=[Depends(login_required)],
+)
+async def gets(request: Request) -> List[StudentSheet]:
+    return StudentSheetAPI.gets(request)
+
+
+@student_sheet_router.get(
+    "/{uuid}",
+    response_model=ReadStudentSheetSchema,
+    dependencies=[Depends(login_required)],
+)
+async def get(request: Request, uuid: UUID) -> Optional[StudentSheet]:
+    return StudentSheetAPI.get(request, uuid)
+
+
+@student_sheet_router.post(
+    "/", response_model=ReadStudentSheetSchema, dependencies=[Depends(login_required)]
+)
+async def create(request: Request, schema: CreateStudentSheetSchema) -> StudentSheet:
+    return StudentSheetAPI.create(request, schema)
+
+
+@student_sheet_router.put(
+    "/{uuid}",
+    response_model=ReadStudentSheetSchema,
+    dependencies=[Depends(login_required)],
+)
+async def update(
+    request: Request,
+    uuid: UUID,
+    schema: UpdateStudentSheetSchema,
+) -> StudentSheet:
+    return StudentSheetAPI.update(request, uuid, schema)
+
+
+@student_sheet_router.delete("/{uuid}", dependencies=[Depends(login_required)])
+async def delete(request: Request, uuid: UUID) -> None:
+    return StudentSheetAPI.delete(request, uuid)