Setup project, started outlining endpoints and tests.

This commit is contained in:
Sparkchaser13 committed 2026-09-22 21:29:31 -06:00
commit ad61b3f83c
55 files changed
+5138

No files matched your search

+1
View File
@@ -0,0 +1 @@
3.13
View File
Whitespace-only changes.
View File
Whitespace-only changes.
Binary file not shown.
Binary file not shown.
View File
Whitespace-only changes.
Binary file not shown.
+3
View File
@@ -0,0 +1,3 @@
"""Common types and models."""
type Message = dict[str, str]
+20
View File
@@ -0,0 +1,20 @@
"""Where the magic happens."""
from fastapi import APIRouter, FastAPI
from app.core.common import Message
from app.platform.auth import router as auth
from app.platform.users import router as users
app = FastAPI()
api_router = APIRouter(prefix="/api")
api_router.include_router(users.router)
api_router.include_router(auth.router)
app.include_router(api_router)
@app.get(path="/")
def status_check() -> Message:
"""Endpoind to check if server is running."""
return {"status": "healthy"}
View File
Whitespace-only changes.
Whitespace-only changes.
+49
View File
@@ -0,0 +1,49 @@
"""Endpoints for authentication."""
from fastapi import APIRouter
from app.core.common import Message
router = APIRouter(prefix="/auth", tags=["auth"])
@router.post(path="/login")
async def login_user() -> Message:
"""Start user session/token."""
return {"status": "healthy"}
@router.post(path="/refresh")
async def refresh_login_session() -> Message:
"""Refresh user login."""
return {"status": "healthy"}
@router.post(path="/logout")
async def logout_user() -> Message:
"""End user session/token."""
return {"status": "healthy"}
@router.post(path="/invite/accept")
async def accept_invite() -> Message:
"""Accept user invite."""
return {"status": "healthy"}
@router.post(path="/password-reset/request")
async def request_password_reset() -> Message:
"""Initiate password request."""
return {"status": "healthy"}
@router.post(path="/password-reset/confirm")
async def confirm_password_reset() -> Message:
"""Confirm password request."""
return {"status": "healthy"}
@router.get(path="/{user_id}")
async def retrieve_authenticated_user(user_id: str) -> Message:
"""Retrieve current authenticated user by id."""
return {"status": user_id}
Whitespace-only changes.
Whitespace-only changes.
+21
View File
@@ -0,0 +1,21 @@
"""Database user model."""
import uuid
from sqlalchemy import Column, String
from sqlalchemy.orm import DeclarativeBase
class Base(DeclarativeBase):
"""Base Class for all db models."""
pass
class DBUser(Base):
"""Database User Model."""
id = Column(
String(36), primary_key=True, default=lambda: str(uuid.uuid4()), index=True
)
email = Column(String)
+61
View File
@@ -0,0 +1,61 @@
"""Routes for users."""
from fastapi import APIRouter
from app.core.common import Message
router = APIRouter(prefix="/users", tags=["user"])
@router.get(path="/")
def list_users() -> Message:
"""Retrieve all users stored in DB."""
return {"status": "healthy"}
@router.post(path="/invite")
def send_user_invite() -> Message:
"""Send user invite request."""
return {"status": "healthy"}
@router.get(path="/{user_id}")
def retrieve_user(user_id: str) -> Message:
"""Retrieve user by id."""
return {"user": user_id}
@router.patch(path="/{user_id}")
def update_user(user_id: str) -> Message:
"""Update user by id."""
return {"user": user_id}
@router.post(path="/{user_id}/deactivate")
def deactivate_user(user_id: str) -> Message:
"""Deactivates user by id."""
return {"user": user_id}
@router.post(path="/{user_id}/reactivate")
def reactivate_user(user_id: str) -> Message:
"""Reactivates user by id."""
return {"user": user_id}
@router.post(path="/{user_id}/resend-invite")
def resend_user_invite(user_id: str) -> Message:
"""Resends user invite."""
return {"user": user_id}
@router.get(path="/{user_id}/export")
def export_user(user_id: str) -> Message:
"""Resends user invite."""
return {"user": user_id}
@router.delete(path="/{user_id}")
def delete_user(user_id: str) -> Message:
"""Resends user invite."""
return {"user": user_id}
+78
View File
@@ -0,0 +1,78 @@
[project]
name = "backend"
version = "0.1.0"
description = "Add your description here"
readme = "README.md"
authors = [
{ name = "Jermey Van Sant", email = "jermey.e.vansant@gmail.com" }
]
requires-python = ">=3.13"
dependencies = [
"fastapi[standard]>=0.141.1",
"sqlalchemy>=2.0.54",
]
[tool.fastapi]
entrypoint = "app.main:app"
[tool.pytest.ini_options]
pythonpath = ["."]
[tool.ruff]
line-length = 88
target-version = "py312"
indent-width = 2
[tool.ruff.format]
indent-style = "space"
quote-style = "double"
[tool.ruff.lint]
exclude = [
".bzr",
".direnv",
".eggs",
".git",
".git-rewrite",
".hg",
".ipynb_checkpoints",
".mypy_cache",
".nox",
".pants.d",
".pyenv",
"__init__.py",
".pytest_cache",
".pytype",
".ruff_cache",
".svn",
".tox",
".venv",
".vscode",
"__pypackages__",
"_build",
"buck-out",
"build",
"dist",
"node_modules",
"site-packages",
"venv",
]
select = [
"E", # pycodestyle
"F", # Pyflakes
"D", # Docstrings
"I", # isort
"UP", # pyupgrade
"B", # flake8-bugbear
"SIM", # flake8-simplify
"ANN",
"RUF", # Ruff-specific rules
]
ignore = ["EXE002"]
[dependency-groups]
dev = [
"httpx2>=2.13.0",
"pytest>=9.1.1",
]
View File
Whitespace-only changes.
Binary file not shown.
+15
View File
@@ -0,0 +1,15 @@
"""Fixtures to import into tests."""
from collections.abc import Iterator
import pytest
from fastapi.testclient import TestClient
from app.main import app
@pytest.fixture
def client() -> Iterator[TestClient]:
"""Client fixture to pass test client with."""
with TestClient(app) as client:
yield client
+13
View File
@@ -0,0 +1,13 @@
"""Unit tests for main.py."""
from fastapi.testclient import TestClient
from app.main import app
client = TestClient(app)
def test_status_check() -> None:
"""Tests that status check returns 200."""
response = client.get("/")
assert response.status_code == 200
Whitespace-only changes.
+46
View File
@@ -0,0 +1,46 @@
"""Tests to check that auth endpoints are wired up."""
from fastapi.testclient import TestClient
def test_post_auth_login_returns_200(client: TestClient) -> None:
"""Verify POST /api/auth/login returns a successful response."""
response = client.post("/api/auth/login")
assert response.status_code == 200
def test_post_auth_refresh_returns_200(client: TestClient) -> None:
"""Verify POST /api/auth/refresh returns a successful response."""
response = client.post("/api/auth/refresh")
assert response.status_code == 200
def test_post_auth_logout_returns_200(client: TestClient) -> None:
"""Verify POST /api/auth/logout returns a successful response."""
response = client.post("/api/auth/logout")
assert response.status_code == 200
def test_post_auth_invite_accept_returns_200(client: TestClient) -> None:
"""Verify POST /api/auth/invite/accept returns a successful response."""
response = client.post("/api/auth/invite/accept")
assert response.status_code == 200
def test_post_auth_password_reset_request_returns_200(client: TestClient) -> None:
"""Verify POST /api/auth/password-reset/request returns a successful response."""
response = client.post("/api/auth/password-reset/request")
assert response.status_code == 200
def test_post_auth_password_reset_confirm_returns_200(client: TestClient) -> None:
"""Verify POST /api/auth/password-reset/confirm returns a successful response."""
response = client.post("/api/auth/password-reset/confirm")
assert response.status_code == 200
def test_get_auth_self_returns_200(client: TestClient) -> None:
"""Verify get /api/auth/{user_id} returns a successful response."""
response = client.get("/api/auth/123")
assert response.status_code == 200
+66
View File
@@ -0,0 +1,66 @@
"""One stop shop to check endpoints."""
from fastapi.testclient import TestClient
def test_get_users_returns_200(client: TestClient) -> None:
"""Verify GET /api/users returns a successful response."""
response = client.get("/api/users")
assert response.status_code == 200
def test_post_user_invite_returns_200(client: TestClient) -> None:
"""Verify POST /api/users/invite returns a successful response."""
response = client.post("/api/users/invite")
assert response.status_code == 200
def test_get_user_by_id_returns_200(client: TestClient) -> None:
"""Verify GET /api/users/{id} returns a successful response."""
response = client.get("/api/users/123")
assert response.status_code == 200
def test_patch_user_by_id_returns_200(client: TestClient) -> None:
"""Verify PATCH /api/users/{id} returns a successful response."""
response = client.patch("/api/users/123")
assert response.status_code == 200
def test_deactivate_user_returns_200(client: TestClient) -> None:
"""Verify POST /api/users/{id}/deactivate returns a successful response."""
response = client.post("/api/users/123/deactivate")
assert response.status_code == 200
def test_reactivate_user_returns_200(client: TestClient) -> None:
"""Verify POST /api/users/{id}/reactivate returns a successful response."""
response = client.post("/api/users/123/reactivate")
assert response.status_code == 200
def test_resend_user_invite_returns_200(client: TestClient) -> None:
"""Verify POST /api/users/{id}/resend-invite returns a successful response."""
response = client.post("/api/users/123/resend-invite")
assert response.status_code == 200
def test_export_current_user_returns_200(client: TestClient) -> None:
"""Verify GET /api/users/me/export returns a successful response."""
response = client.get("/api/users/123/export")
assert response.status_code == 200
def test_delete_user_returns_200(client: TestClient) -> None:
"""Verify DELETE /api/users/{id} returns a successful response."""
response = client.delete("/api/users/123")
assert response.status_code == 200
+1178
View File
File diff suppressed because it is too large. Load diff