Small tweaks from feedback and API planning for visit stealing

Redirect to queue on home page when logged in, add a 404 page, "Start Visit" instead of "Call"

Author: jbcarras

api/queue/controller.py

@@ -46,3 +46,25 @@ def remove_from_queue_without_visit(student, reason):
     db.end_visit(visit, reason)
     return True
 
+def get_tas_visit(ta):
+
+    in_progress = db.get_in_progress_visits()
+    in_progress = list(filter(lambda v: v["ta_id"] == ta, in_progress))
+
+    if len(in_progress) == 0:
+        return None
+
+    visit = in_progress[0]
+    student = db.lookup_identifier(visit["student_id"])
+
+    return {
+        "id": visit["student_id"],
+        "username": student["ubit"],
+        "pn": student["person_num"],
+        "preferred_name": student["preferred_name"],
+        "visitID": visit["visit_id"],
+        "visit_reason": visit["student_visit_reason"]
+    }
+
+
+

api/queue/routes.py

@@ -4,7 +4,7 @@
 
 import api.queue.controller as controller
 from api.auth.controller import get_user
-from api.queue.controller import remove_from_queue_without_visit
+from api.queue.controller import remove_from_queue_without_visit, get_tas_visit
 from api.roster.controller import min_level
 from api.database.db import db
 
@@ -121,23 +121,73 @@ def restore_visit():
 
     user_id = user["user_id"]
 
+    return get_tas_visit(user_id)
+
+@blueprint.route("/active-visits", methods=["GET"])
+@min_level('ta')
+def get_active_visits():
     in_progress = db.get_in_progress_visits()
-    in_progress = list(filter(lambda v: v["ta_id"] == user_id, in_progress))
 
-    if len(in_progress) == 0:
-        return {"message": "You have no in-progress visits."}, 404
+    visits = []
+
+    for visit in in_progress:
+        student = db.lookup_identifier(visit["student_id"])
+
+        if visit["ta_id"] is not None:
+            ta = db.lookup_identifier(visit["ta_id"])
+            ta_name = ta["preferred_name"]
+        else:
+            ta_name = None
+
+        visits.append({
+            "student_id": visit["student_id"],
+            "student_username": student["ubit"],
+            "student_name": student["preferred_name"],
+            "visitID": visit["visit_id"],
+            "visit_reason": visit["student_visit_reason"],
+            "ta_id": visit["ta_id"],
+            "ta_name": ta_name
+        })
+
+@blueprint.route("/visits/<id>", methods=["GET"])
+@min_level('instructor')
+def get_visit(visit_id):
+    """
+    Retrieve all information about the specified visit.
+
+    """
+
+    pass
+
+@blueprint.route("/steal-visit/<id>", methods=["PATCH"])
+@min_level('ta')
+def steal_visit(visit_id):
+    """
+    Replace the TA associated with the visit with the TA who sent
+    the request. Returns all information about the visit being stolen.
+
+    Does not work on visits that are not in progress, or if the TA
+    has an active visit.
+
+    """
+
+    pass
+
+@blueprint.route("/abandon-visit", methods=["PATCH"])
+@min_level('ta')
+def abandon_visit():
+    """
+    Abandon the visit associated with the TA who sent the request.
+    Does not end the visit.
+
+    Returns an error if the TA isn't in an active visit. Future retrievals
+    of this visit should return "None" as the TA's ID and name.
+
+
+    """
+    pass
 
-    visit = in_progress[0]
-    student = db.lookup_identifier(visit["student_id"])
 
-    return {
-        "id": visit["student_id"],
-        "username": student["ubit"],
-        "pn": student["person_num"],
-        "preferred_name": student["preferred_name"],
-        "visitID": visit["visit_id"],
-        "visit_reason": visit["student_visit_reason"]
-    }
 
 @blueprint.route("/help-a-student", methods=["POST"])
 @min_level("ta")

api/server.py

@@ -6,7 +6,6 @@
 import datetime
 import io
 import os
-
 import requests
 from flask import Flask, render_template, request, redirect
 from flask import send_file

client/src/App.vue

@@ -1,6 +1,6 @@
 <script setup lang="ts">
 
-
+	
 
 </script>
 
@@ -15,4 +15,4 @@
 @import "assets/css/base.css";
 
 
-</style>
+</style>

client/src/assets/makeopenhorse.png

@@ -3,12 +3,11 @@
 const props = defineProps(['user_id', 'username', 'pn', 'preferred_name',
                             'last_name', 'course_role'])
 
-
 </script>
 
 <template>
           <tr>
-            <td>{{ username }}</td>
+            <td contenteditable="true" @input="() => { console.log(username) }">{{ username }}</td>
             <td>{{ pn }}</td>
             <td>{{ preferred_name }}</td>
             <td>{{ last_name }}</td>

client/src/components/EnrollmentEntry.vue

@@ -15,7 +15,7 @@ const dropdownVisible = ref<boolean>(false);
       <div @click='dropdownVisible = !dropdownVisible' class="queue-entry">
       <div class="queue-entry-info">{{ name }} ({{ ubit }})</div>
       <div class="queue-entry-buttons">
-        <button @click="$emit('call-student', id)">Call</button>
+        <button @click="$emit('call-student', id)">Start Visit</button>
         <button @click="$emit('remove-student', id)">Remove</button>
         <button @click="$emit('move-to-end', id)">Move to End</button>
       </div>

client/src/components/QueueEntry.vue

@@ -9,6 +9,7 @@ import ManageCourse from "@/pages/ManageCourse.vue";
 import Swipe from "@/pages/Swipe.vue";
 import SwipeAuth from "@/pages/SwipeAuth.vue";
 import AppLayout from "@/layouts/AppLayout.vue";
+import NotFound from "@/pages/NotFound.vue";
 
 const router = createRouter({
     history: createWebHistory(),
@@ -18,7 +19,8 @@ const router = createRouter({
         { path: '/queue', component: AppLayout, children: [{path: '/queue', component: Queue}]},
         { path: '/manage', component: AppLayout, children: [{path: '/manage', component: ManageCourse}]},
         { path: '/swipe', component: Swipe},
-        { path: '/swipe-auth', component: SwipeAuth}
+        { path: '/swipe-auth', component: SwipeAuth},
+        { path: '/:pathMatch(.*)*', component: AppLayout, children: [{path: '/:pathMatch(.*)*', component: NotFound}]}
     ]
 })
 

client/src/main.ts

@@ -9,6 +9,12 @@ const router = useRouter()
 
 const autolabLink = ref<HTMLAnchorElement>();
 
+fetch("/api/me").then(res => {
+  if (res.ok) {
+    router.push("/queue")
+  }
+})
+
 </script>
 
 <template>

client/src/pages/Home.vue

@@ -0,0 +1,37 @@
+<script setup lang="ts">
+
+import {useRouter} from "vue-router";
+
+const router = useRouter()
+
+</script>
+
+<template>
+  <div id="content">
+    <img src="../assets/makeopenhorse.png" alt="Make Open Horse logo" class="big-logo">
+    <p>Couldn't find what you were looking for. (Unless it was this horse)</p>
+    <button class="no-grow" @click="router.push('/')">Go Home</button>
+  </div>
+</template>
+
+<style scoped>
+
+  #content {
+    margin: 16px;
+    display: flex;
+    flex-direction: column;
+    justify-content: center;
+    text-align: center;
+    gap: 8px;
+  }
+
+  .big-logo {
+    margin: auto;
+    max-height: 65vh;
+  }
+
+  button {
+    margin: auto;
+  }
+
+</style>