jackson541 / api-boletim-covid

API Rest em Django para acompanhar o número de casos do Covid-19 na região do Seridó.

API Boletins Covid Seridó

API em Djangorestframework para acompanhar o número de casos do Covid-19 na região do Seridó.

How to Run:

Clone the project

git clone https://github.com/jackson541/API-Boletim-Covid.git

Go to Directory

cd API-Boletim-Covid

Install dependencies

pip3 install -r requirements.txt

Configure database

• Install PostgreSQL
• Go to the settings.py file in the ApiBoletimCovid folder
• Search for DATABASES in settings.py
• Configure your database information (name, password and port) in the option default
• Create a table in your database with the name apicovid

Apply Migrations

python3 manage.py makemigrations
python3 manage.py migrate

Run local server

python3 manage.py runserver

Routes documentation

After running the project, go to the route:

http://localhost:8000/swagger/

Contributors:

Jackson Alves	Jonathan Tavares

api-boletim-covid's Issues

Relacionar cidade do usuário criado com a do criador

Enquanto fazia a tela de usuários, percebi que a API está pedindo, como entrada para criar um usuário, username, password e cidade. Porém, a cidade do usuário criado deve ser a mesma do seu criador.

Desenvolvimento orientado a testes

Esqueci de perguntar antes, mas quer seguir o desenvolvimento utilizando os testes? Nunca trabalhei com testes, mas sei como eles funcionam, pelo menos em JS. Até agora só fiz os testes da api manualmente.

Atualizar README

Atualizar com informações sobre o projeto como:

• Versão da API
• Como rodar
• Status de Integração Contínua
• Contribuidores
• Dependências do Projeto

Criar container docker

Implementar na API o CRUD de Cidade com DjangoRest

Tendo o nome das cidades já definidas, serão inseridas no banco, não podendo ser atualizadas (alteradas)

Criar Testes unitários para Boletim

Criação das demais branchs

No padrão antigo, eu estava utilizando apenas uma branch de desenvolvimento sem seguir a risca o padrão do Gitflow. Acho que agora seguir esse padrão, com a criação das branchs de features e as demais, será o ideal. Tem outra ideia em mente ou prefere seguir por essa, @jonathantvrs ?

Problema na listagem de boletins

A rota de listagem geral deve receber uma query para definir a cidade de retorno dos boletins. Atualmente todos são retornados.

Requisitos Model Caso

TB_CASO

• id: int (chave primária)

• boletim: int (chave estrangeira -> TB_BOLETIM #8 ) (obrigatório)

• tipo: string (choices = confirmado, em tratamento, internado, recuperado, suspeito, obito, descartado, notificado) (obrigatório)

• gênero: string (choices = feminino, masculino, outro) (obrigatório)

• faixa: string (choices = #14) (obrigatório)

Informações e questionamentos

1 - O banco PostgreSQL aceita o uso de campos com tipo array, o que permite o campo "faixa" conter um array no qual a primeira posição é o início da faixa e a segunda é o final.

2 - Sempre que um novo boletim for cadastrado nesse modelo, é preciso que as informações dos casos do boletim anterior, que foram alteradas ou não, sejam recadastradas em novos casos com o boletim recém criado associado. Dessa forma, os casos anteriores permanecem intactos e novos são criados com informações atualizadas.

3 - Seria melhor deixar apenas os campos obrigatórios no "tipo" como está e incluir campos para os opcionais nos boletins ou também adicioná-los entre as escolhas de tipos de um caso?

3 - Pensei em uma outra forma de fazer a associação entre os casos e os boletins com um relacionamento N - N. Nesse modelo, se os dados de um caso forem atualizados, cria-se um novo caso e o associa ao novo boletim, se não, associa o mesmo caso ao novo boletim e ao anterior. Sendo assim, imagino que seja possível diminuir a uso de memória do db, já que uma linha na TB_BOLETINS_CASOS contém menos informações que uma linha na TB_CASO. No entanto, essa é uma forma que será mais trabalhosa para implementar e que talvez não traga uma grande diferença.

Refatoração dos casos e boletins

Boletim model

• id: int (chave primária) (definido pelo sistema)

• cidade: int (chave estrangeira) (obrigatório)

• data: datetime (obrigatório)

• ativo: boolean (definido pelo sistema)

• casosConfirmados: int (obrigatório)

• casosEmTratemento: int (obrigatório)

• casosInternados: int (obrigatório)

• casosRecuperados: int (obrigatório)

• casosSuspeitos: int (obrigatório)

• casosDeObito: int (obrigatório)

• casosDescartados: int (obrigatório)

• casosNotificados: int (obrigatório)

InformacoesCasos

• id: int (chave primária) (definido pelo sistema)

• cidade: int (chave estrangeira) (obrigatório)

• data: datetime (obrigatório)

• ativo: boolean (definido pelo sistema)

CasosConfirmados (e demais tipos de casos)

• id: int (chave primária) (definido pelo sistema)

• informacoesCasos: int(chave estrangeira) (obrigatório)

• ativo: boolean (definido pelo sistema)

• masculino: int (obrigatório)

• feminino: int (obrigatório)

• outro: int (obrigatório)

• faixa_0_19: int (obrigatório)

• faixa_20_39: int (obrigatório)

• faixa_40_59: int (obrigatório)

• faixa_60_69: int (obrigatório)

• faixa_70_79: int (obrigatório)

• faixa_80: int (obrigatório)

Implementar na API o CRUD de Caso com DjangoRest

Adicionar Badge de Deploy Heroku no README

Configurar integração contínua e ver a possibilidade de ser feito junto com a issue #45

Bug: Deploy Heroku

O deploy está funcionando? Aparentemente não. E ainda tem dois environments no repo, fico confuso. Precisamos trocar os nomes também. O ideal é criar um novo

Mudar a configuração de SGBD

Utilizar PostgreSQL

Documentar código no Padrão PEP 08

Adicionar o Swagger na API

https://www.django-rest-framework.org/topics/documenting-your-api/

Alterar código de usuário para Mixins

Estava olhando e acho que da para fazer a mudança e enxugar o código

Criar arquivo choices.py em apicovid

Com o arquivo choices.py, o código dos modelos fica mais limpo e a parte de choices fica mais simples de ser acessada e alterada, se for o caso

Deletar branchs antigas

É uma boa prática deletar branchs que não serão mais utilizadas?

Mudar gerenciador de dependências

Mudar pip freeze para Pipenv

Implementar HATEOAS na API

Analisar Boletins de Covid-19 das cidades de Caicó, Jucurutu, São João do Sabugi e outras

Com a análise:

• Anexar imagens dos boletins nessa issue
• Escrever os requisitos do modelo Boletim em #8
• Escrever os requisitos do modelo Cidade em #9

Lista de cidades

Alterar autenticação com Token

Esse artigo é bem interessante. O token registra tbm a data em que foi criado, então é possível estipular um tempo de validade.

Temos usuário django admin no deploy?

Se não tiver temos que criar pelo heroku, certo?

Separar funções

Se as funções da View.py forem separadas em arquivos de tipo de entidade e importadas de volta na View, irá continuar funcionando? O arquivo está ficando muito grande

Criar Testes unitários para Caso

É possivel excluir os outros environments?

@jackson541

Mudar nome do projeto no Github

Pensei em colocar API-Boletim-Covid ou algo do gênero.

Implementar na API o CRUD de Boletim com DjangoRest

• Cadastrar novo boletim
• Visualizar novo boletim
• Editar novo boletim
• Remover novo boletim

Implementar na API o CRUD de User com DjangoRest

Adicionar mais um card

Alterar card, gráfico e back-end para aceitar a informação "Confirmados fora da cidade". Além disso, colocar uma explicação que esses casos são de pessoas com endereço aqui, mas que se encontram fora da cidade.

• Concluir

Faixas de Idade para cadastro de Casos

• 0-20
• 20-40
• 40-60
• 60-70
• 70-80
• +80

Adicionar atributo ativo em todas as entidades do sistema

Com o atributo ativo implementado, é preciso fazer uma alteração no método delete, para que o o sistema não delete o registro do banco, apenas faça o update de ativo para false. Também é necessário adicionar em todas as listagens que somente os dados com ativo true sejam mostrados no sistema, é só colocar um filtro nos serializers

Exclusão de Usuário

@jackson541 , tava vendo aqui os modelos e se não me falha a memória, o ondelete CASCADE deleta a referência na tabela filha, logo acho que ao deletar um usuário de uma cidade, a cidade também será deletada.

Falha em testes unitários

Rodei os testes localmente e recebi 6 falhas e 11 erros dos 22 testes feitos.

Criar permissão personalizada para CRUD de Cidade

O Django Rest não fornece um tipo de permissão que apenas superusuários tenham acesso

Criar imagem do boletim

Nessa feature, deve ser possível pegar os dados principais e gerar um pdf do boletim com estilo

Escopo do projeto e checklist

Navbar

Navbar contendo os links para navegar pelo site e logo com símbolo da cidade.

• Links
• Logo

Cards da home

Parte inicial contendo cards que informam os estados dos casos. Clicar em um card redireciona para o seu gráfico.
Design interessante

• Confirmados
• Recuperados
• Suspeitos
• Descartados
• Óbitos

Gráficos

Seção contendo os gráficos de cada card.

• Confirmados
• Recuperados
• Suspeitos
• Descartados
• Óbitos

Informações importantes

Seção com informações e links importantes para os usuários, por exemplo, como lavar as máscaras.

• Cards com vídeos do Todos Pela Saúde
  principais videos
• Cards com dicas (vídeos) para sair do estresse.
  Dicas
• Sobre a doença
  site original

Footer

Footer do site dizendo quem criou.

• Footer

Alterar modelos e testes

alterar os modelos atuais para seguir o novo padrão

Adicionar CORS

A aplicação (no heroku) está negando as requisições do Front, mas achei estranho que não está negando as requisições que faço pelo Postman. django cors

Criar Testes unitários para Cidade

Teste de vídeo

• Trocar os iframes por vídeos locais para melhorar a performance do site.

Colocar v1.0 para deploy

• Corrigir erros nos testes unitários
• Refatorar modelos
• Corrigir problema com token no Swagger

Feito isso, vamos subir a primeira versão para a master para deploy. Com isso conseguiremos iniciar o front para testes

Adicionar possibilidade de enviar o token ou logar no Swagger

Importante possibilitar isso, deixa todas as rotas abertas mas exige token para aquelas que precisam

Criar uma nova aplicação no projeto

• Configurar e registrar dependências da aplicação
• Configurar API
• Criar os models

Requisitos Model Boletim

Com base na issue #6

Criar Testes unitários para Usuário

Criar novo environment e desativar os outros

Criar environment no heroku
Desativar antigos

Ou simplesmente pode mudar o nome de algum dos dois que estão ativos e desativar o outro.

Mas é importante deixar só um rodando

Requisitos Model Cidade

TB_CIDADE

• id: int (chave primária)
• nome: string (chave candidata ou única) (obrigatório)
• responsável: int (chave estrangeira -> User) (obrigatório)
• numeroHabitantes: int (obrigatório)

Final do projeto

• Adicionar banco MySQL
• Fazer deploy