honeybadger 5.0.2 → 5.1.0

data/lib/honeybadger/backend/base.rb

@@ -1,116 +1,116 @@
-require 'forwardable'
-require 'net/http'
-require 'json'
-
-require 'honeybadger/logging'
-
-module Honeybadger
-  module Backend
-    class Response
-      NOT_BLANK = /\S/
-
-      attr_reader :code, :body, :message, :error
-
-      FRIENDLY_ERRORS = {
-        429 => "Your project is currently sending too many errors.\nThis issue should resolve itself once error traffic is reduced.".freeze,
-        503 => "Your project is currently sending too many errors.\nThis issue should resolve itself once error traffic is reduced.".freeze,
-        402 => "The project owner's billing information has expired (or the trial has ended).\nPlease check your payment details or email support@honeybadger.io for help.".freeze,
-        403 => "The API key is invalid. Please check your API key and try again.".freeze
-      }.freeze
-
-      # Initializes the Response instance.
-      #
-      # @overload initialize(response)
-      #   Creates an instance from a +Net::HTTPResponse+.
-      #   @param [Net::HTTPResponse] response With 1 argument, the code, body,
-      #     and message will be determined automatically.
-      #
-      # @overload initialize(code, body, message)
-      #   Creates an instance from parameters.
-      #   @param [Integer] code The status code. May also be :error for requests
-      #     which failed to reach the server.
-      #   @param [String] body The String body of the response.
-      #   @param [String] message The String message returned by the server (or
-      #     set by the backend in the case of an :error code).
-      def initialize(*args)
-        if (response = args.first).kind_of?(Net::HTTPResponse)
-          @code, @body, @message = response.code.to_i, response.body.to_s, response.message
-        else
-          @code, @body, @message = args
-        end
-
-        @success = (200..299).cover?(@code)
-        @error = parse_error(body) unless @success
-      end
-
-      def success?
-        @success
-      end
-
-      def error_message
-        return message if code == :error
-        return FRIENDLY_ERRORS[code] if FRIENDLY_ERRORS[code]
-        return error if error =~ NOT_BLANK
-        msg = "The server responded with #{code}"
-        msg << ": #{message}" if message =~ NOT_BLANK
-        msg
-      end
-
-      private
-
-      def parse_error(body)
-        return unless body =~ NOT_BLANK
-        obj = JSON.parse(body)
-        return obj['error'] if obj.kind_of?(Hash)
-      rescue JSON::ParserError
-        nil
-      end
-    end
-
-    class Base
-      extend Forwardable
-
-      include Honeybadger::Logging::Helper
-
-      def initialize(config)
-        @config = config
-      end
-
-      # Process payload for feature.
-      #
-      # @example
-      #   backend.notify(:notices, Notice.new(...))
-      #
-      # @param [Symbol] feature The feature name (corresponds to HTTP
-      #   endpoint). Current options are: `:notices`, `:deploys`, `:ping`.
-      # @param [#to_json] payload The JSON payload to send.
-      #
-      # @raise NotImplementedError
-      def notify(feature, payload)
-        raise NotImplementedError, 'must define #notify on subclass.'
-      end
-
-      # Does a check in using the input id.
-      #
-      # @param [String] id The unique check_in id.
-      #
-      # @raise NotImplementedError
-      def check_in(id)
-        raise NotImplementedError, 'must define #check_in on subclass.'
-      end
-
-      # Track a deployment
-      # @example
-      #   backend.track_deployment({ revision: 'be2ceb6' })
-      #
-      # @param [#to_json] payload The JSON payload containing all deployment data.
-      def track_deployment(payload)
-        notify(:deploys, payload)
-      end
-
-      private
-
-      attr_reader :config
-    end
-  end
-end
+require 'forwardable'
+require 'net/http'
+require 'json'
+
+require 'honeybadger/logging'
+
+module Honeybadger
+  module Backend
+    class Response
+      NOT_BLANK = /\S/
+
+      attr_reader :code, :body, :message, :error
+
+      FRIENDLY_ERRORS = {
+        429 => "Your project is currently sending too many errors.\nThis issue should resolve itself once error traffic is reduced.".freeze,
+        503 => "Your project is currently sending too many errors.\nThis issue should resolve itself once error traffic is reduced.".freeze,
+        402 => "The project owner's billing information has expired (or the trial has ended).\nPlease check your payment details or email support@honeybadger.io for help.".freeze,
+        403 => "The API key is invalid. Please check your API key and try again.".freeze
+      }.freeze
+
+      # Initializes the Response instance.
+      #
+      # @overload initialize(response)
+      #   Creates an instance from a +Net::HTTPResponse+.
+      #   @param [Net::HTTPResponse] response With 1 argument, the code, body,
+      #     and message will be determined automatically.
+      #
+      # @overload initialize(code, body, message)
+      #   Creates an instance from parameters.
+      #   @param [Integer] code The status code. May also be :error for requests
+      #     which failed to reach the server.
+      #   @param [String] body The String body of the response.
+      #   @param [String] message The String message returned by the server (or
+      #     set by the backend in the case of an :error code).
+      def initialize(*args)
+        if (response = args.first).kind_of?(Net::HTTPResponse)
+          @code, @body, @message = response.code.to_i, response.body.to_s, response.message
+        else
+          @code, @body, @message = args
+        end
+
+        @success = (200..299).cover?(@code)
+        @error = parse_error(body) unless @success
+      end
+
+      def success?
+        @success
+      end
+
+      def error_message
+        return message if code == :error
+        return FRIENDLY_ERRORS[code] if FRIENDLY_ERRORS[code]
+        return error if error =~ NOT_BLANK
+        msg = "The server responded with #{code}"
+        msg << ": #{message}" if message =~ NOT_BLANK
+        msg
+      end
+
+      private
+
+      def parse_error(body)
+        return unless body =~ NOT_BLANK
+        obj = JSON.parse(body)
+        return obj['error'] if obj.kind_of?(Hash)
+      rescue JSON::ParserError
+        nil
+      end
+    end
+
+    class Base
+      extend Forwardable
+
+      include Honeybadger::Logging::Helper
+
+      def initialize(config)
+        @config = config
+      end
+
+      # Process payload for feature.
+      #
+      # @example
+      #   backend.notify(:notices, Notice.new(...))
+      #
+      # @param [Symbol] feature The feature name (corresponds to HTTP
+      #   endpoint). Current options are: `:notices`, `:deploys`, `:ping`.
+      # @param [#to_json] payload The JSON payload to send.
+      #
+      # @raise NotImplementedError
+      def notify(feature, payload)
+        raise NotImplementedError, 'must define #notify on subclass.'
+      end
+
+      # Does a check in using the input id.
+      #
+      # @param [String] id The unique check_in id.
+      #
+      # @raise NotImplementedError
+      def check_in(id)
+        raise NotImplementedError, 'must define #check_in on subclass.'
+      end
+
+      # Track a deployment
+      # @example
+      #   backend.track_deployment({ revision: 'be2ceb6' })
+      #
+      # @param [#to_json] payload The JSON payload containing all deployment data.
+      def track_deployment(payload)
+        notify(:deploys, payload)
+      end
+
+      private
+
+      attr_reader :config
+    end
+  end
+end

