Termos e acordos

Ao iniciar este projeto, você concorda com as diretrizes do Código de Ética e Conduta e do Manual da Pessoa Estudante da Trybe

Boas vindas ao repositório do projeto Cookmaster!

Você já usa o GitHub diariamente para desenvolver os exercícios, certo? Agora, para desenvolver os projetos, você deverá seguir as instruções a seguir. Fique atento a cada passo, e se tiver qualquer dúvida, nos envie por Slack! #vqv 🚀

Aqui você vai encontrar os detalhes de como estruturar o desenvolvimento do seu projeto a partir deste repositório, utilizando uma branch específica e um Pull Request para colocar seus códigos.

---

Sumário

• Habilidades
• Entregáveis
  • O que deverá ser desenvolvido
  • Desenvolvimento
  • Data de Entrega
• Instruções para entregar seu projeto
  • Antes de começar a desenvolver
  • Durante o desenvolvimento
  • Depois de terminar o desenvolvimento
• Como desenvolver
  • Todos os seus endpoints devem estar no padrão REST
  • Conexão com o Banco
  • Coleções
  • Linter
• Requisitos do projeto
  • Lista de requisitos
    • 1 - Crie um endpoint para o cadastro de usuários
    • 2 - Crie um endpoint para o login de usuários
    • 3 - Crie um endpoint para o cadastro de receitas
    • 4 - Crie um endpoint para a listagem de receitas
    • 5 - Crie um endpoint para visualizar uma receita específica
    • 6 - Permissões do usuário admin
    • 7 - Crie um endpoint para a edição de uma receita
    • 8 - Crie um endpoint para a exclusão de uma receita
    • 9 - Crie um endpoint para a adição de uma imagem a uma receita
    • 10 - Crie um endpoint para acessar a imagem de uma receita
  • Bônus
    • 11 - Cadastramento de admin
• Revisando um pull request
• Avisos finais

---

Habilidades

Neste projeto, você será capaz de:

• Entender o que há por dentro de um token de autenticação;

• Gerar tokens a partir de informações como login e senha;

• Autenticar rotas do Express, usando o token JWT;

• Fazer upload de arquivos em APIs REST;

• Salvar arquivos no servidor através de uma API REST;

• Consultar arquivos do servidor através de uma api REST.

---

Entregáveis

Para entregar o seu projeto você deverá criar um Pull Request neste repositório.

Lembre-se que você pode consultar nosso conteúdo sobre Git & GitHub sempre que precisar!

---

O que deverá ser desenvolvido

Você vai desenvolver seu app utilizando a arquitetura MSC!

Neste novo projeto deverá ser possível fazer o cadastro e login de pessoa usuária, onde apenas esse usúario poderá acessar, modificar e deletar as receitas que cadastrou.

---

Desenvolvimento

Você vai desenvolver todas as camadas da aplicação (Models, Service e Controllers) a partir do seu código no projeto cookmaster.

Através dessa aplicação, será possível realizar as operações básicas que se pode fazer em um determinado banco de dados: Criação, Leitura, Atualização e Exclusão (ou CRUD, pros mais íntimos 😜).

Para realizar qualquer tipo de alteração no banco de dados (como cadastro, edição ou exclusão de receitas) será necessário autenticar-se. Além disso, as pessoas usuárias devem poder ser clientes ou administradores. Os clientes apenas poderão disparar ações nas receitas que ele mesmo criou. Já um administrador pode disparar qualquer ação em qualquer receita.

A autenticação deverá ser feita via JWT.

O código para cadastro de pessoas usuárias deve ser criado por você utilizando os conhecimentos adquiridos nesse bloco.

Deverá ser possível adicionar uma imagem à uma receita, utilizando o upload de arquivos fornecido pelo multer.

⚠️ Dicas Importantes ⚠️:

• Não haverá front-end neste projeto, portanto não se preocupe com a visualização, mas apenas com as funcionalidades e organização do código.

