honeybadger 5.1.0 → 5.2.1

data/lib/honeybadger/singleton.rb

@@ -1,103 +1,103 @@
-require 'forwardable'
-require 'honeybadger/agent'
-
-# Honeybadger's public API is made up of two parts: the {Honeybadger} singleton
-# module, and the {Agent} class. The singleton module delegates its methods to
-# a global agent instance, {Agent#instance}; this allows methods to be accessed
-# directly, for example when calling +Honeybadger.notify+:
-#
-#   begin
-#     raise 'testing an error report'
-#   rescue => err
-#     Honeybadger.notify(err)
-#   end
-#
-# Custom agents may also be created by users who want to report to multiple
-# Honeybadger projects in the same app (or have fine-grained control over
-# configuration), however most users will use the global agent.
-#
-# @see Honeybadger::Agent
-module Honeybadger
-  extend Forwardable
-  extend self
-
-  # @!macro [attach] def_delegator
-  #   @!method $2(...)
-  #     Forwards to {$1}.
-  #     @see Agent#$2
-  def_delegator :'Honeybadger::Agent.instance', :check_in
-  def_delegator :'Honeybadger::Agent.instance', :context
-  def_delegator :'Honeybadger::Agent.instance', :configure
-  def_delegator :'Honeybadger::Agent.instance', :get_context
-  def_delegator :'Honeybadger::Agent.instance', :flush
-  def_delegator :'Honeybadger::Agent.instance', :stop
-  def_delegator :'Honeybadger::Agent.instance', :exception_filter
-  def_delegator :'Honeybadger::Agent.instance', :exception_fingerprint
-  def_delegator :'Honeybadger::Agent.instance', :backtrace_filter
-  def_delegator :'Honeybadger::Agent.instance', :add_breadcrumb
-  def_delegator :'Honeybadger::Agent.instance', :breadcrumbs
-  def_delegator :'Honeybadger::Agent.instance', :clear!
-  def_delegator :'Honeybadger::Agent.instance', :track_deployment
-
-  # @!macro [attach] def_delegator
-  #   @!method $2(...)
-  #     @api private
-  #     Forwards to {$1}.
-  #     @see Agent#$2
-  def_delegator :'Honeybadger::Agent.instance', :config
-  def_delegator :'Honeybadger::Agent.instance', :init!
-  def_delegator :'Honeybadger::Agent.instance', :with_rack_env
-
-  # @!method notify(...)
-  # Forwards to {Agent.instance}.
-  # @see Agent#notify
-  def notify(exception_or_opts, opts = {})
-    # Note this is defined directly (instead of via forwardable) so that
-    # generated stack traces work as expected.
-    Agent.instance.notify(exception_or_opts, opts)
-  end
-
-  # @api private
-  def load_plugins!
-    Dir[File.expand_path('../plugins/*.rb', __FILE__)].each do |plugin|
-      require plugin
-    end
-    Plugin.load!(self.config)
-  end
-
-  # @api private
-  def install_at_exit_callback
-    at_exit do
-      if $! && !ignored_exception?($!) && Honeybadger.config[:'exceptions.notify_at_exit']
-        Honeybadger.notify($!, component: 'at_exit', sync: true)
-      end
-
-      Honeybadger.stop if Honeybadger.config[:'send_data_at_exit']
-    end
-  end
-
-  # @deprecated
-  def start(config = {})
-    raise NoMethodError, <<-WARNING
-`Honeybadger.start` is no longer necessary and has been removed.
-
-  Use `Honeybadger.configure` to explicitly configure the agent from Ruby moving forward:
-
-  Honeybadger.configure do |config|
-    config.api_key = 'project api key'
-    config.exceptions.ignore += [CustomError]
-  end
-WARNING
-  end
-
-  private
-  # @api private
-  def ignored_exception?(exception)
-    exception.is_a?(SystemExit) ||
-      ( exception.is_a?(SignalException) &&
-         ( (exception.respond_to?(:signm) && exception.signm == "SIGTERM") ||
-          # jruby has a missing #signm implementation
-          ["TERM", "SIGTERM"].include?(exception.to_s) )
-    )
-  end
-end
+require 'forwardable'
+require 'honeybadger/agent'
+
+# Honeybadger's public API is made up of two parts: the {Honeybadger} singleton
+# module, and the {Agent} class. The singleton module delegates its methods to
+# a global agent instance, {Agent#instance}; this allows methods to be accessed
+# directly, for example when calling +Honeybadger.notify+:
+#
+#   begin
+#     raise 'testing an error report'
+#   rescue => err
+#     Honeybadger.notify(err)
+#   end
+#
+# Custom agents may also be created by users who want to report to multiple
+# Honeybadger projects in the same app (or have fine-grained control over
+# configuration), however most users will use the global agent.
+#
+# @see Honeybadger::Agent
+module Honeybadger
+  extend Forwardable
+  extend self
+
+  # @!macro [attach] def_delegator
+  #   @!method $2(...)
+  #     Forwards to {$1}.
+  #     @see Agent#$2
+  def_delegator :'Honeybadger::Agent.instance', :check_in
+  def_delegator :'Honeybadger::Agent.instance', :context
+  def_delegator :'Honeybadger::Agent.instance', :configure
+  def_delegator :'Honeybadger::Agent.instance', :get_context
+  def_delegator :'Honeybadger::Agent.instance', :flush
+  def_delegator :'Honeybadger::Agent.instance', :stop
+  def_delegator :'Honeybadger::Agent.instance', :exception_filter
+  def_delegator :'Honeybadger::Agent.instance', :exception_fingerprint
+  def_delegator :'Honeybadger::Agent.instance', :backtrace_filter
+  def_delegator :'Honeybadger::Agent.instance', :add_breadcrumb
+  def_delegator :'Honeybadger::Agent.instance', :breadcrumbs
+  def_delegator :'Honeybadger::Agent.instance', :clear!
+  def_delegator :'Honeybadger::Agent.instance', :track_deployment
+
+  # @!macro [attach] def_delegator
+  #   @!method $2(...)
+  #     @api private
+  #     Forwards to {$1}.
+  #     @see Agent#$2
+  def_delegator :'Honeybadger::Agent.instance', :config
+  def_delegator :'Honeybadger::Agent.instance', :init!
+  def_delegator :'Honeybadger::Agent.instance', :with_rack_env
+
+  # @!method notify(...)
+  # Forwards to {Agent.instance}.
+  # @see Agent#notify
+  def notify(exception_or_opts, opts = {})
+    # Note this is defined directly (instead of via forwardable) so that
+    # generated stack traces work as expected.
+    Agent.instance.notify(exception_or_opts, opts)
+  end
+
+  # @api private
+  def load_plugins!
+    Dir[File.expand_path('../plugins/*.rb', __FILE__)].each do |plugin|
+      require plugin
+    end
+    Plugin.load!(self.config)
+  end
+
+  # @api private
+  def install_at_exit_callback
+    at_exit do
+      if $! && !ignored_exception?($!) && Honeybadger.config[:'exceptions.notify_at_exit']
+        Honeybadger.notify($!, component: 'at_exit', sync: true)
+      end
+
+      Honeybadger.stop if Honeybadger.config[:'send_data_at_exit']
+    end
+  end
+
+  # @deprecated
+  def start(config = {})
+    raise NoMethodError, <<-WARNING
+`Honeybadger.start` is no longer necessary and has been removed.
+
+  Use `Honeybadger.configure` to explicitly configure the agent from Ruby moving forward:
+
+  Honeybadger.configure do |config|
+    config.api_key = 'project api key'
+    config.exceptions.ignore += [CustomError]
+  end
+WARNING
+  end
+
+  private
+  # @api private
+  def ignored_exception?(exception)
+    exception.is_a?(SystemExit) ||
+      ( exception.is_a?(SignalException) &&
+         ( (exception.respond_to?(:signm) && exception.signm == "SIGTERM") ||
+          # jruby has a missing #signm implementation
+          ["TERM", "SIGTERM"].include?(exception.to_s) )
+    )
+  end
+end

