spanx 0.1.0 → 0.1.1

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+script: "bundle exec rspec"
+notifications:
+  email: false

data/README.md

@@ -1,9 +1,13 @@
-# Spanx
+Spanx
+=====
+
+[![Build status](https://secure.travis-ci.org/wanelo/spanx.png)](http://travis-ci.org/wanelo/spanx)
 
 Spank down IP spam: IP-based rate limiting for web applications behind HTTP server such as nginx or Apache.
 
-Spanx is a simple Redis-based web request rate limiter, which integrates into any web application simply by monitoring
-one or more HTTP server access log file(s) in real time (think Apache/nginx access.log).
+Spanx integrates into any web application simply by monitoring one or more HTTP server access log file(s)
+in real time (think Apache/nginx access.log). Spanx is built on top of the gem Pause, which is a simple Redis-based rate
+limiter.
 
 Basic flow is as follows:
 

data/lib/spanx/actor/analyzer.rb

@@ -38,13 +38,12 @@ module Spanx
       def analyze_all_ips
         return unless Spanx::IPChecker.enabled?
 
-        @previously_blocked_ips = Spanx::IPChecker.blocked_identifiers
-
+        @previously_blocked_ips = Spanx::IPChecker.rate_limited_identifiers
         ips = Spanx::IPChecker.tracked_identifiers
 
         Logger.logging "analyzed #{ips.size} IPs" do
           ips.each do |ip|
-            blocked_ip = analyze_ip(ip)
+            blocked_ip = Spanx::IPChecker.new(ip).analyze
             blocked_ips << blocked_ip if blocked_ip
           end
         end
@@ -54,12 +53,6 @@ module Spanx
         blocked_ips.clear
       end
 
-      # Analyze individual IP for all defined periods.  As soon as one
-      # rule is triggered, exit the method
-      def analyze_ip(ip)
-        Spanx::IPChecker.new(ip).analyze
-      end
-
       private
 
       def initialize_notifiers(config)

data/lib/spanx/actor/collector.rb

@@ -39,7 +39,7 @@ module Spanx
             semaphore.synchronize {
               Logger.logging "flushing cache with [#{cache.keys.size}] keys" do
                 cache.each_pair do |key, count|
-                  Spanx::IPChecker.new(key[0]).increment!(key[1], count)
+                  Spanx::IPChecker.new(key[0]).increment!(count, key[1])
                 end
                 reset_cache
               end

data/lib/spanx/actor/writer.rb

@@ -26,7 +26,7 @@ module Spanx
 
       def write
         if Spanx::IPChecker.enabled?
-          ips = Spanx::IPChecker.blocked_identifiers
+          ips = Spanx::IPChecker.rate_limited_identifiers
         else
           Logger.log "writing empty block file due to disabled state"
           ips = []

data/lib/spanx/config.rb

@@ -25,7 +25,7 @@ module Spanx
 
       if self.has_key?(:analyzer) && self[:analyzer].has_key?(:period_checks)
         self[:analyzer][:period_checks].each do |check|
-          Spanx::IPChecker.check check[:period_seconds].to_i, check[:max_allowed].to_i, check[:block_ttl].to_i
+          Spanx::IPChecker.check(check)
         end
       end
 

data/lib/spanx/ip_checker.rb

@@ -1,5 +1,5 @@
 require 'pause'
 
 class Spanx::IPChecker < Pause::Action
-  scope "spanx:ip"
+  scope "ip"
 end

data/lib/spanx/version.rb

@@ -1,3 +1,3 @@
 module Spanx
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/spanx.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = %w(lib)
   gem.version       = Spanx::VERSION
 
-  gem.add_dependency 'pause', '~> 0.0.3'
+  gem.add_dependency 'pause', '~> 0.0.4'
   gem.add_dependency 'file-tail'
   gem.add_dependency 'mixlib-cli'
   gem.add_dependency 'daemons'

data/spec/spanx/actor/analyzer_spec.rb

@@ -36,24 +36,24 @@ describe Spanx::Actor::Analyzer do
   let(:ip1) { "127.0.0.1" }
   let(:ip2) { "192.168.0.1" }
 
-  describe "#analyze_ip" do
+  describe "#RateLimitedEvent" do
 
     let(:now) { period_marker(10, Time.now.to_i) + 1 }
 
     context "IP blocking rules are not matched" do
       it "returns nil" do
-        analyzer.analyze_ip(ip1).should be_nil
+        Spanx::IPChecker.new(ip1).analyze.should be_nil
       end
     end
 
     context "IP blocking rules are matched" do
       before do
-        Spanx::IPChecker.new(ip1).increment!(now - 5, 2)
-        Spanx::IPChecker.new(ip1).increment!(now - 15, 1)
+        Spanx::IPChecker.new(ip1).increment!(2, now - 5)
+        Spanx::IPChecker.new(ip1).increment!(1, now - 15)
       end
 
-      it "returns a Pause::BlockedAction" do
-        analyzer.analyze_ip(ip1).should be_a(Pause::BlockedAction)
+      it "returns a Pause::RateLimitedEvent" do
+        Spanx::IPChecker.new(ip1).analyze.should be_a(Pause::RateLimitedEvent)
       end
     end
   end
@@ -61,7 +61,7 @@ describe Spanx::Actor::Analyzer do
   describe "#analyze_all_ips" do
     context "checker is disabled" do
       before do
-        Spanx::IPChecker.stub(:blocked_identifiers).and_return([ip1, ip2])
+        Spanx::IPChecker.stub(:rate_limited_identifiers).and_return([ip1, ip2])
         Spanx::IPChecker.stub(:enabled?).and_return(false)
         analyzer.should_not_receive(:analyze_ip)
       end
@@ -73,12 +73,11 @@ describe Spanx::Actor::Analyzer do
 
     context "adapter is enabled" do
       let(:period_check) { double(period_seconds: 1, max_allowed: 1, block_ttl: nil) }
-      let(:blocked_ip) { Pause::BlockedAction.new(mock(identifier:ip2), period_check, 200, 1234566) }
 
       before do
         Spanx::IPChecker.should_receive(:tracked_identifiers).and_return([ip1, ip2])
-        analyzer.should_receive(:analyze_ip).with(ip1)
-        analyzer.should_receive(:analyze_ip).with(ip2)
+        Spanx::IPChecker.should_receive(:new).with(ip1).and_return(mock(analyze: nil))
+        Spanx::IPChecker.should_receive(:new).with(ip2).and_return(mock(analyze: nil))
       end
 
       it "analyzes each IP found" do
@@ -105,8 +104,8 @@ describe Spanx::Actor::Analyzer do
     end
 
     it "should publish to notifiers on blocking IP" do
-      fake_notifier.should_receive(:publish).with(an_instance_of(Pause::BlockedAction))
-      Spanx::IPChecker.new(ip1).increment!(Time.now.to_i - 5, 50000)
+      fake_notifier.should_receive(:publish).with(an_instance_of(Pause::RateLimitedEvent))
+      Spanx::IPChecker.new(ip1).increment!(50000, Time.now.to_i - 5)
       analyzer.analyze_all_ips
     end
   end

data/spec/spanx/actor/writer_spec.rb

@@ -19,7 +19,7 @@ describe Spanx::Actor::Writer do
     end
 
     before do
-      Spanx::IPChecker.stub(:blocked_identifiers).and_return(["1.2.3.4", "127.0.0.1"])
+      Spanx::IPChecker.stub(:rate_limited_identifiers).and_return(["1.2.3.4", "127.0.0.1"])
     end
 
     context "when adapter is enabled" do

data/spec/spanx/notifier/base_spec.rb

@@ -6,7 +6,7 @@ describe Spanx::Notifier::Base do
     let(:time) { Time.now }
     let(:ip_check) { Spanx::IPChecker.new("1.2.3.4") }
     let(:period_check) { Pause::PeriodCheck.new(60, 100, 80)}
-    let(:blocked_action) { Pause::BlockedAction.new(ip_check, period_check, 500, time.to_i)}
+    let(:blocked_action) { Pause::RateLimitedEvent.new(ip_check, period_check, 500, time.to_i)}
 
     it "should set the correct message content" do
       Spanx::Notifier::Base.new.send(:generate_block_ip_message, blocked_action).should ==

data/spec/spanx/notifier/email_spec.rb

@@ -47,7 +47,7 @@ describe Spanx::Notifier::Email, "#publish" do
   let(:time_blocked) { Time.now }
   let(:period) { mock() }
   let(:action) { Spanx::IPChecker.new("1.2.3.4") }
-  let(:blocked_ip) { Pause::BlockedAction.new(action, period, 50, time_blocked) }
+  let(:blocked_ip) { Pause::RateLimitedEvent.new(action, period, 50, time_blocked) }
 
   before { Spanx::Notifier::Email.any_instance.stub(:configure_email_gateway) }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spanx
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -19,7 +19,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.0.3
+        version: 0.0.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,7 +27,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.0.3
+        version: 0.0.4
 - !ruby/object:Gem::Dependency
   name: file-tail
   requirement: !ruby/object:Gem::Requirement
@@ -201,6 +201,7 @@ files:
 - .pairs
 - .rspec
 - .rvmrc
+- .travis.yml
 - Gemfile
 - Guardfile
 - LICENSE
@@ -299,4 +300,3 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/fakeredis.rb
 - spec/support/mail.rb
-has_rdoc: