rakismet 1.1.2 → 1.2.0

data/CHANGELOG

@@ -1,3 +1,5 @@
+= 1.2.0
+* Rakismet attribute mappings are now inheritable
 = 1.1.2
 * Explicitly load version
 = 1.1.1

data/lib/rakismet.rb

@@ -55,8 +55,11 @@ module Rakismet
       args.merge!(:blog => Rakismet.url)
       akismet = URI.parse(call_url(function))
       _, response = Net::HTTP::Proxy(proxy_host, proxy_port).start(akismet.host) do |http|
-        data = args.map { |k,v| "#{k}=#{CGI.escape(v.to_str)}" }.join('&')
-        http.post(akismet.path, data, Rakismet.headers)
+        params = args.map do |k,v|
+          param = v.class < String ? v.to_str : v.to_s # for ActiveSupport::SafeBuffer and Nil, respectively
+          "#{k}=#{CGI.escape(param)}"
+        end
+        http.post(akismet.path, params.join('&'), Rakismet.headers)
       end
       response
     end

data/lib/rakismet/model.rb

@@ -26,6 +26,11 @@ module Rakismet
           self.akismet_attrs[f] = v
         end
       end
+
+      def inherited(subclass)
+        super
+        subclass.rakismet_attrs akismet_attrs.dup
+      end
     end
     
     module InstanceMethods

data/lib/rakismet/version.rb

@@ -1,3 +1,3 @@
 module Rakismet
-  VERSION = "1.1.2"
+  VERSION = "1.2.0"
 end

data/rakismet.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/joshfrench/rakismet"
   s.summary = "Akismet and TypePad AntiSpam integration for Rails."
   s.description = "Rakismet is the easiest way to integrate Akismet or TypePad's AntiSpam into your Rails app."
-  s.date = "2011-08-11"
+  s.date = "2012-04-19"
 
   s.rubyforge_project = "rakismet"
 

data/spec/models/block_params_spec.rb

@@ -0,0 +1,26 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+PROC = proc { author.reverse }
+
+class BlockAkismetModel
+  include Rakismet::Model
+  rakismet_attrs :author => PROC
+end
+
+describe BlockAkismetModel do
+
+  before do
+    @block = BlockAkismetModel.new
+    comment_attrs.each_pair { |k,v| @block.stub!(k).and_return(v) }
+  end
+
+  it "should accept a block" do
+    puts BlockAkismetModel.akismet_attrs.inspect
+    BlockAkismetModel.akismet_attrs[:comment_author].should eql(PROC)
+  end
+
+  it "should eval block with self = instance" do
+    data = @block.send(:akismet_data)
+    data[:comment_author].should eql(comment_attrs[:author].reverse)
+  end
+end

data/spec/models/custom_params_spec.rb

@@ -0,0 +1,19 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+MAPPED_PARAMS = { :comment_type => :type2, :author => :author2, :content => :content2,
+                  :author_email => :author_email2, :author_url => :author_url2 }
+
+class CustomAkismetModel
+  include Rakismet::Model
+  rakismet_attrs MAPPED_PARAMS.dup
+end
+
+
+describe CustomAkismetModel do
+  it "should override default mappings" do
+    [:comment_type, :author, :author_url, :author_email, :content].each do |field|
+      fieldname = field.to_s =~ %r(^comment_) ? field : "comment_#{field}".intern
+       CustomAkismetModel.akismet_attrs[fieldname].should eql(MAPPED_PARAMS[field])
+     end
+  end
+end

data/spec/models/extended_params_spec.rb

@@ -0,0 +1,16 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+EXTRA = { :extra => :extra, :another => lambda { } }
+
+class ExtendedAkismetModel
+  include Rakismet::Model
+  rakismet_attrs EXTRA.dup
+end
+
+describe ExtendedAkismetModel do
+  it "should include additional attributes" do
+    [:extra, :another].each do |field|
+      ExtendedAkismetModel.akismet_attrs[field].should eql(EXTRA[field])
+    end
+  end
+end

data/spec/models/rakismet_model_spec.rb

