honeybadger 1.13.2 → 1.14.0

data/spec/honeybadger/payload_spec.rb

@@ -0,0 +1,162 @@
+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] = (i < max_depth-1 ? {:string => 'string'} : '[max depth reached]') }} }
+    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['0']).to eq(expected_hash['0'])
+    end
+
+    it "does not allow infinite recursion" do
+      hash = {:a => :a}
+      hash[:hash] = hash
+      payload = described_class.new(:request => {:params => hash})
+      expect(payload.request[:params][:hash]).to eq "[possible infinite recursion halted]"
+    end
+
+    it "converts unserializable objects to strings" do
+      assert_serializes(:request, :parameters)
+      assert_serializes(:request, :cgi_data)
+      assert_serializes(:request, :session_data)
+      assert_serializes(:request, :local_variables)
+    end
+
+    it "ensures #to_hash is called on objects that support it" do
+      expect { described_class.new(:session => { :object => double(:to_hash => {}) }) }.not_to raise_error
+    end
+
+    it "ensures #to_ary is called on objects that support it" do
+      expect { described_class.new(:session => { :object => double(:to_ary => {}) }) }.not_to raise_error
+    end
+  end
+
+  it "filters parameters" do
+    assert_filters_request(:params)
+  end
+
+  it "filters cgi data" do
+    assert_filters_request(:cgi_data)
+  end
+
+  it "filters session" do
+    assert_filters_request(:session)
+  end
+
+  it "filters local_variables" do
+    assert_filters_request(:local_variables)
+  end
+
+  context 'filtered parameters in query string' do
+    let(:params_filters) { [:foo, :bar] }
+
+    describe '#url' do
+      subject { described_class.new({:request => {:url => 'https://www.honeybadger.io/?foo=1&bar=2&baz=3'}}, :filters => params_filters).request[:url] }
+
+      it 'filters query' do
+        expect(subject).to eq 'https://www.honeybadger.io/?foo=[FILTERED]&bar=[FILTERED]&baz=3'
+      end
+    end
+
+    describe '#cgi_data' do
+      let(:cgi_data) { { 'QUERY_STRING' => 'foo=1&bar=2&baz=3', 'ORIGINAL_FULLPATH' => '/?foo=1&bar=2&baz=3' } }
+
+      subject { described_class.new({:request => {:cgi_data => cgi_data}}, :filters => params_filters).request[:cgi_data] }
+
+      it 'filters QUERY_STRING key' do
+        expect(subject['QUERY_STRING']).to eq 'foo=[FILTERED]&bar=[FILTERED]&baz=3'
+      end
+
+      it 'filters ORIGINAL_FULLPATH key' do
+        expect(subject['ORIGINAL_FULLPATH']).to eq '/?foo=[FILTERED]&bar=[FILTERED]&baz=3'
+      end
+    end
+  end
+
+  describe '#filter_url!' do
+    subject { described_class.new.send(:filter_url!, url) }
+
+    context 'malformed query' do
+      let(:url) { 'https://www.honeybadger.io/?foobar12' }
+      it { should eq url }
+    end
+
+    context 'no query' do
+      let(:url) { 'https://www.honeybadger.io' }
+      it { should eq url }
+    end
+
+    context 'malformed url' do
+      let(:url) { 'http s ! honeybadger' }
+      before { expect { URI.parse(url) }.to raise_error }
+      it { should eq url }
+    end
+
+    context 'complex url' do
+      let(:url) { 'https://foo:bar@www.honeybadger.io:123/asdf/?foo=1&bar=2&baz=3' }
+      it { should eq url }
+    end
+  end
+
+  def assert_serializes(*keys)
+    [File.open(__FILE__), Proc.new { puts "boo!" }, Module.new].each do |object|
+      hash = {
+        :strange_object => object,
+        :sub_hash => {
+          :sub_object => object
+        },
+        :array => [object]
+      }
+
+      payload_keys = keys.dup
+      last_key = payload_keys.pop
+      payload = described_class.new(payload_keys.reverse.reduce({last_key => hash}) { |a,k| {k => a} })
+
+      first_key = keys.shift
+      hash = keys.reduce(payload[first_key]) {|a,k| a[k] }
+
+      expect(hash[:strange_object]).to eq object.to_s # objects should be serialized
+      expect(hash[:sub_hash]).to be_a Hash # subhashes should be kept
+      expect(hash[:sub_hash][:sub_object]).to eq object.to_s # subhash members should be serialized
+      expect(hash[:array]).to be_a Array # arrays should be kept
+      expect(hash[:array].first).to eq object.to_s # array members should be serialized
+    end
+  end
+
+  def assert_filters_request(attribute)
+    filters  = ["abc", :def, /private/, /^foo_.*$/]
+    original = { 'abc' => "123", 'def' => "456", 'ghi' => "789", 'nested' => { 'abc' => '100' },
+      'something_with_abc' => 'match the entire string', 'private_param' => 'prra',
+      'foo_param' => 'bar', 'not_foo_param' => 'baz', 'nested_foo' => { 'foo_nested' => 'bla'} }
+    filtered = { 'abc'    => "[FILTERED]",
+                 'def'    => "[FILTERED]",
+                 'something_with_abc' => "match the entire string",
+                 'ghi'    => "789",
+                 'nested' => { 'abc' => '[FILTERED]' },
+                 'private_param' => '[FILTERED]',
+                 'foo_param' => '[FILTERED]',
+                 'not_foo_param' => 'baz',
+                 'nested_foo' => { 'foo_nested' => '[FILTERED]'}
+    }
+
+    payload = described_class.new({:request => {attribute => original}}, {:filters => filters})
+
+    expect(payload.request[attribute]).to eq filtered
+  end
+end

data/spec/honeybadger/rack_spec.rb

@@ -1,11 +1,11 @@
 require 'spec_helper'
 require 'rack'
 
-describe Honeybadger::Rack do
+describe Honeybadger::Rack::ErrorNotifier do
   it "calls the upstream app with the environment" do
     environment = { 'key' => 'value' }
     app = lambda { |env| ['response', {}, env] }
-    stack = Honeybadger::Rack.new(app)
+    stack = Honeybadger::Rack::ErrorNotifier.new(app)
 
     response = stack.call(environment)
 
@@ -24,7 +24,7 @@ describe Honeybadger::Rack do
     Honeybadger.should_receive(:notify_or_ignore).with(exception, :rack_env => environment)
 
     begin
-      stack = Honeybadger::Rack.new(app)
+      stack = Honeybadger::Rack::ErrorNotifier.new(app)
       stack.call(environment)
     rescue Exception => raised
       expect(raised).to eq exception
@@ -43,7 +43,7 @@ describe Honeybadger::Rack do
       env['rack.exception'] = exception
       response
     end
-    stack = Honeybadger::Rack.new(app)
+    stack = Honeybadger::Rack::ErrorNotifier.new(app)
 
     Honeybadger.should_receive(:notify_or_ignore).with(exception, :rack_env => environment)
 
@@ -62,7 +62,7 @@ describe Honeybadger::Rack do
       env['sinatra.error'] = exception
       response
     end
-    stack = Honeybadger::Rack.new(app)
+    stack = Honeybadger::Rack::ErrorNotifier.new(app)
 
     Honeybadger.should_receive(:notify_or_ignore).with(exception, :rack_env => environment)
 
@@ -76,7 +76,7 @@ describe Honeybadger::Rack do
     expect(Thread.current[:honeybadger_context]).to eq({ :foo => :bar })
 
     app = lambda { |env| ['response', {}, env] }
-    stack = Honeybadger::Rack.new(app)
+    stack = Honeybadger::Rack::ErrorNotifier.new(app)
 
     stack.call({})
 

data/spec/honeybadger/rails/action_controller_spec.rb

@@ -52,6 +52,8 @@ begin
         data.collect do |value|
           stringify_array_elements(value)
         end
+      elsif Honeybadger::Payload::OBJECT_WHITELIST.any? {|c| data.kind_of?(c) }
+        data
       else
         data.to_s
       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

data/spec/honeybadger/user_feedback_spec.rb

@@ -1,14 +1,14 @@
 require 'spec_helper'
 require 'sham_rack'
 
-describe Honeybadger::UserFeedback do
+describe Honeybadger::Rack::UserFeedback do
   let(:main_app) do
     lambda do |env|
       env['honeybadger.error_id'] = honeybadger_id if defined?(honeybadger_id)
       [200, {}, ["<!-- HONEYBADGER FEEDBACK -->"]]
     end
   end
-  let(:informer_app) { Honeybadger::UserFeedback.new(main_app) }
+  let(:informer_app) { Honeybadger::Rack::UserFeedback.new(main_app) }
   let(:response) { Net::HTTP.get_response(URI.parse("http://example.com/")) }
 
   before do

data/spec/honeybadger/user_informer_spec.rb

@@ -1,13 +1,13 @@
 require 'spec_helper'
 require 'sham_rack'
 
-describe Honeybadger::UserInformer do
+describe Honeybadger::Rack::UserInformer do
   it 'modifies output if there is a honeybadger id' do
     main_app = lambda do |env|
       env['honeybadger.error_id'] = 1
       [200, {}, ["<!-- HONEYBADGER ERROR -->"]]
     end
-    informer_app = Honeybadger::UserInformer.new(main_app)
+    informer_app = Honeybadger::Rack::UserInformer.new(main_app)
 
     ShamRack.mount(informer_app, "example.com")
 
@@ -20,7 +20,7 @@ describe Honeybadger::UserInformer do
     main_app = lambda do |env|
       [200, {}, ["<!-- HONEYBADGER ERROR -->"]]
     end
-    informer_app = Honeybadger::UserInformer.new(main_app)
+    informer_app = Honeybadger::Rack::UserInformer.new(main_app)
 
     ShamRack.mount(informer_app, "example.com")
 

metadata

@@ -1,36 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: honeybadger
 version: !ruby/object:Gem::Version
-  version: 1.13.2
-  prerelease: 
+  version: 1.14.0
 platform: ruby
 authors:
 - Joshua Wood
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-22 00:00:00.000000000 Z
+date: 2014-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   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: cucumber
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -62,7 +55,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: sham_rack
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -70,7 +62,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -78,7 +69,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -86,7 +76,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -94,7 +83,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -102,7 +90,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -110,129 +97,113 @@ dependencies:
 - !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: 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: sinatra
   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: aruba
   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: appraisal
   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: fuubar
   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: growl
   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: webmock
   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: Make managing application errors a more pleasant experience.
@@ -257,33 +228,33 @@ files:
 - features/rails3.x.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/step_definitions/thor_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
+- features/support/test.thor
+- features/thor.feature
+- 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
+- gemfiles/thor.gemfile
 - generators/honeybadger/honeybadger_generator.rb
 - generators/honeybadger/lib/insert_commands.rb
 - generators/honeybadger/lib/rake_commands.rb
@@ -298,13 +269,23 @@ 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/integrations/thor.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
@@ -328,10 +309,16 @@ 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/integrations/thor_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
@@ -348,6 +335,7 @@ files:
 - spec/support/helpers.rb
 homepage: http://www.honeybadger.io
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options:
 - --charset=UTF-8
@@ -355,23 +343,18 @@ rdoc_options:
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2811727937091942835
 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.1.5
 signing_key: 
 specification_version: 2
 summary: Error reports you can be happy about.