feat(like): users can like articles

- Write unit test
- add route to like articles
- add user can like articles controller

[Delivers #159206057]

controllers/ArticleController.js

@@ -1,6 +1,7 @@
+import { Op } from 'sequelize';
 import cloudinary from '../config/cloudinary';
 import Utilities from '../helpers/utilities';
-import { Article, User } from '../models';
+import { Article, User, Like } from '../models';
 import createArticleHelper from '../helpers/createArticleHelper';
 
 /**
@@ -59,6 +60,7 @@ class ArticleController {
           model: User,
           attributes: { exclude: ['id', 'email', 'hashedPassword', 'createdAt', 'updatedAt'] }
         }],
+        attributes: { exclude: ['userId'] }
       })
       .then((article) => {
         // if the article does not exist
@@ -174,6 +176,70 @@ class ArticleController {
       .then(() => res.status(200).json({ message: 'Article successfully deleted' }))
       .catch(next);
   }
+
+  /**
+  * @function CountLikes
+  * @summary: controller to handle counting likes
+  * @param {object} res
+  * @param {integer} id
+  * @returns {object} newOrFoundUser
+  * @memberof AuthController
+  */
+  static countLikes(res, id) {
+    Like.findAndCountAll({
+      where: {
+        [Op.and]: [
+          { articleId: id }
+        ]
+      }
+    })
+      .then((articleLikes) => {
+        res.status(200).json({
+          success: 'true',
+          totalLikes: articleLikes.count,
+        });
+      });
+  }
+
+
+  /**
+  * @function likeArticle
+  * @summary: API controller to handle requests to like an article
+  * @param {object} req: request object
+  * @param {object} res: response object
+  * @param {object} next: response object
+  * @returns {object} api response: article object for
+  * successful requests, or error object for
+  * requests that fail
+  */
+  static likeArticle(req, res, next) {
+    const { userId } = req;
+    const { id } = req.params;
+    Like.find({
+      where: {
+        userId, articleId: id
+      }
+    })
+      .then((like) => {
+        if (!like) {
+          Like.create({
+            articleId: id,
+            userId,
+          })
+            .then(() => {
+              ArticleController.countLikes(res, id);
+            });
+        } else {
+          Like.destroy({
+            where: { id: like.id }
+          })
+            .then(() => {
+              ArticleController.countLikes(res, id);
+            });
+        }
+      })
+      .catch(next);
+  }
 }
 
 export default ArticleController;

helpers/utilities.js

@@ -140,6 +140,7 @@ export default class Utilities {
       })
       .catch(next);
   }
+
   /**
   * @function increaseCount
   * @summary: A funtion to increase count

index.js

@@ -9,8 +9,9 @@ import methodOverride from 'method-override';
 import morgan from 'morgan';
 import debugLog from 'debug';
 import expressValidator from 'express-validator';
-
 import { } from 'dotenv/config';
+import cloudinary from 'cloudinary';
+import config from './config';
 import passportConfig from './config/passport';
 import routes from './routes';
 

middlewares/checkArticle.js

@@ -0,0 +1,29 @@
+import { Article } from '../models';
+/**
+   * validate Request id parameter
+   * @param {Object} req
+   * @param {Object} res
+   *
+   * @param {Function} next
+   *
+   * @return {Object} json
+   */
+const checkArticle = (req, res, next) => {
+  const { id } = req.params;
+  Article.find({
+    where: {
+      id
+    }
+  })
+    .then((article) => {
+      if (article) return next();
+      return res.status(404).json({
+        errors: {
+          body: [
+            'Ooops! the article cannot be found.'
+          ]
+        }
+      });
+    });
+};
+export default checkArticle;

middlewares/idIsInteger.js

@@ -0,0 +1,36 @@
+import Validate from 'validatorjs';
+
+/**
+* validate Request id parameter
+* @param {Object} req
+* @param {Object} res
+*
+* @param {Function} next
+*
+* @return {Object} json
+*/
+const idIsNumber = (req, res, next) => {
+  const {
+    id,
+  } = req.params;
+
+  const data = {
+    id,
+  };
+  const rules = {
+    id: ['required', 'integer'],
+  };
+  const validations = new Validate(data, rules, {
+    'integer.id': 'The parameter :attribute must be an integer.',
+  });
+
+  if (validations.passes()) {
+    return next();
+  }
+
+  return res.status(406).json({
+    success: 'false',
+    errors: validations.errors.all(),
+  });
+};
+export default idIsNumber;

middlewares/validateArticle.js

@@ -7,33 +7,17 @@
  *  or continue to the next middleware using next()
  */
 const validateArticle = (req, res, next) => {
-<<<<<<< HEAD
   if (!req.body.article) {
     return res.status(400).json({
       errors: {
         body: [
           'Please check that article field is present'
-=======
-  let { title, description, body } = req.body.article;
-  try {
-    title = title.trim();
-    description = description.trim();
-    body = body.trim();
-  } catch (error) {
-    return res.status(400).json({
-      errors: {
-        body: [
-          'Please check that your title, description or body field is not empty'
->>>>>>> ft(create-article): create user article
         ]
       }
     });
   }
-<<<<<<< HEAD
   const { title, description, body } = req.body.article;
 
-=======
->>>>>>> ft(create-article): create user article
   if (!title || !description || !body) {
     return res.status(400).json({
       errors: {
@@ -43,12 +27,9 @@ const validateArticle = (req, res, next) => {
       }
     });
   }
-<<<<<<< HEAD
   req.body.article.title = title.trim();
   req.body.article.description = description.trim();
   req.body.article.body = body.trim();
-=======
->>>>>>> ft(create-article): create user article
 
   next();
 };

migrations/20180730142739-create-article.js

@@ -16,22 +16,14 @@ module.exports = {
       type: Sequelize.STRING
     },
     body: {
-<<<<<<< HEAD
       type: Sequelize.TEXT
-=======
-      type: Sequelize.STRING
->>>>>>> ft(create-article): create user article
     },
     updatedCount: {
       type: Sequelize.INTEGER,
       defaultValue: '0'
     },
     tagList: {
-<<<<<<< HEAD
       type: Sequelize.ARRAY(Sequelize.STRING)
-=======
-      type: Sequelize.ARRAY(Sequelize.TEXT)
->>>>>>> ft(create-article): create user article
     },
     favorited: {
       type: Sequelize.BOOLEAN

migrations/20180807152049-create-likes.js

@@ -0,0 +1,39 @@
+module.exports = {
+  up: (queryInterface, Sequelize) => queryInterface.createTable('Likes', {
+    id: {
+      allowNull: false,
+      autoIncrement: true,
+      primaryKey: true,
+      type: Sequelize.INTEGER
+    },
+    createdAt: {
+      allowNull: false,
+      type: Sequelize.DATE
+    },
+    updatedAt: {
+      allowNull: false,
+      type: Sequelize.DATE
+    },
+    articleId: {
+      type: Sequelize.INTEGER,
+      onDelete: 'CASCADE',
+      references: {
+        model: 'Articles',
+        key: 'id',
+        as: 'articleId',
+      },
+    },
+    userId: {
+      type: Sequelize.INTEGER,
+      onDelete: 'CASCADE',
+      references: {
+        model: 'Users',
+        key: 'id',
+        as: 'userId',
+      },
+    },
+  }),
+  down: (queryInterface/* , Sequelize */) => {
+    queryInterface.dropTable('Likes');
+  }
+};

models/Article.js

@@ -34,7 +34,10 @@ module.exports = (sequelize, DataTypes) => {
         onDelete: 'CASCADE',
       }
     );
+    Article.hasMany(models.Like, {
+      foreignKey: 'articleId',
+      as: 'likes',
+    });
   };
-
   return Article;
 };

models/Likes.js

@@ -0,0 +1,16 @@
+
+module.exports = (sequelize) => {
+  const Like = sequelize.define('Like', {}, {});
+
+  Like.associate = (models) => {
+    Like.belongsTo(models.Article, {
+      foreignKey: 'articleId',
+      as: 'likedArticle',
+    });
+    Like.belongsTo(models.User, {
+      foreignKey: 'userId',
+      as: 'user',
+    });
+  };
+  return Like;
+};

models/User.js

@@ -47,6 +47,10 @@ module.exports = (sequelize, DataTypes) => {
       as: 'amFollowing',
       foreignKey: 'userId'
     });
+    User.hasMany(models.Like, {
+      foreignKey: 'userId',
+      as: 'likes',
+    });
   };
   return User;
 };