Refactor packaging

Author: billyhoce

services/question-service/app/core/__init__.py

@@ -1,6 +1,6 @@
 import uuid
 from typing import List, Dict, Optional
-from app.utils import get_conn, upload_to_s3, get_from_s3, delete_from_s3
+from utils import get_conn, upload_to_s3, get_from_s3, delete_from_s3
 from app.models.exceptions import QuestionNotFoundException
 
 def list_difficulties_and_topics() -> Dict[str, List[str]]:

services/question-service/app/crud.py renamed to services/question-service/app/core/crud.py

@@ -1,130 +1,11 @@
-from fastapi import FastAPI, HTTPException, Query
+from fastapi import FastAPI
 from dotenv import load_dotenv
-from app.models.endpoint_models import QuestionBase64Images
-from app.models.exceptions import QuestionNotFoundException
-from app.utils import batch_convert_base64_to_bytes, batch_convert_bytes_to_base64
-from app.crud import (
-    add_difficulty,
-    delete_difficulty,
-    add_topic,
-    delete_topic,
-    create_question,
-    get_question,
-    get_random_question_by_difficulty_and_topic,
-    override_question,
-    delete_question,
-    list_difficulties_and_topics
-)
-
+from app.routers import questions_router, metadata_router
 
 load_dotenv()
 
 app = FastAPI()
 
-@app.post("/questions")
-def create_question_endpoint(q: QuestionBase64Images):
-    # Convert images and call CRUD with primitive types
-    images_bytes = batch_convert_base64_to_bytes(q.images)
-    
-    new_qid = create_question(
-        name=q.name,
-        description=q.description, 
-        difficulty=q.difficulty,
-        topic=q.topic,
-        images=images_bytes
-    )
-    
-    # Get the created question and convert to response model
-    return {
-        "id": new_qid,
-        "message": "Created successfully"
-    }
-
-
-@app.get("/questions/{qid}", response_model=QuestionBase64Images) 
-def get_question_endpoint(qid: str):
-    try:
-        question_dict = get_question(qid)
-    except QuestionNotFoundException as e:
-        raise HTTPException(status_code=404, detail=f"Question {e.question_id} not found")
-    question_dict['images'] = batch_convert_bytes_to_base64(question_dict['images'])
-    return question_dict
-
-
-@app.get("/questions/random")
-def get_random_question_endpoint(
-    difficulty: str = Query(..., description="The difficulty level to filter by"),
-    topic: str = Query(..., description="The topic to filter by")
-):
-    """Get a random question by difficulty and topic"""
-    try:
-        question_dict = get_random_question_by_difficulty_and_topic(difficulty, topic)
-    except QuestionNotFoundException as e:
-        raise HTTPException(status_code=404, detail=str(e))
-    question_dict['images'] = batch_convert_bytes_to_base64(question_dict['images'])
-    return question_dict
-
-
-@app.put("/questions/{qid}")
-def update_question_endpoint(qid: str, q: QuestionBase64Images):
-    images_bytes = batch_convert_base64_to_bytes(q.images)
-    
-    try:
-        override_question(
-            qid=qid,
-            name=q.name,
-            description=q.description,
-            difficulty=q.difficulty, 
-            topic=q.topic,
-            images=images_bytes
-        )
-    except QuestionNotFoundException as e:
-        raise HTTPException(status_code=404, detail=str(e))
-
-    return {
-        "message": "Updated successfully"
-    }
-
-
-@app.delete("/questions/{qid}")
-def delete_question_endpoint(qid: str):
-    try:
-        delete_question(qid)
-    except QuestionNotFoundException as e:
-        raise HTTPException(status_code=404, detail=str(e))
-    return {
-        "message": "Deleted successfully"
-    }
-
-
-@app.get("/difficulties-topics")
-def get_difficulties_topics():
-    return list_difficulties_and_topics()
-
-@app.post("/difficulties")
-def add_difficulty_endpoint(difficulty: str = Query(..., description="The difficulty level to add")):
-    add_difficulty(difficulty)
-    return {
-        "message": f"Difficulty '{difficulty}' added successfully"
-    }
-
-@app.delete("/difficulties")
-def delete_difficulty_endpoint(difficulty: str = Query(..., description="The difficulty level to delete")):
-    delete_difficulty(difficulty)
-    return {
-        "message": f"Difficulty '{difficulty}' deleted successfully"
-    }
-
-@app.post("/topics")
-def add_topic_endpoint(topic: str = Query(..., description="The topic to add")):
-    add_topic(topic)
-    return {
-        "message": f"Topic '{topic}' added successfully"
-    }
-
-@app.delete("/topics")
-def delete_topic_endpoint(topic: str = Query(..., description="The topic to delete")):
-    delete_topic(topic)
-    return {
-        "message": f"Topic '{topic}' deleted successfully"
-    }
+# Include routers
+app.include_router(questions_router)
+app.include_router(metadata_router)

