Merge pull request #339 from tcet-opensource/280-megafeat-semester

[Added] Endpoints, APIDOC for Semester

Author: TejasNair9977

_apidoc.js

@@ -666,6 +666,74 @@
  * attainment as per Bloom's Taxanomy (L1-L6).
  */
 
+// ------------------------------------------------------------------------------------------
+// Semester
+// ------------------------------------------------------------------------------------------
+/**
+ * @api {post} /semester/add Request to add Semester information
+ * @apiName Addsemester
+ * @apiGroup Semester
+ *
+ * @apiQuery {Number} [number] Number of semester
+ * @apiQuery {String} [academicYear] To show the current academic year
+ * @apiQuery {String} [type] Stores the enum ODD or EVEN for semester
+ * @apiQuery {Date} [startDate] Start date of the semester
+ * @apiQuery {Date} [endDate] End date of the semester
+ *
+ * @apiSuccess {String} res Response message .
+ * @apiError (Error 500) DatabaseError Err message if there is an error inserting into the database.
+ *
+ */
+
+/**
+ * @api {get} /semester/list Request to list Semester information
+ * @apiName semesterlist
+ * @apiGroup Semester
+ *
+ * @apiQuery {Number} [number] Number of semester
+ * @apiQuery {String} [academicYear] To show the current academic year
+ * @apiQuery {String} [type] Stores the enum ODD or EVEN for semester
+ * @apiQuery {Date} [startDate] Start date of the semester
+ * @apiQuery {Date} [endDate] End date of the semester
+ *
+ * @apiSuccess {semester[]} res Array of Filtered semester Doc.
+ * @apiSuccess {Number} semester.number Number of semester
+ * @apiSuccess {String} semester.academicYear To show the current academic year of the semester
+ * @apiSuccess {String} semester.type Stores the enum ODD or EVEN for semester
+ * @apiSuccess {Date} semester.startDate Start date of the semester
+ * @apiSuccess {Date} semester.endDate End date of the semester
+ *
+ */
+
+/**
+ * @api {update} /semester/update/:id Request to list Semester information
+ * @apiName Updatesemester
+ * @apiGroup Semester
+ *
+ * @apiBody {Number} [number] Number of semester
+ * @apiBody {String} [academicYear] To show the current academic year
+ * @apiBody {String} [type] Stores the enum ODD or EVEN for semester
+ * @apiBody {Date} [startDate] Start date of the semester
+ * @apiBody {Date} [endDate] End date of the semester
+ *
+ *@apiSuccess {String} res Semester updated.
+ * @apiError (Error 500) DatabaseError Error in updating the database.
+ *
+ */
+
+/**
+* @api {delete} /semester/delete/:id Request to list Semester information
+* @apiName Deletesemester
+* @apiGroup Semester
+*
+* @apiParam {String} id The ID of the Semester document to delete.
+*
+* @apiSuccess {String} res Success message indicating the deletion.
+*
+* @apiError (Error 500) DatabaseError Error message if there was an error during the deletion.
+*/
+
+
 // ------------------------------------------------------------------------------------------
 // Activity.
 // ------------------------------------------------------------------------------------------
@@ -813,4 +881,4 @@
  * @apiSuccess {ObjectId} task The task of the activity (ObjectId).One of possible Topic,Practical,Tutorial.
  * @apiSuccess {ObjectId} group The group of the activity (ObjectId).
  * @apiSucess {ObjectId} students the students who gonna attend the activity(ObjectId).
- */
+ */

app.js

@@ -8,6 +8,7 @@ import { logger } from "#util";
 import indexRouter from "#routes/index";
 import usersRouter from "#routes/users";
 import authRouter from "#routes/auth";
+import semesterRouter from "#routes/semester";
 import accreditationRouter from "#routes/accreditation";
 import infrastructureRouter from "#routes/infrastructure";
 import practicalRouter from "#routes/practical";
@@ -55,5 +56,6 @@ app.use("/timetable", timetableRouter);
 app.use("/department", departmentRouter);
 app.use("/coursework", courseworkRouter);
 app.use("/module", moduleRouter);
+app.use("/semester", semesterRouter);
 app.use("/faculty", facultyRouter);
 export default app;

controller/semester.js

@@ -0,0 +1,54 @@
+import {
+  createSemester, updateSemesterById, semesterList, deleteSemesterById,
+} from "#services/semester";
+import { logger } from "#util";
+
+async function addSemester(req, res) {
+  const {
+    number, academicYear, type, startDate, endDate,
+  } = req.body;
+
+  try {
+    const newSemester = await createSemester(number, academicYear, type, startDate, endDate);
+    res.json({ res: `added semester ${newSemester.id} `, id: newSemester.id });
+  } catch (error) {
+    logger.error("Error while inserting", error);
+    res.status(500);
+    res.json({ err: "Error while inserting in DB" });
+  }
+}
+
+async function updateSemester(req, res) {
+  const { id } = req.params;
+  const {
+    ...data
+  } = req.body;
+  try {
+    await updateSemesterById(id, data);
+    res.json({ res: `Updated Semester with id  ${id}` });
+  } catch (error) {
+    logger.error("Error while updating", error);
+    res.status(500);
+    res.json({ err: "Error while updating in DB" });
+  }
+}
+
+async function getSemester(req, res) {
+  const filter = req.query;
+  const semlist = await semesterList(filter);
+  res.json({ res: semlist });
+}
+
+async function deleteSemester(req, res) {
+  const { id } = req.params;
+  try {
+    await deleteSemesterById(id);
+    res.json({ res: `Deleted Semster with id ${id}` });
+  } catch (error) {
+    logger.error("Error while deleting", error);
+    res.status(500).json({ error: "Error while deleting from DB" });
+  }
+}
+export default {
+  addSemester, deleteSemester, getSemester, updateSemester,
+};

