Merge pull request #58 from andela/ch-refactor-responses-167367862

#167367862 Refactor responses for uniformity
andela · Jul 18, 2019 · 7983c75 · 7983c75
2 parents ac4be16 + 28095fe
commit 7983c75
Show file tree

Hide file tree

Showing 31 changed files with 381 additions and 375 deletions.
diff --git a/src/controllers/Auth.js b/src/controllers/Auth.js
@@ -49,10 +49,10 @@ class AuthController {
         message: 'A link has been sent to your mailbox for verification',
         token
       });
-    } catch (err) {
+    } catch (error) {
       return res.status(500).json({
         status: 500,
-        message: 'Internal server error'
+        message: error.message
       });
     }
   }
@@ -78,24 +78,24 @@ class AuthController {
             token
           };
           return res.status(200).json({
-            status: '200',
+            status: 200,
             message: 'Your account has been verified',
-            data: [verifiedUser]
+            token: verifiedUser.token
           });
         }
         return res.status(400).json({
-          status: '400',
+          status: 400,
           message: 'Invalid user credential'
         });
       }
       return res.status(400).json({
-        status: '400',
+        status: 400,
         message: 'Invalid user credential'
       });
-    } catch (err) {
+    } catch (error) {
       return res.status(400).json({
-        status: '400',
-        message: 'Invalid user credential'
+        status: 400,
+        message: error.message
       });
     }
   }
@@ -132,14 +132,23 @@ class AuthController {
             status: 200,
             message: 'User Login successful',
             token,
-            data: user
+            data: [ user ]
           });
         }
-        return res.status(401).json({ error: true, message: 'Invalid email or password' });
+        return res.status(401).json({
+          status: 401,
+          message: 'Invalid email or password'
+        });
       }
-      return res.status(401).json({ error: true, message: 'Invalid email or password' });
-    } catch (err) {
-      return res.status(500).json({ error: true, message: 'Internal Server error' });
+      return res.status(401).json({
+        status: 401,
+        message: 'Invalid email or password'
+      });
+    } catch (error) {
+      return res.status(500).json({
+        status: 500,
+        message: error.message
+      });
     }
   }
 
@@ -160,12 +169,12 @@ class AuthController {
       });
       return res.status(200).json({
         status: 200,
-        message: 'User successfully Logged Out',
+        message: 'User successfully logged out',
       });
     } catch (error) {
       return res.status(500).json({
         status: 500,
-        data: error,
+        message: error.message,
       });
     }
   }
@@ -228,12 +237,12 @@ class AuthController {
       // RETURN SUCCESS IF SUCCESS
       return res.status(200).json({
         status: 200,
-        message: 'reset code resent to your email',
+        message: 'A reset code has been resent to your email',
       });
-    } catch (err) {
+    } catch (error) {
       return res.status(500).json({
         status: 500,
-        message: 'Internal server error',
+        message: error.message,
       });
     }
   }
@@ -268,12 +277,12 @@ class AuthController {
       // RETURN SUCCESS IF SUCCESS
       return res.status(200).json({
         status: 200,
-        message: 'password reset successful',
+        message: 'Password reset successful',
       });
-    } catch (err) {
+    } catch (error) {
       return res.status(500).json({
         status: 500,
-        message: 'Internal server error',
+        message: error.message,
       });
     }
   }

