airbrake 4.3.8 → 5.0.0

data/lib/airbrake/configuration.rb

@@ -1,366 +0,0 @@
-module Airbrake
-  # Used to set up and modify settings for the notifier.
-  class Configuration
-
-    OPTIONS = [:api_key, :backtrace_filters, :development_environments,
-        :development_lookup, :environment_name, :host,
-        :http_open_timeout, :http_read_timeout, :ignore, :ignore_by_filters,
-        :ignore_user_agent, :notifier_name, :notifier_url, :notifier_version,
-        :params_filters, :params_whitelist_filters, :project_root, :port, :protocol, :proxy_host,
-        :proxy_pass, :proxy_port, :proxy_user, :secure, :use_system_ssl_cert_chain,
-        :framework, :user_information, :rescue_rake_exceptions, :rake_environment_filters,
-        :test_mode].freeze
-
-    # The API key for your project, found on the project edit form.
-    attr_accessor :api_key
-
-    # The host to connect to (defaults to airbrake.io).
-    attr_accessor :host
-
-    # The port on which your Airbrake server runs (defaults to 443 for secure
-    # connections, 80 for insecure connections).
-    attr_writer :port
-
-    # +true+ for https connections, +false+ for http connections.
-    attr_accessor :secure
-
-    # +true+ to use whatever CAs OpenSSL has installed on your system. +false+ to use the ca-bundle.crt file included in Airbrake itself (reccomended and default)
-    attr_accessor :use_system_ssl_cert_chain
-
-    # The HTTP open timeout in seconds (defaults to 2).
-    attr_accessor :http_open_timeout
-
-    # The HTTP read timeout in seconds (defaults to 5).
-    attr_accessor :http_read_timeout
-
-    # The hostname of your proxy server (if using a proxy)
-    attr_accessor :proxy_host
-
-    # The port of your proxy server (if using a proxy)
-    attr_accessor :proxy_port
-
-    # The username to use when logging into your proxy server (if using a proxy)
-    attr_accessor :proxy_user
-
-    # The password to use when logging into your proxy server (if using a proxy)
-    attr_accessor :proxy_pass
-
-    # A list of parameters that should be filtered out of what is sent to Airbrake.
-    # By default, all "password" attributes will have their contents replaced.
-    attr_accessor :params_filters
-
-    # A list of whitelisted parameters that will be sent to Airbrake.
-    # All other parameters will be filtered and their content replaced.
-    # By default this list is empty (all parameters are whitelisted).
-    attr_accessor :params_whitelist_filters
-
-    # A list of filters for cleaning and pruning the backtrace. See #filter_backtrace.
-    attr_reader :backtrace_filters
-
-    # A list of filters for ignoring exceptions. See #ignore_by_filter.
-    attr_reader :ignore_by_filters
-
-    # A list of environment keys that will be ignored from what is sent to Airbrake server
-    # Empty by default and used only in rake handler
-    attr_reader :rake_environment_filters
-
-    # A list of exception classes to ignore during server requests. The array can be appended to.
-    attr_reader :ignore
-
-    # A list of exception classes to ignore during Rake tasks. The array can be appended to.
-    attr_reader :ignore_rake
-
-    # A list of user agents that are being ignored. The array can be appended to.
-    attr_reader :ignore_user_agent
-
-    # A list of environments in which notifications should not be sent.
-    attr_accessor :development_environments
-
-    # +true+ if you want to check for production errors matching development errors, +false+ otherwise.
-    attr_accessor :development_lookup
-
-    # The name of the environment the application is running in
-    attr_accessor :environment_name
-
-    # The path to the project in which the error occurred, such as the Rails.root
-    attr_accessor :project_root
-
-    # The name of the notifier library being used to send notifications (such as "Airbrake Notifier")
-    attr_accessor :notifier_name
-
-    # The version of the notifier library being used to send notifications (such as "1.0.2")
-    attr_accessor :notifier_version
-
-    # The url of the notifier library being used to send notifications
-    attr_accessor :notifier_url
-
-    # The logger used by Airbrake
-    attr_accessor :logger
-
-    # The text that the placeholder is replaced with. {{error_id}} is the actual error number.
-    attr_accessor :user_information
-
-    # The framework Airbrake is configured to use
-    attr_accessor :framework
-
-    # Should Airbrake catch exceptions from Rake tasks?
-    # (boolean or nil; set to nil to catch exceptions when rake isn't running from a terminal; default is nil)
-    attr_accessor :rescue_rake_exceptions
-    alias_method :rescue_rake_exceptions?, :rescue_rake_exceptions
-
-    # User attributes that are being captured
-    attr_reader :user_attributes
-
-    # Only used for JSON API
-    attr_reader :project_id
-
-    # Setting this to true will use the CollectingSender instead of
-    # the default one which will cause storing the last notice locally
-    attr_accessor :test_mode
-    alias_method :test_mode?, :test_mode
-
-    DEFAULT_PARAMS_FILTERS  = %w(password password_confirmation).freeze
-    DEFAULT_PARAMS_WHITELIST_FILTERS = [].freeze
-
-    DEFAULT_USER_ATTRIBUTES = %w(id).freeze
-
-    VALID_USER_ATTRIBUTES   = %w(id name username email).freeze
-
-    DEFAULT_BACKTRACE_FILTERS = [
-      lambda { |line|
-        if defined?(Airbrake.configuration.project_root) && Airbrake.configuration.project_root.to_s != ''
-          line.sub(/#{Airbrake.configuration.project_root}/, "[PROJECT_ROOT]")
-        else
-          line
-        end
-      },
-      lambda { |line| line.gsub(/^\.\//, "") },
-      lambda { |line|
-        Gem.path.each{ |path| line.sub!(/#{path}/, "[GEM_ROOT]") unless path.to_s.strip.empty? } if defined?(Gem)
-        line
-      },
-      lambda { |line| line if line !~ %r{lib/airbrake} }
-    ].freeze
-
-    IGNORE_DEFAULT = ['ActiveRecord::RecordNotFound',
-                      'ActionController::RoutingError',
-                      'ActionController::InvalidAuthenticityToken',
-                      'CGI::Session::CookieStore::TamperedWithCookie',
-                      'ActionController::UnknownHttpMethod',
-                      'ActionController::UnknownAction',
-                      'AbstractController::ActionNotFound',
-                      'Mongoid::Errors::DocumentNotFound',
-                      'ActionController::UnknownFormat']
-
-    alias_method :secure?, :secure
-    alias_method :use_system_ssl_cert_chain?, :use_system_ssl_cert_chain
-
-    def initialize
-      @secure                   = false
-      @use_system_ssl_cert_chain= false
-      @host                     = 'api.airbrake.io'
-      @port                     = nil
-      @http_open_timeout        = 2
-      @http_read_timeout        = 5
-      @params_filters           = DEFAULT_PARAMS_FILTERS.dup
-      @params_whitelist_filters = DEFAULT_PARAMS_WHITELIST_FILTERS.dup
-      @backtrace_filters        = DEFAULT_BACKTRACE_FILTERS.dup
-      @ignore_by_filters        = []  # These filters are applied to both server requests and Rake tasks
-      @ignore                   = IGNORE_DEFAULT.dup
-      @ignore_rake              = []  # Rake tasks don't ignore any exception classes by default
-      @ignore_user_agent        = []
-      @development_environments = %w(development test cucumber)
-      @development_lookup       = true
-      @notifier_name            = 'Airbrake Notifier'
-      @notifier_version         = VERSION
-      @notifier_url             = 'https://github.com/airbrake/airbrake'
-      @framework                = 'Standalone'
-      @user_information         = 'Airbrake Error {{error_id}}'
-      @rescue_rake_exceptions   = nil
-      @user_attributes          = DEFAULT_USER_ATTRIBUTES.dup
-      @rake_environment_filters = []
-      @async                    = nil
-    end
-
-    # Takes a block and adds it to the list of backtrace filters. When the filters
-    # run, the block will be handed each line of the backtrace and can modify
-    # it as necessary.
-    #
-    # @example
-    #   config.filter_bracktrace do |line|
-    #     line.gsub(/^#{Rails.root}/, "[Rails.root]")
-    #   end
-    #
-    # @param [Proc] block The new backtrace filter.
-    # @yieldparam [String] line A line in the backtrace.
-    def filter_backtrace(&block)
-      self.backtrace_filters << block
-    end
-
-    # Takes a block and adds it to the list of ignore filters.
-    # When the filters run, the block will be handed the exception.
-    # @example
-    #   config.ignore_by_filter do |exception_data|
-    #     true if exception_data[:error_class] == "RuntimeError"
-    #   end
-    #
-    # @param [Proc] block The new ignore filter
-    # @yieldparam [Hash] data The exception data given to +Airbrake.notify+
-    # @yieldreturn [Boolean] If the block returns true the exception will be ignored, otherwise it will be processed by airbrake.
-    def ignore_by_filter(&block)
-      self.ignore_by_filters << block
-    end
-
-    # Overrides the list of default ignored errors.
-    #
-    # @param [Array<Exception>] names A list of exceptions to ignore.
-    def ignore_only=(names)
-      @ignore = [names].flatten
-    end
-
-    # Overrides the list of default ignored errors during Rake tasks.
-    #
-    # @param [Array<Exception>] names A list of rake exceptions to ignore.
-    def ignore_rake_only=(names)
-      @ignore_rake = [names].flatten
-    end
-
-    # Overrides the list of default ignored user agents
-    #
-    # @param [Array<String>] A list of user agents to ignore
-    def ignore_user_agent_only=(names)
-      @ignore_user_agent = [names].flatten
-    end
-
-    # Allows config options to be read like a hash
-    #
-    # @param [Symbol] option Key for a given attribute
-    def [](option)
-      send(option)
-    end
-
-    # Returns a hash of all configurable options
-    def to_hash
-      OPTIONS.inject({}) do |hash, option|
-        hash[option.to_sym] = self.send(option)
-        hash
-      end
-    end
-
-    # Returns a hash of all configurable options merged with +hash+
-    #
-    # @param [Hash] hash A set of configuration options that will take precedence over the defaults
-    def merge(hash)
-      to_hash.merge(hash)
-    end
-
-    # Determines if the notifier will send notices.
-    # @return [Boolean] Returns +true+ if an api string exists, +false+ otherwise.
-    def configured?
-      !api_key.nil? && !api_key.empty?
-    end
-
-    # Determines if the notifier will send notices.
-    # @return [Boolean] Returns +false+ if in a development environment, +true+ otherwise.
-    def public?
-      @public ||= !development_environments.include?(environment_name)
-    end
-
-    def port
-      @port || default_port
-    end
-
-    # Determines whether protocol should be "http" or "https".
-    # @return [String] Returns +"http"+ if you've set secure to +false+ in
-    # configuration, and +"https"+ otherwise.
-    def protocol
-      if secure?
-        'https'
-      else
-        'http'
-      end
-    end
-
-    def user_attributes=(user_attributes)
-      @user_attributes = validate_user_attributes user_attributes
-    end
-
-    # Should Airbrake send notifications asynchronously
-    # (boolean, nil or callable; default is nil).
-    # Can be used as callable-setter when block provided.
-    def async(&block)
-      if block_given?
-        @async = block
-      end
-      @async
-    end
-    alias_method :async?, :async
-
-    def async=(use_default_or_this)
-      @async = use_default_or_this == true ?
-        default_async_processor :
-        use_default_or_this
-    end
-
-    def rescue_rake_exceptions=(val)
-      if val && !defined?(Airbrake::RakeHandler)
-        raise LoadError, "you must require 'airbrake/rake_handler' to rescue from rake exceptions"
-      end
-      @rescue_rake_exceptions = val
-    end
-
-    def ca_bundle_path
-      if use_system_ssl_cert_chain?
-        OpenSSL::X509::DEFAULT_CERT_FILE if File.exist?(OpenSSL::X509::DEFAULT_CERT_FILE)
-      else
-        local_cert_path # ca-bundle.crt built from source, see resources/README.md
-      end
-    end
-
-    def local_cert_path
-      File.expand_path(File.join("..", "..", "..", "resources", "ca-bundle.crt"), __FILE__)
-    end
-
-    def project_id=(project_id)
-      @project_id = "#{project_id}"
-    end
-
-  private
-    # Determines what port should we use for sending notices.
-    # @return [Fixnum] Returns 443 if you've set secure to true in your
-    # configuration, and 80 otherwise.
-    def default_port
-      if secure?
-        443
-      else
-        80
-      end
-    end
-
-    # Async notice delivery defaults to girl friday
-    def default_async_processor
-      if defined?(SuckerPunch)
-        lambda {|notice| SendJob.new.async.perform(notice)}
-      elsif defined?(GirlFriday)
-        queue = GirlFriday::WorkQueue.new(nil, :size => 3) do |notice|
-          Airbrake.sender.send_to_airbrake(notice)
-        end
-        lambda {|notice| queue << notice}
-      else
-        warn "[AIRBRAKE] You can't use the default async handler without sucker_punch or girl_friday."\
-        " Please make sure you have sucker_punch or girl_friday installed (sucker_punch is recommended)."
-      end
-    end
-
-    def validate_user_attributes(user_attributes)
-      user_attributes.reject do |attribute|
-        unless VALID_USER_ATTRIBUTES.include? attribute.to_s
-          warn "[AIRBRAKE] Unsupported user attribute: '#{attribute}'. "\
-            "This attribute will not be shown in the Airbrake UI. "\
-            "Check http://git.io/h6YRpA for more info."
-          true
-        end
-      end
-    end
-  end
-end

data/lib/airbrake/jobs/send_job.rb

@@ -1,7 +0,0 @@
-class SendJob
-  include SuckerPunch::Job if defined?(SuckerPunch)
-
-  def perform(notice)
-    Airbrake.sender.send_to_airbrake(notice)
-  end
-end