Merge pull request #27 from DanielAraldi/feat/edit-user-data

Added endpoint to edit user data

Author: DanielAraldi

README.md

@@ -20,7 +20,8 @@ O objetivo do treinamento é mostrar como criar uma API com uma arquitetura bem
 
 > ## APIs adicionais construídas:
 
-1. [Refresh Token](./requirements/refresh-token.md)
+1. [Refresh token](./requirements/refresh-token.md)
+1. [Edição de dados do usuário](./requirements/edit-user-data.md)
 
 > ## Princípios aplicados:
 

package-lock.json

@@ -42,20 +42,20 @@
     "@types/jest": "^29.4.0",
     "@types/jsonwebtoken": "^9.0.1",
     "@types/module-alias": "^2.0.1",
-    "@types/node": "^18.13.0",
+    "@types/node": "^18.14.2",
     "@types/supertest": "^2.0.12",
     "@types/swagger-ui-express": "^4.1.3",
     "@types/validator": "^13.7.12",
-    "@typescript-eslint/eslint-plugin": "^5.52.0",
-    "@typescript-eslint/parser": "^5.52.0",
+    "@typescript-eslint/eslint-plugin": "^5.54.0",
+    "@typescript-eslint/parser": "^5.54.0",
     "copyfiles": "^2.4.1",
     "coveralls": "^3.1.1",
-    "eslint": "^8.34.0",
+    "eslint": "^8.35.0",
     "eslint-config-standard-with-typescript": "^34.0.0",
     "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-n": "^15.6.1",
     "eslint-plugin-promise": "^6.0.0",
-    "git-commit-msg-linter": "^4.7.3",
+    "git-commit-msg-linter": "^4.7.4",
     "husky": "^8.0.3",
     "jest": "^29.4.3",
     "lint-staged": "^13.1.2",
@@ -66,7 +66,7 @@
     "typescript": "^4.9.5"
   },
   "dependencies": {
-    "@apollo/server": "^4.3.3",
+    "@apollo/server": "^4.4.0",
     "@graphql-tools/schema": "^9.0.16",
     "@graphql-tools/utils": "^9.2.1",
     "bcrypt": "^5.0.1",
@@ -76,7 +76,7 @@
     "module-alias": "^2.2.2",
     "mongodb": "^4.13.0",
     "nodemon": "^2.0.20",
-    "swagger-ui-express": "^4.5.0",
+    "swagger-ui-express": "^4.6.2",
     "validator": "^13.9.0"
   },
   "engines": {

package.json

@@ -0,0 +1,19 @@
+# Edição de Dados do Usuário
+
+> ## Caso de sucesso:
+
+1. ✅ Recebe uma requisição do tipo **PUT** na rota **/api/account/edit**.
+1. ✅ Valida se os dados **name** e **email** não foram passados como `string` vazia.
+1. ✅ Valida que o campo **email** é um e-mail válido.
+1. ✅ Valida se já existe um usuário com o e-mail fornecido.
+1. ✅ Edita a conta do usuário com os dados informados.
+1. ✅ Retorna **204**.
+
+> ## Exceções:
+
+1. ✅ Retorna erro **404** se a API não existir.
+1. ✅ Retorna erro **400** se **name** e **email** forem uma `string` vazia.
+1. ✅ Retorna erro **400** se o campo **email** for um e-mail inválido.
+1. ✅ Retorna erro **403** se o e-mail fornecido já estiver em uso.
+1. ✅ Retorna erro **403** se não for um **usuário**.
+1. ✅ Retorna erro **500** se der erro ao tentar editar a conta do usuário.

requirements/edit-user-data.md

@@ -5,7 +5,7 @@
 1. ✅ Recebe uma requisição do tipo **POST** na rota **/api/login**.
 1. ✅ Valida dados obrigatórios **email** e **password**.
 1. ✅ Valida que o campo **email** é um e-mail válido.
-1. ✅ Busca o usuário com o email e senha fornecidos.
+1. ✅ Busca o usuário com o e-mail e senha fornecidos.
 1. ✅ Gera um token de acesso a partir do ID do usuário.
 1. ✅ Atualiza os dados do usuário com o token de acesso gerado.
 1. ✅ Retorna **200** com o token de acesso e o nome do usuário.

requirements/login.md

@@ -15,7 +15,7 @@
 1. ✅ Retorna erro **404** se a API não existir.
 1. ✅ Retorna erro **403** se não for um **usuário**.
 1. ✅ Retorna erro **403** se o **surveyId** passado na URL for inválido.
-1. ✅ Retorna erro **403** se a resposta enviada pelo client for uma resposta inválida.
+1. ✅ Retorna erro **403** se a resposta enviada pelo cliente for uma resposta inválida.
 1. ✅ Retorna erro **500** se der erro ao tentar criar o resultado da enquete.
 1. ✅ Retorna erro **500** se der erro ao tentar atualizar o resultado da enquete.
 1. ✅ Retorna erro **500** se der erro ao tentar carregar a enquete.

requirements/save-survey-result.md

@@ -6,7 +6,7 @@
 1. ✅ Valida dados obrigatórios **name**, **email**, **password** e **passwordConfirmation**.
 1. ✅ Valida que **password** e **passwordConfirmation** são iguais.
 1. ✅ Valida que o campo **email** é um e-mail válido.
-1. ✅ Valida se já existe um usuário com o email fornecido.
+1. ✅ Valida se já existe um usuário com o e-mail fornecido.
 1. ✅ Gera uma senha criptografada (essa senha não pode ser descriptografada).
 1. ✅ Cria uma conta para o usuário com os dados informados, substituindo a senha pela senha criptorafada.
 1. ✅ Gera um token de acesso a partir do ID do usuário.
@@ -19,7 +19,7 @@
 1. ✅ Retorna erro **400** se **name**, **email**, **password** ou **passwordConfirmation** não forem fornecidos pelo cliente.
 1. ✅ Retorna erro **400** se **password** e **passwordConfirmation** não forem iguais.
 1. ✅ Retorna erro **400** se o campo **email** for um e-mail inválido.
-1. ✅ Retorna erro **403** se o email fornecido já estiver em uso.
+1. ✅ Retorna erro **403** se o e-mail fornecido já estiver em uso.
 1. ✅ Retorna erro **500** se der erro ao tentar gerar uma senha criptografada.
 1. ✅ Retorna erro **500** se der erro ao tentar criar a conta do usuário.
 1. ✅ Retorna erro **500** se der erro ao tentar gerar o token de acesso.

requirements/signup.md

@@ -1,3 +1,3 @@
 export interface HashComparer {
-  compare(plaitext: string, digest: string): Promise<boolean>;
+  compare(plaintext: string, digest: string): Promise<boolean>;
 }

src/data/protocols/criptography/hash-comparer.ts

@@ -0,0 +1,9 @@
+import { EditAccount } from '@/domain/usecases';
+
+export interface EditAccountRepository {
+  edit(data: EditAccountRepository.Params): Promise<void>;
+}
+
+export namespace EditAccountRepository {
+  export type Params = EditAccount.Params;
+}

src/data/protocols/db/account/edit-account-repository.ts

@@ -1,5 +1,6 @@
 export * from './add-account-repository';
 export * from './check-account-by-email-repository';
+export * from './edit-account-repository';
 export * from './load-account-by-email-repository';
 export * from './load-account-by-token-repository';
 export * from './update-access-token-repository';