diff --git a/src/controllers/CommentController.js b/src/controllers/CommentController.js
@@ -31,16 +31,20 @@ class CommentController {
     const { id, createdAt, updatedAt } = comment;
       return res.status(201).json({
         status: 201,
-        message: 'Comment Added Successfully',
-        id,
-        commentBody,
-        createdAt,
-        updatedAt,
-        author: {
-          userName,
-          bio,
-          imageUrl
-        }
+        message: 'Comment added successfully',
+        data: [
+          {
+            id,
+            commentBody,
+            createdAt,
+            updatedAt,
+            author: {
+              userName,
+              bio,
+              imageUrl
+            }
+          }
+        ]
       });
     } catch (error) {
       return res.status(500).json({
@@ -67,16 +71,22 @@ class CommentController {
         limit: defaultLimit,
         offset
       });
-
       const pages = Math.ceil(count / limit) || 1;
       offset = limit * (defaultPage - 1);
 
       return res.status(200).json({
         status: 200,
         message: 'All comments fetched successfully',
-        article,
-        comments,
-        pages
+        data: [ 
+          {
+            articleId,
+            comments,
+            totalComments: count,
+            currentPage,
+            limit,
+            totalPages: pages
+          }
+        ]
       });
     } catch (error) {
       return res.status(500).json({

diff --git a/src/controllers/articleController.js b/src/controllers/articleController.js
@@ -105,7 +105,7 @@ class ArticleController {
     } catch (error) {
       return res.status(500).json({
         status: 500,
-        error: error.message
+        message: error.message
       });
     }
   }
@@ -142,13 +142,14 @@ class ArticleController {
       await Tag.bulkCreate(newTagDetails);
 
       return res.status(201).json({
-        message: 'article successfully created',
-        article: newArticle
+        status: 201,
+        message: 'Article successfully created',
+        data: [ newArticle ]
       });
     } catch (error) {
-      return res.status(500).json({
-        message: 'Internal server error',
-        error
+      return res.status(500).json({ 
+        status: 500,
+        message: error.message
       });
     }
   }

diff --git a/src/controllers/likeController.js b/src/controllers/likeController.js
@@ -31,22 +31,22 @@ class LikeController {
         await likedArticle.destroy();
         return res.status(200).json({
           status: 200,
-          data: article,
           message: 'You just unliked this article',
+          data: [ article ],
         });
       }
 
       await Like.create({ userId, articleId: article.id });
 
       return res.status(201).json({
         status: 201,
-        data: article,
         message: 'You just liked this article',
+        data: [ article ],
       });
     } catch (error) {
       return res.status(500).json({
         status: 500,
-        error: error.message,
+        message: error.message,
       });
     }
   }

diff --git a/src/controllers/ratingController.js b/src/controllers/ratingController.js
@@ -30,8 +30,12 @@ class RatingController {
         return res.status(200).json({
           status: 200,
           message: `Article rating has been updated as ${value} star`,
-          article,
-          rating: previousRating.value
+          data: [ 
+            {
+              articleId,
+              rating: previousRating.value
+            }
+          ]
         });
       }
       const rating = await Rating.create({
@@ -42,13 +46,17 @@ class RatingController {
       return res.status(200).json({
         status: 200,
         message: `Article has been rated as ${value} star`,
-        article,
-        rating: rating.value,
+        data: [
+          {
+            articleId,
+            rating: rating.value,
+          }
+        ]
       });
-    } catch (err) {
+    } catch (error) {
       return res.status(500).json({
         status: 500,
-        message: 'Internal server error'
+        message: error.message
       });
     }
   }
@@ -58,8 +66,8 @@ class RatingController {
  * @returns { object } res
  * @description - paginate article ratings
  * @static
- * @param {*} req
- * @param {*} res
+ * @param {object} req
+ * @param {object} res
  * @memberof RatingController
  */
 static async getAllArticlesRating(req, res){
@@ -85,15 +93,22 @@ static async getAllArticlesRating(req, res){
       return res.status(200).json({
         status: 200,
         message: 'All Ratings fetched successfully',
-        article,
-        rating,
-        pages
+        data: [ 
+          {
+            articleId,
+            rating,
+            totalRating: count,
+            currentPage,
+            limit,
+            totalPages: pages
+          }
+        ]
       });
 
-    } catch(err){
+    } catch(error){
       return res.status(500).json({
         status: 500,
-        message: 'Internal server error'
+        message: error.message
       })
     }
   }

diff --git a/src/controllers/socialController.js b/src/controllers/socialController.js
@@ -55,7 +55,10 @@ export default class socialController {
       });
 
       if (!user) {
-        return res.status(404).send('user not found');
+        return res.status(404).json({
+          status: 404,
+          message: 'User not found'
+        });
       }
 
       const {
@@ -74,18 +77,20 @@ export default class socialController {
 
       return res.status(200).json({
         message: 'successful',
-        data: {
-          token,
-          firstname,
-          lastname,
-          bio,
-          image
-        }
+        data: [
+          {
+            token,
+            firstname,
+            lastname,
+            bio,
+            image
+          }
+        ]
       });
-    } catch (err) {
+    } catch (error) {
       return res.status(500).json({
-        status: 'error',
-        message: err.message
+        status: 500,
+        message: error.message
       });
     }
   }