honeybadger 1.12.0.beta3 → 1.13.0

data/lib/honeybadger/rack.rb

@@ -1,12 +1,58 @@
-require 'honeybadger/rack/error_notifier'
-require 'honeybadger/rack/user_informer'
-require 'honeybadger/rack/user_feedback'
-
 module Honeybadger
-  module Rack
-    def self.new(*args, &block)
-      warn '[DEPRECATION] Honeybadger::Rack is deprecated in 2.0. Use Honeybadger::Rack::ErrorNotifier.'
-      ErrorNotifier.new(*args, &block)
+  # Middleware for Rack applications. Any errors raised by the upstream
+  # application will be delivered to Honeybadger and re-raised.
+  #
+  # Synopsis:
+  #
+  #   require 'rack'
+  #   require 'honeybadger'
+  #
+  #   Honeybadger.configure do |config|
+  #     config.api_key = 'my_api_key'
+  #   end
+  #
+  #   app = Rack::Builder.app do
+  #     run lambda { |env| raise "Rack down" }
+  #   end
+  #
+  #   use Honeybadger::Rack
+  #   run app
+  #
+  # Use a standard Honeybadger.configure call to configure your api key.
+  class Rack
+    def initialize(app)
+      @app = app
+      Honeybadger.configuration.framework = "Rack: #{::Rack.release}"
+    end
+
+    def ignored_user_agent?(env)
+      true if Honeybadger.
+        configuration.
+        ignore_user_agent.
+        flatten.
+        any? { |ua| ua === env['HTTP_USER_AGENT'] }
+    end
+
+    def notify_honeybadger(exception,env)
+      Honeybadger.notify_or_ignore(exception, :rack_env => env) unless ignored_user_agent?(env)
+    end
+
+    def call(env)
+      begin
+        response = @app.call(env)
+      rescue Exception => raised
+        env['honeybadger.error_id'] = notify_honeybadger(raised, env)
+        raise
+      ensure
+        Honeybadger.context.clear!
+      end
+
+      framework_exception = env['rack.exception'] || env['sinatra.error']
+      if framework_exception
+        env['honeybadger.error_id'] = notify_honeybadger(framework_exception, env)
+      end
+
+      response
     end
   end
 end

data/lib/honeybadger/rails.rb

@@ -18,11 +18,11 @@ module Honeybadger
 
       if defined?(::Rails.configuration) && ::Rails.configuration.respond_to?(:middleware)
         ::Rails.configuration.middleware.insert_after 'ActionController::Failsafe',
-                                                      Honeybadger::Rack::ErrorNotifier
+                                                      Honeybadger::Rack
         ::Rails.configuration.middleware.insert_after 'Rack::Lock',
-                                                      Honeybadger::Rack::UserInformer
-        ::Rails.configuration.middleware.insert_after Honeybadger::Rack::UserInformer,
-                                                      Honeybadger::Rack::UserFeedback
+                                                      Honeybadger::UserInformer
+        ::Rails.configuration.middleware.insert_after Honeybadger::UserInformer,
+                                                      Honeybadger::UserFeedback
       end
 
       Honeybadger.configure(true) do |config|
@@ -34,7 +34,6 @@ module Honeybadger
 
       if defined?(::Rails.configuration) && ::Rails.configuration.respond_to?(:after_initialize)
         ::Rails.configuration.after_initialize do
-          Honeybadger::Dependency.inject!
           Honeybadger.ping(Honeybadger.configuration)
         end
       end

data/lib/honeybadger/railtie.rb

@@ -10,9 +10,9 @@ module Honeybadger
     end
 
     initializer "honeybadger.use_rack_middleware" do |app|
-      app.config.middleware.insert 0, "Honeybadger::Rack::UserInformer"
-      app.config.middleware.insert_after "Honeybadger::Rack::UserInformer","Honeybadger::Rack::UserFeedback"
-      app.config.middleware.insert_after "Honeybadger::Rack::UserFeedback","Honeybadger::Rack::ErrorNotifier"
+      app.config.middleware.insert 0, "Honeybadger::UserInformer"
+      app.config.middleware.insert_after "Honeybadger::UserInformer","Honeybadger::UserFeedback"
+      app.config.middleware.insert_after "Honeybadger::UserFeedback","Honeybadger::Rack"
     end
 
     config.after_initialize do
@@ -44,7 +44,6 @@ module Honeybadger
         ::ActionDispatch::ShowExceptions.send(:include,Honeybadger::Rails::Middleware::ExceptionsCatcher)
       end
 
-      Honeybadger::Dependency.inject!
       Honeybadger.ping(Honeybadger.configuration)
     end
   end

data/lib/honeybadger/user_feedback.rb

@@ -1,8 +1,72 @@
+require 'erb'
+require 'uri'
+
+begin
+  require 'i18n'
+rescue LoadError
+  module Honeybadger
+    module I18n
+      def self.t(key, options={})
+        options[:default]
+      end
+    end
+  end
+end
+
 module Honeybadger
-  class UserFeedback < Rack::UserFeedback
+  class UserFeedback
     def initialize(app)
-      warn '[DEPRECATION] Honeybadger::UserFeedback is deprecated in 2.0. Use Honeybadger::Rack::UserFeedback.'
-      super
+      @app = app
+    end
+
+    def call(env)
+      status, headers, body = @app.call(env)
+      if enabled? && env['honeybadger.error_id'] && form = render_form(env['honeybadger.error_id'])
+        new_body = []
+        body.each do |chunk|
+          new_body << chunk.gsub("<!-- HONEYBADGER FEEDBACK -->", form)
+        end
+        body.close if body.respond_to?(:close)
+        headers['Content-Length'] = new_body.reduce(0) { |a,e| a += e.bytesize }.to_s
+        body = new_body
+      end
+      [status, headers, body]
+    end
+
+    def config
+      Honeybadger.configuration
+    end
+
+    def enabled?
+      config.feedback && config.features['feedback']
+    end
+
+    def action
+      URI.parse("#{config.protocol}://#{config.host}:#{config.port}/v1/feedback/").to_s
+    rescue URI::InvalidURIError
+      nil
+    end
+
+    def render_form(error_id, action = action)
+      return unless action
+      ERB.new(@template ||= File.read(template_file)).result(binding)
+    end
+
+    def custom_template_file
+      @custom_template_file ||= config.project_root &&
+        File.join(config.project_root, 'lib', 'honeybadger', 'templates', 'feedback_form.erb')
+    end
+
+    def custom_template_file?
+      custom_template_file && File.exists?(custom_template_file)
+    end
+
+    def template_file
+      if custom_template_file?
+        custom_template_file
+      else
+        File.expand_path('../templates/feedback_form.erb', __FILE__)
+      end
     end
   end
 end

data/lib/honeybadger/user_informer.rb

@@ -1,8 +1,26 @@
 module Honeybadger
-  class UserInformer < Rack::UserInformer
+  class UserInformer
     def initialize(app)
-      warn '[DEPRECATION] Honeybadger::UserInformer is deprecated in 2.0. Use Honeybadger::Rack::UserInformer.'
-      super
+      @app = app
+    end
+
+    def replacement(with)
+      Honeybadger.configuration.user_information.gsub(/\{\{\s*error_id\s*\}\}/, with.to_s)
+    end
+
+    def call(env)
+      status, headers, body = @app.call(env)
+      if env['honeybadger.error_id'] && Honeybadger.configuration.user_information
+        new_body = []
+        replace  = replacement(env['honeybadger.error_id'])
+        body.each do |chunk|
+          new_body << chunk.gsub("<!-- HONEYBADGER ERROR -->", replace)
+        end
+        body.close if body.respond_to?(:close)
+        headers['Content-Length'] = new_body.reduce(0) { |a,e| a += e.bytesize }.to_s
+        body = new_body
+      end
+      [status, headers, body]
     end
   end
 end

data/spec/honeybadger/configuration_spec.rb

@@ -30,13 +30,11 @@ describe Honeybadger::Configuration do
     assert_config_default :source_extract_radius, 2
     assert_config_default :async, nil
     assert_config_default :send_request_session, true
-    assert_config_default :send_local_variables, false
     assert_config_default :debug, false
     assert_config_default :log_exception_on_send_failure, false
     assert_config_default :fingerprint, nil
     assert_config_default :hostname, Socket.gethostname
     assert_config_default :feedback, true
-    assert_config_default :features, {'notices' => true, 'local_variables' => true}
   end
 
   it "configures async as Proc" do
@@ -118,7 +116,6 @@ describe Honeybadger::Configuration do
     assert_config_overridable :send_request_session
     assert_config_overridable :debug
     assert_config_overridable :hostname
-    assert_config_overridable :features
     assert_config_overridable :metrics
     assert_config_overridable :feedback
     assert_config_overridable :log_exception_on_send_failure
@@ -137,8 +134,7 @@ describe Honeybadger::Configuration do
      :notifier_version, :params_filters, :project_root, :port, :protocol,
      :proxy_host, :proxy_pass, :proxy_port, :proxy_user, :secure,
      :source_extract_radius, :async, :send_request_session, :debug,
-     :fingerprint, :hostname, :features, :metrics, :feedback,
-     :log_exception_on_send_failure].each do |option|
+     :fingerprint, :hostname, :metrics, :feedback, :log_exception_on_send_failure].each do |option|
        expect(hash[option]).to eq config[option]
     end
   end

data/spec/honeybadger/notice_spec.rb

@@ -76,17 +76,6 @@ 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
@@ -568,12 +557,7 @@ describe Honeybadger::Notice do
       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
+    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)
@@ -610,115 +594,6 @@ 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/rails_spec.rb

@@ -1,9 +1,7 @@
 require 'spec_helper'
+require 'honeybadger/rails'
 
-# 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
+describe Honeybadger::Rails do
   include DefinesConstants
 
   it "triggers use of Rails' logger if logger isn't set and Rails' logger exists" do

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: honeybadger
 version: !ruby/object:Gem::Version
-  version: 1.12.0.beta3
-  prerelease: 7
+  version: 1.13.0
+  prerelease: 
 platform: ruby
 authors:
 - Joshua Wood
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-08 00:00:00.000000000 Z
+date: 2014-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -256,33 +256,33 @@ 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/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/rails.gemfile
+- gemfiles/rack.gemfile.lock
 - 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/standalone.gemfile
-- gemfiles/thor.gemfile
+- gemfiles/sinatra.gemfile.lock
 - generators/honeybadger/honeybadger_generator.rb
 - generators/honeybadger/lib/insert_commands.rb
 - generators/honeybadger/lib/rake_commands.rb
@@ -297,23 +297,13 @@ 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
@@ -337,16 +327,10 @@ 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
@@ -377,13 +361,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -754790268402252973
+      hash: -2545053771295497767
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23