defender 0.1.0 → 0.1.1

data/README.rdoc

@@ -2,12 +2,6 @@
 
 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.

data/Rakefile

@@ -12,6 +12,7 @@ begin
     gem.authors = ["Henrik Hodne"]
     gem.add_development_dependency "rspec", ">= 1.2.9"
     gem.add_development_dependency "yard", ">= 0"
+    gem.add_development_dependency "mocha", ">= 0.9.8"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/defender.rb

@@ -5,10 +5,12 @@ class Defender
   # The Defensio API version currently supported by Defender
   API_VERSION = "1.2"
   
+  ROOT_URL = "http://api.defensio.com/"
+  
   DEFAULT_OPTIONS = {
-    service_type: "blog",
-    api_key: "",
-    owner_url: ""
+    :service_type => "blog",
+    :api_key => "",
+    :owner_url => ""
   }
   
   ##
@@ -48,13 +50,9 @@ class Defender
     # otherwise.
     #
     # @return [Boolean]
-    def spam?
-      @spam
-    end
+    def spam?; @spam; end
     
-    def to_s
-      @signature
-    end
+    def to_s; @signature; end
   end
   
   ##
@@ -66,47 +64,39 @@ class Defender
     # Defensio on this blog.
     #
     # @return [Float<0..1>]
-    attr_reader :accuracy
+    def accuracy; @response["accuracy"]; end
     
     ##
     # The number of spam comments caught by the filter.
-    attr_reader :spam
+    def spam; @response["spam"]; end
     
     ##
     # The number of ham (legitimate) comments accepted by the filter.
-    attr_reader :ham
+    def ham; @response["ham"]; end
     
     ##
     # The number of times a legitimate message was retrained from the spambox
     # (i.e. "de-spammed" by the user)
-    attr_reader :false_positives
+    def false_positives; @response["false-positives"]; end
     
     ##
     # The number of times a spam message was retrained from comments box (i.e.
     # "de-legitimized" by the user)
-    attr_reader :false_negatives
+    def false_negatives; @response["false-negatives"]; end
     
     ##
     # A boolean value indicating whether Defensio is still in its initial
     # learning phase.
     #
     # @return [Boolean]
-    attr_reader :learning
+    def learning; @response["learning"]; end
     
     ##
     # More details on the reason(s) why Defensio is still in its initial
     # learning phase.
-    attr_reader :learning_status
+    def learning_status; @response["learning-status"]; end
     
-    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
+    def initialize(response); @response = response; end
   end
   
   attr_accessor :service_type, :api_key, :owner_url
@@ -131,11 +121,9 @@ class Defender
   # @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
+    options.each do |key, val|
+      opts[key.to_s.gsub("_", "-").downcase] = val.respond_to?(:strftime) ? 
+        val.strftime("%Y/%m/%d") : val.to_s
     end
     opts
   end
@@ -162,40 +150,27 @@ class Defender
   # @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
+    call_action("validate-key")["status"] == "success" ? true : false
   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
+  # @param [Hash] opts All options are required.
+  # @option opts [#to_s] :article_title The title of the article
+  # @option opts [#to_s] :article_author The name of the author of the article
+  # @option opts [#to_s] :article_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.
+  # @option opts [#to_s] :article_content The content of the article itself.
+  # @option opts [#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)
+  def announce_article(opts={})
+    response = call_action(Defender.options_to_parameters(opts))
     true
   end
   
@@ -258,9 +233,7 @@ class Defender
   # @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
+    report_false(:negatives, signatures)
   end
   
   ##
@@ -277,9 +250,7 @@ class Defender
   # @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
+    report_false(:positives, signatures)
   end
   
   ##
@@ -293,6 +264,12 @@ class Defender
   end
   
   private
+    def report_false(type, signatures)
+      call_action("report-false-#{type}",
+                           "signatures" => signatures.join(","))
+      true
+    end
+  
     ##
     # Returns the url for the given action.
     #
@@ -301,11 +278,7 @@ class Defender
     # @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"
+      "#{ROOT_URL}#{@service_type}/#{API_VERSION}/#{action}/#{@api_key}.yaml"
     end
     
     ##
@@ -317,12 +290,10 @@ class Defender
     # @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
+      response = Net::HTTP.post_form(URI.parse(url(action)),
+        {"owner-url" => @owner_url}.merge(params))
+      response.code == 401 ?
+        raise(APIKeyError) :
         Defender.raise_if_error(YAML.load(response.body)["defensio-result"])
