akismet 1.0.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 21be3c8269a6a3727bbe1760d106b450cb7bc48d
-  data.tar.gz: 92ff9426460df5eed3b240d577375323f0a668c4
+  metadata.gz: 00663d1516528ee39d7e814ea5393f177802be86
+  data.tar.gz: 99dccbfcabb40bd23a8e9239503eee9885e6c4f3
 SHA512:
-  metadata.gz: 82c9fbcc9d514619e2c19c3a4b12625e7e8744b98746910346fd562bc527401ff22d7fa0871fd785af44697375ed261645a599acd5471e75dec4f95b97e40d54
-  data.tar.gz: 0f5f1f79dd1525f89627a41f857d78713ccfd3ff69aae9c6ac7e8be85777165a822a4e959c997427d5727e5b85d914fea564f1ce138e9cd70fc1ff98c2dfaa33
+  metadata.gz: d235bdf6c5346a477295d3285d8fcfd56079edead6287b7001e1f5e4d6156920480fa4e066a8e8bcf12ba78f34a533b762e11b9c85068e1fee5faea47a6212ad
+  data.tar.gz: bcadc97707e2fe6a250e9cce4f2093cb3e6303a26536d9527a3eb07710cc79802c1663e6b13f77a8b5ea697c7ddb8053e27bda282427acdace04c9282803751a

data/.yardopts

@@ -0,0 +1,4 @@
+--no-private
+-
+README.md
+LICENSE.txt

data/README.md

@@ -1,68 +1,123 @@
-Akismet
-=======
-
-A Ruby client for the Akismet API.
-
-Instantiate an `Akismet::Client` with your API key and home page URL. Then
-call `verify_key`, `comment_check`, `submit_ham`, or `submit_spam`.
-
-Use `Akismet::Client.open` or `Akismet::Client#open` to submit multiple
-requests over a single TCP connection.
-
-See lib/akismet/client.rb for more documentation or generate docs with YARD. 
-
-Verify an API key
------------------
-
-    Akismet::Client.new( 'apikey123', 'http://jonahb.com' ).verify_key
-
-
-Check whether a comment is spam
--------------------------------
-
-    client = Akismet::Client.new( 'apikey123',
-      'http://jonahb.com',
-      :app_name => 'jonahb.com',
-      :app_version => '1.0' )
-
-    # assumes variables comment, post_url, request (a racklike HTTP request)
-    spam = client.comment_check( request.remote_ip,
-      request.user_agent,
-      :content_type => 'comment',
-      :referrer => request.headers[ 'HTTP_REFERER' ],
-      :permalink => post_url, 
-      :comment_author => comment.author,
-      :comment_author_email => comment.author_email,
-      :comment_content => comment.body )
-
-    if spam
-      # ...
-    end 
-
-Submit a batch of checks using a single TCP connection
-------------------------------------------------------
-
-    client = Akismet::Client.new( 'apikey123',
-      'http://jonahb.com',
-      :app_name => 'jonahb.com',
-      :app_version => '1.0' )
-
-    begin
-      client.open
-      comments.each do |comment|
-        client.comment_check( ... )  # see example above
-      end
-    ensure
-      client.close
-    end
-
-    # ... or ...
-
-    Akismet::Client.open( 'apikey123',
-      'http://jonahb.com',
-      :app_name => 'jonahb.com',
-      :app_version => '1.0' ) do |client|
-      comments.each do |comment|
-        client.comment_check( ... )  # see example above
-      end
-    end
+# akismet
+
+A Ruby client for the [Akismet API](http://akismet.com/development/api/).
+
+[![Gem Version](https://badge.fury.io/rb/akismet.svg)](http://badge.fury.io/rb/akismet)
+[![Build Status](https://travis-ci.org/jonahb/akismet.svg?branch=master)](https://travis-ci.org/jonahb/akismet)
+
+## Getting Started
+
+### Installation
+
+```bash
+gem install akismet
+```
+
+### Documentation
+
+This README provides an overview of `akismet`. Full documentation is
+available at [rubydoc.info](http://www.rubydoc.info/gems/akismet).
+
+### API Key
+
+Sign up at [akismet.com](https://akismet.com/) and retrieve your API
+key from your [account page](https://akismet.com/account/).
+
+## Usage
+
+### Basics
+
+Set your API key and app URL (a URL representing your app):
+
+```ruby
+Akismet.api_key = '<your API key>'
+Akismet.app_url = 'http://example.com'
+```
+
+Then check whether a comment is spam ...
+
+```ruby
+# request is a Rack::Request
+is_spam = Akismet.spam?(request.ip, request.user_agent, text: 'Poppycock!')
+```
+
+... file a spam report ...
+
+```ruby
+Akismet.spam request.ip, request.user_agent, text: 'I earn $2,000 a week ...'
+```
+
+... or flag a false positive ("ham" is not-spam):
+
+```ruby
+Akismet.ham request.ip, request.user_agent, text: '"Viagra" derives from the Sanskrit ...'
+```
+
+### Accuracy
+
+To maximize the accuracy of the filter, submit as many of the [documented](http://www.rubydoc.info/gems/akismet) parameters as possible. Also submit environment variables related to the comment as a hash in the `env` parameter (Akismet suggests [these variables](http://php.net/manual/en/reserved.variables.server.php)):
+
+```ruby
+vars = %w{
+  HTTP_ACCEPT
+  HTTP_ACCEPT_ENCODING
+  # ...
+}
+
+params = {
+  type: 'comment',
+  text: 'A new life awaits you in the Off-World colonies.',
+  created_at: DateTime.now,
+  author: 'Eldon',
+  author_email: 'eldont@aol.com',
+  author_url: 'http://geocities.com/eldont',
+  post_url: 'http://example.com/posts/1',
+  post_modified_at: DateTime.new(2015, 1, 1),
+  referrer: request.referrer,
+  env: request.env.slice(*vars) # slice courtesy of Active Support
+}
+
+is_spam = Akismet.spam?(request.ip, request.user_agent, params)
+```
+### Blatant Spam
+
+Akismet flags blatant spam that should be deleted without review. This feature is exposed via `Akismet.check`:
+
+```ruby
+is_spam, is_blatant = Akismet.check(request.ip, request.user_agent, text: 'Buy everything ... now!')
+```
+
+### Reusing Connections
+
+`Akismet.spam?` and friends create a new TCP connection each time you call them. If you have many comments to check or report, use `Akismet.open` to reuse a single connection:
+
+```ruby
+Akismet.open do |client|
+  for comment in comments
+    is_spam = client.spam?(comment.ip, comment.user_agent, text: comment.text)
+  end
+end
+```
+
+### Akismet::Client
+
+In the example above, the object yielded to the block is an `Akismet::Client`. `Akismet::Client` underlies the `Akismet` class methods. Use it on its own to manually open and close connections or override the global API key:
+
+```ruby
+begin
+  client = Akismet::Client.new('api-key-2', 'http://example2.com')
+  client.open
+  client.spam request.ip, request.user_agent, text: 'Bank error in your favor!'
+ensure
+  client.close
+end
+```
+
+## Tests
+
+1. Set the environment variable AKISMET\_API\_KEY to your API key
+2. `rake`
+
+## Contributing
+
+Please submit issues and pull requests to [jonahb/akismet](https://github.com/jonahb/akismet) on GitHub.

data/lib/akismet.rb

@@ -3,5 +3,65 @@
   error
   client
 }.each do |file|
-  require File.join( File.dirname( __FILE__ ), 'akismet', file )
-end
+  require "akismet/#{file}"
+end
+
+# {Akismet} provides convenience methods that instantiate a {Akismet::Client}
+# and invoke the Akismet API in one call. Before calling these methods, set
+# {api_key} and {app_url}.
+#
+module Akismet
+  class << self
+
+    # The API key obtained at akismet.com. Set before calling the {Akismet}
+    # class methods.
+    # @return [String]
+    attr_accessor :api_key
+
+    # A URL that identifies the application making the request. Set before
+    # calling the {Akismet} class methods.
+    # @return [String]
+    attr_accessor :app_url
+
+    # The name of the application making the request
+    # @return [String]
+    attr_accessor :app_name
+
+    # The version of the application making the request
+    # @return [String]
+    attr_accessor :app_version
+
+    # (see Client#check)
+    def check(user_ip, user_agent, params = {})
+      with_client { |client| client.check user_ip, user_agent, params }
+    end
+
+    # (see Client#spam?)
+    def spam?(user_ip, user_agent, params = {})
+      with_client { |client| client.spam? user_ip, user_agent, params }
+    end
+
+    # (see Client#spam)
+    def spam(user_ip, user_agent, params = {})
+      with_client { |client| client.spam user_ip, user_agent, params }
+    end
+
+    # (see Client#ham)
+    def ham(user_ip, user_agent, params = {})
+      with_client { |client| client.ham user_ip, user_agent, params }
+    end
+
+    # (see Client.open)
+    def open(&block)
+      with_client(&block)
+    end
+
+    private
+
+    def with_client(&block)
+      raise "Set Akismet.api_key" unless api_key
+      raise "Set Akismet.app_url" unless app_url
+      Akismet::Client.open api_key, app_url, app_name: app_name, app_version: app_version, &block
+    end
+  end
+end

data/lib/akismet/client.rb

@@ -1,166 +1,108 @@
+require 'date'
 require 'net/http'
-require 'cgi'
+require 'uri'
 
 module Akismet
 
-  # A Ruby client for the Akismet API.
-  #
-  # @example
-  #
-  #   # Verify an API key
-  #   #
-  #
-  #   Akismet::Client.new( 'apikey123', 'http://jonahb.com' ).verify_key
-  #
-  # @example
-  #
-  #   # Check whether a comment is spam
-  #   #
-  #
-  #   client = Akismet::Client.new( 'apikey123',
-  #     'http://jonahb.com',
-  #     :app_name => 'jonahb.com',
-  #     :app_version => '1.0' )
-  #
-  #   # assumes variables comment, post_url, request (a racklike HTTP request)
-  #   spam = client.comment_check( request.remote_ip,
-  #     request.user_agent,
-  #     :content_type => 'comment',
-  #     :referrer => request.headers[ 'HTTP_REFERER' ],
-  #     :permalink => post_url,
-  #     :comment_author => comment.author,
-  #     :comment_author_email => comment.author_email,
-  #     :comment_content => comment.body )
-  #
-  #   if spam
-  #     # ...
-  #   end
-  #
-  # @example
-  #
-  #   # Submit a batch of checks using a single TCP connection
-  #   #
-  #
-  #
-  #   client = Akismet::Client.new( 'apikey123',
-  #     'http://jonahb.com',
-  #     :app_name => 'jonahb.com',
-  #     :app_version => '1.0' )
-  #
-  #   begin
-  #     client.open
-  #     comments.each do |comment|
-  #       client.comment_check( ... )  # see example above
-  #     end
-  #   ensure
-  #     client.close
-  #   end
-  #
-  #   # ... or ...
-  #
-  #   Akismet::Client.open( 'apikey123',
-  #     'http://jonahb.com',
-  #     :app_name => 'jonahb.com',
-  #     :app_version => '1.0' ) do |client|
-  #     comments.each do |comment|
-  #       client.comment_check( ... )  # see example above
-  #     end
-  #   end
-  #
-  #
   class Client
 
-    # The API key obtained at akismet.com.
+    # The API key obtained at akismet.com
     # @return [String]
-    #
     attr_reader :api_key
 
-
-    # The URL of the home page of the application making the request.
+    # A URL that identifies the application making the request
     # @return [String]
-    #
-    attr_reader :home_url
+    attr_reader :app_url
 
-
-    # The name of the application making the request, e.g "jonahb.com".
+    # The name of the application making the request
     # @return [String]
-    #
     attr_reader :app_name
 
-
-    # The version of the application making the request, e.g. "1.0".
+    # The version of the application making the request
     # @return [String]
-    #
     attr_reader :app_version
 
+    # @!group Constructors
 
     # @param [String] api_key
-    #   The API key obtained at akismet.com.
-    # @param [String] home_url
-    #   The URL of the home page of the application making the request.
+    #   The API key obtained at akismet.com
+    # @param [String] app_url
+    #   The URL of the home page of the application making the request
     # @option options [String] :app_name
     #   The name of the application making the request, e.g. "jonahb.com".
     #   Forms part of the User-Agent header submitted to Akismet.
     # @option options [String] :app_version
     #   The version of the application making the request, e.g. "1.0". Forms
     #   part of the User-Agent header submitted to Akismet. Ignored if
-    #   :app_name is not privded.
+    #   :app_name is not provided.
     #
-    def initialize( api_key, home_url, options = {} )
+    def initialize(api_key, app_url, options = {})
       @api_key = api_key
-      @home_url = home_url
+      @app_url = app_url
       @app_name = options[ :app_name ]
       @app_version = options[ :app_version ]
+      @http_session = nil
     end
 
+    # @!group Managing Connections
 
-    # Yields a new open Client, closing the Client when the block returns.
-    # Takes the same arguments as {#initialize}. Use for submitting a batch of
-    # requests using a single TCP and HTTP session.
-    #
-    # @yield [Akismet::Client]
-    # @return [nil]
-    # @see #initialize
+    # Initializes a client, opens it, yields it to the given block, and closes
+    # it when the block returns. Allows you to perform several operations over
+    # a single TCP connection.
+    # @param (see #initialize)
+    # @option (see #initialize)
+    # @yieldparam [Client] client
+    # @return [Object]
+    #   The return value of the block
     # @see #open
     #
-    def self.open( api_key, home_url, options = {} )
+    def self.open(api_key, app_url, options = {})
       raise "Block required" unless block_given?
-      client = nil
-      begin
-        client = new( api_key, home_url, options )
-        client.open
-        yield client
-      ensure
-        client.close if client
-      end
-      nil
+      client = new(api_key, app_url)
+      client.open { yield client }
     end
 
-
-    # Opens the client. You may use this method in combination with {#close}
-    # to submit a batch of requests using a single TCP and HTTP session.
+    # Opens the client, creating a new TCP connection.
     #
-    # If you don't call this before calling {#comment_check}, {#submit_ham},
-    # or {#submit_spam}, a session will be created and opened for the duration
-    # of the call.
+    # If a block is given, yields to the block, closes the client when the
+    # block returns, and returns the return value of the block. If a
+    # block is not given, returns self and leaves the client open, relying on
+    # the caller to close the client with {#close}.
     #
-    # Note that calls to {#verify_key} always create a session. This is due to
-    # a peculiarity of the Akismet API where {#verify_key} requests must be
-    # sent to a different host.
+    # Note that opening and closing the client is only required if you want to
+    # make several calls over one TCP connection. Otherwise, you can simply
+    # call {#spam?}, {#check}, {#ham}, or {#spam}, which call {#open} for you
+    # if necessary.
     #
-    # @return [self]
-    # @raise [RuntimeError]
-    #   The client is already open.
-    # @see #close
-    # @see Akismet::Client.open
+    # Due to a peculiarity of the Akismet API, {#verify_key} always creates its
+    # own connection.
+    #
+    # @overload open
+    #   Opens the client, yields to the block, and closes the client when the
+    #   block returns.
+    #   @yield
+    #     A block to be called when the client is open
+    #   @return [Object]
+    #     The return value of the block
+    #   @raise [StandardError]
+    #     The client is already open    
+    # @overload open
+    #   @return [self]
+    #   @raise [StandardError]
+    #     The client is already open
     #
     def open
       raise "Already open" if open?
+
       @http_session = Net::HTTP.new( "#{ api_key }.rest.akismet.com", 80 )
-      @http_session.start
-      self
-    end
 
+      begin
+        @http_session.start
+        block_given? ? yield : self
+      ensure
+        close if block_given?
+      end
+    end
 
     # Closes the Client.
     # @return [self]
@@ -172,122 +114,141 @@ module Akismet
       self
     end
 
-
     # Whether the Client is open.
-    # @return [boolean]
+    # @return [Boolean]
     #
     def open?
       @http_session && @http_session.started?
     end
 
+    # @!group Verifying Keys
 
     # Checks the validity of the API key.
-    # @return [boolean]
+    # @return [Boolean]
     #
     def verify_key
-      response = Net::HTTP.start( 'rest.akismet.com', 80 ) do |session|
-        invoke( session, 'verify-key', :blog => home_url, :key => api_key )
+      response = Net::HTTP.start('rest.akismet.com', 80) do |session|
+        invoke session, 'verify-key', blog: app_url, key: api_key
       end
 
-      unless %w{ valid invalid }.include?( response.body )
+      unless %w{ valid invalid }.include?(response.body)
         raise_with_response response
       end
 
       response.body == 'valid'
     end
 
-
-    # Checks whether a comment is spam. You are encouraged the submit, in
-    # addition to the documented parameters, data about the client and the
-    # comment submission. For example, if the client is an HTTP server,
-    # include HTTP headers and environment variables.
+    # @!macro akismet_method
+    #   @param [String] user_ip
+    #     The comment author's IP address
+    #   @param [String] user_agent
+    #     The comment author's user-agent
+    #   @param [Hash{Symbol => Object}] params
+    #     Optional parameters. To maximize accuracy, pass as many as possible.
+    #   @option params [String] :referrer
+    #     The value of the HTTP_REFERER header. Note that the parameter is
+    #     spelled with two consecutive 'r's.
+    #   @option params [String] :post_url
+    #     The URL of the post, article, etc. on which the comment was made
+    #   @option params [DateTime] :post_modified_at
+    #     The date and time the post was last modified
+    #   @option params [String] :type
+    #     Suggested values include 'comment', 'trackback', and 'pingback'
+    #   @option params [String] :text
+    #     The text of the comment
+    #   @option params [DateTime] :created_at
+    #     The date and time the comment was created
+    #   @option params [String] :author
+    #     The comment author's name
+    #   @option params [String] :author_email
+    #     The comment author's email address
+    #   @option params [String] :author_url
+    #     The comment author's personal URL
+    #   @option params [Array<String>] :languages
+    #     The ISO 639-1 codes of the languages in use on the site where the
+    #     comment appears
+    #   @option params [Boolean] :test
+    #     When set to true, Akismet does not use the comment to train the filter
+    #   @option params [Hash{Symbol, String => Object}] :env
+    #     Environment variables such as HTTP headers related to the comment
+    #     submission
+    #   @raise [Akismet::Error]
+    #     The Akismet service returned an error
+    #   @raise [ArgumentError]
+    #     An environment variable conflicts with a built-in parameter
+    #   @raise [ArgumentError]
+    #     Invalid param
+
+    # @!group Checking
+
+    # Checks whether a comment is spam and whether it is "blatant."
+    # @!macro akismet_method
+    # @return [(Boolean, Boolean)]
+    #   An array containing two booleans. The first indicates whether the
+    #   comment is spam. The second indicates whether it is "blatant,"
+    #   i.e. whether it can be deleted without review.
     #
-    # If the Client is not open, opens it for the duration of the call.
-    #
-    # @return [boolean]
-    # @raise [Akismet::Error]
-    # @param [String] user_ip
-    #   The IP address of the submitter of the comment.
-    # @param [String] user_agent
-    #   The user agent of the web browser submitting the comment. Typically
-    #   the HTTP_USER_AGENT CGI variable. Not to be confused with the user
-    #   agent of the Akismet library.
-    # @option params [String] :referrer
-    #   The value of the HTTP_REFERER header. Note that the parameter is
-    #   spelled with two consecutive 'r's.
-    # @option params [String] :permalink
-    #   The permanent URL of the entry to which the comment pertains.
-    # @option params [String] :comment_type
-    #   'comment', 'trackback', 'pingback', or a made-up value like
-    #   'registration'
-    # @option params [String] :comment_author
-    #   The name of the author of the comment.
-    # @option params [String] :comment_author_email
-    #   The email address of the author of the comment.
-    # @option params [String] :comment_author_url
-    #   A URL submitted with the comment.
-    # @option params [String] :comment_content
-    #   The text of the comment.
-    #
-    def comment_check( user_ip, user_agent, params = {} )
-      response = invoke_comment_method( 'comment-check',
+    def check(user_ip, user_agent, params = {})
+      response = invoke_comment_method('comment-check',
         user_ip,
         user_agent,
-        params )
+        params)
 
-      unless %w{ true false }.include?( response.body )
+      unless %w{ true false }.include?(response.body)
         raise_with_response response
       end
 
-      response.body == 'true'
+      [
+        response.body == 'true',
+        response['X-akismet-pro-tip'] == 'discard'
+      ]
     end
+    alias_method :comment_check, :check
 
-
-    # Submits a comment that has been identified as not-spam (ham). Takes
-    # the same arguments as {#comment_check}. If the Client is not open, opens
-    # it for the duration of the call.
+    # Checks whether a comment is spam.
+    # @!macro akismet_method
+    # @return [Boolean]
     #
-    # @return [nil]
-    # @raise [Akismet::Error]
-    # @see #comment_check
+    def spam?(user_ip, user_agent, params = {})
+      check(user_ip, user_agent, params)[0]
+    end
+
+    # @!group Reporting
+
+    # Submits a comment that has been identified as not-spam (ham).
+    # @!macro akismet_method
+    # @return [void]
     #
-    def submit_ham( user_ip, user_agent, params = {} )
-      response = invoke_comment_method( 'submit-ham',
+    def ham(user_ip, user_agent, params = {})
+      response = invoke_comment_method('submit-ham',
         user_ip,
         user_agent,
-        params )
+        params)
 
       unless response.body == 'Thanks for making the web a better place.'
         raise_with_response response
       end
-
-      nil
     end
+    alias_method :submit_ham, :ham
 
-
-    # Submits a comment that has been identified as spam. Takes the same
-    # arguments as {#comment_check}. If the Client is not open, opens it for
-    # the duration of the call.
+    # Submits a comment that has been identified as spam.
+    # @!macro akismet_method
+    # @return [void]
     #
-    # @return [nil]
-    # @raise [Akismet::Error]
-    # @see #comment_check
-    #
-    def submit_spam( user_ip, user_agent, params = {} )
-      response = invoke_comment_method( 'submit-spam',
+    def spam(user_ip, user_agent, params = {})
+      response = invoke_comment_method('submit-spam',
         user_ip,
         user_agent,
-        params )
+        params)
 
       unless response.body == 'Thanks for making the web a better place.'
         raise_with_response response
       end
-
-      nil
     end
+    alias_method :submit_spam, :spam
 
 
-  private
+    private
 
 
     # Yields an HTTP session to the given block. Uses this instance's open
@@ -296,54 +257,49 @@ module Akismet
     # @yield [Net::HTTP]
     #
     def in_http_session
-      raise "Block required" unless block_given?
       if open?
         yield @http_session
       else
-        begin
-          open
-          yield @http_session
-        ensure
-          close
-        end
+        open { yield @http_session }
       end
     end
 
-
-    # Raises an error given a response. The Akismet documentation states that
-    # the HTTP headers of the response may contain error strings. I can't
-    # seem to find them, so for now just raise an unknown error.
     # @param [Net::HTTPResponse] response
-    #
     def raise_with_response( response )
-      raise Error.new( Error::UNKNOWN, 'Unknown error' )
+      raise Error, response['X-akismet-debug-help'] || 'Unknown error'
     end
 
-
     # @param [String] method_name
     # @param [String] user_ip
     # @param [String] user_agent
     # @param [Hash] params
     # @return [Net::HTTPResponse]
-    # @raise [Akismet::Error]
-    #   The API key is invalid.
+    # @raise [ArgumentError]
+    #   An environment variable conflicts with a built-in parameter
+    # @raise [ArgumentError]
+    #   Invalid parameter
     #
-    def invoke_comment_method( method_name, user_ip, user_agent, params = {} )
-      params = params.merge :blog => home_url,
-        :user_ip => user_ip,
-        :user_agent => user_agent
+    def invoke_comment_method(method_name, user_ip, user_agent, params = {})
+      env = params[:env] || {}
 
-      response = in_http_session do |session|
-        invoke( session, method_name, params )
+      for key in env.keys
+        if PARAM_TO_API_PARAM.has_value?(key.to_sym)
+          raise ArgumentError, "Environment variable '#{key}' conflicts with built-in API parameter"
+        end
       end
 
-      if response.body == 'invalid'
-        raise Error.new( Error::INVALID_API_KEY, 'Invalid API key' )
+      params = params.each_with_object(Hash.new) do |(name, value), api_params|
+        next if name == :env
+        api_name = PARAM_TO_API_PARAM[name] || raise(ArgumentError, "Invalid param: #{name}")
+        api_params[api_name] = value
       end
 
-      response
-    end
+      params = env.merge(params).merge(blog: app_url, user_ip: user_ip, user_agent: user_agent)
 
+      in_http_session do |session|
+        invoke session, method_name, params
+      end
+    end
 
     # @param [Net::HTTP] http_session
     #   A started HTTP session
@@ -352,10 +308,16 @@ module Akismet
     # @raise [Akismet::Error]
     #   An HTTP response other than 200 is received.
     #
-    def invoke( http_session, method_name, params = {} )
-      response = http_session.post( "/1.1/#{ method_name }",
-        url_encode( params ),
-        http_headers )
+    def invoke(http_session, method_name, params = {})
+      params[:blog_charset] = 'UTF-8'
+
+      params = params.collect do |name, value|
+        [name.to_s.encode('UTF-8'), format(value).encode('UTF-8')]
+      end
+
+      response = http_session.post("/1.1/#{ method_name }",
+        URI.encode_www_form(params),
+        http_headers)
 
       unless response.is_a?( Net::HTTPOK )
         raise Error, "HTTP #{ response.code } received (expected 200)"
@@ -364,46 +326,66 @@ module Akismet
       response
     end
 
+    # @param [Object] object
+    # @return [String]
+    def format(object)
+      case object
+      when DateTime
+        object.iso8601
+      when TrueClass
+        '1'
+      when FalseClass
+        '0'
+      when Array
+        object.collect { |element| format(element) }.join(', ')
+      else
+        object.to_s
+      end
+    end
 
     # @return [Hash]
-    #
     def http_headers
-      { 'User-Agent' => user_agent }
+      {
+        'User-Agent' => user_agent,
+        'Content-Type' => 'application/x-www-form-urlencoded'
+      }
     end
 
-
-    # @return [String]
-    #
-    def url_encode( hash = {} )
-      hash.collect do |k, v|
-        "#{ CGI.escape( k.to_s ) }=#{ CGI.escape( v.to_s ) }"
-      end.join( "&" )
-    end
-
-
     # From the Akismet documentation:
     #   If possible, your user agent string should always use the following
     #   format: Application Name/Version | Plugin Name/Version
     # @return [String]
     #
     def user_agent
-      [ user_agent_app, user_agent_plugin ].compact.join( " | " )
+      [user_agent_app, user_agent_plugin].compact.join(" | ")
     end
 
-
     # Returns nil if the Client was instantiated without an app_name.
     # @return [String]
     #
     def user_agent_app
-      app_name && [ app_name, app_version ].compact.join( "/" )
+      app_name && [app_name, app_version].compact.join("/")
     end
 
-
     # @return [String]
-    #
     def user_agent_plugin
       "Ruby Akismet/#{ Akismet::VERSION }"
     end
 
+    PARAM_TO_API_PARAM = {
+      referrer: :referrer,
+      post_url: :permalink,
+      post_modified_at: :comment_post_modified_gmt,
+      text: :comment_content,
+      created_at: :comment_date_gmt,
+      type: :comment_type,
+      author: :comment_author,
+      author_url: :comment_author_url,
+      author_email: :comment_author_email,
+      languages: :blog_lang,
+      user_role: :user_role,
+      test: :is_test,
+    }
+
   end
-end
+end

data/lib/akismet/error.rb

@@ -1,23 +1,6 @@
 module Akismet
 
   class Error < StandardError
-
-    UNKNOWN = 1
-    INVALID_API_KEY = 2
-
-    # An error code corresponding to a constant in Akismet::Error.
-    # @return [Integer]
-    attr_reader :code
-
-    # @param [String] message
-    #   A human-readable description of the error.
-    # @param [Integer] code
-    #   An error code corresponding to a constant in Akismet::Error.
-    #
-    def initialize( code, message = nil )
-      super( message )
-      @code = code
-    end
   end
 
-end
+end

data/lib/akismet/version.rb

@@ -1,6 +1,6 @@
 module Akismet
   # The version of the Akismet gem.
-  VERSION = '1.0.2'
+  VERSION = '2.0.0'
 
   # The supported version of the Akismet API.
   API_VERSION = '1.3'

metadata

@@ -1,22 +1,66 @@
 --- !ruby/object:Gem::Specification
 name: akismet
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Jonah Burke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-07 00:00:00.000000000 Z
-dependencies: []
-description: A Ruby client for the Akismet API
-email: jonah@jonahb.com
+date: 2015-02-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+description: 
+email:
+- jonah@jonahb.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- MIT-LICENSE
+- ".yardopts"
+- LICENSE.txt
 - README.md
 - lib/akismet.rb
 - lib/akismet/client.rb
@@ -34,7 +78,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -42,8 +86,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A Ruby client for the Akismet API
 test_files: []
+has_rdoc: