stoolie 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ca19f561e69ea9b59e6f99a52eac6c83060df20d
-  data.tar.gz: 37f3c585bd23ab5c67a3c3375978fe74bfb31827
+  metadata.gz: b08dfb182be3bffe1d92f2d467324d00230d7d1c
+  data.tar.gz: 622872b0bb0ca414c4fb6757761781a7a706634d
 SHA512:
-  metadata.gz: bef278518cb9933be6b5b145f0a4f0be41e9d7da55d329bdb04cb5742ad5fc1082fb272bbd427ae6f9282c8ce2316da374b46a4aec0b3a94bc4a09912f99dcc2
-  data.tar.gz: 2557aa46e4a39bde6736362f042d44e6bdb4e47958e3094ce320be1748e1a23699fcf7a42e633a17dbcfdef5bc351fcf47dc58b084b1ee09a6315397b2604409
+  metadata.gz: 6c111411770de04086328bc58551176c5fa8c52722461b96e631128fffa88e10af85c7fa2fcdfc1dc895602771ffe1bac600182f5e3918603c32e7d85e8db54f
+  data.tar.gz: 11f58c2850469b8fcd5f02786ee26a4e1bb2b1eb0fe5c014d1289429565046d4add0fbaa23e258d685c0b97d81b2272dbc3db995dfdecf5130e729d652122371

data/README.md

@@ -10,7 +10,7 @@ The easiest way to install is with [Bundler](http://gembundler.com)
  gem 'stoolie'
 ```
 
-Stoolie will work on Ruby 1.8.7+
+Stoolie will work on Ruby 1.8.7+, however the development gems (such as rspec) will only work on 1.9.3+.
 
 ## Configuration
 

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/lib/stoolie.rb

@@ -1,5 +1,5 @@
 module Stoolie
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 
   class << self
     attr_accessor :config

data/lib/stoolie/clients/prevoty/smartfilter.rb

@@ -0,0 +1,100 @@
+# © Prevoty SmartFilter
+# https://github.com/smartfiltersecurity/smartfilter-ruby
+
+require 'rubygems'
+require 'httparty'
+require 'json'
+
+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 PrevotySmartFilter
+  attr_accessor :key, :base
+
+  def initialize(key)
+    @key = key
+    @base = 'https://api.prevoty.com/1'
+  end
+
+  # Endpoint: /key/verify
+  def verify
+    begin
+      return verify!
+    rescue => e
+      return nil
+    end
+  end
+
+  def verify!
+    options = {:api_key => @key}
+    response = HTTParty.get("#{@base}/key/verify", :query => options)
+    return true if response.code == 200
+    raise SmartFilterBadInputParameter.new if response.code == 400
+    raise SmartFilterBadAPIKey.new if response.code == 403
+    raise SmartFilterInternalError.new if response.code == 500
+    false
+  end
+
+  # Endpoint: /key/info
+  def info
+    begin
+      return info!
+    rescue => e
+      return nil
+    end
+  end
+
+  def info!
+    options = {:api_key => @key}
+    response = HTTParty.get("#{@base}/key/info", :query => options)
+    return JSON.parse(response.body) if response.code == 200
+    raise SmartFilterBadInputParameter.new if response.code == 400
+    raise SmartFilterBadAPIKey.new if response.code == 403
+    raise SmartFilterInternalError.new if response.code == 500
+    Array.new
+  end
+
+  # Endpoint: /rule/verify
+  def verify_rule(rule_key)
+    begin
+      return verify_rule!(rule_key)
+    rescue => e
+      return nil
+    end
+  end
+
+  def verify_rule!(rule_key)
+    options = {:api_key => @key, :rule_key => rule_key}
+    response = HTTParty.get("#{@base}/rule/verify", :query => options)
+    return true if response.code == 200
+    raise SmartFilterBadInputParameter.new if response.code == 400
+    raise SmartFilterBadAPIKey.new if response.code == 403
+    raise SmartFilterInternalError.new if response.code == 500
+    false
+  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)
+    options = {:api_key => @key, :input => input, :rule_key => rule_key}
+    response = HTTParty.post("#{@base}/xss/filter", :query => options)
+    return JSON.parse(response.body) if response.code == 200
+    raise SmartFilterBadInputParameter.new if response.code == 400
+    raise SmartFilterBadAPIKey.new if response.code == 403
+    raise SmartFilterRequestTooLarge.new if response.code == 413
+    raise SmartFilterInternalError.new if response.code == 500
+    raise SmartFilterAccountQuotaExceeded.new if response.code == 507
+    Array.new
+  end
+end

data/lib/stoolie/clients/smart_filter.rb

@@ -1,52 +1,28 @@
 require File.expand_path(File.dirname(__FILE__) + '/../result')
-require 'yaml'
-require 'httparty'
+require File.expand_path(File.dirname(__FILE__) + '/prevoty/smartfilter')
 
-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 SmartFilterBadRuleKey < Exception; end
 
-class SmartFilter
-  attr_accessor :rule_key, :api_key, :base
-  attr_accessor :input, :output
+class SmartFilter < PrevotySmartFilter
+  alias_method :api_key, :key
+  alias_method :api_key=, :key=
 
-  def initialize(opts = {})
-    @config       = SmartFilter.config(Stoolie.config.smart_filter)
+  attr_accessor :rule_key, :input, :output, :response
 
-    @rule_key     = opts[:rule_key] || @config[:rule_key]
-    @api_key      = @config[:api_key]
+  def initialize(key = nil)
+    @config        = SmartFilter.config(Stoolie.config.smart_filter)
 
-    @base         = 'https://api.prevoty.com/1'
-  end
+    super(key)
 
-  # Endpoint: /xss/filter
-  def filter(input, rule_key)
-    begin
-      return filter!(input, rule_key)
-    rescue => e
-      return nil
-    end
+    @rule_key       = key || @config[:rule_key]
+    @api_key = @key = @config[:api_key]
   end
 
-  def filter!(input, rule_key = nil)
+  def filter!(input, rule_key)
     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)
+    raise SmartFilterBadRuleKey.new unless rule_key
 
-    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
+    super(input, rule_key)
   end
 
   # Public: allows changing the thresholds at which the xss, spam & offensive methods will trigger
@@ -102,9 +78,10 @@ class SmartFilter
   # Returns a Stoolie::Result object
   def analyze(input = '')
     @input    = input
-    result    = filter!(@input)
-    @stats    = result['statistics']
-    @output   = result['output']
+    @response = filter!(@input, rule_key)
+    @output   = @response['output']
+    @stats    = @response['statistics']
+
     @result   = Stoolie::Result.new(self)
   end
 

data/lib/stoolie/filter.rb

@@ -1,4 +1,7 @@
-require File.expand_path(File.dirname(__FILE__) + '/clients/smart_filter')
+# ideally, we would only require a client if it's in use
+Dir[File.expand_path(File.dirname(__FILE__) + '/clients/*.rb')].each { |file| require file }
+
+class StoolieFilterClientException < Exception; end
 
 module Stoolie
   class Filter
@@ -6,7 +9,9 @@ module Stoolie
 
     # Public: takes the class name of the filter client to use - e.g. SmartFilter
     def initialize(client = nil)
-      @config = Stoolie.config
+      raise StoolieFilterClientException.new("client must be a Class") if client and !client.is_a?(Class)
+
+      @config = Stoolie.configure
 
       @client = client || Stoolie.config.client
       @client = @client.send(:new)

data/stoolie.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "stoolie"
-  s.version = "0.0.2"
+  s.version = "0.0.3"
 
   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.date = "2014-07-01"
   s.description = "Content filter to determine the XSS, spam or offensive quality of text."
   s.email = "awallis@bleacherreport.com"
   s.extra_rdoc_files = [
@@ -25,6 +25,7 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "lib/stoolie.rb",
+    "lib/stoolie/clients/prevoty/smartfilter.rb",
     "lib/stoolie/clients/smart_filter.rb",
     "lib/stoolie/filter.rb",
     "lib/stoolie/railtie.rb",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stoolie
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Aaron Wallis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-06 00:00:00.000000000 Z
+date: 2014-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: loofah
@@ -166,6 +166,7 @@ files:
 - Rakefile
 - VERSION
 - lib/stoolie.rb
+- lib/stoolie/clients/prevoty/smartfilter.rb
 - lib/stoolie/clients/smart_filter.rb
 - lib/stoolie/filter.rb
 - lib/stoolie/railtie.rb