merb_akismet 0.0.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2007 raspberry lemon
+
+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,6 @@
+merb_akismet
+=================
+
+Spam checking with Akismet (http://akismet.com/) for Merb.
+
+Remember to run rake akismet:settings

data/Rakefile

@@ -0,0 +1,35 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'lib/merb_akismet'
+
+PLUGIN = "merb_akismet"
+NAME = "merb_akismet"
+AUTHOR = "raspberry lemon"
+EMAIL = "lemon@raspberry-style.net"
+HOMEPAGE = "http://merb-plugins.rubyforge.org/merb_akismet/"
+SUMMARY = "Provides spam checking with Akismet for Merb apps"
+
+spec = Gem::Specification.new do |s|
+  s.name = NAME
+  s.version = MerbAkismet::VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README", "LICENSE", 'TODO']
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  s.requirements << 'merb'
+  s.require_path = 'lib'
+  s.autorequire = PLUGIN
+  s.files = %w(LICENSE README Rakefile TODO) + Dir.glob("{lib,specs}/**/*")
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+task :install => [:package] do
+  sh %{sudo gem install pkg/#{NAME}-#{MerbAkismet::VERSION}}
+end

data/TODO

@@ -0,0 +1,2 @@
+TODO:
+Simpler configuration?

data/lib/merb_akismet.rb

@@ -0,0 +1,35 @@
+require 'net/http'
+require 'merb'
+
+# make sure we're running inside Merb
+if defined?(Merb::Plugins)
+  Merb::Plugins.config[:merb_akismet] = {
+    :application => 'merb_akismet',
+    :blog => 'http://your_site_here',
+    :charset => 'utf-8',
+    :key => 'your_akismet_key'
+  }
+
+  # :o lulz
+  file = File.join(MERB_ROOT, 'config', 'akismet.yml')
+  if File.exist?(file)
+    Merb::Plugins.config[:merb_akismet].merge!(YAML.load_file(file))
+  end
+
+  Merb::Plugins.add_rakefiles "merb_akismet/merbtasks"
+end
+
+module MerbAkismet
+  VERSION = '0.0.2'
+
+  def self.config
+    Merb::Plugins.config[:merb_akismet]
+  end
+end
+
+require File.join(File.dirname(__FILE__), 'merb_akismet', 'request')
+require File.join(File.dirname(__FILE__), 'merb_akismet', 'mixin')
+
+class Merb::AbstractController
+  include MerbAkismet::Mixin
+end

data/lib/merb_akismet/merbtasks.rb

@@ -0,0 +1,21 @@
+namespace :akismet do
+  desc "Generate akismet.yml"
+  task :setup do
+    file = File.join(MERB_ROOT, 'config', 'akismet.yml')
+    if not File.exists?(file)
+      File.open(file, 'w') { |f| f << MerbAkismet.config.to_yaml }
+      puts "Please edit config/akismet.yml"
+    else
+      puts "Configuration file already exists"
+    end
+  end
+
+  desc "Verify akismet API key"
+  task :verify do
+    if MerbAkismet::Request.has_valid_key?
+      puts "Verified and A-OK!"
+    else
+      puts "Invalid Key. To get a key, register at http://www.wordpress.com/"
+    end
+  end
+end

data/lib/merb_akismet/mixin.rb

@@ -0,0 +1,36 @@
+module MerbAkismet
+  module Mixin
+    # Returns true if +data+ is spam.
+    # +data+ can be a hash with parameters described in MerbAkismet::Request, or
+    # an arbitrary object which responds to #content, #author, #email, #url and #type
+    def spam?(data)
+      akismet_request('comment-check', data)
+    end
+
+    # When Akismet makes a mistake, we tell them about it
+    def submit_spam(data)
+      akismet_request('submit-spam', data)
+    end
+
+    # Marks a false positive and reports to Akismet
+    def submit_ham(data)
+      akismet_request('submit-ham', data)
+    end
+
+    private
+    # Extracts information from data and sends an Akismet request
+    def akismet_request(function, data)
+      data = {
+        :comment_content => data.content,
+        :comment_type => data.type,
+        :comment_author => data.author,
+        :comment_author_email => data.email,
+        :comment_author_url => data.url
+      } if data.respond_to? :content
+      data[:user_ip] ||= request.remote_ip
+      data[:user_agent] ||= request.user_agent
+      data[:referrer] ||= request.referer
+      MerbAkismet::Request.new(function, data).response
+    end
+  end
+end

data/lib/merb_akismet/request.rb

@@ -0,0 +1,57 @@
+module MerbAkismet
+  class Request
+    HEADERS = {
+      'User-Agent' => "Merb/#{Merb::VERSION} | MerbAkismet/#{MerbAkismet::VERSION}",
+      'Content-Type' => "application/x-www-form-urlencoded; charset=#{MerbAkismet.config[:charset]}"
+    }
+
+    # True when Akismet determines that a comment is spam
+    attr_reader :response
+
+    # Makes an API call to Akismet
+    #
+    # +function+ should be one of 'comment-check', 'submit-spam'
+    # or 'submit-ham'
+    #
+    # +args+ should be a hash containing all the extra info Akismet wants.
+    #
+    # Required arguments
+    # blog: The front page or home URL of the instance making the request.
+    #       If you've set this in the options, it can be left out
+    # user_ip: IP address of the comment submitter.
+    # user_agent: User agent information
+    #
+    # Optional (but recommended!) arguments
+    # referrer: HTTP_REFERER
+    # 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.
+    # env: Other environment variables
+    def initialize(function, args)
+      args[:blog] ||= MerbAkismet.config[:blog]
+      req = Net::HTTP.new("#{key}.rest.akismet.com", 80)
+      res, data = req.post("/1.1/#{function}", args.to_params, HEADERS)
+      @response = (data != "false")
+    end
+
+    private
+    def key
+      MerbAkismet.config[:key]
+    end
+
+    class << self
+      def has_valid_key?
+        req = Net::HTTP.new('rest.akismet.com', 80)
+        qs = {
+          :key => MerbAkismet.config[:key],
+          :blog => MerbAkismet.config[:blog]
+        }.to_params
+        res, data = req.post('/1.1/verify-key', qs, HEADERS)
+        data == "valid"
+      end
+    end
+  end
+end

data/specs/merb_akismet_spec.rb

@@ -0,0 +1,45 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe MerbAkismet do  
+  it 'should use the Merb::Plugins.config hash for its configuration' do
+    MerbAkismet.config.should == Merb::Plugins.config[:merb_akismet]
+  end
+end
+
+describe MerbAkismet::Request do
+  before(:each) do
+    setup_config
+    @comment = {
+      :user_ip => '58.120.49.28',
+      :user_agent => 'Mozilla/5.0 (Macintosh; U; Intel Mac OS X; en-us) AppleWebKit/523.10.3 (KHTML, like Gecko) Version/3.0.4 Safari/523.10',
+      :comment_author => 'Mr. Bell',
+      :comment_content => 'This is a really interesting place. I love your blaahg.',
+      :referrer => 'http://127.0.0.1/'
+    }
+  end
+
+  it 'should be able to verify keys' do
+    MerbAkismet::Request.should have_valid_key
+  end
+
+  it 'should only verify keys that are valid' do
+    MerbAkismet.config[:key] = 'invalid key'
+    MerbAkismet::Request.should_not have_valid_key
+  end
+
+  it 'should allow harmless comments' do
+    request = MerbAkismet::Request.new('comment-check', @comment)
+    request.response.should be_false
+  end
+
+  # A request with 'viagra-test-123' as the author is always considered spam
+  it 'should identify spam' do
+    @comment[:comment_author] = "viagra-test-123"
+    request = MerbAkismet::Request.new('comment-check', @comment)
+    request.response.should be_true
+  end
+end
+
+describe MerbAkismet::Mixin do
+  Merb::AbstractController.new.should respond_to(:spam?)
+end

data/specs/spec_config.yaml

@@ -0,0 +1,3 @@
+---
+:blog: http://test.blog.museum/
+:key: Replace this with a valid key

data/specs/spec_helper.rb

@@ -0,0 +1,11 @@
+$TESTING=true
+$:.push File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'spec'
+require 'merb'
+require 'merb_akismet'
+
+def setup_config
+  yaml = YAML.load_file(File.join(File.dirname(__FILE__), 'spec_config.yaml'))
+  MerbAkismet.config.merge!(yaml)
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.4
+specification_version: 1
+name: merb_akismet
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+date: 2007-10-27 00:00:00 +02:00
+summary: Provides spam checking with Akismet for Merb apps
+require_paths: 
+- lib
+email: lemon@raspberry-style.net
+homepage: http://merb-plugins.rubyforge.org/merb_akismet/
+rubyforge_project: 
+description: Provides spam checking with Akismet for Merb apps
+autorequire: merb_akismet
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- raspberry lemon
+files: 
+- LICENSE
+- README
+- Rakefile
+- TODO
+- lib/merb_akismet
+- lib/merb_akismet/merbtasks.rb
+- lib/merb_akismet/mixin.rb
+- lib/merb_akismet/request.rb
+- lib/merb_akismet.rb
+- specs/merb_akismet_spec.rb
+- specs/spec_config.yaml
+- specs/spec_helper.rb
+test_files: []
+
+rdoc_options: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+- TODO
+executables: []
+
+extensions: []
+
+requirements: 
+- merb
+dependencies: []
+