Merge a848f1b into e1be332

controllers/comment.js

@@ -6,14 +6,15 @@ import {
 
 const {
   comments, sequelize, articles, users,
+  highlightArticleComments
 } = db;
 
 class Comment {
   static async createComment(req, res) {
+    const transaction = await sequelize.transaction();
     const { body } = req.body;
     const { slug } = req.params;
     const { username } = req.decoded;
-    const transaction = await sequelize.transaction();
     try {
       const article = await articles.findOne({
         where: {
@@ -140,5 +141,33 @@ class Comment {
       });
     }
   }
+
+  static async highlightTextAndComment(req, res) {
+    try {
+      const { articleSlug } = req.params;
+      const {
+        comment, highlight, startIndex, stopIndex
+      } = req.body;
+      const { email } = req.decoded;
+      const article = await articles.findOne({ where: { slug: articleSlug } });
+      const user = await users.findOne({ where: { email } });
+      const highlightText = await highlightArticleComments.create({
+        startIndex,
+        stopIndex,
+        highlight,
+        comment,
+        articleSlug: article.slug,
+        authorId: user.id
+      }, { returning: true });
+      return res.status(201).json({
+        message: 'successfully commented on text',
+        highlightText
+      });
+    } catch (error) {
+      return res.status(500).json({
+        error: 'failed to comment on highlited text'
+      });
+    }
+  }
 }
 export default Comment;

index.js

@@ -47,7 +47,7 @@ app.use(passport.session());
 app.use(router);
 
 app.all('*', (_req, res) => {
-  res.status(400).json({
+  res.status(404).json({
     error: 'address not found',
   });
 });

middlewares/index.js

@@ -1,2 +1,3 @@
 export * from './checkToken';
 export * from './checkDb';
+export * from './validations/highlightsValidations';

middlewares/validations/highlightsValidations.js

@@ -0,0 +1,34 @@
+import db from '../../models';
+
+const {
+  articles
+} = db;
+
+export const checkHighlightAndComment = async (req, res, next) => {
+  const {
+    highlight, startIndex, stopIndex, comment
+  } = req.body;
+  const { articleSlug } = req.params;
+  const article = await articles.findOne({
+    where: { slug: articleSlug }
+  });
+  if (!article) {
+    return res.status(404).json({ error: 'failed to find article' });
+  }
+  switch (true) {
+    case highlight === null || highlight === undefined
+      || highlight === '' || startIndex === null
+      || startIndex === undefined || startIndex === ''
+      || stopIndex === null || stopIndex === undefined
+      || stopIndex === '' || comment === null
+      || comment === undefined || comment === '':
+      return res.status(400).json({ error: 'highlight, startIndex, stopIndex and comment cannot be left empty' });
+    case typeof startIndex === 'string' || stopIndex === 'string':
+      return res.status(400).json({ error: 'startIndex and stopIndex can only be number' });
+    case stopIndex > article.body.length:
+      return res.status(400).json({ error: 'stopIndex is invalid' });
+    case startIndex < 0:
+      return res.status(400).json({ error: 'startIndex is invalid' });
+  }
+  next();
+};

migrations/20190729040846-createTableHighlightComments.js

@@ -0,0 +1,52 @@
+export const up = (queryInterface, Sequelize) => queryInterface.createTable('highlightArticleComments', {
+  id: {
+    type: Sequelize.UUID,
+    defaultValue: Sequelize.UUIDV4,
+    allowNull: false,
+    primaryKey: true
+  },
+  startIndex: {
+    type: Sequelize.INTEGER,
+    allowNull: false
+  },
+  stopIndex: {
+    type: Sequelize.INTEGER,
+    allowNull: false
+  },
+  highlight: {
+    type: Sequelize.TEXT,
+    allowNull: false
+  },
+  comment: {
+    type: Sequelize.TEXT,
+    allowNull: false
+  },
+  articleSlug: {
+    type: Sequelize.STRING,
+    allowNull: false,
+    onDelete: 'CASCADE',
+    references: {
+      model: 'articles',
+      key: 'slug'
+    }
+  },
+  authorId: {
+    type: Sequelize.UUID,
+    allowNull: false,
+    onDelete: 'CASCADE',
+    references: {
+      model: 'users',
+      key: 'id'
+    }
+  },
+  createdAt: {
+    type: Sequelize.DATE,
+    default: true
+  },
+  updatedAt: {
+    type: Sequelize.DATE,
+    default: true
+  }
+});
+
+export const down = queryInterface => queryInterface.dropTable('highlightArticleComments');

models/articles.js

@@ -45,6 +45,7 @@ export default (sequelize, DataTypes) => {
   });
   articles.associate = (models) => {
     articles.belongsTo(models.users, { as: 'author', foreignKey: 'authorId' });
+    articles.hasMany(models.highlightArticleComments, { foreignKey: 'articleSlug', sourceKey: 'slug' });
     articles.hasMany(models.bookmark, { foreignKey: 'articleId' });
     articles.hasMany(models.ratings, { as: 'ratings', foreignKey: 'articleSlug', sourceKey: 'slug' });
     articles.hasMany(models.likes, { as: 'likes', foreignKey: 'articleSlug', sourceKey: 'slug' });

models/highlightArticleComments.js

@@ -0,0 +1,58 @@
+export default (sequelize, DataTypes) => {
+  const highlightArticleComments = sequelize.define('highlightArticleComments', {
+    id: {
+      type: DataTypes.UUID,
+      defaultValue: DataTypes.UUIDV4,
+      allowNull: false,
+      primaryKey: true
+    },
+    startIndex: {
+      type: DataTypes.INTEGER,
+      allowNull: false
+    },
+    stopIndex: {
+      type: DataTypes.INTEGER,
+      allowNull: false
+    },
+    highlight: {
+      type: DataTypes.TEXT,
+      allowNull: false
+    },
+    comment: {
+      type: DataTypes.TEXT,
+      allowNull: false
+    },
+    articleSlug: {
+      type: DataTypes.STRING,
+      allowNull: false,
+      onDelete: 'CASCADE',
+      references: {
+        model: 'articles',
+        key: 'slug'
+      }
+    },
+    authorId: {
+      type: DataTypes.UUID,
+      allowNull: false,
+      onDelete: 'CASCADE',
+      references: {
+        model: 'users',
+        key: 'id'
+      }
+    },
+    createdAt: {
+      type: DataTypes.DATE,
+      default: true
+    },
+    updatedAt: {
+      type: DataTypes.DATE,
+      default: true
+    }
+  },
+  {});
+  highlightArticleComments.associate = (models) => {
+    highlightArticleComments.belongsTo(models.users, { as: 'author', foreignKey: 'authorId' });
+    highlightArticleComments.belongsTo(models.articles, { foreignKey: 'articleSlug' });
+  };
+  return highlightArticleComments;
+};

models/users.js

@@ -75,8 +75,7 @@ export default (sequelize, DataTypes) => {
     users.hasMany(models.articles, { as: 'author', foreignKey: 'authorId' });
     users.hasMany(models.ratings, { foreignKey: 'userId' });
     users.hasMany(models.likes, { as: 'liker', foreignKey: 'userId', sourceKey: 'id' });
-    users.hasMany(models.articles, { foreignKey: 'authorId', allowNull: false });
-    users.hasMany(models.comments, { foreignKey: 'authorId', allowNull: false });
+    users.hasMany(models.highlightArticleComments, { foreignKey: 'authorId', sourceKey: 'id' });
     users.hasMany(models.Follow, { as: 'User', foreignKey: 'followed' });
     users.hasMany(models.bookmark, { foreignKey: 'userId', allowNull: false });
     users.hasMany(models.articleStats, { foreignKey: 'userId' });

routes/api/articles.js

@@ -162,7 +162,6 @@ router.put('/articles/:slug', checkToken, checkArticleOwner, uploadImage, valida
 *         description: Article deleted successfully
 */
 router.delete('/articles/:slug', checkToken, checkArticleOwner, article.deleteArticle);
-
 /**
 * @swagger
 *  /api/articles/{slug}/share/{channel}:

routes/api/comments.js

@@ -1,6 +1,6 @@
 import express from 'express';
 import commentController from '../../controllers/comment';
-import { checkToken } from '../../middlewares';
+import { checkToken, checkHighlightAndComment } from '../../middlewares';
 
 const router = express.Router();
 
@@ -39,5 +39,6 @@ const router = express.Router();
 router.post('/articles/:slug/comments', checkToken, commentController.createComment);
 router.get('/articles/:articleSlug/comments', commentController.getArticleComments);
 router.delete('/comments/:commentId', checkToken, commentController.deleteComment);
+router.post('/articles/:articleSlug/highlight/comments', checkToken, checkHighlightAndComment, commentController.highlightTextAndComment);
 
 export default router;

seeders/20190726112201-comments.js → seeders/20190731072414-comments.js

@@ -19,4 +19,4 @@ export const up = (queryInterface, Sequelize) => queryInterface.bulkInsert(
   {}
 );
 
-const down = (queryInterface, Sequelize) => queryInterface.bulkDelete('comments', null, {});
+const down = (queryInterface, Sequelize) => queryInterface.bulkDelete('comments', null, {});

tests/comment.test.js

@@ -177,4 +177,71 @@ describe('Create, Get and Delete Comment', () => {
         done();
       });
   });
+  it('Should let user comment on highlited text in an article with valid details', (done) => {
+    chai
+      .request(app)
+      .post(`/api/articles/${slugArticle}/highlight/comments`)
+      .set('Authorization', `Bearer ${authToken}`)
+      .send(user.highlightText)
+      .end((err, res) => {
+        expect(res.statusCode).to.be.equal(201);
+        expect(res.body.message).to.be.equal('successfully commented on text');
+        expect(res.body.highlightText).to.have.property('comment');
+        expect(res.body.highlightText).to.have.property('startIndex');
+        expect(res.body.highlightText).to.have.property('stopIndex');
+        done();
+      });
+  });
+  it('Should not let user comment on highlited text in an article with invalid Indexes', (done) => {
+    chai
+      .request(app)
+      .post(`/api/articles/${slugArticle}/highlight/comments`)
+      .set('Authorization', `Bearer ${authToken}`)
+      .send(user.invalidEndIndex)
+      .end((err, res) => {
+        expect(res.statusCode).to.be.equal(400);
+        expect(res.body.error).to.be.equal('stopIndex is invalid');
+        expect(res.body).to.have.property('error');
+        done();
+      });
+  });
+  it('Should not let user comment on highlited text in an article with invalid null body', (done) => {
+    chai
+      .request(app)
+      .post(`/api/articles/${slugArticle}/highlight/comments`)
+      .set('Authorization', `Bearer ${authToken}`)
+      .send(user.nullIndex)
+      .end((err, res) => {
+        expect(res.statusCode).to.be.equal(400);
+        expect(res.body.error).to.be.equal('highlight, startIndex, stopIndex and comment cannot be left empty');
+        expect(res.body).to.have.property('error');
+        done();
+      });
+  });
+  it('Should not let user comment on highlited text in an article with negative Indexes than article', (done) => {
+    chai
+      .request(app)
+      .post(`/api/articles/${slugArticle}/highlight/comments`)
+      .set('Authorization', `Bearer ${authToken}`)
+      .send(user.negativeIndex)
+      .end((err, res) => {
+        expect(res.statusCode).to.be.equal(400);
+        expect(res.body.error).to.be.equal('startIndex is invalid');
+        expect(res.body).to.have.property('error');
+        done();
+      });
+  });
+  it('Should not let user comment on highlited text in an article with invalidSlug', (done) => {
+    chai
+      .request(app)
+      .post('/api/articles/thelondon/highlight/comments')
+      .set('Authorization', `Bearer ${authToken}`)
+      .send(user.highlightText)
+      .end((err, res) => {
+        expect(res.statusCode).to.be.equal(404);
+        expect(res.body.error).to.be.equal('failed to find article');
+        expect(res.body).to.have.property('error');
+        done();
+      });
+  });
 });

tests/index.test.js

@@ -167,6 +167,33 @@ const article2 = {
   tagList: 'nodejs, programming'
 };
 
+const highlightText = {
+  startIndex: 1,
+  stopIndex: 24,
+  highlight: 'language which has many',
+  comment: 'change tense'
+};
+
+const invalidEndIndex = {
+  startIndex: 1,
+  stopIndex: 1000,
+  highlight: 'language which has many',
+  comment: 'change tense'
+};
+
+const nullIndex = {
+  startIndex: 1,
+  highlight: 'language which has many',
+  comment: 'change tense'
+};
+
+const negativeIndex = {
+  startIndex: -12,
+  stopIndex: 20,
+  highlight: 'language which has many',
+  comment: 'change tense'
+};
+
 // twitter user
 export const twitterUser = (req, res, next) => {
   req.user = {
@@ -234,5 +261,9 @@ export default {
   secondLogin,
   givenArticle,
   givenComment1,
-  givenComment2
+  givenComment2,
+  highlightText,
+  invalidEndIndex,
+  nullIndex,
+  negativeIndex
 };