Nesse desafio, deve-se continuar desenvolvendo a aplicaĆ§Ć£o de gestĆ£o de transaƧƵes, treinando o que foi aprendido atĆ© agora no Node.js junto ao TypeScript, mas dessa vez incluindo o uso de banco de dados com o TypeORM e envio de arquivos com o Multer.
Essa serĆ” uma aplicaĆ§Ć£o que deve armazenar transaƧƵes financeiras de entrada e saĆda e permitir o cadastro e a listagem dessas transaƧƵes, alĆ©m de permitir a criaĆ§Ć£o de novos registros no banco de dados a partir do envio de um arquivo csv.
Deve-se navegar atƩ a pasta criada e abri-la no Visual Studio Code, lembrando-se de executar o comando yarn
no terminal para instalar todas as dependĆŖncias.
Deve-se verificar os arquivos da pasta src
e completar onde nĆ£o possui cĆ³digo com o cĆ³digo para atingir os objetivos de cada rota.
POST /transactions
: A rota deve recebertitle
,value
,type
, ecategory
dentro do corpo da requisiĆ§Ć£o, sendo otype
o tipo da transaĆ§Ć£o, que deve serincome
para entradas (depĆ³sitos) eoutcome
para saĆdas (retiradas). Ao cadastrar uma nova transaĆ§Ć£o, ela deve ser armazenada dentro do banco de dados, possuindo os camposid
,title
,value
,type
,category_id
,created_at
,updated_at
.
Dica: Para a categoria, deve-se criar uma nova tabela, que terĆ” os campos id
, title
, created_at
, updated_at
.
Dica 2: Antes de criar uma nova categoria, deve-se verificar se jĆ” existe uma categoria com o mesmo tĆtulo. Caso ela exista, deve-se usar o id
jĆ” existente no banco de dados.
{
"id": "uuid",
"title": "SalƔrio",
"value": 3000,
"type": "income",
"category": "AlimentaĆ§Ć£o"
}
GET /transactions
: Essa rota deve retornar uma listagem com todas as transaƧƵes cadastrados atƩ agora, junto com o valor da soma de entradas, retiradas e total de crƩdito. Essa rota deve retornar um objeto o seguinte formato:
{
"transactions": [
{
"id": "uuid",
"title": "SalƔrio",
"value": 4000,
"type": "income",
"category": {
"id": "uuid",
"title": "Salary",
"created_at": "2020-04-20T00:00:49.620Z",
"updated_at": "2020-04-20T00:00:49.620Z",
},
"created_at": "2020-04-20T00:00:49.620Z",
"updated_at": "2020-04-20T00:00:49.620Z",
},
{
"id": "uuid",
"title": "Freela",
"value": 2000,
"type": "income",
"category": {
"id": "uuid",
"title": "Others",
"created_at": "2020-04-20T00:00:49.620Z",
"updated_at": "2020-04-20T00:00:49.620Z",
},
"created_at": "2020-04-20T00:00:49.620Z",
"updated_at": "2020-04-20T00:00:49.620Z",
},
{
"id": "uuid",
"title": "Pagamento da fatura",
"value": 4000,
"type": "outcome",
"category": {
"id": "uuid",
"title": "Others",
"created_at": "2020-04-20T00:00:49.620Z",
"updated_at": "2020-04-20T00:00:49.620Z",
},
"created_at": "2020-04-20T00:00:49.620Z",
"updated_at": "2020-04-20T00:00:49.620Z",
},
{
"id": "uuid",
"title": "Cadeira Gamer",
"value": 1200,
"type": "outcome",
"category": {
"id": "uuid",
"title": "Recreation",
"created_at": "2020-04-20T00:00:49.620Z",
"updated_at": "2020-04-20T00:00:49.620Z",
},
"created_at": "2020-04-20T00:00:49.620Z",
"updated_at": "2020-04-20T00:00:49.620Z",
}
],
"balance": {
"income": 6000,
"outcome": 5200,
"total": 800
}
}
DELETE /transactions/:id
: A rota deve deletar uma transaĆ§Ć£o com oid
presente nos parĆ¢metros da rota;
POST /transactions/import
: A rota deve permitir a importaĆ§Ć£o de um arquivo com formato.csv
contendo as mesmas informaƧƵes necessĆ”rias para criaĆ§Ć£o de uma transaĆ§Ć£oid
,title
,value
,type
,category_id
,created_at
,updated_at
, onde cada linha do arquivo CSV deve ser um novo registro para o banco de dados, e por fim retornar todas astransactions
que foram importadas para o banco de dados. O arquivo csv, deve seguir o seguinte modelo.
Em cada teste, hĆ” uma breve descriĆ§Ć£o no que a aplicaĆ§Ć£o deve cumprir para que o teste passe.
Para esse desafio, existem os seguintes testes:
ā ļø Antes de rodar os testes, deve-se criar um banco de dados com o nome "gostack_desafio06_tests" para que todos os testes possam executar corretamente ā ļø
should be able to create a new transaction
: Para que esse teste passe, a aplicaĆ§Ć£o deve permitir que uma transaĆ§Ć£o seja criada, e retorne um json com a transaĆ§Ć£o criado.
should create tags when inserting new transactions
: Para que esse teste passe, a aplicaĆ§Ć£o deve permitir que ao criar uma nova transaĆ§Ć£o com uma categoria que nĆ£o existe, essa seja criada e inserida no campo category_id da transaĆ§Ć£o com oid
que acabou de ser criado.
should not create tags when they already exists
: Para que esse teste passe, a aplicaĆ§Ć£o deve permitir que ao criar uma nova transaĆ§Ć£o com uma categoria que jĆ” existe, seja atribuĆdo ao campo category_id da transaĆ§Ć£o com oid
dessa categoria existente, nĆ£o permitindo a criaĆ§Ć£o de categorias com o mesmotitle
.
should be able to list the transactions
: Para que esse teste passe, a aplicaĆ§Ć£o deve permitir que seja retornado um array de objetos contendo todas as transaƧƵes junto ao balanƧo de income, outcome e total das transaƧƵes que foram criadas atĆ© o momento.
should not be able to create outcome transaction without a valid balance
: Para que esse teste passe, a aplicaĆ§Ć£o nĆ£o deve permitir que uma transaĆ§Ć£o do tipooutcome
extrapole o valor total que o usuĆ”rio tem em caixa (total de income), retornando uma resposta com cĆ³digo HTTP 400 e uma mensagem de erro no seguinte formato:{ error: string }
.
should be able to delete a transaction
: Para que esse teste passe, deve-se permitir que a rota de delete exclua uma transaĆ§Ć£o, e ao fazer a exclusĆ£o, ela retorne uma resposta vazia, com status 204.
should be able to import transactions
: Para que esse teste passe, a aplicaĆ§Ć£o deve permitir que seja importado um arquivo csv, contendo o seguinte modelo. Com o arquivo importado, deve-se permitir que seja criado no banco de dados todos os registros e categorias que estavam presentes nesse arquivo, e retornar todas as transactions que foram importadas.