rakismet 1.2.1 → 1.3.0

data/CHANGELOG

@@ -1,3 +1,7 @@
+= 1.3.0
+* Clean up gemspec and load paths [Steven Harman]
+* Add Akismet is_test param [Steven Harman]
+* Add Akismet user_role attribute [Steven Harman]
 = 1.2.1
 * Fix deprecated usage of HTTPResponse for Ruby 1.9.3 [Leonid Shevtsov]
 = 1.2.0

data/Gemfile

@@ -1,8 +1,3 @@
 source "http://rubygems.org"
 
 gemspec
-
-group :test do
-  gem 'rake'
-  gem 'rspec', '~> 2'
-end

data/README.md

@@ -20,13 +20,20 @@ you'll need an API key. Head on over to http://akismet.com/signup/ and sign up
 for a new username.
 
 Configure the Rakismet key and the URL of your application by setting the following
-in an initializer or application.rb:
+in application.rb:
 
 ```ruby
 config.rakismet.key = 'your wordpress key'
 config.rakismet.url = 'http://yourdomain.com/'
 ```
-    
+
+or an initializer, for example `config/initializers/rakismet.rb`:
+
+```ruby
+YourApp::Application.config.rakismet.key = 'your wordpress key'
+YourApp::Application.config.rakismet.url = 'http://yourdomain.com/'
+```
+
 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.
