UBS API

API Rest para exposição dados de Unidades Básicas de Saúde (UBS) fornecidas pelo Portal Brasileiro de Dados Abertos. Formatação dos dados:

PROPRIEDADE	TIPO	DESCRIÇÃO
cnes_id	Serial	ID da UBS pela CNES
name	String	Nome fantasia da UBS
address	String	Endereço
number	String	Número do Endereço
neighborhood	String	Bairro
city	String	Cidade
uf	String	Estado
phone	String	Telefone
latitude	Numeric	Coordenada
longitude	Numeric	Coordenada

Sobre a aplicação

API está disponível no seguinte endereço: https://rmoura-ubs-api.herokuapp.com

- Documentação API

Assim que novos testes forem desenvolvidos ou atualizados no path spec/integration, a documentação deve ser atualizada utilizando o comando:

$ bundle exec rake rswag:specs:swaggerize

Para melhores práticas e qualidade no desenvolvimento de código foi utilizado a gem rubocop, forçamdo a aplicação de melhores práticas e convenções de codificação. Para análise:

$ rubocop --require rubocop-rails

Para análise de vulnerabilidades foi utilizado a gem brakeman. O último relatório gerado está disponível no path storage/brakeman.html. Para gerar um novo:

$ brakeman -o storage/brakeman.html

A análise de cobertura de testes é atualizado assim que os testes são executados, o resultado da análise fica em coverage/index.html, podendo ser visualizado em um navegador, como o Google Chrome. Até o momento a cobertura dos testes é de 97.89%.

É possível subir esta aplicação em ambiente de testes/desenvolvimento utilizando o Docker. A utilização do Docker é opcional para desenvolvimento.

O deploy está sobre o serviço do Heroku com Docker. Cada push ao Github é acionado o Github Actions. O workflow desenhado é, executar os testes automatizados desenvolvidos, validar o build e aí então realizar o deploy automaticamente no Heroku.

Para atualizar os dados de UBS no banco de dados, basta executar a seguinte rake task:

$ bundle exec rake establishments:load

ou

$ heroku run rake establishments:load

Esta API foi desenvolvida utilizando Ruby 2.7, Rails 6.0.2.2 e PostgreSQL 11.

Para os testes unitários o RSpec.

Foi implementado também um health check da aplicação.

Observações - Cálculo entre distâncias

Foi adotado a opção de criar uma função SQL em PostgreSQL ao invés de um serviço em Ruby para realizar este cálculo do lado da aplicação. Isso devido a perca de desempenho e performance considerável ao retornar os estabelecimentos, mesmo se utilizando de paginação com Kaminari.

Para demonstrar a diferença em tempo de resposta em ambas as formas, desenvolvi uma rake task com o comparativo, para checar o resultado do benchmark basta executar a seguinte task:

$ docker-compose run app rake haversine:benchmarking

Segue resultado obtido:

	user	system	total	real
Function PGSQL:	0.060906	0.008529	0.069435	(0.072843)
Ruby code:	2.661075	0.043680	2.704755	(2.760907)

Dependências

Para a opção de não utilizar Docker, instalar:

• Ruby 2.7
• Postgres

Para a opção com Docker, instalar:

• Docker
• docker-compose

Configuração com Docker

Primeiramente gerar arquivo master.key:

$ EDITOR=vim rails credentials:edit

Iniciar processo de build e start dos containers para subir os serviços:

$ docker-compose up -d

Geração de tabelas e banco de dados:

$ docker-compose run app rake db:create
$ docker-compose run app rake db:migrate

Execução dos testes automatizados:

$ docker-compose run specs

Checar se aplicação subiu corretamente:

$ curl localhost:3000

O resultado deve ser:

{"healthy":true,"message":"OK"}

Para execução dos testes com Rspec

$ docker-compose run spec