defender 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,23 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+doc
+.yardoc
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Henrik Hodne
+
+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.rdoc

@@ -0,0 +1,24 @@
+= defender
+
+This is a Ruby wrapper of the Defensio[http://defensio.com] spam filtering API. To use this library, you need an API key from Defensio. Go ahead and {get one}[http://defensio.com/signup/].
+
+== Testing
+
+To run the tests, you need to pass the api key and owner url with the environment keys API_KEY and API_OWNER_URL, like this:
+  rake spec API_KEY="key1234" API_OWNER_URL="http://myblog.com"
+The tests will fail with invalid keys and urls.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+  bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Henrik Hodne. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,69 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "defender"
+    gem.summary = %Q{Ruby API wrapper for Defensio}
+    gem.description = %Q{A wrapper of the Defensio spam filtering service.}
+    gem.email = "henrik.hodne@binaryhex.com"
+    gem.homepage = "http://github.com/dvyjones/defender"
+    gem.authors = ["Henrik Hodne"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "yard", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+begin
+  require 'reek/adapters/rake_task'
+  Reek::RakeTask.new do |t|
+    t.verbose = false
+    t.source_files = 'lib/**/*.rb'
+  end
+rescue LoadError
+  task :reek do
+    abort "Reek is not available. In order to run reek, you must: sudo gem install reek"
+  end
+end
+
+begin
+  require 'roodi'
+  require 'roodi_task'
+  RoodiTask.new do |t|
+    t.verbose = false
+  end
+rescue LoadError
+  task :roodi do
+    abort "Roodi is not available. In order to run roodi, you must: sudo gem install roodi"
+  end
+end
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/defender.rb

@@ -0,0 +1,328 @@
+require 'yaml'
+require 'net/http'
+
+class Defender
+  # The Defensio API version currently supported by Defender
+  API_VERSION = "1.2"
+  
+  DEFAULT_OPTIONS = {
+    service_type: "blog",
+    api_key: "",
+    owner_url: ""
+  }
+  
+  ##
+  # Raised if an invalid or no API key is given
+  class APIKeyError < StandardError; end
+  
+  ##
+  # The response from the {Defender#audit_comment} method. Should only be
+  # initialized by the library.
+  class CommentResponse
+    ##
+    # A message signature that uniquely identifies the comment in the Defensio
+    # system. This signature should be stored by the client for retraining
+    # purposes.
+    attr_reader :signature
+    
+    ##
+    # A value indicating the relative likelihood of the comment being spam.
+    # This value should be stored by the client for use in building convenient
+    # spam sorting user-interfaces.
+    #
+    # @return [Float] A value between 0 and 1.
+    attr_reader :spaminess
+    
+    ##
+    # Initialize a CommentResponse. Should only be called by the library.
+    #
+    # @param [Hash] response The response from the audit-comment call.
+    def initialize(response)
+      @signature = response["signature"]
+      @spam = response["spam"]
+      @spaminess = response["spaminess"].to_f
+    end
+    
+    ##
+    # Returns true if Defensio marked the comment as spam, returns false
+    # otherwise.
+    #
+    # @return [Boolean]
+    def spam?
+      @spam
+    end
+    
+    def to_s
+      @signature
+    end
+  end
+  
+  ##
+  # The response from the {Defender#statistics} method. Should only be
+  # initialized by the library.
+  class Statistics
+    ##
+    # Describes the percentage of comments correctly identified as spam/ham by
+    # Defensio on this blog.
+    #
+    # @return [Float<0..1>]
+    attr_reader :accuracy
+    
+    ##
+    # The number of spam comments caught by the filter.
+    attr_reader :spam
+    
+    ##
+    # The number of ham (legitimate) comments accepted by the filter.
+    attr_reader :ham
+    
+    ##
+    # The number of times a legitimate message was retrained from the spambox
+    # (i.e. "de-spammed" by the user)
+    attr_reader :false_positives
+    
+    ##
+    # The number of times a spam message was retrained from comments box (i.e.
+    # "de-legitimized" by the user)
+    attr_reader :false_negatives
+    
+    ##
+    # A boolean value indicating whether Defensio is still in its initial
+    # learning phase.
+    #
+    # @return [Boolean]
+    attr_reader :learning
+    
+    ##
+    # More details on the reason(s) why Defensio is still in its initial
+    # learning phase.
+    attr_reader :learning_status
+    
+    def initialize(response)
+      @accuracy = response["accuracy"]
+      @spam = response["spam"]
+      @ham = response["ham"]
+      @false_positives = response["false-positives"]
+      @false_negatives = response["false-negatives"]
+      @learning = response["learning"]
+      @learning_status = response["learning-status"]
+    end
+  end
+  
+  attr_accessor :service_type, :api_key, :owner_url
+  
+  ##
+  # Raises a StandardError with the error message from Defensio if the
+  # response is a "failed" one.
+  #
+  # @param [Hash] response The return value from {#call_action}.
+  def self.raise_if_error(response)
+    if response["status"] == "fail"
+      raise StandardError, response["message"]
+    end
+    response
+  end
+  
+  ##
+  # Converts a hash with symbol keys and underscores to a hash with string
+  # keys and hyphens. Calls #strftime or #to_s on the values.
+  #
+  # @param [Hash] options Input options.
+  # @return [Hash]
+  def self.options_to_parameters(options)
+    opts = {}
+    options.each do |key, value|
+      if value.respond_to?(:strftime)
+        value = value.strftime("%Y/%m/%d")
+      end
+      opts[key.to_s.gsub("_", "-").downcase] = value.to_s
+    end
+    opts
+  end
+
+  ##
+  # Initialize Defender
+  #
+  # @param [Hash] opts The options hash.
+  # @option opts ["blog","app"] :service_type ("blog") The service type. May be
+  #   "app" (use of Defender within an application) or "blog" (use of Defender
+  #   to support a blogging platform).
+  # @option opts [String] :api_key Your API key. This option is required, the
+  #   method calls will fail without it.
+  def initialize(opts={})
+    opts = DEFAULT_OPTIONS.merge(opts)
+    @service_type = opts[:service_type]
+    @api_key = opts[:api_key]
+    @owner_url = opts[:owner_url]
+  end
+  
+  ##
+  # Checks if the given key is valid.
+  #
+  # @return [Boolean]
+  # @see http://defensio.com/api/#validate-key
+  def valid_key?
+    begin
+      response = call_action("validate-key")
+      if response["status"] == "success"
+        return true
+      else
+        return false
+      end
+    rescue StandardError
+      return false
+    end
+  end
+  
+  ##
+  # Announce an article existence. This should (if feasible) be called when an
+  # article or blogpost is created so Defensio can analyse it.
+  #
+  # @param [#to_s] title The title of the article
+  # @param [#to_s] author The name of the author of the article
+  # @param [#to_s] author_email The email address of the person posting the
+  #   article.
+  # @param [#to_s] content The content of the article itself.
+  # @param [#to_s] permalink The permalink of the article just posted.
+  # @raise [StandardError] If the call fails, a StandardError is raised with
+  #   the error message given from Defensio.
+  # @return [Boolean] Returns true if the article was successfully announced,
+  #   raises StandardError otherwise.
+  # @see http://defensio.com/api/#announce-article
+  def announce_article(title, author, author_email, content, permalink)
+    response = call_action("announce-article",
+                           "article-title" => title.to_s,
+                           "article-author" => author.to_s,
+                           "article-author-email" => author_email.to_s,
+                           "article-content" => content,
+                           "permalink" => permalink)
+    true
+  end
+  
+  ##
+  # Check if a comment is spam. This is the central action of Defensio.
+  #
+  # @param [Hash] opts All options are recommended, but only required if noted.
+  # @option opts [#to_s] :user_ip The IP address of whomever is posting the
+  #   comment. This option is required.
+  # @option opts [#to_s, #strftime] :article_date The date the original blog
+  #   article was posted. If a string is given, it must be in the format
+  #   "yyyy/mm/dd". This option is required.
+  # @option opts [#to_s] :comment_author The name of the author of the comment.
+  #   This option is required.
+  # @option opts ["comment", "trackback", "pingback", "other"] :comment_type
+  #   The type of the comment being posted to the blog. This option is required
+  # @option opts [#to_s] :comment_content The actual content of the comment
+  #   (strongly recommended to be included where ever possible).
+  # @option opts [#to_s] :comment_author_email The email address of the person
+  #   posting the comment.
+  # @option opts [#to_s] :comment_author_url The URL of the person posting the
+  #   comment.
+  # @option opts [#to_s] :permalink The permalink of the blog post to which
+  #   the comment is being posted.
+  # @option opts [#to_s] :referrer The URL of the site that brought commenter
+  #   to this page.
+  # @option opts [Boolean] :user_logged_in Whether or not the user posting
+  #   the comment is logged-into the blogging platform
+  # @option opts [Boolean] :trusted_user Whether or not the user is an
+  #   administrator, moderator or editor of this blog; the client should pass
+  #   true only if blogging platform can guarantee that the user has been
+  #   authenticated and has a role of responsibility on this blog.
+  # @option opts [#to_s] :openid The OpenID URL of the currently logged in
+  #   user. Must be used in conjunction with :user_logged_in => true. OpenID
+  #   authentication must be taken care of by your application.
+  # @option opts [#to_s] :test_force For testing purposes only: Use this
+  #   parameter to force the outcome of audit_comment. Optionally affix (with
+  #   a comma) a desired spaminess return value (in the range 0 to 1).
+  #   Example: "spam,0.5000" or "ham,0.0010".
+  # @raise [StandardError] If the call fails, a StandardError is raised with
+  #   the error message given from Defensio.
+  # @return [Defender::CommentResponse]
+  # @see http://defensio.com/api/#audit-comment
+  def audit_comment(opts={})
+    response = call_action("audit-comment", Defender.options_to_parameters(opts))
+    return CommentResponse.new(response)
+  end
+  
+  ##
+  # This action is used to retrain false negatives. False negatives are
+  # comments that were originally tagged as "ham" (i.e. legitimate) but were
+  # in fact spam.
+  # 
+  # @param [Array<#to_s, CommentResponse>] signatures List of signatures (may
+  #   contain a single entry) of the comments to be submitted for retraining.
+  #   Note that a signature for each comment was originally provided by the
+  #   {#audit_comment} method.
+  # @raise [StandardError] If the call fails, a StandardError is raised with
+  #   the error message given from Defensio.
+  # @return [Boolean] Returns true if the comments were successfully marked,
+  #   raises StandardError otherwise.
+  def report_false_negatives(signatures)
+    response = call_action("report-false-negatives",
+                           "signatures" => signatures.map(&:to_s).join(","))
+    true
+  end
+  
+  ##
+  # This action is used to retrain false negatives. False negatives are
+  # comments that were originally tagged as spam but were in fact "ham" (i.e.
+  # legitimate).
+  # 
+  # @param [Array<#to_s, CommentResponse>] signatures List of signatures (may
+  #   contain a single entry) of the comments to be submitted for retraining.
+  #   Note that a signature for each comment was originally provided by the
+  #   {#audit_comment} method.
+  # @raise [StandardError] If the call fails, a StandardError is raised with
+  #   the error message given from Defensio.
+  # @return [Boolean] Returns true if the comments were successfully marked,
+  #   raises StandardError otherwise.
+  def report_false_positives(signatures)
+    response = call_action("report-false-positives",
+                           "signatures" => signatures.map(&:to_s).join(","))
+    true
+  end
+  
+  ##
+  # This action returns basic statistics regarding the performance of Defensio
+  # since activation.
+  #
+  # @return [Defender::Statistics]
+  def statistics
+    response = call_action("get-stats")
+    return Statistics.new(response)
+  end
+  
+  private
+    ##
+    # Returns the url for the given action.
+    #
+    # @param [#to_s] action The action to generate the URL for.
+    # @return [String] The URL for the action.
+    # @raise [APIKeyError] Raises this if no API key is given.
+    def url(action)
+      raise APIKeyError unless @api_key.length > 0
+      "http://api.defensio.com/" \
+      "#{@service_type}/" \
+      "#{Defender::API_VERSION}/" \
+      "#{action}/" \
+      "#{@api_key}.yaml"
+    end
+    
+    ##
+    # Backend function for calling an action.
+    #
+    # @param [#to_s] action The action to call.
+    # @param [Hash] params The parameters for the action.
+    # @return [Hash] The raw response, only parsed from YAML.
+    # @raise [APIKeyError] If an invalid (or no) API key is given, this is
+    #   raised
+    def call_action(action, params={})
+      params = {"owner-url" => @owner_url}.merge(params)
+      response = Net::HTTP.post_form(URI.parse(url(action)), params)
+      if response.code == 400
+        raise APIKeyError
+      else
+        Defender.raise_if_error(YAML.load(response.body)["defensio-result"])
+      end
+    end
+end

data/spec/defender_spec.rb

@@ -0,0 +1,79 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Defender" do
+  it "should raise a StandardError if a method fails" do
+    lambda do
+      Defender.raise_if_error({
+        "status" => "fail",
+        "message" => "Failed!"
+       })
+    end.should raise_error(StandardError, "Failed!")
+  end
+  
+  it "should return the correct URL for any given action" do
+    d = Defender.new(:api_key => "key1234")
+    d.instance_eval do
+      url("foobar")
+    end.should == "http://api.defensio.com/blog/#{Defender::API_VERSION}/foobar/key1234.yaml"
+  end
+  
+  it "should correctly identify a valid API key" do
+    d = Defender.new(:api_key => ENV["API_KEY"], :owner_url => ENV["API_OWNER_URL"])
+    d.valid_key?.should be_true
+  end
+  
+  it "should correctly identify an invalid API key" do
+    d = Defender.new(:api_key => "key1234", :owner_url => ENV["API_OWNER_URL"])
+    d.valid_key?.should be_false
+  end
+  
+  it "should correctly identify a spammy comment" do
+    d = Defender.new(:api_key => ENV["API_KEY"], :owner_url => ENV["API_OWNER_URL"])
+    
+    d.audit_comment(
+      :user_ip => "127.0.0.1",
+      :article_date => Time.now,
+      :comment_author => "Henrik Hodne",
+      :comment_type => "comment",
+      :test_force => "spam,0.5000"
+    ).spam?.should be_true
+  end
+  
+  it "should correctly identify a meaty comment" do
+    d = Defender.new(:api_key => ENV["API_KEY"], :owner_url => ENV["API_OWNER_URL"])
+    
+    d.audit_comment(
+      :user_ip => "127.0.0.1",
+      :article_date => Time.now,
+      :comment_author => "Henrik Hodne",
+      :comment_type => "comment",
+      :test_force => "ham,0.1000"
+    ).spam?.should be_false
+  end
+  
+  it "should correctly set the spaminess" do
+    d = Defender.new(:api_key => ENV["API_KEY"], :owner_url => ENV["API_OWNER_URL"])
+    
+    d.audit_comment(
+      :user_ip => "127.0.0.1",
+      :article_date => Time.now,
+      :comment_author => "Henrik Hodne",
+      :comment_type => "comment",
+      :test_force => "spam,0.5000"
+    ).spaminess.should == 0.5
+  end
+  
+  it "should fail without valid API credentials" do
+    d = Defender.new(:api_key => "key1234", :owner_url => "http://google.com")
+    
+    lambda {
+      d.audit_comment(
+        :user_ip => "127.0.0.1",
+        :article_date => Time.now,
+        :comment_author => "Henrik Hodne",
+        :comment_type => "comment",
+        :test_force => "ham,0.1000"
+      )
+    }.should raise_error(StandardError, "Authentication failed. Please verify your key/owner-url combination.")
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'defender'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: defender
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Henrik Hodne
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-08 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: A wrapper of the Defensio spam filtering service.
+email: henrik.hodne@binaryhex.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/defender.rb
+- spec/defender_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/dvyjones/defender
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Ruby API wrapper for Defensio
+test_files: 
+- spec/spec_helper.rb
+- spec/defender_spec.rb