hoptoad_notifier 2.1.0

data/lib/hoptoad_notifier/catcher.rb

@@ -0,0 +1,95 @@
+module HoptoadNotifier
+  # Include this module in Controllers in which you want to be notified of errors.
+  module Catcher
+
+    # Sets up an alias chain to catch exceptions when Rails does
+    def self.included(base) #:nodoc:
+      if base.instance_methods.map(&:to_s).include? 'rescue_action_in_public' and !base.instance_methods.map(&:to_s).include? 'rescue_action_in_public_without_hoptoad'
+        base.send(:alias_method, :rescue_action_in_public_without_hoptoad, :rescue_action_in_public)
+        base.send(:alias_method, :rescue_action_in_public, :rescue_action_in_public_with_hoptoad)
+        base.send(:alias_method, :rescue_action_locally_without_hoptoad, :rescue_action_locally)
+        base.send(:alias_method, :rescue_action_locally, :rescue_action_locally_with_hoptoad)
+      end
+    end
+
+    private
+
+    # Overrides the rescue_action method in ActionController::Base, but does not inhibit
+    # any custom processing that is defined with Rails 2's exception helpers.
+    def rescue_action_in_public_with_hoptoad(exception)
+      unless hoptoad_ignore_user_agent?
+        HoptoadNotifier.notify_or_ignore(exception, hoptoad_request_data)
+      end
+      rescue_action_in_public_without_hoptoad(exception)
+    end
+
+    def rescue_action_locally_with_hoptoad(exception)
+      result = rescue_action_locally_without_hoptoad(exception)
+
+      if HoptoadNotifier.configuration.development_lookup
+        path   = File.join(File.dirname(__FILE__), '..', 'templates', 'rescue.erb')
+        notice = HoptoadNotifier.build_lookup_hash_for(exception, hoptoad_request_data)
+
+        result << @template.render(
+          :file          => path,
+          :use_full_path => false,
+          :locals        => { :host    => HoptoadNotifier.configuration.host,
+                              :api_key => HoptoadNotifier.configuration.api_key,
+                              :notice  => notice })
+      end
+
+      result
+    end
+
+    # This method should be used for sending manual notifications while you are still
+    # inside the controller. Otherwise it works like HoptoadNotifier.notify.
+    def notify_hoptoad(hash_or_exception)
+      unless consider_all_requests_local || local_request?
+        HoptoadNotifier.notify(hash_or_exception, hoptoad_request_data)
+      end
+    end
+
+    def hoptoad_ignore_user_agent? #:nodoc:
+      # Rails 1.2.6 doesn't have request.user_agent, so check for it here
+      user_agent = request.respond_to?(:user_agent) ? request.user_agent : request.env["HTTP_USER_AGENT"]
+      HoptoadNotifier.configuration.ignore_user_agent.flatten.any? { |ua| ua === user_agent }
+    end
+
+    def hoptoad_request_data
+      { :parameters       => hoptoad_filter_if_filtering(params.to_hash),
+        :session_data     => hoptoad_session_data,
+        :controller       => params[:controller],
+        :action           => params[:action],
+        :url              => hoptoad_request_url,
+        :cgi_data         => hoptoad_filter_if_filtering(request.env),
+        :environment_vars => hoptoad_filter_if_filtering(ENV) }
+    end
+
+    def hoptoad_filter_if_filtering(hash)
+      if respond_to?(:filter_parameters)
+        filter_parameters(hash) rescue hash
+      else
+        hash
+      end
+    end
+
+    def hoptoad_session_data
+      if session.respond_to?(:to_hash)
+        session.to_hash
+      else
+        session.data
+      end
+    end
+
+    def hoptoad_request_url
+      url = "#{request.protocol}#{request.host}"
+
+      unless [80, 443].include?(request.port)
+        url << ":#{request.port}"
+      end
+
+      url << request.request_uri
+      url
+    end
+  end
+end

data/lib/hoptoad_notifier/configuration.rb

@@ -0,0 +1,228 @@
+module HoptoadNotifier
+  # 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, :project_root, :port, :protocol, :proxy_host,
+        :proxy_pass, :proxy_port, :proxy_user, :secure].freeze
+
+    # The API key for your project, found on the project edit form.
+    attr_accessor :api_key
+
+    # The host to connect to (defaults to hoptoadapp.com).
+    attr_accessor :host
+
+    # The port on which your Hoptoad server runs (defaults to 443 for secure
+    # connections, 80 for insecure connections).
+    attr_accessor :port
+
+    # +true+ for https connections, +false+ for http connections.
+    attr_accessor :secure
+
+    # 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 Hoptoad.
+    # By default, all "password" attributes will have their contents replaced.
+    attr_reader :params_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 exception classes to ignore. The array can be appended to.
+    attr_reader :ignore
+
+    # 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 "Hoptoad 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 HoptoadNotifier
+    attr_accessor :logger
+
+    DEFAULT_PARAMS_FILTERS = %w(password password_confirmation).freeze
+
+    DEFAULT_BACKTRACE_FILTERS = [
+      lambda { |line|
+        if defined?(HoptoadNotifier.configuration.project_root) && HoptoadNotifier.configuration.project_root.to_s != '' 
+          line.gsub(/#{HoptoadNotifier.configuration.project_root}/, "[PROJECT_ROOT]")
+        else
+          line
+        end
+      },
+      lambda { |line| line.gsub(/^\.\//, "") },
+      lambda { |line|
+        if defined?(Gem)
+          Gem.path.inject(line) do |line, path|
+            line.gsub(/#{path}/, "[GEM_ROOT]")
+          end
+        end
+      },
+      lambda { |line| line if line !~ %r{lib/hoptoad_notifier} }
+    ].freeze
+
+    IGNORE_DEFAULT = ['ActiveRecord::RecordNotFound',
+                      'ActionController::RoutingError',
+                      'ActionController::InvalidAuthenticityToken',
+                      'CGI::Session::CookieStore::TamperedWithCookie',
+                      'ActionController::UnknownAction']
+
+    alias_method :secure?, :secure
+
+    def initialize
+      @secure                   = false
+      @host                     = 'hoptoadapp.com'
+      @http_open_timeout        = 2
+      @http_read_timeout        = 5
+      @params_filters           = DEFAULT_PARAMS_FILTERS.dup
+      @backtrace_filters        = DEFAULT_BACKTRACE_FILTERS.dup
+      @ignore_by_filters        = []
+      @ignore                   = IGNORE_DEFAULT.dup
+      @ignore_user_agent        = []
+      @development_environments = %w(development test cucumber)
+      @development_lookup       = true
+      @notifier_name            = 'Hoptoad Notifier'
+      @notifier_version         = VERSION
+      @notifier_url             = 'http://hoptoadapp.com'
+    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 +HoptoadNotifier.notify+
+    # @yieldreturn [Boolean] If the block returns true the exception will be ignored, otherwise it will be processed by hoptoad.
+    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 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.merge(option.to_sym => send(option))
+      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 +false+ if in a development environment, +true+ otherwise.
+    def public?
+      !development_environments.include?(environment_name)
+    end
+
+    def port
+      @port || default_port
+    end
+
+    def protocol
+      if secure?
+        'https'
+      else
+        'http'
+      end
+    end
+
+    def environment_filters
+      warn 'config.environment_filters has been deprecated and has no effect.'
+      []
+    end
+
+    private
+
+    def default_port
+      if secure?
+        443
+      else
+        80
+      end
+    end
+
+  end
+
+end

data/lib/hoptoad_notifier/notice.rb

@@ -0,0 +1,295 @@
+module HoptoadNotifier
+  class Notice
+
+    # The exception that caused this notice, if any
+    attr_reader :exception
+
+    # The API key for the project to which this notice should be sent
+    attr_reader :api_key
+
+    # The backtrace from the given exception or hash.
+    attr_reader :backtrace
+
+    # The name of the class of error (such as RuntimeError)
+    attr_reader :error_class
+
+    # The name of the server environment (such as "production")
+    attr_reader :environment_name
+
+    # CGI variables such as HTTP_METHOD
+    attr_reader :cgi_data
+
+    # The message from the exception, or a general description of the error
+    attr_reader :error_message
+
+    # See Configuration#backtrace_filters
+    attr_reader :backtrace_filters
+
+    # See Configuration#params_filters
+    attr_reader :params_filters
+
+    # A hash of parameters from the query string or post body.
+    attr_reader :parameters
+    alias_method :params, :parameters
+
+    # The component (if any) which was used in this request (usually the controller)
+    attr_reader :component
+    alias_method :controller, :component
+
+    # The action (if any) that was called in this request
+    attr_reader :action
+
+    # A hash of session data from the request
+    attr_reader :session_data
+
+    # The path to the project that caused the error (usually RAILS_ROOT)
+    attr_reader :project_root
+
+    # The URL at which the error occurred (if any)
+    attr_reader :url
+
+    # See Configuration#ignore
+    attr_reader :ignore
+
+    # See Configuration#ignore_by_filters
+    attr_reader :ignore_by_filters
+
+    # The name of the notifier library sending this notice, such as "Hoptoad Notifier"
+    attr_reader :notifier_name
+
+    # The version number of the notifier library sending this notice, such as "2.1.3"
+    attr_reader :notifier_version
+
+    # A URL for more information about the notifier library sending this notice
+    attr_reader :notifier_url
+
+    def initialize(args)
+      self.args         = args
+      self.exception    = args[:exception]
+      self.api_key      = args[:api_key]
+      self.project_root = args[:project_root]
+      self.url          = args[:url]
+
+      self.notifier_name    = args[:notifier_name]
+      self.notifier_version = args[:notifier_version]
+      self.notifier_url     = args[:notifier_url]
+
+      self.ignore              = args[:ignore]              || []
+      self.ignore_by_filters   = args[:ignore_by_filters]   || []
+      self.backtrace_filters   = args[:backtrace_filters]   || []
+      self.params_filters      = args[:params_filters]      || []
+      self.parameters          = args[:parameters]          || {}
+      self.component           = args[:component] || args[:controller]
+      self.action              = args[:action]
+
+      self.environment_name = args[:environment_name]
+      self.cgi_data         = args[:cgi_data]
+      self.backtrace        = Backtrace.parse(exception_attribute(:backtrace, caller), :filters => self.backtrace_filters)
+      self.error_class      = exception_attribute(:error_class) {|exception| exception.class.name }
+      self.error_message    = exception_attribute(:error_message, 'Notification') do |exception|
+        "#{exception.class.name}: #{exception.message}"
+      end
+
+      find_session_data
+      clean_params
+    end
+
+    # Converts the given notice to XML
+    def to_xml
+      builder = Builder::XmlMarkup.new
+      builder.instruct!
+      xml = builder.notice(:version => HoptoadNotifier::API_VERSION) do |notice|
+        notice.tag!("api-key", api_key)
+        notice.notifier do |notifier|
+          notifier.name(notifier_name)
+          notifier.version(notifier_version)
+          notifier.url(notifier_url)
+        end
+        notice.error do |error|
+          error.tag!('class', error_class)
+          error.message(error_message)
+          error.backtrace do |backtrace|
+            self.backtrace.lines.each do |line|
+              backtrace.line(:number => line.number,
+                             :file   => line.file,
+                             :method => line.method)
+            end
+          end
+        end
+        if url ||
+            controller ||
+            action ||
+            !parameters.blank? ||
+            !cgi_data.blank? ||
+            !session_data.blank?
+          notice.request do |request|
+            request.url(url)
+            request.component(controller)
+            request.action(action)
+            unless parameters.blank?
+              request.params do |params|
+                xml_vars_for(params, parameters)
+              end
+            end
+            unless session_data.blank?
+              request.session do |session|
+                xml_vars_for(session, session_data)
+              end
+            end
+            unless cgi_data.blank?
+              request.tag!("cgi-data") do |cgi_datum|
+                xml_vars_for(cgi_datum, cgi_data)
+              end
+            end
+          end
+        end
+        notice.tag!("server-environment") do |env|
+          env.tag!("project-root", project_root)
+          env.tag!("environment-name", environment_name)
+        end
+      end
+      xml.to_s
+    end
+
+    # Determines if this notice should be ignored
+    def ignore?
+      ignored_class_names.include?(error_class) ||
+        ignore_by_filters.any? {|filter| filter.call(self) }
+    end
+
+    # Allows properties to be accessed using a hash-like syntax
+    #
+    # @example
+    #   notice[:error_message]
+    # @param [String] method The given key for an attribute
+    # @return The attribute value, or self if given +:request+
+    def [](method)
+      case method
+      when :request
+        self
+      else
+        send(method)
+      end
+    end
+
+    private
+
+    attr_writer :exception, :api_key, :backtrace, :error_class, :error_message,
+      :backtrace_filters, :parameters, :params_filters,
+      :environment_filters, :session_data, :project_root, :url, :ignore,
+      :ignore_by_filters, :notifier_name, :notifier_url, :notifier_version,
+      :component, :action, :cgi_data, :environment_name
+
+    # Arguments given in the initializer
+    attr_accessor :args
+
+    # Gets a property named +attribute+ of an exception, either from an actual
+    # exception or a hash.
+    #
+    # If an exception is available, #from_exception will be used. Otherwise,
+    # a key named +attribute+ will be used from the #args.
+    #
+    # If no exception or hash key is available, +default+ will be used.
+    def exception_attribute(attribute, default = nil, &block)
+      (exception && from_exception(attribute, &block)) || args[attribute] || default
+    end
+
+    # Gets a property named +attribute+ from an exception.
+    #
+    # If a block is given, it will be used when getting the property from an
+    # exception. The block should accept and exception and return the value for
+    # the property.
+    #
+    # If no block is given, a method with the same name as +attribute+ will be
+    # invoked for the value.
+    def from_exception(attribute)
+      if block_given?
+        yield(exception)
+      else
+        exception.send(attribute)
+      end
+    end
+
+    # Removes non-serializable data from the given attribute.
+    # See #clean_unserializable_data
+    def clean_unserializable_data_from(attribute)
+      self.send(:"#{attribute}=", clean_unserializable_data(send(attribute)))
+    end
+
+    # Removes non-serializable data. Allowed data types are strings, arrays,
+    # and hashes. All other types are converted to strings.
+    # TODO: move this onto Hash
+    def clean_unserializable_data(data)
+      if data.respond_to?(:to_hash)
+        data.to_hash.inject({}) do |result, (key, value)|
+          result.merge(key => clean_unserializable_data(value))
+        end
+      elsif data.respond_to?(:to_ary)
+        data.collect do |value|
+          clean_unserializable_data(value)
+        end
+      else
+        data.to_s
+      end
+    end
+
+    # Replaces the contents of params that match params_filters.
+    # TODO: extract this to a different class
+    def clean_params
+      clean_unserializable_data_from(:parameters)
+      filter(parameters)
+      if cgi_data
+        clean_unserializable_data_from(:cgi_data)
+        filter(cgi_data)
+      end
+      if session_data
+        clean_unserializable_data_from(:session_data)
+      end
+    end
+
+    def filter(hash)
+      if params_filters
+        hash.each do |key, value|
+          if filter_key?(key)
+            hash[key] = "[FILTERED]"
+          elsif value.respond_to?(:to_hash)
+            filter(hash[key])
+          end
+        end
+      end
+    end
+
+    def filter_key?(key)
+      params_filters.any? do |filter|
+        key.to_s.include?(filter)
+      end
+    end
+
+    def find_session_data
+      self.session_data = args[:session_data] || args[:session] || {}
+      self.session_data = session_data[:data] if session_data[:data]
+    end
+
+    # Converts the mixed class instances and class names into just names
+    # TODO: move this into Configuration or another class
+    def ignored_class_names
+      ignore.collect do |string_or_class|
+        if string_or_class.respond_to?(:name)
+          string_or_class.name
+        else
+          string_or_class
+        end
+      end
+    end
+
+    def xml_vars_for(builder, hash)
+      hash.each do |key, value|
+        if value.respond_to?(:to_hash)
+          builder.var(:key => key){|b| xml_vars_for(b, value.to_hash) }
+        else
+          builder.var(value.to_s, :key => key)
+        end
+      end
+    end
+  end
+end

data/lib/hoptoad_notifier/rails.rb

@@ -0,0 +1,11 @@
+if defined?(ActionController::Base) && !ActionController::Base.include?(HoptoadNotifier::Catcher)
+  ActionController::Base.send(:include, HoptoadNotifier::Catcher)
+end
+
+require 'hoptoad_notifier/rails_initializer'
+HoptoadNotifier::RailsInitializer.initialize
+
+HoptoadNotifier.configure(true) do |config|
+  config.environment_name = RAILS_ENV
+  config.project_root     = RAILS_ROOT
+end

data/lib/hoptoad_notifier/rails_initializer.rb

@@ -0,0 +1,16 @@
+module HoptoadNotifier
+  # used to initialize Rails-specific code
+  class RailsInitializer
+    def self.initialize
+      rails_logger = if defined?(Rails.logger)
+                       Rails.logger
+                     elsif defined?(RAILS_DEFAULT_LOGGER)
+                       RAILS_DEFAULT_LOGGER
+                     end
+
+      HoptoadNotifier.configure(true) do |config|
+        config.logger = rails_logger
+      end
+    end
+  end
+end