Merge branch 'development' into 294-Write-APIDOCs-for-student

TejasNair9977 · web-flow · commit 5fddd20a9596 · 2023-09-30T22:09:34.000+05:30
diff --git a/_apidoc.js b/_apidoc.js
diff --git a/app.js b/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";
@@ -22,6 +23,8 @@ import moduleRouter from "#routes/module";
 import facultyRouter from "#routes/faculty";
 import { identifyUser } from "#middleware/identifyUser";
 import departmentRouter from "#routes/department";
+import paperRouter from "#routes/paper";
+import groupRouter from "#routes/group";
 
 const app = express();
 const currDirName = dirname(fileURLToPath(import.meta.url));
@@ -55,5 +58,9 @@ app.use("/timetable", timetableRouter);
 app.use("/department", departmentRouter);
 app.use("/coursework", courseworkRouter);
 app.use("/module", moduleRouter);
+app.use("/paper", paperRouter);
+app.use("/group", groupRouter);
+app.use("/semester", semesterRouter);
 app.use("/faculty", facultyRouter);
+
 export default app;
diff --git a/controller/group.js b/controller/group.js
@@ -0,0 +1,54 @@
+import {
+  createGroup, deleteGroupById, groupList, updateGroupById,
+} from "#services/group";
+import { logger } from "#util";
+
+async function addGroup(req, res) {
+  const {
+    title, student,
+  } = req.body;
+  try {
+    const group = await createGroup(title, student);
+    res.json({ res: `added group ${group.id}`, id: group.id });
+  } catch (error) {
+    logger.error("Error while inserting", error);
+    res.status(500);
+    res.json({ err: "Error while inserting in DB" });
+  }
+}
+
+async function updateGroup(req, res) {
+  const { id } = req.params;
+  const {
+    ...data
+  } = req.body;
+  try {
+    await updateGroupById(id, data);
+    res.json({ res: `updated group with id ${id}` });
+  } catch (error) {
+    logger.error("Error while updating", error);
+    res.status(500);
+    res.json({ err: "Error while updaing in DB" });
+  }
+}
+
+async function getGroup(req, res) {
+  const filter = req.query;
+  const group = await groupList(filter);
+  res.json({ res: group });
+}
+
+async function deleteGroup(req, res) {
+  const { id } = req.params;
+  try {
+    await deleteGroupById(id);
+    res.json({ res: `Deleted group with ID ${id}` });
+  } catch (error) {
+    logger.error("Error while deleting", error);
+    res.status(500).json({ error: "Error while deleting from DB" });
+  }
+}
+
+export default {
+  addGroup, deleteGroup, getGroup, updateGroup,
+};
diff --git a/controller/paper.js b/controller/paper.js
@@ -0,0 +1,64 @@
+import {
+  createPaper, updatePaperById, listPaper, deletePaperById,
+} from "#services/paper";
+import { logger } from "#util";
+
+async function addPaper(req, res) {
+  const {
+    answerSheetID,
+    exam,
+    student,
+    checkedBy,
+    mark,
+  } = req.body;
+  try {
+    const newPaper = await createPaper(
+      answerSheetID,
+      exam,
+      student,
+      checkedBy,
+      mark,
+    );
+    res.json({ res: `added paper for: ${newPaper.answerSheetID}`, id: newPaper.id });
+  } catch (error) {
+    logger.error("Error while inserting", error);
+    res.status(500);
+    res.json({ err: "Error while inserting in DB" });
+  }
+}
+
+async function updatePaper(req, res) {
+  const { id } = req.params;
+  const { 
+    ...data
+   } = req.body;
+  try {
+    await updatePaperById(id, data);
+    res.json({ res: "Paper updated" });
+  } catch (error) {
+    logger.error("Error while updating", error);
+    res.status(500);
+    res.json({ err: "Error while updating in DB" });
+  }
+}
+
+async function showPaper(req, res) {
+  const filter = req.query;
+  const paper = await listPaper(filter);
+  res.json({ res: paper });
+}
+
+async function deletePaper(req, res) {
+  const { id } = req.params;
+  try {
+    await deletePaperById(id);
+    res.json({ res: `Deleted paper with ID ${id}` });
+  } catch (error) {
+    logger.error("Error while deleting", error);
+    res.status(500).json({ error: "Error while deleting from DB" });
+  }
+}
+
+export default {
+  addPaper, updatePaper, showPaper, deletePaper,
+};
diff --git a/controller/semester.js b/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,
+};
diff --git a/models/group.js b/models/group.js
@@ -19,7 +19,7 @@ async function read(filter, limit = 1) {
 }
 
 async function update(filter, updateObject, options = { multi: true }) {
-  const updateResult = await Group.updateManyupdateMany(filter, { $set: updateObject }, options);
+  const updateResult = await Group.updateMany(filter, { $set: updateObject }, options);
   return updateResult.acknowledged;
 }
 async function remove(groupId) {
diff --git a/models/paper.js b/models/paper.js
@@ -8,7 +8,6 @@ const paperSchema = {
   mark: { type: Number, required: true },
 };
 
-// eslint-disable-next-line  no-unused-vars
 const Paper = connector.model("Paper", paperSchema);
 
 // CRUD OPERATIONS
diff --git a/models/semester.js b/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 },
diff --git a/routes/group.js b/routes/group.js
@@ -0,0 +1,10 @@
+import express from "express";
+import groupController from "#controller/group";
+
+const router = express.Router();
+router.post("/add", groupController.addGroup);
+router.get("/list", groupController.getGroup);
+router.post("/update/:id", groupController.updateGroup);
+router.delete("/delete/:id", groupController.deleteGroup);
+
+export default router;
diff --git a/routes/paper.js b/routes/paper.js
@@ -0,0 +1,11 @@
+import express from "express";
+import paperController from "#controller/paper";
+
+const router = express.Router();
+
+router.post("/add", paperController.addPaper);
+router.get("/list", paperController.showPaper);
+router.post("/update/:id", paperController.updatePaper);
+router.delete("/delete/:id", paperController.deletePaper);
+
+export default router;
diff --git a/routes/semester.js b/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;
diff --git a/services/group.js b/services/group.js
@@ -0,0 +1,33 @@
+import Group from "#models/group";
+import databaseError from "#error/database";
+
+export async function createGroup(title, student) {
+  const newGroup = await Group.create({
+    title, student,
+  });
+  if (newGroup.title === title) {
+    return newGroup;
+  }
+  throw new databaseError.DataEntryError("group");
+}
+
+export async function updateGroupById(id, data) {
+  const updated = await Group.update({ _id: id }, data);
+  if (updated) {
+    return updated;
+  }
+  throw new databaseError.DataEntryError("group");
+}
+
+export async function groupList(filter) {
+  const groups = await Group.read(filter, 0);
+  return groups;
+}
+
+export async function deleteGroupById(groupId) {
+  const deleted = await Group.remove({ _id: groupId });
+  if (deleted) {
+    return deleted;
+  }
+  throw new databaseError.DataDeleteError("group");
+}
diff --git a/services/paper.js b/services/paper.js
@@ -0,0 +1,43 @@
+import Paper from "#models/paper";
+import databaseError from "#error/database";
+
+export async function createPaper(
+  answerSheetID,
+  exam,
+  student,
+  checkedBy,
+  mark,
+) {
+  const newPaper = await Paper.create({
+    answerSheetID,
+    exam,
+    student,
+    checkedBy,
+    mark,
+  });
+  if (newPaper) {
+    return newPaper;
+  }
+  throw new databaseError.DataEntryError("paper");
+}
+
+export async function updatePaperById(id, data) {
+  const updated = await Paper.update({ _id: id }, data);
+  if (updated) {
+    return updated;
+  }
+  throw new databaseError.DataEntryError("paper");
+}
+
+export async function listPaper(filter) {
+  const paper = await Paper.read(filter, 0);
+  return paper;
+}
+
+export async function deletePaperById(paperId) {
+  const deleted = await Paper.remove({ _id: paperId });
+  if (deleted) {
+    return deleted;
+  }
+  throw new databaseError.DataDeleteError("paper");
+}
diff --git a/services/semester.js b/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");
+}
diff --git a/test/routes/group.test.js b/test/routes/group.test.js
diff --git a/test/routes/organization.test.js b/test/routes/organization.test.js
diff --git a/test/routes/paper.test.js b/test/routes/paper.test.js
diff --git a/test/routes/semester.test.js b/test/routes/semester.test.js

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ async function read(filter, limit = 1) {`
`19`	`19`	`}`
`20`	`20`
`21`	`21`	`async function update(filter, updateObject, options = { multi: true }) {`
`22`		`- const updateResult = await Group.updateManyupdateMany(filter, { $set: updateObject }, options);`
	`22`	`+ const updateResult = await Group.updateMany(filter, { $set: updateObject }, options);`
`23`	`23`	`return updateResult.acknowledged;`
`24`	`24`	`}`
`25`	`25`	`async function remove(groupId) {`