feature(verification): send verification email

[starts #167164980]

.env.sample

@@ -1,6 +1,7 @@
 NODE_ENV=
 PORT=
 SECRET_KEY=
+VERIFY_SECRET =
 DATABASE_URL_DEV=
 DATABASE_URL_TEST=
 SERVER_URL=

docs/swagger.yaml

@@ -69,7 +69,50 @@ paths:
         409:
           description: resource already exists
         500:
-          description: internal server error                  
+          description: internal server error            
+  /auth/verify/{token}/{id}:
+    get:
+      tags:
+      - Users
+      summary: "Verifies user account"
+      description: "Verifies user account"
+      parameters:
+      - name: "token"
+        in: "path"
+        description: "Token sent to email of user to be verified."
+        required: true
+        schema:
+          $ref: '#/components/schemas/token'
+
+      - name: "id"
+        in: "path"
+        description: "ID of user to be verified."
+        required: true
+        schema:
+          $ref: '#/components/schemas/token'
+
+
+      responses:
+        200:
+          description: "successful operation"
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/veriryUserSuccess"
+        401:
+          description: "Invalid token, User with ID does not exist, Token does not exit in the database"
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/verifyUserFailure1"
+
+        400:
+          description: "Already verified user"
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/verifyUserFailure2"
+
   /auth/forgotpassword:
     post:
       summary: Forgot password
@@ -103,6 +146,26 @@ paths:
                 $ref: '#/components/schemas/StandardServerResponse'
 components:
   schemas:
+    token:
+      type: string
+    veriryUserSuccess:
+      type: object
+      properties:
+        message:
+          type: string
+          example: "You have sucessfully verified your email"
+    verifyUserFailure1:
+      type: object
+      properties:
+        error:
+          type: string
+          example: "Sorry could not verify email"
+    verifyUserFailure2:
+      type: object
+      properties:
+        error:
+          type: string
+          example: "User already verified"
     User:
       required:
       - firstName

src/controllers/AuthController.js

@@ -1,9 +1,13 @@
 import jwt from 'jsonwebtoken';
 import helpers from '../helpers';
 import services from '../services';
+import models from '../database/models';
+import responseMsg from '../helpers/responseHelper';
 
 const { forgotPasswordMessage } = helpers;
 const { sendMail, findUser } = services;
+const { User } = models;
+const { responseMessage } = responseMsg;
 
 /**
  *
@@ -12,6 +16,7 @@ const { sendMail, findUser } = services;
  * @param {object} response
  * @returns {json} - json
  */
+
 const forgotPassword = async (request, response) => {
   const { email } = request.body;
   try {
@@ -31,6 +36,53 @@ const forgotPassword = async (request, response) => {
   }
 };
 
-export default {
-  forgotPassword
+/**
+ * Update user verified status
+ *
+ * @param {object} req
+ * @param {object} res
+ * @returns {json} - json
+ */
+
+const updateStatus = async (req, res) => {
+  const user = await User.findOne({ where: { id: req.params.id } });
+  const secret = process.env.ACCOUNT_VERIFICATION_SECRET;
+  const token = await jwt.verify(req.params.token, secret, (err, decoded) => {
+    if (err) {
+      return err;
+    }
+    return decoded;
+  });
+
+  if (!user) {
+    return responseMessage(res, 401, { error: 'Sorry could not verify email' });
+  }
+  const { verifiedToken } = user;
+
+  if (token.name) {
+    if (token.name === 'TokenExpiredError') {
+      return responseMessage(res, 401, { error: 'Session has expired you can request for another one' });
+    }
+    return responseMessage(res, 401, { error: 'Sorry could not verify email' });
+  }
+
+  if (verifiedToken !== req.params.token) {
+    return responseMessage(res, 401, { error: 'Sorry could not verify email' });
+  }
+
+  const { isVerified } = user.dataValues;
+  if (isVerified === 'true') {
+    return responseMessage(res, 400, { error: 'user already verified' });
+  }
+
+  await User.update({
+    isVerified: 'true',
+  }, {
+    where: {
+      id: req.params.id,
+    }
+  });
+  return responseMessage(res, 200, { message: 'You have sucessfully verified your email' });
 };
+
+export default { forgotPassword, updateStatus };

src/controllers/userController.js

@@ -1,5 +1,6 @@
 import models from '../database/models';
 import helpers from '../helpers/index';
+import verifyUser from '../helpers/verifyUser';
 
 const { authHelper, responseHelper } = helpers;
 
@@ -24,7 +25,7 @@ const signUp = async (req, res) => {
         message: 'user with email already exists'
       }]
     };
-    return responseHelper.successResponse(res, 409, data);
+    return responseHelper.responseMessage(res, 409, data);
   }
 
   if (foundUsername) {
@@ -34,7 +35,7 @@ const signUp = async (req, res) => {
         message: 'username already taken'
       }]
     };
-    return responseHelper.successResponse(res, 409, data);
+    return responseHelper.responseMessage(res, 409, data);
   }
 
   const user = {
@@ -46,6 +47,11 @@ const signUp = async (req, res) => {
   };
 
   const createdUser = await models.User.create(user);
+  await verifyUser({
+    id: createdUser.id,
+    email: createdUser.email,
+    firstName: createdUser.firstName
+  });
 
   return res.status(201).json({
     status: res.statusCode,

src/database/migrations/20190724090213-create-user.js

@@ -59,6 +59,10 @@ export const up = (queryInterface, Sequelize) => queryInterface.createTable('Use
     type: Sequelize.INTEGER,
     defaultValue: 1
   },
+  verifiedToken: {
+    allowNull: true,
+    type: Sequelize.STRING,
+  },
   createdAt: {
     allowNull: false,
     type: Sequelize.DATE

src/database/models/index.js

@@ -33,6 +33,5 @@ Object.keys(db).forEach((modelName) => {
 });
 
 db.sequelize = sequelize;
-db.Sequelize = Sequelize;
 
 export default db;

src/database/models/user.js

@@ -50,6 +50,10 @@ export default (sequelize, DataTypes) => {
       type: DataTypes.BOOLEAN,
       defaultValue: false
     },
+    verifiedToken: {
+      allowNull: true,
+      type: DataTypes.STRING
+    },
     paymentStatus: {
       allowNull: false,
       type: DataTypes.BOOLEAN,

src/helpers/emailMessages.js

@@ -23,6 +23,33 @@ const forgotPasswordMessage = (firstName, token) => {
   return message;
 };
 
-export default {
-  forgotPasswordMessage
+/**
+ * verify user email page
+ * @name page
+ * @param {object} info
+ * @returns {string} html page
+ */
+
+const VerifyAccountEmailPage = (info) => {
+  const [firstName, url] = info;
+  return `
+<html>
+    <head>
+        <link href="https://fonts.googleapis.com/css?family=Courgette&display=swap" rel="stylesheet">
+        <link href="https://fonts.googleapis.com/css?family=Courgette|Roboto&display=swap" rel="stylesheet">
+        <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.8.1/css/all.css" integrity="sha384-50oBUHEmvpQ+1lW4y57PTFmhCaXp0ML5d60M1M7uH2+nqUivzIebhndOJK28anvf" crossorigin="anonymous">
+    </head>
+    <body>
+        <div style="border: 1px solid #E5E5E5; text-align: center; width: 550px; height: 300px">
+            <h1 style="font-family: 'Roboto', sans-serif; font-weight:normal; text-align: left; margin-left: 25px"><i style="color: #73C81F; margin-right:7px" class="fas fa-feather"></i>Authors Haven</h1>
+            <h3 style="font-weight: normal; font-family: 'Roboto', sans-serif; normal">Welcome, ${firstName}</h3>
+            <p style="font-family: 'Roboto', sans-serif">You’ve  sucessfully signed up to Authors Haven</p>
+            <p style="font-weight: bold; font-family:'Courgette', cursive">Share your ideas, get reviews and request collaborations</p>
+            <p style="font-weight: bold; font-family:'Courgette', cursive">Bring your ideas to life</p>
+            <a href = "${url}" style="font-family:'Roboto', sans-serif;  margin: 10px auto auto auto; color: black; display: block; width: 120px; border: 1px solid #73C81F; text-decoration: none; padding:14px; text-transform: uppercase">Confirm Email</a>
+        </div>
+    </body>
+</html>`;
 };
+
+export default { forgotPasswordMessage, VerifyAccountEmailPage };

src/helpers/responseHelper.js

@@ -5,7 +5,7 @@
    * @param {Object} data - application resource
    * @returns {Object} custom response
    */
-const successResponse = (res, statusCode, data) => res.status(statusCode).json(data);
+const responseMessage = (res, statusCode, data) => res.status(statusCode).json(data);
 
 /**
    * helper for sending server success messages
@@ -16,4 +16,4 @@ const successResponse = (res, statusCode, data) => res.status(statusCode).json(d
    */
 const errorResponse = (res, statusCode, error) => res.status(statusCode).json(error);
 
-export default { successResponse, errorResponse };
+export default { responseMessage, errorResponse };

src/helpers/verifyUser.js

@@ -0,0 +1,42 @@
+import jwt from 'jsonwebtoken';
+import pages from './emailMessages';
+import mailer from '../services/sendMail';
+import model from '../database/models';
+
+const { User } = model;
+const { VerifyAccountEmailPage } = pages;
+
+/**
+ * supplies subject and html page for email
+ * @name msg
+ * @param {Array} userName
+ * @returns {object} subject and html page for email
+ */
+
+const msg = (...userName) => ({
+  subject: 'Authors Haven - Verify Token',
+  html: VerifyAccountEmailPage(userName),
+});
+
+/**
+ * verify user helper function
+ * @name verifyUser
+ * @param {object} info
+ */
+
+const verifyUser = async (info) => {
+  const { id, firstName, email } = info;
+  const token = jwt.sign({ id }, process.env.ACCOUNT_VERIFICATION_SECRET, { expiresIn: '5h' });
+  await User.update({
+    verifiedToken: token
+  }, {
+    where: {
+      id,
+    }
+  });
+  const url = `http://127.0.0.1:3000/api/v1/auth/verify/${token}/${id}`;
+  const message = msg(firstName, url);
+  mailer('williamsohworuka@gmail.com', email, message);
+};
+
+export default verifyUser;

src/index.js

@@ -6,8 +6,11 @@ import debug from 'debug';
 import swaggerUi from 'swagger-ui-express';
 import YAML from 'yamljs';
 import path from 'path';
+import dotenv from 'dotenv';
 import routes from './routes';
 
+dotenv.config();
+
 const isProduction = process.env.NODE_ENV === 'production';
 const isTest = process.env.NODE_ENV === 'test';
 

src/routes/index.js

@@ -1,9 +1,10 @@
 import express from 'express';
 import user from './user';
 import auth from './auth';
+import verifyEmail from './verifyEmail';
 
 const router = express.Router();
 
-router.use('/', user, auth);
+router.use('/', user, auth, verifyEmail);
 
 export default router;

src/routes/verifyEmail.js

@@ -0,0 +1,10 @@
+import express from 'express';
+import AuthController from '../controllers/AuthController';
+
+const { updateStatus } = AuthController;
+const Router = express.Router();
+
+const verifyBaseRoute = '/auth';
+Router.get(`${verifyBaseRoute}/verify/:token/:id`, updateStatus);
+
+export default Router;

tests/auth.spec.js

@@ -4,6 +4,7 @@ import sinon from 'sinon';
 import server from '../src';
 import models from '../src/database/models';
 import mockData from './mockData';
+import mail from '../src/services/index';
 
 chai.use(chaiHttp);
 const { expect } = chai;
@@ -70,6 +71,8 @@ describe('AUTH', () => {
   // Forgot password route
   describe('Forgot password', () => {
     it('should sucessfully return an appropiate message after sending a mail to the user', (done) => {
+      const stub = sinon.stub(mail, 'sendMail');
+      stub.returns({});
       chai.request(server)
         .post(FORGOT_PASSWORD_URL)
         .send(forgotPasswordEmail)
@@ -104,6 +107,7 @@ describe('AUTH', () => {
           expect(response).to.have.status(500);
           expect(response.body).to.be.an('object');
           expect(response.body.error).to.equal('error occured!');
+          stub.restore();
           done();
         });
     });

tests/mockData/userMock.js

@@ -99,7 +99,7 @@ export default {
     password: 'Password'
   },
   forgotPasswordEmail: {
-    email: 'eden@gmail.com'
+    email: 'lordvader@order66.com'
   },
   wrongForgotPasswordEmail: {
     email: 'example@gmail.com'