honeybadger 5.29.1 → 6.0.0

data/lib/honeybadger/cli/deploy.rb

@@ -1,7 +1,7 @@
-require 'forwardable'
-require 'honeybadger/cli/main'
-require 'honeybadger/cli/helpers'
-require 'honeybadger/util/http'
+require "forwardable"
+require "honeybadger/cli/main"
+require "honeybadger/cli/helpers"
+require "honeybadger/util/http"
 
 module Honeybadger
   module CLI
@@ -19,9 +19,9 @@ module Honeybadger
       def run
         payload = {
           environment: config.get(:env),
-          revision: options['revision'],
-          repository: options['repository'],
-          local_username: options['user']
+          revision: options["revision"],
+          repository: options["repository"],
+          local_username: options["user"]
         }
 
         response = config.backend.notify(:deploys, payload)

data/lib/honeybadger/cli/exec.rb

@@ -1,12 +1,12 @@
-require 'erb'
-require 'forwardable'
-require 'honeybadger/cli/main'
-require 'honeybadger/cli/helpers'
-require 'honeybadger/util/http'
-require 'honeybadger/util/stats'
-require 'open3'
-require 'ostruct'
-require 'thor/shell'
+require "erb"
+require "forwardable"
+require "honeybadger/cli/main"
+require "honeybadger/cli/helpers"
+require "honeybadger/util/http"
+require "honeybadger/util/stats"
+require "open3"
+require "ostruct"
+require "thor/shell"
 
 module Honeybadger
   module CLI
@@ -14,34 +14,34 @@ module Honeybadger
       extend Forwardable
       include Helpers::BackendCmd
 
-      FAILED_TEMPLATE = <<-MSG
-Honeybadger detected failure or error output for the command:
-`<%= args.join(' ') %>`
-
-PROCESS ID: <%= pid %>
-
-RESULT CODE: <%= code %>
-
-ERROR OUTPUT:
-<%= stderr %>
-
-STANDARD OUTPUT:
-<%= stdout %>
-MSG
-
-      NO_EXEC_TEMPLATE = <<-MSG
-Honeybadger failed to execute the following command:
-`<%= args.join(' ') %>`
-
-The command was not executable. Try adjusting permissions on the file.
-MSG
-
-      NOT_FOUND_TEMPLATE = <<-MSG
-Honeybadger failed to execute the following command:
-`<%= args.join(' ') %>`
-
-The command was not found. Make sure it exists in your PATH.
-MSG
+      FAILED_TEMPLATE = <<~MSG
+        Honeybadger detected failure or error output for the command:
+        `<%= args.join(' ') %>`
+        
+        PROCESS ID: <%= pid %>
+        
+        RESULT CODE: <%= code %>
+        
+        ERROR OUTPUT:
+        <%= stderr %>
+        
+        STANDARD OUTPUT:
+        <%= stdout %>
+      MSG
+
+      NO_EXEC_TEMPLATE = <<~MSG
+        Honeybadger failed to execute the following command:
+        `<%= args.join(' ') %>`
+        
+        The command was not executable. Try adjusting permissions on the file.
+      MSG
+
+      NOT_FOUND_TEMPLATE = <<~MSG
+        Honeybadger failed to execute the following command:
+        `<%= args.join(' ') %>`
+        
+        The command was not found. Make sure it exists in your PATH.
+      MSG
 
       def initialize(options, args, config)
         @options = options
