Merge branch 'development' into 254-topics.endpoints

Author: TejasNair9977

.github/workflows/test.yml

@@ -10,6 +10,7 @@ on:
 env: 
   TOKEN_SECRET: ${{ secrets.TOKEN_SECRET }}
   DB_URL: ${{ secrets.DB_URL }}
+  ENVIRONMENT: ${{ secrets.ENVIRONMENT }}
 
 permissions:
     contents: read

.husky/pre-commit

@@ -0,0 +1,13 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+# npm test
+npx lint-staged
+
+if [ "$(uname)" == "Darwin" ]; then
+    npm run test
+elif [ "$(expr substr $(uname -s) 1 5)" == "Linux" ]; then
+    npm run test   
+elif [ "$(expr substr $(uname -s) 1 5)" == "MINGW" ]; then
+    npm run testWin
+fi

.lintstagedrc.json

@@ -0,0 +1,6 @@
+{
+  "*.js": [
+    "prettier --write",
+    "eslint --fix"
+  ]
+}

_apidoc.js

@@ -672,6 +672,68 @@
  * attainment as per Bloom's Taxanomy (L1-L6).
  */
 
+// ------------------------------------------------------------------------------------------
+// Attendance.
+// ------------------------------------------------------------------------------------------
+
+/**
+ * @api {post} /attendance/add Add Attendance
+ * @apiName AddAttendance
+ * @apiGroup Attendance
+ * @apiDescription Add a new attendance.
+ *
+ * @apiBody {String} student Student name.
+ * @apiBody {String} course Course name.
+ * @apiBody {Number} monthlyAttended Monthly attendance of student.
+ * @apiBody {Number} monthlyOccured Monthly occured.
+ * @apiBody {Number} cumulativeAttended sum of attendance of student.
+ * @apiBody {Number} cumulativeOccured sum of occured.
+ * 
+ * @apiSuccess {String} res Response message.
+ * @apiError (Error 500) UserNotFound The  of the User was not found
+ *
+ * @apiSuccessExample Success-Response:
+ *     HTTP/1.1 200 OK
+ *     {
+ *       "res": "added attendance Example Attendance"
+ *     }
+ *
+ * @apiErrorExample Error-Response:
+ *     HTTP/1.1 500 Internal Server Error
+ *     {
+ *       "err": "Error while inserting in DB"
+ *     }
+ */
+
+// ------------------------------------------------------------------------------------------
+// Exam.
+// ------------------------------------------------------------------------------------------
+
+/**
+ * @api {post} /exam/add Add Exam
+ * @apiName AddExam
+ * @apiExam Exam
+ * @apiDescription Add a new exam.
+ *
+ * @apiBody {String} title Exam title.
+ * @apiBody {ObjectId[]} students Array of student ObjectIDs.
+ *
+ * @apiSuccess {String} res Response message.
+ * @apiError (Error 500) ExamAddError Error while adding the exam
+ *
+ * @apiSuccessExample Success-Response:
+ *     HTTP/1.1 200 OK
+ *     {
+ *       "res": "added exam Example Exam"
+ *     }
+ *
+ * @apiErrorExample Error-Response:
+ *     HTTP/1.1 500 Internal Server Error
+ *     {
+ *       "err": "Error while inserting in DB"
+ *     }
+ */
+
 /**
  * @api {post} /module/add Add Module
  * @apiName AddModule
@@ -854,6 +916,20 @@
  *       "err": "Error while inserting in DB"
  *     }
  */
+
+/**
+ * @api {delete} /attendance/delete/:attendanceId To delete Attendance
+ * @apiName DeleteAttendance
+ * @apiGroup Attendance
+ *
+ * @apiParam {String} attendanceId The ID of the attendance document to delete.
+ *
+ * @apiSuccess {String} res Success message indicating the deletion.
+ *
+ * @apiError (Error 500) err Error message if there was an error during the deletion.
+ *
+* */
+
 // ------------------------------------------------------------------------------------------
 // Practical.
 // ------------------------------------------------------------------------------------------
@@ -983,6 +1059,18 @@
  *     }
  */
 
+/**
+ * @api {delete} /exam/delete/:id Delete Exam
+ * @apiName DeleteExam
+ * @apiExam Exam
+ *
+ * @apiParam {ObjectId} id The ObjectID of the exam to delete.
+ *
+ * @apiSuccess {String} res Success message indicating the deletion.
+ * @apiError (Error 500) ExamDeleteError Error while deleting the exam
+ *
+ */
+
 /**
  * @api {delete} /assignment/delete/:assignmentId To delete Assignment
  * @apiName DeleteAssignment
@@ -996,6 +1084,24 @@
  *
 * */
 
+/**
+ * @api {post} /attendance/update update attendance details
+ * @apiName UpdateAttendance
+ * @apiGroup Attendance
+ * @apiDescription update Existing attendance
+ *
+ * @apiBody {String} [student] Student name.
+ * @apiBody {String} [course] Course name.
+ * @apiBody {Number} [monthlyAttended] Monthly attendance of student.
+ * @apiBody {Number} [monthlyOccured] Monthly occured.
+ * @apiBody {Number} [cumulativeAttended] sum of attendance of student.
+ * @apiBody {Number} [cumulativeOccured] sum of occured.
+ *
+ * @apiSuccess {String} res Attendance updated.
+ * @apiError (Error 500) err Error in updating database
+ *
+ */
+
 /**
  * @api {post} /paper/update/:id Update Paper
  * @apiName UpdatePaper
@@ -1034,6 +1140,42 @@
  *
  */
 
+/**
+ * @api {get} attendance/list Get Attendance List
+ * @apiName GetAttendance
+ * @apiGroup Attendance
+ *
+ * @apiBody {String} [student] Student name.
+ * @apiBody {String} [course] Course name.
+ * @apiBody {Number} [monthlyAttended] Monthly attendance of student.
+ * @apiBody {Number} [monthlyOccured] Monthly occured.
+ * @apiBody {Number} [cumulativeAttended] sum of attendance of student.
+ * @apiBody {Number} [cumulativeOccured] sum of occured.
+ *
+ * @apiSuccess {attendance[]} res Array of Filtered attendance Doc.
+ * @apiSuccess {String} attendance._id ID of document given by database.
+ * @apiSuccess {String} attendance.student Name of student.
+ * @apiSuccess {String} attendance.course Name of course.
+ * @apiSuccess {Number} attendance.monthlyAttended Monthly attendance of student.
+ * @apiSuccess {Number} attendance.cumulativeAttended sum of attendance of student.
+ * @apiSuccess {Number} attendance.cumulativeOccured sum of occured.
+ */
+
+/**
+ * @api {post} /exam/update/:id Update Exam Details
+ * @apiName UpdateExam
+ * @apiExam Exam
+ * @apiDescription Update existing exam details.
+ *
+ * @apiParam {ObjectId} id The ObjectID of the exam to update.
+ * @apiBody {String} [title] Exam title.
+ * @apiBody {ObjectId[]} [students] Array of student ObjectIDs.
+ *
+ * @apiSuccess {String} res Exam updated.
+ * @apiError (Error 500) ExamUpdateError Error in updating database
+ *
+ */
+
 /**
  * @api {get} assignment/list Get Assignment List
  * @apiName GetAssignment
@@ -1185,6 +1327,19 @@
  *
  */
 
+/**
+ * @api {get} /exam/list Get Exam List
+ * @apiName GetExamList
+ * @apiExam Exam
+ *
+ * @apiQuery {String} [title] Title of the exam.
+ *
+ * @apiSuccess {Exam[]} res Array of filtered exam documents.
+ * @apiSuccess {ObjectId} exam._id ObjectID of the exam document in the database.
+ * @apiSuccess {String} exam.title Title of the exam.
+ * @apiSuccess {ObjectId[]} exam.students Array of student ObjectIDs in the exam.
+ */
+
 /**
  * @api {get} /group/list Get Group List
  * @apiName GetGroupList
@@ -1516,6 +1671,7 @@
  * @apiSuccess {String} res Topic updated.
  * @apiError (Error 500) DatabaseError Error in updating the database.
  */
+
 /**
  * @api {post} /faculty/update/:id Update Faculty
  * @apiName UpdateFaculty
@@ -1649,4 +1805,4 @@
  * @apiSuccess {String} res topic updated.
  * @apiError (Error 500) err Error in updating database
  *
- */
+ */

app.js

@@ -23,6 +23,8 @@ import moduleRouter from "#routes/module";
 import facultyRouter from "#routes/faculty";
 import { identifyUser } from "#middleware/identifyUser";
 import departmentRouter from "#routes/department";
