Merge pull request #23 from caions/refactor/habits-routes-params

Refactor/habits routes params
caions · Apr 17, 2024 · 27356ae · 27356ae
2 parents 1ed8be1 + 5a26884
commit 27356ae
Show file tree

Hide file tree

Showing 8 changed files with 59 additions and 66 deletions.
diff --git a/habits-document.json b/habits-document.json
@@ -43,26 +43,21 @@
             "description": ""
           }
         }
-      },
-      "put": {
+      }
+    },
+    "/habits/{habitId}": {
+      "get": {
         "tags": [
           "Habits"
         ],
         "description": "",
         "parameters": [
           {
-            "name": "id",
-            "description": "habit id",
-            "in": "query",
-            "type": "string"
-          },
-          {
-            "name": "obj",
-            "in": "body",
-            "description": "update a habit",
-            "schema": {
-              "$ref": "#/definitions/HabitBodyName"
-            }
+            "name": "habitId",
+            "in": "path",
+            "required": true,
+            "type": "string",
+            "description": "habit habitId"
           }
         ],
         "responses": {
@@ -71,18 +66,25 @@
           }
         }
       },
-      "delete": {
+      "put": {
         "tags": [
           "Habits"
         ],
         "description": "",
         "parameters": [
+          {
+            "name": "habitId",
+            "in": "path",
+            "required": true,
+            "type": "string",
+            "description": "habit habitId"
+          },
           {
             "name": "obj",
             "in": "body",
-            "description": "habit uuid",
+            "description": "update a habit",
             "schema": {
-              "$ref": "#/definitions/HabitBodyId"
+              "$ref": "#/definitions/HabitBodyName"
             }
           }
         ],
@@ -91,21 +93,19 @@
             "description": ""
           }
         }
-      }
-    },
-    "/habits/{id}": {
-      "get": {
+      },
+      "delete": {
         "tags": [
           "Habits"
         ],
         "description": "",
         "parameters": [
           {
-            "name": "id",
+            "name": "habitId",
             "in": "path",
             "required": true,
             "type": "string",
-            "description": "habit id"
+            "description": "habit habitId"
           }
         ],
         "responses": {

diff --git a/src/application/HabitCompletionDateUseCase.ts b/src/application/HabitCompletionDateUseCase.ts
@@ -4,7 +4,7 @@ import { HabitRepositoryProtocol } from '../domain/repositories/HabitRepositoryP
 import { AppError } from '../shared/errors/AppError';
 import { HabitCompletionDate } from '../domain/entities/HabitCompletionDate';
 import { isSameDate } from '../shared/utils/isSameDate';
-import { validUtcDate } from '../shared/utils/utcDateValidation';
+import { validISODate } from '../shared/utils/validISODate';
 
 export class HabitCompletionDateUseCase {
   constructor(
@@ -20,7 +20,7 @@ export class HabitCompletionDateUseCase {
       completedDate,
     };
 
-    if (!validUtcDate(completedDate)) {
+    if (!validISODate(completedDate)) {
       throw new AppError('completedDate invalid utc format');
     }
 

diff --git a/src/application/tests/HabitCompletionDateUseCase.test.ts b/src/application/tests/HabitCompletionDateUseCase.test.ts
@@ -13,7 +13,6 @@ describe('Complete a Habit', () => {
   let habitCompletionDateUseCase: HabitCompletionDateUseCase;
   let listHabitCompletionDateUseCase: ListHabitCompletionDateUseCase;
   const completedDate = new Date().toISOString();
-  jest.useFakeTimers().setSystemTime(new Date('2020-01-01'));
 
   beforeEach(() => {
     memoryHabitRepository = new MemoryHabitRepository();
@@ -81,8 +80,7 @@ describe('Complete a Habit', () => {
   });
 
   it('should not be possible to complete with an invalid date format.', async () => {
-    const createdHabit = await createHabitUseCase.execute('verr');
-    console.log(createdHabit.id);
+    const createdHabit = await createHabitUseCase.execute('ver');
     await expect(
       habitCompletionDateUseCase.execute(
         createdHabit.id,

diff --git a/src/infra/web/controllers/HabitController.ts b/src/infra/web/controllers/HabitController.ts
@@ -16,9 +16,9 @@ export class HabitController {
   };
 
   show = async (request: Request, response: Response): Promise<void> => {
-    const { id } = request.params;
+    const { habitId } = request.params;
     const findHabitUseCase = new FindHabitUseCase(this.habitRepository);
-    const result = await findHabitUseCase.execute(id);
+    const result = await findHabitUseCase.execute(habitId);
     response.json(result);
   };
 
@@ -30,10 +30,10 @@ export class HabitController {
   };
 
   update = async (request: Request, response: Response): Promise<void> => {
-    const { id } = request.query;
+    const { habitId } = request.params;
     const { name } = request.body;
     const habit = {
-      id: String(id),
+      id: String(habitId),
       name,
     };
     const updateHabitUseCase = new UpdateHabitUseCase(this.habitRepository);
@@ -42,9 +42,9 @@ export class HabitController {
   };
 
   destroy = async (request: Request, response: Response): Promise<void> => {
-    const { id } = request.body;
+    const { habitId } = request.params;
     const deleteHabitUseCase = new DeleteHabitUseCase(this.habitRepository);
-    await deleteHabitUseCase.execute(id);
+    await deleteHabitUseCase.execute(habitId);
     response.json();
   };
 }
diff --git a/src/infra/web/routes/e2e/habit.routes.test.ts b/src/infra/web/routes/e2e/habit.routes.test.ts
@@ -10,10 +10,10 @@ const memoryHabitRepository = new MemoryHabitRepository();
 const habitController = new HabitController(memoryHabitRepository);
 
 habitRouter.get('/', habitController.index);
-habitRouter.get('/:id', habitController.show);
+habitRouter.get('/:habitId', habitController.show);
 habitRouter.post('/', habitController.create);
-habitRouter.put('/', habitController.update);
-habitRouter.delete('/', habitController.destroy);
+habitRouter.put('/:habitId', habitController.update);
+habitRouter.delete('/:habitId', habitController.destroy);
 describe('Habits Controllers', () => {
   beforeAll(() => {
     app.use(express.json());
@@ -44,24 +44,17 @@ describe('Habits Controllers', () => {
     const habit = await request(app).post('/').send({
       name: 'jumping',
     });
-    const response = await request(app)
-      .put('/')
-      .query({
-        id: habit.body.id,
-      })
-      .send({
-        name: 'thinking',
-      });
+    const response = await request(app).put(`/${habit.body.id}`).send({
+      name: 'thinking',
+    });
     expect(response.status).toBe(201);
   });
 
   it('DELETE', async () => {
     const habit = await request(app).post('/').send({
       name: 'hiking',
     });
-    const response = await request(app).delete('/').send({
-      id: habit.body.id,
-    });
+    const response = await request(app).delete(`/${habit.body.id}`);
     expect(response.status).toBe(200);
   });
 
@@ -99,10 +92,7 @@ describe('Habits Controllers', () => {
 
   it('should NOT be able to update a habit that not exist', async () => {
     const response = await request(app)
-      .put('/')
-      .query({
-        id: '672c2ae2-c4fd-443d-8c2a-4bb2cdb179d8',
-      })
+      .put(`/672c2ae2-c4fd-443d-8c2a-4bb2cdb179d8`)
       .send({
         name: 'thinking',
       });
@@ -111,9 +101,9 @@ describe('Habits Controllers', () => {
   });
 
   it('should NOT be able to delete a habit that not exist', async () => {
-    const response = await request(app)
-      .delete('/')
-      .send({ id: '672c2ae2-c4fd-443d-8c2a-4bb2cdb179d8' });
+    const response = await request(app).delete(
+      `/672c2ae2-c4fd-443d-8c2a-4bb2cdb179d8`,
+    );
     expect(response.status).toBe(400);
     expect(response.body).toBe('habit not found');
   });

diff --git a/src/infra/web/routes/e2e/habitCompDate.routes.test.ts b/src/infra/web/routes/e2e/habitCompDate.routes.test.ts
@@ -95,4 +95,13 @@ describe('Habit Complete Date Controllers', () => {
     expect(completedHabits).toHaveLength(1);
     expect(response.status).toBe(200);
   });
+
+  it('POST should NOT be able to complete a habit with a invalid date time', async () => {
+    const response = await request(app).post('/').send({
+      habitId: '4567',
+      completedDate: '2000-02-03',
+    });
+    expect(response.status).toBe(400);
+    expect(response.body).toBe('completedDate invalid utc format');
+  });
 });
diff --git a/src/infra/web/routes/habit.routes.ts b/src/infra/web/routes/habit.routes.ts
@@ -12,9 +12,9 @@ habitRouter.get(
   habitController.index,
 );
 habitRouter.get(
-  '/:id',
+  '/:habitId',
   // #swagger.tags = ['Habits']
-  //  #swagger.parameters['id'] = { description: 'habit id' }
+  //  #swagger.parameters['habitId'] = { description: 'habit habitId' }
   habitController.show,
 );
 habitRouter.post(
@@ -28,9 +28,9 @@ habitRouter.post(
   habitController.create,
 );
 habitRouter.put(
-  '/',
+  '/:habitId',
   // #swagger.tags = ['Habits']
-  //  #swagger.parameters['id'] = { description: 'habit id' }
+  //  #swagger.parameters['habitId'] = { description: 'habit habitId' }
   /*  #swagger.parameters['obj'] = {
         in: 'body',
         description: 'update a habit',
@@ -39,13 +39,9 @@ habitRouter.put(
   habitController.update,
 );
 habitRouter.delete(
-  '/',
+  '/:habitId',
   // #swagger.tags = ['Habits']
-  /*  #swagger.parameters['obj'] = {
-        in: 'body',
-        description: 'habit uuid',
-        schema: { $ref: '#/definitions/HabitBodyId' }
-  } */
+  //  #swagger.parameters['habitId'] = { description: 'habit habitId' }
   habitController.destroy,
 );
 

diff --git a/src/shared/utils/utcDateValidation.ts → src/shared/utils/validISODate.ts b/src/shared/utils/utcDateValidation.ts → src/shared/utils/validISODate.ts
@@ -1,4 +1,4 @@
-export const validUtcDate = (dateString: string) => {
+export const validISODate = (dateString: string) => {
   const date = new Date(dateString);
   return date.toISOString() === dateString;
 };