data/lib/honeybadger/tasks.rb

@@ -1,22 +1,22 @@
-namespace :honeybadger do
-  def warn_task_moved(old_name, new_cmd = "honeybadger help #{old_name}")
-    puts "This task was moved to the CLI in honeybadger 2.0. To learn more, run `#{new_cmd}`."
-  end
-
-  desc "Verify your gem installation by sending a test exception to the honeybadger service"
-  task :test do
-    warn_task_moved('test')
-  end
-
-  desc "Notify Honeybadger of a new deploy."
-  task :deploy do
-    warn_task_moved('deploy')
-  end
-
-  namespace :heroku do
-    desc "Install Heroku deploy notifications addon"
-    task :add_deploy_notification do
-      warn_task_moved('heroku:add_deploy_notification', 'honeybadger heroku help install_deploy_notification')
-    end
-  end
-end
+namespace :honeybadger do
+  def warn_task_moved(old_name, new_cmd = "honeybadger help #{old_name}")
+    puts "This task was moved to the CLI in honeybadger 2.0. To learn more, run `#{new_cmd}`."
+  end
+
+  desc "Verify your gem installation by sending a test exception to the honeybadger service"
+  task :test do
+    warn_task_moved('test')
+  end
+
+  desc "Notify Honeybadger of a new deploy."
+  task :deploy do
+    warn_task_moved('deploy')
+  end
+
+  namespace :heroku do
+    desc "Install Heroku deploy notifications addon"
+    task :add_deploy_notification do
+      warn_task_moved('heroku:add_deploy_notification', 'honeybadger heroku help install_deploy_notification')
+    end
+  end
+end

data/lib/honeybadger/templates/feedback_form.erb

@@ -1,84 +1,84 @@
-<style>
-#honeybadger_feedback_form *, #honeybadger_feedback_form *:before, #honeybadger_feedback_form *:after { -moz-box-sizing: border-box; -webkit-box-sizing: border-box; box-sizing: border-box; }
-#honeybadger_feedback_form h2 { font-size: 110%; line-height: 1.5em; }
-#honeybadger_feedback_form label { font-weight: bold; }
-#honeybadger_feedback_name, #honeybadger_feedback_email, #honeybadger_feedback_comment { width: 100%; padding: 0.5em; }
-#honeybadger_feedback_comment { height: 10em; }
-#honeybadger_feedback_form .honeybadger-feedback-phone { display: none; }
-#honeybadger_feedback_link { font-size: 90%; }
-</style>
-
-<script>
-function honeybadgerFeedbackResponse(data) {
-  if (data['result'] == 'OK') {
-    var form = document.getElementById('honeybadger_feedback_form');
-    var success = document.getElementById('honeybadger_feedback_success');
-
-    form.style.display = 'none';
-    success.style.display = 'block';
-  } else {
-    var message;
-
-    if (data['error']) {
-      message = data['error'];
-    } else {
-      message = 'An unknown error occurred. Please try again.';
-    }
-
-    alert(message);
-  }
-}
-
-function sendHoneybadgerFeedback() {
-  try {
-    var script = document.createElement('script');
-    var form = document.getElementById('honeybadger_feedback_form');
-    script.src = '<%= action %>?format=js&token=<%= error_id %>&name=' + encodeURIComponent(form.name.value) + '&email=' + encodeURIComponent(form.email.value) + '&comment=' + encodeURIComponent(form.comment.value);
-    form.appendChild(script);
-    return false;
-  } catch(e) {
-    if (window.console) {
-      console.log('Error caught while processing Honeybadger feedback form: ' + e);
-      console.log('Submitting form normally...');
-    }
-    return true;
-  }
-}
-</script>
-
-<div id="honeybadger_feedback_success" style="display:none;">
-  <p><strong><%= I18n.t('honeybadger.feedback.thanks', :default => 'Thanks for the feedback!') %></strong></p>
-</div>
-
-<form action="<%= action %>" method="POST" id="honeybadger_feedback_form" onsubmit="return sendHoneybadgerFeedback();">
-  <input type="hidden" name="token" id="honeybadger_feedback_token" value="<%= error_id %>">
-
-  <h2><%= I18n.t('honeybadger.feedback.heading', :default => 'Care to help us fix this?') %></h2>
-  <p><%= I18n.t('honeybadger.feedback.explanation', :default => 'Any information you can provide will help our technical team get to the bottom of this issue.') %></p>
-
-  <p class="honeybadger-feedback-name">
-    <label for="honeybadger_feedback_name"><%= I18n.t('honeybadger.feedback.labels.name', :default => 'Your name') %></label><br>
-    <input type="text" name="name" id="honeybadger_feedback_name" size="60">
-  </p>
-
-  <p class="honeybadger-feedback-phone">
-    <label for="honeybadger_feedback_phone"><%= I18n.t('honeybadger.feedback.labels.phone', :default => 'Your phone number') %></label><br>
-    <input type="text" name="phone" id="honeybadger_feedback_phone" size="60">
-  </p>
-
-  <p class="honeybadger-feedback-email">
-    <label for="honeybadger_feedback_email"><%= I18n.t('honeybadger.feedback.labels.email', :default => 'Your email address') %></label><br>
-    <input type="email" name="email" id="honeybadger_feedback_email" size="60">
-  </p>
-
-  <p class="honeybadger-feedback-comment">
-    <label for="honeybadger_feedback_comment"><%= I18n.t('honeybadger.feedback.labels.comment', :default => 'Comment (required)') %></label><br>
-    <textarea name="comment" id="honeybadger_feedback_comment" cols="50" rows="6" required></textarea>
-  </p>
-
-  <p class="honeybadger-feedback-submit">
-    <input type="submit" id="honeybadger_feedback_submit" value="<%= I18n.t('honeybadger.feedback.submit', :default => 'Send') %>">
-  </p>
-</form>
-
-<p><a id="honeybadger_feedback_link" href="https://www.honeybadger.io/" target="_blank" title="Exception, uptime, and performance monitoring for Ruby.">Powered by Honeybadger</a></p>
+<style>
+#honeybadger_feedback_form *, #honeybadger_feedback_form *:before, #honeybadger_feedback_form *:after { -moz-box-sizing: border-box; -webkit-box-sizing: border-box; box-sizing: border-box; }
+#honeybadger_feedback_form h2 { font-size: 110%; line-height: 1.5em; }
+#honeybadger_feedback_form label { font-weight: bold; }
+#honeybadger_feedback_name, #honeybadger_feedback_email, #honeybadger_feedback_comment { width: 100%; padding: 0.5em; }
+#honeybadger_feedback_comment { height: 10em; }
+#honeybadger_feedback_form .honeybadger-feedback-phone { display: none; }
+#honeybadger_feedback_link { font-size: 90%; }
+</style>
+
+<script>
+function honeybadgerFeedbackResponse(data) {
+  if (data['result'] == 'OK') {
+    var form = document.getElementById('honeybadger_feedback_form');
+    var success = document.getElementById('honeybadger_feedback_success');
+
+    form.style.display = 'none';
+    success.style.display = 'block';
+  } else {
+    var message;
+
+    if (data['error']) {
+      message = data['error'];
+    } else {
+      message = 'An unknown error occurred. Please try again.';
+    }
+
+    alert(message);
+  }
+}
+
+function sendHoneybadgerFeedback() {
+  try {
+    var script = document.createElement('script');
+    var form = document.getElementById('honeybadger_feedback_form');
+    script.src = '<%= action %>?format=js&token=<%= error_id %>&name=' + encodeURIComponent(form.name.value) + '&email=' + encodeURIComponent(form.email.value) + '&comment=' + encodeURIComponent(form.comment.value);
+    form.appendChild(script);
+    return false;
+  } catch(e) {
+    if (window.console) {
+      console.log('Error caught while processing Honeybadger feedback form: ' + e);
+      console.log('Submitting form normally...');
+    }
+    return true;
+  }
+}
+</script>
+
+<div id="honeybadger_feedback_success" style="display:none;">
+  <p><strong><%= I18n.t('honeybadger.feedback.thanks', :default => 'Thanks for the feedback!') %></strong></p>
+</div>
+
+<form action="<%= action %>" method="POST" id="honeybadger_feedback_form" onsubmit="return sendHoneybadgerFeedback();">
+  <input type="hidden" name="token" id="honeybadger_feedback_token" value="<%= error_id %>">
+
+  <h2><%= I18n.t('honeybadger.feedback.heading', :default => 'Care to help us fix this?') %></h2>
+  <p><%= I18n.t('honeybadger.feedback.explanation', :default => 'Any information you can provide will help our technical team get to the bottom of this issue.') %></p>
+
+  <p class="honeybadger-feedback-name">
+    <label for="honeybadger_feedback_name"><%= I18n.t('honeybadger.feedback.labels.name', :default => 'Your name') %></label><br>
+    <input type="text" name="name" id="honeybadger_feedback_name" size="60">
+  </p>
+
+  <p class="honeybadger-feedback-phone">
+    <label for="honeybadger_feedback_phone"><%= I18n.t('honeybadger.feedback.labels.phone', :default => 'Your phone number') %></label><br>
+    <input type="text" name="phone" id="honeybadger_feedback_phone" size="60">
+  </p>
+
+  <p class="honeybadger-feedback-email">
+    <label for="honeybadger_feedback_email"><%= I18n.t('honeybadger.feedback.labels.email', :default => 'Your email address') %></label><br>
+    <input type="email" name="email" id="honeybadger_feedback_email" size="60">
+  </p>
+
+  <p class="honeybadger-feedback-comment">
+    <label for="honeybadger_feedback_comment"><%= I18n.t('honeybadger.feedback.labels.comment', :default => 'Comment (required)') %></label><br>
+    <textarea name="comment" id="honeybadger_feedback_comment" cols="50" rows="6" required></textarea>
+  </p>
+
+  <p class="honeybadger-feedback-submit">
+    <input type="submit" id="honeybadger_feedback_submit" value="<%= I18n.t('honeybadger.feedback.submit', :default => 'Send') %>">
+  </p>
+</form>
+
+<p><a id="honeybadger_feedback_link" href="https://www.honeybadger.io/" target="_blank" title="Exception, uptime, and performance monitoring for Ruby.">Powered by Honeybadger</a></p>

data/lib/honeybadger/util/http.rb

@@ -1,92 +1,92 @@
-require 'forwardable'
-require 'net/http'
-require 'json'
-require 'zlib'
-require 'openssl'
-
-require 'honeybadger/version'
-require 'honeybadger/logging'
-
-module Honeybadger
-  module Util
-    class HTTP
-      extend Forwardable
-
-      include Honeybadger::Logging::Helper
-
-      HEADERS = {
-        'Content-type'.freeze => 'application/json'.freeze,
-        'Content-Encoding'.freeze => 'deflate'.freeze,
-        'Accept'.freeze => 'text/json, application/json'.freeze,
-        'User-Agent'.freeze => "HB-Ruby #{VERSION}; #{RUBY_VERSION}; #{RUBY_PLATFORM}".freeze
-      }.freeze
-
-      ERRORS = [Timeout::Error,
-                Errno::EINVAL,
-                Errno::ECONNRESET,
-                Errno::ECONNREFUSED,
-                Errno::ENETUNREACH,
-                EOFError,
-                Net::HTTPBadResponse,
-                Net::HTTPHeaderSyntaxError,
-                Net::ProtocolError,
-                OpenSSL::SSL::SSLError,
-                SocketError].freeze
-
-      def initialize(config)
-        @config = config
-      end
-
-      def get(endpoint)
-        response = http_connection.get(endpoint)
-        debug { sprintf("http method=GET path=%s code=%d", endpoint.dump, response.code) }
-        response
-      end
-
-      def post(endpoint, payload, headers = nil)
-        response = http_connection.post(endpoint, compress(payload.to_json), http_headers(headers))
-        debug { sprintf("http method=POST path=%s code=%d", endpoint.dump, response.code) }
-        response
-      end
-
-      private
-
-      attr_reader :config
-
-      def http_connection
-        setup_http_connection
-      end
-
-      def http_headers(headers = nil)
-        {}.tap do |hash|
-          hash.merge!(HEADERS)
-          hash.merge!({'X-API-Key' => config[:api_key].to_s})
-          hash.merge!(headers) if headers
-        end
-      end
-
-      def setup_http_connection
-        http_class = Net::HTTP::Proxy(config[:'connection.proxy_host'], config[:'connection.proxy_port'], config[:'connection.proxy_user'], config[:'connection.proxy_pass'])
-        http = http_class.new(config[:'connection.host'], config.connection_port)
-
-        http.read_timeout = config[:'connection.http_read_timeout']
-        http.open_timeout = config[:'connection.http_open_timeout']
-
-        if config[:'connection.secure']
-          http.use_ssl = true
-
-          http.ca_file = config.ca_bundle_path
-          http.verify_mode = OpenSSL::SSL::VERIFY_PEER
-        else
-          http.use_ssl = false
-        end
-
-        http
-      end
-
-      def compress(string, level = Zlib::DEFAULT_COMPRESSION)
-        Zlib::Deflate.deflate(string, level)
-      end
-    end
-  end
-end
+require 'forwardable'
+require 'net/http'
+require 'json'
+require 'zlib'
+require 'openssl'
+
+require 'honeybadger/version'
+require 'honeybadger/logging'
+
+module Honeybadger
+  module Util
+    class HTTP
+      extend Forwardable
+
+      include Honeybadger::Logging::Helper
+
+      HEADERS = {
+        'Content-type'.freeze => 'application/json'.freeze,
+        'Content-Encoding'.freeze => 'deflate'.freeze,
+        'Accept'.freeze => 'text/json, application/json'.freeze,
+        'User-Agent'.freeze => "HB-Ruby #{VERSION}; #{RUBY_VERSION}; #{RUBY_PLATFORM}".freeze
+      }.freeze
+
+      ERRORS = [Timeout::Error,
+                Errno::EINVAL,
+                Errno::ECONNRESET,
+                Errno::ECONNREFUSED,
+                Errno::ENETUNREACH,
+                EOFError,
+                Net::HTTPBadResponse,
+                Net::HTTPHeaderSyntaxError,
+                Net::ProtocolError,
+                OpenSSL::SSL::SSLError,
+                SocketError].freeze
+
+      def initialize(config)
+        @config = config
+      end
+
+      def get(endpoint)
+        response = http_connection.get(endpoint)
+        debug { sprintf("http method=GET path=%s code=%d", endpoint.dump, response.code) }
+        response
+      end
+
+      def post(endpoint, payload, headers = nil)
+        response = http_connection.post(endpoint, compress(payload.to_json), http_headers(headers))
+        debug { sprintf("http method=POST path=%s code=%d", endpoint.dump, response.code) }
+        response
+      end
+
+      private
+
+      attr_reader :config
+
+      def http_connection
+        setup_http_connection
+      end
+
+      def http_headers(headers = nil)
+        {}.tap do |hash|
+          hash.merge!(HEADERS)
+          hash.merge!({'X-API-Key' => config[:api_key].to_s})
+          hash.merge!(headers) if headers
+        end
+      end
+
+      def setup_http_connection
+        http_class = Net::HTTP::Proxy(config[:'connection.proxy_host'], config[:'connection.proxy_port'], config[:'connection.proxy_user'], config[:'connection.proxy_pass'])
+        http = http_class.new(config[:'connection.host'], config.connection_port)
+
+        http.read_timeout = config[:'connection.http_read_timeout']
+        http.open_timeout = config[:'connection.http_open_timeout']
+
+        if config[:'connection.secure']
+          http.use_ssl = true
+
+          http.ca_file = config.ca_bundle_path
+          http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+        else
+          http.use_ssl = false
+        end
+
+        http
+      end
+
+      def compress(string, level = Zlib::DEFAULT_COMPRESSION)
+        Zlib::Deflate.deflate(string, level)
+      end
+    end
+  end
+end