-      end
     end
 end

data/spec/defender_spec.rb

@@ -1,6 +1,10 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe "Defender" do
+  before(:each) do
+    @defender = Defender.new(:api_key => "validkey", :owner_url => "validurl")
+  end
+
   it "should raise a StandardError if a method fails" do
     lambda do
       Defender.raise_if_error({
@@ -11,26 +15,39 @@ describe "Defender" do
   end
   
   it "should return the correct URL for any given action" do
-    d = Defender.new(:api_key => "key1234")
-    d.instance_eval do
+    @defender.instance_eval do
       url("foobar")
-    end.should == "http://api.defensio.com/blog/#{Defender::API_VERSION}/foobar/key1234.yaml"
+    end.should == "http://api.defensio.com/blog/#{Defender::API_VERSION}/foobar/validkey.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
+    @defender.stubs(:call_action).with("validate-key").returns(
+      {"status" => "success", "message" => ""}
+    )
+    @defender.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
+    @defender.stubs(:call_action).with("validate-key").returns(
+      {"status" => "fail", "message" => "Invalid key"}
+    )
+    @defender.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(
+    @defender.
+      stubs(:call_action).
+      with('audit-comment', {
+        "user-ip" => "127.0.0.1",
+        "article-date" => Time.now.strftime("%Y/%m/%d"),
+        "comment-author" => "Henrik Hodne",
+        "comment-type" => "comment",
+        "test-force" => "spam,0.5000",
+      }).
+      returns(
+      {"signature" => "abc123", "spam" => true, "spaminess" => 0.5}
+    )
+    @defender.audit_comment(
       :user_ip => "127.0.0.1",
       :article_date => Time.now,
       :comment_author => "Henrik Hodne",
@@ -40,9 +57,19 @@ describe "Defender" do
   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(
+    @defender.
+      stubs(:call_action).
+      with('audit-comment', {
+        "user-ip" => "127.0.0.1",
+        "article-date" => Time.now.strftime("%Y/%m/%d"),
+        "comment-author" => "Henrik Hodne",
+        "comment-type" => "comment",
+        "test-force" => "ham,0.1000",
+      }).
+      returns(
+      {"signature" => "abc123", "spam" => false, "spaminess" => 0.1}
+    )
+    @defender.audit_comment(
       :user_ip => "127.0.0.1",
       :article_date => Time.now,
       :comment_author => "Henrik Hodne",
@@ -52,9 +79,19 @@ describe "Defender" do
   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(
+    @defender.
+      stubs(:call_action).
+      with('audit-comment', {
+        "user-ip" => "127.0.0.1",
+        "article-date" => Time.now.strftime("%Y/%m/%d"),
+        "comment-author" => "Henrik Hodne",
+        "comment-type" => "comment",
+        "test-force" => "spam,0.5000",
+      }).
+      returns(
+      {"signature" => "abc123", "spam" => true, "spaminess" => 0.5}
+    )
+    @defender.audit_comment(
       :user_ip => "127.0.0.1",
       :article_date => Time.now,
       :comment_author => "Henrik Hodne",
@@ -64,8 +101,16 @@ describe "Defender" do
   end
   
   it "should fail without valid API credentials" do
-    d = Defender.new(:api_key => "key1234", :owner_url => "http://google.com")
-    
+    @defender.
+      stubs(:call_action).
+      with('audit-comment', {
+        "user-ip" => "127.0.0.1",
+        "article-date" => Time.now.strftime("%Y/%m/%d"),
+        "comment-author" => "Henrik Hodne",
+        "comment-type" => "comment",
+        "test-force" => "ham,0.1000",
+      }).
+      raises(StandardError)
     lambda {
       d.audit_comment(
         :user_ip => "127.0.0.1",
@@ -74,6 +119,6 @@ describe "Defender" do
         :comment_type => "comment",
         :test_force => "ham,0.1000"
       )
-    }.should raise_error(StandardError, "Authentication failed. Please verify your key/owner-url combination.")
+    }.should raise_error(StandardError)
   end
 end

data/spec/spec_helper.rb

@@ -3,6 +3,7 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'defender'
 require 'spec'
 require 'spec/autorun'
+require 'mocha'
 
 Spec::Runner.configure do |config|
   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: defender
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Henrik Hodne
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-08 00:00:00 +01:00
+date: 2009-11-09 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,6 +32,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.8
+    version: 
 description: A wrapper of the Defensio spam filtering service.
 email: henrik.hodne@binaryhex.com
 executables: []