APP EASYWALLET 💱

PROJETO BACKEND

Já imaginou como funcionaria uma carteira digital "por baixo dos panos"? Então, eu também imaginei 😄.

Como uma forma de consolidar meus aprendizados com as tecnologias Sequelize ORM e MySQL, trabalhadas em conjunto com JavaScript, NodeJS e Docker, desenvolvi esse projeto que simula o backend de uma carteira digital, onde é possível acessar as rotas da aplicação, um banco de dados pré-definido, e simular transferências em $$ entre as pessoas usuárias. Tudo isso observando os padrões de arquitetura MVC e API RESTful.

SOBRE O PROJETO

Pensado para ser um modelo simplificado de conta digital que permite transações financeiras entre pessoas usuárias diferentes, algumas regras de negócio precisavam ser estabelecidas, a saber:

Existem 2 tipos diferentes de pessoa usuária: física e jurídica.
Ambas são registradas no sistema e possuem informações em comum como: nome completo, email e senha. Porém, clientes pessoa física possuem CPF e clientes pessoa jurídica são identificados pelo CNPJ.
Os dados CPF/CNPJ e emails devem ser únicos no sistema.
Somente clientes pessoa física podem realizar a operação de transferência. Lojistas (pessoa jurídica) podem receber transferências mas não estão aptos a enviar dinheiro.
É preciso avaliar se há saldo disponível na conta da pessoa usuária sempre que ela iniciar uma transferência.
Caso a transferência seja iniciada, deve-se simular um serviço de autorização externo para que a mesma seja liberada. Ou seja, essa simulação deve ocorrer antes da transferência ser finalizada.
- Aqui, o serviço foi simulado através de uma requisição para esse mock
A operação de transferência deve ser uma transação (ou seja, revertida em qualquer caso de inconsistência) e o dinheiro deve voltar para a carteira do usuário que envia.
Ao receber o pagamento, a pessoa usuária precisa receber notificação (envio de email, sms) enviada por um serviço externo e, eventualmente, este serviço pode estar indisponível/instável.
- Essa etapa foi simulada através de uma requisição a esse mock
A realização das transferências deve ocorrer em uma rota transaction do tipo POST e ser semelhante ao modelo:
```
{
 "value" : 100.00,
 "payer" : 4,
 "payee" : 15
}
```

DESENVOLVIMENTO

Antes de começar a estruturar o código, primeiro busquei visualizar como se daria a relação entre as camadas da aplicação com o banco de dados. Além disso, pensei sobre como seria o relacionamento desses dados no banco e como estariam agrupados. Essas reflexões me levaram a escolher trabalhar com o MySQL, um banco de dados relacional, pois precisava criar um modelo simples de banco de dados que me permitisse ter controle sobre as operações envolvidas nas etapas de criação de tabelas e seus campos e de consulta ao banco.

Para dinamizar a criação e preenchimento das tabelas, escolhi trabalhar também com o Sequelize ORM, que iria ajudar nas etapas de consulta ao banco para buscar ou alterar dados específicos. Essa ferramenta iria trazer flexibilidade para o MySQL, aliando as vantagens de um banco relacional com a versatilidade de um ORM.

Para completar, optei por usar o combo JavaScript + NodeJS para desenvolver a lógica do projeto e a estrutura MVC.

Como preferi utilizar o Docker para carregar os containers de minha aplicação e banco de dados, optei por deixar um arquivo .env genérico na raiz do projeto. Aviso aqui contudo que normalmente essa não é uma prática recomendada. No meu caso, como precisei de um arquivo "ponte" para que a aplicação rode corretamente, deixei apenas o escopo das variáveis de ambiente necessárias ao projeto.

Ok, falei bastante sobre o processo de escolha das ferramentas. Mas e quanto à solução em código?

Posso dizer que o código foi elaborado a partir de vários esboços (vários mesmo 😅) sobre como seria a relação entre certas camadas da aplicação com o banco de dados, bem como o relacionamento entre tabelas do próprio banco. Mas finalmente cheguei a um padrão visual bem próximo ao que acabou ficando definido no código, a saber:

ANTES DE COMEÇAR

Esse projeto utiliza Docker para ser inicializado, portanto, é preciso que você já o tenha instalado em sua máquina antes de executar os passos a seguir.

Destaco ainda que esse projeto não possui Front-end e, uma vez que será necessário o acesso para as rotas da aplicação por meio de requisições HTTP e para as tabelas no banco de dados por meio de queries, é recomendável que você tenha em sua máquina ferramentas similares ao Postman e ao MySQL Workbench para melhor consultar essas informações.

INSTRUÇÕES PARA ACESSO:

Clone o repositório:

git clone https://github.com/loren-gt/app-easywallet.git
Entre na pasta do repositório que você acabou de clonar:
- cd app-easywallet

Utilize o comando abaixo para rodar o projeto com Docker:

docker-compose up --force-recreate

Dessa forma, sua aplicação estará ativa e conectada à instância do MySQL na porta 3306.

Você já pode realizar as requisições e consultas ao banco normalmente.

Opcional: Se precisar parar a aplicação e executa-la novamente, utilize o comando a seguir antes de rodar o comando Docker anterior. Entretanto, note que o comando a seguir irá limpar os containers e todas as images do seu pc. Utilize com sabedoria. 😉

docker system prune --all --force --volumes

INFORMAÇÕES ADICIONAIS

O projeto cria e popula automagicamente o banco de dados users_api assim que o Docker levanta os containers necessários.

As rotas do projeto são:
- /user - GET: exibe todos as pessoas usuárias
- /user/:id - GET: exibe um usuário específico (representado por id)
- /wallet - GET: exibe os dados da carteira de todas as pessoas usuárias
- /wallet/:id - GET: exibe os dados da carteira de uma pessoa usuária específica
- /transaction - POST: analisa e efetua a transação entre duas pessoas usuárias
As tabelas do banco de dados são:
- Admins - representa os dados das pessoas usuárias do tipo jurídico.
- Clients - representa os dados das pessoas usuárias do tipo físico.
- Users - mostra os dados de todas as pessoas cadastradas.
- Wallets - exibe informações como o saldo de todas as pessoas cadastradas.
- Transactions - inicialmente vazia, vai sendo populada conforme as transações são realizadas. Ela exibe os dados de todas as transações.
A transação, representada pelo valor inserido pela pessoa usuária, contém as informações value (valor a ser transferido), payer (identificador da pessoa pagadora _ relacionada aqui com o identificador da tabela Clients) e payee (identificador da pessoa destinatária _ representada com o identificador da tabela Admins).