Merge pull request #114 from MassiGy/architecture-refactor

Architecture refactor Overall Done

Author: William-McGonagle

res/emails/confirmEmail.html

@@ -10,7 +10,7 @@ <h3 style="text-align:center; padding-bottom:5px;">
     Hey <b>${data.username}</b>,
     <br />
     Please validate your email address on fairfieldprogramming.org by clicking
-    <a href="https://fairfield-programming.herokuapp.com/confirmEmail/${id_token}">this link</a>.
+    <a href="https://fairfield-programming.herokuapp.com/user/confirmEmail/${id_token}">this link</a>.
     <br />
 </p>
 <p>

src/routes/Article/createArticle.js renamed to src/controllers/Article/createArticle.js

@@ -5,7 +5,9 @@ function missingParameters(req) {
   return !title || !description || !body;
 }
 
-module.exports = (req, res) => {
+
+
+module.exports.createArticle = (req, res) => {
   if (missingParameters(req)) res.status(400).send("Not All Parameters Provided.");
   else {
     Article.create(

src/controllers/Article/getAllArticles.js

@@ -0,0 +1,15 @@
+
+
+module.exports.getAllArticles = (req, res) => {
+    Article.findAll(
+      {},
+    )
+      .then((data) => {
+        if (data.length <= 0) return res.status(404).send("Not Found.");
+        return res.json(data);
+      })
+      .catch((error) => {
+        console.log(error);
+        return res.status(500).send("Internal Server Error.");
+      });
+  };

src/controllers/Article/index.js

@@ -0,0 +1,8 @@
+const { createArticle } = require("./createArticle");
+const { getAllArticles } = require("./getAllArticles");
+const { queryArticle } = require("./queryArticle");
+
+
+module.exports.createArticle = createArticle;
+module.exports.getAllArticles = getAllArticles;
+module.exports.queryArticle = queryArticle;

src/controllers/Article/queryArticle.js

@@ -0,0 +1,21 @@
+module.exports.queryArticle = (req, res) => {
+    if (!req.params.id) return res.status(400).send("Not All Parameters Provided.");
+  
+    Article.findOne(
+      {
+        where:
+        {
+          id: req.params.id,
+        },
+      },
+    ).then((data) => {
+      if (!data) return res.status(404).send("Not Found.");
+  
+      return res.json(data);
+    })
+      .catch((error) => {
+        console.log(error);
+        return res.status(500).send("Internal Server Error.");
+      });
+  };
+  

src/routes/Duck/index.js renamed to src/controllers/Duck/getDuck.js

@@ -1,8 +1,9 @@
 const duckGenerator = require("duckgen");
 
-module.exports = (req, res) => {
+module.exports.getDuck = (req, res) => {
   res.set("Content-Type", "image/svg+xml");
   res.send(duckGenerator.formatSVG(duckGenerator.generateDuck(
     {},
   )));
 };
+

src/routes/Duck/id.js renamed to src/controllers/Duck/getDuckById.js

@@ -1,6 +1,6 @@
 const duckGenerator = require("duckgen");
 
-module.exports = (req, res) => {
+module.exports.getDuckById = (req, res) => {
   const duckData = duckGenerator.parseV1String(req.params.id);
   if (!duckData) return res.status(400).send("Bad Request.");
 
@@ -9,5 +9,4 @@ module.exports = (req, res) => {
   return res.send(
     duckGenerator.formatSVG(duckGenerator.generateDuck(duckData)),
   );
-};
- 
+};

src/controllers/Duck/getZoomedDuck.js

@@ -0,0 +1,15 @@
+const duckGenerator = require("duckgen");
+
+module.exports.getZoomedDuck = (req, res) => {
+    // Parse the String
+    const duckData = duckGenerator.parseV1String(req.params.id);
+    if (!duckData) res.status(400).send("Bad Request.");
+    else {
+      const zoomInt = parseInt(req.params.zoom);
+      res.set("Content-Type", "image/svg+xml");
+  
+      res.send(
+        duckGenerator.formatSVG(duckGenerator.generateDuck(duckData), zoomInt),
+      );
+    }
+  };

src/controllers/Duck/index.js

@@ -0,0 +1,7 @@
+const { getDuck } = require("./getDuck");
+const { getDuckById } = require("./getDuckById");
+const { getZoomedDuck } = require("./getZoomedDuck");
+
+module.exports.getDuck = getDuck;
+module.exports.getDuckById = getDuckById;
+module.exports.getZoomedDuck = getZoomedDuck;

src/routes/Events/createEvent.js renamed to src/controllers/Events/createEvent.js

@@ -1,6 +1,6 @@
 const { missingParameters } = require("../../library/eventsUtils");
 
-module.exports = (req, res) => {
+module.exports.createEvent = (req, res) => {
   if (!req.user) return res.status(400).send("Not Logged In.");
 
   if (missingParameters(req)) return res.status(400).send("Not All Parameters Provided.");

src/routes/Events/deleteEvent.js renamed to src/controllers/Events/deleteEvent.js

@@ -1,4 +1,4 @@
-module.exports = (req, res) => {
+module.exports.deleteEvent = (req, res) => {
   if (!req.user) return res.status(403).send("Not Logged In.");
   if (!req.params.id) return res.status(400).send("Not All Parameters Provided.");
 

src/routes/Events/editEvent.js renamed to src/controllers/Events/editEvent.js

@@ -2,7 +2,7 @@ const Events = require("../../models/Events");
 const { missingParameters } = require("../../library/eventsUtils");
 const { DetectVulgarWords } = require("../../library/VulgarTest");
 
-module.exports = (req, res) => {
+module.exports.editEvent = (req, res) => {
   if (!req.user) return res.status(403).send("Not Logged In.");
   if (missingParameters(req)) return res.status(400).send("Not All Parameters Provided.");
 

src/controllers/Events/index.js

@@ -0,0 +1,17 @@
+const { createEvent } = require("./createEvent");
+const { deleteEvent } = require("./deleteEvent");
+const { editEvent } = require("./editEvent");
+const { listEvents } = require("./listEvents");
+const { queryEvent } = require("./queryEvent");
+const { rsvpEvent } = require("./rsvpEvent");
+const { unrsvpEvent } = require("./unrsvpEvent");
+
+
+
+module.exports.createEvent = createEvent;
+module.exports.deleteEvent = deleteEvent;
+module.exports.editEvent = editEvent;
+module.exports.listEvents = listEvents;
+module.exports.queryEvent = queryEvent;
+module.exports.rsvpEvent = rsvpEvent;
+module.exports.unrsvpEvent = unrsvpEvent;

src/routes/Events/listEvents.js renamed to src/controllers/Events/listEvents.js

@@ -1,4 +1,4 @@
-module.exports = (req, res) => {
+module.exports.listEvents = (req, res) => {
   Events.findAll(
     {},
   )

src/routes/Events/queryEvent.js renamed to src/controllers/Events/queryEvent.js

@@ -1,4 +1,4 @@
-module.exports = (req, res) => {
+module.exports.queryEvent = (req, res) => {
   if (!req.params.id) return res.status(400).send("Not All Parameters Provided.");
 
   Events.findOne(

src/routes/Events/rsvpEvent.js renamed to src/controllers/Events/rsvpEvent.js

@@ -1,6 +1,6 @@
 const Events = require("../../models/Events");
 
-module.exports = (req, res) => {
+module.exports.rsvpEvent = (req, res) => {
   if (!req.user) return res.status(403).send("Not Logged In.");
   if (!req.params.id) return res.status(400).send("Not All Parameters Provided.");
 

src/routes/Events/unrsvpEvent.js renamed to src/controllers/Events/unrsvpEvent.js

@@ -1,4 +1,4 @@
-module.exports = (req, res) => {
+module.exports.unrsvpEvent = (req, res) => {
   if (!req.user) return res.status(403).send("Not Logged In.");
   if (!req.params.id) return res.status(400).send("Not All Parameters Provided.");
 

src/controllers/Joke/getAllJokes.js

@@ -0,0 +1,7 @@
+const jokeLib = require("./jokeFinder");
+
+
+module.exports.getAllJokes = (req, res) => {
+    res.set("Access-Control-Allow-Origin", "*");
+    return res.json(jokeLib.getAllJokes());
+};

src/controllers/Joke/getJokeById.js

@@ -0,0 +1,18 @@
+const jokeLib = require("./jokeFinder");
+const { propertyUndefined } = require("../../library/validator");
+
+
+
+module.exports.getJokeById= (req, res) => {
+    res.set("Access-Control-Allow-Origin", "*");
+
+    if (propertyUndefined(req.params.id)) return res.status(400).send("ID Not Given.");
+
+    const numID = parseInt(req.params.id, 10);
+    if (typeof numID !== "number") return res.status(400).send("Poorly Formatted ID.");
+
+    const joke = jokeLib.getJokeAtIndex(numID);
+    if (!joke) return res.status(404).send("Joke Not Found.");
+
+    return res.send(joke);
+};

src/controllers/Joke/getJokeCount.js

@@ -0,0 +1,6 @@
+const jokeLib = require("./jokeFinder");
+
+module.exports.getJokeCount = (req, res) => {
+    res.set("Access-Control-Allow-Origin", "*");
+    return res.send(jokeLib.getJokeCount().toString());
+};

src/controllers/Joke/getRandomJoke.js

@@ -0,0 +1,6 @@
+const jokeLib = require("./jokeFinder");
+
+module.exports.getRandomJoke = (req, res) => {
+    res.set("Access-Control-Allow-Origin", "*");
+    return res.send(jokeLib.getRandomJoke());
+};

src/controllers/Joke/index.js

@@ -0,0 +1,11 @@
+const {getAllJokes} = require("./getAllJokes");
+const {getJokeById} = require("./getJokeById");
+const {getJokeCount} = require("./getJokeCount");
+const {getRandomJoke} = require("./getRandomJoke");
+
+
+
+module.exports.getAllJokes = getAllJokes;
+module.exports.getJokeById = getJokeById;
+module.exports.getJokeCount = getJokeCount;
+module.exports.getRandomJoke = getRandomJoke;

src/routes/Joke/jokeFinder.js renamed to src/controllers/Joke/jokeFinder.js

@@ -1,6 +1,6 @@
 const { verify } = require("jsonwebtoken");
 
-module.exports = async (req, res) => {
+module.exports.confirmEmail = async (req, res) => {
     try {
 
         // get the user id from the jwt on the req.params

src/routes/Joke/jokes.txt renamed to src/controllers/Joke/jokes.txt

@@ -1,7 +1,7 @@
 const { compare } = require("bcrypt");
 const { handleError500 } = require("../../../library/errorHandler");
 
-module.exports = (req, res) => {
+module.exports.deleteAccount = (req, res) => {
   if (!req.params.id) res.status(400).send("Not All Parameters Given.");
   else if (!req.user) res.status(403).send("Not Logged In.");
   else if (req.user.id !== req.params.id) res.status(401).send("Not Authorized.");

src/routes/User/Account/confirmEmail.js renamed to src/controllers/User/Account/confirmEmail.js

@@ -1,4 +1,4 @@
-module.exports = (req, res) => {
+module.exports.getStatus = (req, res) => {
   if (!req.params.id) return res.status(400).send("Not All Parameters Provided.");
 
   User.findOne(
@@ -14,7 +14,7 @@ module.exports = (req, res) => {
 
       res.set("Content-Type", "text/html");
 
-      return res.send(data.status);
+      return res.send(JSON.stringify(data.status));
     })
     .catch((error) => {
       console.log(error);

src/routes/User/Account/deleteAccount.js renamed to src/controllers/User/Account/deleteAccount.js

@@ -1,18 +1,18 @@
+const { compare } = require("bcrypt");
+const { sign } = require("jsonwebtoken");
+
+
 /**
  * @module login
  * HTTP POST Request on "/login" handler
  * @param {Request} req - HTTP POST Request on "/login" 
  * @param {Response} res - HTTP Response 
  * @returns {Response}  HTTP Response
  * @description This route handler will listen to the client request, 
- * check if all parameter are good, look if there is a user in the data base with those credentials
+ * check if all parameter are good, look if there is a user in the database with the passed credentials
  * then if all goes well, send back a cookie to the client.
  */
-
-const { compare } = require("bcrypt");
-const { sign } = require("jsonwebtoken");
-
-module.exports = (req, res) => {
+module.exports.login = (req, res) => {
   if ((!req.body.email && !req.body.username) || !req.body.password) return res.status(400).send("Not All Parameters Given.");
 
   User.findOne({

src/routes/User/Account/getStatus.js renamed to src/controllers/User/Account/getStatus.js

@@ -1,6 +1,6 @@
 const vulgarTester = require("../../../library/VulgarTest");
 
-module.exports = (req, res) => {
+module.exports.setData = (req, res) => {
   if (!req.user) return res.status(403).send("Not Logged In.");
 
   const { biography, profilePicture, username } = req.body;

src/routes/User/Account/login.js renamed to src/controllers/User/Account/login.js

@@ -4,7 +4,7 @@ const {
 } = require("bcrypt");
 const { handleError500 } = require("../../../library/errorHandler");
 
-module.exports = (req, res) => {
+module.exports.setPass = (req, res) => {
   if (!req.params.id || !req.body.password || !req.body.newPassword) return res.status(400).send("Not All Parameters Given.");
 
   if (!req.user) return res.status(403).send("Not Logged In.");

src/routes/User/Account/setData.js renamed to src/controllers/User/Account/setData.js

@@ -1,7 +1,7 @@
 const vulgarTester = require("../../../library/VulgarTest");
 const { handleError500 } = require("../../../library/errorHandler");
 
-module.exports = (req, res) => {
+module.exports.setStatus = (req, res) => {
   if (!req.user) res.status(403).send("Not Logged In.");
   else {
     User.findOne(

src/routes/User/Account/setPass.js renamed to src/controllers/User/Account/setPass.js

@@ -15,7 +15,7 @@ function accountExists(userData) {
   return userData.length > 0;
 }
 
-module.exports = async (req, res) => {
+module.exports.signup = async (req, res) => {
   const { username, email, password } = req.body;
   if (!username || !email || !password) res.status(400).send("Not All Parameters Provided.");
   else if (invalidPassword(password)) res.status(400).send("Password Not Corresponding The Format (between 4 to 14 characters, including both alphanumerical and non-alphanumerical symbols).");

src/routes/User/Account/setStatus.js renamed to src/controllers/User/Account/setStatus.js

@@ -1,4 +1,4 @@
-module.exports = (req, res) => {
+module.exports.blockUser = (req, res) => {
   if (!req.user) return res.status(403).send("Not Logged In.");
   if (!req.params.id || !req.params.blockId) return res.status(400).send("Not All Parameters Provided.");
 

src/routes/User/Account/signup.js renamed to src/controllers/User/Account/signup.js

@@ -1,4 +1,4 @@
-module.exports = (req, res) => {
+module.exports.listBlocked = (req, res) => {
     if (!req.user) return res.status(403).send("Not Logged In.");
     if (!req.params.id || !req.params.blockId) return res.status(400).send("Not All Parameters Provided.");
 

src/routes/User/Block/blockUser.js renamed to src/controllers/User/Block/blockUser.js

@@ -1,4 +1,4 @@
-module.exports = (req, res) => {
+module.exports.queryBlock = (req, res) => {
     if (!req.params.id || !req.params.blockId) return res.status(400).send("Not All Parameters Provided.");
     if (!req.user) return res.status(403).send("Not Logged In");
 

src/routes/User/Block/listBlocked.js renamed to src/controllers/User/Block/listBlocked.js

@@ -1,6 +1,6 @@
 const { handleError500 } = require("../../../library/errorHandler");
 
-module.exports = (req, res) => {
+module.exports.unblockUser = (req, res) => {
   if (!req.user) res.status(403).send("Not Logged In.");
   if (!req.params.id || !req.params.blockId) res.status(400).send("Not All Parameters Provided.");
   else {

src/routes/User/Block/queryBlock.js renamed to src/controllers/User/Block/queryBlock.js

@@ -1,6 +1,6 @@
 const { handleError500 } = require("../../../library/errorHandler");
 
-module.exports = (req, res) => {
+module.exports.followUser = (req, res) => {
   if (!req.user) res.status(403).send("Not Logged In.");
   else if (!req.params.id || !req.params.followerId) res.status(400).send("Not All Parameters Provided.");
   else {

src/routes/User/Block/unblockUser.js renamed to src/controllers/User/Block/unblockUser.js

@@ -1,4 +1,4 @@
-module.exports = (req, res) => {
+module.exports.listFollowers = (req, res) => {
   if (!req.user) return res.status(403).send("Not Logged In.");
   if (!req.params.id) return res.status(400).send("Not All Parameters Provided.");
 

src/routes/User/Followers/followUser.js renamed to src/controllers/User/Followers/followUser.js

@@ -1,4 +1,4 @@
-module.exports = (req, res) => {
+module.exports.queryFollower = (req, res) => {
   if (!req.params.id || !req.params.followerId) return res.status(400).send("Not All Parameters Provided.");
   if (!req.user) return res.status(403).send("Not Logged In");
 

src/routes/User/Followers/listFollowers.js renamed to src/controllers/User/Followers/listFollowers.js

@@ -1,6 +1,6 @@
 const { handleError500 } = require("../../../library/errorHandler");
 
-module.exports = (req, res) => {
+module.exports.unfollowUser = (req, res) => {
   if (!req.user) res.status(403).send("Not Logged In.");
   if (!req.params.id || !req.params.followerId) res.status(400).send("Not All Parameters Provided.");
   else {

src/routes/User/Followers/queryFollower.js renamed to src/controllers/User/Followers/queryFollower.js

@@ -1,4 +1,4 @@
-module.exports = (req, res) => {
+module.exports.countUsers = (req, res) => {
     User.findAll(
       {},
     )