Merge pull request #17 from CS3219-AY2425S1/D2-TEMPLATE

Add Question Service to Main Repository

Author: yuxuanleong

Backend/.gitignore

@@ -0,0 +1,26 @@
+QuestionService/.env
+QuestionService/insert_questions_script.py
+
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+QuestionService/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/build
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

Backend/QuestionService/app.js

@@ -0,0 +1,20 @@
+const express = require('express')
+const mongoose = require('mongoose')
+const cors = require('cors')
+const dotenv = require("dotenv")
+const questionRouter = require("./controllers/questions")
+
+dotenv.config()
+
+const app = express()
+app.use(cors())
+app.use(express.json())
+
+const mongoURI = `mongodb+srv://${process.env.DB_USERNAME}:${process.env.DB_PASSWORD}@cs3219.rrxz3.mongodb.net/Question-User-DB?retryWrites=true&w=majority&appName=CS3219`
+mongoose.connect(mongoURI)
+.then(() => console.log('MongoDB connected'))
+.catch(err => console.error('MongoDB connection error:', err));
+
+app.use('/api/questions', questionRouter)
+
+module.exports = app

Backend/QuestionService/controllers/questions.js

@@ -0,0 +1,103 @@
+const questionsRouter = require('express').Router()
+const QuestionModel = require('../models/Questions')
+
+// Read all questions
+questionsRouter.get("/", async (req, res) => {
+    try {
+        const questions = await QuestionModel.find();
+        res.status(200).json(questions);
+    } catch (error) {
+        res.status(500).json({error: error.message});
+    }
+})
+
+// Create a new question
+questionsRouter.post("/", async (req, res) => {
+  console.log('Incoming Data:', req.body)
+  try {
+      const maxQuestion = await QuestionModel.findOne().sort({ id: -1 }).exec()
+      const maxId = maxQuestion ? maxQuestion.id : 0
+
+      const newQuestion = new QuestionModel({
+          category: req.body.category,
+          complexity: req.body.complexity,
+          description: req.body.description,
+          id: maxId + 1,
+          title: req.body.title
+      })
+
+      // Save the new question
+      await newQuestion.save()
+      res.status(201).json(newQuestion)
+  } catch (error) {
+      if (error.code === 11000) {
+          // Check for duplicate key in MongoDB
+          return res.status(400).json({ error: "This title is already in use." })
+      } else if (error.name === "ValidationError" || error.name === "CastError") {
+          const errors = Object.values(error.errors).map(err => err.message)
+          return res.status(400).json({ error: errors })
+      }
+      res.status(500).json({ error: error.message })
+  }
+})
+
+// Read a specific question 
+questionsRouter.get("/:id", async (req, res) => {
+
+    const id = req.params.id;
+
+    console.log("Fetching Question with ID:", id);
+
+    try {
+        const question = await QuestionModel.findById(id);
+
+        if (!question) {
+            return res.status(404).json({error: 'Question not found'});
+        }
+        console.log("Data found: ", question);
+        res.status(200).json(question);
+    } catch (error) {
+        res.status(500).json({error: error.message});
+    }
+})
+
+questionsRouter.put("/:id", async (req, res) => {
+    try {
+        const question = await QuestionModel.findByIdAndUpdate(req.params.id, req.body, { new: true, runValidators: true });
+        if (!question) return res.status(404).json({ error: "Question not found" });
+        res.status(200).json(question);
+    } catch (error) {
+        
+        if (error.code === 11000) {
+            // Check for duplicate key in MongoDB
+            return res.status(400).json({ error: "This title is already in use. " });
+        } else if (error.name === "ValidationError" || error.name === "CastError" ) {
+            const errors = Object.values(error.errors).map(err => err.message);
+            return res.status(400).json({ error: errors });
+        }
+        res.status(500).json({ error: error.message });
+    }
+});
+
+
+// Delete a question 
+questionsRouter.delete("/:id", async (req, res) => {
+    const id = req.params.id;
+
+    try {
+        const question = await QuestionModel.findByIdAndDelete({_id: id});
+        if (!question) {
+            return res.status(404).json({error: 'Question not found '});
+        }
+        res.status(200).json({message: 'Question deleted'});
+    } catch (error) {
+        res.status(500).json({ error: error.message });
+    }
+})
+
+module.exports = questionsRouter
+
+
+
+
+

Backend/QuestionService/index.js

@@ -0,0 +1,6 @@
+const app = require('./app')
+
+// Change the port number to listen to a different port but remember to change the port number in frontend too!
+app.listen(3001, () => {
+    console.log("Server is Running")
+})

Backend/QuestionService/models/Questions.js

@@ -0,0 +1,47 @@
+// Create Question Model Here 
+const mongoose = require('mongoose');
+
+const QuestionSchema = new mongoose.Schema({
+    category: {
+        type: [String],
+        required: [true, "Category is required. "],
+        validate: {
+            validator: function (v) {
+                return v.length > 0; 
+            },
+            message: "Category cannot be empty. "
+        },
+    },
+    complexity: {
+        type: String,
+        required: [true, "Please indicate the level of complexity. "]
+    },
+    description: {
+        type: String,
+        required: [true, "Description is required. "],
+        validate: {
+            validator: function (v) {
+                return v && v.trim().length > 0; 
+            },
+            message: "Description cannot be empty. "
+        }
+    },
+    id: Number,
+    title: {
+        type: String,
+        required: [true, "Title is required. "],
+        unique: true,
+        validate: {
+            validator: function (v) {
+                return v && v.trim().length > 0; 
+            },
+            message: "Title cannot be empty. "
+        }
+    }
+});
+
+
+// We create a model with the name 'Question', a schema 'QuestionSchema', and specifically looking at 'Questions' cluster in
+// the 'Question-User-DB' database 
+const QuestionModel = mongoose.model('Question', QuestionSchema, 'Questions');
+module.exports = QuestionModel;