Skip to content

Latest commit

 

History

History
143 lines (107 loc) · 5.95 KB

README.md

File metadata and controls

143 lines (107 loc) · 5.95 KB
Raw

Cadastro de usuários

Esse projeto consiste em uma aplicação web para cadastro de usuários. Os dados de cadastro estão na estrutura a seguir:

  • nome
  • e-mail
  • endereço do usuário
    • País
    • Estado
    • Município
    • CEP
    • Rua
    • Número
    • Complemento
  • CPF
  • PIS
  • Senha

Dependências Utilizadas

  • Ubuntu 18.04
  • Python 3.8.7
  • PostgreSQL 13.2
  • jq
    • usado para filtrar o retorno do curl que é usado no script de população do banco de dados
  • virtualenv
    • usado para separar bibliotecas usadas caso execute o projeto diretamente
  • outras bibliotecas podem ser encontrada no arquivo requirements.txt

Criação do ambiente

Na raiz do projeto:

  • Criar o ambiente virtual usando
virtualenv -p python3.8 .env
  • Ativar o ambiente virtual com
source .env/bin/activate
  • Instalar as dependências
pip install -r requirements.txt
  • No PostgreSQL deve haver dois bancos: web_user e test_web_user. Um para a aplicação e outro para testes, respectivamente. Esses bancos de dados não precisam ter tabelas, eles só precisam existir.
  • Algumas variáveis são declaradas no arquivo local_settings.py, que por motivos de segurança, está sendo ignorado pelo git. Ele é idêntico ao local_settings.example.py. É necessário apenas substituir a SECRET_KEY, colocando o resultado de
openssl rand -hex 32

Como popular o banco de dados por script

Para facilitar os testes iniciais, existe o arquivo populate.sh. Caso ele não esteja com permissão de execução, basta rodar

chmod +x caminho/para/populate.sh

Para executá-lo e, consequentemente, adicionar valores ao banco de dados, basta usar

./caminho/para/populate.sh

Este arquivo cria 2 usuários. O primeiro com 1 endereço e o segundo com 2. OBS: O backend deve estar rodando.

Como executar o projeto

Com o ambiente virtual ativo, execute:

uvicorn backend.main:app --reload

Você pode acessar as rotas descritas no main.py pela barra de buscas ou usar o Interactive API docs

Como popular o banco de dados manualmente

Para inserir dados pelo Interactive API docs, siga os seguintes passos:

Com o projeto executando, vá para a página

http://127.0.0.1:8000/docs#/

Ao clicar em qualquer uma das rotas, aparecerão alguns campos. Para adicionar valores, basta clicar em Try it out. Depois de modificar os valores, é só clicar em Execute. Nas respostas você verá o curl utilizado, o código de status e outras informações. Esse curl pode ser modificado e enviado diretamente pelo terminal, mudando os valores que devem ser únicos.

No começo da página e em algumas rotas existe um botão chamado Authorize. Ao clicar, aparecerá uma tela de login. Preencha com usuário e senha já cadastrados e clique em Authorize. Enquanto o usuário estiver logado, o cadeado do botão aparecerá "trancado".

GET /users/ Retorna todos os usuários. É preciso verificar necessidade. No momento seria para administradores ou equivalente, dependendo da regra de negócio.

POST /users/ Adiciona um usuário

GET /users/{user_id}/ Retorna o usuário de acordo com o id

DELETE ​/users​/{user_id}​/ Apaga o usuário de acordo com o id

GET /users​/{user_id}​/addresses​/ Retorna os endereços de acordo com o id o usuário

POST ​/users​/{user_id}​/addresses​/ Adiciona um endereço para o usuário do id especificado

DELETE ​/users​/{user_id}​/addresses​/ Apaga todos os endereços de um usuário. Só é usado quando apaga o usuário

GET ​/addresses​/ Retorna todos os endereços de todos os usuários. É preciso verificar necessidade. No momento seria para administradores ou equivalente, dependendo da regra de negócio.

DELETE ​/addresses​/{address_id}​/ Apaga o endereço de acordo com o id

PUT ​/users​/{user_id}​/addresses​/{address_id}​/ Modifica o endereço de um usuário

GET ​/items​/ Retorna o token

GET ​/users​/me Retorna o usuário atual

POST ​/token Cria o token de acesso

Obs: e-mail, CPF e PIS estão sendo validados. Para o POST funcionar, é necessário adicionar um domínio de e-mail válido. Para CPF e PIS, você pode usar os geradores marcados como link. Não importa se a entrada tem ou não os caracteres padrão, eles serão removidos. Caso um desses campos já exista, o POST não será feito.

Como rodar os testes

  • na raiz do projeto e com o ambiente virtual ativo, execute
pytest tests/tests.py

Obs: esses testes precisam ser melhor desenvolvidos e é necessário remover alguns hard codes.

Dificuldades encontradas

  • Quando o usuário está logado, um cookie é gerado. Entretanto ele se perde quando a página é atualizada. Não descobri a tempo como armazená-lo.
  • Adicionei uma mensagem para quando um usuário faz login, mas ao meu ver isso deveria acontecer no front. Caso exista um usuário logado mostra o nome, caso não, mostra "visitante".
  • Até o momento não encontrei uma biblioteca de validação de CEP que funcione para todos os países.
  • Os testes estão com id hard coded, por dificuldade em pegar o id do usuário.

Próximos passos

Além de resolver os mencionados em "dificuldades encontradas":

  • Colocar autorização nas rotas. O login existe e funciona, mas só está sendo usado na rota que pega o usuário atual (/users/me) e na rota que pega o token.
  • Adicionar docstrings e gerar documentação através delas.
  • Melhorar testes.