honeybadger 1.11.2 → 1.12.0.beta2

data/spec/honeybadger/exception_extensions_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe Exception, :unless => defined?(BindingOfCaller) do
+  should { respond_to :__honeybadger_bindings_stack }
+  its(:__honeybadger_bindings_stack) { should eq([]) }
+end
+
+describe Exception, :if => defined?(BindingOfCaller) do
+  describe "#set_backtrace" do
+    context "call stack does not match current file" do
+      it "changes the bindings stack" do
+        expect { subject.set_backtrace(['foo.rb:1']) }.to change(subject, :__honeybadger_bindings_stack).from([])
+      end
+    end
+
+    context "call stack includes current file" do
+      before do
+        subject.stub(:caller).and_return(["#{File.expand_path('../../../lib/honeybadger/exception_extensions.rb', __FILE__)}:1"])
+      end
+
+      it "does not change the bindings stack" do
+        expect { subject.set_backtrace(['foo.rb:1']) }.not_to change(subject, :__honeybadger_bindings_stack).from([])
+      end
+    end
+
+    context "call stack includes a non-matching line" do
+      before do
+        subject.stub(:caller).and_return(['(foo)'])
+      end
+
+      it "skips the non-matching line" do
+        expect { subject.set_backtrace(['foo.rb:1']) }.not_to raise_error
+      end
+
+      it "changes the bindings stack" do
+        expect { subject.set_backtrace(['foo.rb:1']) }.to change(subject, :__honeybadger_bindings_stack).from([])
+      end
+    end
+  end
+end

data/spec/honeybadger/integrations/delayed_job_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe "DelayedJob Dependency" do
+  before do
+    Honeybadger::Dependency.reset!
+  end
+
+  context "when delayed_job is not installed" do
+    it "fails quietly" do
+      expect { Honeybadger::Dependency.inject! }.not_to raise_error
+    end
+  end
+
+  context "when delayed_job is installed" do
+    let(:plugins_array) { [] }
+    let(:plugin_class) do
+      Class.new do
+        def self.callbacks(&block)
+        end
+      end
+    end
+
+    before do
+      Object.const_set(:Delayed, Module.new)
+      ::Delayed.const_set(:Plugins, Module.new)
+      ::Delayed::Plugins.const_set(:Plugin, plugin_class)
+      ::Delayed.const_set(:Worker, double(:plugins => plugins_array))
+    end
+
+    after { Object.send(:remove_const, :Delayed) }
+
+    it "adds the plugin to DelayedJob" do
+      Honeybadger::Dependency.inject!
+      expect(plugins_array).to include(Honeybadger::Integrations::DelayedJob::Plugin)
+    end
+
+    context "and delayed_job_honeybadger is installed" do
+      before do
+        ::Delayed::Plugins.const_set(:Honeybadger, Class.new(plugin_class))
+      end
+
+      it "warns the user of the conflict" do
+        Honeybadger.should_receive(:write_verbose_log).with(/Support for Delayed Job has been moved/, :warn).once
+        Honeybadger::Dependency.inject!
+      end
+    end
+  end
+end

data/spec/honeybadger/integrations/sidekiq_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe "Sidekiq Dependency" do
+  before do
+    Honeybadger::Dependency.reset!
+  end
+
+  context "when sidekiq is not installed" do
+    it "fails quietly" do
+      expect { Honeybadger::Dependency.inject! }.not_to raise_error
+    end
+  end
+
+  context "when sidekiq is installed" do
+    let(:shim) do
+      Class.new do
+        def self.configure_server
+        end
+      end
+    end
+
+    let(:config) { double('config', :error_handlers => []) }
+    let(:chain) { double('chain', :add => true) }
+
+    before do
+      Object.const_set(:Sidekiq, shim)
+      ::Sidekiq.stub(:configure_server).and_yield(config)
+      config.stub(:server_middleware).and_yield(chain)
+    end
+
+    after { Object.send(:remove_const, :Sidekiq) }
+
+    context "when version is less than 3" do
+      before do
+        ::Sidekiq.const_set(:VERSION, '2.17.7')
+      end
+
+      it "adds the server middleware" do
+        chain.should_receive(:add).with(Honeybadger::Integrations::Sidekiq::Middleware)
+        Honeybadger::Dependency.inject!
+      end
+
+      it "doesn't add the error handler" do
+        Honeybadger::Dependency.inject!
+        expect(config.error_handlers).to be_empty
+      end
+    end
+
+    context "when version is 3 or greater" do
+      before do
+        ::Sidekiq.const_set(:VERSION, '3.0.0')
+      end
+
+      it "adds the error handler" do
+        Honeybadger::Dependency.inject!
+        expect(config.error_handlers).not_to be_empty
+      end
+    end
+  end
+end