services/question-service/app/main.py

@@ -0,0 +1,5 @@
+# Router imports for the question service
+from .questions import router as questions_router
+from .metadata import router as metadata_router
+
+__all__ = ["questions_router", "metadata_router"]

services/question-service/app/models/__init__.py

@@ -0,0 +1,45 @@
+from fastapi import APIRouter, Query
+from app.core.crud import (
+    add_difficulty,
+    delete_difficulty,
+    add_topic,
+    delete_topic,
+    list_difficulties_and_topics
+)
+
+router = APIRouter(
+    prefix="/metadata",
+    tags=["metadata"]
+)
+
+@router.get("/difficulties-topics")
+def get_difficulties_topics():
+    return list_difficulties_and_topics()
+
+@router.post("/difficulties")
+def add_difficulty_endpoint(difficulty: str = Query(..., description="The difficulty level to add")):
+    add_difficulty(difficulty)
+    return {
+        "message": f"Difficulty '{difficulty}' added successfully"
+    }
+
+@router.delete("/difficulties")
+def delete_difficulty_endpoint(difficulty: str = Query(..., description="The difficulty level to delete")):
+    delete_difficulty(difficulty)
+    return {
+        "message": f"Difficulty '{difficulty}' deleted successfully"
+    }
+
+@router.post("/topics")
+def add_topic_endpoint(topic: str = Query(..., description="The topic to add")):
+    add_topic(topic)
+    return {
+        "message": f"Topic '{topic}' added successfully"
+    }
+
+@router.delete("/topics")
+def delete_topic_endpoint(topic: str = Query(..., description="The topic to delete")):
+    delete_topic(topic)
+    return {
+        "message": f"Topic '{topic}' deleted successfully"
+    }

services/question-service/app/routers/__init__.py

@@ -0,0 +1,91 @@
+from fastapi import APIRouter, HTTPException, Query
+from app.models.endpoint_models import QuestionBase64Images
+from app.models.exceptions import QuestionNotFoundException
+from app.utils import batch_convert_base64_to_bytes, batch_convert_bytes_to_base64
+from app.core.crud import (
+    create_question,
+    get_question,
+    get_random_question_by_difficulty_and_topic,
+    override_question,
+    delete_question,
+)
+
+router = APIRouter(
+    prefix="/questions",
+    tags=["questions"]
+)
+
+@router.post("")
+def create_question_endpoint(q: QuestionBase64Images):
+    # Convert images and call CRUD with primitive types
+    images_bytes = batch_convert_base64_to_bytes(q.images)
+    
+    new_qid = create_question(
+        name=q.name,
+        description=q.description, 
+        difficulty=q.difficulty,
+        topic=q.topic,
+        images=images_bytes
+    )
+    
+    # Get the created question and convert to response model
+    return {
+        "id": new_qid,
+        "message": "Created successfully"
+    }
+
+
+@router.get("/random")
+def get_random_question_endpoint(
+    difficulty: str = Query(..., description="The difficulty level to filter by"),
+    topic: str = Query(..., description="The topic to filter by")
+):
+    """Get a random question by difficulty and topic"""
+    try:
+        question_dict = get_random_question_by_difficulty_and_topic(difficulty, topic)
+    except QuestionNotFoundException as e:
+        raise HTTPException(status_code=404, detail=str(e))
+    question_dict['images'] = batch_convert_bytes_to_base64(question_dict['images'])
+    return question_dict
+
+
+@router.get("/{qid}", response_model=QuestionBase64Images) 
+def get_question_endpoint(qid: str):
+    try:
+        question_dict = get_question(qid)
+    except QuestionNotFoundException as e:
+        raise HTTPException(status_code=404, detail=f"Question {e.question_id} not found")
+    question_dict['images'] = batch_convert_bytes_to_base64(question_dict['images'])
+    return question_dict
+
+
+@router.put("/{qid}")
+def update_question_endpoint(qid: str, q: QuestionBase64Images):
+    images_bytes = batch_convert_base64_to_bytes(q.images)
+    
+    try:
+        override_question(
+            qid=qid,
+            name=q.name,
+            description=q.description,
+            difficulty=q.difficulty, 
+            topic=q.topic,
+            images=images_bytes
+        )
+    except QuestionNotFoundException as e:
+        raise HTTPException(status_code=404, detail=str(e))
+
+    return {
+        "message": "Updated successfully"
+    }
+
+
+@router.delete("/{qid}")
+def delete_question_endpoint(qid: str):
+    try:
+        delete_question(qid)
+    except QuestionNotFoundException as e:
+        raise HTTPException(status_code=404, detail=str(e))
+    return {
+        "message": "Deleted successfully"
+    }