[Issue CodeandoMexico#209] Send email after status change

Send email notification when a service request status has changed.
Added Sidekiq
Ignoring coverage folder
Added Redis dependency on README file

Author: eddie-ruva

.gitignore

@@ -25,3 +25,4 @@
 .ruby-version
 .rspec
 Guardfile
+coverage

Gemfile

@@ -30,12 +30,17 @@ gem 'figaro'
 gem 'active_model_serializers'
 gem 'coveralls', require: false
 
+# Async backgroun job handling
+gem 'sidekiq'
+gem 'sinatra', require: false
+gem 'slim'
+
 group :test do
   gem 'ffaker'
   gem 'database_cleaner'
   gem 'launchy'
   gem 'capybara'
-  gem 'selenium-webdriver'
+  gem 'selenium-webdriver', "~> 2.38.0"
 end
 
 group :development,:test do

Gemfile.lock

@@ -55,7 +55,9 @@ GEM
       activemodel (>= 3.2.0)
       activesupport (>= 3.2.0)
       json (>= 1.7)
-    childprocess (0.3.9)
+    celluloid (0.15.2)
+      timers (~> 1.1.0)
+    childprocess (0.5.1)
       ffi (~> 1.0, >= 1.0.11)
     chunky_png (1.2.8)
     coderay (1.1.0)
@@ -73,6 +75,7 @@ GEM
       sass (~> 3.1)
     compass-rails (1.0.3)
       compass (>= 0.12.2, < 0.14)
+    connection_pool (1.2.0)
     coveralls (0.7.0)
       multi_json (~> 1.3)
       rest-client
@@ -223,6 +226,8 @@ GEM
     rack (1.4.5)
     rack-cache (1.2)
       rack (>= 0.4)
+    rack-protection (1.5.2)
+      rack
     rack-ssl (1.3.3)
       rack
     rack-test (0.6.2)
@@ -255,6 +260,9 @@ GEM
       ffi (>= 0.5.0)
     rdoc (3.12.2)
       json (~> 1.4)
+    redis (3.0.7)
+    redis-namespace (1.4.1)
+      redis (~> 3.0.4)
     rest-client (1.6.7)
       mime-types (>= 1.16)
     rspec-core (2.14.5)
@@ -269,37 +277,51 @@ GEM
       rspec-expectations (~> 2.14.0)
       rspec-mocks (~> 2.14.0)
     ruby-hmac (0.4.0)
-    rubyzip (0.9.9)
+    rubyzip (1.1.0)
     sass (3.2.10)
     sass-rails (3.2.6)
       railties (~> 3.2.0)
       sass (>= 3.1.10)
       tilt (~> 1.3)
     sassy-math (1.5)
       compass (~> 0.11)
-    selenium-webdriver (2.35.1)
+    selenium-webdriver (2.38.0)
       childprocess (>= 0.2.5)
       multi_json (~> 1.0)
-      rubyzip (< 1.0.0)
+      rubyzip (~> 1.0)
       websocket (~> 1.0.4)
     sendgrid (1.2.0)
       json
       json
     shoulda-matchers (2.3.0)
       activesupport (>= 3.0.0)
+    sidekiq (2.17.5)
+      celluloid (>= 0.15.2)
+      connection_pool (>= 1.0.0)
+      json
+      redis (>= 3.0.6)
+      redis-namespace (>= 1.3.1)
     simple_oauth (0.2.0)
     simplecov (0.8.2)
       docile (~> 1.1.0)
       multi_json
       simplecov-html (~> 0.8.0)
     simplecov-html (0.8.0)
+    sinatra (1.4.4)
+      rack (~> 1.4)
+      rack-protection (~> 1.4)
+      tilt (~> 1.3, >= 1.3.4)
+    slim (2.0.2)
+      temple (~> 0.6.6)
+      tilt (>= 1.3.3, < 2.1)
     sprockets (2.2.2)
       hike (~> 1.2)
       multi_json (~> 1.0)
       rack (~> 1.0)
       tilt (~> 1.1, != 1.3.0)
     statistics2 (0.54)
     subexec (0.2.3)
+    temple (0.6.7)
     term-ansicolor (1.2.2)
       tins (~> 0.8)
     thin (1.5.1)
@@ -311,6 +333,7 @@ GEM
       activerecord
       statistics2
     tilt (1.4.1)
+    timers (1.1.0)
     tins (0.13.1)
     treetop (1.4.15)
       polyglot
@@ -381,9 +404,12 @@ DEPENDENCIES
   ransack
   rspec-rails
   sass-rails (~> 3.2.3)
-  selenium-webdriver
+  selenium-webdriver (~> 2.38.0)
   sendgrid
   shoulda-matchers
+  sidekiq
+  sinatra
+  slim
   thin
   thumbs_up
   twitter

Procfile

@@ -1,2 +1 @@
 web: bundle exec unicorn -p $PORT -c ./config/unicorn.rb
-

README.en.md

@@ -18,6 +18,7 @@ based on the [Open 311](http://open311.org) standard.
 - Rails 3.2
 - Bootstrap 3.0
 - Rspec 2.14
+- Redis 2.8.6
 
 ### Questions?
 

README.md

@@ -21,6 +21,7 @@ de la comunicación con la ciudadanía y los reportes de cuestiones en sus servi
 - Rails 3.2
 - Bootstrap 3.0
 - Rspec 2.14
+- Redis 2.8.6
 
 ### ¿Dudas?
 

app/mailers/user_mailer.rb

@@ -0,0 +1,12 @@
+class UserMailer < ActionMailer::Base
+  default from: ENV['MAILER_FROM'] || 'Urbem <no-responder@urbem.org>'
+
+  def notify_service_request_status_change(service_request_id, previous_status_id)
+    @service_request = ServiceRequest.find(service_request_id)
+    @user = @service_request.requester
+    @previous_status = Status.find(previous_status_id)
+    mail(subject: I18n.t('mailer.subject.status_change_notification'), to: @user.email)
+  end
+
+end
+

app/models/service_request.rb

@@ -10,6 +10,7 @@ class ServiceRequest < ActiveRecord::Base
   validate :service_extra_fields
 
   before_validation :assign_default_status, on: :create
+  after_update :send_notification_for_status_update
 
   belongs_to :service
   belongs_to :requester, polymorphic: true
@@ -106,6 +107,11 @@ def service_fields_hash
     end
   end
 
+  def requested_by_user?
+    self.requester_type == 'User'
+  end
+
+
   ransacker :date do |parent|
     Arel::Nodes::InfixOperation.new('||',
                                     Arel::Nodes::InfixOperation.new('||', parent.table[:created_at], ' '), parent.table[:created_at])
@@ -123,4 +129,10 @@ def assign_default_status
     self.status = Status.where(is_default: true).first
   end
 
+  def send_notification_for_status_update
+    if self.requested_by_user? && self.status_id_changed?
+      UserMailer.delay.notify_service_request_status_change(self.id, self.status_id_was)
+    end
+  end
+
 end

app/views/user_mailer/notify_service_request_status_change.html.erb

@@ -0,0 +1,7 @@
+<p>Hola <b><%= @user.name || @user.email %></b>, </p>
+
+<p>Tu reporte con folio <b>#<%= @service_request.id %></b> ha cambiado de estatus <%= @previous_status.name %> a <%= @service_request.status.name %></p>
+
+<p>Puedes ver más sobre este reporte y el mensaje dejado por el administrador ingresando a la siguiente página: <%= link_to nil, service_request_url(@service_request) %></p>
+
+<p>Saludos</p>

config/environments/development.rb

@@ -35,14 +35,10 @@
   # Expands the lines which load the assets
   config.assets.debug = true
 
+  # Action Mailer
   config.action_mailer.default_url_options = { :host => 'localhost:3000' }
-
   config.action_mailer.delivery_method = :letter_opener
+  config.action_mailer.perform_deliveries = true
+  config.action_mailer.raise_delivery_errors = true
 
-  #Fallback for development as it uses open letter
-  SENDGRID = {
-    username: '',
-    password: '',
-    domain: ''
-  }
 end

config/environments/production.rb

@@ -66,6 +66,20 @@
   # with SQLite, MySQL, and PostgreSQL)
   # config.active_record.auto_explain_threshold_in_seconds = 0.5
   #
-  config.action_mailer.default_url_options = { :host => ENV['ACTION_MAILER_DEFAULT_URL'] }
+
+  # Action mailer
+  config.action_mailer.raise_delivery_errors = false
+  config.action_mailer.default_url_options = { :host => ENV['HOST'] }
+  config.action_mailer.smtp_settings = {
+    :user_name      => ENV['SENDGRID_USERNAME'],
+    :password       => ENV['SENDGRID_PASSWORD'],
+    :domain         => 'heroku.com',
+    :address        => 'smtp.sendgrid.net',
+    :port           => '587',
+    :authentication => :plain,
+    :enable_starttls_auto => true
+  }
+
+
 
 end

config/environments/test.rb

@@ -28,6 +28,7 @@
   # The :test delivery method accumulates sent emails in the
   # ActionMailer::Base.deliveries array.
   config.action_mailer.delivery_method = :test
+  config.action_mailer.default_url_options = { :host => 'localhost:3000' }
 
   # Raise exception on mass assignment protection for Active Record models
   config.active_record.mass_assignment_sanitizer = :strict

config/initializers/setup_mail.rb

@@ -0,0 +1,16 @@
+if Rails.env.production?
+  Sidekiq.configure_server do |config|
+    config.redis = { url: ENV["REDISCLOUD_URL"], size: 3 }
+
+    database_url = ENV['DATABASE_URL']
+    if database_url
+      ENV['DATABASE_URL'] = "#{database_url}?pool=20"
+      ActiveRecord::Base.establish_connection
+    end
+  end
+
+  Sidekiq.configure_client do |config|
+    config.redis = {size: 1}
+  end
+end
+

config/initializers/sidekiq.rb

@@ -0,0 +1,4 @@
+es:
+  mailer:
+    subject:
+      status_change_notification: 'Cambio de estatus en reporte'

config/locales/mailers.es.yml

@@ -1,4 +1,5 @@
 require 'api_constraints'
+
 ReporteCiudadano::Application.routes.draw do
 
   devise_for :admins, controllers: { sessions: 'admins/sessions' }

config/routes.rb

@@ -1,27 +1,25 @@
-# config/unicorn.rb
-
-worker_processes 3 #Integer(ENV["WEB_CONCURRENCY"] || 3)
-timeout 30 #Integer(ENV['WEB_TIMEOUT'] || 30)
-#preload_app true
-
-#before_fork do |server, worker|
-
-  #Signal.trap 'TERM' do
-    #puts 'Unicorn master intercepting TERM and sending myself QUIT instead'
-    #Process.kill 'QUIT', Process.pid
-  #end
-
-  #defined?(ActiveRecord::Base) and
-    #ActiveRecord::Base.connection.disconnect!
-#end
-
-#after_fork do |server, worker|
-
-  #Signal.trap 'TERM' do
-    #puts 'Unicorn worker intercepting TERM and doing nothing. Wait for master to sent QUIT'
-  #end
-
-  #defined?(ActiveRecord::Base) and
-    #ActiveRecord::Base.establish_connection
-#end
+worker_processes 3
+timeout 30
+preload_app true
+
+before_fork do |server, worker|
+  Signal.trap 'TERM' do
+    puts 'Unicorn master intercepting TERM and sending myself QUIT instead'
+    Process.kill 'QUIT', Process.pid
+  end
+
+   @sidekiq_pid ||= spawn("bundle exec sidekiq -c 2")
+
+  defined?(ActiveRecord::Base) and
+  ActiveRecord::Base.connection.disconnect!
+end
+
+after_fork do |server, worker|
+  Signal.trap 'TERM' do
+    puts 'Unicorn worker intercepting TERM and doing nothing. Wait for master to sent QUIT'
+  end
+
+  defined?(ActiveRecord::Base) and
+  ActiveRecord::Base.establish_connection
+end
 

config/unicorn.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe UserMailer do
+
+  describe ".notify_service_request_status_change" do
+
+    let!(:service_request) { FactoryGirl.create(:service_request) }
+    let!(:status) { FactoryGirl.create(:status) }
+    let!(:mail) { UserMailer.notify_service_request_status_change(service_request.id, status.id) }
+
+
+    it "sends the email" do
+      reset_email
+      mail.deliver!
+      ActionMailer::Base.deliveries.size.should be 1
+    end
+
+    it "sends an email to the requester" do
+      expect(mail.to).to eq( [service_request.requester.email] )
+    end
+
+    it "has a translated subject" do
+      expect( mail.subject ).to eq(I18n.t('mailer.subject.status_change_notification'))
+    end
+  end
+
+end
+