data/spec/honeybadger/notice_spec.rb

@@ -76,6 +76,17 @@ describe Honeybadger::Notice do
     expect(notice.url).to eq url
   end
 
+  it "initializes default features" do
+    notice = build_notice(:features => nil)
+    expect(notice.features).to eq({})
+  end
+
+  it "accepts features" do
+    features = {'foo' => 'bar'}
+    notice = build_notice(:features => features)
+    expect(notice.features).to eq features
+  end
+
   it "sets the host name" do
     notice = build_notice
     expect(notice.hostname).to eq hostname
@@ -501,53 +512,74 @@ describe Honeybadger::Notice do
     expect { build_notice(:session => { :object => double(:to_ary => {}) }) }.not_to raise_error
   end
 
-  it "extracts data from a rack environment hash" do
-    url = "https://subdomain.happylane.com:100/test/file.rb?var=value&var2=value2"
-    parameters = { 'var' => 'value', 'var2' => 'value2' }
-    env = Rack::MockRequest.env_for(url)
+  context "with a rack environment hash" do
+    it "extracts data from a rack environment hash" do
+      url = "https://subdomain.happylane.com:100/test/file.rb?var=value&var2=value2"
+      parameters = { 'var' => 'value', 'var2' => 'value2' }
+      env = Rack::MockRequest.env_for(url)
 
-    notice = build_notice(:rack_env => env)
+      notice = build_notice(:rack_env => env)
 
-    expect(notice.url).to eq url
-    expect(notice.parameters).to eq parameters
-    expect(notice.cgi_data['REQUEST_METHOD']).to eq 'GET'
-  end
+      expect(notice.url).to eq url
+      expect(notice.parameters).to eq parameters
+      expect(notice.cgi_data['REQUEST_METHOD']).to eq 'GET'
+    end
 
-  it "extracts data from a rack environment hash with action_dispatch info" do
-    params = { 'controller' => 'users', 'action' => 'index', 'id' => '7' }
-    env = Rack::MockRequest.env_for('/', { 'action_dispatch.request.parameters' => params })
+    context "with action_dispatch info" do
+      let(:params) { {'controller' => 'users', 'action' => 'index', 'id' => '7'} }
 
-    notice = build_notice(:rack_env => env)
+      it "extracts data from a rack environment hash " do
+        env = Rack::MockRequest.env_for('/', { 'action_dispatch.request.parameters' => params })
+        notice = build_notice(:rack_env => env)
 
-    expect(notice.parameters).to eq params
-    expect(notice.component).to eq params['controller']
-    expect(notice.action).to eq params['action']
-  end
+        expect(notice.parameters).to eq params
+        expect(notice.component).to eq params['controller']
+        expect(notice.action).to eq params['action']
+      end
+
+      it "removes action_dispatch.request.parameters from cgi_data" do
+        env = Rack::MockRequest.env_for('/', { 'action_dispatch.request.parameters' => params })
+        notice = build_notice(:rack_env => env)
+        expect(notice[:cgi_data]).not_to have_key 'action_dispatch.request.parameters'
+      end
 
-  it "extracts session data from a rack environment" do
-    session_data = { 'something' => 'some value' }
-    env = Rack::MockRequest.env_for('/', 'rack.session' => session_data)
+      it "removes action_dispatch.request.request_parameters from cgi_data" do
+        env = Rack::MockRequest.env_for('/', { 'action_dispatch.request.request_parameters' => params })
+        notice = build_notice(:rack_env => env)
+        expect(notice[:cgi_data]).not_to have_key 'action_dispatch.request.request_parameters'
+      end
+    end
 
-    notice = build_notice(:rack_env => env)
+    it "extracts session data from a rack environment" do
+      session_data = { 'something' => 'some value' }
+      env = Rack::MockRequest.env_for('/', 'rack.session' => session_data)
 
-    expect(notice.session_data).to eq session_data
-  end
+      notice = build_notice(:rack_env => env)
 
-  it "prefers passed session data to rack session data" do
-    session_data = { 'something' => 'some value' }
-    env = Rack::MockRequest.env_for('/')
+      expect(notice.session_data).to eq session_data
+    end
 
-    notice = build_notice(:rack_env => env, :session_data => session_data)
+    it "prefers passed session data to rack session data" do
+      session_data = { 'something' => 'some value' }
+      env = Rack::MockRequest.env_for('/')
 
-    expect(notice.session_data).to eq session_data
-  end
+      notice = build_notice(:rack_env => env, :session_data => session_data)
 
-  unless Gem::Version.new(Rack.release) < Gem::Version.new('1.2')
-    it "fails gracefully when Rack params cannot be parsed" do
-      rack_env = Rack::MockRequest.env_for('http://www.example.com/explode', :method => 'POST', :input => 'foo=bar&bar=baz%')
-      notice = Honeybadger::Notice.new(:rack_env => rack_env)
-      expect(notice.params.size).to eq 1
-      expect(notice.params[:error]).to match(/Failed to call params on Rack::Request/)
+      expect(notice.session_data).to eq session_data
+    end
+
+    if Gem::Version.new(Rack.release) < Gem::Version.new('1.3')
+      it "parses params which are malformed in Rack >= 1.3" do
+        rack_env = Rack::MockRequest.env_for('http://www.example.com/explode', :method => 'POST', :input => 'foo=bar&bar=baz%')
+        expect { Honeybadger::Notice.new(:rack_env => rack_env) }.not_to raise_error
+      end
+    else
+      it "fails gracefully when Rack params cannot be parsed" do
+        rack_env = Rack::MockRequest.env_for('http://www.example.com/explode', :method => 'POST', :input => 'foo=bar&bar=baz%')
+        notice = Honeybadger::Notice.new(:rack_env => rack_env)
+        expect(notice.params.size).to eq 1
+        expect(notice.params[:error]).to match(/Failed to call params on Rack::Request/)
+      end
     end
   end
 
@@ -578,6 +610,115 @@ describe Honeybadger::Notice do
     expect(notice.error_message).to eq 'Something very specific went wrong.'
   end
 
+  describe "#to_json" do
+    context "when local variables are not found" do
+      it "sends local_variables in request payload" do
+        notice = build_notice
+        hash = {'foo' => 'bar'}
+        notice.stub(:local_variables).and_return(hash)
+        expect(JSON.parse(notice.to_json)['request']['local_variables']).to eq(hash)
+      end
+    end
+
+    context "when local variables are found" do
+      it "sends local_variables in request payload" do
+        notice = build_notice
+        expect(JSON.parse(notice.to_json)['request']['local_variables']).to eq({})
+      end
+    end
+  end
+
+  describe "#local_variables" do
+    let(:notice) { build_notice(:exception => @exception, :configuration => configuration) }
+    let(:configuration) { configure }
+
+    before do
+      foo = 'bar'
+      begin
+        fail 'oops'
+      rescue
+        @exception = $!
+      end
+    end
+
+    context "when binding_of_caller is not installed", :unless => defined?(BindingOfCaller) do
+      context "when local variables aren't enabled" do
+        it "does not attempt to find them" do
+          expect(notice.local_variables).to eq({})
+        end
+      end
+
+      context "when local variables are enabled" do
+        before do
+          configuration.send_local_variables = true
+        end
+
+        it "does not attempt to find them" do
+          expect(notice.local_variables).to eq({})
+        end
+      end
+    end
+
+    context "when binding_of_caller is installed", :if => defined?(BindingOfCaller) do
+      context "when local variables aren't enabled" do
+        it "does not attempt to find them" do
+          expect(notice.local_variables).to eq({})
+        end
+      end
+
+      context "when local variables are enabled" do
+        before do
+          configuration.send_local_variables = true
+        end
+
+        it "finds the local variables from first frame of trace" do
+          expect(notice.local_variables[:foo]).to eq 'bar'
+        end
+
+        context "when the feature is disabled" do
+          before do
+            configuration.features['local_variables'] = false
+          end
+
+          it "assigns empty Hash" do
+            expect(notice.local_variables).to eq({})
+          end
+        end
+
+        context "with an application trace" do
+          before do
+            @exception.__honeybadger_bindings_stack.unshift(double('Binding', :eval => nil))
+            configuration.project_root = File.dirname(__FILE__)
+          end
+
+          it "finds the local variables from first frame of application trace" do
+            expect(notice.local_variables[:foo]).to eq 'bar'
+          end
+
+          context "and project_root is a Pathname" do
+            before do
+              configuration.project_root = Pathname.new(File.dirname(__FILE__))
+            end
+
+            specify { expect { notice }.not_to raise_error }
+          end
+        end
+
+        context "without an exception" do
+          it "assigns empty Hash" do
+            expect(build_notice(:exception => nil).local_variables).to eq({})
+          end
+        end
+
+        context "without bindings" do
+          it "assigns empty Hash" do
+            expect(build_notice(:exception => RuntimeError.new).local_variables).to eq({})
+          end
+        end
+      end
+    end
+  end
+
   def assert_accepts_exception_attribute(attribute, args = {}, &block)
     exception = build_exception
     block ||= lambda { exception.send(attribute) }

data/spec/honeybadger/payload_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Honeybadger::Payload do
+  its(:max_depth) { should eq 20 }
+
+  context "when max_depth option is passed to #initialize" do
+    subject { described_class.new({}, :max_depth => 5) }
+    its(:max_depth) { should eq 5 }
+
+    context "when initialized with a bad object" do
+      it "raises ArgumentError" do
+        expect { described_class.new([], :max_depth => 5) }.to raise_error(ArgumentError)
+      end
+    end
+  end
+
+  describe "#sanitize" do
+    let(:deep_hash) { {}.tap {|h| 30.times.each {|i| h = h[i.to_s] = {:string => 'string'} }} }
+    let(:expected_hash) { {}.tap {|h| max_depth.times.each {|i| h = h[i.to_s] = {:string => 'string'} }} }
+    let(:sanitized_hash) { described_class.new(deep_hash, :max_depth => max_depth) }
+    let(:max_depth) { 10 }
+
+    it "truncates nested hashes to max_depth" do
+      expect(sanitized_hash).to eq(expected_hash)
+    end
+  end
+end

data/spec/honeybadger/rails_spec.rb

@@ -1,7 +1,9 @@
 require 'spec_helper'
-require 'honeybadger/rails'
 
-describe Honeybadger::Rails do
+# This test should be run only when Rails is not bundled
+require 'honeybadger/rails' unless defined?(ActionController::Base)
+
+describe 'Honeybadger::Rails', :unless => defined?(ActionController::Base) do
   include DefinesConstants
 
   it "triggers use of Rails' logger if logger isn't set and Rails' logger exists" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: honeybadger
 version: !ruby/object:Gem::Version
-  version: 1.11.2
+  version: 1.12.0.beta2
 platform: ruby
 authors:
 - Joshua Wood
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-13 00:00:00.000000000 Z
+date: 2014-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -227,33 +227,29 @@ files:
 - features/rails.feature
 - features/rake.feature
 - features/sinatra.feature
+- features/standalone.feature
 - features/step_definitions/metal_steps.rb
 - features/step_definitions/rack_steps.rb
 - features/step_definitions/rails_steps.rb
 - features/step_definitions/rake_steps.rb
+- features/step_definitions/standalone_steps.rb
 - features/support/env.rb
 - features/support/honeybadger_failure_shim.rb.template
 - features/support/honeybadger_shim.rb.template
 - features/support/rails.rb
 - features/support/rake/Rakefile
+- gemfiles/binding_of_caller.gemfile
 - gemfiles/rack.gemfile
-- gemfiles/rack.gemfile.lock
+- gemfiles/rails.gemfile
 - gemfiles/rails2.3.gemfile
-- gemfiles/rails2.3.gemfile.lock
 - gemfiles/rails3.0.gemfile
-- gemfiles/rails3.0.gemfile.lock
 - gemfiles/rails3.1.gemfile
-- gemfiles/rails3.1.gemfile.lock
 - gemfiles/rails3.2.gemfile
-- gemfiles/rails3.2.gemfile.lock
 - gemfiles/rails4.0.gemfile
-- gemfiles/rails4.0.gemfile.lock
 - gemfiles/rails4.1.gemfile
-- gemfiles/rails4.1.gemfile.lock
 - gemfiles/rake.gemfile
-- gemfiles/rake.gemfile.lock
 - gemfiles/sinatra.gemfile
-- gemfiles/sinatra.gemfile.lock
+- gemfiles/standalone.gemfile
 - generators/honeybadger/honeybadger_generator.rb
 - generators/honeybadger/lib/insert_commands.rb
 - generators/honeybadger/lib/rake_commands.rb
@@ -268,12 +264,22 @@ files:
 - lib/honeybadger/capistrano/legacy.rb
 - lib/honeybadger/capistrano/tasks.rake
 - lib/honeybadger/configuration.rb
+- lib/honeybadger/dependency.rb
+- lib/honeybadger/exception_extensions.rb
+- lib/honeybadger/integrations.rb
+- lib/honeybadger/integrations/delayed_job.rb
+- lib/honeybadger/integrations/delayed_job/plugin.rb
+- lib/honeybadger/integrations/sidekiq.rb
 - lib/honeybadger/monitor.rb
 - lib/honeybadger/monitor/railtie.rb
 - lib/honeybadger/monitor/sender.rb
 - lib/honeybadger/monitor/worker.rb
 - lib/honeybadger/notice.rb
+- lib/honeybadger/payload.rb
 - lib/honeybadger/rack.rb
+- lib/honeybadger/rack/error_notifier.rb
+- lib/honeybadger/rack/user_feedback.rb
+- lib/honeybadger/rack/user_informer.rb
 - lib/honeybadger/rails.rb
 - lib/honeybadger/rails/action_controller_catcher.rb
 - lib/honeybadger/rails/controller_methods.rb
@@ -297,10 +303,15 @@ files:
 - spec/honeybadger/backtrace_spec.rb
 - spec/honeybadger/capistrano_spec.rb
 - spec/honeybadger/configuration_spec.rb
+- spec/honeybadger/dependency_spec.rb
+- spec/honeybadger/exception_extensions_spec.rb
+- spec/honeybadger/integrations/delayed_job_spec.rb
+- spec/honeybadger/integrations/sidekiq_spec.rb
 - spec/honeybadger/logger_spec.rb
 - spec/honeybadger/monitor/worker_spec.rb
 - spec/honeybadger/notice_spec.rb
 - spec/honeybadger/notifier_spec.rb
+- spec/honeybadger/payload_spec.rb
 - spec/honeybadger/rack_spec.rb
 - spec/honeybadger/rails/action_controller_spec.rb
 - spec/honeybadger/rails_spec.rb
@@ -331,9 +342,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.1.5