Updated endpoints and tests for users, rbac, health, file, and auth
This commit is contained in:
1 parent
207b8eea5e
commit
d379fbd621
26 files changed
+582
-28
No files matched your search
@@ -0,0 +1,4 @@
|
||||
from pwdlib import PasswordHash
|
||||
from pydantic import BaseModel
|
||||
|
||||
|
||||
@@ -0,0 +1,16 @@
|
||||
from sqlalchemy.orm import DeclarativeBase
|
||||
from sqlalchemy import engine
|
||||
|
||||
|
||||
class Base(DeclarativeBase):
|
||||
pass
|
||||
|
||||
|
||||
from sqlalchemy import event
|
||||
|
||||
@event.listens_for(engine.sync_engine, "connect")
|
||||
def _enable_sqlite_fk(dbapi_connection, connection_record):
|
||||
if settings.DATABASE_URL.startswith("sqlite"):
|
||||
cursor = dbapi_connection.cursor()
|
||||
cursor.execute("PRAGMA foreign_keys=ON")
|
||||
cursor.close()
|
||||
@@ -3,6 +3,7 @@
|
||||
from fastapi import APIRouter, FastAPI
|
||||
|
||||
from app.platform.auth import router as auth
|
||||
from app.platform.file import router as files
|
||||
from app.platform.health import router as health
|
||||
from app.platform.rbac import router as rbac
|
||||
from app.platform.users import router as users
|
||||
@@ -14,6 +15,7 @@ v1_router = APIRouter(prefix="/v1")
|
||||
v1_router.include_router(users.router)
|
||||
v1_router.include_router(auth.router)
|
||||
v1_router.include_router(rbac.router)
|
||||
v1_router.include_router(files.router)
|
||||
api_router.include_router(v1_router)
|
||||
app.include_router(api_router)
|
||||
app.include_router(health.router)
|
||||
Whitespace-only changes.
Whitespace-only changes.
@@ -0,0 +1,33 @@
|
||||
"""Application Security."""
|
||||
|
||||
from datetime import UTC, datetime, timedelta
|
||||
|
||||
import jwt
|
||||
from pwdlib import PasswordHash
|
||||
|
||||
SECRET_KEY = "change-me" # generate with: openssl rand -hex 32, load from env
|
||||
ALGORITHM = "HS256"
|
||||
ACCESS_TOKEN_EXPIRE_MINUTES = 30
|
||||
|
||||
password_hash = PasswordHash.recommended()
|
||||
|
||||
|
||||
def hash_password(plain_text: str) -> str:
|
||||
return password_hash.hash(plain_text)
|
||||
|
||||
|
||||
def verify_password(plain_text: str, hashed_text: str) -> bool:
|
||||
return password_hash.verify(plain_text, hashed_text)
|
||||
|
||||
|
||||
def create_access_token(subject: str) -> str:
|
||||
expire = datetime.now(UTC) + timedelta(minutes=ACCESS_TOKEN_EXPIRE_MINUTES)
|
||||
payload = {"sub": subject, "exp": expire}
|
||||
return jwt.encode(
|
||||
payload,
|
||||
SECRET_KEY,
|
||||
)
|
||||
|
||||
|
||||
def decode_access_token(token: str) -> dict:
|
||||
return jwt.decode(token, SECRET_KEY, algorithms=[ALGORITHM])
|
||||
Whitespace-only changes.
@@ -0,0 +1,25 @@
|
||||
"""Endpoints for file upload."""
|
||||
|
||||
from fastapi import APIRouter
|
||||
|
||||
from app.core.common import Message
|
||||
|
||||
router = APIRouter(prefix="/files", tags=["files"])
|
||||
|
||||
|
||||
@router.post(path="/upload")
|
||||
def upload_file() -> Message:
|
||||
"""Upload file endpoint."""
|
||||
return {"status": "healthy"}
|
||||
|
||||
|
||||
@router.post(path="/{file_id}/download")
|
||||
def download_file(file_id: str) -> Message:
|
||||
"""Download file endpoint."""
|
||||
return {"status": file_id}
|
||||
|
||||
|
||||
@router.delete(path="/{file_id}")
|
||||
def delete_file(file_id: str) -> Message:
|
||||
"""Delete file endpoint."""
|
||||
return {"status": file_id}
|
||||
@@ -5,7 +5,13 @@ from app.core.common import Message
|
||||
router = APIRouter(tags=["health"])
|
||||
|
||||
|
||||
@router.get(path="/")
|
||||
@router.get(path="/health")
|
||||
def status_check() -> Message:
|
||||
"""Endpoind to check if server is running."""
|
||||
return {"status": "healthy"}
|
||||
|
||||
|
||||
@router.get(path="/ready")
|
||||
def ready_check() -> Message:
|
||||
"""Endpoind to check if server is ready."""
|
||||
return {"status": "healthy"}
|
||||
@@ -0,0 +1,112 @@
|
||||
from uuid import UUID
|
||||
|
||||
from sqlalchemy import select
|
||||
from sqlalchemy.exc import IntegrityError
|
||||
from sqlalchemy.orm import Session
|
||||
|
||||
from .exceptions import EmailAlreadyExistsError
|
||||
from .models import User
|
||||
from .schema import UserCreate, UserUpdate
|
||||
|
||||
|
||||
def retrieve_user_by_id(session: Session, user_id: UUID) -> User | None:
|
||||
"""Retrieve a user by their unique identifier.
|
||||
|
||||
Args:
|
||||
session (Session): The active database session.
|
||||
user_id (UUID): The unique identifier of the user to retrieve.
|
||||
|
||||
Returns:
|
||||
User | None: The matching user, or ``None`` if no user exists
|
||||
with the given ID.
|
||||
|
||||
"""
|
||||
return session.get(User, user_id)
|
||||
|
||||
|
||||
def list_users(session: Session) -> list[User]:
|
||||
"""Retrieve a list of users.
|
||||
|
||||
Args:
|
||||
session (Session): The active database session.
|
||||
|
||||
Returns:
|
||||
list[User]: The users, ordered by
|
||||
creation time.
|
||||
|
||||
"""
|
||||
stmt = select(User).order_by(User.created_at)
|
||||
return list(session.scalars(stmt).all())
|
||||
|
||||
|
||||
def insert_user(session: Session, new_user: UserCreate) -> User:
|
||||
"""Create and persist a new user.
|
||||
|
||||
Args:
|
||||
session (Session): The active database session.
|
||||
new_user (UserCreate): The data for the user to create.
|
||||
|
||||
Returns:
|
||||
User: The persisted user, including database-generated fields
|
||||
such as ``id`` and ``created_at``.
|
||||
|
||||
Raises:
|
||||
EmailAlreadyExistsError: If a user with the given email already
|
||||
exists.
|
||||
|
||||
"""
|
||||
user = User(**new_user.model_dump())
|
||||
session.add(user)
|
||||
try:
|
||||
session.commit()
|
||||
except IntegrityError as exc:
|
||||
session.rollback()
|
||||
raise EmailAlreadyExistsError(new_user.email) from exc
|
||||
session.refresh(user)
|
||||
return user
|
||||
|
||||
|
||||
def update_user(session: Session, user: User, user_update: UserUpdate) -> User:
|
||||
"""Apply a partial update to an existing user.
|
||||
|
||||
Only fields explicitly set on ``user_update`` are modified; all other
|
||||
fields retain their current values.
|
||||
|
||||
Args:
|
||||
session (Session): The active database session.
|
||||
user (User): The user to update.
|
||||
user_update (UserUpdate): The fields to change and their new values.
|
||||
|
||||
Returns:
|
||||
User: The updated user, refreshed from the database.
|
||||
|
||||
Raises:
|
||||
EmailAlreadyExistsError: If the update changes the email to one
|
||||
already registered to another user.
|
||||
|
||||
"""
|
||||
update_values = user_update.model_dump(exclude_unset=True)
|
||||
for field, value in update_values.items():
|
||||
setattr(user, field, value)
|
||||
try:
|
||||
session.commit()
|
||||
except IntegrityError as exc:
|
||||
session.rollback()
|
||||
raise EmailAlreadyExistsError(update_values.get("email")) from exc
|
||||
session.refresh(user)
|
||||
return user
|
||||
|
||||
|
||||
def delete_user(session: Session, user: User) -> None:
|
||||
"""Permanently delete a user.
|
||||
|
||||
The user's associated ``UserAuth`` record is deleted along with it
|
||||
via the relationship's cascade.
|
||||
|
||||
Args:
|
||||
session (Session): The active database session.
|
||||
user (User): The user to delete.
|
||||
|
||||
"""
|
||||
session.delete(user)
|
||||
session.commit()
|
||||
@@ -0,0 +1,6 @@
|
||||
from enum import StrEnum
|
||||
|
||||
|
||||
class UserStatus(StrEnum):
|
||||
ACTIVE = "active"
|
||||
SUSPENDED = "suspended"
|
||||
@@ -0,0 +1 @@
|
||||
class EmailAlreadyExistsError(Exception): ...
|
||||
@@ -1,21 +1,65 @@
|
||||
"""Database user model."""
|
||||
# app/platform/users/models.py
|
||||
"""User and UserAuth ORM models."""
|
||||
|
||||
import uuid
|
||||
from datetime import datetime
|
||||
|
||||
from sqlalchemy import Column, String
|
||||
from sqlalchemy.orm import DeclarativeBase
|
||||
from sqlalchemy import Boolean, DateTime, ForeignKey, String, func
|
||||
from sqlalchemy import Enum as SAEnum
|
||||
from sqlalchemy.orm import Mapped, mapped_column, relationship
|
||||
|
||||
from app.core.database import Base
|
||||
from app.platform.users.enums import UserStatus
|
||||
|
||||
|
||||
class Base(DeclarativeBase):
|
||||
"""Base Class for all db models."""
|
||||
class User(Base):
|
||||
__tablename__ = "users"
|
||||
|
||||
pass
|
||||
|
||||
|
||||
class DBUser(Base):
|
||||
"""Database User Model."""
|
||||
|
||||
id = Column(
|
||||
String(36), primary_key=True, default=lambda: str(uuid.uuid4()), index=True
|
||||
id: Mapped[uuid.UUID] = mapped_column(primary_key=True, default=uuid.uuid4)
|
||||
first_name: Mapped[str] = mapped_column(String(100), nullable=False)
|
||||
last_name: Mapped[str] = mapped_column(String(100), nullable=False)
|
||||
email: Mapped[str] = mapped_column(
|
||||
String(255), unique=True, index=True, nullable=False
|
||||
)
|
||||
email = Column(String)
|
||||
|
||||
status: Mapped[UserStatus] = mapped_column(
|
||||
SAEnum(UserStatus, native_enum=False, length=32),
|
||||
default=UserStatus.ACTIVE,
|
||||
nullable=False,
|
||||
)
|
||||
is_superuser: Mapped[bool] = mapped_column(Boolean, default=False, nullable=False)
|
||||
|
||||
created_at: Mapped[datetime] = mapped_column(
|
||||
DateTime(timezone=True), server_default=func.now()
|
||||
)
|
||||
updated_at: Mapped[datetime] = mapped_column(
|
||||
DateTime(timezone=True), server_default=func.now(), onupdate=func.now()
|
||||
)
|
||||
last_login_at: Mapped[datetime | None] = mapped_column(
|
||||
DateTime(timezone=True), nullable=True
|
||||
)
|
||||
|
||||
auth: Mapped["UserAuth"] = relationship(
|
||||
back_populates="user", uselist=False, cascade="all, delete-orphan"
|
||||
)
|
||||
|
||||
|
||||
class UserAuth(Base):
|
||||
__tablename__ = "user_auth"
|
||||
|
||||
# Shared primary key pattern: user_id is both the PK and the FK. This
|
||||
# makes a second UserAuth row for the same user structurally
|
||||
# impossible, rather than something you'd enforce with a separate
|
||||
# unique constraint on a regular FK column.
|
||||
user_id: Mapped[uuid.UUID] = mapped_column(
|
||||
ForeignKey("users.id", ondelete="CASCADE"), primary_key=True
|
||||
)
|
||||
hashed_password: Mapped[str] = mapped_column(String(255), nullable=False)
|
||||
must_change_password: Mapped[bool] = mapped_column(
|
||||
Boolean, default=False, nullable=False
|
||||
)
|
||||
updated_at: Mapped[datetime] = mapped_column(
|
||||
DateTime(timezone=True), server_default=func.now(), onupdate=func.now()
|
||||
)
|
||||
|
||||
user: Mapped["User"] = relationship(back_populates="auth")
|
||||
@@ -0,0 +1,65 @@
|
||||
"""User and UserAuth Pydantic schemas for API facing layer."""
|
||||
|
||||
from datetime import datetime
|
||||
from enum import StrEnum
|
||||
from uuid import UUID
|
||||
|
||||
from pydantic import BaseModel, ConfigDict, EmailStr
|
||||
|
||||
|
||||
class UserStatus(StrEnum):
|
||||
"""Statuses that a user account can be in."""
|
||||
|
||||
ACTIVE = "active"
|
||||
SUSPENDED = "suspended"
|
||||
|
||||
|
||||
class UserBase(BaseModel):
|
||||
"""Base User Model."""
|
||||
|
||||
first_name: str
|
||||
last_name: str
|
||||
email: EmailStr
|
||||
|
||||
|
||||
class UserCreate(UserBase):
|
||||
"""Dedicated create class so application can assign ID."""
|
||||
|
||||
status: UserStatus = UserStatus.ACTIVE
|
||||
|
||||
|
||||
class UserRead(UserBase):
|
||||
"""User class to read back when user data is requested."""
|
||||
|
||||
model_config = ConfigDict(from_attributes=True)
|
||||
|
||||
id: UUID
|
||||
status: UserStatus
|
||||
is_superuser: bool
|
||||
created_at: datetime
|
||||
updated_at: datetime
|
||||
last_login_at: datetime | None = None
|
||||
|
||||
|
||||
class UserUpdate(BaseModel):
|
||||
"""Update class to update individual fields in User record."""
|
||||
|
||||
first_name: str | None = None
|
||||
last_name: str | None = None
|
||||
email: EmailStr | None = None
|
||||
status: UserStatus | None = None
|
||||
|
||||
|
||||
class UserAuthCreate(BaseModel):
|
||||
"""Auth Create class to dedicated to grabbing all fields required."""
|
||||
|
||||
user_id: UUID
|
||||
hashed_password: str
|
||||
must_change_password: bool = False
|
||||
|
||||
|
||||
class UserAuthUpdate(BaseModel):
|
||||
"""Updated model to update user password."""
|
||||
|
||||
hashed_password: str | None = None
|
||||
must_change_password: bool | None = None
|
||||
Reference in new issue
Block a user