• Para permitir que as imagens sejam acessadas através da API, você deve utilizar o middleware static do express, da seguinte forma:

  const path = require('path');
  // ...
  
  // /images é o caminho da API onde as imagens estarão disponíveis
  // path.join(__dirname, 'uploads') é o caminho da pasta onde o multer salva suas imagens ao realizar o upload
  app.use('/images', express.static(path.join(__dirname, 'uploads')));
  
  // ...

---

Data de Entrega

- Serão `3` dias de projeto.
- Data de entrega para avaliação final do projeto: `10/03/2021 - 14:00h`.

---

Instruções para entregar seu projeto

Antes de começar a desenvolver

1. Clone o repositório

• git clone https://github.com/tryber/sd-06-cookmaster.git.
• Entre na pasta do repositório que você acabou de clonar:
  • cd sd-06-cookmaster

2. Instale as dependências [Caso existam]

• npm install

3. Crie uma branch a partir da branch master

• Verifique que você está na branch master
  • Exemplo: git branch
• Se não estiver, mude para a branch master
  • Exemplo: git checkout master
• Agora crie uma branch à qual você vai submeter os commits do seu projeto
  • Você deve criar uma branch no seguinte formato: nome-de-usuario-nome-do-projeto
  • Exemplo: git checkout -b joaozinho-sd-06-cookmaster

4. Adicione as mudanças ao stage do Git e faça um commit

• Verifique que as mudanças ainda não estão no stage
  • Exemplo: git status (deve aparecer listada a pasta joaozinho em vermelho)
• Adicione o novo arquivo ao stage do Git
  • Exemplo:
    • git add . (adicionando todas as mudanças - que estavam em vermelho - ao stage do Git)
    • git status (deve aparecer listado o arquivo joaozinho/README.md em verde)
• Faça o commit inicial
  • Exemplo:
    • git commit -m 'iniciando o projeto x' (fazendo o primeiro commit)
    • git status (deve aparecer uma mensagem tipo nothing to commit )

5. Adicione a sua branch com o novo commit ao repositório remoto

• Usando o exemplo anterior: git push -u origin joaozinho-sd-06-cookmaster

6. Crie um novo Pull Request (PR)

• Vá até a página de Pull Requests do repositório no GitHub
• Clique no botão verde "New pull request"
• Clique na caixa de seleção "Compare" e escolha a sua branch com atenção
• Clique no botão verde "Create pull request"
• Adicione uma descrição para o Pull Request e clique no botão verde "Create pull request"
• Não se preocupe em preencher mais nada por enquanto!
• Volte até a página de Pull Requests do repositório e confira que o seu Pull Request está criado

---

Durante o desenvolvimento

• Faça commits das alterações que você fizer no código regularmente.

• Lembre-se de sempre após um (ou alguns) commits atualizar o repositório remoto.

• Os comandos que você utilizará com mais frequência são:

  1. git status (para verificar o que está em vermelho - fora do stage - e o que está em verde - no stage)
  2. git add (para adicionar arquivos ao stage do Git)
  3. git commit (para criar um commit com os arquivos que estão no stage do Git)
  4. git push -u origin nome-da-branch (para enviar o commit para o repositório remoto na primeira vez que fizer o push de uma nova branch)
  5. git push (para enviar o commit para o repositório remoto após o passo anterior)

---

Depois de terminar o desenvolvimento

Para sinalizar que o seu projeto está pronto para o "Code Review" dos seus colegas, faça o seguinte:

• Vá até a página DO SEU Pull Request, adicione a label de "code-review" e marque seus colegas:

  • No menu à direita, clique no link "Labels" e escolha a label code-review;

  • No menu à direita, clique no link "Assignees" e escolha o seu usuário;

  • No menu à direita, clique no link "Reviewers" e digite students, selecione o time tryber/students-sd-06.

Caso tenha alguma dúvida, aqui tem um video explicativo.

---

Como desenvolver

⚠️ Leia-os atentamente e siga à risca o que for pedido. ⚠️

👀 Observações importantes:

• O não cumprimento de um requisito, total ou parcialmente, impactará em sua avaliação.

Todos os seus endpoints devem estar no padrão REST

• Use os verbos HTTP adequados para cada operação.

• Agrupe e padronize suas URL em cada recurso.

• Garanta que seus endpoints sempre retornem uma resposta, havendo sucesso nas operações ou não.

• Retorne os códigos de status corretos (recurso criado, erro de validação, autorização, etc).

---

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

app.get('/', (request, response) => {
  response.send();
});

Isso está configurado para o avaliador funcionar.

Conexão com o Banco

A conexão do banco local deverá conter os seguintes parâmetros:

const MONGO_DB_URL = 'mongodb://localhost:27017/Cookmaster';
const DB_NAME = 'Cookmaster';

Para o avaliador funcionar altere a conexão do banco para:

const MONGO_DB_URL = 'mongodb://mongodb:27017/Cookmaster';
const DB_NAME = 'Cookmaster';

Coleções

O banco terá duas coleções: usuários e receitas.

A coleção de usuários deverá ter o seguinte nome: users.

Os campos da coleção users terão este formato:

{ "name" : "Erick Jacquin", "email" : "erickjacquin@gmail.com", "password" : "12345678", "role" : "user" }

A resposta do insert para ser retornada após a criação é esta:

{ "_id" : ObjectId("5f46914677df66035f61a355"), "name" : "Erick Jacquin", "email" : "erickjacquin@gmail.com", "password" : "12345678", "role" : "user" }

(O _id será gerado automaticamente pelo mongodb)

A coleção de receitas deverá ter o seguinte nome: recipes.

Os campos da coleção recipes terão este formato:

{ "name" : "Receita do Jacquin", "ingredients" : "Frango", "preparation" : "10 minutos no forno" }

A resposta do insert para ser retornada após a criação é esta:

{ "_id" : ObjectId("5f46919477df66035f61a356"), "name" : "string", "ingredients" : "string", "preparation" : "string", "userId" : ObjectId("5f46914677df66035f61a355") }

(O _id será gerado automaticamente pelo mongodb, e o userId será gerado com o id do usuário que criou a receita)

O projeto deve rodar na porta http://localhost/3000

---

Linter

Usaremos o ESLint para fazer a análise estática do seu código.

Este projeto já vem com as dependências relacionadas ao linter configuradas no arquivos package.json.

Para poder rodar os ESLint em um projeto basta executar o comando npm install dentro do projeto e depois npm run lint. Se a análise do ESLint encontrar problemas no seu código, tais problemas serão mostrados no seu terminal. Se não houver problema no seu código, nada será impresso no seu terminal.

⚠ PULL REQUESTS COM ISSUES DE LINTER NÃO SERÃO AVALIADAS. ATENTE-SE PARA RESOLVÊ-LAS ANTES DE FINALIZAR O DESENVOLVIMENTO! ⚠

Você pode também instalar o plugin do ESLint no VSCode, bastar ir em extensions e baixar o plugin ESLint.

---

Requisitos do projeto

Lista de requisitos

1 - Crie um endpoint para o cadastro de usuários

• A rota deve ser (/users).

• No banco um usuário precisa ter os campos Email, Senha, Nome e Role.

• Para criar um usuário através da API, todos os campos são obrigatórios, com exceção do Role.

• O campo Email deve ser único.

• Usuários criados através desse endpoint devem ter seu campo Role com o atributo user, ou seja, devem ser usuários comuns, e não admins.

• O body da requisição deve conter o seguinte formato:

  {
    "name": "string",
    "email": "string",
    "password": "string"
  }

Além disso, as seguintes verificações serão feitas:

• [Será validado que o campo "name" é obrigatório]

Se o usuário não tiver o campo "name" o resultado retornado deverá ser conforme exibido abaixo, com um status http 400:

• [Será validado que o campo "email" é obrigatório]

Se o usuário não tiver o campo "email" o resultado retornado deverá ser conforme exibido abaixo, com um status http 400:

• [Será validado que não é possível cadastrar usuário com o campo email inválido]

Se o usuário tiver o campo email inválido o resultado retornado deverá ser conforme exibido abaixo, com um status http 400:

• [Será validado que o campo "senha" é obrigatório]

Se o usuário não tiver o campo "senha" o resultado retornado deverá ser conforme exibido abaixo, com um status http 400:

• [Será validado que o campo "email" é único]

Se o usuário cadastrar o campo "email" com um email que já existe, o resultado retornado deverá ser conforme exibido abaixo, com um status http 409:

• [Será validado que é possível cadastrar usuário com sucesso]

Se o usuário for cadastrado com sucesso o resultado retornado deverá ser conforme exibido abaixo, com um status http 201:

• [Será validado que é possível ao cadastrar usuário, o valor do campo "role" tenha o valor "user"]

Se o usuário for criado com sucesso o resultado retornado deverá ser conforme exibido abaixo, com um status http 201:

2 - Crie um endpoint para o login de usuários

• A rota deve ser (/login).

• A rota deve receber os campos Email e Senha e esses campos devem ser validados no banco de dados.

• Na configuração do JWT não use variáveis de ambientes para não ter conflito com o avaliador.

• Um token JWT deve ser gerado e retornado caso haja sucesso no login. No seu payload deve estar presente o id, email e role do usuário.

• O body da requisição deve conter o seguinte formato:

  {
    "email": "string",
    "password": "string"
  }

Além disso, as seguintes verificações serão feitas:

• [Será validado que o campo "email" é obrigatório]

Se o login não tiver o campo "email" o resultado retornado deverá ser conforme exibido abaixo, com um status http 401:

• [Será validado que o campo "password" é obrigatório]

Se o login não tiver o campo "password" o resultado retornado deverá ser conforme exibido abaixo, com um status http 401:

• [Será validado que não é possível fazer login com um email inválido]

Se o login tiver o email inválido o resultado retornado deverá ser conforme exibido abaixo, com um status http 401:

• [Será validado que não é possível fazer login com uma senha inválida]

Se o login tiver a senha inválida o resultado retornado deverá ser conforme exibido abaixo, com um status http 401:

• [Será validado que é possível fazer login com sucesso]

Se foi feito login com sucesso o resultado retornado deverá ser conforme exibido abaixo, com um status http 200:

3 - Crie um endpoint para o cadastro de receitas

• A rota deve ser (/recipes).

• A receita só pode ser criada caso o usuário esteja logado e o token JWT validado.

• No banco, a receita deve ter os campos Nome, Ingredientes, Modo de preparo, URL da imagem e Id do Autor.

• Nome, ingredientes e modo de preparo devem ser recebidos no corpo da requisição, com o seguinte formato:

  {
    "name": "string",
    "ingredients": "string",
    "preparation": "string"
  }

• O campo dos ingredientes pode ser um campo de texto aberto.

• O campo ID do autor, deve ser preenchido automaticamente com o ID do usuário logado, que deve ser extraído do token JWT.

• A URL da imagem será preenchida através de outro endpoint

Além disso, as seguintes verificações serão feitas:

• [Será validado que não é possível cadastrar receita sem o campo "name"]

Se a receita não tiver o campo "name" o resultado retornado deverá ser conforme exibido abaixo, com um status http 400:

• [Será validado que não é possível cadastrar receita sem o campo "ingredients"]

Se a receita não tiver o campo "ingredients" o resultado retornado deverá ser conforme exibido abaixo, com um status http 400:

