ruby-akismet 0.9.2 → 0.9.3

data/README.rdoc

@@ -1,8 +1,5 @@
 Akismet compatible library for checking spams.
 
-Initial form is derived from Akismetor by Ryan Bates and Levy Carneiro Jr.
-as findable at http://github.com/levycarneiro/akismetor
-
 = Usage
 
 First you need an Akismet (or Typepad Antispam) API key. Then you need
@@ -11,7 +8,7 @@ to setup a few configuration variable:
   Akismet.key  = '123456789'
   Akismet.blog = 'http://example.com'
 
-To use Typepad Antispam, just set the host:
+To use Typepad Antispam, just specify the host:
 
   Akismet.host = 'api.antispam.typepad.com'
 
@@ -22,19 +19,27 @@ and possibly an <code>ActionDispatch::Request</code> object.
 
 http://rubydoc.info/github/ysbaddaden/ruby-akismet/master/frames
 
-= Integrate with Ruby on Rails (3.0+)
+= Integrate with Ruby on Rails
 
-Add this gem to your Gemfile:
+On rails 3, add this gem to your <code>Gemfile</code>:
 
   gem 'ruby-akismet', :require => 'akismet'
 
+On rails 2, first install the gem:
+
+  gem install ruby-akismet
+
+Then add the gem to your app:
+
+  config.gem 'ruby-akismet', :lib => 'akismet'
+
 Create an initializer file like <code>config/initializers/akismet.rb</code>
 with your configuration:
 
   Akismet.key  = '123456789'
   Akismet.blog = 'http://example.com'
 
-Then in your controller call the appropriate methods:
+Then in your controller call the appropriate methods (rails 3 example):
 
   class CommentsController < ApplicationController
     before_filter :set_post
@@ -77,3 +82,8 @@ Then in your controller call the appropriate methods:
       end
   end
 
+= Author
+
+ruby-akismet is a complete rewrite of Akismetor by Ryan Bates and
+Levy Carneiro Jr. that you can find at http://github.com/levycarneiro/akismetor
+

data/lib/akismet.rb

@@ -2,12 +2,18 @@ require 'net/http'
 
 # Akismet compatible library for checking spams.
 class Akismet
-  VERSION     = '0.9.2'.freeze
+  VERSION     = '0.9.3'.freeze
   API_VERSION = '1.1'.freeze
 
   @@host = 'rest.akismet.com'
   @@key  = nil
   @@blog = nil
+  @@extra_headers = [
+    'HTTP_REMOTE_ADDR',
+    'HTTP_CLIENT_IP',
+    'HTTP_X_FORWARDED_FOR',
+    'HTTP_CONNECTION'
+  ]
 
   class << self
     # Configure an alternate API server.
@@ -25,6 +31,16 @@ class Akismet
       @@blog = blog
     end
 
+    # Configure an array of extra HTTP headers to pass to Akismet from
+    # the request.
+    # 
+    # Example:
+    # 
+    #   Akismet.extra_headers = ['HTTP_REMOTE_ADDR', 'HTTP_CLIENT_IP', 'HTTP_X_FORWARDED_FOR']
+    def extra_headers=(headers)
+      @@extra_headers = headers
+    end
+
     # Checks if a key is valid or not.
     def valid_key?(key)
       call('verify-key', :key => key) == "valid"
@@ -86,7 +102,6 @@ class Akismet
   end
 
   private
-    # TODO: Extract more relevant HTTP headers.
     def attributes
       @attributes[:blog] ||= @@blog
       
@@ -94,9 +109,10 @@ class Akismet
         @attributes[:comment_type] ||= 'comment'
         
         unless @request.nil?
-          @attributes[:user_ip]    ||= @request.remote_ip
-          @attributes[:user_agent] ||= @request.headers["User-Agent"]
-          @attributes[:referrer]   ||= @request.headers["Http-Referer"]
+          @attributes[:user_ip]    = @request.remote_ip
+          @attributes[:user_agent] = @request.headers["HTTP_USER_AGENT"]
+          @attributes[:referrer]   = @request.headers["HTTP_REFERER"]
+          @@extra_headers.each { |h| @attributes[h] = @request.headers[h] }
         end
       end
       

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-akismet
 version: !ruby/object:Gem::Version 
-  hash: 63
+  hash: 61
   prerelease: false
   segments: 
   - 0
   - 9
-  - 2
-  version: 0.9.2
+  - 3
+  version: 0.9.3
 platform: ruby
 authors: 
 - Julien Portalier
@@ -15,11 +15,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-22 00:00:00 +02:00
+date: 2010-10-23 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
-description: Ruby library for Akismet and Typepad Antispam with easy integration into a Rails 3 application.
+description: Ruby library for Akismet and Typepad Antispam with simplified integration into a Rails application.
 email: ysbaddaden@gmail.com
 executables: []
 
@@ -64,6 +64,6 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Ruby library for the Akismet service.
+summary: Ruby library for the Akismet anti-spam service.
 test_files: 
 - test/akismet_test.rb