Merge pull request #20 from hackclub/endpoint-refactor

API endpoint refactor

Author: thesleepyniko

api/__init__.py

@@ -0,0 +1,4 @@
+# pylint: disable=C0114
+from . import v1
+
+__all__ = ["v1"]

v1/__init__.py renamed to api/v1/__init__.py

@@ -2,12 +2,13 @@
 
 import json
 import os
+import pathlib
 import secrets
 from datetime import datetime, timedelta, timezone
 from email.message import EmailMessage
 from enum import Enum
 from functools import wraps
-from typing import Callable, Any, Awaitable, Optional
+from typing import Any, Awaitable, Callable, Optional
 
 import aiosmtplib
 import dotenv
@@ -18,21 +19,21 @@
 import sqlalchemy
 from fastapi import APIRouter, Depends, Request
 from fastapi.exceptions import HTTPException  # , RequestValidationError
-from fastapi.responses import RedirectResponse, Response, JSONResponse
+from fastapi.responses import JSONResponse, RedirectResponse, Response
 from pydantic import BaseModel, field_validator
-from sqlalchemy.ext.asyncio import AsyncSession
-from sqlalchemy.exc import IntegrityError
 from sqlalchemy import select
+from sqlalchemy.exc import IntegrityError
+from sqlalchemy.ext.asyncio import AsyncSession
 
-from v1.db import get_db
-from v1.models.user import User
+from db import get_db
+from models.user import User
 
 dotenv.load_dotenv()
 
 HOST = "redis" if os.getenv("USING_DOCKER") == "true" else "localhost"
 r = redis.Redis(password=os.getenv("REDIS_PASSWORD", ""), host=HOST)
 
-with open("v1/auth/otp.html", "r", encoding="utf8") as f:
+with open(pathlib.Path(__file__).parent / "otp.html", "r", encoding="utf8") as f:
     OTP_EMAIL_TEMPLATE = f.read()
 
 
@@ -205,7 +206,7 @@ async def is_user_authenticated(request: Request) -> AuthJwt:
     return decoded_jwt
 
 
-@router.post("/auth/refresh_session")
+@router.post("/refresh_session")
 async def refresh_token(
     request: Request, response: Response, session_request: SessionClientRequest
 ):
@@ -258,14 +259,14 @@ async def send_otp_code(to_email: str, old_email: Optional[str] = None) -> bool:
     return True
 
 
-@router.post("/auth/send_otp")
+@router.post("/send_otp")
 async def send_otp(_request: Request, otp_request: OtpClientRequest):
     """Send OTP to the user's email"""
     await send_otp_code(to_email=otp_request.email)
     return Response(status_code=204)
 
 
-@router.post("/auth/validate_otp")
+@router.post("/validate_otp")
 async def validate_otp(
     otp_client_response: OtpClientResponse,
     session: AsyncSession = Depends(get_db),

v1/admin/__init__.py renamed to api/v1/admin/__init__.py

@@ -14,9 +14,9 @@
 from sqlalchemy.orm import selectinload
 import validators
 
-from v1.auth import require_auth  # type: ignore
-from v1.db import get_db  # , engine
-from v1.models.user import User, UserProject
+from api.v1.auth import require_auth  # type: ignore
+from db import get_db  # , engine
+from models.user import User, UserProject
 
 CDN_HOST = "hc-cdn.hel1.your-objectstorage.com"
 
@@ -98,7 +98,7 @@ def validate_repo(repo: HttpUrl | None):
 
 
 # @protect
-@router.patch("/api/projects/{project_id}")
+@router.patch("/{project_id}")
 @require_auth
 async def update_project(
     request: Request,
@@ -160,7 +160,7 @@ async def update_project(
         return Response(status_code=500)
 
 
-@router.get("/api/projects")
+@router.get("/")
 @require_auth
 async def return_projects_for_user(
     request: Request, session: AsyncSession = Depends(get_db)
@@ -180,7 +180,7 @@ async def return_projects_for_user(
     return projects_ret
 
 
-@router.get("/api/projects/{project_id}")
+@router.get("/{project_id}")
 @require_auth
 async def return_project_by_id(
     request: Request, project_id: int, session: AsyncSession = Depends(get_db)
@@ -200,7 +200,7 @@ async def return_project_by_id(
     return ProjectResponse.from_model(project)
 
 
-@router.get("/api/projects/{project_id}/model-test")
+@router.get("/{project_id}/model-test")
 @require_auth
 async def model_test(
     request: Request, project_id: int, session: AsyncSession = Depends(get_db)
@@ -220,7 +220,7 @@ async def model_test(
     return project.update_hackatime()
 
 
-@router.post("/api/projects")
+@router.post("/")
 @require_auth
 async def create_project(
     request: Request,