darkseid / jaiminho

Application to send notifications in a RESTful way, using Sidekiq as background job executor

Jaiminho

Objetivo

Ser uma ferramenta completa para o envio de emails.

Caracteristicas:

1. Ser assincrono
2. Possuir interface REST
3. Fornecer relatorios (abertura, bounce, etc.)
4. Poder cadastrar e manipular os templates

Dependencias:

• Redis
• Mysql
• Runtime JavaScript (node.js, por exemplo)

Como rodar:

• git clone
• bundle install
• bundle exec db:create db:migrate
• bundle exec rails s

Para enviar emails em DEV

Hoje, utilizamos a GEM MailCatcher. Para conseguir visualizar os emails, basta subir o server SMTP que vem com a gem:

E depois, abra o navegador no endereco: (http://localhost:1080), para visualizar.

jaiminho's Issues

Preview do email

Eu, como Criador de Template, gostaria de ver o template renderizado sem precisar enviar um email para ve-lo

Gravar no banco o status do email

Eu, como Admin do jaiminho, quero saber, para cada notificacao recebida, se o email foi enviado, ou nao. E caso não tenha sido, quero saber o motivo e poder enviá-lo novamente.

Visualizar estatísticas do envio de emails

Eu, como admin do Jaiminho, quero poder acessar relatórios de envio, bounce e rejeićão dos emails.

Obs1: Considerar que vamos utilizar o SES da amazon para obter estas estatísticas
Obs2: O SES fornece as estatisticas dos ultimos 15 dias, apenas, portanto, teremos que fazer um Worker que todos dia carrega puxa as informaćões do SES (do dia anterior) e grava no banco local.

Usar valores dinamicos na notificacao

Eu, como criador de templates, preciso poder configurar variaveis dinamicas para colocar no template, as quais serao substituidas por valores enviados no ato do agendamento do email.

Guardar histórico dos emails enviados com o conteúdo final gerado

A princípio deveria ser uma tabela, algo como 'email_report_logs', com um campo que guarde o html gerado no envio do email.

Criar interface REST para agendar o envio de um email

Configurar o Mailer