@@ -59,17 +59,17 @@ MSG
           api_key: config.get(:api_key),
           notifier: NOTIFIER,
           error: {
-            class: 'honeybadger exec error',
+            class: "honeybadger exec error",
             message: result.msg
           },
           request: {
             component: executable,
             context: {
-              command: args.join(' '),
+              command: args.join(" "),
               code: result.code,
               pid: result.pid,
               pwd: Dir.pwd,
-              path: ENV['PATH']
+              path: ENV["PATH"]
             }
           },
           server: {
@@ -112,7 +112,7 @@ MSG
       end
 
       def exec_cmd
-        stdout, stderr, status = Open3.capture3(args.join(' '))
+        stdout, stderr, status = Open3.capture3(args.join(" "))
 
         success = status.success? && stderr =~ BLANK
         pid = status.pid

data/lib/honeybadger/cli/helpers.rb

@@ -3,24 +3,24 @@ module Honeybadger
     module Helpers
       module BackendCmd
         def error_message(response)
-          host = config.get(:'connection.host')
-          <<-MSG
-!! --- Honeybadger request failed --------------------------------------------- !!
-
-We encountered an error when contacting the server:
-
-  #{response.error_message}
-
-To fix this issue, please try the following:
-
-  - Make sure the gem is configured properly.
-  - Retry executing this command a few times.
-  - Make sure you can connect to #{host} (`curl https://#{host}/v1/notices`).
-  - Email support@honeybadger.io for help. Include as much debug info as you
-    can for a faster resolution!
-
-!! --- End -------------------------------------------------------------------- !!
-MSG
+          host = config.get(:"connection.host")
+          <<~MSG
+            !! --- Honeybadger request failed --------------------------------------------- !!
+            
+            We encountered an error when contacting the server:
+            
+              #{response.error_message}
+            
+            To fix this issue, please try the following:
+            
+              - Make sure the gem is configured properly.
+              - Retry executing this command a few times.
+              - Make sure you can connect to #{host} (`curl https://#{host}/v1/notices`).
+              - Email support@honeybadger.io for help. Include as much debug info as you
+                can for a faster resolution!
+            
+            !! --- End -------------------------------------------------------------------- !!
+          MSG
         end
       end
     end

data/lib/honeybadger/cli/heroku.rb

@@ -1,50 +1,50 @@
 module Honeybadger
   module CLI
     class Heroku < Thor
-      class_option :app, aliases: :'-a', type: :string, default: nil, desc: 'Specify optional Heroku APP'
+      class_option :app, aliases: :"-a", type: :string, default: nil, desc: "Specify optional Heroku APP"
 
-      desc 'install_deploy_notification', 'Install Heroku deploy notifications addon'
-      option :api_key, aliases: :'-k', type: :string, desc: 'Api key of your Honeybadger application'
-      option :environment, aliases: :'-e', type: :string, desc: 'Environment of your Heroku application (i.e. "production", "staging")'
+      desc "install_deploy_notification", "Install Heroku deploy notifications addon"
+      option :api_key, aliases: :"-k", type: :string, desc: "Api key of your Honeybadger application"
+      option :environment, aliases: :"-e", type: :string, desc: 'Environment of your Heroku application (i.e. "production", "staging")'
       def install_deploy_notification
-        app       = options.has_key?('app') ? options['app'] : detect_heroku_app(false)
-        rails_env = options['environment'] || heroku_var('RAILS_ENV', app)
-        api_key   = options['api_key'] || heroku_var('HONEYBADGER_API_KEY', app)
+        app = options.has_key?("app") ? options["app"] : detect_heroku_app(false)
+        rails_env = options["environment"] || heroku_var("RAILS_ENV", app)
+        api_key = options["api_key"] || heroku_var("HONEYBADGER_API_KEY", app)
 
-        unless api_key =~ /\S/
+        unless /\S/.match?(api_key)
           say("Unable to detect your API key from Heroku.", :red)
-          say('Have you configured multiple Heroku apps? Try using --app APP', :red) unless app
+          say("Have you configured multiple Heroku apps? Try using --app APP", :red) unless app
           exit(1)
         end
 
-        unless rails_env =~ /\S/
+        unless /\S/.match?(rails_env)
           say("Unable to detect your environment from Heroku. Use --environment ENVIRONMENT.", :red)
-          say('Have you configured multiple Heroku apps? Try using --app APP', :red) unless app
+          say("Have you configured multiple Heroku apps? Try using --app APP", :red) unless app
           exit(1)
         end
 
-        cmd = %Q(heroku webhooks:add -i api:release -l notify -u "https://api.honeybadger.io/v1/deploys/heroku?environment=#{rails_env}&api_key=#{api_key}"#{app ? " --app #{app}" : ''})
+        cmd = %(heroku webhooks:add -i api:release -l notify -u "https://api.honeybadger.io/v1/deploys/heroku?environment=#{rails_env}&api_key=#{api_key}"#{app ? " --app #{app}" : ""})
 
         say("Running: `#{cmd}`")
         say(run(cmd))
       end
 
-      desc 'install API_KEY', 'Install Honeybadger on Heroku using API_KEY'
+      desc "install API_KEY", "Install Honeybadger on Heroku using API_KEY"
       def install(api_key)
         say("Installing Honeybadger #{VERSION} for Heroku")
 
         app = options[:app] || detect_heroku_app(false)
         say("Adding config HONEYBADGER_API_KEY=#{api_key} to Heroku.", :magenta)
-        unless write_heroku_env({'HONEYBADGER_API_KEY' => api_key}, app)
-          say('Unable to update heroku config. You may need to specify an app name with --app APP', :red)
+        unless write_heroku_env({"HONEYBADGER_API_KEY" => api_key}, app)
+          say("Unable to update heroku config. You may need to specify an app name with --app APP", :red)
           exit(1)
         end
 
-        if env = heroku_var('RAILS_ENV', app, heroku_var('RACK_ENV', app))
-          say('Installing deploy notification addon', :magenta)
-          invoke :install_deploy_notification, [], { app: app, api_key: api_key, environment: env }
+        if (env = heroku_var("RAILS_ENV", app, heroku_var("RACK_ENV", app)))
+          say("Installing deploy notification addon", :magenta)
+          invoke :install_deploy_notification, [], {app: app, api_key: api_key, environment: env}
         else
-          say('Skipping deploy notification installation: we were unable to determine the environment name from your Heroku app.', :yellow)
+          say("Skipping deploy notification installation: we were unable to determine the environment name from your Heroku app.", :yellow)
           say("To install manually, try `honeybadger heroku install_deploy_notification#{app ? " -a #{app}" : ""} -k #{api_key} --environment ENVIRONMENT`", :yellow)
         end
 
@@ -60,14 +60,14 @@ module Honeybadger
       #
       # Returns the String app name if detected, otherwise nil.
       def detect_heroku_app(prompt_on_default = true)
-        apps, git_config = {}, File.join(Dir.pwd, '.git', 'config')
+        apps, git_config = {}, File.join(Dir.pwd, ".git", "config")
         if File.exist?(git_config)
-          require 'inifile'
+          require "inifile"
           ini = IniFile.load(git_config)
           ini.each_section do |section|
-            if match = section.match(/remote \"(?<remote>.+)\"/)
-              url = ini[section]['url']
-              if url_match = url.match(/heroku\.com:(?<app>.+)\.git$/)
+            if (match = section.match(/remote "(?<remote>.+)"/))
+              url = ini[section]["url"]
+              if (url_match = url.match(/heroku\.com:(?<app>.+)\.git$/))
                 apps[match[:remote]] = url_match[:app]
               end
             end
@@ -78,16 +78,16 @@ module Honeybadger
               apps.values.first
             else
               say "We detected a Heroku app named #{apps.values.first}. Do you want to load the config? (y/yes or n/no)"
-              if STDIN.gets.chomp =~ /(y|yes)/i
+              if /(y|yes)/i.match?($stdin.gets.chomp)
                 apps.values.first
               end
             end
           elsif apps.size > 1
             say "We detected the following Heroku apps:"
-            apps.each_with_index {|a,i| say "\s\s#{i+1}. #{a[1]}" }
-            say "\s\s#{apps.size+1}. Use default"
-            say "Please select an option (1-#{apps.size+1}):"
-            apps.values[STDIN.gets.chomp.to_i-1]
+            apps.each_with_index { |a, i| say "\s\s#{i + 1}. #{a[1]}" }
+            say "\s\s#{apps.size + 1}. Use default"
+            say "Please select an option (1-#{apps.size + 1}):"
+            apps.values[$stdin.gets.chomp.to_i - 1]
           end
         end
       end
@@ -97,29 +97,29 @@ module Honeybadger
       end
 
       def heroku_var(var, app_name, default = nil)
-        app = app_name ? "--app #{app_name}" : ''
+        app = app_name ? "--app #{app_name}" : ""
         result = run("heroku config:get #{var} #{app} 2> /dev/null").strip
-        result.split.find(lambda { default }) {|x| x =~ /\S/ }
+        result.split.find(lambda { default }) { |x| x =~ /\S/ }
       end
 
       def read_heroku_env(app = nil)
-        cmd = ['heroku config']
+        cmd = ["heroku config"]
         cmd << "--app #{app}" if app
         output = run(cmd.join("\s"))
         return false unless $?.to_i == 0
-        Hash[output.scan(/(HONEYBADGER_[^:]+):\s*(\S.*)\s*$/)]
+        output.scan(/(HONEYBADGER_[^:]+):\s*(\S.*)\s*$/).to_h
       end
 
       def set_env_from_heroku(app = nil)
-        return false unless env = read_heroku_env(app)
-        env.each_pair do |k,v|
+        return false unless (env = read_heroku_env(app))
+        env.each_pair do |k, v|
           ENV[k] ||= v
         end
       end
 
       def write_heroku_env(env, app = nil)
         cmd = ["heroku config:set"]
-        Hash(env).each_pair {|k,v| cmd << "#{k}=#{v}" }
+        Hash(env).each_pair { |k, v| cmd << "#{k}=#{v}" }
         cmd << "--app #{app}" if app
         run(cmd.join("\s"))
         $?.to_i == 0

data/lib/honeybadger/cli/install.rb

@@ -1,7 +1,7 @@
-require 'forwardable'
-require 'honeybadger/cli/main'
-require 'honeybadger/cli/test'
-require 'pathname'
+require "forwardable"
+require "honeybadger/cli/main"
+require "honeybadger/cli/test"
+require "pathname"
 
 module Honeybadger
   module CLI
@@ -18,15 +18,15 @@ module Honeybadger
         say("Installing Honeybadger #{VERSION}")
 
         begin
-          require File.join(Dir.pwd, 'config', 'application.rb')
+          require File.join(Dir.pwd, "config", "application.rb")
           raise LoadError unless defined?(::Rails.application)
           root = Rails.root
-          config_root = root.join('config')
+          config_root = root.join("config")
         rescue LoadError
           root = config_root = Pathname.new(Dir.pwd)
         end
 
-        config_path = config_root.join('honeybadger.yml')
+        config_path = config_root.join("honeybadger.yml")
 
         if config_path.exist?
           say("You're already on Honeybadger, so you're all set.", :yellow)
@@ -45,52 +45,52 @@ module Honeybadger
 
           default_env = defined?(::Rails.application) ? "Rails.env" : "ENV['RUBY_ENV'] || ENV['RACK_ENV']"
           default_root = defined?(::Rails.application) ? "Rails.root.to_s" : "Dir.pwd"
-          File.open(path, 'w+') do |file|
-            file.write(<<-CONFIG)
----
-# For more options, see https://docs.honeybadger.io/lib/ruby/gem-reference/configuration
-
-api_key: '#{api_key}'
-
-# The environment your app is running in.
-env: "<%= #{default_env} %>"
-
-# The absolute path to your project folder.
-root: "<%= #{default_root} %>"
-
-# Honeybadger won't report errors in these environments.
-development_environments:
-- test
-- development
-- cucumber
-
-# By default, Honeybadger won't report errors in the development_environments.
-# You can override this by explicitly setting report_data to true or false.
-# report_data: true
-
-# The current Git revision of your project. Defaults to the last commit hash.
-# revision: null
-
-# Enable verbose debug logging (useful for troubleshooting).
-debug: false
-
-# Enable Honeybadger Insights
-insights:
-  enabled: #{options["insights"]}
-CONFIG
+          File.open(path, "w+") do |file|
+            file.write(<<~CONFIG)
+              ---
+              # For more options, see https://docs.honeybadger.io/lib/ruby/gem-reference/configuration
+              
+              api_key: '#{api_key}'
+              
+              # The environment your app is running in.
+              env: "<%= #{default_env} %>"
+              
+              # The absolute path to your project folder.
+              root: "<%= #{default_root} %>"
+              
+              # Honeybadger won't report errors in these environments.
+              development_environments:
+              - test
+              - development
+              - cucumber
+              
+              # By default, Honeybadger won't report errors in the development_environments.
+              # You can override this by explicitly setting report_data to true.
+              # report_data: true
+              
+              # The current Git revision of your project. Defaults to the last commit hash.
+              # revision: null
+              
+              # Enable verbose debug logging (useful for troubleshooting).
+              debug: false
+              
+              # Enable Honeybadger Insights
+              insights:
+                enabled: #{options["insights"]}
+            CONFIG
             if (connection = options.slice("host", "ui_host")).any?
               file.puts("\n# Override hosts\nconnection:")
-              connection.each {|k,v| file.puts("  #{k}: '#{v}'") }
+              connection.each { |k, v| file.puts("  #{k}: '#{v}'") }
             end
           end
         end
 
-        if (capfile = root.join('Capfile')).exist?
-          if capfile.read.match(/honeybadger/)
+        if (capfile = root.join("Capfile")).exist?
+          if /honeybadger/.match?(capfile.read)
             say("Detected Honeybadger in Capfile; skipping Capistrano installation.", :yellow)
           else
             say("Appending Capistrano tasks to: #{capfile}", :yellow)
-            File.open(capfile, 'a') do |f|
+            File.open(capfile, "a") do |f|
               f.puts("\nrequire 'capistrano/honeybadger'")
             end
           end