wip: update Officer models

Author: jbriones1

src/officers/constants.py

@@ -1,6 +1,8 @@
 from enum import StrEnum
 
-OFFICER_POSITION_MAX_LENGTH = 128
+# OFFICER FIELD CONSTRAINTS
+OFFICER_POSITION_MAX = 128
+OFFICER_LEGAL_NAME_MAX = 128
 
 class OfficerPositionEnum(StrEnum):
     PRESIDENT = "president"

src/officers/models.py

@@ -1,18 +1,18 @@
-from datetime import datetime
+from datetime import date
 
-from pydantic import BaseModel
+from pydantic import BaseModel, Field
 
-from officers.constants import OfficerPositionEnum
+from officers.constants import OFFICER_LEGAL_NAME_MAX, OfficerPositionEnum
 
 
-class BaseOfficerModel(BaseModel):
+class OfficerBaseModel(BaseModel):
     # TODO (#71): compute this using SFU's API & remove from being uploaded
-    legal_name: str
+    legal_name: str = Field(..., max_length=OFFICER_LEGAL_NAME_MAX)
     position: OfficerPositionEnum
-    start_date: datetime
-    end_date: str | None = None
+    start_date: date
+    end_date: date | None = None
 
-class PublicOfficerResponse(BaseOfficerModel):
+class PublicOfficerResponse(OfficerBaseModel):
     """
     Response when fetching public officer data
     """
@@ -33,17 +33,17 @@ class PrivateOfficerResponse(PublicOfficerResponse):
     github_username: str | None = None
     google_drive_email: str | None = None
 
-class OfficerTermCreate(BaseOfficerModel):
-    """
-    Create a new Officer term
-    """
+class OfficerTermBaseModel(BaseModel):
     computing_id: str
-
-class OfficerTermUpdate(BaseModel):
-    """
-    Update an Officer Term
-    """
-    legal_name: str | None = None
-    position: OfficerPositionEnum | None = None
-    start_date: datetime | None = None
-    end_date: datetime | None = None
+    position: OfficerPositionEnum
+    start_date: date
+
+class OfficerTermResponse(OfficerTermBaseModel):
+    id: int
+    end_date: date | None = None
+    favourite_course_0: str | None = None
+    favourite_course_1: str | None = None
+    favourite_pl_0: str | None = None
+    favourite_pl_1: str | None = None
+    biography: str | None = None
+    photo_url: str | None = None

src/officers/tables.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from datetime import datetime
+from datetime import date, datetime
 
 from sqlalchemy import (
     Date,
@@ -20,7 +20,7 @@
     GITHUB_USERNAME_LEN,
 )
 from database import Base
-from officers.constants import OFFICER_POSITION_MAX_LENGTH, OfficerPositionEnum
+from officers.constants import OFFICER_LEGAL_NAME_MAX, OFFICER_POSITION_MAX, OfficerPositionEnum
 
 
 # A row represents an assignment of a person to a position.
@@ -36,10 +36,10 @@ class OfficerTerm(Base):
         nullable=False,
     )
 
-    position: Mapped[OfficerPositionEnum] = mapped_column(String(OFFICER_POSITION_MAX_LENGTH), nullable=False)
-    start_date: Mapped[datetime] = mapped_column(Date, nullable=False)
+    position: Mapped[OfficerPositionEnum] = mapped_column(String(OFFICER_POSITION_MAX), nullable=False)
+    start_date: Mapped[date] = mapped_column(Date, nullable=False)
     # end_date is only not-specified for positions that don't have a length (ie. webmaster)
-    end_date: Mapped[datetime] = mapped_column(Date, nullable=True)
+    end_date: Mapped[date] = mapped_column(Date, nullable=True)
 
     nickname: Mapped[str] = mapped_column(String(128), nullable=True)
     favourite_course_0: Mapped[str] = mapped_column(String(64), nullable=True)
@@ -113,7 +113,7 @@ class OfficerInfo(Base):
     )
 
     # TODO (#71): we'll need to use SFU's API to get the legal name for users
-    legal_name: Mapped[str] = mapped_column(String(128), nullable=False) # some people have long names, you never know
+    legal_name: Mapped[str] = mapped_column(String(OFFICER_LEGAL_NAME_MAX), nullable=False) # some people have long names, you never know
     phone_number: Mapped[str] = mapped_column(String(24), nullable=True)
 
     # TODO (#99): add unique constraints to discord_id (stops users from stealing the username of someone else)

src/officers/urls.py

@@ -5,7 +5,7 @@
 import database
 import officers.crud
 import utils
-from officers.models import PrivateOfficerResponse, PublicOfficerResponse
+from officers.models import OfficerTermResponse, PrivateOfficerResponse, PublicOfficerResponse
 from officers.tables import OfficerInfo, OfficerTerm
 from officers.types import InitialOfficerInfo, OfficerInfoUpload, OfficerTermUpload
 from permission.types import OfficerPrivateInfo, WebsiteAdmin
@@ -82,23 +82,22 @@ async def all_officers(
             raise HTTPException(status_code=401, detail="only website admins can view all executive terms that have not started yet")
 
     all_officers = await officers.crud.all_officers(db_session, has_private_access, include_future_terms)
-    if has_private_access:
-        return JSONResponse([
-            PrivateOfficerResponse.model_validate(officer_data)
-            for officer_data in all_officers
-        ])
-    else:
-        return JSONResponse([
-            PublicOfficerResponse.model_validate(officer_data)
-            for officer_data in all_officers
-        ])
+    return JSONResponse([
+        officer_data.serializable_dict()
+        for officer_data in all_officers
+    ])
 
 @router.get(
     "/terms/{computing_id}",
     description="""
         Get term info for an executive. All term info is public for all past or active terms.
         Future terms can only be accessed by website admins.
     """,
+    response_model=list[OfficerTermResponse],
+    responses={
+        401: { "description": "not authorized to view private info", "model": DetailModel }
+    },
+    operation_id="get_all_officers"
 )
 async def get_officer_terms(
     request: Request,
@@ -118,7 +117,7 @@ async def get_officer_terms(
         include_future_terms
     )
     return JSONResponse([
-        term.serializable_dict() for term in officer_terms
+        OfficerTermResponse.model_validate(term) for term in officer_terms
     ])
 
 @router.get(