mollom 0.1.6 → 0.2.0

data/.gitignore

@@ -0,0 +1,4 @@
+docs
+test_mollom.rb
+pkg
+.DS_Store

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Jan De Poorter - Openminds BVBA
+ 
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+ 
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+ 
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,33 @@
+require 'rubygems'
+require 'rake/rdoctask'
+require 'rake/testtask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "mollom"
+    gemspec.summary = "Ruby class for easy interfacing with the mollom.com open API for spam detection and content quality assesment."
+    gemspec.description = "Ruby class for easy interfacing with the mollom.com open API for spam detection and content quality assesment."
+    gemspec.email = "mollom@openminds.be"
+    gemspec.homepage = "http://mollom.rubyforge.com"
+    gemspec.authors = ["Jan De Poorter"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+
+Rake::RDocTask.new { |rdoc|
+  rdoc.rdoc_dir = 'docs'
+  rdoc.title    = "Mollom -- Ruby class for easy interfacing with the mollom.com open API for spam detection and content quality assesment."
+  rdoc.options << '--line-numbers' << '--inline-source' << '-A cattr_accessor=object'
+  rdoc.options << '--charset' << 'utf-8'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+}

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/lib/mollom.rb

@@ -1,6 +1,8 @@
 require 'xmlrpc/client'
 require 'openssl'
 require 'base64'
+require 'mollom/content_response'
+require 'mollom/api_compatibility'
 
 # Mollom API requires this to change, but this gives a warning!
 # XMLRPC::Client::USER_AGENT = "Ruby Mollom/0.1"
@@ -51,7 +53,7 @@ class Mollom
   #  response.spam? # => false
   #  response.ham?  # => true
   def check_content content = {}
-    return ContentResponse.new(send_command('mollom.checkContent', content))
+    ContentResponse.new(send_command('mollom.checkContent', content))
   end
 
   # Requests an Image captcha from Mollom. It takes the optional <tt>session_id</tt> and <tt>author_ip</tt> keys, if you allready have a session.
@@ -61,7 +63,7 @@ class Mollom
   #  captcha['url']        # => http://xmlrpc1.mollom.com:80/a9616e6b4cd6a81ecdd509fa624d895d.png
   #  captcha['session_id'] # => a9616e6b4cd6a81ecdd509fa624d895d
   def image_captcha info = {}
-    return send_command('mollom.getImageCaptcha', info)
+    send_command('mollom.getImageCaptcha', info)
   end
 
   # Requests an Audio captcha from Mollom. It takes the optional +session_id+ and +author_ip+ keys, if you allready have a session.
@@ -71,7 +73,7 @@ class Mollom
   #  captcha['url']        # => http://xmlrpc1.mollom.com:80/a9616e6b4cd6a81ecdd509fa624d895d.mp3
   #  captcha['session_id'] # => a9616e6b4cd6a81ecdd509fa624d895d
   def audio_captcha info = {}
-    return send_command('mollom.getAudioCaptcha', info)
+    send_command('mollom.getAudioCaptcha', info)
   end
 
   # Checks with mollom if the given captcha (by the user) is correct. Takes +session_id+ and +solution+ keys. Both keys are required.
@@ -82,14 +84,14 @@ class Mollom
   #  return = mollom.valid_captcha? :session_id => captcha['session_id'], :solution => 'abcDe9'
   #  return # => true
   def valid_captcha? info = {}
-    return send_command('mollom.checkCaptcha', info)
+    send_command('mollom.checkCaptcha', info)
   end
 
   # Standard check to see if your public/private keypair are recognized. Takes no options
   def key_ok?
-    return send_command('mollom.verifyKey')
+    send_command('mollom.verifyKey')
   rescue XMLRPC::FaultException
-    return false
+    false
   end
 
   # Gets some statistics from Mollom about your site.
@@ -105,7 +107,7 @@ class Mollom
   #
   #  mollom.statistics :type => 'total_accepted' # => 123
   def statistics options = {}
-    return send_command('mollom.getStatistics', options)
+    send_command('mollom.getStatistics', options)
   end
 
   # Send feedback to Mollom about a certain content. Required keys are +session_id+ and +feedback+. 
@@ -118,7 +120,14 @@ class Mollom
   #
   #  mollom.send_feedback :session_id => 'a9616e6b4cd6a81ecdd509fa624d895d', :feedback => 'unwanted'
   def send_feedback feedback = {}
-    return send_command('mollom.sendFeedback', feedback)
+    send_command('mollom.sendFeedback', feedback)
+  end
+  
+  # Gets language of input text.
+  #
+  # mollom.language_for 'This is my text'
+  def language_for text
+    send_command('mollom.detectLanguage', :text => text)
   end
 
   # Gets a list of servers from Mollom. You should cache this information in your application in a temporary file or in a database. You can set this with Mollom#server_list=
@@ -160,7 +169,8 @@ class Mollom
   def send_command(command, data = {})
     server_list.each do |server|
       begin
-        return XMLRPC::Client.new(server[:host], "/#{API_VERSION}").call(command, data.merge(authentication_hash))
+        client = XMLRPC::Client.new(server[:host], "/#{API_VERSION}")
+        return client.call(command, data.merge(authentication_hash))
       # TODO: Rescue more stuff (Connection Timeout and such)
       rescue XMLRPC::FaultException => error
         case error.faultCode
@@ -195,52 +205,8 @@ class Mollom
     return :public_key=> @public_key, :time => now, :hash => hash, :nonce => nonce
   end
 
-  class ContentResponse
-    attr_reader :session_id, :quality
-
-    Unknown = 0
-    Ham  = 1
-    Unsure = 2
-    Spam = 3
-
-    # This class should only be initialized from within the +check_content+ command.
-    def initialize(hash)
-      @spam_response = hash["spam"]
-      @session_id = hash["session_id"]
-      @quality = hash["quality"]
-    end
-
-    # Is the content Spam?
-    def spam?
-      @spam_response == Spam
-    end
-
-    # Is the content Ham?
-    def ham?
-      @spam_response == Ham
-    end
-
-    # is Mollom unsure about the content?
-    def unsure?
-      @spam_response == Unsure
-    end
-
-    # is the content unknown?
-    def unknown?
-      @spam_response == Unknown
-    end
-    
-    # Returns 'unknown', 'ham', 'unsure' or 'spam', depending on what the content is.
-    def to_s
-      case @spam_response
-      when Unknown 	then 'unknown'
-      when Ham 		then 'ham'
-      when Unsure 	then 'unsure'
-      when Spam 	then 'spam'
-      end
-    end
-  end
-  
   class Error < StandardError; end
   class NoAvailableServers < Error; end
+  
+  include ApiCompatibility
 end

data/lib/mollom/api_compatibility.rb

@@ -0,0 +1,16 @@
+class Mollom
+  module ApiCompatibility
+    def self.included base
+      base.class_eval do
+        alias checkContent check_content
+        alias getImageCaptcha image_captcha
+        alias getAudioCaptcha audio_captcha
+        alias checkCaptcha valid_captcha?
+        alias verifyKey key_ok?
+        alias getStatistics statistics
+        alias sendFeedback send_feedback
+        alias detectLanguage language_for
+      end
+    end
+  end
+end

data/lib/mollom/content_response.rb

@@ -0,0 +1,47 @@
+class Mollom
+  class ContentResponse
+    attr_reader :session_id, :quality
+
+    Unknown = 0
+    Ham  = 1
+    Unsure = 2
+    Spam = 3
+
+    # This class should only be initialized from within the +check_content+ command.
+    def initialize(hash)
+      @spam_response = hash["spam"]
+      @session_id = hash["session_id"]
+      @quality = hash["quality"]
+    end
+
+    # Is the content Spam?
+    def spam?
+      @spam_response == Spam
+    end
+
+    # Is the content Ham?
+    def ham?
+      @spam_response == Ham
+    end
+
+    # is Mollom unsure about the content?
+    def unsure?
+      @spam_response == Unsure
+    end
+
+    # is the content unknown?
+    def unknown?
+      @spam_response == Unknown
+    end
+
+    # Returns 'unknown', 'ham', 'unsure' or 'spam', depending on what the content is.
+    def to_s
+      case @spam_response
+      when Unknown 	then 'unknown'
+      when Ham 		then 'ham'
+      when Unsure 	then 'unsure'
+      when Spam 	then 'spam'
+      end
+    end
+  end
+end

data/mollom.gemspec

@@ -0,0 +1,52 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{mollom}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jan De Poorter"]
+  s.date = %q{2010-03-10}
+  s.description = %q{Ruby class for easy interfacing with the mollom.com open API for spam detection and content quality assesment.}
+  s.email = %q{mollom@openminds.be}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "MIT-LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/mollom.rb",
+     "lib/mollom/api_compatibility.rb",
+     "lib/mollom/content_response.rb",
+     "mollom.gemspec",
+     "pkg/mollom-0.1.1.gem",
+     "test/content_response_test.rb",
+     "test/mollom_test.rb"
+  ]
+  s.homepage = %q{http://mollom.rubyforge.com}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Ruby class for easy interfacing with the mollom.com open API for spam detection and content quality assesment.}
+  s.test_files = [
+    "test/content_response_test.rb",
+     "test/mollom_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/test/mollom_test.rb

@@ -150,46 +150,95 @@ class TestMollom < Test::Unit::TestCase
   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
+    options = {:author_ip => '172.16.0.1', :post_body => 'Lorem Ipsum'}
+    
+    assert_command 'mollom.checkContent', :with => options, :returns => {"spam" => 1, "quality" => 0.40, "session_id" => 1} do
+      cr = @mollom.check_content(options)
+      assert cr.ham?
+      assert_equal 1, cr.session_id
+      assert_equal 0.40, cr.quality
+    end
   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')
+    options = {:author_ip => '172.16.0.1'}
+    
+    assert_command 'mollom.getImageCaptcha', :with => options, :returns => {'url' => 'http://xmlrpc1.mollom.com:80/a9616e6b4cd6a81ecdd509fa624d895d.png', 'session_id' => 'a9616e6b4cd6a81ecdd509fa624d895d'} do
+      @mollom.image_captcha(:author_ip => '172.16.0.1')
+    end
   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')
+    options = {:author_ip => '172.16.0.1'}
+    
+    assert_command 'mollom.getAudioCaptcha', :with => options, :returns => {'url' => 'http://xmlrpc1.mollom.com:80/a9616e6b4cd6a81ecdd509fa624d895d.mp3', 'session_id' => 'a9616e6b4cd6a81ecdd509fa624d895d'} do
+      @mollom.audio_captcha(options)
+    end
   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')
+    options = {:session_id => 'a9616e6b4cd6a81ecdd509fa624d895d', :solution => 'foo'}
+    
+    assert_command 'mollom.checkCaptcha', :with => options, :returns => true do
+      assert @mollom.valid_captcha?(options)
+    end
   end
 
   def test_key_ok
-    Mollom.any_instance.expects(:send_command).with('mollom.verifyKey').returns(true)
-    assert @mollom.key_ok?
+    assert_command 'mollom.verifyKey', :returns => true do
+      assert @mollom.key_ok?
+    end
   end
   
   def test_invalid_key
-    Mollom.any_instance.expects(:send_command).with('mollom.verifyKey').raises(XMLRPC::FaultException.new(1000, "Internal server error due to malformed request, or the hamster powering the server died..."))
-    assert !@mollom.key_ok?
+    assert_command 'mollom.verifyKey', :raises => internal_server_error do
+      assert !@mollom.key_ok?
+    end
   end
   
   def test_statistics
-    Mollom.any_instance.expects(:send_command).with('mollom.getStatistics', :type => 'total_accepted').returns(123)
-    @mollom.statistics(:type => 'total_accepted')
+    assert_command 'mollom.getStatistics', :with => {:type => 'total_accepted'}, :returns => 12 do
+      @mollom.statistics(:type => 'total_accepted')
+    end
   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
+    assert_command 'mollom.sendFeedback', :with => {:session_id => 1, :feedback => 'profanity'} do
+      @mollom.send_feedback :session_id => 1, :feedback => 'profanity'
+    end
+  end
+  
+  def test_detect_language
+    assert_command 'mollom.detectLanguage', :with => {:text => 'Dit is nederlands'}, :returns => [{"confidence"=>0.332, "language"=>"nl"}] do
+      assert_equal [{"confidence"=>0.332, "language"=>"nl"}], @mollom.language_for('Dit is nederlands')
+    end
+  end
+  
+  def test_api_compatability
+    assert @mollom.respond_to? :checkContent
+    assert @mollom.respond_to? :getImageCaptcha
+    assert @mollom.respond_to? :getAudioCaptcha
+    assert @mollom.respond_to? :checkCaptcha
+    assert @mollom.respond_to? :verifyKey
+    assert @mollom.respond_to? :getStatistics
+    assert @mollom.respond_to? :sendFeedback 
+    assert @mollom.respond_to? :detectLanguage
+  end
+  
+  private
+  def assert_command command, options = {}
+    expectation = Mollom.any_instance.expects(:send_command)
+    expectation.with do |*arguments|
+      arguments.first == command &&
+      (!options[:with] || options[:with] == arguments.last)
+    end
+    expectation.returns(options[:returns]) if options[:returns]
+    expectation.raises(options[:raises]) if options[:raises]
     
+    yield
+  end
+  
+  def internal_server_error
+    XMLRPC::FaultException.new(1000, "Internal server error due to malformed request, or the hamster powering the server died...")
+  end
 end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: mollom
 version: !ruby/object:Gem::Version 
-  version: 0.1.6
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Jan De Poorter
@@ -9,11 +14,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-28 00:00:00 +02:00
+date: 2010-03-10 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
-description: 
+description: Ruby class for easy interfacing with the mollom.com open API for spam detection and content quality assesment.
 email: mollom@openminds.be
 executables: []
 
@@ -22,33 +27,45 @@ extensions: []
 extra_rdoc_files: 
 - README.rdoc
 files: 
-- lib/mollom.rb
+- .gitignore
+- MIT-LICENSE
 - README.rdoc
+- Rakefile
+- VERSION
+- lib/mollom.rb
+- lib/mollom/api_compatibility.rb
+- lib/mollom/content_response.rb
+- mollom.gemspec
+- pkg/mollom-0.1.1.gem
+- test/content_response_test.rb
+- test/mollom_test.rb
 has_rdoc: true
 homepage: http://mollom.rubyforge.com
 licenses: []
 
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
-rubyforge_project: mollom
-rubygems_version: 1.3.5
+rubyforge_project: 
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Ruby class for easy interfacing with the mollom.com open API for spam detection and content quality assesment.