honeybadger 1.9.5 → 1.10.0.beta1

data/gemfiles/rake.gemfile

@@ -4,6 +4,5 @@ source "https://rubygems.org"
 
 gem "sinatra"
 gem "honeybadger", :path=>"../"
-gem "faraday", "~> 0.7.0"
 
 gemspec :path=>"../"

data/gemfiles/rake.gemfile.lock

@@ -1,8 +1,7 @@
 PATH
   remote: /Users/josh/code/honeybadger-ruby
   specs:
-    honeybadger (1.9.5)
-      faraday (~> 0.7)
+    honeybadger (1.10.0.beta1)
       json
 
 GEM
@@ -34,10 +33,6 @@ GEM
       gherkin (~> 2.11.7)
       multi_json (~> 1.3)
     diff-lcs (1.2.4)
-    faraday (0.7.6)
-      addressable (~> 2.2)
-      multipart-post (~> 1.1)
-      rack (~> 1.1)
     ffi (1.9.3)
     formatador (0.2.4)
     fuubar (1.2.1)
@@ -65,7 +60,6 @@ GEM
     lumberjack (1.0.4)
     method_source (0.8.2)
     multi_json (1.8.2)
-    multipart-post (1.2.0)
     net-scp (1.1.2)
       net-ssh (>= 2.6.5)
     net-sftp (2.1.2)
@@ -118,7 +112,6 @@ DEPENDENCIES
   aruba
   capistrano (~> 2.0)
   cucumber (~> 1.2.1)
-  faraday (~> 0.7.0)
   fuubar
   growl
   guard (~> 1.8.3)

data/gemfiles/sinatra.gemfile

@@ -4,6 +4,5 @@ source "https://rubygems.org"
 
 gem "sinatra"
 gem "honeybadger", :path=>"../"
-gem "faraday", "~> 0.7.0"
 
 gemspec :path=>"../"

data/gemfiles/sinatra.gemfile.lock

@@ -1,8 +1,7 @@
 PATH
   remote: /Users/josh/code/honeybadger-ruby
   specs:
-    honeybadger (1.9.5)
-      faraday (~> 0.7)
+    honeybadger (1.10.0.beta1)
       json
 
 GEM
@@ -34,10 +33,6 @@ GEM
       gherkin (~> 2.11.7)
       multi_json (~> 1.3)
     diff-lcs (1.2.4)
-    faraday (0.7.6)
-      addressable (~> 2.2)
-      multipart-post (~> 1.1)
-      rack (~> 1.1)
     ffi (1.9.3)
     formatador (0.2.4)
     fuubar (1.2.1)
@@ -65,7 +60,6 @@ GEM
     lumberjack (1.0.4)
     method_source (0.8.2)
     multi_json (1.8.2)
-    multipart-post (1.2.0)
     net-scp (1.1.2)
       net-ssh (>= 2.6.5)
     net-sftp (2.1.2)
@@ -118,7 +112,6 @@ DEPENDENCIES
   aruba
   capistrano (~> 2.0)
   cucumber (~> 1.2.1)
-  faraday (~> 0.7.0)
   fuubar
   growl
   guard (~> 1.8.3)

data/honeybadger.gemspec

@@ -4,8 +4,8 @@ Gem::Specification.new do |s|
   s.rubygems_version = '1.3.5'
 
   s.name              = 'honeybadger'
-  s.version           = '1.9.5'
-  s.date              = '2013-12-06'
+  s.version           = '1.10.0.beta1'
+  s.date              = '2013-12-04'
 
   s.summary     = 'Error reports you can be happy about.'
   s.description = 'Make managing application errors a more pleasant experience.'
@@ -19,7 +19,6 @@ Gem::Specification.new do |s|
   s.rdoc_options = ['--charset=UTF-8', '--markup tomdoc']
   s.extra_rdoc_files = %w[README.md MIT-LICENSE]
 
-  s.add_dependency('faraday', '~> 0.7')
   s.add_dependency('json')
 
   s.add_development_dependency('cucumber',   '~> 1.2.1')
@@ -108,6 +107,9 @@ Gem::Specification.new do |s|
     lib/honeybadger/shared_tasks.rb
     lib/honeybadger/stats.rb
     lib/honeybadger/tasks.rb
+    lib/honeybadger/templates/feedback_form.html.erb
+    lib/honeybadger/user_feedback.rb
+    lib/honeybadger/user_informer.rb
     lib/honeybadger_tasks.rb
     lib/rails/generators/honeybadger/honeybadger_generator.rb
     rails/init.rb
@@ -125,6 +127,8 @@ Gem::Specification.new do |s|
     spec/honeybadger/rails/action_controller_spec.rb
     spec/honeybadger/rails_spec.rb
     spec/honeybadger/sender_spec.rb
