hydraulic_brake 0.1.0 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 83e086fbfbdec0c32a3e454b8c53c5589c7b8439
+  data.tar.gz: 339f4004d5a2e02447cbf211733bba531c89a4dd
+SHA512:
+  metadata.gz: 76803cffcf750e04c17cc953b01a2f57f374c64cdcdc1caf4626ea535893aa78924f2d731df9dac8df576cb56926b24bacf562a400c21b67106cbd0080f454a3
+  data.tar.gz: e7a13f6265a431a26fc4e833a6fac075375d680e9b002b7b1e4af096a4c7982240cc49a55fb5239cbf3841623730ed56a64eae55dedf7ce63262fca1097bab9f

data/.gitignore

@@ -0,0 +1,20 @@
+log/*
+tmp
+db/schema.rb
+db/*.sqlite3
+public/system
+*.swp
+*.DS_Store
+coverage/*
+rdoc/
+tags
+.yardoc
+doc
+pkg
+
+Gemfile.lock
+.bundle
+
+*.rbc
+*.plan
+.ruby-version

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.1.1
+  - jruby-head
+  - rbx
+script: bundle exec rake test

data/Gemfile

@@ -1,16 +1,3 @@
 source "http://rubygems.org"
 
-gem "builder"
-
-group "development" do
-  gem "bourne", ">= 1.0"
-  gem "cucumber", "~> 0.10.6"
-  gem "fakeweb", "~> 1.3.0"
-  gem "jeweler"
-  gem "nokogiri", "~> 1.4.3.1"
-  gem "rake"
-  gem "rspec", "~> 2.6.0"
-  gem "shoulda", "~> 2.11.3"
-  gem "simplecov"
-  gem "yard"
-end
+gemspec

data/README.md

@@ -1,5 +1,4 @@
-HydraulicBrake
-========
+# HydraulicBrake [![Build Status](https://travis-ci.org/stevecrozz/hydraulic_brake.svg?branch=master)](https://travis-ci.org/stevecrozz/hydraulic_brake)
 
 This is a replacement notifier gem for the [Airbrake
 gem](https://github.com/airbrake/airbrake) which is used
@@ -76,9 +75,20 @@ HydraulicBrake#notify.
 Async Notifications
 -------------------
 
-HydraulicBrake doesn't provide anything special for async notifications.
-Just wrap your calls to Airbrake#notify in the async library of your
-choice if you want to.
+HydraulicBrake can send notifications for you in the background using a Ruby
+thread. If configured for async notifications, calls to HydraulicBrake::Notify
+will populate an in-memory queue up to a configurable limit. If you reach the
+limit, HydraulicBrake will send an error to HydraulicBrake.logger for every
+additional notice beyond the queue's capacity and this notice will contain
+information about the notice that could not be sent. Shown below are the
+default options, but you may adjust them to suit your needs.
+
+```ruby
+HydraulicBrake.configure do |config|
+  config.async = false
+  config.async_queue_capacity = 100
+end
+```
 
 Proxy Support
 -------------
@@ -94,7 +104,7 @@ HydraulicBrake.configure do |config|
   config.proxy_pass = bar # optional
 end
 ```
-      
+
 Logging
 ------------
 
@@ -107,22 +117,6 @@ HydraulicBrake.configure do |config|
 end
 ```
 
-Deploy Hook
------------
-
-HydraulicBrake can notify Airbrake whenever you deploy your app. Just
-call HydraulicBrake::Hook#deploy whenever you deploy:
-
-```ruby
-HydraulicBrake::Hook.deploy({
-  :scm_revision => "cd6b969f66ad0794c7117d5030f926b49f82b038",
-  :scm_repository => "stevecrozz/hydraulic_brake",
-  :local_username => "stevecrozz",
-  :rails_env => "production", # everything is rails, right?
-  :message => "Another deployment hook brought to you by HydraulicBrake"
-})
-```
-
 Credits
 -------
 

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/hydraulic_brake.gemspec

@@ -5,55 +5,50 @@
 
 Gem::Specification.new do |s|
   s.name = "hydraulic_brake"
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Stephen Crosby"]
-  s.date = "2013-07-19"
+  s.date = "2015-09-03"
   s.description = "Sends notifications to an Airbrake server"
   s.email = "stevecrozz@gmail.com"
   s.extra_rdoc_files = [
     "README.md"
   ]
-  s.files = [
-    ".rbenv-version",
-    ".rvmrc",
-    ".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/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/backtrace_test.rb",
-    "test/configuration_test.rb",
-    "test/helper.rb",
-    "test/logger_test.rb",
-    "test/notice_test.rb",
-    "test/notifier_test.rb",
-    "test/recursion_test.rb",
-    "test/sender_test.rb"
-  ]
+  s.files = %w(
+    .gitignore
+    .rvmrc
+    .travis.yml
+    .yardopts
+    Gemfile
+    INSTALL
+    MIT-LICENSE
+    README.md
+    Rakefile
+    VERSION
+    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/notice.rb
+    lib/hydraulic_brake/sender.rb
+    lib/hydraulic_brake/test_notification.rb
+    lib/hydraulic_brake/version.rb
+    resources/README.md
+    resources/ca-bundle.crt
+    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
+    test/logger_test.rb
+    test/notice_test.rb
+    test/notifier_test.rb
+    test/recursion_test.rb
+    test/sender_test.rb
+  )
   s.homepage = "http://github.com/stevecrozz/hydraulic_brake"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
@@ -65,38 +60,32 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<builder>, [">= 0"])
-      s.add_development_dependency(%q<bourne>, [">= 1.0"])
-      s.add_development_dependency(%q<cucumber>, ["~> 0.10.6"])
+      s.add_development_dependency(%q<bourne>, ["~> 1.5.0"])
       s.add_development_dependency(%q<fakeweb>, ["~> 1.3.0"])
       s.add_development_dependency(%q<jeweler>, [">= 0"])
       s.add_development_dependency(%q<nokogiri>, ["~> 1.4.3.1"])
       s.add_development_dependency(%q<rake>, [">= 0"])
-      s.add_development_dependency(%q<rspec>, ["~> 2.6.0"])
       s.add_development_dependency(%q<shoulda>, ["~> 2.11.3"])
       s.add_development_dependency(%q<simplecov>, [">= 0"])
       s.add_development_dependency(%q<yard>, [">= 0"])
     else
       s.add_dependency(%q<builder>, [">= 0"])
-      s.add_dependency(%q<bourne>, [">= 1.0"])
-      s.add_dependency(%q<cucumber>, ["~> 0.10.6"])
+      s.add_dependency(%q<bourne>, ["~> 1.5.0"])
       s.add_dependency(%q<fakeweb>, ["~> 1.3.0"])
       s.add_dependency(%q<jeweler>, [">= 0"])
       s.add_dependency(%q<nokogiri>, ["~> 1.4.3.1"])
       s.add_dependency(%q<rake>, [">= 0"])
-      s.add_dependency(%q<rspec>, ["~> 2.6.0"])
       s.add_dependency(%q<shoulda>, ["~> 2.11.3"])
       s.add_dependency(%q<simplecov>, [">= 0"])
       s.add_dependency(%q<yard>, [">= 0"])
     end
   else
     s.add_dependency(%q<builder>, [">= 0"])
-    s.add_dependency(%q<bourne>, [">= 1.0"])
-    s.add_dependency(%q<cucumber>, ["~> 0.10.6"])
+    s.add_dependency(%q<bourne>, ["~> 1.5.0"])
     s.add_dependency(%q<fakeweb>, ["~> 1.3.0"])
     s.add_dependency(%q<jeweler>, [">= 0"])
     s.add_dependency(%q<nokogiri>, ["~> 1.4.3.1"])
     s.add_dependency(%q<rake>, [">= 0"])
-    s.add_dependency(%q<rspec>, ["~> 2.6.0"])
     s.add_dependency(%q<shoulda>, ["~> 2.11.3"])
     s.add_dependency(%q<simplecov>, [">= 0"])
     s.add_dependency(%q<yard>, [">= 0"])

data/lib/hydraulic_brake.rb

@@ -1,9 +1,10 @@
+require 'logger'
 require 'net/http'
 require 'net/https'
 require 'rubygems'
+require 'hydraulic_brake/async_sender'
 require 'hydraulic_brake/backtrace'
 require 'hydraulic_brake/configuration'
-require 'hydraulic_brake/hook'
 require 'hydraulic_brake/notice'
 require 'hydraulic_brake/sender'
 require 'hydraulic_brake/test_notification'
@@ -75,7 +76,15 @@ module HydraulicBrake
     #   end
     def configure(silent = false)
       yield(configuration)
-      self.sender = Sender.new(configuration)
+
+      if configuration.async
+        self.sender = AsyncSender.new(
+          :sync_sender => Sender.new(configuration),
+          :capacity => configuration.async_queue_capacity)
+      else
+        self.sender = Sender.new(configuration)
+      end
+
       report_ready unless silent
       self.sender
     end
@@ -102,7 +111,7 @@ module HydraulicBrake
     # @option opts [String] :session_data The contents of the user's session
     # @option opts [String] :environment_name The application environment name
     def notify(exception, opts = {})
-      send_notice(build_notice_for(exception, opts))
+      send_notice build_notice_for(exception, opts)
     end
 
     def build_lookup_hash_for(exception, options = {})

data/lib/hydraulic_brake/async_sender.rb

@@ -0,0 +1,39 @@
+module HydraulicBrake
+  # In-memory, thread-safe storage for notices that haven't yet been sent to
+  # Airbrake
+  class AsyncSender
+    attr_reader :sync_sender
+    attr_reader :thread
+
+    def initialize(opts={})
+      @sync_sender = opts[:sync_sender]
+      @q = Queue.new
+      @capacity = opts[:capacity] || 100
+      @logger = opts
+      @thread = nil
+    end
+
+    def send_to_airbrake(notice)
+      return will_not_deliver(notice) if @q.length >= @capacity
+
+      @q.push(notice)
+
+      return if @thread && @thread.alive?
+
+      @thread = Thread.new do
+        while n = @q.pop
+          @sync_sender.send_to_airbrake(n)
+        end
+      end
+    end
+
+    private
+    def will_not_deliver(notice)
+      HydraulicBrake.logger.error(
+        "[HydraulicBrake::AsyncSender has reached its capacity of "          \
+        "#{@capacity} and the following notice will not be delivered "       \
+        "Error: #{notice.error_class} - #{notice.error_message}\n"           \
+        "Backtrace: \n#{notice.backtrace}")
+    end
+  end
+end

data/lib/hydraulic_brake/configuration.rb

@@ -4,6 +4,8 @@ module HydraulicBrake
 
     OPTIONS = [
       :api_key,
+      :async,
+      :async_queue_capacity,
       :backtrace_filters,
       :development_environments,
       :development_lookup,
@@ -65,6 +67,14 @@ module HydraulicBrake
     # The password to use when logging into your proxy server (if using a proxy)
     attr_accessor :proxy_pass
 
+    # Send the notice to airbrake using a background thread
+    attr_accessor :async
+
+    # Maxmimum number of notices to store in memory. If the number of notices
+    # waiting to be sent to airbrake reaches this value, further notices will
+    # be dropped until the queue size drops.
+    attr_accessor :async_queue_capacity
+
     # A list of parameters that should be filtered out of what is sent to Airbrake.
     # By default, all "password" attributes will have their contents replaced.
     attr_reader :params_filters
@@ -139,6 +149,8 @@ module HydraulicBrake
     alias_method :use_system_ssl_cert_chain?, :use_system_ssl_cert_chain
 
     def initialize
+      @async                    = false
+      @async_queue_capacity     = 100
       @secure                   = false
       @use_system_ssl_cert_chain= false
       @host                     = 'api.airbrake.io'
@@ -146,7 +158,7 @@ module HydraulicBrake
       @http_read_timeout        = 5
       @params_filters           = DEFAULT_PARAMS_FILTERS.dup
       @backtrace_filters        = DEFAULT_BACKTRACE_FILTERS.dup
-      @development_environments = %w(development test cucumber)
+      @development_environments = %w(development test)
       @development_lookup       = true
       @notifier_name            = 'HydraulicBrake Notifier'
       @notifier_version         = VERSION
@@ -155,6 +167,7 @@ module HydraulicBrake
       @rescue_rake_exceptions   = nil
       @user_attributes          = DEFAULT_USER_ATTRIBUTES.dup
       @rake_environment_filters = []
+      @logger                   = Logger.new(STDOUT)
     end
 
     # Takes a block and adds it to the list of backtrace filters. When the filters

data/lib/hydraulic_brake/sender.rb

@@ -13,7 +13,8 @@ module HydraulicBrake
                    Errno::ECONNREFUSED].freeze
 
     def initialize(options = {})
-      [ :proxy_host,
+      [
+        :proxy_host,
         :proxy_port,
         :proxy_user,
         :proxy_pass,
@@ -31,9 +32,9 @@ module HydraulicBrake
 
     # Sends the notice data off to Airbrake for processing.
     #
-    # @param [Notice or String] notice The notice to be sent off
+    # @param [Notice] notice The notice to be sent off
     def send_to_airbrake(notice)
-      data = notice.respond_to?(:to_xml) ? notice.to_xml : notice
+      data = notice.to_xml
       http = setup_http_connection
 
       response = begin
@@ -47,19 +48,14 @@ module HydraulicBrake
       case response
       when Net::HTTPSuccess then
         log :level => :info,
-            :message => "Success: #{response.class}",
-            :response => response
+            :message => success_message_from_response(response)
+        error_id_from_response(response)
       else
         log :level => :error,
             :message => "Failure: #{response.class}",
             :response => response,
             :notice => notice
       end
-
-      if response && response.respond_to?(:body)
-        error_id = response.body.match(%r{<id[^>]*>(.*?)</id>})
-        error_id[1] if error_id
-      end
     rescue => e
       log :level => :error,
         :message => "[HydraulicBrake::Sender#send_to_airbrake] Cannot send notification. Error: #{e.class}" +
@@ -85,12 +81,44 @@ module HydraulicBrake
 
   private
 
+    def success_message_from_response(response)
+      error_url = error_url_from_response(response)
+
+      if error_url
+        "Success: sent error to Airbrake: #{error_url}"
+      else
+        "Success: sent error to Airbrake"
+      end
+    end
+
+    def error_id_from_response(response)
+      if response && response.respond_to?(:body)
+        error_id = response.body.match(%r{<id[^>]*>(.*?)</id>})
+        return error_id[1] if error_id
+      end
+
+      nil
+    rescue
+      nil
+    end
+
+    def error_url_from_response(response)
+      if response && response.respond_to?(:body)
+        error_url = response.body.match(%r{<url[^>]*>(.*?)</url>})
+        return error_url[1] if error_url
+      end
+
+      nil
+    rescue
+      nil
+    end
+
     def url
       URI.parse("#{protocol}://#{host}:#{port}").merge(NOTICES_URI)
     end
 
     def log(opts = {})
-      opts[:logger].send opts[:level], LOG_PREFIX + opts[:message] if opts[:logger]
+      logger.send opts[:level], LOG_PREFIX + opts[:message]
       HydraulicBrake.report_environment_info
       HydraulicBrake.report_response_body(opts[:response].body) if opts[:response] && opts[:response].respond_to?(:body)
       HydraulicBrake.report_notice(opts[:notice]) if opts[:notice]