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

Esse é um projeto de aprendizado de aplicação de conceitos de construção de camadas Model, Services e Controllers. O projeto trata-se de uma API de um sistema de gerenciamento de vendas, onde é possível criar, listar, atualizar e deletar produtos e vendas (CRUD).

Habilidades exercidas

Entender o funcionamento da camada de Model;
Delegar responsabilidades específicas para essa camada;
Conectar sua aplicação com diferentes bancos de dados;
Estruturar uma aplicação em camadas;
Delegar responsabilidades específicas para cada parte do seu app;
Melhorar manutenibilidade e reusabilidade do seu código;
Entender e aplicar os padrões REST;
Escrever assinaturas para APIs intuitivas e facilmente entendíveis.

Variáveis de ambiente

Para conectar corretamente a API ao banco SQL, as variáveis de ambiente foram configuradas no arquido .env na raiz do projeto.

MYSQL_HOST=localhost

MYSQL_USER=nome

MYSQL_PASSWORD=1234

PORT=3000

Instalação e execução

Para instalar o projeto localmente

Clone o projeto

  git clone git@github.com:MikaelaBraga/store-manager.git

Acesse a pasta do projeto

  cd store-manager

Instale as dependências

  npm install

Execute o projeto (utilize algum cliente para testar as rotas: insomnia, postman, etc...)

  npm start

Execute os testes

  npm run test:mocha

API Endpoints

Cadastro de produtos

  POST /products

Parameter	Type	Description
`name`	`string`	Required
`quantity`	`string`	Required

Lista todos os produtos

  GET /products

Retorno

  [
    {
      "id": 1,
      "name": "produto A",
      "quantity": 10
    },
    {
      "id": 2,
      "name": "produto B",
      "quantity": 20
    }
  ]

Lista um único produtos

    GET /products/${id}

Parameter	Type	Description
`id`	`string`	Required. Id of item to fetch

Atualiza um produto

    PUT /products/${id}

Parameter	Type	Description
`id`	`string`	Required. Id of item to update

Deleta um produto

    DELETE /products/${id}

Parameter	Type	Description
`id`	`string`	Required. Id of item to delete

Cadastro de vendas

  POST /sales

Parameter	Type	Description
`product_id`	`string`	Required
`quantity`	`string`	Required

Lista todas as vendas

  GET /sales

Retorno

[
    {
      "saleId": 1,
      "date": "2021-09-09T04:54:29.000Z",
      "product_id": 1,
      "quantity": 2
    },
    {
      "saleId": 1,
      "date": "2021-09-09T04:54:54.000Z",
      "product_id": 2,
      "quantity": 2
    }
]

Lista uma única venda

    GET /sales/${id}

Parameter	Type	Description
`id`	`string`	Required. Id of sale to fetch

Atualiza uma venda

    PUT /sales/${id}

Parameter	Type	Description
`id`	`string`	Required. Id of sale to update

Deleta uma venda

    DELETE /sales/${id}

Parameter	Type	Description
`id`	`string`	Required. Id of sale to delete

Requisitos do projeto

Lista de requisitos

1 - Crie um endpoint para o cadastro de 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 endpoint deve receber a seguinte estrutura:

{
  "name": "product_name",
  "quantity": "product_quantity"
}

O que será validado

👉 Para o endpoint POST /products, o campo name deve ser uma string com 5 ou mais caracteres e deve ser único.

Quando a requisição é feita sem o atributo name :
```
  { "quantity": 100 }
```
- sua API deve responder com status http 400 e o seguinte body:
```
  { "message": "\"name\" is required" }
```

Quando a requisição é feita e contém o seguinte body:

  { "name": "pro", "quantity": 100 }

sua API deve responder com status http 422 e o seguinte body:

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

Quando a requisição é feita com o atributo name igual um já cadastrado:
```
  { "name": "produto", "quantity": 100 }
```
- sua API deve responder com status http 409 e o seguinte body:
```
  { "message": "Product already exists" }
```

👉 Para o endpoint POST /products, o campoquantity deve ser um número inteiro maior que 0.

Quando a requisição é feita sem o atributo quantity :
```
  { "name": "produto" }
```
- sua API deve responder com status http 400 e o seguinte body:
```
  { "message": "\"quantity\" is required" }
```

Quando a requisição é feita e contém os seguintes body:

  { "name": "produto", "quantity": "string" }

  { "name": "produto", "quantity": -1 }

  { "name": "produto", "quantity": 0 }

sua API deve responder com status http 422 e o seguinte body:

  { "message": "\"quantity\" must be a number larger than or equal to 1" }

👉 Para o endpoint POST /products, quando a requisição é feita corretamente, o produto deve ser cadastrado.

Quando a requisição é feita e contém o seguinte body:
```
  { "name": "produto", "quantity": 10 }
```
- sua API deve responder com status http 201 e o seguinte body:
```
  { "id": 1, "name": "produto", "quantity": 10 }
```

2 - Crie um endpoint para listar os produtos

O endpoint deve ser acessível através do caminho (/products) ou (/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 que será validado

👉 Para o endpoint GET /products, será validado que todos produtos estão sendo retornados.

sua API deve responder com status http 200 e o seguinte body:

  [
    {
      "id": 1,
      "name": "produto A",
      "quantity": 10
    },
    {
      "id": 2,
      "name": "produto B",
      "quantity": 20
    }
  ]

👉 Para o endpoint GET /products/:id, será validado que é possível listar um determinado produto.

sua API deve responder com status http 200 e o seguinte body:

  {
    "id": 1,
    "name": "produto A",
    "quantity": 10
  }

👉 Para o endpoint GET /products/:id, será validado que não é possível listar um produto que não existe.

sua API deve responder com status http 404 e o seguinte body:
```
  { "message": "Product not found" }
```

3 - Crie um endpoint para atualizar um produto

O endpoint deve ser acessível através do caminho (/products/:id);
O corpo da requisição deve seguir a mesma estrutura do método responsável por adicionar um produto;
Apenas o produto com o id presente na URL deve ser atualizado;
O corpo da requisição deve receber a seguinte estrutura:

{
  "name": "new_product_name",
  "quantity": "new_product_quantity"
}

O que será validado

👉 Para o endpoint PUT /products/:id, o campo name deve ser uma string com 5 ou mais caracteres e deve ser único.

Quando a requisição é feita e contém o seguinte body:

  { "name": "pro", "quantity": 15 }

sua API deve responder com status http 422 e o seguinte body:

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

👉 Para o endpoint PUT /products/:id, o campoquantity deve ser um número inteiro maior que 0.

Quando a requisição é feita e contém os seguintes body:

  { "name": "produto", "quantity": "string" }

  { "name": "produto", "quantity": -1 }

  { "name": "produto", "quantity": 0 }

sua API deve responder com status http 422 e o seguinte body:

  { "message": "\"quantity\" must be a number larger than or equal to 1" }

👉 Para o endpoint PUT /products/:id, quando a requisição é feita corretamente, o produto deve ser alterado.

Quando a requisição é feita e contém o seguinte body:
```
  { "name": "produto", "quantity": 15 }
```
- sua API deve responder com status http 200 e o seguinte body:
```
  { "id": 1, "name": "produto", "quantity": 15 }
```

👉 Para o endpoint PUT /products/:id, será validado que não é possível alterar um produto que não existe.

sua API deve responder com status http 404 e o seguinte body:
```
  { "message": "Product not found" }
```

4 - Crie um endpoint para deletar um produto

O endpoint deve ser acessível através do caminho (/products/:id);
Apenas o produto com o id presente na URL deve ser deletado;

O que será validado

👉 Para o endpoint DELETE /products/:id, será validado que é possível deletar um produto com sucesso.

sua API deve responder com status http 200 e o seguinte body:

  {
    "id": 1,
    "name": "produto A",
    "quantity": 10
  }

👉 Para o endpoint DELETE /products/:id, será validado que não é possível deletar um produto que não existe.

sua API deve responder com status http 404 e o seguinte body:
```
  { "message": "Product not found" }
```

5 - Crie um endpoint para cadastrar vendas

O endpoint deve ser acessível através do caminho (/sales);
As vendas enviadas devem ser salvas na tabela 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 endpoint deve receber a seguinte estrutura:

[
  {
    "product_id": "product_id",
    "quantity": "product_quantity",
  }
]

O que será validado

👉 Para o endpoint POST /sales, o campo product_id deve ser um id de um produto anteriormente cadastrado.

Quando a requisição é feita sem o atributo product_id :
```
  [
    {
      "quantity": 1
    }
  ]
```
- sua API deve responder com status http 400 e o seguinte body:
```
  { "message": "\"product_id\" is required" }
```

👉 Para o endpoint POST /sales, o campoquantity deve ser um número inteiro maior que 0.

Quando a requisição é feita sem o atributo quantity :
```
  [
    {
      "product_id": 1
    }
  ]
```
- sua API deve responder com status http 400 e o seguinte body:
```
  { "message": "\"quantity\" is required" }
```

Quando a requisição é feita e contém os seguintes body:

  [
    {
      "product_id": 1,
      "quantity": -1
    }
  ]

  [
    {
      "product_id": 1,
      "quantity": 0
    }
  ]

  [
    {
      "product_id": 1,
      "quantity": "string"
    }
  ]

sua API deve responder com status http 422 e o seguinte body:

  { "message": "\"quantity\" must be a number larger than or equal to 1" }

👉 Para o endpoint POST /sales, quando a requisição é feita corretamente, o produto deve ser cadastrado.

Quando a requisição é feita e contém o seguinte body:

  [
    {
      "product_id": 1,
      "quantity": 3
    }
  ]

sua API deve responder com status http 201 e o seguinte body:

  {
    "id": 1,
    "itemsSold": [
      {
        "product_id": 1,
        "quantity": 3
      }
    ]
  }

👉 Para o endpoint POST /sales, quando a requisição é feita corretamente, a venda deve ser cadastrada.

Quando a requisição é feita e contém o seguinte body:

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

sua API deve responder com status http 201 e o seguinte body:

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

6 - Crie um endpoint para listar as vendas

O endpoint deve ser acessível através do caminho (/sales) ou (/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 que será validado

👉 Para o endpoint GET /sales, será validado que todas vendas estão sendo retornados.

sua API deve responder com status http 200 e o seguinte body:

  [
    {
      "saleId": 1,
      "date": "2021-09-09T04:54:29.000Z",
      "product_id": 1,
      "quantity": 2
    },
    {
      "saleId": 1,
      "date": "2021-09-09T04:54:54.000Z",
      "product_id": 2,
      "quantity": 2
    }
  ]

👉 Para o endpoint GET /sales/:id, será validado que é possível listar uma determinada venda.

sua API deve responder com status http 200 e o seguinte body:

  [
    {
      "date": "2021-09-09T04:54:29.000Z",
      "product_id": 1,
      "quantity": 2
    },
    {
      "date": "2021-09-09T04:54:54.000Z",
      "product_id": 2,
      "quantity": 2
    }
  ]

👉 Para o endpoint GET /sales/:id, será validado que não é possível listar uma venda que não existe.

sua API deve responder com status http 404 e o seguinte body:
```
  { "message": "Sale not found" }
```

7 - Crie um endpoint para atualizar uma venda

O endpoint deve ser acessível através do caminho (/sales/:id);
quantity deve ser um número inteiro maior que 0;
Apenas a venda com o id presente na URL deve ser atualizada;
O corpo da requisição deve receber a seguinte estrutura:

[
  {
    "product_id": "id_change",
    "quantity": "new_quantity"
  }
]

O que será validado

👉 Para o endpoint PUT /sales/:id, o campo product_id deve ser um id de um produto anteriormente cadastrado.

Quando a requisição é feita sem o atributo product_id :
```
  [
    {
      "quantity": 10
    }
  ]
```
- sua API deve responder com status http 400 e o seguinte body:
```
  { "message": "\"product_id\" is required" }
```

👉 Para o endpoint PUT /sales/:id, o campo quantity deve ser um número inteiro maior que 0.

Quando a requisição é feita sem o atributo quantity :
```
  [
    {
      "product_id": 1
    }
  ]
```
- sua API deve responder com status http 400 e o seguinte body:
```
  { "message": "\"quantity\" is required" }
```

Quando a requisição é feita e contém os seguintes body:

  [
    {
      "product_id": 1,
      "quantity": -1
    }
  ]

  [
    {
      "product_id": 1,
      "quantity": 0
    }
  ]

  [
    {
      "product_id": 1,
      "quantity": "string"
    }
  ]

sua API deve responder com status http 422 e o seguinte body:

  { "message": "\"quantity\" must be a number larger than or equal to 1" }

👉 Para o endpoint PUT /sales/:id, quando a requisição é feita corretamente, a venda deve ser alterada.

Quando a requisição é feita e contém o seguinte body:

  [
    {
      "product_id": 1,
      "quantity": 6
    }
  ]

sua API deve responder com status http 200 e o seguinte body:

  {
    "saleId": 1,
    "itemUpdated": [
      {
        "product_id": 1,
        "quantity": 6
      }
    ]
  }

8 - Escreva testes para cobrir 35% das camadas da sua aplicação

Seus arquivos de teste devem ficar no diretório test/unit, como citado aqui;
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;

O que será validado

👉 Será validado que a cobertura total das linhas dos arquivos nas pastas models, services e controllers é maior ou igual a 35%.

👉 Será validado que ao menos 24 linhas são cobertas pelos testes.

9 - Escreva testes para cobrir 40% das camadas da sua aplicação

Seus arquivos de teste devem ficar no diretório test/unit, como citado aqui
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;

O que será validado

👉 Será validado que a cobertura total das linhas dos arquivos nas pastas models, services e controllers é maior ou igual a 40%.

👉 Será validado que ao menos 24 linhas são cobertas pelos testes.

Bônus

10 - Crie um endpoint para deletar uma venda

O endpoint deve ser acessível através do caminho (/sales/:id);
Apenas a venda com o id presente na URL deve ser deletado;

O que será validado

👉 Para o endpoint DELETE /sales/:id, será validado que é possível deletar uma venda com sucesso.

sua API deve responder com status http 200 e o seguinte body:

  [
    {
      "date": "2021-09-09T04:54:29.000Z",
      "product_id": 1,
      "quantity": 2
    },
    {
      "date": "2021-09-09T04:54:54.000Z",
      "product_id": 2,
      "quantity": 2
    }
  ]

👉 Para o endpoint DELETE /sales/:id, será validado que não é possível deletar uma venda que não existe.

sua API deve responder com status http 404 e o seguinte body:

  { "message": "Sale not found" }

11 - Atualize a quantidade de produtos

Ao realizar uma venda, atualizá-la ou deletá-la, você deve também atualizar a quantidade do produto em questão presente na tabela responsável pelos produtos;
- Exemplo 1: suponha que haja um produto chamado Bola de Futebol e a sua propriedade quantity tenha o valor 10. Caso seja feita uma venda com 8 unidades desse produto, a quantidade do produto deve ser atualizada para 2 , pois 10 - 8 = 2;
- Exemplo 2: Suponha que esta venda tenha sido deletada, logo estas 8 unidades devem voltar ao quantity e seu valor voltará a 10, pois 2 + 8 = 10;

O que será validado

👉 Será validado que ao fazer uma determinada venda, a quantidade do produto deverá ser atualizada também na tabela responsável pelos produtos.

👉 Será validado que ao deletar uma determinada venda, a quantidade do produto deverá ser atualizada também na tabela responsável pelos produtos;.

12 - Valide a quantidade de produtos

Um produto nunca deve ter a quantidade em estoque menor que 0;
Quando uma venda for realizada, garanta que a quantidade sendo vendida está disponível no estoque

O que será validado

👉 Para o endpoint POST /sales, será validado que a quantidade de produtos em estoque nunca seja menor que 0 (zero).

Quando a requisição é feita com uma quantidade superior a quantidade em estoque:

  [
    {
      "product_id": 1,
      "quantity": 100
    }
  ]

sua API deve responder com status http 422 e o seguinte body:

  { "message": "Such amount is not permitted to sell" }

13 - Escreva testes para cobrir 50% das camadas da sua aplicação

Seus arquivos de teste devem ficar no diretório test/unit, como citado aqui;
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;

O que será validado

👉 Será validado que a cobertura total das linhas dos arquivos nas pastas models, services e controllers é maior ou igual a 50%.

👉 Será validado que ao menos 24 linhas são cobertas pelos testes.

14 - Escreva testes para cobrir 60% das camadas da sua aplicação

Seus arquivos de teste devem ficar no diretório test/unit, como citado aqui;
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;

O que será validado

👉 Será validado que a cobertura total das linhas dos arquivos nas pastas models, services e controllers é maior ou igual a 60%.

👉 Será validado que ao menos 24 linhas são cobertas pelos testes.