data/lib/honeybadger/backend/debug.rb

@@ -1,22 +1,22 @@
-require 'honeybadger/backend/null'
-
-module Honeybadger
-  module Backend
-    # Logs the notice payload rather than sending it. The purpose of this
-    # backend is primarily for programmatically inspecting JSON payloads in
-    # integration tests.
-    class Debug < Null
-      def notify(feature, payload)
-        logger.unknown("notifying debug backend of feature=#{feature}\n\t#{payload.to_json}")
-        return Response.new(ENV['DEBUG_BACKEND_STATUS'].to_i, nil) if ENV['DEBUG_BACKEND_STATUS']
-        super
-      end
-
-      def check_in(id)
-        logger.unknown("checking in debug backend with id=#{id}")
-        return Response.new(ENV['DEBUG_BACKEND_STATUS'].to_i, nil) if ENV['DEBUG_BACKEND_STATUS']
-        super
-      end
-    end
-  end
-end
+require 'honeybadger/backend/null'
+
+module Honeybadger
+  module Backend
+    # Logs the notice payload rather than sending it. The purpose of this
+    # backend is primarily for programmatically inspecting JSON payloads in
+    # integration tests.
+    class Debug < Null
+      def notify(feature, payload)
+        logger.unknown("notifying debug backend of feature=#{feature}\n\t#{payload.to_json}")
+        return Response.new(ENV['DEBUG_BACKEND_STATUS'].to_i, nil) if ENV['DEBUG_BACKEND_STATUS']
+        super
+      end
+
+      def check_in(id)
+        logger.unknown("checking in debug backend with id=#{id}")
+        return Response.new(ENV['DEBUG_BACKEND_STATUS'].to_i, nil) if ENV['DEBUG_BACKEND_STATUS']
+        super
+      end
+    end
+  end
+end

data/lib/honeybadger/backend/null.rb

@@ -1,29 +1,29 @@
-require 'honeybadger/backend/base'
-
-module Honeybadger
-  module Backend
-    class Null < Base
-      class StubbedResponse < Response
-        def initialize
-          super(:stubbed, '{}'.freeze)
-        end
-
-        def success?
-          true
-        end
-      end
-
-      def initialize(*args)
-        super
-      end
-
-      def notify(feature, payload)
-        StubbedResponse.new
-      end
-
-      def check_in(id)
-        StubbedResponse.new
-      end
-    end
-  end
-end
+require 'honeybadger/backend/base'
+
+module Honeybadger
+  module Backend
+    class Null < Base
+      class StubbedResponse < Response
+        def initialize
+          super(:stubbed, '{}'.freeze)
+        end
+
+        def success?
+          true
+        end
+      end
+
+      def initialize(*args)
+        super
+      end
+
+      def notify(feature, payload)
+        StubbedResponse.new
+      end
+
+      def check_in(id)
+        StubbedResponse.new
+      end
+    end
+  end
+end

data/lib/honeybadger/backend/server.rb

@@ -1,62 +1,62 @@
-require 'net/http'
-require 'json'
-require 'zlib'
-require 'openssl'
-
-require 'honeybadger/backend/base'
-require 'honeybadger/util/http'
-
-module Honeybadger
-  module Backend
-    class Server < Base
-      ENDPOINTS = {
-        notices: '/v1/notices'.freeze,
-        deploys: '/v1/deploys'.freeze
-      }.freeze
-
-      CHECK_IN_ENDPOINT = '/v1/check_in'.freeze
-
-
-      HTTP_ERRORS = Util::HTTP::ERRORS
-
-      def initialize(config)
-        @http = Util::HTTP.new(config)
-        super
-      end
-
-      # Post payload to endpoint for feature.
-      #
-      # @param [Symbol] feature The feature which is being notified.
-      # @param [#to_json] payload The JSON payload to send.
-      #
-      # @return [Response]
-      def notify(feature, payload)
-        ENDPOINTS[feature] or raise(BackendError, "Unknown feature: #{feature}")
-        Response.new(@http.post(ENDPOINTS[feature], payload, payload_headers(payload)))
-      rescue *HTTP_ERRORS => e
-        Response.new(:error, nil, "HTTP Error: #{e.class}")
-      end
-
-      # Does a check in using the input id.
-      #
-      # @param [String] id The unique check_in id.
-      #
-      # @return [Response]
-      def check_in(id)
-        Response.new(@http.get("#{CHECK_IN_ENDPOINT}/#{id}"))
-      rescue *HTTP_ERRORS => e
-        Response.new(:error, nil, "HTTP Error: #{e.class}")
-      end
-
-      private
-
-      def payload_headers(payload)
-        if payload.respond_to?(:api_key) && payload.api_key
-          {
-            'X-API-Key' => payload.api_key
-          }
-        end
-      end
-    end
-  end
-end
+require 'net/http'
+require 'json'
+require 'zlib'
+require 'openssl'
+
+require 'honeybadger/backend/base'
+require 'honeybadger/util/http'
+
+module Honeybadger
+  module Backend
+    class Server < Base
+      ENDPOINTS = {
+        notices: '/v1/notices'.freeze,
+        deploys: '/v1/deploys'.freeze
+      }.freeze
+
+      CHECK_IN_ENDPOINT = '/v1/check_in'.freeze
+
+
+      HTTP_ERRORS = Util::HTTP::ERRORS
+
+      def initialize(config)
+        @http = Util::HTTP.new(config)
+        super
+      end
+
+      # Post payload to endpoint for feature.
+      #
+      # @param [Symbol] feature The feature which is being notified.
+      # @param [#to_json] payload The JSON payload to send.
+      #
+      # @return [Response]
+      def notify(feature, payload)
+        ENDPOINTS[feature] or raise(BackendError, "Unknown feature: #{feature}")
+        Response.new(@http.post(ENDPOINTS[feature], payload, payload_headers(payload)))
+      rescue *HTTP_ERRORS => e
+        Response.new(:error, nil, "HTTP Error: #{e.class}")
+      end
+
+      # Does a check in using the input id.
+      #
+      # @param [String] id The unique check_in id.
+      #
+      # @return [Response]
+      def check_in(id)
+        Response.new(@http.get("#{CHECK_IN_ENDPOINT}/#{id}"))
+      rescue *HTTP_ERRORS => e
+        Response.new(:error, nil, "HTTP Error: #{e.class}")
+      end
+
+      private
+
+      def payload_headers(payload)
+        if payload.respond_to?(:api_key) && payload.api_key
+          {
+            'X-API-Key' => payload.api_key
+          }
+        end
+      end
+    end
+  end
+end

