Merge pull request #55 from andela/ft-travelled-destinations-170947580

src/controllers/tripsController.js

@@ -516,4 +516,28 @@ export default class requestController {
       return Response.errorResponse(res, 500, res.__('server error'));
     }
   }
+
+  /**
+   * @description this function finds and displays most travelled destinations
+   * @param  {object} req
+   * @param  {object} res
+   * @return {object} most travelled destinations
+   */
+  static async mostTravelledDestinations(req, res) {
+    try {
+      const counting = await db.Request.findAll({
+        attributes: ['destination', [db.sequelize.fn('count', db.sequelize.col('destination')), 'count']],
+        group: ['Request.destination'],
+        raw: true,
+        order: db.sequelize.literal('count DESC'),
+        where: {
+          status: 'approved',
+          confirm: true
+        }
+      });
+      return Response.success(res, 200, res.__('Most travelled destinations'), { Destinations: counting });
+    } catch (err) {
+      return Response.errorResponse(res, 500, res.__('server error'));
+    }
+  }
 }

src/routes/tripsRoutes.js

@@ -22,8 +22,7 @@ router.patch('/:requestId/reject', protectRoute.verifyUser, protectRoute.verifyM
 router.patch('/:requestId/approve', protectRoute.verifyUser, protectRoute.verifyManager, tripsController.approveRequest);
 router.get('/search', protectRoute.verifyUser, searchQueryRules, validationResult, tripsController.requestSearch);
 router.get('/stats', protectRoute.verifyUser, tripsController.TripStats);
-
 router.get('/:requestId/view', protectRoute.verifyUser, tripsController.viewRequest);
 router.get('/view', protectRoute.verifyUser, tripsController.viewAllRequests);
-
+router.get('/most-travelled', protectRoute.verifyUser, tripsController.mostTravelledDestinations);
 export default router;

src/services/localesServices/locales/en.json

@@ -174,5 +174,6 @@
 	"Request not found or not yours to manage": "Request not found or not yours to manage",
 	"feedback is required": "feedback is required",
 	"feedback can't be longer than 300 character": "feedback can't be longer than 300 character",
-	"feedback saved successfully" : "feedback saved successfully"
+	"feedback saved successfully" : "feedback saved successfully",
+	"Most travelled destinations": "Most travelled destinations"
 }

src/services/localesServices/locales/fr.json

@@ -181,5 +181,6 @@
 	"Trips statistics": "Statistiques de voyages",
 	"feedback is required": "une rétroaction est requise",
 	"feedback can't be longer than 300 character": "les commentaires ne peuvent pas dépasser 300 caractères",
-	"feedback saved successfully" : "commentaires enregistrés avec succès"
+	"feedback saved successfully" : "commentaires enregistrés avec succès",
+	"Most travelled destinations": "Destinations les plus fréquentées"
 }

src/swagger/trips.swagger.js

@@ -496,3 +496,28 @@
  *       '401':
  *         description: You are not authorized to perform this action
  */
+/**
+ * @swagger
+ * /api/v1/trips/most-travelled:
+ *   get:
+ *     security:
+ *       - bearerAuth: []
+ *     tags:
+ *       - Trips
+ *     name: Most travelled destination
+ *     summary:  Users should be able to view the most travelled destination
+ *     parameters:
+ *       - name: token
+ *         in: header
+ *         schema:
+ *           type: string
+ *     produces:
+ *       - application/json
+ *     consumes:
+ *       - application/json
+ *     responses:
+ *       '200':
+ *         description: Most travelled destination.
+ *       '401':
+ *         description: You are not authorized to perform this action
+ */

src/tests/trips.test.js

@@ -377,3 +377,16 @@ describe('TRIP STATS TESTS', () => {
       });
   });
 });
+describe('MOST TRAVELLED DESTINATION TEST', () => {
+  it('should return the most travelled destinations', (done) => {
+    chai
+      .request(app)
+      .get('/api/v1/trips/most-travelled')
+      .set('token', token)
+      .end((err, res) => {
+        expect(res.status).to.equal(200);
+        expect(res.body.message).to.equal('Most travelled destinations');
+        done();
+      });
+  });
+});

src/tests/unitTests/tripService.test.js

@@ -3,6 +3,7 @@ import sgMail from '@sendgrid/mail';
 import sinon from 'sinon';
 import TripsService from '../../services/tripServices';
 import stringHelper from '../../utils/stringHelper';
+import db from '../../models';
 
 const {
   expect
@@ -59,3 +60,18 @@ describe('APPROVE REQUEST SERVICE TEST', () => {
     expect(approvedRequest.status).to.equal('approved');
   });
 });
+describe('MOST TRAVELLED DESTINATION UNIT TEST', () => {
+  it('should return the most travelled destinations', async () => {
+    const counting = await db.Request.findAll({
+      attributes: ['destination', [db.sequelize.fn('count', db.sequelize.col('destination')), 'count']],
+      group: ['Request.destination'],
+      raw: true,
+      order: db.sequelize.literal('count DESC'),
+      where: {
+        status: 'approved',
+        confirm: true
+      }
+    });
+    expect(counting).to.be.an('array');
+  });
+});