Skip to content

FranciscoVieir/Project-talker-manager

BranchesTags

Repository files navigation

Boas-vindas ao repositório do projeto Talker Manager!

👨‍💻 O que deverá ser desenvolvido

Será irá construído uma aplicação de cadastro de talkers (palestrantes) em que será possível cadastrar, visualizar, pesquisar, editar e excluir informações. Para isso você deverá:

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

Orientações

:Rodando no Docker vs Localmente

Com Docker

Rode o serviço node com o comando docker-compose up -d.

  • Esse serviço irá inicializar um container chamado talker_manager.
  • A partir daqui você pode rodar o container via CLI ou abri-lo no VS Code.

Use o comando docker exec -it talker_manager bash.

  • Ele te dará acesso ao terminal interativo do container criado pelo compose, que está rodando em segundo plano.

Instale as dependências [Caso existam] com npm install

Execute a aplicação com npm start ou npm run dev

Sem Docker

Instale as dependências [Caso existam] com npm install

👀 De olho nas dicas:

  1. Para rodar o projeto desta forma, obrigatoriamente você deve ter o node instalado em seu computador.
  2. O avaliador espera que a versão do node utilizada seja a 16.
‼️ Antes de começar
  1. Clone o repositório
  • git clone [email protected]:FranciscoVieir/Project-talker-manager.git.
  • Entre na pasta do repositório que você acabou de clonar:
    • cd Project-talker-manager

Requisitos

⚠️ Observações importantes!

  1. Com exceção do requisito 3, todos os outros requisitos deverão ser feitos utilizando o módulo fs.

  2. O arquivo src/talker.json será utilizado como base para fazer as requisições da API. As operações de leitura e escrita dos requisitos devem ser feitas nesse arquivo usando os métodos da biblioteca fs.

  3. Há um arquivo src/index.js no repositório. Não remova, nele, o seguinte trecho de código:

    app.get('/', (_request, response) => {
      response.status(HTTP_OK_STATUS).send();
    });

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 protected]",
  "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 protected]\""
}
  • 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:

    • Dica 💡: Um token válido é composto por exatamente 16 caracteres e deve ser do tipo string.

      {
  "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
  }
}

    • Os dados atualizados por meio do endpoint deve ser persistidos no arquivo talker.json.

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.

About

No description or website provided.

Topics

docker middleware crud docker-compose routes crud-application

Resources

Readme
Activity

Stars

0 stars

Watchers

2 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages