Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/lucas54neves/byebnk-desafio-backend

Asset financial API
https://github.com/lucas54neves/byebnk-desafio-backend

asset-finance byebnk django django-rest-framework finance python

Last synced: 8 days ago
JSON representation

Asset financial API

Awesome Lists containing this project

README 

        
# Desafio técnico backend - Byebnk



## Sumário



1. [Descrição do desafio](#descricao-desafio)



2. [Comandos principais](#comandos-principais)



3. [Rotas](#rotas)



## Descrição do desafio 



Olá,



Estamos muito felizes que você deseja fazer parte do time da Byebnk. O teste abaixo é construido de

forma que você consiga demonstrar os seus conhecimentos em Django/DRF e investimentos. Ele consiste

em apenas 2 a 3 endpoints com regras de negócio bem específicas.



Se você não entende de investimentos, não se preocupe. Isso é algo que você pode aprender trabalhando

com a gente. As regras financeiras estão bem detalhadas nos requisitos obrigatórios, mas caso tenha

alguma dificuldade em entender, não tenha medo de perguntar. Isso não é um ponto negativo. Na Byebnk

valorizamos quem sabe utilizar todos os recursos disponíveis para entregar um excelente resultado.

Por outro lado, se você é o especialista em mercado de capitais, pode se aventurar desenvolvendo

alguns dos requisitos extras (opcionais).



Você pode organizar a API e o banco de dados da maneira que achar que faz mais sentido. Além disso,

sinta-se a vontade para adicionar ferramentas ou funcionalidades que ache relevante, porém não deixe

que isso impacte negativamente a qualidade dos requisitos obrigatórios.



Uma coisa muito importante na Byebnk são os testes. A complexidade e responsabilidade dos sistemas

são grandes e o que nos ajuda a manter tudo sobre controle são os testes automatizados. Você não

precisa testar cada mínimo detalhe do seu código, mas é importante que as principais regras de

negócio estejam testadas e demais condições que você achar relevante (as decisões são importantes:

vamos perguntar o porque você decidiu testar A e não B).



Lembre-se: Existem diversas formas de se desenvolver um sistema. Não estamos procurando a resposta

certa, mas sim uma explicação racional por trás de cada decisão tomada.



### Requisitos obrigatórios



Usando [Django](https://www.djangoproject.com/) e [Django REST framework](https://www.django-rest-framework.org/)

desenvolva uma API REST que permita usuários a gerenciar investimentos.



#### Usuários devem ser capazes de



1. Cadastrar ativos

   - Os ativos devem conter no mínimo as informações abaixo:

     - Nome - uma denominação para este ativo

     - Modalidade - renda fixa, renda variável ou cripto

2. Fazer aplicações e resgates em um ativo

   - Aplicação é quando o usuário aporta dinheiro em um ativo

   - Resgate é quando o usuário retira dinheiro de um ativo

   - Aplicações e resgates são transacionais e imutáveis. Uma vez realizada não há como alterar.

   - As aplicações e resgates devem conter no mínimo as informações abaixo:

     - Ativo - O ativo ao qual a aplicação/resgate se refere

     - Data de solicitação - a data em que a aplicação/resgate foi solicitada

     - Quantidade - número de ativos que foram aplicados/resgatados

     - Preço unitário - preço unitário do ativo na aplicação/resgate

   - Usuários podem fazer aplicações/resgate em ativos cadastrados por qualquer usuário

     - Exemplo:

     - O usuário A cadastra um ativo chamado BITCOIN e faz uma aplicação de mil reais

     - O usuário B pode aplicar no ativo BITCOIN também, pois ele já foi cadastrado pelo usuário A

3. Visualizar o saldo da sua carteira de investimentos

   - Você pode decidir onde e como mostrar a informação

   - O saldo da carteira é o somatório de saldos investidos em cada um dos ativos



#### Usuários não podem



- Ver aplicações e resgates de outros usuários

- Ver o saldo da carteira de outros usuários



#### Outros detalhes da API



- Testes

  - As funcionalidade principais devem estar com [testes](https://docs.djangoproject.com/en/3.1/topics/testing/) escritos

  - Não é preciso testar tudo, você pode decidir quais os testes que mais agregam valor ao projeto

- **O escopo do desafio é somente a API REST**

  - Você **não** precisa desenvolver frontend/formulários para o sistema

  - Você **não** precisa desenvolver endpoints para criação/gerenciamento de usuários

  - Você apenas precisa desenvolver os 2 a 3 endpoints REST necessários para a realização dos requisitos obrigatórios



### Requisitos extras (opcional)



- Permitir os usuários listar ativos por tipo (renda fixa, renda váriavel, cripto)

- Adicionar o preço de mercado de cada ativo e calcular o saldo de carteira utilizando ele

- Permitir os usuários visualizar o lucro/prejuízo realizado

- Salvar o endereço de IP do usuário que fez uma aplicação/resgate

- Expandir o sistema adicionando taxa de custódia, administração, tarifa de saque, etc...



### O que vamos avaliar (nesta ordem)



1. O cumprimento dos requisitos obrigatórios

2. A forma que o código está organizado

3. O domínio das funcionalidade do Django e DRF

4. A abordagem e abrangência dos testes do código

5. A simplicidade da solução

6. Aderência a [PEP 8](https://duckduckgo.com/?q=pep8)

7. A implementação de requisitos opcionais

8. A implementação de funcionalidades extras



## Comandos principais 



### Instalar a venv



```

# No diretório src

python3 -m venv venv

```



### Ativar a venv



```

# No diretório src

source venv/bin/activate

```



### Para instalar as dependências



```

pip install -r requirements.txt

```



### Criar o projeto



```

django-admin startproject core .

```



### Criar app asset



```

django-admin startapp asset

```



### Iniciar o servidor



```

python manage.py runserver

```



### Criar migrations



```

python manage.py makemigrations

```



### Rodar migrations



```

python manage.py migrate

```



### Para rodar os testes



```

python manage.py test

```



## Rotas 



Observação: O projeto está programado para calcular o valor dos ativos automaticamente, porém deve ser enviado os nomes corretos que a lib yfinance espera. Segue alguns exemplos para teste:



- '^BVSP'

- 'PETR4.SA'

- 'BTC-USD'

- 'ETH-USD'

- 'XPLG11.SA'



### /balance



Rota que retorna o saldo da conta do usuário. O usuário deve estar logado.



### /assets



Rota para adicionar e visualizar os ativos financeiros. O usuário deve estar logado. Para listar por categoria, deve-se passar por query params no parâmetro **modality** pelo menos um desses valores:



- 'cripto'

- 'variable'

- 'fixed'



### /transactions



Rota para adicionar e visualizar as transações (aplicação e resgate). O usuário deve estar logado.



### /accounts



Rotas relativas às contas de usuário.



- /accounts/signup: Criar conta

- /accounts/login: Realizar login

- /accounts/logout: Realizar logout