+    spec/honeybadger/user_feedback_spec.rb
+    spec/honeybadger/user_informer_spec.rb
     spec/honeybadger_tasks_spec.rb
     spec/spec_helper.rb
     spec/support/array_including.rb

data/lib/honeybadger.rb

@@ -1,5 +1,5 @@
-require 'faraday'
-require 'timeout'
+require 'net/http'
+require 'net/https'
 require 'json'
 require 'digest'
 require 'logger'
@@ -10,16 +10,18 @@ require 'honeybadger/notice'
 require 'honeybadger/rack'
 require 'honeybadger/sender'
 require 'honeybadger/stats'
+require 'honeybadger/user_informer'
+require 'honeybadger/user_feedback'
 
 require 'honeybadger/railtie' if defined?(Rails::Railtie)
 
 module Honeybadger
-  VERSION = '1.9.5'
+  VERSION = '1.10.0.beta1'
   LOG_PREFIX = "** [Honeybadger] "
 
   HEADERS = {
-    'Content-type'             => 'application/json',
-    'Accept'                   => 'text/json, application/json'
+    'Content-type' => 'application/json',
+    'Accept'       => 'text/json, application/json'
   }
 
   class << self

data/lib/honeybadger/configuration.rb

@@ -7,8 +7,8 @@ module Honeybadger
                :ignore_user_agent, :notifier_name, :notifier_url, :notifier_version,
                :params_filters, :project_root, :port, :protocol, :proxy_host, :proxy_pass,
                :proxy_port, :proxy_user, :secure, :use_system_ssl_cert_chain, :framework,
-               :user_information, :rescue_rake_exceptions, :source_extract_radius,
-               :send_request_session, :debug, :fingerprint, :hostname].freeze
+               :user_information, :feedback, :rescue_rake_exceptions, :source_extract_radius,
+               :send_request_session, :debug, :fingerprint, :hostname, :metrics].freeze
 
     # The API key for your project, found on the project edit form.
     attr_accessor :api_key
@@ -84,7 +84,10 @@ module Honeybadger
     # The text that the placeholder is replaced with. {{error_id}} is the actual error number.
     attr_accessor :user_information
 
-    # The framework Honeybadger is configured to use
+    # Display user feedback form when configured?
+    attr_accessor :feedback
+
+    # The framework Honeybadger is configured to use.
     attr_accessor :framework
 
     # Should Honeybadger catch exceptions from Rake tasks?
@@ -173,6 +176,7 @@ module Honeybadger
       @metrics                   = true
       @features                  = { 'notices' => true }
       @limit                     = nil
+      @feedback                  = true
     end
 
     # Public: Takes a block and adds it to the list of backtrace filters. When

data/lib/honeybadger/monitor/sender.rb

@@ -10,19 +10,17 @@ module Honeybadger
           return nil
         end
 
-        response = client.post do |p|
-          p.url "/v1/metrics"
-          p.body = data.to_json
+        response = rescue_http_errors do
+          http_connection.post('/v1/metrics', data.to_json, http_headers)
         end
 
-        if response.success?
+        if Net::HTTPSuccess === response
           true
         else
-          Honeybadger.configuration.features['metrics'] = false if response.status == 403
+          Honeybadger.configuration.features['metrics'] = false if Net::HTTPForbidden === response
           log(:error, "Metrics Failure", response, data)
           false
         end
-
       rescue => e
         log(:error, "[Honeybadger::Monitor::Sender#send_metrics] Error: #{e.class} - #{e.message}\nBacktrace:\n#{e.backtrace.join("\n\t")}")
         true

data/lib/honeybadger/notice.rb

@@ -82,11 +82,13 @@ module Honeybadger
     # System stats
     attr_reader :stats
 
+    # The api_key to use when sending notice (optional)
+    attr_reader :api_key
+
     def initialize(args)
       self.args         = args
       self.exception    = args[:exception]
       self.project_root = args[:project_root]
-      self.url          = args[:url] || rack_env(:url)
 
       self.notifier_name    = args[:notifier_name]
       self.notifier_version = args[:notifier_version]
@@ -114,8 +116,10 @@ module Honeybadger
         end
       end
 
+      self.url              = filter_url(args[:url] || rack_env(:url))
       self.hostname         = local_hostname
       self.stats            = Stats.all
+      self.api_key          = args[:api_key]
 
       self.source_extract_radius = args[:source_extract_radius] || 2
       self.source_extract        = extract_source_from_backtrace
@@ -143,6 +147,7 @@ module Honeybadger
     # Returns JSON representation of notice
     def as_json(options = {})
       {
+        :api_key => api_key,
         :notifier => {
           :name => notifier_name,
           :url => notifier_url,
@@ -231,7 +236,7 @@ module Honeybadger
       :environment_filters, :session_data, :project_root, :url, :ignore,
       :ignore_by_filters, :notifier_name, :notifier_url, :notifier_version,
       :component, :action, :cgi_data, :environment_name, :hostname, :stats, :context,
-      :source_extract, :source_extract_radius, :send_request_session
+      :source_extract, :source_extract_radius, :send_request_session, :api_key
 
     # Private: Arguments given in the initializer
     attr_accessor :args
@@ -291,7 +296,24 @@ module Honeybadger
       end
     end
 
-    # Private: Replaces the contents of params that match params_filters.
+    # Internal: Filters query parameters from URL
+    #
+    # url - String URL to filter
+    #
+    # Returns filtered String URL
+    def filter_url(url)
+      return nil unless url =~ /\S/
+
+      url = url.dup
+      url.scan(/&([^=]+)=([^&]+)/).each do |m|
+        next unless filter_key?(m[0])
+        url.gsub!(/#{m[1]}/, '[FILTERED]')
+      end
+
+      url
+    end
+
+    # Internal: Replaces the contents of params that match params_filters.
     # TODO: extract this to a different class
     def clean_params
       clean_unserializable_data_from(:parameters)
@@ -360,7 +382,11 @@ module Honeybadger
 
     def filter_key?(key)
       params_filters.any? do |filter|
-        key.to_s.eql?(filter.to_s)
+        if filter.is_a?(Regexp)
+          key.to_s =~ filter
+        else
+          key.to_s.eql?(filter.to_s)
+        end
       end
     end
 

data/lib/honeybadger/rails.rb

@@ -19,6 +19,8 @@ module Honeybadger
       if defined?(::Rails.configuration) && ::Rails.configuration.respond_to?(:middleware)
         ::Rails.configuration.middleware.insert_after 'ActionController::Failsafe',
                                                       Honeybadger::Rack
+        ::Rails.configuration.middleware.insert_after 'Rack::Lock',
+                                                      Honeybadger::UserInformer
       end
 
       Honeybadger.configure(true) do |config|

data/lib/honeybadger/rails3_tasks.rb

@@ -29,7 +29,7 @@ namespace :honeybadger do
     # Detect and disable the better_errors gem
     if defined? BetterErrors::Middleware
       puts 'Better Errors detected: temporarily disabling middleware.'
-      class BetterErrors::Middleware ; def call(env) @app.call(env); end ; end
+      class BetterErrors::Middleware ; def call(env) ; end ; end
     end
 
     begin
@@ -87,7 +87,7 @@ namespace :honeybadger do
     puts 'Processing request.'
 
     ssl = defined?(Rails.configuration.force_ssl) && Rails.configuration.force_ssl
-    env = Rack::MockRequest.env_for("http#{ ssl ? 's' : nil }://www.example.com/verify", 'REMOTE_ADDR' => '127.0.0.1')
+    env = Rack::MockRequest.env_for("http#{ ssl ? 's' : nil }://www.example.com/verify")
 
     Rails.application.call(env)
   end

data/lib/honeybadger/railtie.rb

@@ -10,7 +10,9 @@ module Honeybadger
     end
 
     initializer "honeybadger.use_rack_middleware" do |app|
-      app.config.middleware.insert 0, "Honeybadger::Rack"
+      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

data/lib/honeybadger/sender.rb

@@ -5,6 +5,9 @@ module Honeybadger
                    Errno::EINVAL,
                    Errno::ECONNRESET,
                    EOFError,
+                   Net::HTTPBadResponse,
+                   Net::HTTPHeaderSyntaxError,
+                   Net::ProtocolError,
                    Errno::ECONNREFUSED].freeze
 
     def initialize(options = {})
@@ -27,7 +30,7 @@ module Honeybadger
 
     # Public: Sends the notice data off to Honeybadger for processing.
     #
-    # notice - The notice data to be sent (Hash or JSON string)
+    # notice - The notice to be sent (Notice, Hash or JSON string)
     #
     # Returns error id from successful response
     def send_to_honeybadger(notice)
@@ -36,27 +39,21 @@ module Honeybadger
         return nil
       end
 
-      return nil unless api_key_ok?
+      api_key = api_key_ok?(!notice.is_a?(String) && notice['api_key']) or return nil
 
       data = notice.is_a?(String) ? notice : notice.to_json
 
-      response = begin
-                   client.post do |p|
-                     p.url NOTICES_URI
-                     p.body = data
-                   end
-                 rescue *HTTP_ERRORS => e
-                   log(:error, "Unable to contact the Honeybadger server. HTTP Error=#{e}")
-                   nil
-                 end
-
-      if response.success?
+      response = rescue_http_errors do
+        http_connection.post(url.path, data, http_headers({'X-API-Key' => api_key}))
+      end
+
+      if Net::HTTPSuccess === response
         log(Honeybadger.configuration.debug ? :info : :debug, "Success: #{response.class}", response, data)
         JSON.parse(response.body).fetch('id')
       else
         log(:error, "Failure: #{response.class}", response, data)
+        nil
       end
-
     rescue => e
       log(:error, "[Honeybadger::Sender#send_to_honeybadger] Error: #{e.class} - #{e.message}\nBacktrace:\n#{e.backtrace.join("\n\t")}")
       nil
@@ -65,18 +62,16 @@ module Honeybadger
     def ping(data = {})
       return nil unless api_key_ok?
 
-      response = client.post do |p|
-        p.url "/v1/ping"
-        p.body = data.to_json
+      response = rescue_http_errors do
+        http_connection.post('/v1/ping/', data.to_json, http_headers)
       end
 
-      if response.success?
+      if Net::HTTPSuccess === response
         JSON.parse(response.body)
       else
         log(:error, "Ping Failure", response, data)
         nil
       end
-
     rescue => e
       log(:error, "[Honeybadger::Sender#ping] Error: #{e.class} - #{e.message}\nBacktrace:\n#{e.backtrace.join("\n\t")}")
       nil
@@ -100,44 +95,18 @@ module Honeybadger
 
     private
 
-    def api_key_ok?
-      if api_key.nil? || api_key == ''
-        log(:error, "API key not found.")
-        return nil
-      end
-      true
+    def url
+      URI.parse("#{protocol}://#{host}:#{port}").merge(NOTICES_URI)
     end
 
-    def proxy_options
-      if proxy_host
-        { :uri => "#{protocol}://#{proxy_host}:#{proxy_port || port}", :user => proxy_user, :password => proxy_pass }
+    def api_key_ok?(api_key = nil)
+      api_key ||= self.api_key
+      unless api_key =~ /\S/
+        log(:error, "API key not found.")
+        return nil
       end
-    end
 
-    def request_options
-      { :timeout => http_read_timeout, :open_timeout => http_open_timeout }
-    end
-
-    def client
-      @client ||= Faraday.new(:request => request_options, :proxy => proxy_options).tap do |conn|
-        conn.build do |builder|
-          builder.adapter Faraday.default_adapter
-        end
-
-        conn.url_prefix = "#{protocol}://#{host}:#{port}"
-        conn.headers['User-agent'] = "HB-Ruby #{Honeybadger::VERSION}; #{RUBY_VERSION}; #{RUBY_PLATFORM}"
-        conn.headers['X-API-Key'] = api_key.to_s
-        conn.headers['Content-Type'] = 'application/json'
-        conn.headers['Accept'] = 'text/json, application/json'
-
-        if secure?
-          conn.ssl[:verify_mode] = OpenSSL::SSL::VERIFY_PEER
-          conn.ssl[:ca_file] = Honeybadger.configuration.ca_bundle_path
-        end
-      end
-    rescue => e
-      log(:error, "[Honeybadger::Sender#client] Failure initializing the HTTP connection.\nError: #{e.class} - #{e.message}\nBacktrace:\n#{e.backtrace.join("\n\t")}")
-      raise e
+      api_key
     end
 
     def log(level, message, response = nil, data = nil)
@@ -149,5 +118,46 @@ module Honeybadger
       Honeybadger.report_response_body(response.body) if response && response.body =~ /\S/
       Honeybadger.write_verbose_log("Notice: #{data}", :debug) if data && Honeybadger.configuration.debug
     end
+
+    def rescue_http_errors(&block)
+      yield
+    rescue *HTTP_ERRORS => e
+      log(:error, "Unable to contact the Honeybadger server. HTTP Error=#{e}")
+      nil
+    end
+
+    def http_connection
+      setup_http_connection
+    end
+
+    def http_headers(headers=nil)
+      {}.tap do |hash|
+        hash.merge!(HEADERS)
+        hash.merge!({'X-API-Key' => api_key})
+        hash.merge!(headers) if headers
+      end
+    end
+
+    def setup_http_connection
+      http_class = Net::HTTP::Proxy(proxy_host, proxy_port, proxy_user, proxy_pass)
+      http = http_class.new(url.host, url.port)
+
+      http.read_timeout = http_read_timeout
+      http.open_timeout = http_open_timeout
+
+      if secure?
+        http.use_ssl     = true
+
+        http.ca_file      = Honeybadger.configuration.ca_bundle_path
+        http.verify_mode  = OpenSSL::SSL::VERIFY_PEER
+      else
+        http.use_ssl     = false
+      end
+
+      http
+    rescue => e
+      log(:error, "[Honeybadger::Sender#setup_http_connection] Failure initializing the HTTP connection.\nError: #{e.class} - #{e.message}\nBacktrace:\n#{e.backtrace.join("\n\t")}")
+      raise e
+    end
   end
 end