models/semester.js

@@ -10,7 +10,7 @@ const semesterSchema = {
       message: (props) => `${props.value} is not a valid year format starting with "2"!`,
     },
   },
-  type: { enum: ["ODD", "EVEN"], required: true },
+  type: { type: String, enum: ["ODD", "EVEN"], required: true },
 
   startDate: { type: Date, required: true },
   endDate: { type: Date, required: true },

routes/semester.js

@@ -0,0 +1,10 @@
+import express from "express";
+import semesterController from "#controller/semester";
+
+const router = express.Router();
+router.post("/add", semesterController.addSemester);
+router.get("/list", semesterController.getSemester);
+router.post("/update/:id", semesterController.updateSemester);
+router.delete("/delete/:id", semesterController.deleteSemester);
+
+export default router;

services/semester.js

@@ -0,0 +1,34 @@
+import Semester from "#models/semester";
+import databaseError from "#error/database";
+
+export async function createSemester(number, academicYear, type, startDate, endDate) {
+  const newSemester = await Semester.create({
+    number, academicYear, type, startDate, endDate,
+  });
+  if (newSemester.number === number) {
+    return newSemester;
+  }
+  throw new databaseError.DataDeleteError("semster");
+}
+
+export async function updateSemesterById(id, data) {
+  const update = await Semester.update({ _id: id }, data);
+
+  if (update) {
+    return update;
+  }
+  throw new databaseError.DataEntryError("semester");
+}
+
+export async function semesterList(filter) {
+  const semlist = await Semester.read(filter, 0);
+  return semlist;
+}
+
+export async function deleteSemesterById(semesterId) {
+  const deleted = await Semester.remove({ _id: semesterId });
+  if (deleted) {
+    return deleted;
+  }
+  throw new databaseError.DataDeleteError("semester");
+}

test/routes/semester.test.js

@@ -0,0 +1,98 @@
+import { jest } from "@jest/globals"; // eslint-disable-line import/no-extraneous-dependencies
+import request from "supertest";
+import app from "#app";
+import connector from "#models/databaseUtil";
+import semesterModel from "#models/semester";
+
+jest.mock("#util");
+
+let server;
+let agent;
+
+beforeAll((done) => {
+  server = app.listen(null, () => {
+    agent = request.agent(server);
+    connector.set("debug", false);
+    done();
+  });
+});
+
+function cleanUp(callback) {
+  semesterModel
+    .remove({
+      number: 3,
+      academicYear: "2023",
+      type: "ODD",
+      startDate: "2023-06-18T14:11:30Z",
+      endDate: "2023-06-18T14:11:30Z",
+    })
+    .then(() => {
+      connector.disconnect((DBerr) => {
+        if (DBerr) console.log("Database disconnect error: ", DBerr);
+        server.close((serverErr) => {
+          if (serverErr) console.log(serverErr);
+          callback();
+        });
+      });
+    });
+}
+
+afterAll((done) => {
+  cleanUp(done);
+});
+
+describe("Semester API", () => {
+  it("Should create semester", async () => {
+    const response = await agent.post("/semester/add").send({
+      number: 3,
+      academicYear: "2023",
+      type: "ODD",
+      startDate: "2023-06-18T14:11:30Z",
+      endDate: "2023-06-18T14:11:30Z",
+    });
+
+    expect(response.status).toBe(200);
+    expect(response.body.res).toMatch(/added semester/);
+  });
+
+  describe("after adding semester", () => {
+    let id;
+    beforeEach(async () => {
+      id = await agent.post("/semester/add").send({
+        number: 3,
+        academicYear: "2023",
+        type: "ODD",
+        startDate: "2023-06-18T14:11:30Z",
+        endDate: "2023-06-18T14:11:30Z",
+      });
+      id = JSON.parse(id.res.text).id;
+    });
+
+    afterEach(async () => {
+      await semesterModel.remove({
+        number: 3,
+        academicYear: "2023",
+        type: "ODD",
+        startDate: "2023-06-18T14:11:30Z",
+        endDate: "2023-06-18T14:11:30Z",
+      });
+    });
+
+    it("should read semester", async () => {
+      const response = await agent
+        .get("/semester/list")
+        .send({ number: 3 });
+      expect(response.status).toBe(200);
+      expect(response.body.res).toBeDefined();
+    });
+
+    it("should update semester", async () => {
+      const response = await agent
+        .post(`/semester/update/${id}`)
+        .send({ number: 3 }, { academicYear: 2024 });
+
+      expect(response.status).toBe(200);
+      expect(response.body.res).toMatch(/Updated Semester/);
+    });
+  });
+});