Este projeto contém os requisitos realizados por Anna Beatriz Garcia Trajano de Sá enquanto estudava na Trybe 🚀

Project Talker Manager

Neste projeto desenvolvi uma aplicação de cadastro de talkers (palestrantes) em que foi possível cadastrar, visualizar, pesquisar, editar e excluir informações.

Demo

Instalação do projeto localmente:

Após cada um dos passos, haverá um exemplo do comando a ser digitado para fazer o que está sendo pedido, caso tenha dificuldades e o exemplo não seja suficiente, não hesite em me contatar em annagarcia@id.uff.br

Abra o terminal e crie um diretório no local de sua preferência com o comando mkdir:

  mkdir projetos

Entre no diretório que acabou de criar e depois clone o projeto:

  cd projetos
  git clone git@github.com:annabia95/project-talker-manager.git

Acesse o diretório do projeto e depois utilize o comando npm i para instalar todas as dependências necessárias:

  cd project-talker-manager
  npm i

✨ Dica: Caso queira utilizar Docker para rodar os testes localmente e validar as funcionalidades, basta executar o comando:

docker run -p 3306:3306 --name mysql_57 -e MYSQL_ROOT_PASSWORD=1234 -d mysql:5.7 mysqld --default-authentication-plugin=mysql_native_password

Depois de usar o comando acima, agora basta executar os testes digitando no terminal:

MYSQL_USER=root MYSQL_PASSWORD=1234 HOSTNAME=localhost npm test

Habilidades Desenvolvidas

Neste projeto, desenvolvi as seguintes habilidades:

Desenvolver uma API de um CRUD (Create, Read, Update e Delete) de palestrantes (talkers) e;
Desenvolver alguns endpoints que irão ler e escrever em um arquivo utilizando o módulo fs.

Referências

Documentação Oficial - Node.js
Documentação Express - Rotas
Documentação Express - Middleware
Node.js // Dicionário do Programador

Escopo do Projeto

1 - Crie o endpoint GET `/talker`

A requisição deve retornar o status 200 e um array com todas as pessoas palestrantes cadastradas. Exemplo:

[
  {
    "name": "Henrique Albuquerque",
    "age": 62,
    "id": 1,
    "talk": { "watchedAt": "23/10/2020", "rate": 5 }
  },
  {
    "name": "Heloísa Albuquerque",
    "age": 67,
    "id": 2,
    "talk": { "watchedAt": "23/10/2020", "rate": 5 }
  },
  {
    "name": "Ricardo Xavier Filho",
    "age": 33,
    "id": 3,
    "talk": { "watchedAt": "23/10/2020", "rate": 5 }
  },
  {
    "name": "Marcos Costa",
    "age": 24,
    "id": 4,
    "talk": { "watchedAt": "23/10/2020", "rate": 5 }
  }
]

Caso não exista nenhuma pessoa palestrante cadastrada a requisição deve retornar o status 200 e um array vazio. Exemplo:

[]

2 - Crie o endpoint GET `/talker/:id`

A requisição deve retornar o status 200 e uma pessoa palestrante com base no id da rota. Por exemplo, ao fazer uma requisição /talker/1, a resposta deve ser:

{
  "name": "Henrique Albuquerque",
  "age": 62,
  "id": 1,
  "talk": { "watchedAt": "23/10/2020", "rate": 5 }
}

Caso não seja encontrada uma pessoa palestrante com base no id da rota, a requisição deve retornar o status 404 com o seguinte corpo:

{
  "message": "Pessoa palestrante não encontrada"
}

3 - Crie o endpoint POST `/login`

O endpoint deverá receber no corpo da requisição os campos email e password e retornar um token aleatório de 16 caracteres. Este token será utilizado pelas requisições dos próximos requisitos do projeto.

O corpo da requisição deverá ter seguinte formato:

{
  "email": "email@email.com",
  "password": "123456"
}

Os seguintes pontos serão avaliados:

O endpoint deverá retornar um código de status 200 com o token gerado e o seguinte corpo:

{
  "token": "7mqaVRXJSp886CGr"
}

O endpoint deve retornar um token aleatório a cada vez que for acessado.

4 - Adicione as validações para o endpoint `/login`

Os campos recebidos pela requisição devem ser validados e, caso os valores sejam inválidos, o endpoint deve retornar o código de status 400 com a respectiva mensagem de erro ao invés do token.

As regras de validação são:

o campo email é obrigatório;
o campo email deve ter um email válido;
o campo password é obrigatório;
o campo password deve ter pelo menos 6 caracteres.

Os seguintes pontos serão avaliados:

Caso o campo email não seja passado ou esteja vazio, retorne um código de status 400 com o seguinte corpo:

{
  "message": "O campo \"email\" é obrigatório"
}

Caso o email passado não seja válido, retorne um código de status 400 com o seguinte corpo:

{
  "message": "O \"email\" deve ter o formato \"email@email.com\""
}

