Skip to content

Latest commit

 

History

History
66 lines (42 loc) · 5 KB

readme.md

File metadata and controls

66 lines (42 loc) · 5 KB

Honesto SQN

Run in Postman

Uso de parte da stack Serenata de Amor como o Jarbas para auxiliar cidadãos a fiscalizarem seus políticos pelo Telegram.


O projeto está em construção ainda então não espere muita coisa. Assim que novas situações forem incluídas este README será atualizado com 9dades!

Preparando ambiente de desenvolvimento

O básico é o seguinte:

  1. Docker Compose para facilitar as coisas
  2. Token do robô do Telegram (obtenha pelo BotFather)
  3. Ambiente de desenvolvimento do Serenata de Amor

Para o terceiro item faça o seguinte (leia o comentário final antes de executar):

git clone https://github.com/okfn-brasil/serenata-de-amor.git && cd serenata-de-amor/ && cp contrib/.env.sample .env && cp rosie/config.ini.example rosie/requirements.txt rosie/rosie/. && docker-compose up -d

Não sei se existe algum problema com o projeto em si, mas não roda de primeira, pode lançar vários erros. O que fiz para funcionar no meu caso foi desabilitar a construção do serviço research no docker-compose.yml.

Download de correções e novas features para rodar projeto

Como tive que criar e corrigir algumas situações no Apache Camel, dependendo de quando você baixar o repositório talvez a versão dos componentes no projeto principal ainda não tenham sido liberados para download no Maven. Para esse caso, ou você faz download do meu fork e faz o build a partir da branch de trabalho com a versão necessária ou o download do projeto oficial.

Fluxo mínimo viável

Já não faz jus a versão atual. Atualizarei em breve.

Mapa de navegação por opções

Recursos (visão de alto nível) para MVP

  • Controle de transação da conversa (máquina de estado).
  • Caso a opção não esteja disponível informar o usuário e finalizar a transação da conversa.
  • Listagem dos políticos configurados via opção /atual.
  • Excluir determinado político configurado previamente via opção /retirar.
  • Mapeamento dos serviços ofertados pelo Jarbas.
  • Pesquisar histórico do político via opção /pesquisar.
  • Informar usuário para esperar pacientemente até 3x com mensagens distintas já que o Jarbas demora para processar.
  • Caso o Jarbas informe que tenha mais item do retorno da pesquisa, perguntar ao usuário se quer receber mais registros da pesquisa ou não.
  • Usuário escolher qual político deseja receber notificações de gastos suspeitos via opção /configurar.
  • Envio de notificações (push notification) para usuários que configuraram o político que fez gasto suspeito.
  • Atualização da figura fluxo mínimo viável.
  • Realizar teste de estresse para medir consumo de memória e CPU.
  • Monitoramento via Jolokia ou JMX com dashboard.

Ideias a serem desenvolvidas

  • Desenvolver componente para usar Facebook Messenger já que hoje não existe para o Apache Camel.
  • Criar adaptador genérico a fim que o FROM (consumer) e o TO (producer) suporte não só o Telegram mas qualquer componente que receba/responda algo, sendo assim um wrapper deverá ser usado tanto para a mensagem de entrada quando de saída já que hoje o projeto utiliza o esquema de mensagem do componente do Telegram.

Frutos do projeto

Links para referência/estudo