[finishes #162171014] Document all API using swagger

andela · Jan 8, 2019 · d61f199 · d61f199
2 parents 55f517b + 510cccf
commit d61f199
Show file tree

Hide file tree

Showing 31 changed files with 3,581 additions and 2,664 deletions.
diff --git a/controllers/ArticlesController.js b/controllers/ArticlesController.js
@@ -7,7 +7,9 @@ import {
   checkUser,
   checkTitle,
   createNewTags,
-  calcReadingTime
+  calcReadingTime,
+  userIsOnwerOrAdmin,
+  checkUserRole
 } from '../helpers/articleHelper';
 import ReadingStatsModelQuery from '../lib/ReadingStatsModelQuery';
 import eventEmitter from '../helpers/eventEmitter';
@@ -69,8 +71,13 @@ class ArticlesController {
     const {
       size = 20, order = 'ASC', orderBy = 'id', offset = 0
     } = req.query;
+
     try {
       const articles = await Article.findAndCountAll({
+        where: {
+          isPublished: true,
+          isArchived: false
+        },
         include: [
           {
             model: Tag,
@@ -102,6 +109,101 @@ class ArticlesController {
     }
   }
 
+  /**
+   * @description - list archived articles
+   * @param {object} req
+   * @param {object} res
+   * @returns {object} Returned object
+   */
+  static async getArchived(req, res) {
+    const {
+      size = 20, order = 'ASC', orderBy = 'id', offset = 0
+    } = req.query;
+
+    try {
+      const articles = await Article.findAndCountAll({
+        where: {
+          isArchived: true
+        },
+        include: [
+          {
+            model: Tag,
+            as: 'tags',
+            attributes: ['tagName'],
+            through: {
+              attributes: []
+            }
+          }
+        ],
+        limit: size,
+        offset,
+        order: [[orderBy, order]]
+      });
+      if (articles.rows.length === 0) {
+        return StatusResponse.success(res, {
+          message: 'No article found'
+        });
+      }
+      return StatusResponse.success(res, {
+        message: 'List of archived articles',
+        articles,
+        ...pagination(articles, offset, size)
+      });
+    } catch (error) {
+      return StatusResponse.internalServerError(res, {
+        message: `something went wrong, please try again.... ${error}`
+      });
+    }
+  }
+
+  /**
+   * @description - list unpublished articles
+   * @param {object} req
+   * @param {object} res
+   * @returns {object} Returned object
+   */
+  static async getUnpublished(req, res) {
+    const {
+      size = 20, order = 'ASC', orderBy = 'id', offset = 0
+    } = req.query;
+
+    try {
+      const articles = await Article.findAndCountAll({
+        where: {
+          isPublished: false,
+          isArchived: false,
+        },
+        include: [
+          {
+            model: Tag,
+            as: 'tags',
+            attributes: ['tagName'],
+            through: {
+              attributes: []
+            }
+          }
+        ],
+        limit: size,
+        offset,
+        order: [[orderBy, order]]
+      });
+      if (articles.rows.length === 0) {
+        return StatusResponse.success(res, {
+          message: 'No article found'
+        });
+      }
+      return StatusResponse.success(res, {
+        message: 'List of unpublished articles',
+        articles,
+        ...pagination(articles, offset, size)
+      });
+    } catch (error) {
+      return StatusResponse.internalServerError(res, {
+        message: `something went wrong, please try again.... ${error}`
+      });
+    }
+  }
+
   /**
    * @description - fetch single article
    * @param {object} req
@@ -110,10 +212,14 @@ class ArticlesController {
    */
   static async get(req, res) {
     const whereFilter = checkIdentifier(req.params.identifier);
+    const { userId, roleId } = req.app.locals.user;
 
     try {
       const fetchArticle = await Article.findOne({
-        where: { ...whereFilter },
+        where: {
+          ...whereFilter,
+          ...checkUserRole(roleId, userId)
+        },
         include: [
           {
             model: Tag,
@@ -129,14 +235,33 @@ class ArticlesController {
           }
         ]
       });
-      if (req.app.locals.user) {
-        const { userId } = req.app.locals.user;
+      if (!fetchArticle) {
+        return StatusResponse.notfound(res, {
+          message: 'Could not find article'
+        });
+      }
+
+      if (userId) {
         const readInfo = {
           articleId: fetchArticle.id,
           userId
         };
         await ReadingStatsModelQuery.createReaderStats(readInfo);
       }
+      if ((fetchArticle.userId === userId)
+       || (roleId === 3 || (userId && fetchArticle.isPublished))) {
+        return StatusResponse.success(res, {
+          message: 'success',
+          article: fetchArticle
+        });
+      }
+
+      if (roleId !== 1 && (userId && !fetchArticle.isPublished)) {
+        return StatusResponse.notfound(res, {
+          message: 'Could not find article'
+        });
+      }
+
       return StatusResponse.success(res, {
         message: 'success',
         article: fetchArticle
@@ -213,23 +338,84 @@ class ArticlesController {
    */
   static async archive(req, res) {
     const { articles } = models;
-    const { userId } = req.app.locals.user;
+    const { userId, roleId } = req.app.locals.user;
     const whereFilter = checkIdentifier(req.params.identifier);
     try {
       const article = await ArticleQueryModel.getArticleByIdentifier(whereFilter);
-      if (!checkUser(article, userId)) {
+
+      if (!userIsOnwerOrAdmin(article, userId, roleId)) {
         return StatusResponse.forbidden(res, {
           message: 'Request denied'
         });
       }
       const data = { isArchived: true };
-      await articles.update(data, {
+      const archivedArticle = await articles.update(data, {
+        where: { ...whereFilter },
+        returning: true,
+        plain: true
+      });
+      const payload = roleId === 1
+        ? {
+          message: 'Article deleted(archived) successfully',
+          article: archivedArticle[1]
+        }
+        : {
+          message: 'Article deleted(archived) successfully'
+        };
+      return StatusResponse.success(res, payload);
+    } catch (error) {
+      return StatusResponse.internalServerError(res, {
+        message: `something went wrong, please try again.... ${error}`
+      });
+    }
+  }
+
+  /**
+   * @description - publish article
+   * @param {object} req
+   * @param {object} res
+   * @returns {object} Returned object
+   */
+  static async publish(req, res) {
+    const { articles } = models;
+    const whereFilter = checkIdentifier(req.params.identifier);
+    try {
+      const data = { isPublished: true };
+      const article = await articles.update(data, {
+        where: { ...whereFilter },
+        returning: true,
+        plain: true
+      });
+      return StatusResponse.success(res, {
+        message: 'Article published successfully!',
+        article: article[1]
+      });
+    } catch (error) {
+      return StatusResponse.internalServerError(res, {
+        message: `something went wrong, please try again.... ${error}`
+      });
+    }
+  }
+
+  /**
+   * @description - publish article
+   * @param {object} req
+   * @param {object} res
+   * @returns {object} Returned object
+   */
+  static async unpublish(req, res) {
+    const { articles } = models;
+    const whereFilter = checkIdentifier(req.params.identifier);
+    try {
+      const data = { isPublished: false };
+      const article = await articles.update(data, {
         where: { ...whereFilter },
         returning: true,
         plain: true
       });
       return StatusResponse.success(res, {
-        message: 'Article deleted(archived) successfully'
+        message: 'Article unpublished successfully!',
+        article: article[1]
       });
     } catch (error) {
       return StatusResponse.internalServerError(res, {

diff --git a/controllers/AuthController.js b/controllers/AuthController.js
@@ -50,7 +50,7 @@ class AuthController {
 
       mailer.sendVerificationMail(email, username, link);
 
-      const { id: roleId } = await roles.find({ where: { name: 'user' } });
+      const { id: roleId } = await roles.find({ where: { name: 'author' } });
       const newUser = await users.create(
         {
           email,

diff --git a/controllers/CommentHistoriesController.js b/controllers/CommentHistoriesController.js
@@ -1,6 +1,7 @@
 import models from '../models';
 import StatusResponse from '../helpers/StatusResponse';
 import { checkUser } from '../helpers/articleHelper';
+import { getArticleWhereClause, getCommentWhereClause } from '../helpers/commentHelper';
 
 const { comments, articles } = models;
 
@@ -60,7 +61,7 @@ class CommentHistoriesController {
         limit: 1
       });
 
-
+      updatedComment[1].commentId = undefined;
       await comments.create(latestComment.dataValues);
 
       return StatusResponse.success(res, {
@@ -82,15 +83,27 @@ class CommentHistoriesController {
    */
   static async getACommentHistory(req, res) {
     const { articleId, commentId } = req.params;
+    const { userId, roleId } = req.app.locals.user;
+
     try {
+      const article = await articles.findOne({ where: { id: articleId } });
+      if (!article) {
+        return StatusResponse.notfound(res, {
+          message: 'Article Not Found'
+        });
+      }
+      const comment = await comments.findOne({ where: { commentId: null, id: commentId } });
+      if (!comment) {
+        return StatusResponse.notfound(res, {
+          message: 'Comment Not Found'
+        });
+      }
       const commentHistory = await comments.findAll({
-        where: { articleId, commentId, isArchived: false },
+        where: { articleId, commentId, ...getCommentWhereClause(article, comment, roleId, userId) },
         order: [['id', 'DESC']],
         include: [{
           model: articles,
-          where: {
-            isArchived: false
-          },
+          where: getArticleWhereClause(article, roleId, userId),
           attributes: []
         }],
       });

diff --git a/controllers/FollowersController.js b/controllers/FollowersController.js
@@ -94,7 +94,7 @@ class FollowersController {
         return StatusResponse.notfound(res, payload);
       }
       const payload = {
-        message: allReturnedFollowers
+        data: allReturnedFollowers
       };
       return StatusResponse.success(res, payload);
     } catch (error) {
@@ -126,7 +126,7 @@ class FollowersController {
         return StatusResponse.success(res, payload);
       }
       return res.status(200).send({
-        message: following
+        data: following
       });
     } catch (error) {
       return StatusResponse.internalServerError(res, {

diff --git a/controllers/RolesController.js b/controllers/RolesController.js
@@ -1,7 +1,10 @@
 import models from '../models';
 import StatusResponse from '../helpers/StatusResponse';
+// import pagination from '../helpers/pagination';
 
-const { users, profiles, roles } = models;
+const {
+  users, profiles, roles,
+} = models;
 
 /**
  * @description RolesController class

diff --git a/helpers/articleHelper.js b/helpers/articleHelper.js
@@ -15,6 +15,8 @@ const checkTitle = (title, articleTitle) => {
 
 const checkUser = (article, userId) => article.userId === userId;
 
+const userIsOnwerOrAdmin = (article, userId, roleId) => roleId === 1 || article.userId === userId;
+
 /**
  * @description This method is used to create new tags abd return the created tag ids
  * @param {Array} tags - An array of tags <= 5
@@ -43,6 +45,24 @@ const calcReadingTime = (bodyText) => {
   return readingTime > 1 ? `${readingTime} mins read` : `${readingTime} min read`;
 };
 
+const isPublished = article => article.isPublished;
+
+const checkUserRole = (roleId, userId) => {
+  let where = { isArchived: false };
+
+  if (roleId === 1) {
+    where = {};
+  }
+  if (!userId) {
+    where = {
+      isArchived: false,
+      isPublished: true
+    };
+  }
+  return where;
+};
+
 export {
-  checkIdentifier, checkUser, checkTitle, createNewTags, calcReadingTime
+  checkIdentifier, checkUser, checkTitle, createNewTags, calcReadingTime, isPublished,
+  userIsOnwerOrAdmin, checkUserRole
 };