+import attendanceRouter from "#routes/attendance";
+import examRouter from "#routes/exam";
 import paperRouter from "#routes/paper";
 import groupRouter from "#routes/group";
 import performarouter from "#routes/performance";
@@ -60,6 +62,8 @@ app.use("/timetable", timetableRouter);
 app.use("/department", departmentRouter);
 app.use("/coursework", courseworkRouter);
 app.use("/module", moduleRouter);
+app.use("/attendance", attendanceRouter);
+app.use("/exam", examRouter);
 app.use("/paper", paperRouter);
 app.use("/group", groupRouter);
 app.use("/semester", semesterRouter);

controller/attendance.js

@@ -0,0 +1,62 @@
+import {
+    addNewAttendance, deleteAttendanceById, updateAttendanceById, getAttendances,
+  } from "#services/attendance";
+  import { logger } from "#util";
+  
+  async function addAttendance(req, res) {
+    const {
+      student, course, monthlyAttended, monthlyOccured, cumulativeAttended, cumulativeOccured,
+    } = req.body;
+    try {
+      // eslint-disable-next-line max-len
+      const attendance = await addNewAttendance( student, course, monthlyAttended, monthlyOccured, cumulativeAttended, cumulativeOccured);
+      res.json({ res: `added attendance ${attendance.student}`, id: attendance.id });
+    } catch (error) {
+      logger.error("Error while inserting", error);
+      res.status(500);
+      res.json({ err: "Error while inserting in DB" });
+    }
+  }
+  async function deleteAttendance(req, res) {
+    const { id } = req.params;
+    try {
+      await deleteAttendanceById(id);
+      res.json({ res: "Attendance deleted successfully" });
+    } catch (error) {
+      logger.error("Error while deleting", error);
+      res.status(500);
+      res.json({ err: "Error while deleting from DB" });
+    }
+  }
+  
+  async function updateAttendance(req, res) {
+    const { id } = req.params;
+    const {
+      ...data
+    } = req.body;
+  
+    try {
+      await updateAttendanceById(id, data);
+      res.json({ res: `${id} attendance updated` });
+    } catch (error) {
+      logger.error("Error while inserting", error);
+      res.status(500);
+      res.json({ err: "Error while inserting in DB" });
+    }
+  }
+  
+  async function showAttendance(req, res) {
+    try {
+      const attendance = await getAttendances(req.query);
+      return res.json({ res: attendance });
+    } catch (error) {
+      logger.error("Error while fetching", error);
+      res.status(500);
+      return res.json({ err: "Error while fetching the data" });
+    }
+  }
+  
+  export default {
+    addAttendance, updateAttendance, deleteAttendance, showAttendance,
+  };
+  

controller/exam.js

@@ -0,0 +1,65 @@
+import {
+  createExam,
+  deleteExamById,
+  examList,
+  updateExamById,
+} from "#services/exam";
+import { logger } from "#util";
+
+async function addExam(req, res) {
+  const {
+    date, startTime, duration, infrastructure, supervisor, course,
+  } = req.body;
+  try {
+    const exam = await createExam(
+      date,
+      startTime,
+      duration,
+      supervisor,
+      infrastructure,
+      course,
+    );
+    res.json({ res: `added exam ${exam.id}`, id: exam.id });
+  } catch (error) {
+    logger.error("Error while inserting", error);
+    res.status(500);
+    res.json({ err: "Error while inserting in DB" });
+  }
+}
+
+async function updateExam(req, res) {
+  const { id } = req.params;
+  const { ...data } = req.body;
+  try {
+    await updateExamById(id, data);
+    res.json({ res: `updated exam with id ${id}` });
+  } catch (error) {
+    logger.error("Error while updating", error);
+    res.status(500);
+    res.json({ err: "Error while updaing in DB" });
+  }
+}
+
+async function getExam(req, res) {
+  const filter = req.query;
+  const exam = await examList(filter);
+  res.json({ res: exam });
+}
+
+async function deleteExam(req, res) {
+  const { id } = req.params;
+  try {
+    await deleteExamById(id);
+    res.json({ res: `Deleted exam with ID ${id}` });
+  } catch (error) {
+    logger.error("Error while deleting", error);
+    res.status(500).json({ error: "Error while deleting from DB" });
+  }
+}
+
+export default {
+  addExam,
+  deleteExam,
+  getExam,
+  updateExam,
+};