honeybadger 5.0.2 → 5.1.0

data/lib/honeybadger/cli/exec.rb

@@ -1,143 +1,143 @@
-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
-    class Exec
-      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
-
-      def initialize(options, args, config)
-        @options = options
-        @args = args
-        @config = config
-        @shell = ::Thor::Base.shell.new
-      end
-
-      def run
-        result = exec_cmd
-        return if result.success
-
-        executable = args.first.to_s[/\S+/]
-        payload = {
-          api_key: config.get(:api_key),
-          notifier: NOTIFIER,
-          error: {
-            class: 'honeybdager exec error',
-            message: result.msg
-          },
-          request: {
-            component: executable,
-            context: {
-              command: args.join(' '),
-              code: result.code,
-              pid: result.pid,
-              pwd: Dir.pwd,
-              path: ENV['PATH']
-            }
-          },
-          server: {
-            project_root: Dir.pwd,
-            environment_name: config.get(:env),
-            time: Time.now,
-            stats: Util::Stats.all
-          }
-        }
-
-        begin
-          response = config.backend.notify(:notices, payload)
-        rescue
-          say(result.msg)
-          raise
-        end
-
-        if !response.success?
-          say(result.msg)
-          say(error_message(response), :red)
-          exit(1)
-        end
-
-        unless quiet?
-          say(result.msg)
-          say("\nSuccessfully notified Honeybadger")
-        end
-
-        exit(0)
-      end
-
-      private
-
-      attr_reader :options, :args, :config
-
-      def_delegator :@shell, :say
-
-      def quiet?
-        !!options[:quiet]
-      end
-
-      def exec_cmd
-        stdout, stderr, status = Open3.capture3(args.join(' '))
-
-        success = status.success? && stderr =~ BLANK
-        pid = status.pid
-        code = status.to_i
-        msg = ERB.new(FAILED_TEMPLATE).result(binding) unless success
-
-        OpenStruct.new(
-          msg: msg,
-          pid: pid,
-          code: code,
-          stdout: stdout,
-          stderr: stderr,
-          success: success
-        )
-      rescue Errno::EACCES, Errno::ENOEXEC
-        OpenStruct.new(
-          msg: ERB.new(NO_EXEC_TEMPLATE).result(binding),
-          code: 126
-        )
-      rescue Errno::ENOENT
-        OpenStruct.new(
-          msg: ERB.new(NOT_FOUND_TEMPLATE).result(binding),
-          code: 127
-        )
-      end
-    end
-  end
-end
+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
+    class Exec
+      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
+
+      def initialize(options, args, config)
+        @options = options
+        @args = args
+        @config = config
+        @shell = ::Thor::Base.shell.new
+      end
+
+      def run
+        result = exec_cmd
+        return if result.success
+
+        executable = args.first.to_s[/\S+/]
+        payload = {
+          api_key: config.get(:api_key),
+          notifier: NOTIFIER,
+          error: {
+            class: 'honeybdager exec error',
+            message: result.msg
+          },
+          request: {
+            component: executable,
+            context: {
+              command: args.join(' '),
+              code: result.code,
+              pid: result.pid,
+              pwd: Dir.pwd,
+              path: ENV['PATH']
+            }
+          },
+          server: {
+            project_root: Dir.pwd,
+            environment_name: config.get(:env),
+            time: Time.now,
+            stats: Util::Stats.all
+          }
+        }
+
+        begin
+          response = config.backend.notify(:notices, payload)
+        rescue
+          say(result.msg)
+          raise
+        end
+
+        if !response.success?
+          say(result.msg)
+          say(error_message(response), :red)
+          exit(1)
+        end
+
+        unless quiet?
+          say(result.msg)
+          say("\nSuccessfully notified Honeybadger")
+        end
+
+        exit(0)
+      end
+
+      private
+
+      attr_reader :options, :args, :config
+
+      def_delegator :@shell, :say
+
+      def quiet?
+        !!options[:quiet]
+      end
+
+      def exec_cmd
+        stdout, stderr, status = Open3.capture3(args.join(' '))
+
+        success = status.success? && stderr =~ BLANK
+        pid = status.pid
+        code = status.to_i
+        msg = ERB.new(FAILED_TEMPLATE).result(binding) unless success
+
+        OpenStruct.new(
+          msg: msg,
+          pid: pid,
+          code: code,
+          stdout: stdout,
+          stderr: stderr,
+          success: success
+        )
+      rescue Errno::EACCES, Errno::ENOEXEC
+        OpenStruct.new(
+          msg: ERB.new(NO_EXEC_TEMPLATE).result(binding),
+          code: 126
+        )
+      rescue Errno::ENOENT
+        OpenStruct.new(
+          msg: ERB.new(NOT_FOUND_TEMPLATE).result(binding),
+          code: 127
+        )
+      end
+    end
+  end
+end

data/lib/honeybadger/cli/helpers.rb

@@ -1,28 +1,28 @@
-module Honeybadger
-  module CLI
-    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
-        end
-      end
-    end
-  end
-end
+module Honeybadger
+  module CLI
+    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
+        end
+      end
+    end
+  end
+end

data/lib/honeybadger/cli/heroku.rb

@@ -1,129 +1,129 @@
-module Honeybadger
-  module CLI
-    class Heroku < Thor
-      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")'
-      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)
-
-        unless api_key =~ /\S/
-          say("Unable to detect your API key from Heroku.", :red)
-          say('Have you configured multiple Heroku apps? Try using --app APP', :red) unless app
-          exit(1)
-        end
-
-        unless rails_env =~ /\S/
-          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
-          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}" : ''})
-
-        say("Running: `#{cmd}`")
-        say(run(cmd))
-      end
-
-      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)
-          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 }
-        else
-          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
-
-        say("Installation complete. Happy 'badgering!", :green)
-      end
-
-      private
-
-      # Detects the Heroku app name from GIT.
-      #
-      # @param [Boolean] prompt_on_default If a single remote is discoverd,
-      #   should we prompt the user before returning it?
-      #
-      # 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')
-        if File.exist?(git_config)
-          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$/)
-                apps[match[:remote]] = url_match[:app]
-              end
-            end
-          end
-
-          if apps.size == 1
-            if !prompt_on_default
-              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
-                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]
-          end
-        end
-      end
-
-      def run(cmd)
-        Bundler.with_unbundled_env { `#{cmd}` }
-      end
-
-      def heroku_var(var, app_name, default = nil)
-        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/ }
-      end
-
-      def read_heroku_env(app = nil)
-        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*$/)]
-      end
-
-      def set_env_from_heroku(app = nil)
-        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}" }
-        cmd << "--app #{app}" if app
-        run(cmd.join("\s"))
-        $?.to_i == 0
-      end
-    end
-  end
-end
+module Honeybadger
+  module CLI
+    class Heroku < Thor
+      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")'
+      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)
+
+        unless api_key =~ /\S/
+          say("Unable to detect your API key from Heroku.", :red)
+          say('Have you configured multiple Heroku apps? Try using --app APP', :red) unless app
+          exit(1)
+        end
+
+        unless rails_env =~ /\S/
+          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
+          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}" : ''})
+
+        say("Running: `#{cmd}`")
+        say(run(cmd))
+      end
+
+      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)
+          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 }
+        else
+          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
+
+        say("Installation complete. Happy 'badgering!", :green)
+      end
+
+      private
+
+      # Detects the Heroku app name from GIT.
+      #
+      # @param [Boolean] prompt_on_default If a single remote is discoverd,
+      #   should we prompt the user before returning it?
+      #
+      # 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')
+        if File.exist?(git_config)
+          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$/)
+                apps[match[:remote]] = url_match[:app]
+              end
+            end
+          end
+
+          if apps.size == 1
+            if !prompt_on_default
+              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
+                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]
+          end
+        end
+      end
+
+      def run(cmd)
+        Bundler.with_unbundled_env { `#{cmd}` }
+      end
+
+      def heroku_var(var, app_name, default = nil)
+        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/ }
+      end
+
+      def read_heroku_env(app = nil)
+        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*$/)]
+      end
+
+      def set_env_from_heroku(app = nil)
+        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}" }
+        cmd << "--app #{app}" if app
+        run(cmd.join("\s"))
+        $?.to_i == 0
+      end
+    end
+  end
+end