defender 2.0.0 → 2.0.1

data/lib/defender/spammable.rb

@@ -44,14 +44,29 @@ module Defender
       #   database and in defensio.
       # @option options [String] :api_key Your Defensio API key. Get one at
       #   defensio.com.
+      # @option options [Boolean] :test_mode Set Defender in test mode. See
+      #   {#test_mode}.
       # 
       def configure_defender(options)
         keys = options.delete(:keys)
         _defensio_keys.merge!(keys) unless keys.nil?
         api_key = options.delete(:api_key)
         Defender.api_key = api_key unless api_key.nil?
+        self.test_mode = options.delete(:test_mode)
       end
       
+      ##
+      # Set this to true to put Defender in "test mode". When in test mode, you
+      # can check if your code is working properly you can specify in the
+      # content field what kind of response you want. If you want a comment to
+      # be marked as spam with a spaminess of 0.85 you write [spam,0.85]
+      # somewhere in the content field of the document. If you want a malicious
+      # response with a spaminess of 0.99 you write [malicious,0.99] and for an
+      # innocent response you write [innocent,0.25]. This is the preferred way
+      # of testing, if you write spammy comments you might hurt the Defensio
+      # performance.
+      attr_accessor :test_mode
+      
       ##
       # Returns the key-attribute mapping used.
       #
@@ -122,7 +137,7 @@ module Defender
         end
         data.merge!({
           'platform' => 'ruby',
-          'type' => 'comment'
+          'type' => (self.class.test_mode ? 'test' : 'comment')
         })
         data.merge!(defensio_data) if defined?(@_defensio_data)
         document = Defender.defensio.post_document(data).last

data/lib/defender/version.rb

@@ -1,4 +1,4 @@
 module Defender
   # Current Defender version
-  VERSION = '2.0.0'
+  VERSION = '2.0.1'
 end

metadata

@@ -1,127 +1,96 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: defender
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 2
-  - 0
-  - 0
-  version: 2.0.0
+version: !ruby/object:Gem::Version
+  version: 2.0.1
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Henrik Hodne
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-01-19 00:00:00 +00:00
+date: 2011-07-02 00:00:00.000000000 +02:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+dependencies:
+- !ruby/object:Gem::Dependency
   name: defensio
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2168669980 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 9
-        - 1
+      - !ruby/object:Gem::Version
         version: 0.9.1
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: activemodel
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2168669980
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: &2168669400 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 3
-        - 0
-        - 0
+      - !ruby/object:Gem::Version
         version: 3.0.0
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: *2168669400
+- !ruby/object:Gem::Dependency
   name: bundler
+  requirement: &2168668920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *2168668920
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2168668400 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 0
-        - 0
-        version: 1.0.0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
-description: An ActiveModel plugin for Defensio.
-email: 
+  prerelease: false
+  version_requirements: *2168668400
+description: 
+email:
 - dvyjones@dvyjones.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- .document
-- .gitignore
-- Gemfile
-- LICENSE
-- README.md
-- Rakefile
-- defender.gemspec
-- lib/defender.rb
+files:
 - lib/defender/defender_error.rb
 - lib/defender/spammable.rb
 - lib/defender/test/comment.rb
 - lib/defender/version.rb
-- spec/defender/spammable_spec.rb
-- spec/fake_defensio.rb
-- spec/spec.opts
-- spec/spec_helper.rb
+- lib/defender.rb
 has_rdoc: true
-homepage: http://rubygems.org/gems/dvyjones
+homepage: 
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
-- - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: ActiveModel plugin for Defensio.
-test_files: 
-- spec/defender/spammable_spec.rb
-- spec/fake_defensio.rb
-- spec/spec.opts
-- spec/spec_helper.rb
+test_files: []

data/.document

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

data/.gitignore

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

data/Gemfile

@@ -1,7 +0,0 @@
-source :rubygems
-
-gemspec
-
-gem 'watchr', '~> 0.7'
-gem 'rspec', '~> 2.1.0'
-gem 'yard', '~> 0.6.3'

data/LICENSE

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

@@ -1,193 +0,0 @@
-Defender
-========
-
-Defender is a wrapper for the [Defensio][0] spam filtering API. From
-their own site:
-
-> More than just another spam filter, Defensio also eliminates malware
-> and other unwanted or risky content to fully protect your blog or Web
-> 2.0 application.
-
-Defensio is able to not only find spam, but also filter profanity and
-other similarities. It can also see the difference between malicious
-material and spammy material.
-
-
-Overview
---------
-
-With Defender you can submit documents to Defensio, which will look for
-spam and malicious content in the documents.
-
-A document contains content to be analyzed by Defensio, or that has been
-analyzed.
-
-To use Defender, you need to retrieve an API key from
-[Defensio][4]. Then add Defender (`gem 'defender'`) to your Gemfile and run
-`bundle install`. To set up Defender, open your Comment class and include
-Defender::Spammable, and configure it by adding your API key. Your comment
-class should look something like this:
-
-    class Comment < ActiveRecord::Base
-      include Defender::Spammable
-      configure_defender :api_key => '0123456789abcdef'
-    end
-
-Now you need to add a few fields to your model. Defender requires a boolean
-field named "spam" (this will be `true` for comments marked as spam, and
-`false otherwise`), and a string field named "defensio_sig" (this will include
-a unique identifier so you can later mark false positives and negatives).
-Defender will also set the spaminess field if it exists (the spaminess field
-should be a float that can range between 0.00 and 1.00, where 0.00 is the
-least spammy and 1.00 is the most spammy). After you've done this, you're
-probably done setting up Defender, although you should read on as there's some
-more things you should know.
-
-Defender will automatically get the comment body, author name, email, IP and
-URL if you have them in your comment class with "standard names". Defender
-will look for fields named "body", "content" and "comment" (in that order) for
-the comment content, "author_name", "author" for the author name,
-"author_email", "email" for the author email, "author_ip", "ip" for the author
-IP, "author_url", "url" for the author URL. Only the comment content is the
-required one of these. If you're not using those attribute names, look further
-down in the readme under "Defining your own attribute names".
-
-Not using ActiveRecord? No problem, Defender supports all libraries that
-support ActiveModel, including Mongoid, MongoMapper and DataMapper. The syntax
-is the exact same, just use the method your library uses to set up the fields
-needed.
-
-
-Defining your own attribute names
----------------------------------
-
-Defensio supports a large amount of attributes you can send to it, and the 
-more you send the more accurately it can determine whether it's spam or not.
-For some of these attributes, Defender will use conventions and try to find
-the attribute, but not all are set up (look at 
-Defender::Spammable::DEFENSIO_KEYS for the exact keys it uses). If you are 
-using other attribute names, or want to add more to get more accurate spam
-evaluation, you do that in the `configure_defender` method. Pass in another
-option called `:keys`, which should be a hash of defensio key names and
-attribute names. The list of defensio key names are after the code example,
-and the attribute name is just a symbol. So if your comment content field is
-called "the_comment_itself", your comment class should look like this:
-
-    class Comment
-      include Defender::Spammable
-      configure_defender :api_key => '0123456789abcdef', :keys => { 'content' => :the_comment_itself }
-    end
-
-If you don't want to store all the information in the database, you can also
-use the `defensio_data` method. In the model, before saving, call
-`defensio_data` with a hash containing the data you want to send. The keys
-should be strings, you can see all the possible values listed below. The
-`defensio_data` method can be called several times with more data.
-
-These are the keys defensio supports (at the time of writing, see
-http://defensio.com/api for a completely up-to-date list):
-
-* **author-email**: The email address of the author of the document.
-* **author-ip**: The IP address of the author of the document.
-* **author-logged-in**: Whether or not the user posting the document is logged
-    onto your Web site, either through your own authentication method or
-    through OpenID.
-* **author-name**: The name of the author of the document.
-* **author-openid**: The OpenID URL of the logged-on user. Must be used in
-    conjunction with user-logged-in=true.
-* **author-trusted**: Whether or not the user is an administrator, moderator,
-    or editor of your Web site. Pass true only if you can guarantee that the
-    user has been authenticated, has a role of responsibility, and can be
-    trusted as a good Web citizen.
-* **author-url**: The URL of the person posting the document.
-* **browser-cookies**: Whether or not the Web browser used to post the
-    document (ie. the comment) has cookies enabled. If no such detection has
-    been made, leave this value empty.
-* **browser-javascript**: Whether or not the Web browser used to post the
-    document (ie. the comment) has JavaScript enabled. If no such detection
-    has been made, leave this value empty.
-* **document-permalink**: The URL to the document being posted.
-* **http-headers**: Contains the HTTP headers sent with the request. You can
-    send a few values or all values. Because this information helps Defensio
-    determine if a document is innocent or not, the more headers you send, the
-    better. The format of this value is one key/value pair per line, each line
-    starting with the key followed by a colon and then the value.
-* **parent-document-date**: The date the parent document was posted. For
-    example, on a blog, this would be the date the article related to the
-    comment (document) was posted. If you're using threaded comments, send the
-    date the article was posted, not the date the parent comment was posted.
-* **parent-document-permalink**: The URL of the parent document. For example,
-    on a blog, this would be the URL the article related to the comment
-    (document) was posted.
-* **referrer**: Provide the value of the HTTP_REFERER (note spelling) in this
-    field.
-* **title**: Provide the title of the document being sent. For example, this
-    might be the title of a blog article.
-
-
-Development
------------
-
-Want to help out on Defender?
-
-First, you should clone the repo and run the features and specs:
-
-    git clone git://github.com/dvyjones/defender.git
-    cd defender
-    rake spec
-
-Feel free to ping the mailing list if you have any problems and we'll
-try to sort it out.
-
-
-Contributing
-------------
-
-Once you've made your great commits:
-
-1. [Fork][1] defender
-2. Create a topic branch - `git checkout -b my_branch`
-3. Push to your branch - `git push origin my_branch`
-4. Create an [Issue][2] with a link to your branch
-5. That's it!
-
-You might want to checkout our [Contributing][cb] wiki page for
-information on coding standards, new features, etc.
-
-
-Mailing List
-------------
-
-To join the list simply send an email to <defender@librelist.com>. This
-will subscribe you and send you information about your subscription,
-include unsubscribe information.
-
-The archive can be found at <http://librelist.com/browser/>.
-
-
-Meta
-----
-
-* Code: `git clone git://github.com/dvyjones/defender.git`
-* Home: <http://github.com/dvyjones/defender/>
-* Docs: <http://rubydoc.info/github/dvyjones/defender/maser/frames>
-* Bugs: <http://github.com/dvyjones/defender/issues>
-* List: <defender@librelist.com>
-* Gems: <http://rubygems.org/gems/defender>
-
-This project uses [Semantic Versioning][sv].
-
-
-Author
-------
-
-Henrik Hodne :: <dvyjones@binaryhex.com> :: @[dvyjones][5]
-
-[0]: http://defensio.com
-[1]: http://help.github.com/forking/
-[2]: http://github.com/dvyjones/defender/issues
-[3]: http://defensio.com/api
-[4]: http://defensio.com/signup/
-[5]: http://twitter.com/dvyjones
-[sv]: http://semver.org
-[cb]: http://wiki.github.com/dvyjones/defender/contributing

data/Rakefile

@@ -1,25 +0,0 @@
-# coding:utf-8
-$:.unshift File.expand_path('../lib', __FILE__)
-
-require 'bundler'
-require 'rubygems'
-require 'rubygems/specification'
-require 'defender'
-
-Bundler::GemHelper.install_tasks
-
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec) do |t|
-  t.rspec_opts = %w{-fs --color}
-end
-
-begin
-  require 'yard'
-rescue LoadError
-  raise 'Run `gem install yard` to generate docs'
-else
-  YARD::Rake::YardocTask.new do |conf|
-    conf.options = ['-mmarkdown', '-rREADME.md']
-    conf.files = ['lib/**/*.rb', '-', 'LICENSE']
-  end
-end

data/defender.gemspec

@@ -1,22 +0,0 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path("../lib/defender/version", __FILE__)
-
-Gem::Specification.new do |s|
-  s.name        = "defender"
-  s.version     = Defender::VERSION
-  s.platform    = Gem::Platform::RUBY
-  s.authors     = ['Henrik Hodne']
-  s.email       = ['dvyjones@dvyjones.com']
-  s.homepage    = 'http://rubygems.org/gems/dvyjones'
-  s.summary     = 'ActiveModel plugin for Defensio.'
-  s.description = 'An ActiveModel plugin for Defensio.'
-  
-  s.add_dependency('defensio', '~> 0.9.1')
-  s.add_dependency('activemodel', '~> 3.0.0')
-  s.add_development_dependency('bundler', '~> 1.0.0')
-  
-  s.files        = `git ls-files`.split("\n")
-  s.test_files   = `git ls-files -- spec/*`.split("\n")
-
-  s.require_path = ['lib']
-end

data/spec/defender/spammable_spec.rb

@@ -1,124 +0,0 @@
-require 'spec_helper'
-
-module Defender
-  describe Spammable do
-    describe '.configure_defender' do
-      it 'sets the attribute-data key mappers' do
-        Comment.configure_defender(:keys => {'foo' => :bar, 'foobar' => :baz})
-        Comment._defensio_keys.should include({'foo' => :bar, 'foobar' => :baz})
-      end
-      
-      it 'sets the API key' do
-        Comment.configure_defender(:api_key => 'foobar')
-        Defender.api_key.should == 'foobar'
-      end
-    end
-    
-    describe '#spam?' do
-      it 'returns the "spam" attribute unless it is nil' do
-        comment_class = Class.new
-        comment_class.instance_eval { attr_accessor :spam }
-        def comment_class.before_save(*args, &block); end
-        comment_class.send(:define_method, :new_record?) { false }
-        comment_class.send(:include, Defender::Spammable)
-        comment = comment_class.new
-        comment.spam = true
-        comment.spam?.should be_true
-      end
-      
-      it 'returns nil for a new record' do
-        comment_class = Class.new
-        comment_class.instance_eval { attr_accessor :spam }
-        def comment_class.before_save(*args, &block); end
-        comment_class.send(:define_method, :new_record?) { true }
-        comment_class.send(:include, Defender::Spammable)
-        comment = comment_class.new
-        comment.spam?.should be_nil
-      end
-      
-      it 'raises a DefenderError if no spam attribute exists' do
-        comment_class = Class.new
-        def comment_class.before_save(*args, &block); end
-        comment_class.send(:define_method, :new_record?) { false }
-        comment_class.send(:include, Defender::Spammable)
-        comment = comment_class.new
-        expect { comment.spam? }.to raise_error(Defender::DefenderError)
-      end
-    end
-    
-    describe '#defensio_data' do
-      it 'merges in more data to be sent to Defensio' do
-        comment = Comment.new
-        comment.defensio_data({'foo' => 'FOOBAR', 'foobar' => 'baz'})
-        comment.defensio_data.should include({'foo' => 'FOOBAR', 'foobar' => 'baz'})
-      end
-      
-      it 'overwrites values repassed' do
-        comment = Comment.new
-        comment.defensio_data({'foo' => 'FOOBAR'})
-        comment.defensio_data({'foo' => 'baz'})
-        comment.defensio_data['foo'].should == 'baz'
-      end
-      
-      it 'leaves values that aren\'t modified' do
-        comment = Comment.new
-        comment.defensio_data({'foo' => 'baz'})
-        comment.defensio_data({'bar' => 'foobar'})
-        comment.defensio_data['foo'].should == 'baz'
-      end
-    end
-    
-    describe '#_defender_before_save' do
-      it 'sets the attributes returned from defensio' do
-        comment = Comment.new
-        comment.body = '[innocent,0.9]'
-        comment.save
-        comment.spam.should be_false
-        comment.defensio_sig.should_not be_nil
-      end
-      
-      it 'sends the information off to Defensio' do
-        old_defensio = Defender.defensio
-        defensio = double('defensio')
-        defensio.should_receive(:post_document) { [200, {'signature' => 1234567890, 'spaminess' => 0.9, 'allow' => true}] }
-        Defender.defensio = defensio
-        comment = Comment.new
-        comment.body = 'Hello, world!'
-        comment.save
-        Defender.defensio = old_defensio
-      end
-    end
-    
-    describe '#_pick_attribute' do
-      it 'returns the value of the attribute passed if it exists' do
-        comment = Comment.new
-        comment.body = 'Foobar!'
-        comment.send(:_pick_attribute, :body).should == 'Foobar!'
-      end
-      
-      it 'returns the value for the first attribute that exists in a list of attributes' do
-        comment = Comment.new
-        comment.body = 'Foobar!'
-        comment.send(:_pick_attribute, [:content, :body]).should == 'Foobar!'
-      end
-      
-      it 'returns nil if no attribute with the given names exists' do
-        comment = Comment.new
-        comment.send(:_pick_attribute, :bogus_attribute).should be_nil 
-      end
-    end
-    
-    describe '#_get_defensio_document' do
-      it 'retrieves the document from Defensio' do
-        old_defensio = Defender.defensio
-        defensio = double('defensio')
-        defensio.should_receive(:get_document) { [200, {'status' => 'succeed'}] }
-        Defender.defensio = defensio
-        comment = Comment.new
-        comment.defensio_sig = '0123456789abcdef'
-        comment.send(:_get_defensio_document)
-        Defender.defensio = old_defensio
-      end
-    end
-  end
-end

data/spec/fake_defensio.rb

@@ -1,36 +0,0 @@
-class FakeDefensio
-  def initialize
-    @documents = {}
-  end
-
-  def post_document(data)
-    content = data[:content] || data['content']
-    classification, spaminess = content[1..-2].split(',')
-    signature = "#{rand}#{content}".hash
-
-    @documents[signature] = {
-      'api-version' => '2.0',
-      'status' => 'success',
-      'message' => '',
-      'signature' => signature,
-      'allow' => (classification == 'innocent'),
-      'classification' => classification,
-      'spaminess' => spaminess.to_f,
-      'profanity-match' => false
-    }
-
-    [200, @documents[signature]]
-  end
-
-  def get_document(signature)
-    if @documents.has_key?(signature)
-      [200, @documents[signature]]
-    else
-      [404,
-        'api-version' => '2.0',
-        'status' => 'failure',
-        'message' => 'document not found'
-      ]
-    end
-  end
-end

data/spec/spec.opts

@@ -1,2 +0,0 @@
---color
---format nested

data/spec/spec_helper.rb

@@ -1,7 +0,0 @@
-require 'defender'
-require 'defender/test/comment'
-require 'fake_defensio'
-
-Comment = Defender::Test::Comment
-
-Defender.defensio = FakeDefensio.new