honeybadger 1.10.3 → 1.11.0.beta1

data/honeybadger.gemspec

@@ -4,8 +4,8 @@ Gem::Specification.new do |s|
   s.rubygems_version = '1.3.5'
 
   s.name              = 'honeybadger'
-  s.version           = '1.10.3'
-  s.date              = '2014-02-05'
+  s.version           = '1.11.0.beta1'
+  s.date              = '2014-01-17'
 
   s.summary     = 'Error reports you can be happy about.'
   s.description = 'Make managing application errors a more pleasant experience.'
@@ -74,6 +74,8 @@ Gem::Specification.new do |s|
     gemfiles/rails3.2.gemfile.lock
     gemfiles/rails4.gemfile
     gemfiles/rails4.gemfile.lock
+    gemfiles/rails4_cap3.gemfile
+    gemfiles/rails4_cap3.gemfile.lock
     gemfiles/rake.gemfile
     gemfiles/rake.gemfile.lock
     gemfiles/sinatra.gemfile
@@ -89,6 +91,8 @@ Gem::Specification.new do |s|
     lib/honeybadger/array.rb
     lib/honeybadger/backtrace.rb
     lib/honeybadger/capistrano.rb
+    lib/honeybadger/capistrano/legacy.rb
+    lib/honeybadger/capistrano/tasks.rake
     lib/honeybadger/configuration.rb
     lib/honeybadger/monitor.rb
     lib/honeybadger/monitor/railtie.rb
@@ -107,7 +111,7 @@ 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/templates/feedback_form.erb
     lib/honeybadger/user_feedback.rb
     lib/honeybadger/user_informer.rb
     lib/honeybadger_tasks.rb
@@ -127,7 +131,6 @@ Gem::Specification.new do |s|
     spec/honeybadger/rails/action_controller_spec.rb
     spec/honeybadger/rails_spec.rb
     spec/honeybadger/sender_spec.rb
-    spec/honeybadger/stats_spec.rb
     spec/honeybadger/user_feedback_spec.rb
     spec/honeybadger/user_informer_spec.rb
     spec/honeybadger_tasks_spec.rb

data/lib/honeybadger.rb

@@ -16,7 +16,7 @@ require 'honeybadger/user_feedback'
 require 'honeybadger/railtie' if defined?(Rails::Railtie)
 
 module Honeybadger
-  VERSION = '1.10.3'
+  VERSION = '1.11.0.beta1'
   LOG_PREFIX = "** [Honeybadger] "
 
   HEADERS = {
@@ -90,6 +90,19 @@ module Honeybadger
       @configuration ||= Configuration.new
     end
 
+    # Internal: Contacts the Honeybadger service and configures features
+    #
+    # configuration - the Configuration object to use
+    #
+    # Returns Hash features on success, NilClass on failure
+    def ping(configuration)
+      if configuration.public?
+        if result = sender.ping({ :version => Honeybadger::VERSION, :framework => configuration.framework, :environment => configuration.environment_name, :hostname => configuration.hostname })
+          configuration.features = result['features'] if result['features']
+        end
+      end
+    end
+
     # Public: Sends an exception manually using this method, even when you are not in a controller.
     #
     # exception - The exception you want to notify Honeybadger about.

data/lib/honeybadger/capistrano.rb

@@ -1,48 +1,7 @@
-# Defines deploy:notify_honeybadger which will send information about the deploy to Honeybadger.
 require 'capistrano'
 
-module Honeybadger
-  module Capistrano
-    def self.load_into(configuration)
-      configuration.load do
-        after "deploy",            "honeybadger:deploy"
-        after "deploy:migrations", "honeybadger:deploy"
-
-        namespace :honeybadger do
-          desc <<-DESC
-            Notify Honeybadger of the deployment by running the notification on the REMOTE machine.
-              - Run remotely so we use remote API keys, environment, etc.
-          DESC
-          task :deploy, :except => { :no_release => true } do
-            rails_env = fetch(:rails_env, "production")
-            honeybadger_env = fetch(:honeybadger_env, fetch(:rails_env, "production"))
-            rake_task = fetch(:honeybadger_deploy_task, 'honeybadger:deploy')
-            local_user = ENV['USER'] || ENV['USERNAME']
-            executable = RUBY_PLATFORM.downcase.include?('mswin') ? fetch(:rake, 'rake.bat') : fetch(:rake, 'rake')
-            async_notify = fetch(:honeybadger_async_notify, false)
-            directory = configuration.current_release
-            notify_command = "cd #{directory};"
-            notify_command << " nohup" if async_notify
-            notify_command << " #{executable} RAILS_ENV=#{rails_env} #{rake_task} TO=#{honeybadger_env} REVISION=#{current_revision} REPO=#{repository} USER=#{local_user}"
-            notify_command << " DRY_RUN=true" if dry_run
-            notify_command << " API_KEY=#{ENV['API_KEY']}" if ENV['API_KEY']
-            notify_command << " >> /dev/null 2>&1 &" if async_notify
-            logger.info "Notifying Honeybadger of Deploy (#{notify_command})"
-            if configuration.dry_run
-              logger.info "DRY RUN: Notification not actually run."
-            else
-              result = ""
-              run(notify_command, :once => true, :pty => false) { |ch, stream, data| result << data }
-              # TODO: Check if SSL is active on account via result content.
-            end
-            logger.info "Honeybadger Notification Complete."
-          end
-        end
-      end
-    end
-  end
-end
-
-if Capistrano::Configuration.instance
-  Honeybadger::Capistrano.load_into(Capistrano::Configuration.instance)
+if defined?(Capistrano::Configuration.instance)
+  require 'honeybadger/capistrano/legacy'
+else
+  load File.expand_path('../capistrano/tasks.rake', __FILE__)
 end

data/lib/honeybadger/capistrano/legacy.rb

@@ -0,0 +1,45 @@
+module Honeybadger
+  module Capistrano
+    def self.load_into(configuration)
+      configuration.load do
+        after "deploy",            "honeybadger:deploy"
+        after "deploy:migrations", "honeybadger:deploy"
+
+        namespace :honeybadger do
+          desc <<-DESC
+            Notify Honeybadger of the deployment by running the notification on the REMOTE machine.
+              - Run remotely so we use remote API keys, environment, etc.
+          DESC
+          task :deploy, :except => { :no_release => true } do
+            rails_env = fetch(:rails_env, "production")
+            honeybadger_env = fetch(:honeybadger_env, fetch(:rails_env, "production"))
+            rake_task = fetch(:honeybadger_deploy_task, 'honeybadger:deploy')
+            local_user = ENV['USER'] || ENV['USERNAME']
+            executable = RUBY_PLATFORM.downcase.include?('mswin') ? fetch(:rake, 'rake.bat') : fetch(:rake, 'rake')
+            async_notify = fetch(:honeybadger_async_notify, false)
+            directory = configuration.current_release
+            notify_options = "cd #{directory};"
+            notify_options << " nohup" if async_notify
+            notify_options << " #{executable} RAILS_ENV=#{rails_env} #{rake_task} TO=#{honeybadger_env} REVISION=#{current_revision} REPO=#{repository} USER=#{local_user}"
+            notify_options << " DRY_RUN=true" if dry_run
+            notify_options << " API_KEY=#{ENV['API_KEY']}" if ENV['API_KEY']
+            notify_options << " >> /dev/null 2>&1 &" if async_notify
+            logger.info "Notifying Honeybadger of Deploy (#{notify_options})"
+            if configuration.dry_run
+              logger.info "DRY RUN: Notification not actually run."
+            else
+              result = ""
+              run(notify_options, :once => true, :pty => false) { |ch, stream, data| result << data }
+              # TODO: Check if SSL is active on account via result content.
+            end
+            logger.info "Honeybadger Notification Complete."
+          end
+        end
+      end
+    end
+  end
+end
+
+if Capistrano::Configuration.instance
+  Honeybadger::Capistrano.load_into(Capistrano::Configuration.instance)
+end

data/lib/honeybadger/capistrano/tasks.rake

@@ -0,0 +1,67 @@
+after 'deploy:finishing', 'honeybadger:deploy'
+
+namespace :honeybadger do
+  def sshkit_outdated?
+    !::SSHKit.config.command_map.respond_to?(:prefix)
+  end
+
+  desc 'Notify Honeybadger of the deployment.'
+  task :deploy => :env do
+    next if sshkit_outdated?
+    if server = fetch(:honeybadger_server)
+      on server do |host|
+        info 'Notifying Honeybadger of deploy.'
+
+        executable = RUBY_PLATFORM.downcase.include?('mswin') ? fetch(:rake, :'rake.bat') : fetch(:rake, :rake)
+        rake_task  = fetch(:honeybadger_deploy_task, 'honeybadger:deploy')
+
+        options = [rake_task]
+
+        if fetch(:honeybadger_async_notify, false)
+          ::SSHKit.config.command_map.prefix[:rake].push(:nohup)
+          options << '>> /dev/null 2>&1 &'
+        end
+
+        within release_path do
+          execute executable, options
+        end
+
+        info 'Honeybadger notification complete.'
+      end
+    end
+  end
+
+  desc 'Setup ENV for Honeybadger deploy rake task.'
+  task :env do
+    if sshkit_outdated?
+      run_locally do
+        warn 'Unable to notify Honeybadger: you are using an outdated version of SSHKIT. Please upgrade to >= 1.2.0.'
+      end
+      next
+    end
+
+    server = fetch(:honeybadger_server) do
+      s = primary(:app)
+      set(:honeybadger_server, s.select?({ :exclude => :no_release }) ? s : nil)
+    end
+
+    if server
+      on server do |host|
+        rails_env       = fetch(:rails_env, "production")
+        honeybadger_env = fetch(:honeybadger_env, rails_env)
+        repository      = fetch(:repo_url)
+        local_user      = fetch(:honeybadger_user, ENV['USER'] || ENV['USERNAME'])
+        api_key         = fetch(:honeybadger_api_key, ENV['HONEYBADGER_API_KEY'] || ENV['API_KEY'])
+        revision        = fetch(:current_revision) do
+          within(repo_path) do
+            capture("cd #{repo_path} && git rev-parse --short HEAD")
+          end
+        end
+
+        env = ["RAILS_ENV=#{rails_env}", "TO=#{honeybadger_env}", "REVISION=#{revision}", "REPO=#{repository}", "USER=#{local_user}"]
+        env << "API_KEY=#{api_key}" if api_key
+        ::SSHKit.config.command_map.prefix[:rake].unshift(*env)
+      end
+    end
+  end
+end

data/lib/honeybadger/configuration.rb

@@ -261,9 +261,9 @@ module Honeybadger
 
     # Public: Determines if the notifier will send notices.
     #
-    # Returns false if in a development environment, true otherwise.
+    # Returns true if allowed to talk to API, false otherwise.
     def public?
-      !development_environments.include?(environment_name) && features['notices']
+      !development_environments.include?(environment_name)
     end
 
     # Public: Determines whether to send metrics

data/lib/honeybadger/monitor/worker.rb

@@ -72,7 +72,7 @@ module Honeybadger
             end
           end.each_slice(@per_request) do |mm|
             begin
-              @sender.send_metrics({ :metrics => mm.compact, :environment => Honeybadger.configuration.environment_name, :hostname => Honeybadger.configuration.hostname })
+              @sender.send_metrics({ :metrics => mm, :environment => Honeybadger.configuration.environment_name, :hostname => Honeybadger.configuration.hostname })
             rescue Exception => e
               log(:error, "[Honeybadger::Monitor::Worker#send_metrics] Failed to send #{mm.count} metrics: #{e.class} - #{e.message}\nBacktrace:\n#{e.backtrace.join("\n\t")}")
             end

data/lib/honeybadger/notice.rb

@@ -305,7 +305,7 @@ module Honeybadger
       return nil unless url =~ /\S/
 
       url = url.dup
-      url.scan(/&([^=]+)=([^&]+)/).each do |m|
+      url.scan(/(?:^|&|\?)([^=?&]+)=([^&]+)/).each do |m|
         next unless filter_key?(m[0])
         url.gsub!(/#{m[1]}/, '[FILTERED]')
       end
@@ -321,6 +321,7 @@ module Honeybadger
       if cgi_data
         clean_unserializable_data_from(:cgi_data)
         filter(cgi_data)
+        filter_cgi_data_params(cgi_data)
       end
       if session_data
         clean_unserializable_data_from(:session_data)
@@ -328,9 +329,17 @@ module Honeybadger
       end
     end
 
+    def filter_cgi_data_params(cgi_data)
+      cgi_data.each_pair do |key, value|
+        next unless value.kind_of?(String) && key =~ /\A[A-Z_]+\Z/
+        cgi_data[key] = filter_url(value)
+      end
+    end
+
     def clean_rack_request_data
       if cgi_data
         cgi_data.delete("rack.request.form_vars")
+        cgi_data.delete("rack.request.query_string")
       end
     end
 

data/lib/honeybadger/rack.rb

@@ -22,6 +22,7 @@ module Honeybadger
   class Rack
     def initialize(app)
       @app = app
+      Honeybadger.configuration.framework = "Rack: #{::Rack.release}"
     end
 
     def ignored_user_agent?(env)

data/lib/honeybadger/rails.rb

@@ -21,6 +21,8 @@ module Honeybadger
                                                       Honeybadger::Rack
         ::Rails.configuration.middleware.insert_after 'Rack::Lock',
                                                       Honeybadger::UserInformer
+        ::Rails.configuration.middleware.insert_after Honeybadger::UserInformer,
+                                                      Honeybadger::UserFeedback
       end
 
       Honeybadger.configure(true) do |config|
@@ -29,6 +31,12 @@ module Honeybadger
         config.project_root     = defined?(::Rails.root) && ::Rails.root || defined?(RAILS_ROOT) && RAILS_ROOT
         config.framework        = defined?(::Rails.version) && "Rails: #{::Rails.version}" || defined?(::Rails::VERSION::STRING) && "Rails: #{::Rails::VERSION::STRING}"
       end
+
+      if defined?(::Rails.configuration) && ::Rails.configuration.respond_to?(:after_initialize)
+        ::Rails.configuration.after_initialize do
+          Honeybadger.ping(Honeybadger.configuration)
+        end
+      end
     end
   end
 end

data/lib/honeybadger/railtie.rb

@@ -44,13 +44,7 @@ module Honeybadger
         ::ActionDispatch::ShowExceptions.send(:include,Honeybadger::Rails::Middleware::ExceptionsCatcher)
       end
 
-      if Honeybadger.configuration.public?
-        if result = Honeybadger.sender.ping({ :version => Honeybadger::VERSION, :framework => Honeybadger.configuration.framework, :environment => Honeybadger.configuration.environment_name, :hostname => Honeybadger.configuration.hostname })
-          Honeybadger.configure(true) do |config|
-            config.features = result['features'] if result['features']
-          end
-        end
-      end
+      Honeybadger.ping(Honeybadger.configuration)
     end
   end
 end

data/lib/honeybadger/stats.rb

@@ -12,7 +12,7 @@ module Honeybadger
       def memory
         out = {}
         if HAS_MEM
-          out[:total], out[:free], out[:buffers], out[:cached] = IO.readlines("/proc/meminfo")[0..4].map { |l| l =~ /^.*?\: +(.*?) kB$/; ($1.to_i / 1024.0).to_f }
+          out[:total], out[:free], out[:buffers], out[:cached] = IO.readlines("/proc/meminfo")[0..4].map { |l| l =~ /^.*?\: +(.*?) kB$/; $1.to_i / 1024.0 }
           out[:free_total] = out[:free] + out[:buffers] + out[:cached]
         end
         out

data/lib/honeybadger/templates/{feedback_form.html.erb → feedback_form.erb}

@@ -6,6 +6,7 @@
 #honeybadger_feedback_comment { height: 10em; }
 #honeybadger_feedback_submit { height: 1em; }
 #honeybadger_feedback_form .honeybadger-feedback-phone { display: none; }
+#honeybadger_feedback_link { font-size: 90%; }
 </style>
 
 <script>
@@ -22,7 +23,7 @@ function honeybadgerFeedbackResponse(data) {
     if (data['error']) {
       message = data['error'];
     } else {
-      message = "An unknown error occurred. Please try again.";
+      message = 'An unknown error occurred. Please try again.';
     }
 
     alert(message);
@@ -47,36 +48,38 @@ function sendHoneybadgerFeedback() {
 </script>
 
 <div id="honeybadger_feedback_success" style="display:none;">
-  <p><strong>Thanks for the feedback!</strong></p>
+  <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>Care to help us fix this?</h2>
-  <p>Any information you can provide will help our technical team get to the bottom of this issue.</p>
+  <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">Your name</label><br>
+    <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">Your phone number</label><br>
+    <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">Your email address</label><br>
+    <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">Comment (required)</label><br>
+    <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="Send">
+    <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/user_feedback.rb

@@ -1,16 +1,47 @@
 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
-    TEMPLATE = File.read(File.expand_path('../templates/feedback_form.html.erb', __FILE__)).freeze
-
     def initialize(app)
       @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
-      config = Honeybadger.configuration
       URI.parse("#{config.protocol}://#{config.host}:#{config.port}/v1/feedback/").to_s
     rescue URI::InvalidURIError
       nil
@@ -18,25 +49,24 @@ module Honeybadger
 
     def render_form(error_id, action = action)
       return unless action
-      ERB.new(TEMPLATE).result(binding)
+      ERB.new(@template ||= File.read(template_file)).result(binding)
     end
 
-    def enabled?
-      Honeybadger.configuration.feedback && Honeybadger.configuration.features['feedback']
+    def custom_template_file
+      @custom_template_file ||= config.project_root &&
+        File.join(config.project_root, 'lib', 'honeybadger', 'templates', 'feedback_form.erb')
     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
+    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
-      [status, headers, body]
     end
   end
 end