Boas-vindas ao repositório do Projeto Store Manager!

Desenvolver sua primeira API utilizando a arquitetura MSC (model-service-controller)!

A API a ser construída é um sistema de gerenciamento de vendas no formato dropshipping em que será possível criar, visualizar, deletar e atualizar produtos e vendas. Você deverá utilizar o banco de dados MySQL para a gestão de dados. Além disso, a API deve ser RESTful.

Tabelas

O banco terá três tabelas:

• A tabela products, com os atributos id e name;
• A tabela sales, com os atributos id e date;
• A tabela sales_products, com os atributos sale_id, product_id e quantity;
• O script de criação do banco de dados pode ser visto aqui;
• O script que popula o banco de dados pode ser visto aqui;

A tabela products tem o seguinte formato: (O id será gerado automaticamente)

A tabela sales tem o seguinte formato: (O id e date são gerados automaticamente)

A tabela sales_products, é a tabela que faz o relacionamento N:N entre products e sales e tem o seguinte formato: (O produto e a venda são deletados automaticamente)

:warning:️ Em caso de dúvidas, consulte os conteúdos:

• Arquitetura de Software - Camada de Model
• Arquitetura de Software - Camada de Controller e Service

---

Dicas de scripts prontos

• Criar o banco de dados e gerar as tabelas:

  npm run migration

• Limpar e popular o banco de dados:

  npm run seed

• Iniciar o servidor Node:

  npm start

• Iniciar o servidor Node com nodemon:

  npm run debug

• Executar os testes de unidade:

  npm run test:mocha

• Executar o linter:

  npm run lint

Requisitos Obrigatórios Propostos para realização do Projeto da Trybe

01 - Crie endpoints para listar produtos

• O endpoint para listar produtos deve ser acessível através do caminho (/products) e (/products/:id);
• Através do caminho /products, todos os produtos devem ser retornados;
• Através do caminho /products/:id, apenas o produto com o id presente na URL deve ser retornado;
• O resultado da listagem deve ser ordernado de forma crescente pelo campo id;

• [Será validado que é possível listar todos os produtos]

  • Ao listar usuários com sucesso o resultado retornado deverá ser conforme exibido abaixo, com um status http 200:

    [
      {
        "id": 1,
        "name": "Martelo de Thor",
      },
      {
        "id": 2,
        "name": "Traje de encolhimento",
      }
      /* ... */
    ]
  

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

  • Se o produto for inexistente o resultado retornado deverá ser conforme exibido abaixo, com um status http 404:

    { "message": "Product not found" }
  

• [Será validado que é possível listar um produto específico com sucesso]

  • Ao listar um produto com sucesso o resultado retornado deverá ser conforme exibido abaixo, com um status http 200:

    {
      "id": 1,
      "name": "Martelo de Thor",
    }
  

---

02 - Desenvolva testes que cubram no mínimo 5% das camadas da sua aplicação

• Seus arquivos de teste devem ficar no diretório tests/unit, como é descrito em Para escrever seus próprios arquivos de teste;
• Seus testes da model devem fazer mock do banco de dados obrigatóriamente;
• Opcionalmente você pode parar o serviço do MYSQL em sua máquina. Para rodar seus teste utilize npm run test:mocha;
• Antes de executar os testes da Trybe, seus testes não devem conter erros.

• [Será validado que a cobertura total das linhas dos arquivos de CADA camada models, services e controllers é maior ou igual a 5%. Ou seja, cada uma das camadas tem de ter, ao menos, 5% de cobertura de testes.]

---

03 - Crie endpoint para cadastrar produtos

• O endpoint deve ser acessível através do caminho (/products);
• Os produtos enviados devem ser salvos na tabela products do banco de dados;
• O corpo da requisição deverá seguir o formato abaixo:

  {
    "name": "ProdutoX"
  }

• [Será validado que é possível cadastrar um produto com sucesso]
  • Se o produto for criado com sucesso o resultado retornado deverá ser conforme exibido abaixo, com um status http 201:

    {
      "id": 4,
      "name": "ProdutoX"
    }
  

---

04 - Crie validações para produtos

• O endpoint de produtos deve ser acessível através do caminho (/products);
• Lembre-se, o banco de dados não deve ser acessado nas validações iniciais do corpo da requisição;

• [Será validado que não é possível realizar operações em um produto sem o campo name]

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

    { "message": "\"name\" is required" }
  

• [Será validado que não é possível realizar operações em um produto com o campo name menor que 5 caracteres]

  • Se a requisição não tiver name com pelo menos 5 caracteres, o resultado retornado deverá ser conforme exibido abaixo, com um status http 422

    { "message": "\"name\" length must be at least 5 characters long" }
  