@@ -0,0 +1,98 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe AkismetModel do
+
+  before 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 request mappings" do
+    [:user_ip, :user_agent, :referrer].each do |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
+
+  describe ".spam?" do
+
+    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.should_receive(:akismet_call).once
+      @model.spam?
+      @model.spam?
+    end
+
+    it "should be true if comment is spam" do
+      Rakismet.stub!(:akismet_call).and_return('true')
+      @model.should be_spam
+    end
+
+    it "should be false if comment is not spam" do
+      Rakismet.stub!(:akismet_call).and_return('false')
+      @model.should_not be_spam
+    end
+
+    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.stub!(:request).and_return(empty_request)
+      lambda { @model.spam? }.should_not raise_error(NoMethodError)
+    end
+  end
+
+
+  describe ".spam!" do
+    it "should call Base.akismet_call with submit-spam" do
+      Rakismet.should_receive(:akismet_call).with('submit-spam', akismet_attrs)
+      @model.spam!
+    end
+
+    it "should mutate #spam?" do
+      Rakismet.stub!(:akismet_call)
+      @model.instance_variable_set(:@_spam, false)
+      @model.spam!
+      @model.should be_spam
+    end
+  end
+
+  describe ".ham!" do
+    it "should call Base.akismet_call with submit-ham" do
+      Rakismet.should_receive(:akismet_call).with('submit-ham', akismet_attrs)
+      @model.ham!
+    end
+
+    it "should mutate #spam?" do
+      Rakismet.stub!(:akismet_call)
+      @model.instance_variable_set(:@_spam, true)
+      @model.ham!
+      @model.should_not be_spam
+    end
+  end
+
+end

data/spec/models/request_params_spec.rb

@@ -0,0 +1,23 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+class RequestParams
+  include Rakismet::Model
+  attr_accessor :user_ip, :user_agent, :referrer
+end
+
+describe RequestParams do
+    before do
+      @model = RequestParams.new
+      attrs = comment_attrs(:user_ip => '192.168.0.1', :user_agent => 'Rakismet', :referrer => 'http://localhost/referrer')
+      attrs.each_pair { |k,v| @model.stub!(k).and_return(v) }
+    end
+
+  it "should use local values even if Rakismet.request is populated" do
+    Rakismet.stub(:request).and_return(request)
+    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

data/spec/models/subclass_spec.rb

@@ -0,0 +1,14 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+class Subclass < AkismetModel
+end
+
+describe Subclass do
+  it "should inherit parent's rakismet attrs" do
+    Subclass.akismet_attrs.should eql AkismetModel.akismet_attrs # key/value equality
+  end
+
+  it "should get a new copy of parent's rakismet attrs" do
+    Subclass.akismet_attrs.should_not equal AkismetModel.akismet_attrs # object equality
+  end
+end

data/spec/spec_helper.rb

@@ -1,17 +1,34 @@
 require File.expand_path "lib/rakismet"
+require 'ostruct'
 
 RSpec.configure do |config|
   config.mock_with :rspec
 end
 
-class Class
-  def subclass(base_name, &body)
-    klass = Class.new(self)
-    class_name = "#{self.name}_#{base_name}"
-    instance_eval do
-      const_set(class_name, klass)
-    end
-    klass.instance_eval(&body)
-    klass
-  end
+class AkismetModel
+  include Rakismet::Model
 end
+
+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)
+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(:user_ip => '127.0.0.1',
+                 :user_agent => 'RSpec',
+                 :referrer => 'http://test.host/referrer')
+end
+
+def empty_request
+  OpenStruct.new(:user_ip => nil,
+                 :user_agent => nil,
+                 :referrer => nil)
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rakismet
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-11 00:00:00.000000000Z
+date: 2012-04-19 00:00:00.000000000 Z
 dependencies: []
 description: Rakismet is the easiest way to integrate Akismet or TypePad's AntiSpam
   into your Rails app.
@@ -32,8 +32,13 @@ files:
 - lib/rakismet/version.rb
 - rakismet.gemspec
 - spec/.rspec
+- spec/models/block_params_spec.rb
+- spec/models/custom_params_spec.rb
+- spec/models/extended_params_spec.rb
+- spec/models/rakismet_model_spec.rb
+- spec/models/request_params_spec.rb
+- spec/models/subclass_spec.rb
 - spec/rakismet_middleware_spec.rb
-- spec/rakismet_model_spec.rb
 - spec/rakismet_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/joshfrench/rakismet
@@ -56,12 +61,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: rakismet
-rubygems_version: 1.8.6
+rubygems_version: 1.8.22
 signing_key: 
 specification_version: 3
 summary: Akismet and TypePad AntiSpam integration for Rails.
 test_files:
+- spec/models/block_params_spec.rb
+- spec/models/custom_params_spec.rb
+- spec/models/extended_params_spec.rb
+- spec/models/rakismet_model_spec.rb
+- spec/models/request_params_spec.rb
+- spec/models/subclass_spec.rb
 - spec/rakismet_middleware_spec.rb
