Merge pull request #108 from MassiGy/master

npm uninstall cookie

Author: William-McGonagle

package-lock.json

@@ -20,7 +20,6 @@
   "license": "MIT",
   "dependencies": {
     "bcrypt": "^5.0.0",
-    "cookie": "^0.4.2",
     "cookie-parser": "^1.4.6",
     "cors": "^2.8.5",
     "dotenv": "^10.0.0",

package.json

@@ -0,0 +1,26 @@
+const nodemailer = require("nodemailer");
+
+const transporter = nodemailer.createTransport({
+    service: 'gmail',
+    auth: {
+      user: '[email protected]',
+      pass: process.env.GMAIL_APP_PASS,
+    },
+  });
+
+
+/**
+ * Mailer is an abstraction layer that allows us to send emails using node-mailer under the hood. 
+ * @param {String} mailMarkup - html based markup
+ * @param {String} receivers  - a comma sperated list of email addresses
+ * @param {String} mailSubject - the mail subject
+ */
+
+module.exports.mailer = function(mailMarkup, receivers, mailSubject) {
+    transporter.sendMail({
+        from: '"Fairfield Programming Association" <[email protected]>', // sender address
+        to: receivers, // list of receivers
+        subject: mailSubject, // Subject line
+        html: mailMarkup,
+      });
+}

src/helpers/mailer.js

@@ -17,7 +17,13 @@ app.use(express.json());
 app.use(require("cors")({ origin: "https://fairfieldprogramming.org" }));
 
 
-
+/**
+ *  Verfies if the user has a confimed email address, otherwise send an error message
+ * @param {Request} req HTTP Request
+ * @param {Response} res HTTP Response
+ * @param {Middelware} next calls the next middelware
+ * @returns {Response}
+ */
 
 const verifyEmail = async (req, res, next) => {
   try {
@@ -30,6 +36,13 @@ const verifyEmail = async (req, res, next) => {
   }
 }
 
+/**
+ *  Verfies if the user is logged in, otherwise redirect to "/login"
+ * @param {Request} req HTTP Request
+ * @param {Response} res HTTP Response
+ * @param {Middelware} next calls the next middelware
+ * @returns {Response}
+ */
 
 const verifyLogin = (req, res, next) => {
   if (req.cookies.token) {
@@ -84,8 +97,8 @@ app.post('/user/:id/block/:blockId/block', verifyLogin, verifyEmail, require('./
 app.post('/user/:id/block/:blockId/undo', verifyLogin, verifyEmail, require('./routes/User/Block/unblockUser'));
 
 // Follow Endpoints
-app.get('/user/:id/followers', require('./routes/User/Followers/listFollowers'));
-app.get('/user/:id/followers/:followerId', require('./routes/User/Followers/queryFollower'));
+app.get('/user/:id/followers', verifyLogin, require('./routes/User/Followers/listFollowers'));
+app.get('/user/:id/followers/:followerId', verifyLogin, require('./routes/User/Followers/queryFollower'));
 
 app.post('/user/:id/followers/:followerId/follow', verifyLogin, verifyEmail, require('./routes/User/Followers/followUser'));
 app.post('/user/:id/followers/:followerId/undo', verifyLogin, verifyEmail, require('./routes/User/Followers/unfollowUser'));

src/index.js

@@ -1,3 +1,14 @@
+/**
+ * @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
+ * then if all goes well, send back a cookie to the client.
+ */
+
 const { compare } = require("bcrypt");
 const { sign } = require("jsonwebtoken");
 
@@ -23,7 +34,6 @@ module.exports = (req, res) => {
           if (!result) return res.status(403).send("Invalid Credentials.");
 
           if (err) {
-            console.log(err);
             return res.status(500).send("Internal Server Error.");
           }
 
@@ -43,7 +53,6 @@ module.exports = (req, res) => {
       );
     })
     .catch((error) => {
-      console.log(error);
       return res.status(500).send("Internal Server Error.");
     });
 };

src/routes/User/Account/login.js

@@ -2,8 +2,7 @@ const fs = require("fs");
 const path = require("path");
 const { hash } = require("bcrypt");
 const { sign } = require("jsonwebtoken");
-const cookie = require("cookie");
-const nodemailer = require("nodemailer");
+const { mailer } = require("../../../helpers/mailer");
 const
   {
     invalidPassword,
@@ -58,35 +57,26 @@ module.exports = async (req, res) => {
                   );
 
                   const id_token = sign({ id: data.id }, process.env.EMAIL_TOKEN, { expiresIn: "4 days", });
-                  let transporter = nodemailer.createTransport({
-                    service: 'gmail',
-                    auth: {
-                      user: '[email protected]',
-                      pass: process.env.GMAIL_APP_PASS,
-                    },
-                  });
+
 
                   let emailData = fs.readFileSync(path.join(process.cwd(), "/res/emails/confirmEmail.html"), 'ascii');
 
-                  emailData = emailData.replace("${data.username}", data.email);
+                  emailData = emailData.replace("${data.username}", data.username);
                   emailData = emailData.replace("${id_token}", id_token);
 
-                  // send mail with defined transport object
-                  transporter.sendMail({
-                    from: '"Fairfield Programming Association" <[email protected]>', // sender address
-                    to: `${data.email}`, // list of receivers
-                    subject: "Confirm Your Email Address", // Subject line
-                    html: emailData,
-                  });
+                  // send the email 
+                  mailer(emailData, String(data.email), "Confirm Your Email Address")
 
-                  res.json({ token: sign(
-                    {
-                      id: data.id,
-                      username: data.username,
-                      email: data.email,
-                    },
-                    process.env.JWT_KEY,
-                  ) });
+                  res.json({
+                    token: sign(
+                      {
+                        id: data.id,
+                        username: data.username,
+                        email: data.email,
+                      },
+                      process.env.JWT_KEY,
+                    )
+                  });
 
                 }
                 )

src/routes/User/Account/signup.js

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