spamster 0.0.1 → 1.0.0

data/README.md

@@ -1,6 +1,6 @@
 # Spamster [![Build Status](https://secure.travis-ci.org/balexand/spamster.png)](http://travis-ci.org/balexand/spamster)
 
-Simple spam filtering.
+Simple spam filtering that works with any Ruby application and can be set up in minutes. It does not depend on any specific ORM or framework, although it includes optional Rack middleware. It uses Akismet or TypePad AntiSpam.
 
 ## Installation
 
@@ -14,29 +14,75 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
+## Usage
 
-    $ gem install spamster
+### Configuration
 
-## Usage
+First you'll need to sign up for an API key from [Akismet](https://akismet.com/signup/) or [TypePad AntiSpam](http://antispam.typepad.com/info/get-api-key.html). Then configure Spamster like:
+
+```ruby
+Spamster.use_akismet("your-api-key", "http://yoursite.com/")
+```
+
+or...
+
+```ruby
+Spamster.use_typepad("your-api-key", "http://yoursite.com/")
+```
+
+If you're building a Rack app (all Rails 3+ apps are Rack apps), then you'll probably want to use the optional Rack middleware so Spamster can automatically fill in the `referrer`, `user_agent`, and `user_ip` params. If you're using Rails then add the middleware like this:
+
+```ruby
+Rails.application.config.middleware.use Spamster::Rack::Middleware
+```
+
+If you're using Rails, then a suggested location to keep the above configuration is in an initializer file.
+
+### Sanity check
 
-### Quick start
+First check that your key is valid:
 
-Start by signing up for an API key [here](https://akismet.com/signup/). Then configure Spamster like:
+```ruby
+Spamster.key_valid? # => true
+```
+
+Then check that it detects spam using the name `viagra-test-123`:
+
+```ruby
+Spamster.spam?(user_ip: "222.222.222.222", user_agent: "Mozilla", comment_author: "viagra-test-123") # => true
+```
+
+And if you want to see the HTTP requests/responses while debugging:
 
 ```ruby
-Spamster.blog = "http://yoursite.com/"
-Spamster.key = "your-api-key"
+Spamster.debug_output = $stderr
 ```
 
-FIXME middleware
-FIXME usage
+### Model mixin
+
+The easiest way to use Spamster is to include the mixin in your comment model:
+
+```ruby
+class Comment
+  attr_accessor :content, :email, :name
+
+  include Spamster::Model
+  spamster_attrs comment_author: :name, comment_author_email: :email, comment_content: :content
+end
+
+comment = Comment.new #...
+comment.spamster.spam? # checks for spam
+comment.spamster.spam! # reports a false negative
+comment.spamster.ham!  # reports a false positive
+```
+
+For a full list of parameters accepted by `spamster_attrs`, see [Akismet's documentation for `comment-check`](http://akismet.com/development/api/#comment-check).
 
 ### Spamster methods
 
 #### key_valid?
 
-Checks if the key is valid using [verify-key](http://akismet.com/development/api/#verify-key).
+Checks if the key is valid using [`verify-key`](http://akismet.com/development/api/#verify-key).
 
 ```ruby
 Spamster.key_valid?
@@ -44,7 +90,7 @@ Spamster.key_valid?
 
 #### spam?
 
-Checks if a comment is spam using [comment-check](http://akismet.com/development/api/#comment-check)
+Checks if a comment is spam using [`comment-check`](http://akismet.com/development/api/#comment-check).
 
 ```ruby
 Spamster.spam?(user_ip: "222.222.222.222", user_agent: "Mozilla", comment_author: "viagra-test-123")
@@ -52,7 +98,7 @@ Spamster.spam?(user_ip: "222.222.222.222", user_agent: "Mozilla", comment_author
 
 ### spam!
 
-Reports a false negative using [submit-spam](http://akismet.com/development/api/#submit-spam)
+Reports a false negative using [`submit-spam`](http://akismet.com/development/api/#submit-spam).
 
 ```ruby
 Spamster.spam!(user_ip: "222.222.222.222", user_agent: "Mozilla", comment_author: "viagra-test-123")
@@ -60,7 +106,7 @@ Spamster.spam!(user_ip: "222.222.222.222", user_agent: "Mozilla", comment_author
 
 ### ham!
 
-Reports a false positive using [submit-ham](http://akismet.com/development/api/#submit-ham)
+Reports a false positive using [`submit-ham`](http://akismet.com/development/api/#submit-ham).
 
 ```ruby
 Spamster.ham!(user_ip: "222.222.222.222", user_agent: "Mozilla", comment_author: "viagra-test-123")
@@ -68,8 +114,6 @@ Spamster.ham!(user_ip: "222.222.222.222", user_agent: "Mozilla", comment_author:
 
 ## Contributing
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+Fork it, install dependencies with `bundle`, and run tests with `bundle exec rake`. If you submit a pull request, then remember to include tests.
+
+Created by Brian Alexander and released under an MIT License.

data/lib/spamster.rb

@@ -1,54 +1,81 @@
+require 'active_support'
+require 'active_support/core_ext'
 require 'net/http'
 require 'spamster/version'
+require 'uri'
 
 module Spamster
+  autoload :Model, 'spamster/model'
+  autoload :Rack, 'spamster/rack/middleware'
+
   class <<self
-    attr_accessor :blog, :key
+    attr_accessor :api_host, :blog, :debug_output, :key, :request_params
+
+    def use_akismet(key, blog)
+      self.api_host = "rest.akismet.com"
+      self.blog = blog
+      self.key = key
+    end
+
+    def use_typepad(key, blog)
+      self.api_host = "api.antispam.typepad.com"
+      self.blog = blog
+      self.key = key
+    end
 
     # see http://akismet.com/development/api/#verify-key
     def key_valid?
-      check_config
       params = {:blog => blog, :key => key}
-      response = Net::HTTP.post_form(URI("http://rest.akismet.com/1.1/verify-key"), params)
+      response = perform_post("http://#{api_host}/1.1/verify-key", params)
       response.body == 'valid'
     end
 
     # see http://akismet.com/development/api/#comment-check
     def spam?(params)
-      submit("comment-check", params) == 'true'
+      perform_spam_post("comment-check", params) == 'true'
     end
 
     # see http://akismet.com/development/api/#submit-spam
     def spam!(params)
-      submit("submit-spam", params)
+      perform_spam_post("submit-spam", params)
     end
 
     # see http://akismet.com/development/api/#submit-ham
     def ham!(params)
-      submit("submit-ham", params)
+      perform_spam_post("submit-ham", params)
     end
 
   private
-    def check_config
-      raise "'Spamster.blog' must be set" unless blog
-      raise "'Spamster.key' must be set"  unless key
+    def perform_post(url, params)
+      [:api_host, :blog, :key].each do |param|
+        raise "'Spamster.#{param}' must be set" unless send(param).present?
+      end
+
+      uri = URI(url)
+
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.set_debug_output(debug_output) if debug_output
+
+      req = Net::HTTP::Post.new(uri.path)
+      req.set_form_data(params)
+      # Akismet wants User-Agent format: Application Name/Version | Plugin Name/Version
+      user_agent = "Spamster/#{VERSION}"
+      user_agent = "Rails/#{Rails.version} | " + user_agent if defined?(Rails)
+      req['User-Agent'] = user_agent
+
+      http.start { |h| h.request(req) }
     end
 
-    def check_required_params(params)
-      # these params are required by spam?, spam!, and ham!
+    # checks params and performs post for spam?, spam!, and ham!
+    def perform_spam_post(method, params = {})
+      params = params.merge(:blog => blog)
+      params.merge!(request_params) if request_params
       [:blog, :user_agent, :user_ip].each do |param|
-        raise "required param #{param.inspect} is missing" unless params[param]
+        raise "required param #{param.inspect} is missing" unless params[param].present?
       end
-    end
 
-    def submit(method, params = {})
-      check_config
-      params = params.merge(:blog => blog)
-      check_required_params(params)
-      response = Net::HTTP.post_form(URI("http://#{key}.rest.akismet.com/1.1/#{method}"), params)
+      response = perform_post("http://#{key}.#{api_host}/1.1/#{method}", params)
       response.body
     end
   end
 end
-
-# FIXME User-Agent

data/lib/spamster/model.rb

@@ -0,0 +1,23 @@
+require 'active_support/concern'
+require 'spamster/model/proxy'
+
+module Spamster
+  module Model
+    extend ActiveSupport::Concern
+
+    included do
+      spamster_attrs({})
+    end
+
+    module ClassMethods
+      def spamster_attrs(attrs = nil)
+        @spamster_attrs = attrs if attrs
+        @spamster_attrs
+      end
+    end
+
+    def spamster
+      Proxy.new(self)
+    end
+  end
+end

data/lib/spamster/model/proxy.rb

@@ -0,0 +1,29 @@
+module Spamster
+  module Model
+    class Proxy
+      def initialize(model)
+        @model = model
+      end
+
+      def spam?
+        Spamster.spam?(data)
+      end
+
+      def spam!
+        Spamster.spam!(data)
+      end
+
+      def ham!
+        Spamster.ham!(data)
+      end
+
+    private
+      def data
+        Hash[@model.class.spamster_attrs.map do |param, method|
+          [param, @model.send(method)]
+        end]
+      end
+    end
+  end
+end
+

data/lib/spamster/rack/middleware.rb

@@ -0,0 +1,22 @@
+module Spamster
+  module Rack
+    class Middleware
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        params = {}
+        params[:referrer]    = env['HTTP_REFERER'] if env['HTTP_REFERER']
+        params[:user_agent]  = env['HTTP_USER_AGENT'] if env['HTTP_USER_AGENT']
+        params[:user_ip]     = env['REMOTE_ADDR'] if env['REMOTE_ADDR']
+        Spamster.request_params = params
+
+        response = @app.call(env)
+
+        Spamster.request_params = nil
+        response
+      end
+    end
+  end
+end

data/lib/spamster/version.rb

@@ -1,3 +1,3 @@
 module Spamster
-  VERSION = "0.0.1"
+  VERSION = "1.0.0"
 end

data/spamster.gemspec

@@ -4,8 +4,8 @@ require File.expand_path('../lib/spamster/version', __FILE__)
 Gem::Specification.new do |gem|
   gem.authors       = ["Brian Alexander"]
   gem.email         = ["balexand@gmail.com"]
-  gem.description   = %q{Simple spam filtering that takes minutes to set up.}
-  gem.summary       = %q{Simple spam filtering.}
+  gem.description   = %q{Simple spam filtering that works with any Ruby application and can be set up in minutes. Uses Akismet or TypePad AntiSpam.}
+  gem.summary       = %q{Simple spam filtering using Akismet or TypePad AntiSpam.}
   gem.homepage      = "https://github.com/balexand/spamster"
 
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
@@ -19,5 +19,6 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "rspec"
   gem.add_development_dependency "webmock"
 
+  gem.add_runtime_dependency "activesupport"
   gem.add_runtime_dependency "jruby-openssl" if RUBY_PLATFORM == "java"
 end

data/spec/spamster/model_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+class Comment
+  include Spamster::Model
+  spamster_attrs :comment_author => :name, :comment_author_email => :email, :comment_content => :content
+  attr_accessor :content, :email, :name
+end
+
+describe Spamster::Model do
+  let(:comment) do
+    Comment.new.tap do |c|
+      c.content = "hello world"
+      c.email = "test@example.com"
+      c.name = "John"
+    end
+  end
+
+  describe "spamster.data" do
+    it "should get correct params from model" do
+      comment.spamster.send(:data).should == {:comment_author => "John", :comment_author_email => "test@example.com", :comment_content => "hello world"}
+    end
+  end
+
+  describe "spamster.spam?" do
+    it "should pass params from model" do
+      Spamster.should_receive(:spam?).once.with(:comment_author => "John", :comment_author_email => "test@example.com", :comment_content => "hello world")
+      comment.spamster.spam?
+    end
+  end
+
+  describe "spamster.spam!" do
+    it "should pass params from model" do
+      Spamster.should_receive(:spam!).once.with(:comment_author => "John", :comment_author_email => "test@example.com", :comment_content => "hello world")
+      comment.spamster.spam!
+    end
+  end
+
+  describe "spamster.ham!" do
+    it "should pass params from model" do
+      Spamster.should_receive(:ham!).once.with(:comment_author => "John", :comment_author_email => "test@example.com", :comment_content => "hello world")
+      comment.spamster.ham!
+    end
+  end
+end

data/spec/spamster/rack/middleware_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe Spamster::Rack::Middleware do
+  before(:each) do
+    Spamster.use_akismet("123abc", "http://example.com/")
+  end
+
+  describe "call" do
+    it "should set 'referrer', 'user_agent', and 'user_ip' request_params" do
+      stub_request(:post, "http://123abc.rest.akismet.com/1.1/comment-check")
+
+      app = Object.new
+      app.stub(:call) do |env|
+        Spamster.request_params.should == {
+          :referrer   => 'http://referer.com/',
+          :user_agent => 'Mozillaish',
+          :user_ip    => "123.123.123.123"
+        }
+
+        Spamster.spam?(:comment_author => "Test User")
+      end
+      app.should_receive(:call).once
+      Spamster::Rack::Middleware.new(app).call(
+        'HTTP_REFERER' => 'http://referer.com/', 'HTTP_USER_AGENT' => 'Mozillaish', 'REMOTE_ADDR' => '123.123.123.123'
+      )
+      Spamster.request_params.should be_nil
+
+      assert_requested(:post, "http://123abc.rest.akismet.com/1.1/comment-check", :times => 1) do |req|
+        CGI.parse(req.body).should == {"comment_author"=>["Test User"], "blog"=>["http://example.com/"], "referrer"=>["http://referer.com/"], "user_agent"=>["Mozillaish"], "user_ip"=>["123.123.123.123"]}
+      end
+    end
+  end
+end

data/spec/spamster_spec.rb

@@ -2,28 +2,49 @@ require 'spec_helper'
 
 describe Spamster do
   before(:each) do
-    Spamster.blog = "http://example.com/"
-    Spamster.key = "123abc"
+    Spamster.use_akismet("123abc", "http://example.com/")
   end
 
-  describe "submit" do
+  describe "perform_post" do
     before(:each) do
       stub_request(:post, "http://123abc.rest.akismet.com/1.1/comment-check")
     end
 
+    it "should raise exception if :api_host is not configured" do
+      Spamster.api_host = ""
+      expect do
+        Spamster.send(:perform_post, "http://123abc.rest.akismet.com/1.1/comment-check", {})
+      end.to raise_exception{ |e| e.message.should == "'Spamster.api_host' must be set" }
+    end
+
     it "should raise exception if :blog is not configured" do
-      Spamster.blog = nil
+      Spamster.blog = ""
       expect do
-        Spamster.send(:submit, "comment-check")
+        Spamster.send(:perform_post, "http://123abc.rest.akismet.com/1.1/comment-check", {})
       end.to raise_exception{ |e| e.message.should == "'Spamster.blog' must be set" }
     end
 
     it "should raise exception if :key is not configured" do
-      Spamster.key = nil
+      Spamster.key = " \n"
       expect do
-        Spamster.send(:submit, "comment-check")
+        Spamster.send(:perform_post, "http://123abc.rest.akismet.com/1.1/comment-check", {})
       end.to raise_exception{ |e| e.message.should == "'Spamster.key' must be set" }
     end
+
+    it "should set User-Agent" do
+      Spamster.send(:perform_post, "http://123abc.rest.akismet.com/1.1/comment-check", {})
+      assert_requested(:post, "http://123abc.rest.akismet.com/1.1/comment-check", :times => 1, :headers => {'User-Agent' => "Spamster/#{Spamster::VERSION}"})
+
+      class Rails
+        def self.version
+          "3.2.2"
+        end
+      end
+
+      Spamster.send(:perform_post, "http://123abc.rest.akismet.com/1.1/comment-check", {})
+      assert_requested(:post, "http://123abc.rest.akismet.com/1.1/comment-check", :times => 1, :headers => {'User-Agent' => "Rails/3.2.2 | Spamster/#{Spamster::VERSION}"})
+      Object.send(:remove_const, :Rails)
+    end
   end
 
   describe "key_valid?" do
@@ -67,7 +88,7 @@ describe Spamster do
 
     it "should raise exception if required param missing" do
       expect do
-        Spamster.spam?(:user_ip => "222.222.222.222")
+        Spamster.spam?(:user_agent => " ", :user_ip => "222.222.222.222")
       end.to raise_exception{ |e| e.message.should == "required param :user_agent is missing" }
 
       expect do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spamster
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-28 00:00:00.000000000 Z
+date: 2012-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -59,7 +59,24 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Simple spam filtering that takes minutes to set up.
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple spam filtering that works with any Ruby application and can be
+  set up in minutes. Uses Akismet or TypePad AntiSpam.
 email:
 - balexand@gmail.com
 executables: []
@@ -73,8 +90,13 @@ files:
 - README.md
 - Rakefile
 - lib/spamster.rb
+- lib/spamster/model.rb
+- lib/spamster/model/proxy.rb
+- lib/spamster/rack/middleware.rb
 - lib/spamster/version.rb
 - spamster.gemspec
+- spec/spamster/model_spec.rb
+- spec/spamster/rack/middleware_spec.rb
 - spec/spamster_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/balexand/spamster
@@ -89,18 +111,26 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -3161924574973985912
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -3161924574973985912
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.19
 signing_key: 
 specification_version: 3
-summary: Simple spam filtering.
+summary: Simple spam filtering using Akismet or TypePad AntiSpam.
 test_files:
+- spec/spamster/model_spec.rb
+- spec/spamster/rack/middleware_spec.rb
 - spec/spamster_spec.rb
 - spec/spec_helper.rb