stoolie 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ca19f561e69ea9b59e6f99a52eac6c83060df20d
+  data.tar.gz: 37f3c585bd23ab5c67a3c3375978fe74bfb31827
+SHA512:
+  metadata.gz: bef278518cb9933be6b5b145f0a4f0be41e9d7da55d329bdb04cb5742ad5fc1082fb272bbd427ae6f9282c8ce2316da374b46a4aec0b3a94bc4a09912f99dcc2
+  data.tar.gz: 2557aa46e4a39bde6736362f042d44e6bdb4e47958e3094ce320be1748e1a23699fcf7a42e633a17dbcfdef5bc351fcf47dc58b084b1ee09a6315397b2604409

data/.document

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

data/Gemfile

@@ -0,0 +1,20 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+gem 'loofah', '~> 1.2.1'
+gem 'httparty', '~> 0.13.0'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem 'rspec'
+  gem 'rspec-mocks'
+  gem 'factory_girl', '~> 4.0'
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 2.0.1"
+  gem "simplecov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,102 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (4.0.4)
+      i18n (~> 0.6, >= 0.6.9)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    addressable (2.3.5)
+    atomic (1.1.16)
+    builder (3.2.2)
+    descendants_tracker (0.0.3)
+    diff-lcs (1.2.5)
+    docile (1.1.3)
+    factory_girl (4.4.0)
+      activesupport (>= 3.0.0)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    git (1.2.6)
+    github_api (0.11.3)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.1)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 1.2)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.0)
+      oauth2
+    hashie (2.0.5)
+    highline (1.6.21)
+    httparty (0.13.0)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
+    i18n (0.6.9)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.1)
+    jwt (0.1.11)
+      multi_json (>= 1.5)
+    loofah (1.2.1)
+      nokogiri (>= 1.4.4)
+    mini_portile (0.5.2)
+    minitest (4.7.5)
+    multi_json (1.9.2)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.1)
+      mini_portile (~> 0.5.0)
+    oauth2 (0.9.3)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 0.1.8)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rake (10.1.1)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.1.6)
+    shoulda-matchers (2.5.0)
+      activesupport (>= 3.0.0)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    thread_safe (0.2.0)
+      atomic (>= 1.1.7, < 2)
+    tzinfo (0.3.39)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  factory_girl (~> 4.0)
+  httparty (~> 0.13.0)
+  jeweler (~> 2.0.1)
+  loofah (~> 1.2.1)
+  rdoc (~> 3.12)
+  rspec
+  rspec-mocks
+  shoulda
+  simplecov

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Aaron Wallis
+
+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

@@ -0,0 +1,156 @@
+# stoolie
+
+Content filter to determine the XSS, spam and profanity content of text
+
+## Installation
+
+The easiest way to install is with [Bundler](http://gembundler.com)
+
+```ruby
+ gem 'stoolie'
+```
+
+Stoolie will work on Ruby 1.8.7+
+
+## Configuration
+
+In Rails, create an initializer such as `config/initializers/stoolie.rb` and add your SmartFilter rule key and API key
+
+```ruby
+ MyApplication::Application.config.stoolie.smart_filter.api_key = 'my api key'
+ MyApplication::Application.config.stoolie.smart_filter.rule_key = 'my rule key'
+```
+
+Otherwise, add the keys like so:
+
+```ruby
+ Stoolie.configure do |config|
+   config.smart_filter = {rule_key: 'rule-key', api_key: 'api-key'}
+ end
+```
+
+### Default Filter and SmartFilter Thresholds
+
+Stoolie uses [Prevoty's SmartFilter](http://www.isodsgn.com/source/work/pv/v1_site/smartfilter.htm) by default, but it's possible to [add](#extending-stoolie) other clients as long as they implement stoolie's API requirements.
+
+These are the default thresholds.
+
+#### XSS
+
+* javascript_threshold - 1
+* invalid_tags_threshold - 1
+
+#### Spam
+
+* link_density_threshold - 3
+* spam_features_threshold - 2
+
+#### Blacklisted Phrases
+
+* blacklisted_phrases_threshold - 1
+
+#### Offensive Phrases
+
+* flagged_phrases_threshold - 6
+* profanity_threshold - 3
+
+All thresholds can be configured using the names given above.
+
+```ruby
+ MyApplication.config.stoolie.smart_filter.profanity_threshold = 5
+```
+
+## Examples
+
+### XSS
+
+```ruby
+ > result = Stoolie::Filter.new.analyze('<script>xss is bad.</script>')
+ => #<Stoolie::Result>
+ > result.is_insecure?
+ => true
+```
+
+### Spam
+
+```ruby
+ > result = Stoolie::Filter.new.analyze('http://mylink.com http://anotherlink.com http://yetanotherlink.com')
+ => #<Stoolie::Result>
+ > result.is_spam?
+ => true
+```
+
+### Blacklisted Phrases
+
+```ruby
+ > filter = Stoolie::Filter.new
+ > result = filter.analyze('some text')
+ => #<Stoolie::Result>
+ > result.is_blacklisted?
+ => false
+ > result = filter.analyze('an incredibly racist word')
+ => #<Stoolie::Result>
+ > result.is_blacklisted?
+ => true
+```
+
+### Offensive Phrases
+
+```ruby
+ > result = Stoolie::Filter.new.analyze('enough curse words to trip the threshold')
+ => #<Stoolie::Result>
+ > result.is_offensive?
+ => true
+```
+
+## Extending stoolie
+
+If you want to add your own filter client, create one in `lib/stoolie/clients/` and make sure it meets the API requirements:
+
+### Instance Attributes
+
+* input
+* output
+
+### Implement public `analyze` instance method
+
+* Should accept a string argument
+* Should return a Stoolie::Result object, which takes the client instance as its argument
+
+```ruby
+ return @result = Stoolie::Result.new(self)
+```
+
+### Implement these public boolean instance methods
+
+* is_insecure?
+* is_spam?
+* is_blacklisted?
+* is_offensive?
+
+To use your new client instead of SmartFilter, you can set it in your configuration:
+
+```ruby
+ MyApplication::Application.config.client = MyFilterClient
+```
+
+Or on the fly
+
+```ruby
+ filter = Stoolie::Filter.new(MyFilterClient)
+```
+
+## Contributing to stoolie
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2014 Aaron Wallis. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "stoolie"
+  gem.homepage = "http://github.com/wheels/stoolie"
+  gem.license = "MIT"
+  gem.summary = %Q{Content filter to determine the XSS, spam or offensive quality of text}
+  gem.description = %Q{Content filter to determine the XSS, spam or offensive quality of text.}
+  gem.email = "awallis@bleacherreport.com"
+  gem.authors = ["Aaron Wallis"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['test'].execute
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "stoolie #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/lib/stoolie/clients/smart_filter.rb

@@ -0,0 +1,157 @@
+require File.expand_path(File.dirname(__FILE__) + '/../result')
+require 'yaml'
+require 'httparty'
+
+class SmartFilterNetworkException < Exception; end
+class SmartFilterBadInputParameter < Exception; end
+class SmartFilterBadAPIKey < Exception; end
+class SmartFilterRequestTooLarge < Exception; end
+class SmartFilterInternalError < Exception; end
+class SmartFilterAccountQuotaExceeded < Exception; end
+
+class SmartFilter
+  attr_accessor :rule_key, :api_key, :base
+  attr_accessor :input, :output
+
+  def initialize(opts = {})
+    @config       = SmartFilter.config(Stoolie.config.smart_filter)
+
+    @rule_key     = opts[:rule_key] || @config[:rule_key]
+    @api_key      = @config[:api_key]
+
+    @base         = 'https://api.prevoty.com/1'
+  end
+
+  # Endpoint: /xss/filter
+  def filter(input, rule_key)
+    begin
+      return filter!(input, rule_key)
+    rescue => e
+      return nil
+    end
+  end
+
+  def filter!(input, rule_key = nil)
+    rule_key ||= @rule_key
+    options = {:api_key => @api_key, :input => input, :rule_key => rule_key}
+    response = HTTParty.post("#{@base}/xss/filter", :query => options, :timeout => 5)
+
+    unless rule_key and @api_key
+      raise "You must configure Smart Filter to use a rule key and api key"
+    end
+
+    return JSON.parse(response.body)      if response.code == 200
+    raise SmartFilterBadInputParameter    if response.code == 400
+    raise SmartFilterBadAPIKey            if response.code == 403
+    raise SmartFilterRequestTooLarge      if response.code == 413
+    raise SmartFilterInternalError        if response.code == 500
+    raise SmartFilterAccountQuotaExceeded if response.code == 507
+    Array.new
+  end
+
+  # Public: allows changing the thresholds at which the xss, spam & offensive methods will trigger
+  #
+  # Returns a hash
+  def self.config(opts =  {})
+    opts[:blacklisted_phrases_threshold] ||= 1
+    opts[:flagged_phrases_threshold]     ||= 6
+    opts[:profanity_threshold]           ||= 3
+    opts[:link_density_threshold]        ||= 3
+    opts[:spam_features_threshold]       ||= 2
+    opts[:javascript_threshold]          ||= 1
+    opts[:invalid_tags_threshold]        ||= 1
+    opts
+  end
+
+  # Public: retrieves the threshold (configured or default) for a given statistic
+  #
+  # Returns a hash of the form {'statistic' => ${threshold value}}
+  def self.stats_to_thresholds
+    map = {}
+    map['blacklisted_phrases']            = config[:blacklisted_phrases_threshold]
+    map['flagged_phrases']                = config[:flagged_phrases_threshold]
+    map['prevoty_profanity_features']     = config[:profanity_threshold]
+    map['prevoty_link_density']           = config[:link_density_threshold]
+    map['prevoty_spam_features']          = config[:spam_features_threshold]
+
+    ['invalid_protocols', 'invalid_attributes', 'invalid_tags'].each do |s|
+      map[s] = config[:invalid_tags_threshold]
+    end
+    ['javascript_tags', 'javascript_protocols', 'javascript_attributes'].each do |s|
+      map[s] = config[:javascript_threshold]
+    end
+
+    map
+  end
+
+  def stat_to_threshold(stat)
+    SmartFilter.stats_to_thresholds[stat.to_s]
+  end
+
+  # Public: calls the filter method to test the input
+  #
+  # input - the text to be analyzed
+  #
+  # Examples
+  #
+  #   result = analyze('<script>text</script>')
+  #   # => #<Stoolie::Result...>
+  #   result.insecure?
+  #   # => true
+  #
+  # Returns a Stoolie::Result object
+  def analyze(input = '')
+    @input    = input
+    result    = filter!(@input)
+    @stats    = result['statistics']
+    @output   = result['output']
+    @result   = Stoolie::Result.new(self)
+  end
+
+  # Public: checks the result statistics against the thresholds for security
+  #
+  # Returns a boolean
+  def is_insecure?
+    return false unless @stats
+
+    beyond_threshold?(['javascript_tags', 'javascript_protocols', 'javascript_attributes', 'invalid_protocols', 'invalid_attributes'])
+  end
+
+  # Public: checks the result statistics against the thresholds for spam
+  #
+  # Returns a boolean
+  def is_spam?
+    return false unless @stats
+
+    beyond_threshold?(['prevoty_spam_features']) || link_density(@stats['prevoty_link_density']) >= stat_to_threshold('prevoty_link_density')
+  end
+
+  # Public: checks the result statistics against the thresholds for blacklisted phrases
+  #
+  # Returns a boolean
+  def is_blacklisted?
+    return false unless @stats
+
+    beyond_threshold?(['blacklisted_phrases'])
+  end
+
+  # Public: checks the result statistics against the thresholds for profanity
+  #
+  # Returns a boolean
+  def is_offensive?
+    return false unless @stats
+
+    beyond_threshold?(['flagged_phrases', 'prevoty_profanity_features'])
+  end
+
+  private
+
+    def link_density(links = {})
+      links.values.inject(&:+) || 0
+    end
+
+    def beyond_threshold?(stats = [])
+      stats.any? { |stat| @stats[stat] >= stat_to_threshold(stat) }
+    end
+
+end

data/lib/stoolie/filter.rb

@@ -0,0 +1,29 @@
+require File.expand_path(File.dirname(__FILE__) + '/clients/smart_filter')
+
+module Stoolie
+  class Filter
+    attr_accessor :client, :result
+
+    # Public: takes the class name of the filter client to use - e.g. SmartFilter
+    def initialize(client = nil)
+      @config = Stoolie.config
+
+      @client = client || Stoolie.config.client
+      @client = @client.send(:new)
+    end
+
+    # Public: analyzes a string for xss, spam and profanity
+    #
+    # input - the string to be analyzed
+    #
+    # Examples:
+    #
+    #   analyze('<script>text</script>')
+    #   # => #<Stoolie::Result: ...>
+    #
+    # Returns a Stoolie::Result object
+    def analyze(input)
+      @result = @client.analyze(input)
+    end
+  end
+end

data/lib/stoolie/railtie.rb

@@ -0,0 +1,16 @@
+require File.expand_path(File.dirname(__FILE__) + '/../stoolie')
+
+module Stoolie
+  class Railtie < Rails::Railtie
+
+    config.stoolie = ActiveSupport::OrderedOptions.new
+    config.stoolie.smart_filter = ActiveSupport::OrderedOptions.new
+
+    initializer "stoolie" do |app|
+      Stoolie.configure do |config|
+        config.client = app.config.stoolie.client if app.config.stoolie.client
+        config.smart_filter = app.config.stoolie.smart_filter
+      end
+    end
+  end
+end

data/lib/stoolie/result.rb

@@ -0,0 +1,51 @@
+module Stoolie
+  class Result
+    attr_accessor :client, :input, :output
+
+    # Client must have the following attributes:
+    #
+    #   #input
+    #   #output
+    #
+    # Client must implement the following methods
+    #
+    #   #analyze(input)
+    #   #is_insecure?
+    #   #is_spammy?
+    #   #is_blacklisted?
+    #   #is_offensive?
+    def initialize(client)
+      @client = client
+      @input = client.input
+      @ouput = client.output
+    end
+
+    # Public: tells whether the client found XSS
+    #
+    # Returns a boolean
+    def is_insecure?
+      @client.is_insecure?
+    end
+
+    # Public: tells whether the client found spam
+    #
+    # Returns a boolean
+    def is_spam?
+      @client.is_spam?
+    end
+
+    # Public: tells whether the client found blacklisted phrases
+    #
+    # Returns a boolean
+    def is_blacklisted?
+      @client.is_blacklisted?
+    end
+
+    # Public: tells whether the client found offensive words or phrases
+    #
+    # Returns a boolean
+    def is_offensive?
+      @client.is_offensive?
+    end
+  end
+end

data/lib/stoolie.rb

@@ -0,0 +1,27 @@
+module Stoolie
+  VERSION = "0.0.2"
+
+  class << self
+    attr_accessor :config
+
+    def configure
+      @config ||= Config.new
+      yield(config) if block_given?
+      @config
+    end
+  end
+
+  class Config
+    attr_accessor :client, :smart_filter
+
+    def initialize
+      @client       = SmartFilter
+      @smart_filter = {}
+    end
+  end
+
+end
+
+require File.expand_path(File.dirname(__FILE__) + '/stoolie/filter')
+
+require 'stoolie/railtie' if defined?(Rails::Railtie)

data/spec/factories.rb

@@ -0,0 +1,5 @@
+FactoryGirl.define do
+  factory :filter, :class => Stoolie::Filter do
+    client   SmartFilter
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+require File.expand_path(File.dirname(__FILE__) + '/../lib/stoolie')
+require 'factory_girl'
+
+include RSpec::Mocks::ExampleMethods
+
+FactoryGirl.definition_file_paths = %w(../factories)
+
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+
+  config.before(:each) do
+    Stoolie.configure do |config|
+      config.smart_filter = {api_key: 'api-key', rule_key: 'rule-key'}
+    end
+  end
+
+  config.before(:each) do
+    def stub_filter(stats = {})
+      filter_result = {"message"=>"", "output"=>"", "statistics"=>{"bytes"=>4, "invalid_attributes"=>0,
+                      "invalid_protocols"=>0, "invalid_tags"=>0, "blacklisted_phrases"=>0, "flagged_phrases"=>0,
+                      "javascript_attributes"=>0, "javascript_protocols"=>0, "javascript_tags"=>0,
+                      "prevoty_profanity_features"=>0, "prevoty_spam_features"=>0, "prevoty_link_metadata"=>{},
+                      "prevoty_link_density"=>{}, "tags_balanced"=>0, "transformations"=>0}}
+      filter_result['statistics'].merge!(stats)
+      SmartFilter.any_instance.stub(:filter!).and_return(filter_result)
+    end
+  end
+end

data/spec/stoolie/clients/smart_filter_spec.rb

@@ -0,0 +1,123 @@
+require 'spec_helper'
+
+describe SmartFilter do
+  before(:each) do
+    stub_filter
+  end
+
+  describe '.analyze' do
+    subject { SmartFilter.new }
+
+    before(:each) do
+      subject.analyze('some text')
+    end
+
+    it { subject.instance_variable_get(:@input).should_not be_nil }
+    it { subject.instance_variable_get(:@stats).should_not be_nil }
+    it { subject.instance_variable_get(:@output).should_not be_nil }
+    it { subject.instance_variable_get(:@result).should_not be_nil }
+    it { subject.instance_variable_get(:@result).should be_a(Stoolie::Result) }
+  end
+
+  describe 'with benign text' do
+    subject { SmartFilter.new }
+
+    before(:each) do
+      stub_filter
+      subject.analyze('benign text')
+    end
+
+    it { subject.should_not be_is_insecure }
+    it { subject.should_not be_is_spam }
+    it { subject.should_not be_is_offensive }
+  end
+
+  describe '.is_insecure? with malicious text exceeding the javascript threshold' do
+    subject { SmartFilter.new }
+
+    context 'because of tags' do
+      before(:each) do
+        stub_filter('javascript_tags' => 1)
+        subject.analyze('<script>malicious text</script>')
+      end
+
+      it { subject.should be_is_insecure }
+    end
+
+    context 'because of protocols' do
+      before(:each) do
+        stub_filter('javascript_protocols' => 1)
+        subject.analyze('<script>malicious text</script>')
+      end
+
+      it { subject.should be_is_insecure }
+    end
+
+    context 'because of attributes' do
+      before(:each) do
+        stub_filter('javascript_attributes' => 1)
+        subject.analyze('<script>malicious text</script>')
+      end
+
+      it { subject.should be_is_insecure }
+    end
+  end
+
+  describe '.is_spam? with malicious text exceeding the spam threshold' do
+    subject { SmartFilter.new }
+
+    context 'because of link density' do
+      before(:each) do
+        stub_filter('prevoty_link_density' => {'http://test.com' => 2, 'http://alsotest.com' => 1})
+        subject.analyze('spammy text')
+      end
+
+      it { subject.should be_is_spam }
+    end
+
+    context 'because of spam features' do
+      before(:each) do
+        stub_filter('prevoty_spam_features' => 2)
+        subject.analyze('spammy text')
+      end
+
+      it { subject.should be_is_spam }
+    end
+  end
+
+  describe '.is_blacklisted? with malicious text exceeding the blacklist threshold' do
+    subject { SmartFilter.new }
+
+    context 'because of blacklisted phrases' do
+      before(:each) do
+        stub_filter('blacklisted_phrases' => 1)
+        subject.analyze('offensive text')
+      end
+
+      it { subject.should be_is_blacklisted }
+    end
+  end
+
+  describe '.is_offensive? with malicious text exceeding the offensive threshold' do
+    subject { SmartFilter.new }
+
+    context 'because of flagged phrases' do
+      before(:each) do
+        stub_filter('flagged_phrases' => 6)
+        subject.analyze('offensive text')
+      end
+
+      it { subject.should be_is_offensive }
+    end
+
+    context 'because of profanity' do
+      before(:each) do
+        stub_filter('prevoty_profanity_features' => 3)
+        subject.analyze('offensive text')
+      end
+
+      it { subject.should be_is_offensive }
+    end
+  end
+
+end

data/spec/stoolie/filter_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe Stoolie::Filter do
+
+  subject { Stoolie::Filter.new }
+
+  describe "#new" do
+    it { should respond_to(:client) }
+    it { subject.client.should be_a(SmartFilter) }
+
+    it { should respond_to(:result) }
+    it { subject.result.should be_nil }
+  end
+
+  describe "#analyze" do
+    before(:each) do
+      stub_filter
+    end
+
+    subject { Stoolie::Filter.new.analyze('some text') }
+
+    it { subject.should be_a(Stoolie::Result) }
+  end
+
+end

data/spec/stoolie/result_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Stoolie::Result do
+
+  subject { Stoolie::Result.new(SmartFilter.new) }
+
+  describe "#new" do
+    it { should respond_to(:client) }
+    it { subject.client.should be_a(SmartFilter) }
+
+    it { should respond_to(:input) }
+    it { should respond_to(:output) }
+  end
+
+  describe "#is_insecure?" do
+    it { should respond_to(:is_insecure?) }
+  end
+
+  describe "#is_spam?" do
+    it { should respond_to(:is_spam?) }
+  end
+
+  describe "#is_blacklisted?" do
+    it { should respond_to(:is_blacklisted?) }
+  end
+
+  describe "#is_offensive?" do
+    it { should respond_to(:is_offensive?) }
+  end
+
+end

data/stoolie.gemspec

@@ -0,0 +1,85 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "stoolie"
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Aaron Wallis"]
+  s.date = "2014-06-06"
+  s.description = "Content filter to determine the XSS, spam or offensive quality of text."
+  s.email = "awallis@bleacherreport.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/stoolie.rb",
+    "lib/stoolie/clients/smart_filter.rb",
+    "lib/stoolie/filter.rb",
+    "lib/stoolie/railtie.rb",
+    "lib/stoolie/result.rb",
+    "spec/factories.rb",
+    "spec/spec_helper.rb",
+    "spec/stoolie/clients/smart_filter_spec.rb",
+    "spec/stoolie/filter_spec.rb",
+    "spec/stoolie/result_spec.rb",
+    "spec/stoolie_spec.rb",
+    "stoolie.gemspec"
+  ]
+  s.homepage = "http://github.com/wheels/stoolie"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "2.0.14"
+  s.summary = "Content filter to determine the XSS, spam or offensive quality of text"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<loofah>, ["~> 1.2.1"])
+      s.add_runtime_dependency(%q<httparty>, ["~> 0.13.0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<rspec-mocks>, [">= 0"])
+      s.add_development_dependency(%q<factory_girl>, ["~> 4.0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+    else
+      s.add_dependency(%q<loofah>, ["~> 1.2.1"])
+      s.add_dependency(%q<httparty>, ["~> 0.13.0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<rspec-mocks>, [">= 0"])
+      s.add_dependency(%q<factory_girl>, ["~> 4.0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<loofah>, ["~> 1.2.1"])
+    s.add_dependency(%q<httparty>, ["~> 0.13.0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<rspec-mocks>, [">= 0"])
+    s.add_dependency(%q<factory_girl>, ["~> 4.0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,204 @@
+--- !ruby/object:Gem::Specification
+name: stoolie
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Aaron Wallis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: loofah
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Content filter to determine the XSS, spam or offensive quality of text.
+email: awallis@bleacherreport.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/stoolie.rb
+- lib/stoolie/clients/smart_filter.rb
+- lib/stoolie/filter.rb
+- lib/stoolie/railtie.rb
+- lib/stoolie/result.rb
+- spec/factories.rb
+- spec/spec_helper.rb
+- spec/stoolie/clients/smart_filter_spec.rb
+- spec/stoolie/filter_spec.rb
+- spec/stoolie/result_spec.rb
+- spec/stoolie_spec.rb
+- stoolie.gemspec
+homepage: http://github.com/wheels/stoolie
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Content filter to determine the XSS, spam or offensive quality of text
+test_files: []