spammable_hot_spot: encapsulating spammable hot_spots

Rodrigo Souto
1 parent eb86a964
Showing 8 changed files with 42 additions and 80 deletions Show diff stats
app/models/comment.rb
app/models/suggest_article.rb
config/initializers/plugins.rb
lib/noosfero/plugin.rb
lib/noosfero/plugin/spammable.rb
plugins/anti_spam/test/unit/anti_spam_plugin_test.rb
test/unit/comment_test.rb
test/unit/suggest_article_test.rb
@@ -106,6 +106,17 @@ class Comment &lt; ActiveRecord::Base
   include Noosfero::Plugin::HotSpot
+  include Spammable
+
+  def after_spam!
+    SpammerLogger.log(ip_address, self)
+    Delayed::Job.enqueue(CommentHandler.new(self.id, :marked_as_spam))
+  end
+
+  def after_ham!
+    Delayed::Job.enqueue(CommentHandler.new(self.id, :marked_as_ham))
+  end
+
   def verify_and_notify
     check_for_spam
     unless spam?
@@ -113,10 +124,6 @@ class Comment &lt; ActiveRecord::Base
     end
   end
-  def check_for_spam
-    plugins.dispatch(:check_comment_for_spam, self)
-  end
-
   def notify_by_mail
     if source.kind_of?(Article) && article.notify_comments?
       if !notification_emails.empty?
@@ -203,25 +210,6 @@ class Comment &lt; ActiveRecord::Base
     @rejected = true
   end
-  include Spammable
-
-  def after_spam!
-    SpammerLogger.log(ip_address, self)
-    Delayed::Job.enqueue(CommentHandler.new(self.id, :marked_as_spam))
-  end
-
-  def after_ham!
-    Delayed::Job.enqueue(CommentHandler.new(self.id, :marked_as_ham))
-  end
-
-  def marked_as_spam
-    plugins.dispatch(:comment_marked_as_spam, self)
-  end
-
-  def marked_as_ham
-    plugins.dispatch(:comment_marked_as_ham, self)
-  end
-
   def need_moderation?
     article.moderate_comments? && (author.nil? || article.author != author)
   end
@@ -23,10 +23,6 @@ class SuggestArticle &lt; Task
   include Noosfero::Plugin::HotSpot
-  def check_for_spam
-    plugins.dispatch(:check_suggest_article_for_spam, self)
-  end
-
   def sender
     "#{name} (#{email})"
   end
@@ -84,13 +80,4 @@ class SuggestArticle &lt; Task
   def after_ham!
     self.delay.marked_as_ham
   end
-
-  def marked_as_spam
-    plugins.dispatch(:suggest_article_marked_as_spam, self)
-  end
-
-  def marked_as_ham
-    plugins.dispatch(:suggest_article_marked_as_ham, self)
-  end
-
 end
@@ -4,4 +4,5 @@ require &#39;noosfero/plugin/manager&#39;
 require 'noosfero/plugin/active_record'
 require 'noosfero/plugin/mailer_base'
 require 'noosfero/plugin/settings'
+require 'noosfero/plugin/spammable'
 Noosfero::Plugin.init_system if $NOOSFERO_LOAD_PLUGINS
@@ -308,45 +308,16 @@ class Noosfero::Plugin
     scope
   end
-  # This method is called by the CommentHandler background job before sending
-  # the notification email. If the comment is marked as spam (i.e. by calling
-  # <tt>comment.spam!</tt>), then the notification email will *not* be sent.
-  #
-  # example:
-  #
-  #   def check_comment_for_spam(comment)
-  #     if anti_spam_service.is_spam?(comment)
-  #       comment.spam!
-  #     end
-  #   end
-  #
-  def check_comment_for_spam(comment)
+  # -> Allows plugins to check weather object is a spam
+  def check_for_spam(object)
   end
-  # This method is called when the user manually marks a comment as SPAM. A
-  # plugin implementing this method should train its spam detection mechanism
-  # by submitting this comment as a confirmed spam.
-  #
-  # example:
-  #
-  #   def comment_marked_as_spam(comment)
-  #     anti_spam_service.train_with_spam(comment)
-  #   end
-  #
-  def comment_marked_as_spam(comment)
+  # -> Allows plugins to know when an object is marked as a spam
+  def marked_as_spam(object)
   end
-  # This method is called when the user manually marks a comment a NOT SPAM. A
-  # plugin implementing this method should train its spam detection mechanism
-  # by submitting this coimment as a confirmed ham.
-  #
-  # example:
-  #
-  #   def comment_marked_as_ham(comment)
-  #     anti_spam_service.train_with_ham(comment)
-  #   end
-  #
-  def comment_marked_as_ham(comment)
+  # -> Allows plugins to know when an object is marked as a ham
+  def marked_as_ham(object)
   end
   # Adds extra actions for comments
@@ -0,0 +1,13 @@
+Spammable.module_eval do
+  def marked_as_spam
+    plugins.dispatch(:marked_as_spam, self)
+  end
+
+  def marked_as_ham
+    plugins.dispatch(:marked_as_ham, self)
+  end
+
+  def check_for_spam
+    plugins.dispatch(:check_for_spam, self)
+  end
+end
@@ -4,6 +4,8 @@ class AntiSpamPluginTest &lt; ActiveSupport::TestCase
   class SpammableContent
     attr_accessor :spam
+    def self.named_scope(*args); end
+
     include Spammable
     def save!; end
@@ -447,7 +447,7 @@ class CommentTest &lt; ActiveSupport::TestCase
   end
   class EverythingIsSpam < Noosfero::Plugin
-    def check_comment_for_spam(comment)
+    def check_for_spam(comment)
       comment.spam!
     end
   end
@@ -469,11 +469,11 @@ class CommentTest &lt; ActiveSupport::TestCase
       attr_accessor :marked_as_ham
     end
-    def comment_marked_as_spam(c)
+    def marked_as_spam(c)
       self.class.marked_as_spam = c
     end
-    def comment_marked_as_ham(c)
+    def marked_as_ham(c)
       self.class.marked_as_ham = c
     end
   end
@@ -151,8 +151,8 @@ class SuggestArticleTest &lt; ActiveSupport::TestCase
   end
   class EverythingIsSpam < Noosfero::Plugin
-    def check_suggest_article_for_spam(suggest_article)
-      suggest_article.spam!
+    def check_for_spam(object)
+      object.spam!
     end
   end
@@ -161,7 +161,7 @@ class SuggestArticleTest &lt; ActiveSupport::TestCase
     t1 = build(SuggestArticle, :target => @profile, :article_name => 'suggested article', :name => 'johndoe', :email => 'johndoe@example.com')
-    EverythingIsSpam.any_instance.expects(:check_suggest_article_for_spam)
+    EverythingIsSpam.any_instance.expects(:check_for_spam)
     t1.check_for_spam
   end
@@ -172,15 +172,15 @@ class SuggestArticleTest &lt; ActiveSupport::TestCase
       attr_accessor :marked_as_ham
     end
-    def check_suggest_article_for_spam(c)
+    def check_for_spam(c)
       # do nothing
     end
-    def suggest_article_marked_as_spam(c)
+    def marked_as_spam(c)
       self.class.marked_as_spam = c
     end
-    def suggest_article_marked_as_ham(c)
+    def marked_as_ham(c)
       self.class.marked_as_ham = c
     end
   end
	@@ -23,10 +23,6 @@ class SuggestArticle < Task		@@ -23,10 +23,6 @@ class SuggestArticle < Task
23		23
24	include Noosfero::Plugin::HotSpot	24	include Noosfero::Plugin::HotSpot
25		25
26	- def check_for_spam
27	- plugins.dispatch(:check_suggest_article_for_spam, self)
28	- end
29	-
30	def sender	26	def sender
31	"#{name} (#{email})"	27	"#{name} (#{email})"
32	end	28	end
	@@ -84,13 +80,4 @@ class SuggestArticle < Task		@@ -84,13 +80,4 @@ class SuggestArticle < Task
84	def after_ham!	80	def after_ham!
85	self.delay.marked_as_ham	81	self.delay.marked_as_ham
86	end	82	end
87	-
88	- def marked_as_spam
89	- plugins.dispatch(:suggest_article_marked_as_spam, self)
90	- end
91	-
92	- def marked_as_ham
93	- plugins.dispatch(:suggest_article_marked_as_ham, self)
94	- end
95	-
96	end	83	end
	@@ -4,4 +4,5 @@ require 'noosfero/plugin/manager'		@@ -4,4 +4,5 @@ require 'noosfero/plugin/manager'
4	require 'noosfero/plugin/active_record'	4	require 'noosfero/plugin/active_record'
5	require 'noosfero/plugin/mailer_base'	5	require 'noosfero/plugin/mailer_base'
6	require 'noosfero/plugin/settings'	6	require 'noosfero/plugin/settings'
		7	+require 'noosfero/plugin/spammable'
7	Noosfero::Plugin.init_system if $NOOSFERO_LOAD_PLUGINS	8	Noosfero::Plugin.init_system if $NOOSFERO_LOAD_PLUGINS
	@@ -308,45 +308,16 @@ class Noosfero::Plugin		@@ -308,45 +308,16 @@ class Noosfero::Plugin
308	scope	308	scope
309	end	309	end
310		310
311	- # This method is called by the CommentHandler background job before sending
312	- # the notification email. If the comment is marked as spam (i.e. by calling
313	- # <tt>comment.spam!</tt>), then the notification email will not be sent.
314	- #
315	- # example:
316	- #
317	- # def check_comment_for_spam(comment)
318	- # if anti_spam_service.is_spam?(comment)
319	- # comment.spam!
320	- # end
321	- # end
322	- #
323	- def check_comment_for_spam(comment)	311	+ # -> Allows plugins to check weather object is a spam
		312	+ def check_for_spam(object)
324	end	313	end
325		314
326	- # This method is called when the user manually marks a comment as SPAM. A
327	- # plugin implementing this method should train its spam detection mechanism
328	- # by submitting this comment as a confirmed spam.
329	- #
330	- # example:
331	- #
332	- # def comment_marked_as_spam(comment)
333	- # anti_spam_service.train_with_spam(comment)
334	- # end
335	- #
336	- def comment_marked_as_spam(comment)	315	+ # -> Allows plugins to know when an object is marked as a spam
		316	+ def marked_as_spam(object)
337	end	317	end
338		318
339	- # This method is called when the user manually marks a comment a NOT SPAM. A
340	- # plugin implementing this method should train its spam detection mechanism
341	- # by submitting this coimment as a confirmed ham.
342	- #
343	- # example:
344	- #
345	- # def comment_marked_as_ham(comment)
346	- # anti_spam_service.train_with_ham(comment)
347	- # end
348	- #
349	- def comment_marked_as_ham(comment)	319	+ # -> Allows plugins to know when an object is marked as a ham
		320	+ def marked_as_ham(object)
350	end	321	end
351		322
352	# Adds extra actions for comments	323	# Adds extra actions for comments
@@ -0,0 +1,13 @@		@@ -0,0 +1,13 @@
	1	+Spammable.module_eval do
	2	+ def marked_as_spam
	3	+ plugins.dispatch(:marked_as_spam, self)
	4	+ end
	5	+
	6	+ def marked_as_ham
	7	+ plugins.dispatch(:marked_as_ham, self)
	8	+ end
	9	+
	10	+ def check_for_spam
	11	+ plugins.dispatch(:check_for_spam, self)
	12	+ end
	13	+end
	@@ -4,6 +4,8 @@ class AntiSpamPluginTest < ActiveSupport::TestCase		@@ -4,6 +4,8 @@ class AntiSpamPluginTest < ActiveSupport::TestCase
4		4
5	class SpammableContent	5	class SpammableContent
6	attr_accessor :spam	6	attr_accessor :spam
		7	+ def self.named_scope(*args); end
		8	+
7	include Spammable	9	include Spammable
8		10
9	def save!; end	11	def save!; end
	@@ -447,7 +447,7 @@ class CommentTest < ActiveSupport::TestCase		@@ -447,7 +447,7 @@ class CommentTest < ActiveSupport::TestCase
447	end	447	end
448		448
449	class EverythingIsSpam < Noosfero::Plugin	449	class EverythingIsSpam < Noosfero::Plugin
450	- def check_comment_for_spam(comment)	450	+ def check_for_spam(comment)
451	comment.spam!	451	comment.spam!
452	end	452	end
453	end	453	end
	@@ -469,11 +469,11 @@ class CommentTest < ActiveSupport::TestCase		@@ -469,11 +469,11 @@ class CommentTest < ActiveSupport::TestCase
469	attr_accessor :marked_as_ham	469	attr_accessor :marked_as_ham
470	end	470	end
471		471
472	- def comment_marked_as_spam(c)	472	+ def marked_as_spam(c)
473	self.class.marked_as_spam = c	473	self.class.marked_as_spam = c
474	end	474	end
475		475
476	- def comment_marked_as_ham(c)	476	+ def marked_as_ham(c)
477	self.class.marked_as_ham = c	477	self.class.marked_as_ham = c
478	end	478	end
479	end	479	end