akismetor 1.0.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rvmrc

@@ -0,0 +1,3 @@
+export RUBYOPT="rubygems"
+export RUBYLIB="."
+rvm default@akismetor

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in akismetor.gemspec
+gemspec

data/MIT_LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2007 Ryan Bates
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,89 @@
+= Now with TypePad support!
+
+Akismetor now supports the free TypePad API in addition to Akismet.
+
+To switch to TypePad, add
+  :provider => :typepad
+to your attributes hash (and don't forget to set your API key to your TypePad key).
+
+If you wish to continue using Akismet, you need do nothing.
+
+= Akismetor 1.1
+
+This version includes rSpec tests and a method to verify the Akismet key.
+
+This plugin was originally created by Ryan Bates (Railscasts episode 65), being forked from http://svn.railscasts.com/public/plugins/akismetor
+
+This plugin provides the Akismet class which you can use to communicate with Akismet. Akismet [http://akismet.com/] is a collaborative spam filtering service.
+
+You can use the class Akismet and its methods, wherever you want inside your Rails application.
+
+== Install:
+
+./script/plugin install git://github.com/levycarneiro/akismetor
+
+
+== Usage:
+
+# submits key to Akismet, and returns a string with "valid" or "invalid".
+Akismetor.valid_key?(attributes)
+
+# submits comment to Akismet, and returns true if the comment is spam, and false in case it's not.
+Akismetor.spam?(attributes)
+
+# submits hash as spam to Akismet. Returns a message string.
+Akismetor.submit_spam(attributes)
+
+# submits hash as ham to Akismet. Returns a message string.
+Akismetor.submit_ham(attributes)
+
+
+
+Let's see a real usage:
+
+comment_attributes = {
+  :key => '123456789', 
+  :blog => 'http://www.my-site.com', 
+  :user_ip => '200.10.20.30',
+  :user_agent => 'Mozilla/5.0 (Macintosh; U; PPC Mac OS X 10.5; en-US; rv:1.9.0.3) Gecko/2008092414 Firefox/3.0.3',
+  :referrer => 'http://www.another-site.com',
+  :permalink => 'http://www.my-site.com/posts/2',
+  :comment_type => 'comment',
+  :comment_author => 'John Doe',
+  :comment_author_email => 'john@doe.com',
+  :comment_author_url => 'http://www.doe.com',
+  :comment_content => 'I beg to differ....'
+}
+
+check = Akismetor.spam?(comment_attributes)
+puts "Is this spam? #{check.to_s}."
+
+== The Akismet API
+
+Akismet API Documentation Version 1.1 is at http://akismet.com/development/api/
+
+blog  (required)
+    The front page or home URL of the instance making the request. For a blog or wiki this would be the front page. Note: Must be a full URI, including http://. 
+user_ip (required)
+    IP address of the comment submitter.
+user_agent (required)
+    User agent information.
+referrer (note spelling)
+    The content of the HTTP_REFERER header should be sent here.
+permalink
+    The permanent location of the entry the comment was submitted to.
+comment_type
+    May be blank, comment, trackback, pingback, or a made up value like "registration".
+comment_author
+    Submitted name with the comment
+comment_author_email
+    Submitted email address
+comment_author_url
+    Commenter URL.
+comment_content
+    The content that was submitted.
+Other server enviroment variables
+    In PHP there is an array of enviroment variables called $_SERVER which contains information about the web server itself as well as a key/value for every HTTP header sent with the request. This data is highly useful to Akismet as how the submited content interacts with the server can be very telling, so please include as much information as possible.
+
+This call returns either "true" or "false" as the body content. True means that the comment is spam and false means that it isn't spam. If you are having trouble triggering you can send "viagra-test-123" as the author and it will trigger a true response, always. 
+

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/akismetor.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "akismetor/version"
+
+Gem::Specification.new do |s|
+  s.name        = "akismetor"
+  s.version     = Akismetor::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Robby Grossman", "Ryan Bates", "Levy Carneiro"]
+  s.email       = ["robby@freerobby.com"]
+  s.homepage    = ""
+  s.summary     = %q{Spam protection with Akismet and Typepad}
+  s.description = %q{Spam protection with Akismet and Typepad}
+
+  s.rubyforge_project = "akismetor"
+  
+  s.add_development_dependency "rspec", ">= 2.4.0"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/akismetor.rb

@@ -0,0 +1,57 @@
+class Akismetor
+  attr_accessor :attributes
+
+  require 'net/http'
+  
+  API_HOST_AKISMET = "rest.akismet.com"
+  API_HOST_TYPEPAD = "api.antispam.typepad.com"
+
+  # Does a key-check on Akismet so you know you can actually use a specific key.
+  # Returns "valid" or "invalid" depending on response.
+  def self.valid_key?(attributes)
+    self.new(attributes).execute('verify-key')
+  end
+
+  # Does a comment-check on Akismet with the submitted hash.
+  # Returns true or false depending on response.
+  def self.spam?(attributes)
+    self.new(attributes).execute('comment-check') != "false"
+  end
+
+  # Does a submit-spam on Akismet with the submitted hash.
+  # Use this when Akismet incorrectly approves a spam comment.
+  def self.submit_spam(attributes)
+    self.new(attributes).execute('submit-spam')
+  end
+
+  # Does a submit-ham on Akismet with the submitted hash.
+  # Use this for a false positive, when Akismet incorrectly rejects a normal comment.
+  def self.submit_ham(attributes)
+    self.new(attributes).execute('submit-ham')
+  end
+
+  def initialize(attributes)
+    @attributes = attributes
+  end
+
+  def execute(command)
+    host = (@attributes[:provider] != :typepad) ? API_HOST_AKISMET : API_HOST_TYPEPAD
+    host_prefix = "#{@attributes[:key]}." if attributes[:key] && command != 'verify-key'
+    http = Net::HTTP.new("#{host_prefix}#{host}", 80)
+    http.post("/1.1/#{command}", attributes_for_post, http_headers).body
+  end
+
+  private
+
+  def http_headers
+    {
+      'User-Agent' => 'Akismetor Rails Plugin/1.1',
+      'Content-Type' => 'application/x-www-form-urlencoded'
+    }
+  end
+
+  def attributes_for_post
+    result = attributes.map { |k, v| "#{k}=#{v}" }.join('&')
+    URI.escape(result)
+  end
+end

data/lib/akismetor/version.rb

@@ -0,0 +1,3 @@
+module Akismetor
+  VERSION = "1.0.0"
+end

data/spec/akismetor_spec.rb

@@ -0,0 +1,116 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require File.dirname(__FILE__) + '/../lib/akismetor'
+
+module AkismetorSpecHelper
+  def valid_attributes
+    {
+      :key => 'YourApiKey', 
+      :blog => 'http://www.my-site.com', 
+      :user_ip => '200.10.20.30', 
+      :user_agent => 'Mozilla/5.0 (Macintosh; U; PPC Mac OS X 10.5; en-US; rv:1.9.0.3) Gecko/2008092414 Firefox/3.0.3', 
+      :referrer => 'http://www.previous-site.com', 
+      :permalink => 'http://www.my-site.com', 
+      :comment_type => 'comment', 
+      :comment_author => 'Joe Dude', 
+      :comment_author_email => 'some-email@some-host.com', 
+      :comment_author_url => 'http://www.author-s-site.com', 
+      :comment_content => 'this is a normal comment'
+    }
+  end
+
+  def invalid_attributes
+    valid_attributes.with(:comment_author => 'viagra-test-123')
+  end
+end
+
+describe Akismetor do
+  include AkismetorSpecHelper
+
+  describe "plugin requirements" do
+
+    def mock_akismet(value)
+      @response = stub("response", :body => value)
+      @http = stub("http", :post => @response)
+    end
+
+    it ".spam? should convert provider's string 'true' to boolean true" do
+      mock_akismet('true')
+      Net::HTTP.should_receive(:new).and_return(@http)
+      Akismetor.spam?(invalid_attributes).should be_true
+    end
+
+    it ".spam? should convert provier's string 'false' to boolean false" do
+      mock_akismet('false')
+      Net::HTTP.should_receive(:new).and_return(@http)
+      Akismetor.spam?(invalid_attributes).should be_false
+    end
+    
+    describe "with akismet" do
+      before do
+        @implicit_attributes = valid_attributes
+        @explicit_attributes = valid_attributes.with(:provider => :akismet)
+      end
+      
+      it ".valid_key? should connect to host 'rest.akismet.com' " do
+        mock_akismet('true')
+        Net::HTTP.should_receive(:new).exactly(:twice).with('rest.akismet.com', anything()).and_return(@http)
+        Akismetor.valid_key?(@implicit_attributes)
+        Akismetor.valid_key?(@explicit_attributes)
+      end
+      
+      it ".spam? should connect to host 'YourApiKey.rest.akismet.com' " do
+        mock_akismet('true')
+        Net::HTTP.should_receive(:new).exactly(:twice).with('YourApiKey.rest.akismet.com', anything()).and_return(@http)
+        Akismetor.spam?(@implicit_attributes)
+        Akismetor.spam?(@explicit_attributes)
+      end
+    end
+    
+    describe "with typepad" do
+      before do
+        @attributes = valid_attributes.with(:provider => :typepad)
+      end
+      
+      it ".valid_key? should connect to host 'api.antispam.typepad.com' " do
+        mock_akismet('true')
+        Net::HTTP.should_receive(:new).with('api.antispam.typepad.com', anything()).and_return(@http)
+        Akismetor.valid_key?(@attributes)
+      end
+      
+      it ".spam? should connect to host 'YourApiKey.api.antispam.typepad.com' " do
+        mock_akismet('true')
+        Net::HTTP.should_receive(:new).with('YourApiKey.api.antispam.typepad.com', anything()).and_return(@http)
+        Akismetor.spam?(@attributes)
+      end
+    end
+  end
+
+  describe "provider commands" do
+
+    before(:each) do
+      @response = stub("response", :body => 'true')
+      @http = stub("http", :post => @response)
+      Net::HTTP.should_receive(:new).and_return(@http)
+    end
+    
+    it ".valid_key? should run provider's command 'verify-key' " do
+      @http.should_receive(:post).with('/1.1/verify-key', anything(), anything()).and_return(@response)
+      Akismetor.valid_key?(valid_attributes)
+    end
+
+    it ".spam? should run provider's command 'comment-check' " do
+      @http.should_receive(:post).with('/1.1/comment-check', anything(), anything()).and_return(@response)
+      Akismetor.spam?(valid_attributes)
+    end
+
+    it ".submit_spam should run provider's command 'submit-spam' " do
+      @http.should_receive(:post).with('/1.1/submit-spam', anything(), anything()).and_return(@response)
+      Akismetor.submit_spam(valid_attributes)
+    end
+
+    it ".submit_ham should run provider's command 'submit-ham' " do
+      @http.should_receive(:post).with('/1.1/submit-ham', anything(), anything()).and_return(@response)
+      Akismetor.submit_ham(valid_attributes)
+    end
+  end
+end

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -0,0 +1,34 @@
+require 'rspec'
+
+# rSpec Hash additions. From 
+#   * http://wincent.com/knowledge-base/Fixtures_considered_harmful%3F
+#   * Neil Rahilly
+class Hash
+
+  # Filter keys out of a Hash.
+  #   { :a => 1, :b => 2, :c => 3 }.except(:a)
+  #   => { :b => 2, :c => 3 }
+
+  def except(*keys)
+    self.reject { |k,v| keys.include?(k || k.to_sym) }
+  end
+
+  # Override some keys.
+  #   { :a => 1, :b => 2, :c => 3 }.with(:a => 4)
+  #   => { :a => 4, :b => 2, :c => 3 }
+  
+  def with(overrides = {})
+    self.merge overrides
+  end
+
+  # Returns a Hash with only the pairs identified by +keys+.
+  #   { :a => 1, :b => 2, :c => 3 }.only(:a)
+  #   => { :a => 1 }
+
+  def only(*keys)
+    self.reject { |k,v| !keys.include?(k || k.to_sym) }
+  end
+end
+
+RSpec::configure do |config|
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification 
+name: akismetor
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Robby Grossman
+- Ryan Bates
+- Levy Carneiro
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-20 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 2
+        - 4
+        - 0
+        version: 2.4.0
+  type: :development
+  version_requirements: *id001
+description: Spam protection with Akismet and Typepad
+email: 
+- robby@freerobby.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rvmrc
+- Gemfile
+- MIT_LICENSE
+- README
+- Rakefile
+- akismetor.gemspec
+- lib/akismetor.rb
+- lib/akismetor/version.rb
+- spec/akismetor_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: akismetor
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Spam protection with Akismet and Typepad
+test_files: 
+- spec/akismetor_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb