Desafio de Backend
Seu objetivo é criar uma API REST com algumas funções essenciais relacionadas ao gerenciamento de contas bancárias em uma das linguagem: Java, Kotlin, Python, Node.js, .NET
- Para abrir uma conta é necessário apenas o nome completo e CPF da pessoa, mas só é permitido uma conta por pessoa;
- Com essa conta é possível realizar transferências para outras contas e depositar;
- Não aceitamos valores negativos nas contas;
- Por questão de segurança cada transação de depósito não pode ser maior do que R$2.000;
- As transferências entre contas são gratuitas e ilimitadas;
Em relação a banco de dados, quem decide é você mesmo.
Por favor, não esquecer de adicionar no README as instruções de como executar o projeto.
- Performance
- Testes
- Manutenabilidade
- Princípios de programação
- Arquitetura de Software
Não faça um fork desse projeto, crie um repositório PÚBLICO no seu perfil do GitHub. Pode criar privado mesmo, sem problemas. Assim que terminar é só compartilhar o código com nosso usuário devdigitalrepublic e envie o link para rh@digitalrepublic.com.br
Boa sorte e divirta-se! ;)
Este projeto foi desenvolvido para candidatura à vaga de Software Developer Backend na Digital Republic.
A arquitetura MSC foi adotada para desenvolvimento da API, seguindo os padrões REST conforme exigido pelo enunciado do desafio. A principal intenção foi desenvolver a aplicação com baixo acoplamento para facilitar a manutenção e melhorar a legibilidade.
Foram utilizados os frameworks Node.js e Express.js (JavaScript).
O banco de dados utilizado foi o MySQL, em conjunto com o ORM Sequelize. As transferências entre contas utilizam transactions para conferir segurança e credibilidade ao código; e evitar inconsistências de valores.
Com relação à segurança, o banco de dados armazena a hash (em SHA-256) da senha dos usuários e conta com bloqueio de login, com duração de 5 minutos, em caso de 3 tentativas malsucedidas consecutivas. Para autenticação dos usuários foi utilizada a biblioteca JSON Web Token, JWT.
A aplicação conta com validação de dígito verificador do Cadastro de Pessoa Física e impede utilização de CPFs inválidos.
Para facilitar testes manuais, foi disponibilizado um endpoint /cpf-generator para geração de CPFs válidos.
A numeração das contas dos usuários seguem o padrão do Social Security Number (SSN) para mitigar a possibilidade de serem geradas contas com numerações iguais, não obstante haja verificação para garantia.
Foi utilizado o ESLint para uniformização do código, seguindo a configuração padrão Airbnb.
Para escrita de testes, foram utilizados os frameworks Sinon, Mocha e Chai.
A seguinte modelagem foi utilizada:
É necessário ter instalada a versão 16.13.2 LTS do node para executar o projeto.
No terminal, realize o clone deste respositório e instale as dependências com npm install.
Para executar o projeto, é necessário renomear o arquivo example.env para .env, fazer as configurações necessárias com usuário e senha para o Sequelize acessar o banco de dados e, caso seja pertinente, alterar o número da porta que a aplicação utilizará e o nome do banco de dados.
Atenção: Certifique-se de que o nome do banco de dados definido no arquivo .env não esteja em conflito com eventual banco de dados já existente na máquina.
Em seguida, executar os comandos npx sequelize db:create && npx sequelize db:migrate && npx sequelize db:seed:all. Para o banco de dados da aplicação ser criado, bem como suas tabelas e conteúdo.
Em seguida, o comando npm run dev iniciará a aplicação na porta definida no arquivo .env e será possível realizar requisições aos endpoints por meio do Insomnia, Postman, HTTPie ou outros.
Os endpoints são os seguintes:
localhost:PORT/cpf-generator - GET
localhost:PORT/signup - POST: Deve conter um body com as propriedades firstName, middleName (opcional) e lastName cujo valor seja uma string com, pelo menos, dois caracteres; e, no header, Basic auth em que username é um número de CPF válido (é possível gerar um número de CPF válido no endpoint acima) e uma senha que contenha 1 número, 1 letra minúscula, 1 letra maiúscula e 1 caracter especial. Retorna um token e o id do cliente.
localhost:PORT/login - GET: Deve conter no header Basic auth em que username é um número de CPF válido e cadastrado; e a senha. Retorna um token.
localhost:PORT/me - GET: Deve conter no header um Bearer token, gerado no signup ou login. Retorna informações do cliente.
localhost:PORT/me/account - GET: Deve conter no header um Bearer token, gerado no signup ou login. Retorna informações da conta do cliente.
localhost:PORT/me/deposit - POST: Deve conter no header um Bearer token, gerado no signup ou login; e um body com a propriedade value, cujo valor deve ser um número no formato 1000 ou 1000.00. Retorna o saldo anterior e atual da conta.
localhost:PORT/me/transfer - POST: Deve conter no header um Bearer token, gerado no signup ou login; e um body contendo as propriedades value, cujo valor deve ser um número; e to, cujo valor deve ser uma string contendo o número da conta para transferência. É possível verificar o número da conta com o token no endpoint /me/account.
Para executar os testes, é possível alterar no arquivo .env, a propriedade NODE_ENV de development para test para que o Sequelize utilize o banco de testes, e não prejudique o banco de dados utilizado para desenvolvimento.
O comando para execução é npm test.
O tempo despendido para realização deste projeto:
