/desafio-ruby-backend

Desafio para Rubystas. Mas quem quiser testar em outras linguagens, está convidado também

Primary LanguageRuby

Desafio programação - para vaga Back-end

Por favor leiam este documento do começo ao fim, com muita atenção. O intuito deste teste é avaliar seus conhecimentos técnicos com o back-end, para ser mais específico em Ruby.

O teste consiste em parsear este arquivo de texto (CNAB) e salvar suas informações (transações financeiras) em uma base de dados a critério do candidato.

Este desafio deve ser feito por você em sua casa.

Instruções de entrega do desafio

  1. Primeiro, faça um fork deste projeto para sua conta no Github (crie uma se você não possuir).
  2. Em seguida, implemente o projeto tal qual descrito abaixo, em seu clone local.
  3. Por fim, envie via email um arquivo patch para seu contato na Impulso.

Descrição do projeto

Você recebeu um arquivo CNAB com os dados das movimentações finanaceira de várias lojas. Precisamos criar uma maneira para que estes dados sejam importados para um banco de dados.

Sua tarefa é criar uma interface web que aceite upload do arquivo CNAB, normalize os dados e armazene-os em um banco de dados relacional e exiba essas informações em tela.

Sua aplicação web DEVE:

  1. Ter uma tela (via um formulário) para fazer o upload do arquivo
  2. Interpretar ("parsear") o arquivo recebido, normalizar os dados, e salvar corretamente a informação em um banco de dados relacional, se atente as documentações que estão logo abaixo.
  3. Exibir uma lista das operações importadas por lojas, e nesta lista deve conter um totalizador do saldo em conta
  4. Ser escrita obrigatoriamente em Ruby 2.0+
  5. Ser simples de configurar e rodar, funcionando em ambiente compatível com Unix (Linux ou Mac OS X). Ela deve utilizar apenas linguagens e bibliotecas livres ou gratuitas.

Sua aplicação web NÃO precisa:

  1. Lidar com autenticação ou autorização (pontos extras se ela fizer, mais pontos extras se a autenticação for feita via OAuth).
  2. Ser escrita usando algum framework específico (mas não há nada errado em usá-los também, use o que achar melhor).

Documentação do CNAB

Descrição do campo Inicio Fim Tamanho Comentário
Tipo 1 1 1 Tipo da transação
Data 2 9 8 Data da ocorrência
Valor 10 19 10 Valor da movimentação. Obs. O valor encontrado no arquivo precisa ser divido por cem(valor / 100.00) para normalizá-lo.
CPF 20 30 11 CPF do beneficiário
Cartão 31 42 12 Cartão utilizado na transação
Hora 43 48 6 Hora da ocorrência atendendo ao fuso de UTC-3
Dono da loja 49 62 14 Nome do representante da loja
Nome loja 63 81 19 Nome da loja

Documentação sobre os tipos das transações

Tipo Descrição Natureza Sinal
1 Débito Entrada +
2 Boleto Saída -
3 Financiamento Saída -
4 Crédito Entrada +
5 Recebimento Empréstimo Entrada +
6 Vendas Entrada +
7 Recebimento TED Entrada +
8 Recebimento DOC Entrada +
9 Aluguel Saída -

Avaliação

Seu projeto será avaliado de acordo com os seguintes critérios.

  1. Sua aplicação preenche os requerimentos básicos?
  2. Você documentou a maneira de configurar o ambiente e rodar sua aplicação?
  3. Você seguiu as instruções de envio do desafio?
  4. Qualidade e cobertura dos testes unitários.

Adicionalmente, tentaremos verificar a sua familiarização com as bibliotecas padrões (standard libs), bem como sua experiência com programação orientada a objetos a partir da estrutura de seu projeto.


Boa sorte!

My Solution

Setup

Project dependencies

Credentials

Create a .env and a .postgres_env according to sample files, .env.sample and .postgres_env.sample. In those files you need to set database credentials and hostname.

If you're using the docker-compose from this project, the $DATABASE_HOST must be postgres.

Container setup

Build the containers for the application

$ docker-compose build

Create database and load config data

$ docker-compose run webapp bundle exec rails db:setup

This next step is actually executed during container building process.

Anyway, I've ran into a webpacker related error and this fixed.

$ docker-compose run webapp bundle exec rails webpacker:install

Running the application

Let docker compose do the job for us

$ docker-compose up

The application will be accessible on localhost:3000

Testing

Run tests using rspec

$ docker-compose run webapp bundle exec rspec

Code Linter

Code quality evaluation is available with rubocop

$ docker-compose run webapp bundle exec rubocop

Disclaimer

When parsing data from a file with more than one line, there are a few different approaches for handling errors. I could have aborted and rollback all the operations, or generate a new output file with a list of failures. Really depends on the scenario and on the opinion of the UX/product team. Due to the short interval I had to build this solution, I've arbitrarily chose to talk to no one and just do the less effort solution, which was logging the error message.

ToDo

  • Create a rails application running on docker
  • Setup testing tools
  • Build an API to receive the CNAB file (mocked response)
  • Build an API to retrieve trades list (mocked data)
  • Create database and model layer
  • Implement data parsing and persistence
  • Implement data extraction and presentation
  • Create the frontend layer with form for file input
  • Create the frontend layer with listing operations
  • Handle errors when uploading cnab file (no file, error messages)
  • Tests for frontend
  • More test scenarios
  • Table for trades list