feature(readTime): view read time

Write function to generate read time Write using tests to view novel Create a route to view a novel Create Validations to view a novel Create a controller to view a novel Add swagger documentation [Finishes #167164998]
andela · Aug 23, 2019 · 7926cc1 · 7926cc1
1 parent 850e6f5
commit 7926cc1
Show file tree

Hide file tree

Showing 12 changed files with 220 additions and 18 deletions.
diff --git a/docs/swagger.yaml b/docs/swagger.yaml
@@ -286,6 +286,41 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/notFoundResponse"
+  '/novel/{slug}':
+    get:
+      tags:
+        - Users
+      summary: View a novel details.
+      security:
+      - ApiKeyAuth: []
+      parameters:
+        - name: slug
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        200:
+          description: novel details
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/NovelInput'
+        404:
+          description: novel not found
+          content:
+            application/json:
+              schema:
+                type: object
+                properties: 
+                  error:
+                    type: object
+                    properties:
+                      message:
+                          type: string
+                          example: 'novel not found'
         500:
           description: server error
           content:

diff --git a/src/controllers/novelController.js b/src/controllers/novelController.js
@@ -7,7 +7,9 @@ const {
 } = helpers;
 const { Novel } = models;
 const {
-  novelServices: { addNovel, findGenre, findAllNovels },
+  novelServices: {
+    addNovel, findGenre, findNovel, findAllNovels
+  },
   notificationServices: { addNotification }
 } = services;
 
@@ -113,4 +115,26 @@ const createGenre = async (request, response) => {
   }
 };
 
-export default { createNovel, getNovels, createGenre };
+/**
+ * @description returns novel with slug
+ * @param {object} request express request object
+ * @param {object} response express response object
+ * @param {object} next express next argument
+ * @returns {json} json
+ */
+const getNovel = async (request, response) => {
+  try {
+    const { slug } = request.params;
+    const novel = await findNovel(slug);
+    if (!novel) {
+      return responseMessage(response, 404, { error: 'novel not found' });
+    }
+    return responseMessage(response, 200, { novel });
+  } catch (error) {
+    responseMessage(response, 500, { error: error.message });
+  }
+};
+
+export default {
+  createNovel, getNovel, getNovels, createGenre
+};
diff --git a/src/database/migrations/20190729135752-create-novel.js b/src/database/migrations/20190729135752-create-novel.js
@@ -38,6 +38,10 @@ const up = (queryInterface, Sequelize) => queryInterface.createTable('Novels', {
     allowNull: false,
     type: Sequelize.TEXT
   },
+  readTime: {
+    allowNull: false,
+    type: Sequelize.INTEGER
+  },
   createdAt: {
     allowNull: false,
     type: Sequelize.DATE

diff --git a/src/database/models/novel.js b/src/database/models/novel.js
@@ -37,6 +37,10 @@ export default (Sequelize, DataTypes) => {
       type: DataTypes.BOOLEAN,
       defaultValue: false
     },
+    readTime: {
+      allowNull: false,
+      type: DataTypes.INTEGER
+    },
     createdAt: {
       allowNull: false,
       type: DataTypes.DATE

diff --git a/src/database/seeders/20190806144830-novel.js b/src/database/seeders/20190806144830-novel.js
@@ -6,6 +6,7 @@ export const up = queryInterface => queryInterface.bulkInsert('Novels', [{
   body: 'abcd',
   genreId: 'ffe299b9-889b-4ad3-86cf-138cd57d5aab',
   authorId: '122a0d86-8b78-4bb8-b28f-8e5f7811c456',
+  readTime: 1,
   createdAt: new Date(),
   updatedAt: new Date()
 },
@@ -17,6 +18,7 @@ export const up = queryInterface => queryInterface.bulkInsert('Novels', [{
   body: 'abcd',
   genreId: 'ffe299b9-889b-4ad3-86cf-138cd57d5aab',
   authorId: '122a0d86-8b78-4bb8-b28f-8e5f7811c456',
+  readTime: 1,
   createdAt: new Date(),
   updatedAt: new Date()
 },
@@ -28,6 +30,7 @@ export const up = queryInterface => queryInterface.bulkInsert('Novels', [{
   body: 'Religion and Christianity proposes that all the answers can be found in the Bible, while Christianity is all bout searching for anwsers.',
   authorId: '122a0d86-8b78-4bb8-b28f-8e5f7811c456',
   genreId: 'ceb59aa0-b10d-4f37-a0d5-925b38876db4',
+  readTime: 1,
   createdAt: new Date(),
   updatedAt: new Date()
 },
@@ -39,6 +42,7 @@ export const up = queryInterface => queryInterface.bulkInsert('Novels', [{
   body: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Mauris arcu ipsum, sagittis eu dapibus sed, pulvinar suscipit magna. Mauris iaculis rutrum ipsum in lobortis. Quisque ullamcorper at odio ac tristique. Vivamus vel risus vitae lorem varius consequat at quis urna.',
   authorId: '122a0d86-8b78-4bb8-b28f-8e5f7811c456',
   genreId: 'e4427fcd-d1dd-480d-98a6-bb08d5e4d4aa',
+  readTime: 1,
   createdAt: new Date(),
   updatedAt: new Date()
 },
@@ -50,6 +54,7 @@ export const up = queryInterface => queryInterface.bulkInsert('Novels', [{
   body: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Mauris arcu ipsum, sagittis eu dapibus sed, pulvinar suscipit magna. Mauris iaculis rutrum ipsum in lobortis. Quisque ullamcorper at odio ac tristique. Vivamus vel risus vitae lorem varius consequat at quis urna.',
   authorId: 'fb94de4d-47ff-4079-89e8-b0186c0a3be8',
   genreId: 'da86915a-6d4d-455f-8b44-5c4b8221ebf6',
+  readTime: 1,
   createdAt: new Date(),
   updatedAt: new Date()
 },
@@ -61,6 +66,7 @@ export const up = queryInterface => queryInterface.bulkInsert('Novels', [{
   body: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Mauris arcu ipsum, sagittis eu dapibus sed, pulvinar suscipit magna. Mauris iaculis rutrum ipsum in lobortis. Quisque ullamcorper at odio ac tristique. Vivamus vel risus vitae lorem varius consequat at quis urna.',
   authorId: 'fb94de4d-47ff-4079-89e8-b0186c0a3be8',
   genreId: 'ceb59aa0-b10d-4f37-a0d5-925b38876db4',
+  readTime: 1,
   createdAt: new Date(),
   updatedAt: new Date()
 },
@@ -72,6 +78,7 @@ export const up = queryInterface => queryInterface.bulkInsert('Novels', [{
   body: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Mauris arcu ipsum, sagittis eu dapibus sed, pulvinar suscipit magna. Mauris iaculis rutrum ipsum in lobortis. Quisque ullamcorper at odio ac tristique. Vivamus vel risus vitae lorem varius consequat at quis urna.',
   authorId: 'fb94de4d-47ff-4079-89e8-b0186c0a3be8',
   genreId: 'e4427fcd-d1dd-480d-98a6-bb08d5e4d4aa',
+  readTime: 1,
   createdAt: new Date(),
   updatedAt: new Date()
 },
@@ -83,6 +90,7 @@ export const up = queryInterface => queryInterface.bulkInsert('Novels', [{
   body: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Mauris arcu ipsum, sagittis eu dapibus sed, pulvinar suscipit magna. Mauris iaculis rutrum ipsum in lobortis. Quisque ullamcorper at odio ac tristique. Vivamus vel risus vitae lorem varius consequat at quis urna.',
   authorId: 'fb94de4d-47ff-4079-89e8-b0186c0a3be8',
   genreId: 'e4427fcd-d1dd-480d-98a6-bb08d5e4d4aa',
+  readTime: 1,
   createdAt: new Date(),
   updatedAt: new Date()
 },
@@ -94,6 +102,7 @@ export const up = queryInterface => queryInterface.bulkInsert('Novels', [{
   body: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Mauris arcu ipsum, sagittis eu dapibus sed, pulvinar suscipit magna. Mauris iaculis rutrum ipsum in lobortis. Quisque ullamcorper at odio ac tristique. Vivamus vel risus vitae lorem varius consequat at quis urna.',
   authorId: 'fb94de4d-47ff-4079-89e8-b0186c0a3be8',
   genreId: '09add0fe-d063-48ce-8e18-0dc590d04dcf',
+  readTime: 1,
   createdAt: new Date(),
   updatedAt: new Date()
 },
@@ -105,6 +114,7 @@ export const up = queryInterface => queryInterface.bulkInsert('Novels', [{
   body: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Mauris arcu ipsum, sagittis eu dapibus sed, pulvinar suscipit magna. Mauris iaculis rutrum ipsum in lobortis. Quisque ullamcorper at odio ac tristique. Vivamus vel risus vitae lorem varius consequat at quis urna.',
   authorId: 'fb94de4d-47ff-4079-89e8-b0186c0a3be8',
   genreId: 'ceb59aa0-b10d-4f37-a0d5-925b38876db4',
+  readTime: 1,
   createdAt: new Date(),
   updatedAt: new Date()
 },
@@ -116,6 +126,7 @@ export const up = queryInterface => queryInterface.bulkInsert('Novels', [{
   body: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Mauris arcu ipsum, sagittis eu dapibus sed, pulvinar suscipit magna. Mauris iaculis rutrum ipsum in lobortis. Quisque ullamcorper at odio ac tristique. Vivamus vel risus vitae lorem varius consequat at quis urna.',
   authorId: '122a0d86-8b78-4bb8-b28f-8e5f7811c456',
   genreId: 'e4427fcd-d1dd-480d-98a6-bb08d5e4d4aa',
+  readTime: 1,
   createdAt: new Date(),
   updatedAt: new Date()
 },
@@ -127,6 +138,7 @@ export const up = queryInterface => queryInterface.bulkInsert('Novels', [{
   body: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Mauris arcu ipsum, sagittis eu dapibus sed, pulvinar suscipit magna. Mauris iaculis rutrum ipsum in lobortis. Quisque ullamcorper at odio ac tristique. Vivamus vel risus vitae lorem varius consequat at quis urna.',
   authorId: 'fb94de4d-47ff-4079-89e8-b0186c0a3be8',
   genreId: 'ceb59aa0-b10d-4f37-a0d5-925b38876db4',
+  readTime: 1,
   createdAt: new Date(),
   updatedAt: new Date()
 },
@@ -138,6 +150,7 @@ export const up = queryInterface => queryInterface.bulkInsert('Novels', [{
   body: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Mauris arcu ipsum, sagittis eu dapibus sed, pulvinar suscipit magna. Mauris iaculis rutrum ipsum in lobortis. Quisque ullamcorper at odio ac tristique. Vivamus vel risus vitae lorem varius consequat at quis urna.',
   authorId: '122a0d86-8b78-4bb8-b28f-8e5f7811c456',
   genreId: 'da86915a-6d4d-455f-8b44-5c4b8221ebf6',
+  readTime: 1,
   createdAt: new Date(),
   updatedAt: new Date()
 },
@@ -149,6 +162,7 @@ export const up = queryInterface => queryInterface.bulkInsert('Novels', [{
   body: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Mauris arcu ipsum, sagittis eu dapibus sed, pulvinar suscipit magna. Mauris iaculis rutrum ipsum in lobortis. Quisque ullamcorper at odio ac tristique. Vivamus vel risus vitae lorem varius consequat at quis urna.',
   authorId: 'fb94de4d-47ff-4079-89e8-b0186c0a3be8',
   genreId: 'e4427fcd-d1dd-480d-98a6-bb08d5e4d4aa',
+  readTime: 1,
   createdAt: new Date(),
   updatedAt: new Date()
 },
@@ -160,6 +174,7 @@ export const up = queryInterface => queryInterface.bulkInsert('Novels', [{
   body: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Mauris arcu ipsum, sagittis eu dapibus sed, pulvinar suscipit magna. Mauris iaculis rutrum ipsum in lobortis. Quisque ullamcorper at odio ac tristique. Vivamus vel risus vitae lorem varius consequat at quis urna.',
   authorId: 'fb94de4d-47ff-4079-89e8-b0186c0a3be8',
   genreId: 'ceb59aa0-b10d-4f37-a0d5-925b38876db4',
+  readTime: 1,
   createdAt: new Date(),
   updatedAt: new Date()
 },
@@ -171,6 +186,7 @@ export const up = queryInterface => queryInterface.bulkInsert('Novels', [{
   body: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Mauris arcu ipsum, sagittis eu dapibus sed, pulvinar suscipit magna. Mauris iaculis rutrum ipsum in lobortis. Quisque ullamcorper at odio ac tristique. Vivamus vel risus vitae lorem varius consequat at quis urna.',
   authorId: 'fb94de4d-47ff-4079-89e8-b0186c0a3be8',
   genreId: 'da86915a-6d4d-455f-8b44-5c4b8221ebf6',
+  readTime: 1,
   createdAt: new Date(),
   updatedAt: new Date()
 },
@@ -182,6 +198,7 @@ export const up = queryInterface => queryInterface.bulkInsert('Novels', [{
   body: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Mauris arcu ipsum, sagittis eu dapibus sed, pulvinar suscipit magna. Mauris iaculis rutrum ipsum in lobortis. Quisque ullamcorper at odio ac tristique. Vivamus vel risus vitae lorem varius consequat at quis urna.',
   authorId: 'fb94de4d-47ff-4079-89e8-b0186c0a3be8',
   genreId: '09add0fe-d063-48ce-8e18-0dc590d04dcf',
+  readTime: 1,
   createdAt: new Date(),
   updatedAt: new Date()
 },
@@ -193,6 +210,7 @@ export const up = queryInterface => queryInterface.bulkInsert('Novels', [{
   body: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Mauris arcu ipsum, sagittis eu dapibus sed, pulvinar suscipit magna. Mauris iaculis rutrum ipsum in lobortis. Quisque ullamcorper at odio ac tristique. Vivamus vel risus vitae lorem varius consequat at quis urna.',
   authorId: '122a0d86-8b78-4bb8-b28f-8e5f7811c456',
   genreId: 'ceb59aa0-b10d-4f37-a0d5-925b38876db4',
+  readTime: 1,
   createdAt: new Date(),
   updatedAt: new Date()
 },
@@ -204,6 +222,7 @@ export const up = queryInterface => queryInterface.bulkInsert('Novels', [{
   body: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Mauris arcu ipsum, sagittis eu dapibus sed, pulvinar suscipit magna. Mauris iaculis rutrum ipsum in lobortis. Quisque ullamcorper at odio ac tristique. Vivamus vel risus vitae lorem varius consequat at quis urna.',
   authorId: 'fb94de4d-47ff-4079-89e8-b0186c0a3be8',
   genreId: 'da86915a-6d4d-455f-8b44-5c4b8221ebf6',
+  readTime: 1,
   createdAt: new Date(),
   updatedAt: new Date()
 },
@@ -215,6 +234,7 @@ export const up = queryInterface => queryInterface.bulkInsert('Novels', [{
   body: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Mauris arcu ipsum, sagittis eu dapibus sed, pulvinar suscipit magna. Mauris iaculis rutrum ipsum in lobortis. Quisque ullamcorper at odio ac tristique. Vivamus vel risus vitae lorem varius consequat at quis urna.',
   authorId: '122a0d86-8b78-4bb8-b28f-8e5f7811c456',
   genreId: 'da86915a-6d4d-455f-8b44-5c4b8221ebf6',
+  readTime: 1,
   createdAt: new Date(),
   updatedAt: new Date()
 },
@@ -226,6 +246,7 @@ export const up = queryInterface => queryInterface.bulkInsert('Novels', [{
   body: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Mauris arcu ipsum, sagittis eu dapibus sed, pulvinar suscipit magna. Mauris iaculis rutrum ipsum in lobortis. Quisque ullamcorper at odio ac tristique. Vivamus vel risus vitae lorem varius consequat at quis urna.',
   authorId: 'fb94de4d-47ff-4079-89e8-b0186c0a3be8',
   genreId: '09add0fe-d063-48ce-8e18-0dc590d04dcf',
+  readTime: 1,
   createdAt: new Date(),
   updatedAt: new Date()
 },
@@ -237,6 +258,7 @@ export const up = queryInterface => queryInterface.bulkInsert('Novels', [{
   body: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Mauris arcu ipsum, sagittis eu dapibus sed, pulvinar suscipit magna. Mauris iaculis rutrum ipsum in lobortis. Quisque ullamcorper at odio ac tristique. Vivamus vel risus vitae lorem varius consequat at quis urna.',
   authorId: '122a0d86-8b78-4bb8-b28f-8e5f7811c456',
   genreId: 'ceb59aa0-b10d-4f37-a0d5-925b38876db4',
+  readTime: 1,
   createdAt: new Date(),
   updatedAt: new Date()
 }], {});

diff --git a/src/helpers/generateReadTime.js b/src/helpers/generateReadTime.js
@@ -0,0 +1,12 @@
+/**
+ * @description returns read time of string in minutes
+ * @param {string} string a string
+ * @returns {number} number in minutes
+ */
+const generateReadTime = (string) => {
+  const wordCount = string.split(' ').length;
+  const readTimeMinutes = Math.round(wordCount / 200);
+  return readTimeMinutes;
+};
+
+export default generateReadTime;
diff --git a/src/helpers/index.js b/src/helpers/index.js
@@ -8,6 +8,7 @@ import verifyUser from './verifyUser';
 import notificationConfig from './notificationConfig';
 import novelHelpers from './novelHelpers';
 import reportHelper from './reportHelper';
+import generateReadTime from './generateReadTime';
 
 const { forgotPasswordMessage, emailNotificationMessage } = emailMessages;
 
@@ -23,5 +24,6 @@ export default {
   emailNotificationMessage,
   notificationConfig,
   novelHelpers,
-  reportHelper
+  reportHelper,
+  generateReadTime
 };
diff --git a/src/middlewares/novelValidator.js b/src/middlewares/novelValidator.js
@@ -2,7 +2,7 @@ import validator from '../helpers/validator';
 import errorHandler from './errorHandler';
 
 const {
-  isNotEmpty, isValidGenre, isValidInt, isValidName
+  isNotEmpty, isValidGenre, isValidInt, isValidName, isNotEmptySlug
 } = validator;
 
 const { validatorError } = errorHandler;
@@ -27,6 +27,10 @@ const novelValidator = {
   genreValidator: [
     isValidName('name'),
     validatorError
+  ],
+  getNovelBySlugValidator: [
+    isNotEmptySlug(),
+    validatorError
   ]
 };
 

diff --git a/src/routes/novel.js b/src/routes/novel.js
@@ -3,17 +3,18 @@ import middlewares from '../middlewares';
 import updateLikes from '../controllers/likesController';
 import novelController from '../controllers/novelController';
 
-const novel = express.Router();
-const NOVEL_URL = '/novels';
-
 const {
   novelValidator: {
-    createNovelValidator, getNovelValidator, genreValidator
+    createNovelValidator, getNovelBySlugValidator, getNovelValidator, genreValidator
   },
   verifyToken,
   authorizeUser
 } = middlewares;
-const { createNovel, getNovels, createGenre } = novelController;
+const {
+  createNovel, getNovel, getNovels, createGenre
+} = novelController;
+const novel = express.Router();
+const NOVEL_URL = '/novels';
 
 // Route to create a novel
 novel.post(`${NOVEL_URL}`, verifyToken, authorizeUser(['author', 'admin', 'superadmin']), createNovelValidator, createNovel);
@@ -24,7 +25,10 @@ novel.post(`${NOVEL_URL}/:slug/like`, verifyToken, authorizeUser(['author', 'adm
 // Route to create a genre
 novel.post('/genres', verifyToken, authorizeUser(['author', 'admin', 'superadmin']), genreValidator, createGenre);
 
-// Route to get novels
+// Route to get all novels
 novel.get(`${NOVEL_URL}`, verifyToken, getNovelValidator, getNovels);
 
+// Route to get novel by slug
+novel.get(`${NOVEL_URL}/:slug`, verifyToken, authorizeUser(['reader', 'author', 'admin', 'superadmin']), getNovelBySlugValidator, getNovel);
+
 export default novel;