spanx 0.1.0

data/spec/spanx/helper/timing_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Spanx::Helper::Timing do
+  class TestClass
+    include Spanx::Helper::Timing
+  end
+
+  let(:tester) { TestClass.new }
+
+  describe "#period_marker" do
+    let(:time) { DateTime.parse('2001-02-02T21:03:26+00:00').to_time }
+
+    before { time.to_i.should == 981147806 }
+
+    it "returns unix time floored to the nearest resolution block" do
+      Timecop.freeze time do
+        tester.period_marker(10).should == 981147800
+        tester.period_marker(300).should == 981147600
+      end
+    end
+  end
+end

data/spec/spanx/notifier/base_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe Spanx::Notifier::Base do
+
+  describe "message content" 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)}
+
+    it "should set the correct message content" do
+      Spanx::Notifier::Base.new.send(:generate_block_ip_message, blocked_action).should ==
+          "1.2.3.4 blocked @ #{time} for 1mins, for 500 requests over 1mins, with 100 allowed."
+    end
+  end
+end

data/spec/spanx/notifier/campfire_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe Spanx::Notifier::Campfire do
+
+end

data/spec/spanx/notifier/email_spec.rb

@@ -0,0 +1,121 @@
+require 'spec_helper'
+require 'mail'
+
+describe Spanx::Notifier::Email, "#initialize" do
+  describe "#initialize" do
+    let(:config) { {
+        email: {
+            gateway: "a.b.com",
+            from: "me@me.com",
+            password: "p4ssw0rd",
+            domain: "my.domain.com"
+        }
+    } }
+
+    context "enabled" do
+      before { Spanx::Notifier::Email.any_instance.stub(:enabled?).and_return(true) }
+
+      it "should configure SMTP gateway" do
+        Spanx::Notifier::Email.new(config)
+        delivery_method = Mail::Configuration.instance.delivery_method
+        delivery_method.should be_an_instance_of(Mail::SMTP)
+        delivery_method.settings[:address].should == "a.b.com"
+        delivery_method.settings[:user_name].should == "me@me.com"
+        delivery_method.settings[:password].should == "p4ssw0rd"
+        delivery_method.settings[:domain].should == "my.domain.com"
+      end
+    end
+
+    context "when disabled" do
+      before {
+        Spanx::Notifier::Email.any_instance.stub(:enabled?).and_return(false)
+      }
+
+      it "should not configure email gateway" do
+        Mail.should_not_receive(:defaults)
+        Spanx::Notifier::Email.new(config)
+      end
+    end
+  end
+end
+
+describe Spanx::Notifier::Email, "#publish" do
+  include Mail::Matchers
+
+  subject { Spanx::Notifier::Email.new(config) }
+
+  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) }
+
+  before { Spanx::Notifier::Email.any_instance.stub(:configure_email_gateway) }
+
+  context "when disabled" do
+    let(:config) { {} }
+
+    before {
+      Spanx::Notifier::Email.any_instance.stub(:enabled?).and_return(false)
+      subject.publish(blocked_ip)
+    }
+
+    it { should_not have_sent_email }
+  end
+
+  context "when enabled" do
+    let(:email_content) { "blocked email message" }
+    let(:email_subject) { nil }
+    let(:config) { {
+        email: {
+            to: "you@you.com",
+            from: "me@me.com",
+            subject: email_subject
+        }
+    } }
+
+    before {
+      Spanx::Notifier::Email.any_instance.stub(:enabled?).and_return(true)
+      Spanx::Notifier::Email.any_instance.stub(:generate_block_ip_message).and_return(email_content)
+      subject.publish(blocked_ip)
+      subject.thread.join
+    }
+
+    context "with email subject" do
+      let(:email_subject) { "OMG It's an email!" }
+
+      it {
+        should have_sent_email.
+                   to("you@you.com").
+                   from("me@me.com").
+                   with_body(email_content).
+                   with_subject("OMG It's an email! 1.2.3.4")
+      }
+    end
+
+    context "without a subject line" do
+      it {
+        should have_sent_email.
+                   to("you@you.com").
+                   from("me@me.com").
+                   with_body(email_content).
+                   with_subject("IP Blocked: 1.2.3.4")
+      }
+    end
+  end
+end
+
+describe Spanx::Notifier::Email, "#enabled?" do
+  subject { Spanx::Notifier::Email.new(config) }
+
+  context "with no email configuration" do
+    let(:config) { {} }
+
+    it { should_not be_enabled }
+  end
+
+  context "with enabled email configuration" do
+    let(:config) { {email: {enabled: true}} }
+
+    it { should be_enabled }
+  end
+end

data/spec/spanx/runner_spec.rb

@@ -0,0 +1,102 @@
+require 'spec_helper'
+
+describe Spanx::Runner do
+  let(:config) { {:access_log => "logfile", :whitelist_file => "whitelist", :log_reader => {:tail_interval => 1}} }
+  let(:runner) { Spanx::Runner.new(config) }
+  let(:faker) { double() }
+
+  describe "#new" do
+    it "should create a new thread queue" do
+      runner.queue.should be_a(Queue)
+    end
+
+    context "actor initialization" do
+      let(:collector) { mock("collector") }
+      let(:writer) { mock("writer") }
+      let(:log_reader) { mock("log_reader") }
+      let(:analyzer) { mock("analyzer") }
+
+      before do
+        Spanx::Runner.any_instance.stub(:collector).and_return(collector)
+        Spanx::Runner.any_instance.stub(:writer).and_return(writer)
+        Spanx::Runner.any_instance.stub(:log_reader).and_return(log_reader)
+        Spanx::Runner.any_instance.stub(:analyzer).and_return(analyzer)
+      end
+
+      it "should match string args" do
+        Spanx::Runner.new("collector", config).actors.should == [collector]
+        Spanx::Runner.new("writer", config).actors.should == [writer]
+        Spanx::Runner.new("log_reader", config).actors.should == [log_reader]
+        Spanx::Runner.new("analyzer", config).actors.should == [analyzer]
+        Spanx::Runner.new("collector", "analyzer", config).actors.should == [collector, analyzer]
+      end
+
+      it "raises if an invalid actor is passed" do
+        lambda {
+          Spanx::Runner.new("methods", config)
+        }.should raise_error("Invalid actor")
+      end
+    end
+  end
+
+  describe "#run" do
+    let(:actor1) { mock("actor") }
+    let(:actor2) { mock("actor") }
+
+    before do
+      actor1.should_receive(:run).and_return(actor1)
+      actor2.should_receive(:run).and_return(actor2)
+      actor2.should_receive(:join).and_return(true)
+    end
+
+    it "runs all actors and joins the last one" do
+      runner.actors = [actor1, actor2]
+      runner.run
+    end
+  end
+
+  describe "#collector" do
+    before { Spanx::Actor::Collector.should_receive(:new).with(config, runner.queue).and_return(faker) }
+
+    it "should create a collector" do
+      runner.collector.should === faker
+    end
+  end
+
+  describe "#whitelist" do
+    before { Spanx::Whitelist.should_receive(:new).with("whitelist").and_return(faker) }
+
+    it "should create a collector" do
+      runner.whitelist.should === faker
+    end
+  end
+
+  describe "#log_reader" do
+    let(:whitelist) { double() }
+
+    before do
+      runner.should_receive(:whitelist).and_return(whitelist)
+      Spanx::Actor::LogReader.should_receive(:new).with("logfile", runner.queue, 1, whitelist).and_return(faker)
+    end
+
+    it "should create a log reader" do
+      runner.log_reader.should === faker
+    end
+  end
+
+  describe "#analyzer" do
+    before { Spanx::Actor::Analyzer.should_receive(:new).with(config).and_return(faker) }
+
+    it "should create an analyzer" do
+      runner.analyzer.should === faker
+    end
+  end
+
+  describe "#writer" do
+    before { Spanx::Actor::Writer.should_receive(:new).with(config).and_return(faker) }
+
+    it "should create an analyzer" do
+      runner.writer.should === faker
+    end
+  end
+end

