Merge remote-tracking branch 'origin/testing' into oldIsNewAgain

Author: jessehartloff

.github/workflows/formatter.yml

@@ -9,17 +9,17 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.10", "3.11", "3.12"]
+        python-version: [ "3.10", "3.11", "3.12" ]
     steps:
-    - uses: actions/checkout@v4
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v3
-      with:
-        python-version: ${{ matrix.python-version }}
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install black
-    - name: Formatting the code with black
-      run: |
-        black $(git ls-files '*.py')
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v3
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install black
+      - name: Formatting the code with black
+        run: |
+          black $(git ls-files '*.py')

.github/workflows/pylint.yml

@@ -1,22 +1,23 @@
 name: Pylint
 run-name: Pylint Checker 🐧
-on: [push]
+on: [ push ]
 jobs:
   build:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.10", "3.11", "3.12"]
+        python-version: [ "3.10", "3.11", "3.12" ]
     steps:
-    - uses: actions/checkout@v4
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v3
-      with:
-        python-version: ${{ matrix.python-version }}
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install -r ./api/requirements_dev.txt
-    - name: Analysing the code with pylint
-      run: |
-        pylint $(git ls-files '*.py')
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v3
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r ./api/requirements.txt
+          pip install -r ./api/utils.txt
+      - name: Analysing the code with pylint
+        run: |
+          pylint $(git ls-files '*.py')

api/.env

@@ -0,0 +1,2 @@
+API_MODE=dev
+DB=relational

api/auth/controller.py

@@ -0,0 +1,6 @@
+from api.database.db import db
+
+
+def create_account(username, numeric_identifier, auth_level='student'):
+    account_id = db.create_account(username, numeric_identifier)
+    return account_id

api/auth/routes.py

@@ -4,6 +4,7 @@
 
 blueprint = Blueprint("auth", __name__)
 
+
 @blueprint.route("/login", methods=["POST"])
 def login():
     """Checks if the current user has the right credentials to log in
@@ -29,3 +30,7 @@ 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)

api/config/config.py

@@ -4,7 +4,7 @@
 
 
 class Config:
-    """Configuration class for MOJ api server, stores current configuration state of flask api"""
+    """Configuration class for MOH api server, stores current configuration state of flask api"""
 
     def __init__(self):
         self.API_MODE = os.getenv("API_MODE", "Can not find mode")

api/database/db.py

@@ -0,0 +1,23 @@
+import os
+
+from api.database.relational_db.relational_db import RelationalDB
+from api.database.testing_db.testing_db import TestingDB
+from api.database.mock_db.mock_db import MockDB
+
+
+def create_db():
+    db_type = os.getenv("DB")
+    match db_type:
+        case "relational":
+            return RelationalDB()
+        case "testing":
+            return TestingDB()
+        case "mock":
+            return MockDB()
+        case None:
+            raise EnvironmentError("environment variable \"DB\" not set")
+        case _:
+            raise ModuleNotFoundError("Could not find database named " + db_type)
+
+
+db = create_db()

api/database/db_interface.py

@@ -0,0 +1,18 @@
+from abc import ABC, abstractmethod
+
+from api.database.idb_queue import IQueue
+from api.database.idb_ratings import IRatings
+from api.database.idb_accounts import IAccounts
+from api.database.idb_roster import IRoster
+
+
+class DBInterface(IQueue, IRatings, IAccounts, IRoster, ABC):
+
+    # All database implements must extend this class
+
+    def __init__(self):
+        super().__init__()
+
+    @abstractmethod
+    def connect(self):
+        pass

api/database/idb_accounts.py

@@ -0,0 +1,12 @@
+from abc import ABC, abstractmethod
+
+
+class IAccounts(ABC):
+
+    def __init__(self):
+        super().__init__()
+
+    @abstractmethod
+    def create_account(self, ubit, pn):
+        # Creates an account with the provided ubit and pn. Generates, and returns, a unique id for the new account
+        raise NotImplementedError()

api/database/idb_queue.py

@@ -0,0 +1,15 @@
+from abc import ABC, abstractmethod
+
+
+class IQueue(ABC):
+
+    def __init__(self):
+        super().__init__()
+
+    @abstractmethod
+    def enqueue_student(self, student):
+        raise NotImplementedError()
+
+    @abstractmethod
+    def dequeue_student(self):
+        raise NotImplementedError()