rakismet 0.4.2 → 1.0.0

data/.gitignore

@@ -2,6 +2,8 @@
 *.tmproj
 tmtags
 *.swp
+*.swo
+*.un~
 coverage
 rdoc
-pkg
+pkg

data/README.md

@@ -2,68 +2,72 @@ Rakismet
 ========
 
 **Akismet** (<http://akismet.com/>) is a collaborative spam filtering service.
-**Rakismet** is easy Akismet integration with your Rails app, including
-support for TypePad's AntiSpam service.
+**Rakismet** is easy Akismet integration with Rails and rack apps. TypePad's
+AntiSpam service and generic Akismet endpoints are supported.
 
+Compatibility
+=============
 
-Setup
-=====
+**Rakismet 1.0.0** works with Rails 3 and other Rack-based frameworks.
+**Rakismet 0.4.2** is compatible with Rails 2.
 
-As a plugin
------------
+Getting Started
+===============
 
-Install with `script/plugin install git://github.com/joshfrench/rakismet`
+Once you've installed the Rakismet gem and added it to your application's Gemfile,
+you'll need an API key from the folks at WordPress. Head on over to
+http://wordpress.com/api-keys/ and sign up for a new username.
 
-Rakismet installation should have created a file called rakismet.rb in
-config/initializers. If not, you can copy the template from:
-vendor/plugins/rakismet/generators/rakismet/templates/config/initializers/rakismet.rb.
+Configure the Rakismet key and the URL of your application by setting the following
+in an initializer or application.rb:
 
-As a gem
---------
+    config.rakismet.key = 'your wordpress key'
+    config.rakismet.url = 'http://yourdomain.com/'
 
-`gem install rakismet`
+If you wish to use another Akismet-compatible API provider such as TypePad's
+antispam service, you'll also need to set `config.rakismet.host` to your service
+provider's endpoint.
 
-In config/environment.rb, require the gem by adding `config.gem 'rakismet'`
-within the config block.
+Checking For Spam
+-----------------
 
-From your app root, run `./script/generate rakismet` to create the Rakismet
-initializer.
+First, introduce Rakismet to your model:
 
-Getting Started
-===============
+    class Comment
+      include Rakismet::Model
+    end
 
-Once you've installed Rakismet via your method of choice, you'll need an API 
-key from the folks at WordPress. Head on over to http://wordpress.com/api-keys/ 
-and sign up for a new username.
+With Rakismet mixed in to your model, you'll get three methods for interacting with
+Akismet:
 
-Edit config/initializers/rakismet.rb and fill in `Rakismet::URL` and
-`Rakismet::KEY` with the URL of your application and the key you received
-from WordPress.
+ * `spam?`
 
-If you wish to use another Akismet-compatible API provider such as TypePad's
-antispam service, you'll also need to change the `Rakismet::HOST` to your
-service provider's endpoint.
+Simply call `@comment.spam?` to get a true/false response. True means it's spam,
+false means it's not.
 
-Rakismet::Model
----------------
+ * `ham!` and
+ * `spam!`
 
-First, introduce Rakismet to your model:
+Akismet works best with your feedback. If you spot a comment that was
+erroneously marked as spam, `@comment.ham!` will resubmit to Akismet, marked
+as a false positive. Likewise if they missed a spammy comment,
+`@comment.spam!` will resubmit marked as spam.
 
-    class Comment
-	  include Rakismet::Model
-	end
+
+Configuring Your Model
+----------------------
 
 Rakismet sends the following information to the spam-hungry robots at Akismet:
 
     author        : name submitted with the comment
     author_url    : URL submitted with the comment
     author_email  : email submitted with the comment
-    comment_type  : 'comment', 'trackback', 'pingback', or whatever you fancy
+    comment_type  : Defaults to comment but you can set it to trackback, pingback, or something more appropriate
     content       : the content submitted
     permalink     : the permanent URL for the entry the comment belongs to
     user_ip       : IP address used to submit this comment
     user_agent    : user agent string
-    referrer      : http referer
+    referrer      : referring URL (note the spelling)
 
 By default, Rakismet just looks for attributes or methods on your class that
 match these names. You don't have to have accessors that match these exactly,
@@ -85,72 +89,92 @@ Or you can pass in a proc, to access associations:
                      :author_email => proc { author.email }
     end
 
-Rakismet::Controller
---------------------
-Perhaps you want to check a comment's spam status at creation time, and you
-have no need to keep track of request-specific information such as the user's
-IP, user agent, or referrer.
+You can even hard-code specific fields:
 
-You can add Rakismet to a controller and the IP, user agent, and referrer will
-be taken from the current request instead of your model instance.
+    class Trackback
+      include Rakismet::Model
+      rakismet_attrs :comment_type => "trackback"
+    end
 
-    class MyController < ActionController::Base
-      include Rakismet::Controller
-	end
+Optional Request Variables
+--------------------------
 
-Since you probably won't be checking for spam in every action, Rakismet takes
-`:only` and `:except` options just like other filters. You can reduce overhead
-by specifying just the appropriate actions:
+Akismet wants certain information about the request environment: remote IP, the
+user agent string, and the HTTP referer when available. Normally, Rakismet
+asks your model for these. Storing this information on your model allows you to
+call the `spam?` method at a later time. For instance, maybe you're storing your
+comments in an administrative queue or processing them with a background job.
 
-    class MyController < ActionController::Base
-      include Rakismet::Controller
-      rakismet_filter :only => :create
-    end
+You don't need to have these three attributes on your model, however. If you
+choose to omit them, Rakismet will instead look at the current request (if one
+exists) and take the values from the request object instead.
 
-Checking For Spam
-=================
+This means that if you are **not storing the request variables**, you must call
+`spam?` from within the controller action that handles comment submissions. That
+way the IP, user agent, and referer will belong to the person submitting the
+comment. If you're not storing the request variables and you call `spam?` at a later
+time, the request information will be missing or invalid and Akismet won't be
+able to do its job properly.
 
-Rakismet provides three methods for interacting with Akismet:
+If you've decided to handle the request variables yourself, you can add this to your
+app initialization to disable the middleware responsible for tracking the request
+information:
 
- * `spam?`
+    config.rakismet.use_middleware = false
 
-Simply call `@comment.spam?` to get a true/false response. True means it's spam, false means it's not. Well, usually; it's possible something went wrong
-and Akismet returned an error message. `@comment.spam?` will return false if
-this happens. You can check `@comment.akismet_response` to be certain;
-anything other than 'true' or 'false' means you got an error. That said, as
-long as you're collecting the data listed above it's probably sufficient to
-check `spam?` alone.
-
-Keep in mind that if you call `spam?` from within a controller action that
-uses the Rakismet filter, the user IP, user agent, and referrer will be taken
-from the current request regardless of what your model attributes are. In
-other words: if you're not verifying comments at the moment they're submitted,
-you probably want to store those attributes rather than rely on the controller
-methods.
-
- * `ham!` and 
- * `spam!`
+Verifying Responses
+-------------------
 
-Akismet works best with your feedback. If you spot a comment that was
-erroneously marked as spam, `@comment.ham!` will resubmit to Akismet, marked
-as a false positive. Likewise if they missed a spammy comment,
-`@comment.spam!` will resubmit marked as spam.
+If you want to see what's happening behind the scenes, after you call one of
+`@comment.spam?`, `@comment.spam!` or `@comment.ham!` you can check
+`@comment.akismet_response`.
+
+This will contain the last response from the Akismet server. In the case of `spam?`
+it should be `true` or `false.` For `spam!` and `ham!` it should be `Feedback received.`
+If Akismet returned an error instead (e.g. if you left out some required information)
+this will contain the error message.
+
+FAQ
+===
+
+Why does Akismet think all of my test data is spam?
+---------------------------------------------------
+
+Akismet needs enough information to decide if your test data is spam or not.
+Try to supply as much as possible, especially the author name and request
+variables.
+
+How can I simulate a spam submission?
+-------------------------------------
+
+Most people have the opposite problem, where Akismet doesn't think anything is
+spam. The only guaranteed way to trigger a positive spam response is to set the
+comment author to "viagra-test-123".
+
+If you've done this and `spam?` is still returning false, you're probably
+missing the user IP or one of the key/url config variables. One way to check is
+to call `@comment.akismet_response`. If you are missing a required field or
+there was another error, this will hold the Akismet error message. If your comment
+was processed normally, this value will simply be `true` or `false`.
+
+Can I use Rakismet with a different ORM or framework?
+-----------------------------------------------------
+
+Sure. Rakismet doesn't care what your persistence layer is. It will work with
+Datamapper, a NoSQL store, or whatever next month's DB flavor is.
+
+Rakismet also has no dependencies on Rails or any of its components, and only uses
+a small Rack middleware object to do some of its magic. Depending on your
+framework, you may have to modify this slightly and/or manually place it in your
+stack.
 
-Updating from Rakismet < 0.4
-----------------------------
-There were some significant changes to the API in version 0.4. This was done
-to make Rakismet easier to use with persistence layers other than
-ActiveRecord.
+You'll also need to set a few config variables by hand. Instead of
+`config.rakismet.key`, `config.rakismet.url`, and `config.rakismet.host`, set
+these values directly with `Rakismet.key`, `Rakismet.url`, and `Rakismet.host`.
 
-If you're updating from an older version, please note:
+---------------------------------------------------------------------------
 
- * Rakismet is no longer automatically injected into ActiveRecord and
-   ActionController. You'll need to manually include Rakismet with
-   `include Rakismet::Model` and `include Rakismet::Controller`.
- * `ActiveRecord::Base#has_rakismet` now becomes
-   `Rakismet::Model#rakismet_attrs`.
- * `ActionController::Base#has_rakismet` now becomes
-   `Rakismet::Controller#rakismet_filter`.
+If you have any implementation or usage questions, don't hesitate to get in
+touch: josh@vitamin-j.com.
 
---------------------------------------------------------------
 Copyright (c) 2008 Josh French, released under the MIT license

data/Rakefile

@@ -17,10 +17,10 @@ rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
 end
 
-require 'spec/rake/spectask'
-Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.spec_files = FileList['spec/**/*_spec.rb']
-end
+#require 'spec/rake/spectask'
+#Spec::Rake::SpecTask.new(:spec) do |spec|
+#  spec.libs << 'lib' << 'spec'
+#  spec.spec_files = FileList['spec/**/*_spec.rb']
+#end
 
-task :default => :spec
+#task :default => :spec

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
-:minor: 4
+:minor: 0
 :build: 
-:patch: 2
-:major: 0
+:patch: 0
+:major: 1

data/lib/rakismet.rb

@@ -1,70 +1,88 @@
 require 'net/http'
 require 'uri'
+require 'cgi'
 require 'yaml'
 
 require 'rakismet/model'
-require 'rakismet/filter'
-require 'rakismet/controller'
+require 'rakismet/middleware'
+
+require 'rakismet/railtie.rb' if defined?(Rails)
 
 module Rakismet
-  def self.version
-    @version ||= begin
-      version = YAML.load_file(File.join(File.dirname(__FILE__), %w(.. VERSION.yml)))
-      [version[:major], version[:minor], version[:patch]].join('.')
+  Request = Struct.new(:user_ip, :user_agent, :referrer)
+  Undefined = Class.new(NameError)
+
+  class << self
+    attr_accessor :key, :url, :host
+
+    def request
+      @request ||= Request.new
+    end
+
+    def set_request_vars(env)
+      request.user_ip, request.user_agent, request.referrer =
+        env['REMOTE_ADDR'], env['HTTP_USER_AGENT'], env['HTTP_REFERER']
     end
-  end
 
-  class Base
-    cattr_accessor :valid_key, :current_request
-    
-    class << self
-      def validate_key
-        validate_constants
-        akismet = URI.parse(verify_url)
-        _, valid = Net::HTTP.start(akismet.host) do |http|
-          data = "key=#{Rakismet::KEY}&blog=#{Rakismet::URL}"
-          http.post(akismet.path, data, Rakismet::HEADERS)
-        end
-        self.valid_key = (valid == 'valid')
+    def clear_request
+      @request = Request.new
+    end
+
+    def version
+      @version ||= begin
+        version = YAML.load_file(File.join(File.dirname(__FILE__), %w(.. VERSION.yml)))
+        [version[:major], version[:minor], version[:patch]].join('.')
       end
-      
-      def valid_key?
-        @@valid_key == true
+    end
+
+    def headers
+      @headers ||= begin
+        user_agent = "Rakismet/#{Rakismet.version}"
+        user_agent = "Rails/#{Rails.version} | " + user_agent if defined?(Rails)
+        { 'User-Agent' => user_agent, 'Content-Type' => 'application/x-www-form-urlencoded' }
       end
-      
-      def akismet_call(function, args={})
-        validate_constants
-        args.merge!(:blog => Rakismet::URL)
-        akismet = URI.parse(call_url(function))
-        _, response = Net::HTTP.start(akismet.host) do |http|
-          data = args.map { |k,v| "#{k}=#{CGI.escape(v.to_s)}" }.join('&')
-          http.post(akismet.path, data, Rakismet::HEADERS)
-        end
-        response
+    end
+
+    def validate_key
+      validate_config
+      akismet = URI.parse(verify_url)
+      _, valid = Net::HTTP.start(akismet.host) do |http|
+        data = "key=#{Rakismet.key}&blog=#{Rakismet.url}"
+        http.post(akismet.path, data, Rakismet.headers)
       end
-      
-      protected
-        
-        def verify_url
-          "http://#{Rakismet::HOST}/1.1/verify-key"
-        end
-
-        def call_url(function)
-          "http://#{Rakismet::KEY}.#{Rakismet::HOST}/1.1/#{function}"
-        end
-
-        def validate_constants
-          raise Undefined, "Rakismet::KEY is not defined"  if Rakismet::KEY.blank?
-          raise Undefined, "Rakismet::URL is not defined"  if Rakismet::URL.blank?
-          raise Undefined, "Rakismet::HOST is not defined" if Rakismet::HOST.blank?
-        end
+      @valid_key = (valid == 'valid')
+    end
+
+    def valid_key?
+      @valid_key == true
+    end
+
+    def akismet_call(function, args={})
+      validate_config
+      args.merge!(:blog => Rakismet.url)
+      akismet = URI.parse(call_url(function))
+      _, response = Net::HTTP.start(akismet.host) do |http|
+        data = args.map { |k,v| "#{k}=#{CGI.escape(v.to_s)}" }.join('&')
+        http.post(akismet.path, data, Rakismet.headers)
+      end
+      response
+    end
+
+    protected
+
+    def verify_url
+      "http://#{Rakismet.host}/1.1/verify-key"
+    end
+
+    def call_url(function)
+      "http://#{Rakismet.key}.#{Rakismet.host}/1.1/#{function}"
+    end
+
+    def validate_config
+      raise Undefined, "Rakismet.key is not defined"  if Rakismet.key.nil? || Rakismet.key.empty?
+      raise Undefined, "Rakismet.url is not defined"  if Rakismet.url.nil? || Rakismet.url.empty?
+      raise Undefined, "Rakismet.host is not defined" if Rakismet.host.nil? || Rakismet.host.empty?
     end
   end
-  
-  Undefined = Class.new(NameError)
-  
-  HEADERS = {
-    'User-Agent' => "Rails/#{Rails::VERSION::STRING} | Rakismet/#{Rakismet.version}",
-    'Content-Type' => 'application/x-www-form-urlencoded'
-  }
+
 end

data/lib/rakismet/middleware.rb

@@ -0,0 +1,16 @@
+module Rakismet
+  class Middleware
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      Rakismet.set_request_vars(env)
+      response = @app.call(env)
+      Rakismet.clear_request
+      response
+    end
+
+  end
+end

data/lib/rakismet/model.rb

@@ -4,7 +4,7 @@ module Rakismet
     def self.included(base)
       base.class_eval do
         attr_accessor :akismet_response
-        class_inheritable_hash :akismet_attrs
+        class << self; attr_accessor :akismet_attrs; end
         extend ClassMethods
         include InstanceMethods
         self.rakismet_attrs
@@ -15,12 +15,12 @@ module Rakismet
       def rakismet_attrs(args={})
         self.akismet_attrs ||= {}
         [:comment_type, :author, :author_url, :author_email, :content].each do |field|
-           # clunky, but throwing around +type+ will break your heart
-           fieldname = field.to_s =~ %r(^comment_) ? field : "comment_#{field}".intern
-           self.akismet_attrs[fieldname] = args.delete(field) || field
+          # clunky, but throwing around +type+ will break your heart
+          fieldname = field.to_s =~ %r(^comment_) ? field : "comment_#{field}".intern
+          self.akismet_attrs[fieldname] = args.delete(field) || field
         end
         [:user_ip, :user_agent, :referrer].each do |field|
-          self.akismet_attrs[field] = args.delete(field)
+          self.akismet_attrs[field] = args.delete(field) || field
         end
         args.each_pair do |f,v|
           self.akismet_attrs[f] = v
@@ -34,45 +34,47 @@ module Rakismet
           @_spam
         else
           data = akismet_data
-
-          unless Rakismet::Base.current_request.nil?
-            { :referrer => :referer, :user_ip => :remote_ip,
-              :user_agent => :user_agent }.each_pair do |k,v|
-                data[k] = Rakismet::Base.current_request.send(v) || ''
-            end
-          end
-
-          self.akismet_response = Rakismet::Base.akismet_call('comment-check', data)
+          self.akismet_response = Rakismet.akismet_call('comment-check', data)
           @_spam = self.akismet_response == 'true'
         end
       end
 
       def spam!
-        Rakismet::Base.akismet_call('submit-spam', akismet_data)
+        Rakismet.akismet_call('submit-spam', akismet_data)
         @_spam = true
       end
 
       def ham!
-        Rakismet::Base.akismet_call('submit-ham', akismet_data)
+        Rakismet.akismet_call('submit-ham', akismet_data)
         @_spam = false
       end
 
       private
 
         def akismet_data
-          self.class.akismet_attrs.keys.inject({}) do |data,attr|
-            data.merge attr =>  if self.class.akismet_attrs[attr].is_a?(Proc)
-                                  instance_eval(&self.class.akismet_attrs[attr])
-                                elsif !self.class.akismet_attrs[attr].nil? && respond_to?(self.class.akismet_attrs[attr])
-                                  send(self.class.akismet_attrs[attr])
-                                elsif !self.class.akismet_attrs[attr].nil?
-                                  self.class.akismet_attrs[attr]
+          akismet = self.class.akismet_attrs.keys.inject({}) do |data,attr|
+            mapped_field = self.class.akismet_attrs[attr]
+            data.merge attr =>  if mapped_field.is_a?(Proc)
+                                  instance_eval(&mapped_field)
+                                elsif !mapped_field.nil? && respond_to?(mapped_field)
+                                  send(mapped_field)
+                                elsif not [:comment_type, :author, :author_email,
+                                        :author_url, :content, :user_ip, :referrer,
+                                        :user_agent].include?(mapped_field)
+                                  # we've excluded any fields that appear to
+                                  # have their default unmapped values
+                                  mapped_field
                                 elsif respond_to?(attr)
                                   send(attr)
+                                elsif Rakismet.request.respond_to?(attr)
+                                  Rakismet.request.send(attr)
                                 end
-          end.delete_if { |k,v| v.blank? }
+          end
+          akismet.delete_if { |k,v| v.nil? || v.empty? }
+          akismet[:comment_type] ||= 'comment'
+          akismet
         end
     end
     
   end
-end
+end

data/lib/rakismet/railtie.rb

@@ -0,0 +1,19 @@
+require 'rails'
+require 'rakismet'
+
+module Rakismet
+  class Railtie < Rails::Railtie
+
+      config.rakismet = ActiveSupport::OrderedOptions.new
+      config.rakismet.host = 'rest.akismet.com'
+      config.rakismet.use_middleware = true
+
+      initializer 'rakismet.setup', :after => :load_config_initializers do |app|
+        Rakismet.key = app.config.rakismet.key
+        Rakismet.url = app.config.rakismet.url
+        Rakismet.host = app.config.rakismet.host
+        app.middleware.use Rakismet::Middleware if app.config.rakismet.use_middleware
+      end
+
+  end
+end

data/spec/.rspec

@@ -0,0 +1 @@
+--color

data/spec/rakismet_middleware_spec.rb

@@ -0,0 +1,27 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Rakismet::Middleware do
+
+  let(:env) { { 'REMOTE_ADDR' => '127.0.0.1', 'HTTP_USER_AGENT' => 'RSpec', 'HTTP_REFERER' => 'http://test.host/referrer' } }
+  let(:app) { double(:app, :call => nil) }
+  let(:request) { double(:request).as_null_object }
+
+  before do
+    @middleware = Rakismet::Middleware.new(app)
+  end
+
+  it "should set set Rakismet.request variables" do
+    Rakismet.stub(:request).and_return(request)
+    request.should_receive(:user_ip=).with('127.0.0.1')
+    request.should_receive(:user_agent=).with('RSpec')
+    request.should_receive(:referrer=).with('http://test.host/referrer')
+    @middleware.call(env)
+  end
+
+  it "should clear Rakismet.request after request is complete" do
+    @middleware.call(env)
+    Rakismet.request.user_ip.should be_nil
+    Rakismet.request.user_agent.should be_nil
+    Rakismet.request.referrer.should be_nil
+  end
+end

data/spec/{models/rakismet_model_spec.rb → rakismet_model_spec.rb}

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+require File.dirname(__FILE__) + '/spec_helper'
 require 'ostruct'
 
 class AkismetModel
@@ -16,23 +16,27 @@ describe AkismetModel do
     @model = AkismetModel.new
     comment_attrs.each_pair { |k,v| @model.stub!(k).and_return(v) }
   end
-  
+
   it "should have default mappings" do
     [:comment_type, :author, :author_email, :author_url, :content].each do |field|
       fieldname = field.to_s =~ %r(^comment_) ? field : "comment_#{field}".intern
       AkismetModel.akismet_attrs[fieldname].should eql(field)
      end
   end
-  
-  it "should have nil placeholders for optional binding variables" do
+
+  it "should have request mappings" do
     [:user_ip, :user_agent, :referrer].each do |field|
-      AkismetModel.akismet_attrs.should have_key(field)
+      AkismetModel.akismet_attrs[field].should eql(field)
      end
   end
 
+  it "should populate comment type" do
+    @model.send(:akismet_data)[:comment_type].should == comment_attrs[:comment_type]
+  end
+
   mapped_params = { :comment_type => :type2, :author => :author2, :content => :content2,
                     :author_email => :author_email2, :author_url => :author_url2 }
-    
+
   describe override = AkismetModel.subclass('Override') { rakismet_attrs(mapped_params.dup) } do
     it "should override default mappings" do
       [:comment_type, :author, :author_url, :author_email, :content].each do |field|
@@ -46,31 +50,32 @@ describe AkismetModel do
                       :referrer => :stored_referrer }
 
   describe extended = AkismetModel.subclass('Extended') { rakismet_attrs(extended_params.dup) } do
-    
+
     before do
       @extended = extended.new
       attrs = comment_attrs(:stored_ip => '127.0.0.1', :stored_agent => 'RSpec', :stored_referrer => 'http://test.host/')
       attrs.each_pair { |k,v| @extended.stub!(k).and_return(v) }
+      Rakismet.stub(:request).and_return(empty_request)
     end
-    
+
     it "should extend optional mappings" do
       [:user_ip, :user_agent, :referrer].each do |field|
         extended.akismet_attrs[field].should eql(extended_params[field])
       end
     end
-    
+
     describe ".spam!" do
       it "should use stored request vars if available" do
-        Rakismet::Base.should_receive(:akismet_call).
+        Rakismet.should_receive(:akismet_call).
           with('submit-spam', akismet_attrs(:user_ip => '127.0.0.1', :user_agent => 'RSpec',
                                             :referrer => 'http://test.host/'))
         @extended.spam!
       end
     end
-    
+
     describe ".ham!" do
       it "should use stored request vars if available" do
-        Rakismet::Base.should_receive(:akismet_call).
+        Rakismet.should_receive(:akismet_call).
           with('submit-ham', akismet_attrs(:user_ip => '127.0.0.1', :user_agent => 'RSpec',
                                             :referrer => 'http://test.host/'))
         @extended.ham!