data/spec/spanx/whitelist_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe Spanx::Whitelist do
+  let(:whitelist) { Spanx::Whitelist.new(file) }
+  let(:file) { "spec/fixtures/whitelist.txt" }
+
+
+  describe "#new" do
+    context "with filename" do
+      it "loads whitelist patterns into memory" do
+        whitelist.patterns[0].should eql(/^127\.0\.0\.1/)
+        whitelist.patterns[1].should eql(/^10\.1\.\d{1,3}\.\d{1,3}/)
+        whitelist.patterns.each{ |p| p.is_a?(Regexp).should be_true }
+      end
+    end
+
+    context "without filename" do
+      let(:file) { nil }
+
+      it "keeps an empty whitelist table" do
+        whitelist.patterns.should == []
+      end
+    end
+
+    context "with non-existent file" do
+      let(:file) { "non-existent-whitelist" }
+
+      it "writes an error to stderr and exits" do
+        $stderr.should_receive(:puts).with("Error: Unable to find whitelist file at #{file}")
+        $stderr.should_receive(:puts).with(Spanx::USAGE)
+
+        lambda {
+          whitelist.patterns
+        }.should raise_error(SystemExit)
+      end
+    end
+  end
+
+
+  describe "#match?" do
+    context "IP address matching" do
+      it 'is true if IP address is in match list' do
+        whitelist.match?("127.0.0.1").should be_true
+      end
+
+      it 'is false if IP address does not match patterns' do
+        whitelist.match?("sadfasdf").should be_false
+      end
+    end
+
+    context "User agent matches pattern" do
+      let(:googlebot) { %Q{66.249.73.24 - - [18/Oct/2012:03:25:33 -0700] GET /p/2213071/39535615 HTTP/1.1 "200" 3943 "-" "-" "Mozilla/5.0 (compatible; Googlebot/2.1; +http://www.google.com/bot.html)" "2.87""Mozilla/5.0 (compatible; Googlebot/2.1; +http://www.google.com/bot.html)" "-"upstream_addr 127.0.0.1:8100upstream_response_time 0.082 request_time 0.082}  }
+      it "whitelists googlebot" do
+        whitelist.match?(googlebot).should be_true
+      end
+    end
+
+    context "users/me matches" do
+      let(:log) { %Q{66.249.73.24 - - [18/Oct/2012:03:25:33 -0700] GET /users/me HTTP/1.1 "200" 3943 "-" "-" "Mozilla/5.0 }  }
+      it "excludes users/me" do
+        whitelist.match?(log).should be_true
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require 'rubygems'
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
+require 'spanx'
+
+Dir['spec/support/**/*.rb'].each { |filename| require_relative "../#{filename}" }
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/support/fakeredis.rb

@@ -0,0 +1 @@
+require 'fakeredis/rspec'

data/spec/support/mail.rb

@@ -0,0 +1,10 @@
+require 'mail'
+
+RSpec.configure do |config|
+  config.before(:each) do
+    Mail::TestMailer.deliveries.clear
+    Mail.defaults do
+      delivery_method :test
+    end
+  end
+end

metadata

@@ -0,0 +1,302 @@
+--- !ruby/object:Gem::Specification
+name: spanx
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Konstantin Gredeskoul
+- Eric Saxby
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pause
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+- !ruby/object:Gem::Dependency
+  name: file-tail
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mixlib-cli
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: daemons
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tinder
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.4.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.4.4
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fakeredis
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Real time IP parsing and rate detection gem for access_log files
+email:
+- kigster@gmail.com
+- sax@livinginthepast.org
+executables:
+- spanx
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .pairs
+- .rspec
+- .rvmrc
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/spanx
+- conf/spanx-config.yml.example
+- conf/spanx-whitelist.txt.example
+- lib/spanx.rb
+- lib/spanx/actor/analyzer.rb
+- lib/spanx/actor/collector.rb
+- lib/spanx/actor/log_reader.rb
+- lib/spanx/actor/writer.rb
+- lib/spanx/cli.rb
+- lib/spanx/cli/analyze.rb
+- lib/spanx/cli/disable.rb
+- lib/spanx/cli/enable.rb
+- lib/spanx/cli/flush.rb
+- lib/spanx/cli/watch.rb
+- lib/spanx/config.rb
+- lib/spanx/helper.rb
+- lib/spanx/helper/exit.rb
+- lib/spanx/helper/subclassing.rb
+- lib/spanx/helper/timing.rb
+- lib/spanx/ip_checker.rb
+- lib/spanx/logger.rb
+- lib/spanx/notifier/audit_log.rb
+- lib/spanx/notifier/base.rb
+- lib/spanx/notifier/campfire.rb
+- lib/spanx/notifier/email.rb
+- lib/spanx/runner.rb
+- lib/spanx/usage.rb
+- lib/spanx/version.rb
+- lib/spanx/whitelist.rb
+- spanx.gemspec
+- spec/fixtures/access.log.1
+- spec/fixtures/access.log.bots
+- spec/fixtures/config.yml
+- spec/fixtures/config_with_checks.yml
+- spec/fixtures/whitelist.txt
+- spec/spanx/actor/analyzer_spec.rb
+- spec/spanx/actor/collector_spec.rb
+- spec/spanx/actor/log_reader_spec.rb
+- spec/spanx/actor/writer_spec.rb
+- spec/spanx/config_spec.rb
+- spec/spanx/helper/timing_spec.rb
+- spec/spanx/notifier/base_spec.rb
+- spec/spanx/notifier/campfire_spec.rb
+- spec/spanx/notifier/email_spec.rb
+- spec/spanx/runner_spec.rb
+- spec/spanx/whitelist_spec.rb
+- spec/spec_helper.rb
+- spec/support/fakeredis.rb
+- spec/support/mail.rb
+homepage: https://github.com/wanelo/spanx
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Real time IP parsing and rate detection gem for access_log files
+test_files:
+- spec/fixtures/access.log.1
+- spec/fixtures/access.log.bots
+- spec/fixtures/config.yml
+- spec/fixtures/config_with_checks.yml
+- spec/fixtures/whitelist.txt
+- spec/spanx/actor/analyzer_spec.rb
+- spec/spanx/actor/collector_spec.rb
+- spec/spanx/actor/log_reader_spec.rb
+- spec/spanx/actor/writer_spec.rb
+- spec/spanx/config_spec.rb
+- spec/spanx/helper/timing_spec.rb
+- spec/spanx/notifier/base_spec.rb
+- spec/spanx/notifier/campfire_spec.rb
+- spec/spanx/notifier/email_spec.rb
+- spec/spanx/runner_spec.rb
+- spec/spanx/whitelist_spec.rb
+- spec/spec_helper.rb
+- spec/support/fakeredis.rb
+- spec/support/mail.rb
+has_rdoc: