ft(highlight_&_comment):The user should be able the highlight the art…

…icle and comment about it.

.eslintrc.json

@@ -22,6 +22,7 @@
       "requireParamDescription": false,
       "requireReturnDescription": true
     }],
+    "jsx-a11y/anchor-is-valid": "off",
     "require-jsdoc": ["error", {
         "require": {
             "FunctionDeclaration": true,

src/api/controllers/highlightController.js

@@ -0,0 +1,34 @@
+import db from '../../sequelize/models';
+
+const { Highlights } = db;
+/**
+ * @author Diane Mahoro
+ * @class Highlight
+ * @description this class performs the whole of highlightings
+ */
+class Highlight {
+  /**
+   * @param {Object} req - Request object
+   * @param {Object} res - Response object
+   * @returns {Object} - Response object
+   */
+  static async createHighlights(req, res) {
+    const { id } = req.user;
+    const {
+      highlightText, comment, occurencyNumber
+    } = req.body;
+    const { article } = req; // This contains the article
+    const newHighlight = await Highlights.create({
+      articleId: article.id,
+      userId: id,
+      highlightText,
+      comment,
+      occurencyNumber,
+    });
+    return res.status(201).json({
+      Message: `Thank you for highlighting this text ${newHighlight.highlightText}`
+    });
+  }
+}
+
+export default Highlight;

src/api/routes/articlesRouter.js

@@ -16,6 +16,9 @@ import checkLikesandDislikes from '../../middleware/checkLikesDislikes';
 import paginate from '../../middleware/paginate';
 import shareArticle from '../../middleware/shareArticle';
 import stats from '../controllers/stats';
+import highlight from '../controllers/highlightController';
+import highlightExist from '../../middleware/highlightExist';
+import textExist from '../../middleware/textExist';
 
 
 const articlesRouter = Router();
@@ -40,6 +43,8 @@ const {
 const { verifyToken, checkIsModerator } = Auth;
 const { createRatings, UpdateRatings } = RatingController;
 const { bookmark } = bookmarkController;
+const { createHighlights } = highlight;
+
 
 const { searchForArticle } = search;
 const {
@@ -112,4 +117,8 @@ articlesRouter.get('/:slug/shares', slugExist, shares);
 // block reported articles
 articlesRouter.post('/:slug/block', verifyToken, checkIsModerator, validateBody('checkDescription'), slugExist, isAlreadBlocked, blockArticle);
 articlesRouter.post('/:slug/unblock', verifyToken, checkIsModerator, slugExist, isNotBlocked, unBlockArticle);
+// highlight the text in the article
+
+articlesRouter.post('/:slug/highlight', verifyToken, validateBody('validateHighlight'), slugExist, highlightExist, textExist, createHighlights);
+
 export default articlesRouter;

src/helpers/validationSchemas.js

@@ -126,5 +126,19 @@ export default {
       .max(5)
       .required()
       .label('Rating must be from 1 to 5 ')
+  }),
+  validateHighlight: Joi.object().keys({
+    highlightText: Joi.string()
+      .trim()
+      .required()
+      .label('The highlightText is required and should be a string'),
+    comment: Joi.string()
+      .trim()
+      .min(3)
+      .label('The comment should have at least 3 letters!'),
+    occurencyNumber: Joi.number()
+      .label('Occurrency should be a number')
+
+
   })
 };

src/middleware/highlightExist.js

@@ -0,0 +1,25 @@
+import db from '../sequelize/models/index';
+
+const { Highlights } = db;
+const highlightExist = async (req, res, next) => {
+  const {
+    article, user: { id },
+    body: { highlightText, occurencyNumber }
+  } = req; // This contains the article
+  const response = await Highlights.findOne({
+    where: {
+      articleId: article.id,
+      userId: id,
+      highlightText,
+      occurencyNumber
+    }
+  });
+  if (!response) {
+    return next();
+  }
+  return res.status(403).json({
+    Message: 'you have already highlighted this text.'
+  });
+};
+
+export default highlightExist;

src/middleware/textExist.js

@@ -0,0 +1,19 @@
+
+const textExist = async (req, res, next) => {
+  const {
+    article,
+    body: { highlightText, occurencyNumber }
+  } = req; // This contains the article
+
+
+  const { body } = article;
+  const regX = new RegExp(highlightText, 'g');
+  const count = (body.match(regX) || []).length;
+  if (count === 0 || occurencyNumber > count) {
+    return res.status(404).json({
+      Message: 'Highlight text not found'
+    });
+  }
+  next();
+};
+export default textExist;

src/sequelize/migrations/20190627142139-create-highlights.js

@@ -0,0 +1,34 @@
+module.exports = {
+  up: (queryInterface, Sequelize) => queryInterface.createTable('Highlights', {
+    id: {
+      allowNull: false,
+      autoIncrement: true,
+      primaryKey: true,
+      type: Sequelize.INTEGER
+    },
+    articleId: {
+      type: Sequelize.INTEGER
+    },
+    userId: {
+      type: Sequelize.INTEGER
+    },
+    highlightText: {
+      type: Sequelize.TEXT
+    },
+    comment: {
+      type: Sequelize.TEXT
+    },
+    occurencyNumber: {
+      type: Sequelize.INTEGER
+    },
+    createdAt: {
+      allowNull: false,
+      type: Sequelize.DATE
+    },
+    updatedAt: {
+      allowNull: false,
+      type: Sequelize.DATE
+    }
+  }),
+  down: queryInterface => queryInterface.dropTable('Highlights')
+};

src/sequelize/models/highlights.js

@@ -0,0 +1,13 @@
+export default (sequelize, DataTypes) => {
+  const Highlights = sequelize.define('Highlights', {
+    articleId: DataTypes.INTEGER,
+    userId: DataTypes.INTEGER,
+    highlightText: DataTypes.TEXT,
+    comment: DataTypes.TEXT,
+    occurencyNumber: DataTypes.INTEGER
+  }, {});
+  Highlights.associate = () => {
+    // associations can be defined here
+  };
+  return Highlights;
+};

test/highlight.test.js

@@ -0,0 +1,98 @@
+import chai from 'chai';
+import chaiHttp from 'chai-http';
+import dotenv from 'dotenv';
+import server from '../src/index';
+import db from '../src/sequelize/models';
+import tokenHelper from '../src/helpers/Token.helper';
+
+
+const { User, Article } = db;
+// eslint-disable-next-line no-unused-vars
+const should = chai.should();
+
+chai.use(chaiHttp);
+const { expect } = chai;
+
+dotenv.config();
+
+let newArticle;
+const highlight = {
+  highlightText: 'Rwanda',
+  comment: 'Thank you',
+  occurencyNumber: 1
+};
+const invalidHighlight = {
+  highlightText: 'Blablablabla',
+  comment: 'Thank you',
+  occurencyNumber: 1
+};
+
+describe('Highlight the Article', () => {
+  let token;
+  before(async () => {
+    const user = {
+      firstName: 'Emy',
+      lastName: 'Rukundo',
+      username: 'mifeillee',
+      email: 'nimilleer@gmail.com',
+      password: 'Rukundo1!',
+      confirmPassword: 'Rukundo1!'
+    };
+    const newUser = await User.create(user);
+
+    token = await tokenHelper.generateToken({ id: newUser.id });
+
+    const article = {
+      title: 'Andela Kigali Launch',
+      description: 'Andela Rwanda, a technology company specializing in training software engineers on Thursday last week launched its Kigali office. Its new offices are housed within the University of Rwanda - College of Science and Technology, in Muhabura Block.',
+      body: 'Andela Rwanda, a technology company specializing in training software engineers on Thursday last week launched its Kigali office. Its new offices are housed within the University of Rwanda - College of Science and Technology, in Muhabura Block. The firm made their debut in Rwanda in July last year, with pan-African hub, the first of its kind. This was followed by the announcement in October of Clement Uwajeneza as the Country Director. The firm has a Memorandum of Understanding with the government to recruit, train and connect to market about 500 young software engineers in the country',
+      tagList: ['Tech', 'Kigali'],
+      authorId: newUser.id,
+      slug: 'slyg',
+      readtime: '1 min'
+    };
+    newArticle = await Article.create(article);
+  });
+  it('should highlight with comment or without', (done) => {
+    chai.request(server)
+      .post(`/api/articles/${newArticle.slug}/highlight`)
+      .set('token', token)
+      .send(highlight)
+      .end((err, res) => {
+        res.should.have.status(201);
+        expect(res.body.Message).to.be.a('string');
+        done();
+      });
+  });
+  it('should raise an error when the user highlights the same text ', (done) => {
+    chai.request(server)
+      .post(`/api/articles/${newArticle.slug}/highlight`)
+      .set('token', token)
+      .send(highlight)
+      .end((err, res) => {
+        res.should.have.status(403);
+        expect(res.body.Message).to.be.a('string');
+        done();
+      });
+  });
+  it('should raise an error when the highlighter text exist', (done) => {
+    chai.request(server)
+      .post(`/api/articles/${newArticle.slug}/highlight`)
+      .set('token', token)
+      .send(invalidHighlight)
+      .end((err, res) => {
+        res.should.have.status(404);
+        expect(res.body.Message).to.be.a('string');
+        done();
+      });
+  });
+  it('should raise an error when the user is not logged in', (done) => {
+    chai.request(server)
+      .post(`/api/articles/${newArticle.slug}/highlight`)
+      .set('token', ' ')
+      .end((err, res) => {
+        res.should.have.status(401);
+        done();
+      });
+  });
+});