@@ -123,75 +128,75 @@ describe AkismetModel do
   end
 
   describe ".spam?" do
-    
-    before do
-      Rakismet::Base.current_request = request
-    end
-    
-    it "should eval request variables in context of Base.rakismet_binding" do
-      Rakismet::Base.should_receive(:akismet_call).
-                with('comment-check', akismet_attrs.merge(:user_ip => '127.0.0.1', 
-                                                          :user_agent => 'RSpec', 
+
+    it "should use request variables from Rakismet.request if absent in model" do
+      [:user_ip, :user_agent, :referrer].each do |field|
+        @model.should_not respond_to(:field)
+      end
+      Rakismet.stub!(:request).and_return(request)
+      Rakismet.should_receive(:akismet_call).
+                with('comment-check', akismet_attrs.merge(:user_ip => '127.0.0.1',
+                                                          :user_agent => 'RSpec',
                                                           :referrer => 'http://test.host/referrer'))
       @model.spam?
     end
-    
+
     it "should cache result of #spam?" do
-      Rakismet::Base.should_receive(:akismet_call).once
+      Rakismet.should_receive(:akismet_call).once
       @model.spam?
       @model.spam?
     end
 
     it "should be true if comment is spam" do
-      Rakismet::Base.stub!(:akismet_call).and_return('true')
+      Rakismet.stub!(:akismet_call).and_return('true')
       @model.should be_spam
     end
-    
+
     it "should be false if comment is not spam" do
-      Rakismet::Base.stub!(:akismet_call).and_return('false')
+      Rakismet.stub!(:akismet_call).and_return('false')
       @model.should_not be_spam
     end
-    
-    it "should set last_akismet_response" do
-      Rakismet::Base.stub!(:akismet_call).and_return('response')
+
+    it "should set akismet_response" do
+      Rakismet.stub!(:akismet_call).and_return('response')
       @model.spam?
       @model.akismet_response.should eql('response')
     end
 
     it "should not throw an error if request vars are missing" do
-      Rakismet::Base.current_request = empty_request
+      Rakismet.stub!(:request).and_return(empty_request)
       lambda { @model.spam? }.should_not raise_error(NoMethodError)
     end
   end
-  
+
   describe StoredParams do
       before do
-        Rakismet::Base.current_request = nil
         @model = StoredParams.new
         comment_attrs.each_pair { |k,v| @model.stub!(k).and_return(v) }
       end
 
-    it "should use local values if Rakismet binding is not present" do
-      @model.user_ip = '127.0.0.1'
-      @model.user_agent = 'RSpec'
-      @model.referrer = 'http://test.host/referrer'
+    it "should use local values even if Rakismet.request is populated" do
+      Rakismet.stub!(:request).and_return(request)
+      @model.user_ip = '192.168.0.1'
+      @model.user_agent = 'Rakismet'
+      @model.referrer = 'http://localhost/referrer'
 
-      Rakismet::Base.should_receive(:akismet_call).
-                with('comment-check', akismet_attrs.merge(:user_ip => '127.0.0.1',
-                                                          :user_agent => 'RSpec',
-                                                          :referrer => 'http://test.host/referrer'))
+      Rakismet.should_receive(:akismet_call).
+                with('comment-check', akismet_attrs.merge(:user_ip => '192.168.0.1',
+                                                          :user_agent => 'Rakismet',
+                                                          :referrer => 'http://localhost/referrer'))
       @model.spam?
     end
   end
 
   describe ".spam!" do
     it "should call Base.akismet_call with submit-spam" do
-      Rakismet::Base.should_receive(:akismet_call).with('submit-spam', akismet_attrs)
+      Rakismet.should_receive(:akismet_call).with('submit-spam', akismet_attrs)
       @model.spam!
     end
 
     it "should mutate #spam?" do
-      Rakismet::Base.stub!(:akismet_call)
+      Rakismet.stub!(:akismet_call)
       @model.instance_variable_set(:@_spam, false)
       @model.spam!
       @model.should be_spam
@@ -200,42 +205,42 @@ describe AkismetModel do
 
   describe ".ham!" do
     it "should call Base.akismet_call with submit-ham" do
-      Rakismet::Base.should_receive(:akismet_call).with('submit-ham', akismet_attrs)
+      Rakismet.should_receive(:akismet_call).with('submit-ham', akismet_attrs)
       @model.ham!
     end
 
     it "should mutate #spam?" do
-      Rakismet::Base.stub!(:akismet_call)
+      Rakismet.stub!(:akismet_call)
       @model.instance_variable_set(:@_spam, true)
       @model.ham!
       @model.should_not be_spam
     end
   end
-  
+
   private
-  
+
     def comment_attrs(attrs={})
       { :comment_type => 'test', :author => 'Rails test',
         :author_email => 'test@test.host', :author_url => 'test.host',
-        :content => 'comment content', :blog => Rakismet::URL }.merge(attrs)
+        :content => 'comment content', :blog => Rakismet.url }.merge(attrs)
     end
-    
+
     def akismet_attrs(attrs={})
       { :comment_type => 'test', :comment_author_email => 'test@test.host',
         :comment_author => 'Rails test', :comment_author_url => 'test.host',
         :comment_content => 'comment content' }.merge(attrs)
     end
-    
-    def request
-      OpenStruct.new(:remote_ip => '127.0.0.1',
+
+    let(:request) {
+      OpenStruct.new(:user_ip => '127.0.0.1',
                      :user_agent => 'RSpec',
-                     :referer => 'http://test.host/referrer')
-    end
+                     :referrer => 'http://test.host/referrer')
+    }
 
-    def empty_request
-      OpenStruct.new(:remote_ip => nil,
+    let(:empty_request) {
+      OpenStruct.new(:user_ip => nil,
                      :user_agent => nil,
-                     :referer => nil)
-    end
+                     :referrer => nil)
+    }
 
-end
+end

data/spec/rakismet_spec.rb

@@ -0,0 +1,80 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Rakismet do
+
+  let(:http) { double(:http, :to_ary => [nil, 'akismet response']).as_null_object }
+
+  after do
+    Rakismet.key = 'dummy-key'
+    Rakismet.url = 'test.localhost'
+    Rakismet.host = 'endpoint.localhost'
+  end
+
+  describe ".validate_config" do
+    it "should raise an error if key is not found" do
+      Rakismet.key = ''
+      lambda { Rakismet.send(:validate_config) }.should raise_error(Rakismet::Undefined)
+    end
+
+    it "should raise an error if url is not found" do
+      Rakismet.url = ''
+      lambda { Rakismet.send(:validate_config) }.should raise_error(Rakismet::Undefined)
+    end
+
+    it "should raise an error if host is not found" do
+      Rakismet.host = ''
+      lambda { Rakismet.send(:validate_config) }.should raise_error(Rakismet::Undefined)
+    end
+  end
+  
+  describe ".validate_key" do
+    it "should set @@valid_key = true if key is valid" do
+      Net::HTTP.stub!(:start).and_return([nil, 'valid'])
+      Rakismet.validate_key
+      Rakismet.valid_key?.should be_true
+    end
+
+    it "should set @@valid_key = false if key is invalid" do
+      Net::HTTP.stub!(:start).and_return([nil, 'invalid'])
+      Rakismet.validate_key
+      Rakismet.valid_key?.should be_false
+    end
+
+    it "should build url with host" do
+      host = "api.antispam.typepad.com"
+      Rakismet.host = host
+      Net::HTTP.should_receive(:start).with(host).and_yield(http)
+      Rakismet.validate_key
+    end
+  end
+  
+  describe ".akismet_call" do
+    before do
+      Net::HTTP.stub(:start).and_yield(http)
+    end
+    
+    it "should build url with API key for the correct host" do
+      host = 'api.antispam.typepad.com'
+      Rakismet.host = host
+      Net::HTTP.should_receive(:start).with("#{Rakismet.key}.#{host}")
+      Rakismet.send(:akismet_call, 'bogus-function')
+    end
+    
+    it "should post data to named function" do
+      http.should_receive(:post).with('/1.1/bogus-function', %r(foo=#{CGI.escape 'escape//this'}), Rakismet.headers)
+      Rakismet.send(:akismet_call, 'bogus-function', { :foo => 'escape//this' })
+    end
+    
+    it "should return response.body" do
+      #Net::HTTP.stub!(:start).and_return([nil, 'akismet response'])
+      Rakismet.send(:akismet_call, 'bogus-function').should eql('akismet response')
+    end
+
+    it "should build query string when params are nil" do
+      lambda {
+        Rakismet.send(:akismet_call, 'bogus-function', { :nil_param => nil })
+      }.should_not raise_error(NoMethodError)
+    end
+  end
+  
+end

data/spec/spec_helper.rb

@@ -1,21 +1,10 @@
-ENV["RAILS_ENV"] = "test"
-require File.expand_path(File.dirname(__FILE__) + "/../../../../config/environment")
-require 'spec'
-require 'spec/rails'
-
-Spec::Runner.configure do |config|
+require File.expand_path "../lib/rakismet"
 
+RSpec.configure do |config|
+  config.mock_with :rspec
 end
 
 class Class
-  # Creates a new subclass of self, with a name "under" our own name. Example:
-  #
-  #     x = Foo::Bar.subclass('Zap'){}
-  #     x.name # => Foo::Bar::Zap_1
-  #     x.superclass.name # => Foo::Bar
-  #
-  # Removed from RSpec after 1.1.something; reproduced here because much of the
-  # spec suite was already written with dynamic class creation.
   def subclass(base_name, &body)
     klass = Class.new(self)
     class_name = "#{self.name}_#{base_name}"
@@ -25,4 +14,4 @@ class Class
     klass.instance_eval(&body)
     klass
   end
-end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rakismet
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 23
   prerelease: false
   segments: 
+  - 1
   - 0
-  - 4
-  - 2
-  version: 0.4.2
+  - 0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Josh French
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-22 00:00:00 -04:00
+date: 2010-10-23 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -34,20 +34,15 @@ files:
 - README.md
 - Rakefile
 - VERSION.yml
-- generators/rakismet/rakismet_generator.rb
-- generators/rakismet/templates/config/initializers/rakismet.rb
-- install.rb
 - lib/rakismet.rb
-- lib/rakismet/controller.rb
-- lib/rakismet/filter.rb
+- lib/rakismet/middleware.rb
 - lib/rakismet/model.rb
-- spec/controllers/rakismet_controller_spec.rb
-- spec/models/base_spec.rb
-- spec/models/rakismet_filter_spec.rb
-- spec/models/rakismet_model_spec.rb
-- spec/spec.opts
+- lib/rakismet/railtie.rb
+- spec/.rspec
+- spec/rakismet_middleware_spec.rb
+- spec/rakismet_model_spec.rb
+- spec/rakismet_spec.rb
 - spec/spec_helper.rb
-- uninstall.rb
 has_rdoc: true
 homepage: http://github.com/joshfrench/rakismet
 licenses: []
@@ -83,8 +78,7 @@ signing_key:
 specification_version: 3
 summary: Akismet and TypePad AntiSpam integration for Rails.
 test_files: 
-- spec/controllers/rakismet_controller_spec.rb
-- spec/models/base_spec.rb
-- spec/models/rakismet_filter_spec.rb
-- spec/models/rakismet_model_spec.rb
+- spec/rakismet_middleware_spec.rb
+- spec/rakismet_model_spec.rb
+- spec/rakismet_spec.rb
 - spec/spec_helper.rb

data/generators/rakismet/rakismet_generator.rb

@@ -1,7 +0,0 @@
-class RakismetGenerator < Rails::Generator::Base
-  def manifest
-    record do |m|
-      m.file "config/initializers/rakismet.rb", "config/initializers/rakismet.rb"
-    end
-  end
-end

data/generators/rakismet/templates/config/initializers/rakismet.rb

@@ -1,3 +0,0 @@
-Rakismet::KEY  = ''
-Rakismet::URL  = ''
-Rakismet::HOST = 'rest.akismet.com'

data/install.rb

@@ -1,7 +0,0 @@
-File.open(File.join(RAILS_ROOT, %w(config initializers rakismet.rb)) , 'w') do |f|
-  f.puts "Rakismet::KEY  = ''"
-  f.puts "Rakismet::URL  = ''"
-  f.puts "Rakismet::HOST = 'rest.akismet.com'"
-end
-
-puts "If you're updating from Rakismet < 0.4, please see the README for important changes to the API."

data/lib/rakismet/controller.rb

@@ -1,20 +0,0 @@
-module Rakismet
-  module Controller
-    
-    def self.included(base)
-      base.class_eval do
-        extend ClassMethods
-        around_filter Rakismet::Filter
-      end
-    end
-
-    module ClassMethods
-      def rakismet_filter(opts={})
-        skip_filter Rakismet::Filter # in case we're inheriting/overriding an existing Rakismet filter
-        opts.assert_valid_keys(:only, :except)
-        self.around_filter Rakismet::Filter, opts
-      end
-    end
-    
-  end
-end

data/lib/rakismet/filter.rb

@@ -1,10 +0,0 @@
-class Rakismet::Filter
-  def self.filter(controller)
-    begin
-      Rakismet::Base.current_request = controller.request
-      yield
-    ensure
-      Rakismet::Base.current_request = nil
-    end
-  end
-end

data/spec/controllers/rakismet_controller_spec.rb

@@ -1,43 +0,0 @@
-require File.dirname(__FILE__) + '/../spec_helper'
-
-ActionController::Routing::Routes.draw do |map|
-  map.connect ':controller/:action/:id'
-end
-
-class StubController < ActionController::Base
-  include Rakismet::Controller
-  def one ; render :nothing => true; end
-  def two ; render :nothing => true; end
-end
-
-describe StubController do
-  it "should add around_filter" do
-    StubController.filter_chain.map(&:method).should include(Rakismet::Filter)
-  end
-end
-
-describe StubController.subclass('OnlyActions') { rakismet_filter(:only => :one) } do
-
-  it "should add around filter to specified actions" do
-    Rakismet::Base.should_receive(:current_request=).twice
-    get :one
-  end
-
-  it "should not add around filter to unspecified actions" do
-    Rakismet::Base.should_not_receive(:current_request=)
-    get :two
-  end
-end
-
-describe StubController.subclass('ExceptActions') { rakismet_filter(:except => :one) } do
-
-  it "should not add around filter to specified actions" do
-    Rakismet::Base.should_not_receive(:current_request=)
-    get :one
-  end
-  
-  it "should add around filter to other actions" do
-    Rakismet::Base.should_receive(:current_request=).twice
-    get :two
-  end
-end

data/spec/models/base_spec.rb

@@ -1,77 +0,0 @@
-require File.dirname(__FILE__) + '/../spec_helper'
-
-describe Rakismet::Base do
-
-  before :all do
-    load File.join(RAILS_ROOT, 'config', 'initializers', 'rakismet.rb')
-  end
-
-  describe ".validate_constants" do
-    it "should raise an error if key is not found" do
-      Rakismet::KEY = ""
-      lambda { Rakismet::Base.send(:validate_constants) }.should raise_error(Rakismet::Undefined)
-    end
-
-    it "should raise an error if url is not found" do
-      Rakismet::URL = ""
-      lambda { Rakismet::Base.send(:validate_constants) }.should raise_error(Rakismet::Undefined)
-    end
-
-    it "should raise an error if host is not found" do
-      Rakismet::HOST = ""
-      lambda { Rakismet::Base.send(:validate_constants) }.should raise_error(Rakismet::Undefined)
-    end
-  end
-  
-  describe ".validate_key" do
-    it "should set @@valid_key = true if key is valid" do
-      Net::HTTP.stub!(:start).and_return([nil, 'valid'])
-      Rakismet::Base.validate_key
-      Rakismet::Base.valid_key?.should be_true
-    end
-
-    it "should set @@valid_key = false if key is invalid" do
-      Net::HTTP.stub!(:start).and_return([nil, 'invalid'])
-      Rakismet::Base.validate_key
-      Rakismet::Base.valid_key?.should be_false
-    end
-
-    it "should build url with host" do
-      host = "api.antispam.typepad.com"
-      Rakismet::HOST = host
-      Net::HTTP.should_receive(:start).with(host).and_yield(mock(:http).as_null_object)
-      Rakismet::Base.validate_key
-    end
-  end
-  
-  describe ".akismet_call" do
-    before do
-      @http = mock(:http)
-      Net::HTTP.stub!(:start).and_yield(@http)
-    end
-    
-    it "should build url with API key for the correct host" do
-      host = "api.antispam.typepad.com"
-      Rakismet::HOST = host
-      Net::HTTP.should_receive(:start).with("#{Rakismet::KEY}.#{host}").and_yield(mock(:http).as_null_object)
-      Rakismet::Base.send(:akismet_call, 'bogus-function')
-    end
-    
-    it "should post data to named function" do
-      @http.should_receive(:post).with('/1.1/bogus-function', %r(foo=#{CGI.escape 'escape//this'}), Rakismet::HEADERS)
-      Rakismet::Base.send(:akismet_call, 'bogus-function', { :foo => 'escape//this' })
-    end
-    
-    it "should return response.body" do
-      Net::HTTP.stub!(:start).and_return([nil, 'akismet response'])
-      Rakismet::Base.send(:akismet_call, 'bogus-function').should eql('akismet response')
-    end
-
-    it "should build query string when params are nil" do
-      lambda {
-        Rakismet::Base.send(:akismet_call, 'bogus-function', { :nil_param => nil })
-      }.should_not raise_error(NoMethodError)
-    end
-  end
-  
-end

data/spec/models/rakismet_filter_spec.rb

@@ -1,24 +0,0 @@
-require File.dirname(__FILE__) + '/../spec_helper'
-
-Rakismet::TestingError = Class.new(StandardError)
-
-describe Rakismet::Base do
-  before do
-    @request = mock('request')
-    @controller = mock('controller', :request => @request)
-  end
-
-  it "should set Rakismet::Base.current_request" do
-    Rakismet::Base.should_receive(:current_request=).with(@request).ordered
-    Rakismet::Base.should_receive(:current_request=).with(nil).ordered
-    Rakismet::Filter.filter(@controller, &lambda{})
-  end
-
-  it "should not retain the request object in case of error" do
-    begin
-      Rakismet::Filter.filter(@controller, &lambda{ raise Rakismet::TestingError })
-    rescue Rakismet::TestingError
-      Rakismet::Base.current_request.should be_nil
-    end
-  end
-end

data/spec/spec.opts

@@ -1,6 +0,0 @@
---colour
---format
-progress
---loadby
-mtime
---reverse

data/uninstall.rb

@@ -1 +0,0 @@
-File.delete(File.join(RAILS_ROOT, %w(config initializers rakismet.rb)))