-- spec/rakismet_model_spec.rb
 - spec/rakismet_spec.rb
 - spec/spec_helper.rb

data/spec/rakismet_model_spec.rb

@@ -1,246 +0,0 @@
-require File.dirname(__FILE__) + '/spec_helper'
-require 'ostruct'
-
-class AkismetModel
-  include Rakismet::Model
-end
-
-class StoredParams
-  include Rakismet::Model
-  attr_accessor :user_ip, :user_agent, :referrer
-end
-
-describe AkismetModel do
-
-  before 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 request mappings" do
-    [:user_ip, :user_agent, :referrer].each do |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|
-        fieldname = field.to_s =~ %r(^comment_) ? field : "comment_#{field}".intern
-         override.akismet_attrs[fieldname].should eql(mapped_params[field])
-       end
-    end
-  end
-
-  extended_params = { :user_ip => :stored_ip, :user_agent => :stored_agent,
-                      :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.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.should_receive(:akismet_call).
-          with('submit-ham', akismet_attrs(:user_ip => '127.0.0.1', :user_agent => 'RSpec',
-                                            :referrer => 'http://test.host/'))
-        @extended.ham!
-      end
-    end
-  end
-
-  @proc = proc { author.reverse }
-  block_params = { :author => @proc }
-
-  describe block = AkismetModel.subclass('Block') { rakismet_attrs(block_params) } do
-
-    before do
-      @block = block.new
-      comment_attrs.each_pair { |k,v| @block.stub!(k).and_return(v) }
-    end
-
-    it "should accept a block" do
-      block.akismet_attrs[:author].should eql(@proc)
-    end
-
-    it "should eval block with self = instance" do
-      data = @block.send(:akismet_data)
-      data[:comment_author].should eql(comment_attrs[:author].reverse)
-    end
-  end
-
-  extra_params = { :extra => :extra, :another => lambda { } }
-
-  describe extra = AkismetModel.subclass('ExtraParams') { rakismet_attrs(extra_params.dup) } do
-    it "should map additional attributes" do
-      [:extra, :another].each do |field|
-        extra.akismet_attrs[field].should eql(extra_params[field])
-      end
-    end
-  end
-
-  string_params = { :comment_type => 'pingback' }
-
-  describe string = AkismetModel.subclass('StringParams') { rakismet_attrs(string_params) } do
-
-    before do
-      @string = string.new
-      comment_attrs.each_pair { |k,v| @string.stub!(k).and_return(v) }
-    end
-
-    it "should map string attributes" do
-      @string.send(:akismet_data)[:comment_type].should eql('pingback')
-    end
-  end
-
-  describe ".spam?" do
-
-    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.should_receive(:akismet_call).once
-      @model.spam?
-      @model.spam?
-    end
-
-    it "should be true if comment is spam" do
-      Rakismet.stub!(:akismet_call).and_return('true')
-      @model.should be_spam
-    end
-
-    it "should be false if comment is not spam" do
-      Rakismet.stub!(:akismet_call).and_return('false')
-      @model.should_not be_spam
-    end
-
-    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.stub!(:request).and_return(empty_request)
-      lambda { @model.spam? }.should_not raise_error(NoMethodError)
-    end
-  end
-
-  describe StoredParams do
-      before do
-        @model = StoredParams.new
-        comment_attrs.each_pair { |k,v| @model.stub!(k).and_return(v) }
-      end
-
-    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.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.should_receive(:akismet_call).with('submit-spam', akismet_attrs)
-      @model.spam!
-    end
-
-    it "should mutate #spam?" do
-      Rakismet.stub!(:akismet_call)
-      @model.instance_variable_set(:@_spam, false)
-      @model.spam!
-      @model.should be_spam
-    end
-  end
-
-  describe ".ham!" do
-    it "should call Base.akismet_call with submit-ham" do
-      Rakismet.should_receive(:akismet_call).with('submit-ham', akismet_attrs)
-      @model.ham!
-    end
-
-    it "should mutate #spam?" do
-      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)
-    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
-
-    let(:request) {
-      OpenStruct.new(:user_ip => '127.0.0.1',
-                     :user_agent => 'RSpec',
-                     :referrer => 'http://test.host/referrer')
-    }
-
-    let(:empty_request) {
-      OpenStruct.new(:user_ip => nil,
-                     :user_agent => nil,
-                     :referrer => nil)
-    }
-
-end