---

05 - Desenvolva testes que cubram no mínimo 10% das camadas da sua aplicação

• Seus arquivos de teste devem ficar no diretório tests/unit, como é descrito em Para escrever seus próprios arquivos de teste;
• Seus testes da model devem fazer mock do banco de dados obrigatóriamente;
• Opcionalmente você pode parar o serviço do MYSQL em sua máquina. Para rodar seus teste utilize npm run test:mocha;
• Antes de executar os testes da Trybe, seus testes não devem conter erros.

• [Será validado que a cobertura total das linhas dos arquivos de CADA camada models, services e controllers é maior ou igual a 10%. Ou seja, cada uma das camadas tem de ter, ao menos, 10% de cobertura de testes.]

---

06 - Crie endpoint para validar e cadastrar vendas

• O endpoint de vendas deve ser acessível através do caminho (/sales);
• As vendas enviadas devem ser salvas nas tabelas sales e sales_products do banco de dados;
• Deve ser possível cadastrar a venda de vários produtos através da uma mesma requisição;
• O corpo da requisição deverá seguir o formato abaixo:

  [
    {
      "productId": 1,
      "quantity":1
    },
    {
      "productId": 2,
      "quantity":5
    }
  ]

• [Será validado que não é possível realizar operações em uma venda sem o campo productId]

  • Se algum dos itens da requisição não tiver o campo productId, o resultado retornado deverá ser conforme exibido abaixo, com um status http 400:

    { "message": "\"productId\" is required" }
  

• [Será validado que não é possível realizar operações em uma venda sem o campo quantity]

  • Se algum dos itens da requisição não tiver o campo quantity, o resultado retornado deverá ser conforme exibido abaixo, com um status http 400 :

    { "message": "\"quantity\" is required" }
  

• [Será validado que não é possível realizar operações em uma venda com o campo quantity menor ou igual a 0 (Zero)]

  • Se a requisição tiver algum item em que o campo quantity seja menor ou igual a zero, o resultado retornado deverá ser conforme exibido abaixo, com um status http 422

    { "message": "\"quantity\" must be greater than or equal to 1" }
  

• [Será validado que não é possível realizar operações em uma venda com o campo productId inexistente, em uma requisição com um único item]

  • Se o campo productId do item da requisição não existir no banco de dados, o resultado retornado deverá ser conforme exibido abaixo, com um status http 404

    { "message": "Product not found" }
  

• [Será validado que não é possível realizar operações em uma venda com o campo productId inexistente, em uma requisição com vários items]

  • Se a requisição tiver algum item cujo campo productId não existe no banco de dados, o resultado retornado deverá ser conforme exibido abaixo, com um status http 404

    { "message": "Product not found" }
  

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

  • Se a venda for criada com sucesso o resultado retornado deverá ser conforme exibido abaixo, com um status http 201:

    {
      "id": 3,
      "itemsSold": [
        {
          "productId": 1,
          "quantity":1
        },
        {
          "productId": 2,
          "quantity":5
        }
      ]
    }
  

💬 Em caso de dúvidas, lembre-se de consultar a seção Dicas e Diagrama ER, Entidades e Scripts

---

07 - Desenvolva testes que cubram no mínimo 15% das camadas da sua aplicação

• Seus arquivos de teste devem ficar no diretório tests/unit, como é descrito em Para escrever seus próprios arquivos de teste;
• Seus testes da model devem fazer mock do banco de dados obrigatóriamente;
• Opcionalmente você pode parar o serviço do MYSQL em sua máquina. Para rodar seus teste utilize npm run test:mocha;
• Antes de executar os testes da Trybe, seus testes não devem conter erros.

• [Será validado que a cobertura total das linhas dos arquivos de CADA camada models, services e controllers é maior ou igual a 15%. Ou seja, cada uma das camadas tem de ter, ao menos, 15% de cobertura de testes.]

---

08 - Crie endpoints para listar vendas

• O endpoint para listar vendas deve ser acessível através do caminho (/sales) e (/sales/:id);
• Através do caminho /sales, todas as vendas devem ser retornadas;
• Através do caminho /sales/:id, apenas a venda com o id presente na URL deve ser retornada;
• o resultado deve ser ordernado de forma crescente pelo campo saleId, em caso de empate, ordernar também de forma crescente pelo campo productId;

• [Será validado que é possível listar todas as vendas]
  • Ao listar vendas com sucesso o resultado retornado deverá ser conforme exibido abaixo, com um status http 200:

    [
      {
        "saleId": 1,
        "date": "2021-09-09T04:54: