mollom 0.1 → 0.1.1

data/README

@@ -1,25 +1,37 @@
 == Mollom
 
-This is a Ruby class for easy interfacing with the mollom.com open API for spam detection and content quality assesment.
+This is a Ruby class for easy interfacing with the mollom.com open API for spam detection and content quality assessment.
+
+== Installation
+
+You can either install the library as a gem
+  gem install mollom
+
+Or you can get the latest development version from GitHub:
+  git clone git://github.com/DefV/ruby-mollom.git
 
 == Usage
 
-After you have requested a public/private keypair from Mollom (on http://www.mollom.com), you can start using this class.
+After you have requested a public/private key-pair from Mollom (on http://www.mollom.com), you can start using this class.
 
-  require 'lib/mollom'
+  require 'rubygems'
+  require 'mollom'
   
-  m = Mollom.new(:private_key => 'azkaozdkoakdzkodazdz', :public_key => '34342ikdiozeezioez')
+  m = Mollom.new(:private_key => 'your-private-key', :public_key => 'your-public-key')
 
   content = m.check_content(:post_title => 'Mollem is an open API', 
-							:post_body => "Mollem is an open API for spam detection and content quality assessment.",
+							:post_body => "Lorem Ipsum dolor...",
 							:author_name => 'Jan De Poorter',
 							:author_url => 'http://blog.defv.be')
-  if content.unsure? or content.spam?
-    puts "Captcha: " + m.image_captcha(:session_id => content.session_id)["url"]
-    print "Captcha is: "
-    puts m.check_captcha(:session_id => content.session_id, :solution => STDIN.gets.chomp)
+  if content.spam?
+	puts "You, sir, are a spammer.. Goodbye!"
+  elsif content.unsure?
+    # possible spam, possible ham, show CAPTCHA
+    puts "CAPTCHA: " + m.image_captcha(:session_id => content.session_id)["url"]
+    
+    captcha_correct = m.check_captcha(:session_id => content.session_id, :solution => STDIN.gets.chomp)
   else
     puts "The post is perfect! No spam!"
   end
 
-Copyright (c) 2008 Jan De Poorter - Openminds BVBA, released under the MIT license
+Copyright (c) 2008 Jan De Poorter - Openminds BVBA, released under the MIT license

data/lib/mollom.rb

@@ -2,6 +2,9 @@ require 'xmlrpc/client'
 require 'openssl'
 require 'base64'
 
+# Mollom API requires this to change, but this gives a warning!
+# XMLRPC::Client::USER_AGENT = "Ruby Mollom/0.1"
+
 class Mollom
   API_VERSION = '1.0'
   module Errors
@@ -116,26 +119,36 @@ class Mollom
   def send_command(command, data = {})
     server_list.each do |server|
       begin
-        return XMLRPC::Client.new(server, "/#{API_VERSION}").call(command, data.merge(authentication_hash))
+        return XMLRPC::Client.new(server[:ip], "/#{API_VERSION}").call(command, data.merge(authentication_hash))
+      # TODO: Rescue more stuff (Connection Timeout and such)
       rescue XMLRPC::FaultException => error
         case error.faultCode
         when Errors::Standard
           raise Error.new(error.faultString)
         when Errors::Refresh
-          # TO IMPLEMENT
+          # we take this one out of our loop
+          raise
         when Errors::Redirect
           next
         else
-          raise
+          next
         end
       end
     end
+    raise Mollom::NoAvailableServers
+  rescue XMLRPC::FaultException
+    # We know it is Errors::Refresh
+    server_list(true)
+    retry
   end
 
   # Gets a list of servers from Mollom
-  def server_list
-    # Mollom prepends 'http://' to the IP.. Ruby doesn't like that
-    @server_list ||= XMLRPC::Client.new("xmlrpc.mollom.com", "/#{API_VERSION}").call('mollom.getServerList', authentication_hash).collect { |s| s.sub('http://', '') }
+  def server_list refresh = false
+    @server_list = nil if refresh
+    @server_list ||= XMLRPC::Client.new("xmlrpc.mollom.com", "/#{API_VERSION}").call('mollom.getServerList', authentication_hash).collect do |server| 
+      proto, ip = server.split('://')
+      {:proto => proto, :ip => ip}
+    end
   end
 
   # Creates a HMAC-SHA1 Hash with the current timestamp, and your private key.
@@ -143,8 +156,8 @@ class Mollom
     now = Time.now.gmtime.strftime('%Y-%m-%dT%H:%M:%S.000+0000')
 
     hash = Base64.encode64(
-    OpenSSL::HMAC.digest(OpenSSL::Digest::SHA1.new, @private_key, now)
-    )
+      OpenSSL::HMAC.digest(OpenSSL::Digest::SHA1.new, @private_key, now)
+    ).chomp
 
     return :public_key=> @public_key, :time => now, :hash => hash
   end
@@ -196,4 +209,5 @@ class Mollom
   end
   
   class Error < StandardError; end
+  class NoAvailableServers < Error; end
 end

data/test/content_response_test.rb

@@ -0,0 +1,33 @@
+require "test/unit"
+
+require "mollom"
+
+class TestContentResponse < Test::Unit::TestCase
+  def test_spam
+    cr = Mollom::ContentResponse.new('spam' => 3, 'session_id' => '1', 'quality' => '10')
+    assert cr.spam?
+    assert !cr.ham?
+    assert_equal 'spam', cr.to_s
+  end
+  
+  def test_ham
+    cr = Mollom::ContentResponse.new('spam' => 1, 'session_id' => '1', 'quality' => '10')
+    assert cr.ham?
+    assert !cr.spam?
+    assert_equal 'ham', cr.to_s
+  end
+  
+  def test_unknown
+    cr = Mollom::ContentResponse.new('spam' => 0, 'session_id' => '1', 'quality' => '10')
+    assert cr.unknown?
+    assert !cr.unsure?
+    assert_equal 'unknown', cr.to_s
+  end
+  
+  def test_unsure
+    cr = Mollom::ContentResponse.new('spam' => 2, 'session_id' => '1', 'quality' => '10')
+    assert cr.unsure?
+    assert !cr.unknown?
+    assert_equal 'unsure', cr.to_s
+  end
+end

data/test/mollom_test.rb

@@ -0,0 +1,136 @@
+require 'test/unit'
+require 'rubygems'
+require 'mocha'
+
+require 'mollom'
+
+class Mollom
+  # Unprivate all methods
+  public :authentication_hash
+  public :server_list
+  public :send_command
+end
+
+class TestMollom < Test::Unit::TestCase
+  def setup
+    @mollom = Mollom.new(:private_key => 'xxxxxxxxx', :public_key => 'yyyyyyyyy')
+  end
+  
+  def test_initialize
+    assert_equal 'xxxxxxxxx', @mollom.private_key
+    assert_equal 'yyyyyyyyy', @mollom.public_key
+  end
+  
+  def test_authentication_hash
+    time = mock
+    time.expects(:strftime).with('%Y-%m-%dT%H:%M:%S.000+0000').returns('2008-04-01T13:54:26.000+0000')
+    Time.stubs(:now).returns(stub(:gmtime => time))
+    hash = @mollom.authentication_hash
+    assert_equal("24qAgAC1v1U+5NbKyrQSp/XKWAI=", hash[:hash])
+    assert_equal('yyyyyyyyy', hash[:public_key])
+    assert_equal('2008-04-01T13:54:26.000+0000', hash[:time])
+  end
+  
+  def test_server_list
+    xml_rpc = mock
+    xml_rpc.expects(:call).with('mollom.getServerList', is_a(Hash)).returns(['http://172.16.0.1', 'http://172.16.0.2', 'https://172.16.0.2'])
+    XMLRPC::Client.stubs(:new).with('xmlrpc.mollom.com', '/1.0').returns(xml_rpc)
+    
+    assert_equal [{:ip => '172.16.0.1', :proto => 'http'}, {:ip => '172.16.0.2', :proto => 'http'}, {:ip => '172.16.0.2', :proto => 'https'}], @mollom.server_list
+  end
+  
+  def test_server_list_force_reload
+    xml_rpc = mock
+    xml_rpc.expects(:call).times(2).with('mollom.getServerList', is_a(Hash)).returns(['http://172.16.0.1', 'http://172.16.0.2', 'https://172.16.0.2'])
+    XMLRPC::Client.stubs(:new).with('xmlrpc.mollom.com', '/1.0').returns(xml_rpc)
+    
+    @mollom.server_list
+    @mollom.server_list
+    @mollom.server_list(true)
+  end
+  
+  def test_send_command_with_good_server
+    Mollom.any_instance.stubs(:server_list).returns([{:ip => '172.16.0.1', :proto => 'http'}])
+    xml_rpc = mock
+    xml_rpc.expects(:call).with('mollom.testMessage', has_entry(:options => 'foo'))
+    XMLRPC::Client.stubs(:new).with('172.16.0.1', '/1.0').returns(xml_rpc)
+    
+    @mollom.send_command('mollom.testMessage', {:options => 'foo'})
+  end
+  
+  
+  def test_send_command_with_bad_server
+    Mollom.any_instance.stubs(:server_list).returns([{:ip => '172.16.0.1', :proto => 'http'}, {:ip => '172.16.0.2', :proto => 'http'}])
+    xml_rpc = mock
+    xml_rpc.expects(:call).with('mollom.testMessage', has_entry(:options => 'foo')).raises(XMLRPC::FaultException.new(1200, "Redirect"))
+    xml_rpc2 = mock
+    xml_rpc2.expects(:call).with('mollom.testMessage', has_entry(:options => 'foo'))
+    
+    XMLRPC::Client.stubs(:new).with('172.16.0.1', '/1.0').returns(xml_rpc)
+    XMLRPC::Client.stubs(:new).with('172.16.0.2', '/1.0').returns(xml_rpc2)
+    @mollom.send_command('mollom.testMessage', {:options => 'foo'})
+  end
+  
+  def test_send_command_with_reload_exception
+    # TODO: Test this
+    @mollom.send_command('mollom.testMessage', {:options => 'foo'})
+  end
+  
+  def test_send_command_with_bad_command
+    Mollom.any_instance.stubs(:server_list).returns([{:ip => '172.16.0.1', :proto => 'http'}])
+    xml_rpc = mock
+    xml_rpc.expects(:call).with('mollom.testMessage', has_entry(:options => 'foo')).raises(XMLRPC::FaultException.new(1000, "Fault String"))
+    XMLRPC::Client.stubs(:new).with('172.16.0.1', '/1.0').returns(xml_rpc)
+    
+    assert_raise(Mollom::Error) { @mollom.send_command('mollom.testMessage', {:options => 'foo'}) }
+  end
+  
+  def test_send_command_with_bad_server_and_no_more_available
+    Mollom.any_instance.stubs(:server_list).returns([{:ip => '172.16.0.1', :proto => 'http'}])
+    xml_rpc = mock
+    xml_rpc.expects(:call).with('mollom.testMessage', has_entry(:options => 'foo')).raises(XMLRPC::FaultException.new(1200, "Redirect"))
+    
+    XMLRPC::Client.stubs(:new).with('172.16.0.1', '/1.0').returns(xml_rpc)
+    
+    assert_raise(Mollom::NoAvailableServers) { @mollom.send_command('mollom.testMessage', {:options => 'foo'}) }
+  end
+  
+  def test_check_content
+    Mollom.any_instance.expects(:send_command).with('mollom.checkContent', :author_ip => '172.16.0.1', :post_body => 'Lorem Ipsum').returns("spam" => 1, "quality" => 0.40, "session_id" => 1)
+    cr = @mollom.check_content(:author_ip => '172.16.0.1', :post_body => 'Lorem Ipsum')
+    assert cr.ham?
+    assert_equal 1, cr.session_id
+    assert_equal 0.40, cr.quality
+  end
+  
+  def test_image_captcha
+    Mollom.any_instance.expects(:send_command).with('mollom.getImageCaptcha', :author_ip => '172.16.0.1').returns('url' => 'http://xmlrpc1.mollom.com:80/a9616e6b4cd6a81ecdd509fa624d895d.png', 'session_id' => 'a9616e6b4cd6a81ecdd509fa624d895d')
+    @mollom.image_captcha(:author_ip => '172.16.0.1')
+  end
+  
+  def test_audio_captcha
+    Mollom.any_instance.expects(:send_command).with('mollom.getAudioCaptcha', :author_ip => '172.16.0.1').returns('url' => 'http://xmlrpc1.mollom.com:80/a9616e6b4cd6a81ecdd509fa624d895d.mp3', 'session_id' => 'a9616e6b4cd6a81ecdd509fa624d895d')
+    @mollom.audio_captcha(:author_ip => '172.16.0.1')
+  end
+  
+  def test_valid_captcha
+    Mollom.any_instance.expects(:send_command).with('mollom.checkCaptcha', :session_id => 'a9616e6b4cd6a81ecdd509fa624d895d', :solution => 'foo').returns(true)
+    @mollom.valid_captcha?(:session_id => 'a9616e6b4cd6a81ecdd509fa624d895d', :solution => 'foo')
+  end
+
+  def test_key_ok
+    Mollom.any_instance.expects(:send_command).with('mollom.verifyKey').returns(true)
+    @mollom.key_ok?
+  end
+  
+  def test_statistics
+    Mollom.any_instance.expects(:send_command).with('mollom.getStatistics', :type => 'total_accepted').returns(123)
+    @mollom.statistics(:type => 'total_accepted')
+  end
+  
+  def test_send_feedback
+    Mollom.any_instance.expects(:send_command).with('mollom.sendFeedback', :session_id => 1, :feedback => 'profanity')
+    @mollom.send_feedback :session_id => 1, :feedback => 'profanity'
+  end
+    
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mollom
 version: !ruby/object:Gem::Version 
-  version: "0.1"
+  version: 0.1.1
 platform: ruby
 authors: 
 - Jan De Poorter
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-04-01 00:00:00 +02:00
+date: 2008-04-04 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -45,10 +45,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: mollom
 rubygems_version: 1.0.1
 signing_key: 
 specification_version: 2
 summary: Ruby class for easy interfacing with the mollom.com open API for spam detection and content quality assesment.
-test_files: []
-
+test_files: 
+- test/content_response_test.rb
+- test/mollom_test.rb