[feature #167727322] Users should be able to comment on requests

- Write create and get comments route - Validate data - Create model, migration and seeder file - Save trip comment - Get comments to owner trip request - Write swagger documentation - Write tests for feature [finishes #167727322]
andela · Sep 11, 2019 · f346d57 · f346d57
1 parent d382d18
commit f346d57
Show file tree

Hide file tree

Showing 23 changed files with 550 additions and 9,086 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/src/controllers/tripController.js b/src/controllers/tripController.js
@@ -1,10 +1,13 @@
 import {
-  postTrip, updateTripStatus, getRequesterEmail
+  postTrip, updateTripStatus, getRequesterEmail, findTripById,
+  findUserTrip
 } from '../services/tripServices';
+import { createTripsComment, getTripComments } from '../services/tripCommentServices';
 import { respondWithSuccess, respondWithWarning } from '../helpers/responseHandler';
 import statusCode from '../helpers/statusCode';
 import { approvedEmitter } from '../helpers/notificationHandler';
 
+
 /**
 * make trip request
 * @param {object} req
@@ -23,6 +26,73 @@ export const oneWayTripRequest = async (req, res) => {
   }
 };
 
+/**
+* comment on a trip request
+* @param {object} req
+* @param {object} res
+* @returns {object} json response
+*/
+export const createTripComment = async (req, res) => {
+  try {
+    const { id: userId } = req.auth;
+    const { comment } = req.body;
+    const { tripId } = req.params;
+    const trip = await findTripById(tripId);
+    if (!trip) {
+      return respondWithWarning(res, statusCode.resourceNotFound, 'Trip not found');
+    }
+    const data = await createTripsComment({ userId, tripId, comment });
+    return respondWithSuccess(res, statusCode.created, 'Comment saved', data.dataValues);
+  } catch (error) {
+    return respondWithWarning(res, statusCode.internalServerError, error.message);
+  }
+};
+
+/**
+* get a user trip comments
+* @param {object} req
+* @param {object} res
+* @param {Function} next
+* @returns {object} json response
+*/
+export const getUserTripComments = async (req, res, next) => {
+  try {
+    const { tripId } = req.params;
+    const { id, roleId } = req.auth;
+    if (roleId === 6) {
+      const trip = await findUserTrip(Number(tripId), id);
+      if (!trip) {
+        return respondWithWarning(res, statusCode.resourceNotFound, 'Trip not found');
+      }
+      const data = await getTripComments(trip);
+      return respondWithSuccess(res, statusCode.success, 'Data retrieved successfully', data);
+    }
+    return next();
+  } catch (error) {
+    return respondWithWarning(res, statusCode.internalServerError, error.message);
+  }
+};
+
+/**
+* get a trip comments
+* @param {object} req
+* @param {object} res
+* @returns {object} json response
+*/
+export const getAllTripComments = async (req, res) => {
+  try {
+    const { tripId } = req.params;
+    const trip = await findTripById(Number(tripId));
+    if (!trip) {
+      return respondWithWarning(res, statusCode.resourceNotFound, 'Trip not found');
+    }
+    const data = await getTripComments(trip);
+    return respondWithSuccess(res, statusCode.success, 'Data retrieved successfully', data);
+  } catch (error) {
+    return respondWithWarning(res, statusCode.internalServerError, error.message);
+  }
+};
+
 export const approveTripRequest = async (req, res) => {
   const status = 'approved';
   try {

diff --git a/src/database/migrations/20190829084157-create-trip-request.js b/src/database/migrations/20190829084157-create-trip-request.js
@@ -35,7 +35,7 @@ export default {
       // values should be ['approved', 'pending', 'rejected']
     },
     userId: {
-      type: Sequelize.STRING,
+      type: Sequelize.INTEGER,
       allowNull: false,
     },
     createdAt: {

diff --git a/src/database/migrations/20190831213947-create-profile.js b/src/database/migrations/20190831213947-create-profile.js
@@ -58,7 +58,5 @@ export default {
       type: Sequelize.DATE
     }
   }),
-  down: (queryInterface, Sequelize) => {
-    return queryInterface.dropTable('Profiles');
-  }
+  down: (queryInterface, Sequelize) => queryInterface.dropTable('Profiles')
 };
diff --git a/src/database/migrations/20190906084157-create-trip-comments-table.js b/src/database/migrations/20190906084157-create-trip-comments-table.js
@@ -0,0 +1,36 @@
+export default {
+  up: (queryInterface, Sequelize) => queryInterface.createTable('TripComments', {
+    id: {
+      allowNull: false,
+      autoIncrement: true,
+      primaryKey: true,
+      type: Sequelize.INTEGER
+    },
+    userId: {
+      type: Sequelize.INTEGER,
+      allowNull: false,
+    },
+    tripId: {
+      type: Sequelize.INTEGER,
+      allowNull: false,
+    },
+    comment: {
+      type: Sequelize.STRING,
+      allowNull: false,
+    },
+    createdAt: {
+      allowNull: false,
+      type: Sequelize.DATE,
+      defaultValue: new Date()
+    },
+    updatedAt: {
+      allowNull: false,
+      type: Sequelize.DATE,
+      defaultValue: new Date()
+    },
+    deletedAt: {
+      type: Sequelize.DATE,
+    }
+  }),
+  down: (queryInterface) => queryInterface.dropTable('TripComments')
+};
diff --git a/src/database/seeders/20190824102850-create-permissions-seeder.js b/src/database/seeders/20190824102850-create-permissions-seeder.js
@@ -124,6 +124,9 @@ export default {
     {
       actionName: 'VIEW_BOOK_ACCOMODATION_FOR_TRIP',
     },
+    {
+      actionName: 'VIEW_TRIP_COMMENT',
+    },
   ], {}),
 
   down: (queryInterface, Sequelize) => queryInterface.bulkDelete('Permissions', null, {})

diff --git a/src/database/seeders/20190825190012-create-users-seeder.js b/src/database/seeders/20190825190012-create-users-seeder.js
@@ -45,6 +45,22 @@ export default {
       password: await passwordHash('123456'),
       roleId: 4
     },
+    {
+      firstName: 'Travel',
+      lastName: 'Admin',
+      username: 'traveladmin',
+      email: 'traveladmin@nomad.com',
+      password: await passwordHash('123456'),
+      roleId: 2
+    },
+    {
+      firstName: 'Dale',
+      lastName: 'Mark',
+      username: 'marck',
+      email: 'mark@nomad.com',
+      password: await passwordHash('123456'),
+      roleId: 6
+    }
   ], {}),
 
   /*

diff --git a/src/database/seeders/20190826080729-create-role-permissions-seeders.js b/src/database/seeders/20190826080729-create-role-permissions-seeders.js
@@ -129,10 +129,6 @@ export default {
       roleId: 6,
       permissionId: 16
     },
-    {
-      roleId: 6,
-      permissionId: 17
-    },
     {
       roleId: 2,
       permissionId: 17
@@ -464,6 +460,26 @@ export default {
     {
       roleId: 6,
       permissionId: 41
+    },
+    {
+      roleId: 1,
+      permissionId: 42
+    },
+    {
+      roleId: 2,
+      permissionId: 42
+    },
+    {
+      roleId: 3,
+      permissionId: 42
+    },
+    {
+      roleId: 4,
+      permissionId: 42
+    },
+    {
+      roleId: 6,
+      permissionId: 42
     }
   ], {}),
 

diff --git a/src/database/seeders/20190906230800-create-trip-request-seeder.js b/src/database/seeders/20190906230800-create-trip-request-seeder.js
@@ -4,8 +4,8 @@ export default {
       origin: 'Lagos',
       destination: 'Nairobi',
       reason: 'Trade Fair',
-      departureDate: '9/9/2019',
-      returnDate: '10/10/2019',
+      departureDate: '2019-09-09T00:09:31.812Z',
+      returnDate: '2019-19-09T00:09:31.812Z',
       type: 'one-way',
       userId: 3
     },
@@ -28,6 +28,15 @@ export default {
       departureDate: '2019-19-09T00:09:31.812Z',
       status: 'pending',
       userId: 2
+    },
+    {
+      origin: 'Lagos',
+      destination: 'New York',
+      reason: 'DockerCon',
+      departureDate: '2019-09-09T00:09:31.812Z',
+      returnDate: '2019-19-09T00:09:31.812Z',
+      type: 'one-way',
+      userId: 6
     }
   ], {}),
 

diff --git a/src/database/seeders/20190907230800-create-trip-comment-seeder.js b/src/database/seeders/20190907230800-create-trip-comment-seeder.js
@@ -0,0 +1,16 @@
+export default {
+  up: async (queryInterface) => queryInterface.bulkInsert('TripComments', [
+    {
+      tripId: 1,
+      userId: 5,
+      comment: 'Avoid staying out late',
+    },
+    {
+      tripId: 2,
+      userId: 5,
+      comment: 'Avoid the subways.',
+    }
+  ], {}),
+
+  down: queryInterface => queryInterface.bulkDelete('TripRequests', null, {})
+};
diff --git a/src/docs/swagger/definitions/trip.js b/src/docs/swagger/definitions/trip.js
@@ -24,3 +24,12 @@ export const createTrip = {
     }
   }
 };
+
+export const createTripComment = {
+  type: 'object',
+  properties: {
+    comment: {
+      type: 'string',
+    },
+  }
+};
diff --git a/src/docs/swagger/paths/profile.js b/src/docs/swagger/paths/profile.js
@@ -176,4 +176,3 @@ const ProfilePath = {
 };
 
 export default ProfilePath;
-