ruby-akismet 0.9.1 → 0.9.2

data/README.rdoc

@@ -16,14 +16,17 @@ To use Typepad Antispam, just set the host:
   Akismet.host = 'api.antispam.typepad.com'
 
 Then you need to call any of the methods with a few attributes,
-and possibly an ActionDispatch::Request object.
+and possibly an <code>ActionDispatch::Request</code> object.
+
+= Documentation
+
+http://rubydoc.info/github/ysbaddaden/ruby-akismet/master/frames
 
 = Integrate with Ruby on Rails (3.0+)
 
 Add this gem to your Gemfile:
 
-  gem 'ruby-akismet', :require => 'akismet',
-    :git => 'git://github.com/ysbaddaden/ruby-akismet.git'
+  gem 'ruby-akismet', :require => 'akismet'
 
 Create an initializer file like <code>config/initializers/akismet.rb</code>
 with your configuration:

data/lib/akismet.rb

@@ -1,80 +1,8 @@
 require 'net/http'
 
 # Akismet compatible library for checking spams.
-# 
-# = Usage
-# 
-# First you need an Akismet (or Typepad Antispam) API key. Then you need
-# to setup a few configuration variable.
-# 
-#   Akismet.key  = '123456789'
-#   Akismet.blog = 'http://example.com'
-# 
-# To use Typepad Antispam, just set the host:
-# 
-#   Akismet.host = 'api.antispam.typepad.com'
-# 
-# Then you need to call any of the methods with a few attributes,
-# and possibly an ActionDispatch::Request object.
-# 
-# = Integrate with Ruby on Rails (3.0+)
-# 
-# Add this gem to your Gemfile:
-# 
-#   gem 'ruby-akismet', :require => 'akismet',
-#     :git => 'git://github.com/ysbaddaden/ruby-akismet.git'
-# 
-# Create an initializer file like <code>config/initializers/akismet.rb</code>
-# with your configuration:
-# 
-#   Akismet.key  = '123456789'
-#   Akismet.blog = 'http://example.com'
-# 
-# Then in your controller call the appropriate methods:
-# 
-#   class CommentsController < ApplicationController
-#     before_filter :set_post
-#     respond_to :html, :xml
-#     
-#     def create
-#       @comment = @post.comments.new(params[:comment])
-#       @comment.spam = Akismet.spam?(akismet_attributes, request)
-#       @comment.save
-#       respond_with(@comment, :location => @post)
-#     end
-#     
-#     def spam
-#       @comment = Comment.find(params[:id])
-#       @comment.update_attribute(:spam, false)
-#       Akismet.submit_spam(akismet_attributes)
-#       respond_with(@comment, :location => @post)
-#     end
-#     
-#     def ham
-#       @comment = Comment.find(params[:id])
-#       @comment.update_attribute(:spam, false)
-#       Akismet.submit_ham(akismet_attributes)
-#       respond_with(@comment, :location => @post)
-#     end
-#     
-#     private
-#       def akismet_attributes
-#         {
-#           :comment_author       => @comment.author,
-#           :comment_author_url   => @comment.author_url,
-#           :comment_author_email => @comment.author_email,
-#           :comment_content      => @comment.body,
-#           :permalink            => post_url(@post)
-#         }
-#       end
-#       
-#       def set_post
-#         @post = Post.find(params[:post_id])
-#       end
-#   end
-# 
 class Akismet
-  VERSION     = '0.9.1'.freeze
+  VERSION     = '0.9.2'.freeze
   API_VERSION = '1.1'.freeze
 
   @@host = 'rest.akismet.com'
@@ -82,23 +10,27 @@ class Akismet
   @@blog = nil
 
   class << self
+    # Configure an alternate API server.
     def host=(host)
       @@host = host
     end
 
+    # Configure your API key (required).
     def key=(key)
       @@key = key
     end
 
+    # Configure your homepage URL (optional).
     def blog=(blog)
       @@blog = blog
     end
 
+    # Checks if a key is valid or not.
     def valid_key?(key)
       call('verify-key', :key => key) == "valid"
     end
 
-    # Checks wether a comment is spam or not.
+    # Checks if a comment is spam.
     # 
     # Required attributes:
     # 
@@ -119,19 +51,19 @@ class Akismet
       call('comment-check', attributes, request) == "true"
     end
 
-    # Returns true unless comment is spam. Accepts the same arguments than spam.
+    # Checks if a comment is ham. Takes the same arguments than spam?.
     def ham?(attributes, request = nil)
       call('comment-check', attributes, request) == "false"
     end
 
     # Submits a spam comment to Akismet that hadn't been recognized
-    # as spam. Takes the same attributes than spam.
+    # as spam. Takes the same attributes than spam?.
     def submit_spam(attributes)
       call('submit-spam', attributes)
     end
 
     # Submits a false-positive comment as non-spam to Akismet.
-    # Takes the same attributes than spam.
+    # Takes the same attributes than +spam+.
     def submit_ham(attributes)
       call('submit-ham', attributes)
     end
@@ -142,18 +74,19 @@ class Akismet
       end
   end
 
-  def initialize(command, attributes, request = nil) # :nodoc:
+  def initialize(command, attributes, request = nil)
     @command    = command
     @attributes = attributes
     @request    = request
   end
 
-  def call # :nodoc:
+  def call
     http = Net::HTTP.new(http_host, 80)
     http.post(http_path, post_attributes, http_headers).body
   end
 
   private
+    # TODO: Extract more relevant HTTP headers.
     def attributes
       @attributes[:blog] ||= @@blog
       

data/test/akismet_test.rb

@@ -1,6 +1,7 @@
 require 'test/unit'
 require File.expand_path("../../lib/akismet.rb", __FILE__)
 
+# TODO: Test with an ActionDispatch::TestRequest object.
 class AkismetTest < Test::Unit::TestCase
   def setup
     Akismet.host = 'api.antispam.typepad.com'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-akismet
 version: !ruby/object:Gem::Version 
-  hash: 57
+  hash: 63
   prerelease: false
   segments: 
   - 0
   - 9
-  - 1
-  version: 0.9.1
+  - 2
+  version: 0.9.2
 platform: ruby
 authors: 
 - Julien Portalier