transactions

:fire: Sobre o projeto

Nesse projeto utilizo Node.js junto ao TypeScript para desenvolver uma aplicação de gestão de transações. É utilizado também o TypeORM para gerenciar um banco de dados e o Multer para tratativa de upload de arquvios. Essa aplicação foi desenvolvida orientada a testes, ao final todos os testes foram passados com sucesso. Essa é uma aplicação que armazena transações financeiras de entrada e saída e permiti 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.

Específicação dos testes

Em cada teste, tem uma breve descrição do que a aplicação cumpri para que o teste passe.

Para essa aplicação, temos os seguintes testes:

• should be able to create a new transaction: Para que esse teste passe, a aplicação permiti 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 permiti 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 o id que acabou de ser criado.

• should not create tags when they already exists: Para que esse teste passe, a aplicação permiti que ao criar uma nova transação com uma categoria que já existe, seja atribuído ao campo category_id da transação com o id dessa categoria existente, não permitindo a criação de categorias com o mesmo title.

• should be able to list the transactions: Para que esse teste passe, a aplicação permiti 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 permiti que uma transação do tipo outcome 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, a rota de delete precisa excluir uam transação, e ao fazer a exclusão, ele retorne uma resposta vazia, com status 204.

• should be able to import transactions: Para que esse teste passe, a aplicação permiti que seja importado um arquivo csv, contendo o seguinte modelo. Com o arquivo importado, você deve 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.

Rotas da aplicação

• POST /transactions: A rota recebe title, value, type, e category dentro do corpo da requisição, sendo o type o tipo da transação, que deve ser income para entradas (depósitos) e outcome para saídas (retiradas). Ao cadastrar uma nova transação, ela deve ser armazenada dentro do seu banco de dados, possuindo os campos id, title, value, type, category_id, created_at, updated_at.

{
  "id": "uuid",
  "title": "Salário",
  "value": 3000,
  "type": "income",
  "category": "Alimentação"
}

• GET /transactions: Essa rota retorna uma listagem com todas as transações que você cadastrou até agora, junto com o valor da soma de entradas, retiradas e total de crédito. Essa rota retorna um objeto do 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 deleta uma transação com o id 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ção id, 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 retorne todas as transactions que foram importadas para seu banco de dados. O arquivo csv, deve seguir o seguinte modelo

---

Como rodar o projeto localmente

Para rodar o projeto você irá precisar ter:

• Node;
• Yarn ou NPM;
• Postgres (pode ser pelo docker);

Passo a passo

• Primeiramente, ao baixar o projeto, rode o yarn para instalar as dependências;

• Após isso você deve copiar o conteúdo do arquivo ormconfig.json.example e substituir pelas informações de conexão do seu postgres;

• Após modificar as conexões, basta apenas rodar o comando yarn typeorm migration:run e o projeto estará pronto para executar.

Na raiz do projeto temos o arquivo do ambiente para testes no Insomnia: Ambiente-Insominia

Fim :fire: