feat(like): users can like articles

- Write unit test - add route to like articles - add user can like articles controller [Delivers #159206057]
andela · Aug 16, 2018 · 56bfd5c · 56bfd5c
1 parent 6b9dd41
commit 56bfd5c
Show file tree

Hide file tree

Showing 13 changed files with 429 additions and 36 deletions.
diff --git a/controllers/ArticleController.js b/controllers/ArticleController.js
@@ -1,6 +1,8 @@
 import cloudinary from 'cloudinary';
+import { Op } from 'sequelize';
 import Utilities from '../helpers/utilities';
-import { Article, User } from '../models';
+import { Article, User, Like } from '../models';
+
 import createArticleHelper from '../helpers/createArticleHelper';
 
 /**
@@ -23,6 +25,7 @@ class ArticleController {
 
     const { userId } = req;
 
+
     const articleObject = {
       title, description, body, tagList, imageUrl, userId
     };
@@ -75,17 +78,17 @@ class ArticleController {
         }
 
         return res.status(200).json({ article });
-      })
-      .catch(() => res.status(501).send('oops seems there is an error finding the article'));
+      });
   }
 
   /**
    * get all articles created
    * @param {object} req - request object
    * @param {object} res - response object
+   * @param {object} next: response object
    * @returns {object} - the found article from database or empty if not found
    */
-  static listAllArticles(req, res) {
+  static listAllArticles(req, res, next) {
     return Article
       .findAll({
         include: [{
@@ -105,7 +108,7 @@ class ArticleController {
 
         return res.status(200).json({ articles, articlesCount: articles.length });
       })
-      .catch(() => res.status(501).send('oops seems there is an error finding all articles'));
+      .catch(next);
   }
 
   /**
@@ -114,11 +117,12 @@ class ArticleController {
   * to edit 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 editArticle(req, res) {
+  static editArticle(req, res, next) {
     const { title, description, body } = req.body.article;
     const { count } = req;
     const { slug } = req.params;
@@ -138,16 +142,7 @@ class ArticleController {
         success: true,
         article: result[1]
       }))
-      .catch((err) => {
-        res.status(500).json({
-          errors: {
-            body: [
-              'sorry there was an error updating this article',
-              err
-            ]
-          }
-        });
-      });
+      .catch(next);
   }
 
   /**
@@ -156,26 +151,88 @@ class ArticleController {
 * to delete 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 deleteArticle(req, res) {
+  static deleteArticle(req, res, next) {
     const { slug } = req.params;
     Article.destroy({
       where: { slug }
     })
       .then(() => res.status(204).json())
-      .catch(() => {
-        res.status(500).json({
-          errors: {
-            body: [
-              'sorry there was an error deleting this article',
-            ]
-          }
+      .catch(next);
+  }
+
+  /**
+   * @description - model query function
+   * @static
+   *
+   *
+   * @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;
diff --git a/helpers/createArticleHelper.js b/helpers/createArticleHelper.js
@@ -30,7 +30,7 @@ const createArticleHelper = (res, articleObject, imageUrl = null) => {
         model: User,
         attributes: { exclude: ['id', 'email', 'hashedPassword', 'createdAt', 'updatedAt'] }
       }],
-      attributes: { exclude: ['id', 'userId'] }
+      attributes: { exclude: ['userId'] }
     }))
     .then(article => res.status(201).json({ article }))
     .catch(err => res.status(400).send({

diff --git a/helpers/utilities.js b/helpers/utilities.js
@@ -137,6 +137,7 @@ export default class Utilities {
       })
       .catch(next);
   }
+
   /** @function increaseCount
   * @summary: API controller to handle requests
   * to delete an article

diff --git a/middlewares/checkArticle.js b/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;
diff --git a/middlewares/idIsInteger.js b/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;
diff --git a/migrations/20180807152049-create-likes.js b/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');
+  }
+};
diff --git a/models/Article.js b/models/Article.js
@@ -34,7 +34,10 @@ module.exports = (sequelize, DataTypes) => {
         onDelete: 'CASCADE',
       }
     );
+    Article.hasMany(models.Like, {
+      foreignKey: 'articleId',
+      as: 'likes',
+    });
   };
-
   return Article;
 };
diff --git a/models/Likes.js b/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;
+};
diff --git a/models/User.js b/models/User.js
@@ -42,6 +42,10 @@ module.exports = (sequelize, DataTypes) => {
       foreignKey: 'userId',
       as: 'articles',
     });
+    User.hasMany(models.Like, {
+      foreignKey: 'userId',
+      as: 'likes',
+    });
   };
   return User;
 };