More overall structure for the project. Added roster and lots of TODOs

jessehartloff · jessehartloff · commit 9e3470a165d6 · 2025-06-11T13:24:36.000-04:00
diff --git a/api/auth/controller.py b/api/auth/controller.py
@@ -0,0 +1,5 @@
+from api.database.db import db
+
+def create_account(username, numeric_identifier, auth_level='student'):
+    db.create_account(username, numeric_identifier)
+    pass
diff --git a/api/auth/routes.py b/api/auth/routes.py
@@ -29,3 +29,8 @@ def signup():
         The status of the sign-up attempt
     """
     return "Signup arrived"
+
+
+# TODO: update preferred name
+
+# TODO: accounts has UBIT (For AL lookups) and pn (For card swipes)
diff --git a/api/database/IAccounts.py b/api/database/IAccounts.py
@@ -0,0 +1,9 @@
+
+from abc import ABC, abstractmethod
+
+class IAccounts:
+
+    @abstractmethod
+    def create_account(self, ubit, pn):
+        # return id
+        raise NotImplementedError()
diff --git a/api/database/IRoster.py b/api/database/IRoster.py
@@ -0,0 +1,9 @@
+
+from abc import ABC, abstractmethod
+
+class IRoster:
+
+    @abstractmethod
+    def add_to_roster(self, user_id, role):
+        raise NotImplementedError()
+
diff --git a/api/database/interface.py b/api/database/interface.py
@@ -1,9 +1,11 @@
 from abc import ABC, abstractmethod
 
-from IQueue import IQueue
-from IRatings import IRatings
+from api.database.IQueue import IQueue
+from api.database.IRatings import IRatings
+from api.database.IAccounts import IAccounts
+from api.database.IRoster import IRoster
 
-class DBInterface(IQueue, IRatings, ABC):
+class DBInterface(IQueue, IRatings, IAccounts, IRoster, ABC):
 
     # All database implements must extend this class
 
diff --git a/api/database/mock_db/MockDB.py b/api/database/mock_db/MockDB.py
@@ -1,7 +1,22 @@
-from api.database.mock_db.MockDBQueue import MockDBQueue
-from api.database.mock_db.MockDBRatings import MockDBRatings
+from api.database.interface import DBInterface
 
 
-class MockDB(MockDBQueue, MockDBRatings):
+class MockDB(DBInterface):
 
-    pass
+    def connect(self):
+        pass
+
+    def enqueue_student(self, student):
+        pass
+
+    def dequeue_student(self):
+        pass
+
+    def rate_student(self, student, rating, feedback):
+        pass
+
+    def create_account(self, ubit, pn):
+        pass
+
+    def add_to_roster(self, user_id, role):
+        pass
diff --git a/api/database/mock_db/MockDBQueue.py b/api/database/mock_db/MockDBQueue.py
diff --git a/api/database/mock_db/MockDBRatings.py b/api/database/mock_db/MockDBRatings.py
diff --git a/api/database/relational_db/RelationalDB.py b/api/database/relational_db/RelationalDB.py
@@ -1,7 +1,9 @@
+from api.database.interface import DBInterface
+
 from api.database.relational_db.RelationalDBQueue import RelationalDBQueue
 from api.database.relational_db.RelationalDBRatings import RelationalDBRatings
 
 
-class RelationalDB(RelationalDBQueue, RelationalDBRatings):
+class RelationalDB(DBInterface, RelationalDBQueue, RelationalDBRatings):
 
     pass
diff --git a/api/database/testing_db/TestingDB.py b/api/database/testing_db/TestingDB.py
@@ -1,7 +1,17 @@
+from api.database.interface import DBInterface
+
 from api.database.testing_db.TestingDBQueue import TestingDBQueue
 from api.database.testing_db.TestingDBRatings import TestingDBRatings
 
 
-class TestingDB(TestingDBQueue, TestingDBRatings):
+class TestingDB(DBInterface, TestingDBQueue, TestingDBRatings):
+
+    def connect(self):
+        pass
+
+    def create_account(self, ubit, pn):
+        print("Welcome " + ubit)
+
+    def add_to_roster(self, user_id, role):
+        pass
 
-    pass
diff --git a/api/models/live_queue.py b/api/models/live_queue.py
diff --git a/api/models/visits.py b/api/models/visits.py
diff --git a/api/queue/controller.py b/api/queue/controller.py
@@ -0,0 +1,13 @@
+
+def add_to_queue_by_card_swipe(swipe_data):
+    pass
+
+def add_to_queue_by_ta_override(identifier):
+    # identifier is resolved by checking if it's a valid UBIT, then pn, then account id
+    pass
+
+
+def add_to_queue(user_account):
+    # called by both add_to_queue_by_card_swipe and add_to_queue_by_ta_override after user
+    # has been identified and their account was pulled from the db
+    pass
diff --git a/api/queue/routes.py b/api/queue/routes.py
@@ -10,41 +10,61 @@
 @blueprint.route("/enqueue-card-swipe", methods=["POST"])
 def enqueue_card_swipe():
     """
+    role: hardware
+
     Add student to the current live queue for office hours
 
     Args:
-        Request.cookie: A HTTP Cookie with the name `id` for the student being added.
-        Cookie Example -
-            "id": "12344567890" # only one field seems weird maybe more?
+        body.swipe_data: The raw data from the card swipe as a string
+
+    Body:
+        {
+            "swipe_data": "..."
+        }
 
     Returns:
-        A JSON of request status and possible wait time in seconds
+        A JSON of request status
         {
             "message": "You are enqueued",
-            "wait_time": "5000"
         }
     """
     return f"{request.path} hit 😎, enqueue method is used"
 
 
 @blueprint.route("/enqueue-ta-override", methods=["POST"])
 def enqueue_ta_override():
-    db.enqueue_student("Steve")
     """
-    Force enqueue a student into the queue. Only usable by TAs and instructors
+    role: TA
+
+    Force enqueue a student into the queue.
+
+    Resolving the id will be done in the order: UBIT -> pn -> id (Although, these _should_ all be unique so the order
+    shouldn't matter)
+
+    Args:
+        body.id: A unique identifier for the student This can either be the id of their account, their pn, or their ubit
+
+    Body:
+        {
+            "id": "..."
+        }
 
     Use case: A student didn't bring their card to OH so they can't swipe in. The TA can force add them to the queue
     """
+    pass
     return ""
 
 
-@blueprint.route("/dequeue", methods=["DELETE"])
+@blueprint.route("/help-a-student", methods=["POST"])
 def dequeue():
-    student = db.dequeue_student()
     """
+    role: TA
+
     Remove the first student from the queue and create a Visit in the DB
+
+    Not allowed if TA is already in a visit
     """
-    return student
+    return "Help them good!"
 
 
 @blueprint.route("/get-queue", methods=["GET"])
@@ -67,13 +87,18 @@ def get_anon_queue():
     return ""
 
 
-@blueprint.route("/remove", methods=["DELETE"])
-def remove():
+@blueprint.route("/remove-self-from-queue", methods=["POST"])
+def remove_self():
     """Removing students from the queue based on id
     Args:
-        Request.cookie: A HTTP Cookie with the name `id` for the student bring removed.
-        Cookie Example -
-            "id": "12344567890"
+        Request.cookie: The auth token used to identify the requester
+        body.reason: a text reason for removing the user from the queue. Will appear in the body of the request in a
+                     json object
+
+    Body:
+        {
+            "reason": "No show"
+        }
 
     Returns:
         A JSON of request status
@@ -82,3 +107,24 @@ def remove():
         }
     """
     return f"{request.path} hit 😎, remove method is used."
+
+
+@blueprint.route("/remove-from-queue/<user_id>", methods=["POST"])
+def remove(user_id):
+    """Removing students from the queue by id
+    Args:
+        user_id: The id of the student being removed. Note: This is the id of their account, not their UBIT/pn
+        body.reason: a text reason for removing the user from the queue. Will appear in the body of the request in a
+                     json object
+
+    Body:
+        {
+            "reason": "No show"
+        }
+
+    Returns:
+        {
+            "message": "You removed <user_id> from the queue"
+        }
+    """
+    return f"{request.path} hit 😎, remove method is used."
diff --git a/api/ratings/controller.py b/api/ratings/controller.py
@@ -0,0 +1 @@
+pass
diff --git a/api/ratings/routes.py b/api/ratings/routes.py
@@ -5,4 +5,10 @@
 blueprint = Blueprint("ratings", __name__)
 
 
-# TODO: All the end points for students and TAs
+# TODO: All the end points for students and TAs. Rating contains rater/ratee/rating/feedback/visitID
+
+# TODO: create_rating
+
+# TODO: update rating (must be author)
+
+# TODO: get ratings (instructor/admin only)
diff --git a/api/roster/routes.py b/api/roster/routes.py
@@ -0,0 +1,18 @@
+"""Roster Blueprint for MOH"""
+
+from flask import Blueprint
+
+blueprint = Blueprint("roster", __name__)
+
+
+# TODO: upload roster. Take a csv file and add all the students to the roster (ubit,pn,name,role)
+
+# TODO: get roster
+
+# TODO: add to roster - to add an individual to the roster
+
+# TODO: Remove from roster
+
+# TODO: Whenever someone is added to the roster, check if they have an account and create one for them if not
+
+# TODO: handle roles here (Will make it easier to move to multiple courses in the future)
diff --git a/api/server.py b/api/server.py
@@ -3,25 +3,19 @@
 A Flask API server that handles enqueue and dequeuing students from the office hours queue.
 """
 
-# TODO: Make the doc string sound better
-
 import datetime
 import io
-import json
-import os
 
 import requests
-from flask import Flask, request
+from flask import Flask
 from flask import send_file
 
 from api.config import config
 from api.utils.debug import debug_access_only
-from api.database.db import create_db
 import api.auth.routes as auth_routes
 import api.queue.routes as queue_routes
 import api.ratings.routes as ratings_routes
-
-from api.database.db import db
+import api.roster.routes as roster_routes
 
 
 def create_app():
@@ -38,6 +32,7 @@ def create_app():
     app.register_blueprint(auth_routes.blueprint)
     app.register_blueprint(queue_routes.blueprint)
     app.register_blueprint(ratings_routes.blueprint)
+    app.register_blueprint(roster_routes.blueprint)
 
     @app.route("/", methods=["GET"])
     def home():
diff --git a/api/test/.placeholder b/api/test/.placeholder
diff --git a/test.py b/test.py
diff --git a/tests/api/test_queue_basics.py b/tests/api/test_queue_basics.py