data/lib/honeybadger/backend/test.rb

@@ -1,46 +1,46 @@
-require 'honeybadger/backend/null'
-
-module Honeybadger
-  module Backend
-    class Test < Null
-      # The notification list.
-      #
-      # @example
-      #   Test.notifications[:notices] # => [Notice, Notice, ...]
-      #
-      # @return [Hash] Notifications hash.
-      def self.notifications
-        @notifications ||= Hash.new {|h,k| h[k] = [] }
-      end
-
-      # @api public
-      # The check in list.
-      #
-      # @example
-      #   Test.check_ins # => ["foobar", "danny", ...]
-      #
-      # @return [Array<Object>] List of check ins.
-      def self.check_ins
-        @check_ins ||= []
-      end
-
-      def notifications
-        self.class.notifications
-      end
-
-      def check_ins
-        self.class.check_ins
-      end
-
-      def notify(feature, payload)
-        notifications[feature] << payload
-        super
-      end
-
-      def check_in(id)
-        check_ins << id
-        super
-      end
-    end
-  end
-end
+require 'honeybadger/backend/null'
+
+module Honeybadger
+  module Backend
+    class Test < Null
+      # The notification list.
+      #
+      # @example
+      #   Test.notifications[:notices] # => [Notice, Notice, ...]
+      #
+      # @return [Hash] Notifications hash.
+      def self.notifications
+        @notifications ||= Hash.new {|h,k| h[k] = [] }
+      end
+
+      # @api public
+      # The check in list.
+      #
+      # @example
+      #   Test.check_ins # => ["foobar", "danny", ...]
+      #
+      # @return [Array<Object>] List of check ins.
+      def self.check_ins
+        @check_ins ||= []
+      end
+
+      def notifications
+        self.class.notifications
+      end
+
+      def check_ins
+        self.class.check_ins
+      end
+
+      def notify(feature, payload)
+        notifications[feature] << payload
+        super
+      end
+
+      def check_in(id)
+        check_ins << id
+        super
+      end
+    end
+  end
+end

data/lib/honeybadger/backend.rb

@@ -1,27 +1,27 @@
-require 'forwardable'
-
-require 'honeybadger/backend/base'
-require 'honeybadger/backend/server'
-require 'honeybadger/backend/test'
-require 'honeybadger/backend/null'
-require 'honeybadger/backend/debug'
-
-module Honeybadger
-  # @api private
-  module Backend
-    class BackendError < StandardError; end
-
-    def self.mapping
-      @@mapping ||= {
-        server: Server,
-        test: Test,
-        null: Null,
-        debug: Debug
-      }.freeze
-    end
-
-    def self.for(backend)
-      mapping[backend] or raise(BackendError, "Unable to locate backend: #{backend}")
-    end
-  end
-end
+require 'forwardable'
+
+require 'honeybadger/backend/base'
+require 'honeybadger/backend/server'
+require 'honeybadger/backend/test'
+require 'honeybadger/backend/null'
+require 'honeybadger/backend/debug'
+
+module Honeybadger
+  # @api private
+  module Backend
+    class BackendError < StandardError; end
+
+    def self.mapping
+      @@mapping ||= {
+        server: Server,
+        test: Test,
+        null: Null,
+        debug: Debug
+      }.freeze
+    end
+
+    def self.for(backend)
+      mapping[backend] or raise(BackendError, "Unable to locate backend: #{backend}")
+    end
+  end
+end