ActionItem870: notify article owner about new comments by e-mail

Joenio Costa · Antonio Terceiro
1 parent d3ed5d29
Showing 8 changed files with 136 additions and 7 deletions Show diff stats
app/helpers/article_helper.rb
app/models/comment.rb
app/views/comment/notifier/mail.rhtml
db/migrate/057_add_notify_comments_to_articles.rb
db/schema.rb
test/functional/cms_controller_test.rb
test/unit/article_test.rb
test/unit/comment_notifier_test.rb
@@ -7,8 +7,10 @@ module ArticleHelper
       check_box(:article, :published) +
       content_tag('label', _('Published'), :for => 'article_published') +
       check_box(:article, :accept_comments) +
-      content_tag('label', _('Accept Comments'), :for => 'article_accept_comments')
-    )
+      content_tag('label', _('Accept Comments'), :for => 'article_accept_comments') +
+      check_box(:article, :notify_comments) +
+      content_tag('label', _('Notify Comments'), :for => 'article_notify_comments')
+    ) + observe_field(:article_accept_comments, :function => "$('article_notify_comments').disabled = ! $('article_accept_comments').checked")
   end
   def cms_label_for_new_children
@@ -45,4 +45,26 @@ class Comment &lt; ActiveRecord::Base
     article.comments_updated
   end
+  after_create do |comment|
+    if comment.article.notify_comments?
+      Comment::Notifier.deliver_mail(comment)
+    end
+  end
+
+  class Notifier < ActionMailer::Base
+    def mail(comment)
+      profile = comment.article.profile
+      recipients profile.email
+      from "#{profile.environment.name} <#{profile.environment.contact_email}>"
+      subject _("%s - New comment in '%s'") % [profile.environment.name, comment.article.title]
+      body :name => (comment.author.nil? ? comment.name : comment.author.name),
+        :email => (comment.author.nil? ? comment.email : comment.author.email),
+        :title => comment.title,
+        :body => comment.body,
+        :article_url => comment.article.url,
+        :environment => profile.environment.name,
+        :url => url_for(:host => profile.environment.default_hostname, :controller => 'home')
+    end
+  end
+
 end
@@ -0,0 +1,14 @@
+<%= _('Name: %s') % @name %>
+<%= _('e-Mail: %s') % @email %>
+<%= _('Title') % @title %>
+<%= _('Comment:') %>
+--
+
+<%= @body %>
+
+--
+<%= @article_url %>
+
+--
+<%= _('%s environment system') % @environment %>
+<%= @url %>
@@ -0,0 +1,11 @@
+class AddNotifyCommentsToArticles < ActiveRecord::Migration
+  def self.up
+    add_column :articles, :notify_comments, :boolean, :default => false
+    add_column :article_versions, :notify_comments, :boolean, :default => false
+  end
+
+  def self.down
+    remove_column :articles, :notify_comments
+    remove_column :article_versions, :notify_comments
+  end
+end
@@ -9,7 +9,7 @@
 #
 # It's strongly recommended to check this file into your version control system.
-ActiveRecord::Schema.define(:version => 56) do
+ActiveRecord::Schema.define(:version => 57) do
   create_table "article_versions", :force => true do |t|
     t.integer  "article_id"
@@ -40,6 +40,7 @@ ActiveRecord::Schema.define(:version =&gt; 56) do
     t.boolean  "accept_comments",      :default => true
     t.integer  "reference_article_id"
     t.text     "setting"
+    t.boolean  "notify_comments",      :default => false
   end
   create_table "articles", :force => true do |t|
@@ -71,6 +72,7 @@ ActiveRecord::Schema.define(:version =&gt; 56) do
     t.boolean  "accept_comments",      :default => true
     t.integer  "reference_article_id"
     t.text     "setting"
+    t.boolean  "notify_comments",      :default => false
   end
   create_table "articles_categories", :id => false, :force => true do |t|
@@ -79,8 +81,8 @@ ActiveRecord::Schema.define(:version =&gt; 56) do
     t.boolean "virtual",     :default => false
   end
