fix: endpoint responses as specified in docs/endpoint.md (#18)

Fix #17

__tests__/integration/controllers/PostController.test.ts

@@ -144,7 +144,7 @@ describe('PostController', () => {
         .delete(`/post/${createPostBody.post._id}`)
         .set('Authorization', `Bearer ${loginBody.token}`)
 
-      expect(response.status).toBe(200)
+      expect(response.status).toBe(204)
     })
 
     it('should not delete a post with a non-existent postId', async () => {
@@ -161,8 +161,19 @@ describe('PostController', () => {
           password: user.password
         })
 
+      const post = await factory.attrs('Post')
+
+      const { body: createPostBody } = await request(app)
+        .post('/create/post')
+        .set('Authorization', `Bearer ${loginBody.token}`)
+        .send(post)
+
+      await request(app)
+        .delete(`/post/${createPostBody.post._id}`)
+        .set('Authorization', `Bearer ${loginBody.token}`)
+
       const response = await request(app)
-        .delete(`/post/a${5}`)
+        .delete(`/post/${createPostBody.post._id}`)
         .set('Authorization', `Bearer ${loginBody.token}`)
 
       expect(response.status).toBe(400)

__tests__/integration/controllers/UserController.test.ts

@@ -26,7 +26,7 @@ describe('UserController', () => {
         .post('/register')
         .send(user)
 
-      expect(response.body).toHaveProperty('_id')
+      expect(response.body).toHaveProperty('user')
     })
 
     it('should not be able to register with duplicated email', async () => {

src/controllers/AuthController.ts

@@ -14,7 +14,7 @@ class AuthController {
     })
 
     if (!(await schema.isValid(req.body))) {
-      return res.status(400).json({ error: 'Validation fails' })
+      return res.status(400).json({ error: 'Invalid argument(s)' })
     }
 
     try {

src/controllers/CityController.ts

@@ -11,7 +11,7 @@ class CityController {
     const schema = Yup.string().required()
 
     if (!(await schema.isValid(req.query.search))) {
-      return res.status(400).json({ error: 'Validation fails' })
+      return res.status(400).json({ error: 'Invalid argument(s)' })
     }
 
     try {
@@ -35,7 +35,7 @@ class CityController {
 
       return res.status(200).json({ cities: normalizedCities })
     } catch (error) {
-      return res.status(400).json({ error: 'Unable to search cities' })
+      return res.status(400).json({ error: 'Failed to search cities' })
     }
   }
 }

src/controllers/PostController.ts

@@ -11,15 +11,15 @@ class PostController {
     })
 
     if (!(await schema.isValid(req.body))) {
-      return res.status(400).json({ error: 'Validation fails' })
+      return res.status(400).json({ error: 'Invalid argument(s)' })
     }
 
     try {
       const post = await Post.create({ ...req.body, user: req.userId })
 
-      return res.json({ post })
+      return res.status(201).json({ post })
     } catch (error) {
-      return res.status(400).json({ error: 'Creation failed' })
+      return res.status(400).json({ error: 'Failed to create post' })
     }
   }
 
@@ -29,17 +29,21 @@ class PostController {
 
       return res.json({ posts })
     } catch (error) {
-      return res.status(400).json({ error: 'Listation failed' })
+      return res.status(400).json({ error: 'Failed to list posts' })
     }
   }
 
   async delete (req: AuthRequest, res: Response): Promise<Response> {
     try {
-      await Post.findByIdAndRemove(req.params.postId)
+      const result = await Post.findByIdAndRemove(req.params.postId)
 
-      return res.status(200).send()
+      if (!result) {
+        return res.status(400).json({ error: 'Post not existent' })
+      }
+
+      return res.status(204).send()
     } catch (error) {
-      return res.status(400).json({ error: 'Deletation failed' })
+      return res.status(400).json({ error: 'Failed to delete post' })
     }
   }
 }

src/controllers/UserController.ts

@@ -1,6 +1,6 @@
 import { Request, Response } from 'express'
 import * as Yup from 'yup'
-import pick from 'lodash/pick'
+import omit from 'lodash/omit'
 
 import User from '../schemas/User'
 import CheckUserEmail from '../services/CheckUserEmail'
@@ -14,7 +14,7 @@ class UserController {
     })
 
     if (!(await schema.isValid(req.body))) {
-      return res.status(400).json({ error: 'Validation fails' })
+      return res.status(400).json({ error: 'Invalid argument(s)' })
     }
 
     try {
@@ -25,9 +25,9 @@ class UserController {
       }
 
       const user = await User.create(req.body)
-      return res.json(pick(user.toObject(), ['_id', 'name', 'email']))
+      return res.status(201).json({ user: omit(user.toObject(), ['password']) })
     } catch (err) {
-      return res.status(400).json({ error: 'Registration failed' })
+      return res.status(400).json({ error: 'Failed to register user' })
     }
   }
 }