@@ -137,6 +144,33 @@ your app initialization:
 config.rakismet.use_middleware = false
 ```
 
+Testing
+-------
+
+Rakismet can be configued to tell Akismet that it should operate in test mode -
+so Akismet will not change its behavior based on any test API calls, meaning
+they will have no training effect. That means your tests can be somewhat
+repeatable in the sense that one test won't influence subsequent calls.
+
+You can configure Rakismet for test mode via application.rb:
+
+```ruby
+config.rakismet.test = false # <- default
+config.rakismet.test = true
+```
+
+Or via an initializer:
+
+```ruby
+YourApp::Application.config.rakismet.test = false # <- default
+YourApp::Application.config.rakismet.test = true
+```
+
+**NOTE**: When running in Rails, Rakismet will run in test mode when your Rails
+environment is `test` or `development`, unless explictly configured otherwise.
+Outside of Rails Rakismet defaults to test mode turned **off**.
+
+
 Verifying Responses
 -------------------
 

data/lib/rakismet.rb

@@ -13,7 +13,7 @@ module Rakismet
   Undefined = Class.new(NameError)
 
   class << self
-    attr_accessor :key, :url, :host, :proxy_host, :proxy_port
+    attr_accessor :key, :url, :host, :proxy_host, :proxy_port, :test
 
     def request
       @request ||= Request.new
@@ -52,7 +52,7 @@ module Rakismet
 
     def akismet_call(function, args={})
       validate_config
-      args.merge!(:blog => Rakismet.url)
+      args.merge!(:blog => Rakismet.url, :is_test => Rakismet.test_mode)
       akismet = URI.parse(call_url(function))
       response = Net::HTTP::Proxy(proxy_host, proxy_port).start(akismet.host) do |http|
         params = args.map do |k,v|
@@ -79,6 +79,10 @@ module Rakismet
       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
+
+    def test_mode
+      test ? 1 : 0
+    end
   end
 
 end

data/lib/rakismet/model.rb

@@ -1,6 +1,6 @@
 module Rakismet
   module Model
-   
+
     def self.included(base)
       base.class_eval do
         attr_accessor :akismet_response
@@ -10,11 +10,11 @@ module Rakismet
         self.rakismet_attrs
       end
     end
-   
+
     module ClassMethods
       def rakismet_attrs(args={})
         self.akismet_attrs ||= {}
-        [:comment_type, :author, :author_url, :author_email, :content].each do |field|
+        [:comment_type, :author, :author_url, :author_email, :content, :user_role].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
@@ -32,7 +32,7 @@ module Rakismet
         subclass.rakismet_attrs akismet_attrs.dup
       end
     end
-    
+
     module InstanceMethods
       def spam?
         if instance_variable_defined? :@_spam
@@ -64,7 +64,8 @@ module Rakismet
                                 elsif !mapped_field.nil? && respond_to?(mapped_field)
                                   send(mapped_field)
                                 elsif not [:comment_type, :author, :author_email,
-                                        :author_url, :content, :user_ip, :referrer,
+                                        :author_url, :content, :user_role,
+                                        :user_ip, :referrer,
                                         :user_agent].include?(mapped_field)
                                   # we've excluded any fields that appear to
                                   # have their default unmapped values
@@ -80,6 +81,6 @@ module Rakismet
           akismet
         end
     end
-    
+
   end
 end

data/lib/rakismet/railtie.rb

@@ -14,6 +14,7 @@ module Rakismet
         Rakismet.host = app.config.rakismet[:host]
         Rakismet.proxy_host = app.config.rakismet[:proxy_host]
         Rakismet.proxy_port = app.config.rakismet[:proxy_port]
+        Rakismet.test = app.config.rakismet.fetch(:test) { Rails.env.test? || Rails.env.development? }
         app.middleware.use Rakismet::Middleware if app.config.rakismet.use_middleware
       end
 

data/lib/rakismet/version.rb

@@ -1,3 +1,3 @@
 module Rakismet
-  VERSION = "1.2.1"
+  VERSION = "1.3.0"
 end

data/rakismet.gemspec

@@ -1,6 +1,5 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "rakismet/version"
+require File.expand_path('../lib/rakismet/version', __FILE__)
 
 Gem::Specification.new do |s|
   s.name = "rakismet"
@@ -11,9 +10,11 @@ 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 = "2012-04-22"
+  s.date = "2012-08-04"
 
   s.rubyforge_project = "rakismet"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec", "~> 2.11"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/spec/models/block_params_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+require  'spec_helper'
 
 PROC = proc { author.reverse }
 

data/spec/models/custom_params_spec.rb

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

data/spec/models/extended_params_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+require  'spec_helper'
 
 EXTRA = { :extra => :extra, :another => lambda { } }
 

data/spec/models/rakismet_model_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+require  'spec_helper'
 
 describe AkismetModel do
 
@@ -8,7 +8,7 @@ describe AkismetModel do
   end
 
   it "should have default mappings" do
-    [:comment_type, :author, :author_email, :author_url, :content].each do |field|
+    [:comment_type, :author, :author_email, :author_url, :content, :user_role].each do |field|
       fieldname = field.to_s =~ %r(^comment_) ? field : "comment_#{field}".intern
       AkismetModel.akismet_attrs[fieldname].should eql(field)
      end

data/spec/models/request_params_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+require  'spec_helper'
 
 class RequestParams
   include Rakismet::Model
@@ -20,4 +20,4 @@ describe RequestParams do
                                                         :referrer => 'http://localhost/referrer'))
     @model.spam?
   end
-end
+end

data/spec/models/subclass_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+require  'spec_helper'
 
 class Subclass < AkismetModel
 end
@@ -11,4 +11,4 @@ describe Subclass do
   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
+end

data/spec/rakismet_middleware_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/spec_helper'
+require 'spec_helper'
 
 describe Rakismet::Middleware do
 

data/spec/rakismet_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/spec_helper'
+require 'spec_helper'
 
 describe Rakismet do
 
@@ -7,12 +7,12 @@ describe Rakismet do
   end
   let(:http) { double(:http, :post => mock_response('akismet response')) }
 
-  after do
+  before do
     Rakismet.key = 'dummy-key'
     Rakismet.url = 'test.localhost'
     Rakismet.host = 'endpoint.localhost'
   end
-  
+
   describe "proxy host" do
     it "should have proxy host and port as nil by default" do
       Rakismet.proxy_host.should be_nil
@@ -36,13 +36,13 @@ describe Rakismet do
       lambda { Rakismet.send(:validate_config) }.should raise_error(Rakismet::Undefined)
     end
   end
-  
+
   describe ".validate_key" do
     before (:each) do
       @proxy = mock(Net::HTTP)
       Net::HTTP.stub!(:Proxy).and_return(@proxy)
     end
-    
+
     it "should use proxy host and port" do
       Rakismet.proxy_host = 'proxy_host'
       Rakismet.proxy_port = 'proxy_port'
@@ -50,7 +50,7 @@ describe Rakismet do
       Net::HTTP.should_receive(:Proxy).with('proxy_host', 'proxy_port').and_return(@proxy)
       Rakismet.validate_key
     end
-    
+
     it "should set @@valid_key = true if key is valid" do
       @proxy.stub!(:start).and_return(mock_response('valid'))
       Rakismet.validate_key
@@ -70,14 +70,14 @@ describe Rakismet do
       Rakismet.validate_key
     end
   end
-  
+
   describe ".akismet_call" do
     before do
       @proxy = mock(Net::HTTP)
       Net::HTTP.stub!(:Proxy).and_return(@proxy)
       @proxy.stub(:start).and_yield(http)
     end
-    
+
     it "should use proxy host and port" do
       Rakismet.proxy_host = 'proxy_host'
       Rakismet.proxy_port = 'proxy_port'
@@ -85,19 +85,30 @@ describe Rakismet do
       Net::HTTP.should_receive(:Proxy).with('proxy_host', 'proxy_port').and_return(@proxy)
       Rakismet.send(:akismet_call, 'bogus-function')
     end
-    
+
     it "should build url with API key for the correct host" do
       host = 'api.antispam.typepad.com'
       Rakismet.host = host
       @proxy.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 default to not being in test mode" do
+      http.should_receive(:post).with(anything, %r(is_test=0), anything)
+      Rakismet.send(:akismet_call, 'bogus-function')
+    end
+
+    it "should be in test mode when configured" do
+      Rakismet.test = true
+      http.should_receive(:post).with(anything, %r(is_test=1), anything)
+      Rakismet.send(:akismet_call, 'bogus-function')
+    end
+
     it "should return response.body" do
       Rakismet.send(:akismet_call, 'bogus-function').should eql('akismet response')
     end
@@ -108,5 +119,5 @@ describe Rakismet do
       }.should_not raise_error(NoMethodError)
     end
   end
-  
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rakismet
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,40 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-22 00:00:00.000000000 Z
-dependencies: []
+date: 2012-08-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
 description: Rakismet is the easiest way to integrate Akismet or TypePad's AntiSpam
   into your Rails app.
 email: josh@vitamin-j.com