-  add_index "articles_categories", ["article_id"], :name => "index_articles_categories_on_article_id"
   add_index "articles_categories", ["category_id"], :name => "index_articles_categories_on_category_id"
+  add_index "articles_categories", ["article_id"], :name => "index_articles_categories_on_article_id"
   create_table "blocks", :force => true do |t|
     t.string  "title"
@@ -120,8 +122,8 @@ ActiveRecord::Schema.define(:version =&gt; 56) do
     t.boolean "virtual",     :default => false
   end
-  add_index "categories_profiles", ["profile_id"], :name => "index_categories_profiles_on_profile_id"
   add_index "categories_profiles", ["category_id"], :name => "index_categories_profiles_on_category_id"
+  add_index "categories_profiles", ["profile_id"], :name => "index_categories_profiles_on_profile_id"
   create_table "comments", :force => true do |t|
     t.string   "title"
@@ -188,8 +190,8 @@ ActiveRecord::Schema.define(:version =&gt; 56) do
     t.datetime "updated_at"
   end
-  add_index "product_categorizations", ["product_id"], :name => "index_product_categorizations_on_product_id"
   add_index "product_categorizations", ["category_id"], :name => "index_product_categorizations_on_category_id"
+  add_index "product_categorizations", ["product_id"], :name => "index_product_categorizations_on_product_id"
   create_table "products", :force => true do |t|
     t.integer  "enterprise_id"
@@ -260,8 +262,8 @@ ActiveRecord::Schema.define(:version =&gt; 56) do
     t.datetime "created_at"
   end
-  add_index "taggings", ["tag_id"], :name => "index_taggings_on_tag_id"
   add_index "taggings", ["taggable_id", "taggable_type"], :name => "index_taggings_on_taggable_id_and_taggable_type"
+  add_index "taggings", ["tag_id"], :name => "index_taggings_on_tag_id"
   create_table "tags", :force => true do |t|
     t.string  "name"
@@ -746,4 +746,10 @@ class CmsControllerTest &lt; Test::Unit::TestCase
     assert_tag :tag => 'input', :attributes => {:type => 'submit', :value => 'Yes, I want.' }
   end
+  should 'display notify comments option' do
+    a = profile.articles.create!(:name => 'test')
+    get :edit, :profile => profile.identifier, :id => a.id
+    assert :tag => 'input', :attributes => {:name => 'article[notify_comments]', :value => 1}
+  end
+
 end
@@ -562,4 +562,9 @@ class ArticleTest &lt; Test::Unit::TestCase
     assert !a.belongs_to_blog?
   end
+  should 'has comments notifier false by default' do
+    a = Article.new
+    assert !a.notify_comments?
+  end
+
 end
@@ -0,0 +1,67 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class CommentNotifierTest < Test::Unit::TestCase
+  FIXTURES_PATH = File.dirname(__FILE__) + '/../fixtures'
+  CHARSET = "utf-8"
+
+  def setup
+    ActionMailer::Base.delivery_method = :test
+    ActionMailer::Base.perform_deliveries = true
+    ActionMailer::Base.deliveries = []
+
+    @expected = TMail::Mail.new
+    @expected.set_content_type "text", "plain", { "charset" => CHARSET }
+  end
+
+  should 'deliver mail after make aarticle commment' do
+    p = create_user('user_comment_test').person
+    a = Article.create!(:name => 'Article test', :profile => p, :notify_comments => true)
+    assert_difference ActionMailer::Base.deliveries, :count do
+      a.comments << Comment.new(:author => p, :title => 'test comment', :body => 'you suck!')
+    end
+  end
+
+  should 'deliver mail to owner of article' do
+    p = create_user('user_comment_test').person
+    a = Article.create!(:name => 'Article test', :profile => p, :notify_comments => true)
+    a.comments << Comment.new(:author => p, :title => 'test comment', :body => 'you suck!')
+    sent = ActionMailer::Base.deliveries.first
+    assert_equal [p.email], sent.to
+  end
+
+  should 'display author name in delivered mail' do
+    p = create_user('user_comment_test').person
+    a = Article.create!(:name => 'Article test', :profile => p, :notify_comments => true)
+    a.comments << Comment.new(:author => p, :title => 'test comment', :body => 'you suck!')
+    sent = ActionMailer::Base.deliveries.first
+    assert_match /user_comment_test/, sent.body
+  end
+
+  should 'display unauthenticated author name and email in delivered mail' do
+    p = create_user('user_comment_test').person
+    a = Article.create!(:name => 'Article test', :profile => p, :notify_comments => true)
+    a.comments << Comment.new(:name => 'flatline', :email => 'flatline@invalid.com', :title => 'test comment', :body => 'you suck!')
+    sent = ActionMailer::Base.deliveries.first
+    assert_match /flatline/, sent.body
+    assert_match /flatline@invalid.com/, sent.body
+  end
+
+  should 'not deliver mail if notify comments is false' do
+    p = create_user('user_comment_test').person
+    a = Article.create!(:name => 'Article test', :profile => p, :notify_comments => false)
+    assert_no_difference ActionMailer::Base.deliveries, :count do
+      a.comments << Comment.new(:author => p, :title => 'test comment', :body => 'you suck!')
+    end
+  end
+
+  private
+
+    def read_fixture(action)
+      IO.readlines("#{FIXTURES_PATH}/mail_sender/#{action}")
+    end
+
+    def encode(subject)
+      quoted_printable(subject, CHARSET)
+    end
+
+end
	@@ -45,4 +45,26 @@ class Comment < ActiveRecord::Base		@@ -45,4 +45,26 @@ class Comment < ActiveRecord::Base
45	article.comments_updated	45	article.comments_updated
46	end	46	end
47		47
		48	+ after_create do \|comment\|
		49	+ if comment.article.notify_comments?
		50	+ Comment::Notifier.deliver_mail(comment)
		51	+ end
		52	+ end
		53	+
		54	+ class Notifier < ActionMailer::Base
		55	+ def mail(comment)
		56	+ profile = comment.article.profile
		57	+ recipients profile.email
		58	+ from "#{profile.environment.name} <#{profile.environment.contact_email}>"
		59	+ subject _("%s - New comment in '%s'") % [profile.environment.name, comment.article.title]
		60	+ body :name => (comment.author.nil? ? comment.name : comment.author.name),
		61	+ :email => (comment.author.nil? ? comment.email : comment.author.email),
		62	+ :title => comment.title,
		63	+ :body => comment.body,
		64	+ :article_url => comment.article.url,
		65	+ :environment => profile.environment.name,
		66	+ :url => url_for(:host => profile.environment.default_hostname, :controller => 'home')
		67	+ end
		68	+ end
		69	+
48	end	70	end
@@ -0,0 +1,14 @@		@@ -0,0 +1,14 @@
	1	+<%= _('Name: %s') % @name %>
	2	+<%= _('e-Mail: %s') % @email %>
	3	+<%= _('Title') % @title %>
	4	+<%= _('Comment:') %>
	5	+--
	6	+
	7	+<%= @body %>
	8	+
	9	+--
	10	+<%= @article_url %>
	11	+
	12	+--
	13	+<%= _('%s environment system') % @environment %>
	14	+<%= @url %>
@@ -0,0 +1,11 @@		@@ -0,0 +1,11 @@
	1	+class AddNotifyCommentsToArticles < ActiveRecord::Migration
	2	+ def self.up
	3	+ add_column :articles, :notify_comments, :boolean, :default => false
	4	+ add_column :article_versions, :notify_comments, :boolean, :default => false
	5	+ end
	6	+
	7	+ def self.down
	8	+ remove_column :articles, :notify_comments
	9	+ remove_column :article_versions, :notify_comments
	10	+ end
	11	+end
	@@ -746,4 +746,10 @@ class CmsControllerTest < Test::Unit::TestCase		@@ -746,4 +746,10 @@ class CmsControllerTest < Test::Unit::TestCase
746	assert_tag :tag => 'input', :attributes => {:type => 'submit', :value => 'Yes, I want.' }	746	assert_tag :tag => 'input', :attributes => {:type => 'submit', :value => 'Yes, I want.' }
747	end	747	end
748		748
		749	+ should 'display notify comments option' do
		750	+ a = profile.articles.create!(:name => 'test')
		751	+ get :edit, :profile => profile.identifier, :id => a.id
		752	+ assert :tag => 'input', :attributes => {:name => 'article[notify_comments]', :value => 1}
		753	+ end
		754	+
749	end	755	end
	@@ -562,4 +562,9 @@ class ArticleTest < Test::Unit::TestCase		@@ -562,4 +562,9 @@ class ArticleTest < Test::Unit::TestCase
562	assert !a.belongs_to_blog?	562	assert !a.belongs_to_blog?
563	end	563	end
564		564
		565	+ should 'has comments notifier false by default' do
		566	+ a = Article.new
		567	+ assert !a.notify_comments?
		568	+ end
		569	+
565	end	570	end
@@ -0,0 +1,67 @@		@@ -0,0 +1,67 @@
	1	+require File.dirname(__FILE__) + '/../test_helper'
	2	+
	3	+class CommentNotifierTest < Test::Unit::TestCase
	4	+ FIXTURES_PATH = File.dirname(__FILE__) + '/../fixtures'
	5	+ CHARSET = "utf-8"
	6	+
	7	+ def setup
	8	+ ActionMailer::Base.delivery_method = :test
	9	+ ActionMailer::Base.perform_deliveries = true
	10	+ ActionMailer::Base.deliveries = []
	11	+
	12	+ @expected = TMail::Mail.new
	13	+ @expected.set_content_type "text", "plain", { "charset" => CHARSET }
	14	+ end
	15	+
	16	+ should 'deliver mail after make aarticle commment' do
	17	+ p = create_user('user_comment_test').person
	18	+ a = Article.create!(:name => 'Article test', :profile => p, :notify_comments => true)
	19	+ assert_difference ActionMailer::Base.deliveries, :count do
	20	+ a.comments << Comment.new(:author => p, :title => 'test comment', :body => 'you suck!')
	21	+ end
	22	+ end
	23	+
	24	+ should 'deliver mail to owner of article' do
	25	+ p = create_user('user_comment_test').person
	26	+ a = Article.create!(:name => 'Article test', :profile => p, :notify_comments => true)
	27	+ a.comments << Comment.new(:author => p, :title => 'test comment', :body => 'you suck!')
	28	+ sent = ActionMailer::Base.deliveries.first
	29	+ assert_equal [p.email], sent.to
	30	+ end
	31	+
	32	+ should 'display author name in delivered mail' do
	33	+ p = create_user('user_comment_test').person
	34	+ a = Article.create!(:name => 'Article test', :profile => p, :notify_comments => true)
	35	+ a.comments << Comment.new(:author => p, :title => 'test comment', :body => 'you suck!')
	36	+ sent = ActionMailer::Base.deliveries.first
	37	+ assert_match /user_comment_test/, sent.body
	38	+ end
	39	+
	40	+ should 'display unauthenticated author name and email in delivered mail' do
	41	+ p = create_user('user_comment_test').person
	42	+ a = Article.create!(:name => 'Article test', :profile => p, :notify_comments => true)
	43	+ a.comments << Comment.new(:name => 'flatline', :email => 'flatline@invalid.com', :title => 'test comment', :body => 'you suck!')
	44	+ sent = ActionMailer::Base.deliveries.first
	45	+ assert_match /flatline/, sent.body
	46	+ assert_match /flatline@invalid.com/, sent.body
	47	+ end
	48	+
	49	+ should 'not deliver mail if notify comments is false' do
	50	+ p = create_user('user_comment_test').person
	51	+ a = Article.create!(:name => 'Article test', :profile => p, :notify_comments => false)
	52	+ assert_no_difference ActionMailer::Base.deliveries, :count do
	53	+ a.comments << Comment.new(:author => p, :title => 'test comment', :body => 'you suck!')
	54	+ end
	55	+ end
	56	+
	57	+ private
	58	+
	59	+ def read_fixture(action)
	60	+ IO.readlines("#{FIXTURES_PATH}/mail_sender/#{action}")
	61	+ end
	62	+
	63	+ def encode(subject)
	64	+ quoted_printable(subject, CHARSET)
	65	+ end
	66	+
	67	+end