merb_akismet 0.0.2 → 0.0.3

data/Rakefile

@@ -1,5 +1,7 @@
 require 'rubygems'
 require 'rake/gempackagetask'
+require 'spec/rake/spectask'
+require 'merb'
 require 'lib/merb_akismet'
 
 PLUGIN = "merb_akismet"
@@ -26,6 +28,10 @@ spec = Gem::Specification.new do |s|
   s.files = %w(LICENSE README Rakefile TODO) + Dir.glob("{lib,specs}/**/*")
 end
 
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['specs/*_spec.rb']
+end
+
 Rake::GemPackageTask.new(spec) do |pkg|
   pkg.gem_spec = spec
 end

data/lib/merb_akismet.rb

@@ -1,35 +1,31 @@
 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'
+    :key => '',
+    :timeout => 20,
+
+    # By default, everything is considered spam when unable to access Akismet
+    :fallback_answer => true
   }
 
   # :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'
+  module MerbAkismet
+    VERSION = '0.0.3'
 
-  def self.config
-    Merb::Plugins.config[:merb_akismet]
+    def self.config
+      Merb::Plugins.config[:merb_akismet]
+    end
   end
-end
+  require File.join(File.dirname(__FILE__), 'merb_akismet', 'request')
+  require File.join(File.dirname(__FILE__), 'merb_akismet', 'mixin')
 
-require File.join(File.dirname(__FILE__), 'merb_akismet', 'request')
-require File.join(File.dirname(__FILE__), 'merb_akismet', 'mixin')
+  config = File.join(MERB_ROOT, 'config', 'akismet.yml')
+  Merb::Plugins.config[:merb_akismet].merge!(YAML.load_file(config)) if File.exist?(config)
 
-class Merb::AbstractController
-  include MerbAkismet::Mixin
+  Merb::Plugins.add_rakefiles "merb_akismet/merbtasks"
+  class Merb::AbstractController; include MerbAkismet::Mixin end
 end

data/lib/merb_akismet/merbtasks.rb

@@ -13,9 +13,9 @@ namespace :akismet do
   desc "Verify akismet API key"
   task :verify do
     if MerbAkismet::Request.has_valid_key?
-      puts "Verified and A-OK!"
+      puts "Akismet key verified and A-OK!"
     else
-      puts "Invalid Key. To get a key, register at http://www.wordpress.com/"
+      puts "Invalid key. To get a key, register at http://www.wordpress.com/"
     end
   end
 end

data/lib/merb_akismet/request.rb

@@ -1,4 +1,6 @@
 module MerbAkismet
+  class KeyNotProvided < StandardError; end
+  
   class Request
     HEADERS = {
       'User-Agent' => "Merb/#{Merb::VERSION} | MerbAkismet/#{MerbAkismet::VERSION}",
@@ -8,7 +10,7 @@ module MerbAkismet
     # True when Akismet determines that a comment is spam
     attr_reader :response
 
-    # Makes an API call to Akismet
+    # Makes an Akismet API call
     #
     # +function+ should be one of 'comment-check', 'submit-spam'
     # or 'submit-ham'
@@ -32,9 +34,15 @@ module MerbAkismet
     # 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")
+      begin
+        raise KeyNotProvided if key.blank?
+        req = Net::HTTP.new("#{key}.rest.akismet.com", 80)
+        req.read_timeout = MerbAkismet.config[:timeout]
+        res, data = req.post("/1.1/#{function}", args.to_params, HEADERS)
+        @response = (data != "false")
+      rescue TimeoutError, KeyNotProvided
+        @response = MerbAkismet.config[:fallback_answer]
+      end
     end
 
     private

data/specs/merb_akismet_spec.rb

@@ -22,7 +22,7 @@ describe MerbAkismet::Request do
     MerbAkismet::Request.should have_valid_key
   end
 
-  it 'should only verify keys that are valid' do
+  it 'should only allow valid keys' do
     MerbAkismet.config[:key] = 'invalid key'
     MerbAkismet::Request.should_not have_valid_key
   end
@@ -38,6 +38,20 @@ describe MerbAkismet::Request do
     request = MerbAkismet::Request.new('comment-check', @comment)
     request.response.should be_true
   end
+
+  it 'should handle timeouts gracefully' do
+    MerbAkismet.config[:timeout] = 0.001 # Should be enough ;)
+    MerbAkismet.config[:fallback_answer] = "Timed out"
+    request = MerbAkismet::Request.new('comment-check', @comment)
+    request.response.should == "Timed out"
+  end
+
+  it 'should drop to the fallback answer if no api key is provided' do
+    MerbAkismet.config[:fallback_answer] = "Oh my"
+    MerbAkismet.config[:key] = ''
+    request = MerbAkismet::Request.new('comment-check', @comment)
+    request.response.should == "Oh my"
+  end
 end
 
 describe MerbAkismet::Mixin do

data/specs/spec_config.yaml

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

metadata

@@ -3,8 +3,8 @@ 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
+  version: 0.0.3
+date: 2007-11-14 00:00:00 +01:00
 summary: Provides spam checking with Akismet for Merb apps
 require_paths: 
 - lib