Merge pull request #65 from andela/ft-text-highlight-166240846

#166240846 highlight text

src/api/controllers/articleController.js

@@ -7,19 +7,10 @@ import errorSender from '../../helpers/error.sender';
 import generatePagination from '../../helpers/generate.pagination.details';
 
 const {
-  Article, Category, User, Report
+  Article, Category, User, Report, Highlight
 } = models;
 
-const { CREATED } = statusCodes;
-
-/**
- *
- *
- * this is the article controller
- *
- * @export
- * @class ArticleController
- */
+const { CREATED, BAD_REQUEST } = statusCodes;
 
 /**
  * containing all article's model controllers
@@ -248,4 +239,35 @@ export default class ArticleController {
         'Sorry, but that reason does not exist, Thanks');
     }
   }
+
+  /**
+  * allow a user to highlight a text in an article
+  *
+  * @author Alain Burindi
+  * @static
+  * @param {object} req the request
+  * @param {object} res the response to be sent
+  * @memberof ArticleController
+  * @returns {Object} res
+  */
+  static async highlight(req, res) {
+    const { slug } = req.params;
+    const {
+      startIndex, lastIndex, text, comment
+    } = req.body;
+    const correctLength = lastIndex - startIndex + 1;
+
+    if (correctLength === text.length) {
+      const userId = req.user.user.id;
+      const highlighted = await Highlight.create({
+        startIndex, lastIndex, text, comment, articleSlug: slug, userId
+      });
+      res.status(CREATED).json({
+        status: CREATED,
+        highlighted
+      });
+    } else {
+      errorSender(BAD_REQUEST, res, 'text', errorMessage.textMatch);
+    }
+  }
 }

src/api/migrations/20190703103749-create-highlight.js

@@ -0,0 +1,43 @@
+export default {
+  up: (queryInterface, Sequelize) => {
+    return queryInterface.createTable('Highlights', {
+      id: {
+        allowNull: false,
+        autoIncrement: true,
+        primaryKey: true,
+        type: Sequelize.INTEGER
+      },
+      startIndex: {
+        type: Sequelize.INTEGER
+      },
+      lastIndex: {
+        type: Sequelize.INTEGER
+      },
+      text: {
+        type: Sequelize.STRING
+      },
+      comment: {
+        type: Sequelize.STRING
+      },
+      articleSlug: {
+        type: Sequelize.STRING,
+        references: { model: 'Articles', key: 'slug' }
+      },
+      userId: {
+        type: Sequelize.INTEGER,
+        references: { model: 'Users', key: 'id'}
+      },
+      createdAt: {
+        allowNull: false,
+        type: Sequelize.DATE
+      },
+      updatedAt: {
+        allowNull: false,
+        type: Sequelize.DATE
+      }
+    });
+  },
+  down: (queryInterface, Sequelize) => {
+    return queryInterface.dropTable('Highlights');
+  }
+};

src/api/models/article.js

@@ -58,6 +58,10 @@ export default (sequelize, DataTypes) => {
       onDelete: 'CASCADE',
       hooks: true
     });
+    Article.hasMany(models.Highlight, {
+      foreignKey: 'articleSlug',
+      onDelete: 'CASCADE',
+    });
   };
 
   return Article;

src/api/models/highlight.js

@@ -0,0 +1,21 @@
+export default (sequelize, DataTypes) => {
+  const Highlight = sequelize.define('Highlight', {
+    startIndex: DataTypes.INTEGER,
+    lastIndex: DataTypes.INTEGER,
+    text: DataTypes.STRING,
+    comment: DataTypes.STRING,
+    articleSlug: DataTypes.STRING,
+    userId: DataTypes.INTEGER
+  }, {});
+  Highlight.associate = (models) => {
+    Highlight.belongsTo(models.User, { 
+      foreignKey: 'userId',
+      onDelete: 'CASCADE'
+    });
+    Highlight.belongsTo(models.Article, { 
+      foreignKey: 'articleSlug',
+      onDelete: 'CASCADE'
+    });
+  };
+  return Highlight;
+};

src/api/models/index.js

@@ -12,14 +12,16 @@ const models = {
   Category: sequelize.import('./category'),
   Rating: sequelize.import('./rating'),
   Report: sequelize.import('./report'),
-  Reason: sequelize.import('./reasons')
+  Reason: sequelize.import('./reasons'),
+  Highlight: sequelize.import('./highlight')
 };
 
 Object.keys(models).forEach((key) => {
   if ('associate' in models[key]) {
     models[key].associate(models);
   }
 });
+
 export { sequelize };
 
 export default models;

src/api/models/user.js

@@ -63,6 +63,10 @@ export default (sequelize, DataTypes) => {
     User.hasMany(models.Rating, {
       foreignKey: 'userId'
     });
+    User.hasMany(models.Highlight, {
+      foreignKey: 'userId',
+      onDelete: 'CASCADE',
+    });
   };
 
   User.findByEmail = (email) => {

src/api/routes/articleRouter.js

@@ -20,6 +20,7 @@ articleRouter.post('/:slug/rating',
   validateInputs('rateArticle', ['rating']),
   checkExistingRates.ExistingRating,
   ratingsController.rateArticle);
+const highlightFields = ['firstIndex', 'lastIndex', 'comment', 'text'];
 
 articleRouter.get('/', articleController.getArticles);
 articleRouter.get('/:slug', articleController.getArticle);
@@ -50,6 +51,8 @@ articleRouter.delete('/:slug',
   checkValidToken,
   checkArticleOwner.checkOwner,
   articleController.delete);
+articleRouter.post('/:slug/highlight', checkValidToken, checkArticle.getArticle, validateInputs('highlight', highlightFields),
+  articleController.highlight);
 
 articleRouter.post('/:slug/report',
   checkValidToken,

src/helpers/constants/error.messages.js

@@ -32,4 +32,5 @@ export default {
   noArticles: 'Article not found!',
   noMoreArticle: 'There no more articles at the moment.',
   reason: 'a reason can not be a string, Please provide a number starting from 1, Thanks',
+  textMatch: 'The text does not match the indexes'
 };

src/helpers/constants/validation.schemas.js

@@ -105,5 +105,19 @@ export default {
     body: Joi.string().allow(''),
     category: Joi.string().uppercase().allow(''),
     tagList: Joi.array().items(Joi.string().alphanum()).allow('')
-  })
+  }),
+  highlight: Joi.object().keys({
+    startIndex: Joi.number()
+      .min(1)
+      .required(),
+    lastIndex: Joi.number()
+      .min(1)
+      .required(),
+    text: Joi.string()
+      .trim()
+      .required(),
+    comment: Joi.string()
+      .trim()
+      .required(),
+  }),
 };

tests/highlight.test.js

@@ -0,0 +1,55 @@
+import chai from 'chai';
+import chaiHttp from 'chai-http';
+
+import server from '../src/index';
+import statusCodes from '../src/helpers/constants/status.codes';
+import signup from '../src/helpers/tests/signup';
+import errorMessage from '../src/helpers/constants/error.messages';
+
+
+chai.use(chaiHttp);
+chai.should();
+
+const { CREATED, BAD_REQUEST } = statusCodes;
+const highlitedData = {
+  startIndex: 3,
+  lastIndex: 8,
+  text: 'text g',
+  comment: 'is correct'
+};
+
+const token = signup();
+describe('Highlight', () => {
+  it('should highlight a text', (done) => {
+    chai
+      .request(server)
+      .post('/api/articles/How-to-create-sequalize-seeds/highlight')
+      .set('Authorization', token)
+      .send({
+        ...highlitedData
+      })
+      .end((err, res) => {
+        res.should.have.status(CREATED);
+        res.body.highlighted.should.include(highlitedData);
+        done();
+      });
+  });
+
+  describe('Validation', () => {
+    it('the text length should match the indexes', (done) => {
+      highlitedData.startIndex = 2;
+      chai
+        .request(server)
+        .post('/api/articles/How-to-create-sequalize-seeds/highlight')
+        .set('Authorization', token)
+        .send({
+          ...highlitedData
+        })
+        .end((err, res) => {
+          res.should.have.status(BAD_REQUEST);
+          res.body.errors.should.have.property('text', errorMessage.textMatch);
+          done();
+        });
+    });
+  });
+});