• [Será validado que não é possível cadastrar receita sem o campo "preparation"]

Se a receita não tiver o campo "preparation" o resultado retornado deverá ser conforme exibido abaixo, com um status http 400:

• [Será validado que não é possível cadastrar uma receita com token invalido]

Se a receita não tiver o token válido o resultado retornado deverá ser conforme exibido abaixo, com um status http 401:

• [Será validado que é possível cadastrar uma receita com sucesso]

O resultado retornado para cadastrar a receita com sucesso deverá ser conforme exibido abaixo, com um status http 201:

4 - Crie um endpoint para a listagem de receitas

• A rota deve ser (/recipes).

• A rota pode ser acessada por usuários logados ou não

Além disso, as seguintes verificações serão feitas:

• [Será validado que é possível listar todas as receitas sem estar autenticado]

O resultado retornado para listar receitas com sucesso deverá ser conforme exibido abaixo, com um status http 200:

• [Será validado que é possível listar todas as receitas estando autenticado]

O resultado retornado para listar receitas com sucesso deverá ser conforme exibido abaixo, com um status http 200:

5 - Crie um endpoint para visualizar uma receita específica

• A rota deve ser (/recipes/:id).

• A rota pode ser acessada por usuários logados ou não

Além disso, as seguintes verificações serão feitas:

• [Será validado que é possível listar uma receita específica sem estar autenticado]

O resultado retornado para listar uma receita com sucesso deverá ser conforme exibido abaixo, com um status http 200:

• [Será validado que é possível listar uma receita específica estando autenticado]

O resultado retornado para listar uma receita com sucesso deverá ser conforme exibido abaixo, com um status http 200:

• [Será validado que não é possível listar uma receita que não existe]

O resultado retornado para listar uma receita que não existe deverá ser conforme exibido abaixo, com um status http 404:

6 - Permissões do usuário admin

Crie um arquivo seed.js na raiz do projeto com uma query do Mongo DB capaz de inserir um usuário na coleção users com os seguintes valores:

{ name: 'admin', email: 'root@email.com', password: 'admin', role: 'admin' }

Obs.: Esse usuário tem o poder de criar, deletar, atualizar ou remover qualquer receita, independente de quem a cadastrou. Isso será solicitado ao longo dos próximos requisitos.

Além disso, as seguintes verificações serão feitas:

• [Será validado que o projeto tem um arquivo de seed, com um comando para inserir um usuário root e verifico que é possivel fazer login]

Será validado no arquivo seed.js existe a query para criar um usuário root

7 - Crie um endpoint para a edição de uma receita

• A rota deve ser (/recipes/:id).

• A receita só pode ser atualizada caso o usuário esteja logado e o token JWT validado.

• A receita só pode ser atualizada caso pertença ao usuário logado, ou caso esse usuário seja um admin.

• O corpo da requisição deve receber o seguinte formato:

  {
    "name": "string",
    "ingredients": "string",
    "preparation": "string"
  }

Além disso, as seguintes verificações serão feitas:

• [Será validado que não é possível editar receita sem estar autenticado]

O resultado retornado para editar receita sem autenticação deverá ser conforme exibido abaixo, com um status http 401:

• [Será validado que não é possível editar receita com token inválido]

O resultado retornado para editar receita com token inválido deverá ser conforme exibido abaixo, com um status http 401:

• [Será validado que é possível editar receita estando autenticado]

O resultado retornado para editar uma receita com sucesso deverá ser conforme exibido abaixo, com um status http 200:

• [Será validado que é possível editar receita com usuário admin]

O resultado retornado para editar uma receita com sucesso deverá ser conforme exibido abaixo, com um status http 200:

8 - Crie um endpoint para a exclusão de uma receita

• A rota deve ser (/recipes/:id).

• A receita só pode ser excluída caso o usuário esteja logado e o token JWT validado.

• A receita só pode ser excluída caso pertença ao usuário logado, ou caso o usuário logado seja um admin.

Além disso, as seguintes verificações serão feitas:

• [Será validado que não é possível excluir receita sem estar autenticado]

O resultado retornado para excluir uma receita sem autenticação deverá ser conforme exibido abaixo, com um status http 401:

• [Será validado que é possível excluir receita estando autenticado]

O resultado retornado para excluir uma receita com sucesso deverá ser conforme exibido abaixo, com um status http 204:

• [Será validado que é possível excluir receita com usuário admin]

O resultado retornado para excluir uma receita com sucesso deverá ser conforme exibido abaixo, com um status http 204:

9 - Crie um endpoint para a adição de uma imagem a uma receita

• A rota deve ser (/recipes/:id/image/).

• A imagem deve ser lida do campo image.

• O endpoint deve aceitar requisições no formato multipart/form-data.

• A receita só pode ser atualizada caso o usuário esteja logado e o token JWT validado.

• A receita só pode ser atualizada caso pertença ao usuário logado ou caso o usuário logado seja admin.

• O upload da imagem deverá ser feito utilizando o Multer.

• O nome do arquivo deve ser o ID da receita.

• A URL completa para acessar a imagem através da API deve ser gravada no banco de dados, junto com os dados da receita.

Além disso, as seguintes verificações serão feitas:

• [Será validado que é possível enviar foto com usuário autenticado]

O resultado retornado para adicionar uma foto na receita com sucesso deverá ser conforme exibido abaixo, com um status http 200:

• [Será validado que ao enviar foto, o nome da imagem é alterada para o id da receita]

O resultado retornado para adicionar uma foto na receita com sucesso deverá ser conforme exibido abaixo, com um status http 200:

• [Será validado que não é possível enviar foto sem estar autenticado]

O resultado retornado para adicionar uma foto na receita com sucesso deverá ser conforme exibido abaixo, com um status http 401:

• [Será validado que é possível enviar foto com usuário admin]

O resultado retornado para adicionar uma foto na receita com sucesso deverá ser conforme exibido abaixo, com um status http 200:

10 - Crie um endpoint para acessar a imagem de uma receita

• As imagens devem estar disponíveis através da rota /images/<id-da-receita>.jpeg na API.

Além disso, as seguintes verificações serão feitas:

• [Será validado que é retornada uma imagem como resposta]

O resultado retornado deverá ser do tipo imagem, com um status http 200:

Bônus

11 - Cadastramento de admin

• A rota deve ser (/users/admin).

• Só será possível adicionar um admin caso esta ação esteja sendo feita por outro admin, portanto, deve ser validado se há um admin logado.

• Por padrão, as requisições pra esse endpoint devem adicionar um usuário com a role admin.

• O corpo da requisição deve ter o seguinte formato:

  {
    "name": "string",
    "email": "string",
    "password": "string"
  }

Além disso, as seguintes verificações serão feitas:

• [Será validado que não é possível cadastrar um usuário admin, sem estar autenticado como um usuário admin]

Se o usuário admin não é criado com sucesso o resultado retornado deverá ser conforme exibido abaixo, com um status http 403:

• [Será validado que é possível cadastrar um usuário admin]

Se o usuário admin é criado com sucesso o resultado retornado deverá ser conforme exibido abaixo, com um status http 201:

---

Revisando um pull request

Use o conteúdo sobre Code Review para te ajudar a revisar os Pull Requests.

#VQV

---

Avisos finais

Ao finalizar e submeter o projeto, não se esqueça de avaliar sua experiência preenchendo o formulário. Leva menos de 3 minutos!

Link: FORMULÁRIO DE AVALIAÇÃO DE PROJETO

O avaliador automático não necessariamente avalia seu projeto na ordem em que os requisitos aparecem no readme. Isso acontece para deixar o processo de avaliação mais rápido. Então, não se assuste se isso acontecer, ok?