Caso o campo password não seja passado ou esteja vazio retorne um código de status 400 com o seguinte corpo:

{
  "message": "O campo \"password\" é obrigatório"
}

Caso a senha não tenha pelo menos 6 caracteres retorne um código de status 400 com o seguinte corpo:

{
  "message": "O \"password\" deve ter pelo menos 6 caracteres"
}

5 - Crie o endpoint POST `/talker`

Os seguintes pontos serão avaliados:

O endpoint deve ser capaz de adicionar uma nova pessoa palestrante ao seu arquivo;

O corpo da requisição deverá ter o seguinte formato:

{
  "name": "Danielle Santos",
  "age": 56,
  "talk": {
    "watchedAt": "22/10/2019",
    "rate": 5
  }
}

A requisição deve ter o token de autenticação nos headers, no campo authorization.
- Caso o token não seja encontrado retorne um código de status 401, com o seguinte corpo:
```
{
  "message": "Token não encontrado"
}
```
- Caso o token seja inválido retorne um código de status 401, com o seguinte corpo:
```
{
  "message": "Token inválido"
}
```
O campo name deverá ter no mínimo 3 caracteres. Ele é obrigatório.
- Caso o campo não seja passado ou esteja vazio retorne um código de status 400, com o seguinte corpo:
```
{
  "message": "O campo \"name\" é obrigatório"
}
```
- Caso o nome não tenha pelo menos 3 caracteres retorne um código de status 400, com o seguinte corpo:
```
{
  "message": "O \"name\" deve ter pelo menos 3 caracteres"
}
```
O campo age deverá ser um inteiro e apenas pessoas maiores de idade (pelo menos 18 anos) podem ser cadastrados. Ele é obrigatório.
- Caso o campo não seja passado ou esteja vazio retorne um código de status 400, com o seguinte corpo:
```
{
  "message": "O campo \"age\" é obrigatório"
}
```
- Caso a pessoa palestrante não tenha pelo menos 18 anos retorne status 400, com o seguinte corpo:
```
{
  "message": "A pessoa palestrante deve ser maior de idade"
}
```
- O campo talk deverá ser um objeto com as chaves watchedAt e rate:
- O campo talk é obrigatório.
  - Caso o campo não seja informado retorne status 400, com o seguinte corpo:
```
{
  "message": "O campo \"talk\" é obrigatório"
}
```
- A chave watchedAt é obrigatória.
  - Caso a chave não seja informada ou esteja vazia retorne status 400, com o seguinte corpo:
```
{
  "message": "O campo \"watchedAt\" é obrigatório"
}
```
- A chave watchedAt deve ser uma data no formato dd/mm/aaaa.
  - Caso a data não respeite o formato dd/mm/aaaa retorne status 400, com o seguinte corpo:
```
{
  "message": "O campo \"watchedAt\" deve ter o formato \"dd/mm/aaaa\""
}
```
- O campo rate é obrigatório.
  - Caso o campo não seja informado ou esteja vazio retorne status 400, com o seguinte corpo:
```
{
  "message": "O campo \"rate\" é obrigatório"
}
```
- A chave rate deve ser um inteiro de 1 à 5.
  - Caso a nota não seja um inteiro de 1 à 5 retorne status 400, com o seguinte corpo:
```
{
  "message": "O campo \"rate\" deve ser um inteiro de 1 à 5"
}
```
Caso esteja tudo certo, retorne o status 201 e a pessoa cadastrada.

O endpoint deve retornar o status 201 e a pessoa palestrante que foi cadastrada, da seguinte forma:

{
  "id": 1,
  "name": "Danielle Santos",
  "age": 56,
  "talk": {
    "watchedAt": "22/10/2019",
    "rate": 5
  }
}

6 - Crie o endpoint PUT `/talker/:id`

Os seguintes pontos serão avaliados:

O endpoint deve ser capaz de editar uma pessoa palestrante com base no id da rota, sem alterar o id registrado.

O corpo da requisição deverá ter o seguinte formato:

{
  "name": "Danielle Santos",
  "age": 56,
  "talk": {
    "watchedAt": "22/10/2019",
    "rate": 5
  }
}

A requisição deve ter o token de autenticação nos headers, no campo authorization.
- Caso o token não seja encontrado retorne um código de status 401, com o seguinte corpo:
```
{
  "message": "Token não encontrado"
}
```
- Caso o token seja inválido retorne um código de status 401, com o seguinte corpo:
```
{
  "message": "Token inválido"
}
```
O campo name deverá ter no mínimo 3 caracteres. Ele é obrigatório.
- Caso o campo não seja passado ou esteja vazio retorne um código de status 400, com o seguinte corpo:
```
{
  "message": "O campo \"name\" é obrigatório"
}
```
- Caso o nome não tenha pelo menos 3 caracteres retorne um código de status 400, com o seguinte corpo:
```
{
  "message": "O \"name\" ter pelo menos 3 caracteres"
}
```
O campo age deverá ser um inteiro e apenas pessoas maiores de idade (pelo menos 18 anos) podem ser cadastrados. Ele é obrigatório.
- Caso o campo não seja passado ou esteja vazio retorne um código de status 400, com o seguinte corpo:
```
{
  "message": "O campo \"age\" é obrigatório"
}
```
- Caso a pessoa palestrante não tenha pelo menos 18 anos retorne status 400, com o seguinte corpo:
```
{
  "message": "A pessoa palestrante deve ser maior de idade"
}
```
O campo talk deverá ser um objeto com as chaves watchedAt e rate:
- O campo talk é obrigatório.
  - Caso o campo não seja informado retorne status 400, com o seguinte corpo:
```
{
  "message": "O campo \"talk\" é obrigatório"
}
```
- A chave watchedAt é obrigatória.
  - Caso a chave não seja informada ou esteja vazia retorne status 400, com o seguinte corpo:
```
{
  "message": "O campo \"watchedAt\" é obrigatório"
}
```
- A chave watchedAt deve ser uma data no formato dd/mm/aaaa.
  - Caso a data não respeite o formato dd/mm/aaaa retorne status 400, com o seguinte corpo:
```
{
  "message": "O campo \"watchedAt\" deve ter o formato \"dd/mm/aaaa\""
}
```
- O campo rate é obrigatório.
  - Caso o campo não seja informado ou esteja vazio retorne status 400, com o seguinte corpo:
```
{
  "message": "O campo \"rate\" é obrigatório"
}
```
- A chave rate deve ser um inteiro de 1 à 5.
  - Caso a nota não seja um inteiro de 1 à 5 retorne status 400, com o seguinte corpo:
```
{
  "message": "O campo \"rate\" deve ser um inteiro de 1 à 5"
}
```
Caso esteja tudo certo, retorne o status 200 e a pessoa editada.

O endpoint deve retornar o status 200 e a pessoa palestrante que foi editada, da seguinte forma:

{
  "id": 1,
  "name": "Danielle Santos",
  "age": 56,
  "talk": {
    "watchedAt": "22/10/2019",
    "rate": 4
  }
}

7 - Crie o endpoint DELETE `/talker/:id`

Os seguintes pontos serão avaliados:

A requisição deve ter o token de autenticação nos headers, no campo authorization.
- Caso o token não seja encontrado retorne um código de status 401, com o seguinte corpo:
```
{
  "message": "Token não encontrado"
}
```
- Caso o token seja inválido retorne um código de status 401, com o seguinte corpo:
```
{
  "message": "Token inválido"
}
```
O endpoint deve deletar uma pessoa palestrante com base no id da rota. Devendo retornar o status 204, sem conteúdo na resposta.

8 - Crie o endpoint GET `/talker/search?q=searchTerm`

Os seguintes pontos serão avaliados:

O endpoint deve retornar um array de palestrantes que contenham em seu nome o termo pesquisado no queryParam da URL. Devendo retornar o status 200, com o seguinte corpo:

/search?q=Da

[
  {
    "id": 1,
    "name": "Danielle Santos",
    "age": 56,
    "talk": {
      "watchedAt": "22/10/2019",
      "rate": 5,
    },
  }
]

A requisição deve ter o token de autenticação nos headers, no campo authorization.
- Caso o token não seja encontrado retorne um código de status 401, com o seguinte corpo:
```
{
  "message": "Token não encontrado"
}
```
- Caso o token seja inválido retorne um código de status 401, com o seguinte corpo:
```
{
  "message": "Token inválido"
}
```
Caso searchTerm não seja informado ou esteja vazio, o endpoint deverá retornar um array com todos as pessoas palestrantes cadastradas, assim como no endpoint GET /talker, com um status 200.
Caso nenhuma pessoa palestrante satisfaça a busca, o endpoint deve retornar o status 200 e um array vazio.

Dica é importante ter atenção se essa rota não entra em conflito com as outras, já que a ordem das rotas faz diferença na interpretação da aplicação

annabia95/project-talker-manager

Project Talker Manager

Demo

Instalação do projeto localmente:

Habilidades Desenvolvidas

Referências

Escopo do Projeto

1 - Crie o endpoint GET /talker

2 - Crie o endpoint GET /talker/:id

3 - Crie o endpoint POST /login

4 - Adicione as validações para o endpoint /login

5 - Crie o endpoint POST /talker

6 - Crie o endpoint PUT /talker/:id

7 - Crie o endpoint DELETE /talker/:id

8 - Crie o endpoint GET /talker/search?q=searchTerm

1 - Crie o endpoint GET `/talker`

2 - Crie o endpoint GET `/talker/:id`

3 - Crie o endpoint POST `/login`

4 - Adicione as validações para o endpoint `/login`

5 - Crie o endpoint POST `/talker`

6 - Crie o endpoint PUT `/talker/:id`

7 - Crie o endpoint DELETE `/talker/:id`

8 - Crie o endpoint GET `/talker/search?q=searchTerm`