hydraulic_brake 0.1.0 → 0.2.0

data/test/async_sender_test.rb

@@ -0,0 +1,105 @@
+require File.expand_path '../helper', __FILE__
+
+class AsyncSenderTest < Test::Unit::TestCase
+  def setup
+    reset_config
+  end
+
+  def build_sync_sender
+    klass = Class.new do
+      attr_reader :notices_sent
+
+      def send_to_airbrake(notice)
+        @notices_sent ||= []
+        @notices_sent.push notice
+      end
+    end
+
+    klass.new
+  end
+
+  def build_sender(opts = {})
+    HydraulicBrake::AsyncSender.new(
+      :sync_sender => build_sync_sender,
+      :capacity => 5)
+  end
+
+  def build_notice
+    HydraulicBrake::Notice.new(
+      :error_class => "FooBar", :error_message => "Foo Bar")
+  end
+
+  def wait_for_thread(thread)
+    # wait for the sending thread to stop running
+    while thread.status == 'run'
+      sleep 0.01
+    end
+  end
+
+  def mock_logger
+    logger_class = Class.new do
+      attr_reader :errors
+
+      def error(blob)
+        @errors ||= []
+        @errors.push(blob)
+      end
+
+      def debug(blob); end
+    end
+
+    logger_class.new
+  end
+
+  should "send a notice" do
+    notice = build_notice
+    sender = build_sender
+
+    sender.send_to_airbrake(notice)
+    wait_for_thread(sender.thread)
+
+    notices_sent = sender.sync_sender.notices_sent
+    assert notices_sent == [ notice ]
+  end
+
+  should "send multiple notices" do
+    notice1 = build_notice
+    notice2 = build_notice
+    notice3 = build_notice
+    sender = build_sender
+
+    sender.send_to_airbrake(notice1)
+    sender.send_to_airbrake(notice2)
+    sender.send_to_airbrake(notice3)
+
+    wait_for_thread(sender.thread)
+
+    notices_sent = sender.sync_sender.notices_sent
+    assert notices_sent == [ notice1, notice2, notice3 ]
+  end
+
+  should "reach capacity and stop accepting notices" do
+    logger = mock_logger
+
+    HydraulicBrake.configure do |c|
+      c.logger = logger
+    end
+
+    notices = (1..100).map { build_notice }
+    sender = build_sender
+
+    notices.each { |n| sender.send_to_airbrake n }
+    wait_for_thread(sender.thread)
+    notices_sent = sender.sync_sender.notices_sent
+
+    assert(
+      notices_sent[0, 5] == notices[0, 5],
+      'at least the first five errors should be delivered')
+    assert(
+      notices_sent.size < 100,
+      'less than all the errors should be delivered')
+    assert(
+      logger.errors.size == notices.size - notices_sent.size,
+      'for every error that was not delivered, an error should be logged')
+  end
+end

data/test/configuration_test.rb

@@ -5,20 +5,21 @@ class ConfigurationTest < Test::Unit::TestCase
   include DefinesConstants
 
   should "provide default values" do
-    assert_config_default :proxy_host,          nil
-    assert_config_default :proxy_port,          nil
-    assert_config_default :proxy_user,          nil
-    assert_config_default :proxy_pass,          nil
-    assert_config_default :project_root,        nil
-    assert_config_default :environment_name,    nil
-    assert_config_default :logger,              nil
-    assert_config_default :notifier_version,    HydraulicBrake::VERSION
-    assert_config_default :notifier_name,       'HydraulicBrake Notifier'
-    assert_config_default :notifier_url,        'https://github.com/stevecrozz/hydraulic_brake'
-    assert_config_default :secure,              false
-    assert_config_default :host,                'api.airbrake.io'
-    assert_config_default :http_open_timeout,   2
-    assert_config_default :http_read_timeout,   5
+    assert_config_default :async,                false
+    assert_config_default :async_queue_capacity, 100
+    assert_config_default :proxy_host,           nil
+    assert_config_default :proxy_port,           nil
+    assert_config_default :proxy_user,           nil
+    assert_config_default :proxy_pass,           nil
+    assert_config_default :project_root,         nil
+    assert_config_default :environment_name,     nil
+    assert_config_default :notifier_version,     HydraulicBrake::VERSION
+    assert_config_default :notifier_name,        'HydraulicBrake Notifier'
+    assert_config_default :notifier_url,         'https://github.com/stevecrozz/hydraulic_brake'
+    assert_config_default :secure,               false
+    assert_config_default :host,                 'api.airbrake.io'
+    assert_config_default :http_open_timeout,    2
+    assert_config_default :http_read_timeout,    5
     assert_config_default :params_filters,
                           HydraulicBrake::Configuration::DEFAULT_PARAMS_FILTERS
     assert_config_default :backtrace_filters,
@@ -51,6 +52,8 @@ class ConfigurationTest < Test::Unit::TestCase
   end
 
   should "allow values to be overwritten" do
+    assert_config_overridable :async
+    assert_config_overridable :async_queue_capacity
     assert_config_overridable :proxy_host
     assert_config_overridable :proxy_port
     assert_config_overridable :proxy_user
@@ -110,7 +113,7 @@ class ConfigurationTest < Test::Unit::TestCase
 
   should "use development and test as development environments by default" do
     config = HydraulicBrake::Configuration.new
-    assert_same_elements %w(development test cucumber), config.development_environments
+    assert_same_elements %w(development test), config.development_environments
   end
 
   should "be public in a public environment" do
@@ -132,6 +135,11 @@ class ConfigurationTest < Test::Unit::TestCase
     assert config.public?
   end
 
+  should "use the default logger none is set" do
+    config = HydraulicBrake::Configuration.new
+    assert_kind_of Logger, config.logger
+  end
+
   should "use the assigned logger if set" do
     config = HydraulicBrake::Configuration.new
     config.logger = "CUSTOM LOGGER"

data/test/helper.rb

@@ -1,14 +1,17 @@
 require 'simplecov'
-SimpleCov.start
+SimpleCov.start do
+  add_filter '/test/'
+end
 require 'test/unit'
 require 'rubygems'
 
 $LOAD_PATH << File.expand_path(File.join(File.dirname(__FILE__), "..", "lib"))
 
+require 'mocha/setup'
+require 'bourne'
 require 'shoulda'
 require 'nokogiri'
-require 'bourne'
-require "hydraulic_brake"
+require 'hydraulic_brake'
 
 begin require 'redgreen'; rescue LoadError; end
 
@@ -93,6 +96,7 @@ class Test::Unit::TestCase
     HydraulicBrake.configuration = nil
     HydraulicBrake.configure do |config|
       config.api_key = 'abc123'
+      config.logger = FakeLogger.new
     end
   end
 
@@ -128,6 +132,10 @@ class Test::Unit::TestCase
     }
   end
 
+  def build_notice(exception = nil)
+    HydraulicBrake::Notice.new(build_notice_data(exception))
+  end
+
   def assert_caught_and_sent
     assert !HydraulicBrake.sender.collected.empty?
   end

data/test/logger_test.rb

@@ -11,7 +11,7 @@ class LoggerTest < Test::Unit::TestCase
   end
 
   def send_notice
-    HydraulicBrake.sender.send_to_airbrake({'foo' => "bar"})
+    HydraulicBrake.sender.send_to_airbrake(build_notice)
   end
 
   def stub_verbose_log

data/test/notifier_test.rb

@@ -131,7 +131,8 @@ class NotifierTest < Test::Unit::TestCase
     config_opts = { 'one' => 'two', 'three' => 'four' }
     stub_notice!
     stub_sender!
-    HydraulicBrake.configuration = stub('config', :merge => config_opts, :public? => true)
+    HydraulicBrake.configuration = stub(
+      'config', :merge => config_opts, :public? => true, :async => false)
 
     HydraulicBrake.notify(exception)
 
@@ -140,6 +141,22 @@ class NotifierTest < Test::Unit::TestCase
     end
   end
 
+  should "use sync sender when async is false" do
+    HydraulicBrake.configure do |config|
+      config.async = false
+    end
+
+    assert_kind_of HydraulicBrake::Sender, HydraulicBrake.sender
+  end
+
+  should "use async sender when async is true" do
+    HydraulicBrake.configure do |config|
+      config.async = true
+    end
+
+    assert_kind_of HydraulicBrake::AsyncSender, HydraulicBrake.sender
+  end
+
   context "building notice JSON for an exception" do
     setup do
       @params    = { :controller => "users", :action => "create" }

data/test/sender_test.rb

@@ -12,15 +12,27 @@ class SenderTest < Test::Unit::TestCase
     end
   end
 
+  def build_logger
+    klass = Class.new do
+      attr_reader :errors, :infos, :debugs
+
+      def error(i); @errors ||= []; @errors << i; end
+      def info(i); @infos ||= []; @infos << i; end
+      def debug(i); @debugs ||= []; @debugs << i; end
+    end
+
+    klass.new
+  end
+
   def send_exception(args = {})
-    notice = args.delete(:notice) || build_notice_data
-    notice.stubs(:to_xml)
+    notice = args.delete(:notice) || HydraulicBrake::Notice.new(args)
     sender = args.delete(:sender) || build_sender(args)
     sender.send_to_airbrake(notice)
   end
 
-  def stub_http(options = {})
-    response = stub(:body => options[:body] || 'body')
+  def stub_http(response=nil)
+    response ||= stub(:body => 'body')
+
     http = stub(:post          => response,
                 :read_timeout= => nil,
                 :open_timeout= => nil,
@@ -31,19 +43,6 @@ class SenderTest < Test::Unit::TestCase
     http
   end
 
-  should "post to Airbrake with XML passed" do
-    xml_notice = HydraulicBrake::Notice.new(:error_class => "FooBar", :error_message => "Foo Bar").to_xml
-
-    http = stub_http
-
-    sender = build_sender
-    sender.send_to_airbrake(xml_notice)
-
-    assert_received(http, :post) do |expect|
-      expect.with(anything, xml_notice, HydraulicBrake::HEADERS)
-    end
-  end
-
   should "post to Airbrake with a Notice instance passed" do
     notice = HydraulicBrake::Notice.new(:error_class => "FooBar", :error_message => "Foo Bar")
 
@@ -87,10 +86,33 @@ class SenderTest < Test::Unit::TestCase
   end
 
   should "return the created group's id on successful posting" do
-    http = stub_http(:body => '<id type="integer">3799307</id>')
+    response = Net::HTTPSuccess.new(1.0, 200, "OK")
+    def response.body
+      '<id type="integer">3799307</id>'
+    end
+
+    stub_http(response)
     assert_equal "3799307", send_exception(:secure => false)
   end
 
+  should "log the url to the error on successful posting" do
+    response = Net::HTTPSuccess.new(1.0, 200, "OK")
+    def response.body
+      '<id type="integer">3799307</id><url>http://some-url.com/foo</url>'
+    end
+
+    logger = build_logger
+
+    HydraulicBrake.configure do |c|
+      c.logger = logger
+    end
+
+    stub_http(response)
+    send_exception(:secure => false)
+    matcher = %r{Success: sent error to Airbrake: http://some-url.com/foo}
+    assert_match matcher, logger.infos.first
+  end
+
   context "when encountering exceptions: " do
     context "HTTP connection setup problems" do
       should "not be rescued" do

metadata

@@ -1,190 +1,139 @@
 --- !ruby/object:Gem::Specification
 name: hydraulic_brake
 version: !ruby/object:Gem::Version
-  version: 0.1.0
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - Stephen Crosby
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-19 00:00:00.000000000 Z
+date: 2015-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
   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: bourne
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: cucumber
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.10.6
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.10.6
+        version: 1.5.0
 - !ruby/object:Gem::Dependency
   name: fakeweb
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: jeweler
   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: nokogiri
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.4.3.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.4.3.1
 - !ruby/object:Gem::Dependency
   name: rake
   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: rspec
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.6.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.6.0
 - !ruby/object:Gem::Dependency
   name: shoulda
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.11.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.11.3
 - !ruby/object:Gem::Dependency
   name: simplecov
   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: yard
   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: Sends notifications to an Airbrake server
@@ -194,35 +143,30 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
-- .rbenv-version
-- .rvmrc
-- .yardopts
+- ".gitignore"
+- ".rvmrc"
+- ".travis.yml"
+- ".yardopts"
 - Gemfile
 - INSTALL
 - MIT-LICENSE
 - README.md
 - Rakefile
 - VERSION
-- features/rake.feature
-- features/step_definitions/rake_steps.rb
-- features/support/matchers.rb
-- features/support/rake/Rakefile
-- features/support/terminal.rb
 - hydraulic_brake.gemspec
 - lib/hydraulic_brake.rb
+- lib/hydraulic_brake/async_sender.rb
 - lib/hydraulic_brake/backtrace.rb
 - lib/hydraulic_brake/configuration.rb
-- lib/hydraulic_brake/hook.rb
 - lib/hydraulic_brake/notice.rb
 - lib/hydraulic_brake/sender.rb
 - lib/hydraulic_brake/test_notification.rb
 - lib/hydraulic_brake/version.rb
-- lib/hydraulic_brake_tasks.rb
 - resources/README.md
 - resources/ca-bundle.crt
-- script/deploy_integration_test.rb
 - script/notify_integration_test.rb
 - test/airbrake_2_3.xsd
+- test/async_sender_test.rb
 - test/backtrace_test.rb
 - test/configuration_test.rb
 - test/helper.rb
@@ -234,29 +178,26 @@ files:
 homepage: http://github.com/stevecrozz/hydraulic_brake
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2276683694056635469
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 3
 summary: Simple Airbrake client
 test_files: []
+has_rdoc: