Spaces:
Sleeping
Sleeping
File size: 4,412 Bytes
b84ea83 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 | """
User Model — ORM + Pydantic Schemas for Authentication
ORM: User (SQLAlchemy table: users)
Schemas: UserCreate, UserLogin, UserResponse, TokenResponse
Architecture Reference: insights/architecture_rule.md
Phase 2: "Implement JWT Authentication and RBAC in auth_controller.py"
"""
import uuid
from datetime import datetime
from typing import Optional
from enum import Enum
from sqlalchemy import String, DateTime, Boolean, func
from sqlalchemy.dialects.postgresql import UUID
from sqlalchemy.orm import Mapped, mapped_column
from pydantic import BaseModel, Field, ConfigDict, EmailStr
from models.base import Base
# ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
# Enums
# ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
class UserRole(str, Enum):
"""Role-Based Access Control roles."""
admin = "admin" # Full system access
inspector = "inspector" # Ghost Shopper field inspector
viewer = "viewer" # Read-only dashboard access
# ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
# ORM Model
# ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
class User(Base):
"""SQLAlchemy ORM model for the 'users' table."""
__tablename__ = "users"
id: Mapped[uuid.UUID] = mapped_column(
UUID(as_uuid=True), primary_key=True, default=uuid.uuid4
)
email: Mapped[str] = mapped_column(
String(255), unique=True, nullable=False, index=True
)
hashed_password: Mapped[str] = mapped_column(
String(255), nullable=False
)
full_name: Mapped[str] = mapped_column(
String(255), nullable=False
)
role: Mapped[str] = mapped_column(
String(20), nullable=False, default=UserRole.inspector.value
)
is_active: Mapped[bool] = mapped_column(
Boolean, nullable=False, default=True
)
fcm_token: Mapped[Optional[str]] = mapped_column(
String(500), nullable=True,
comment="Firebase Cloud Messaging token for push notifications"
)
last_login: Mapped[Optional[datetime]] = mapped_column(
DateTime, nullable=True
)
created_at: Mapped[datetime] = mapped_column(
DateTime, server_default=func.now()
)
updated_at: Mapped[datetime] = mapped_column(
DateTime, server_default=func.now(), onupdate=func.now()
)
def __repr__(self) -> str:
return f"<User(id={self.id}, email='{self.email}', role='{self.role}')>"
# ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
# Pydantic Schemas
# ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
class UserCreate(BaseModel):
"""Schema for user registration."""
email: str = Field(..., max_length=255, description="User email address")
password: str = Field(..., min_length=8, max_length=128, description="Plain-text password (will be hashed)")
full_name: str = Field(..., min_length=1, max_length=255, description="Full display name")
role: UserRole = Field(UserRole.inspector, description="User role: admin, inspector, viewer")
class UserLogin(BaseModel):
"""Schema for login request."""
email: str = Field(..., description="Registered email address")
password: str = Field(..., description="Plain-text password")
fcm_token: Optional[str] = Field(None, description="FCM token for push notifications")
class UserResponse(BaseModel):
"""Schema for user info in API responses (no password)."""
model_config = ConfigDict(from_attributes=True)
id: uuid.UUID
email: str
full_name: str
role: str
is_active: bool
last_login: Optional[datetime]
created_at: datetime
class TokenResponse(BaseModel):
"""Schema for JWT token response."""
access_token: str
token_type: str = "bearer"
expires_in: int = Field(description="Token lifetime in seconds")
user: UserResponse
|