Class: HoptoadNotifier::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/hoptoad_notifier/configuration.rb

Overview

Used to set up and modify settings for the notifier.

Constant Summary collapse

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, :framework,
:user_information].freeze
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',
'AbstractController::ActionNotFound']

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Configuration

Returns a new instance of Configuration.



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/hoptoad_notifier/configuration.rb', line 120

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'
  @framework                = 'Standalone'
  @user_information         = 'Hoptoad Error {{error_id}}'
end

Instance Attribute Details

#api_key ⇒ Object

The API key for your project, found on the project edit form.



14
15
16
 
# File 'lib/hoptoad_notifier/configuration.rb', line 14

def api_key
  @api_key
end

#backtrace_filters ⇒ Object (readonly)

A list of filters for cleaning and pruning the backtrace. See #filter_backtrace.



49
50
51
 
# File 'lib/hoptoad_notifier/configuration.rb', line 49

def backtrace_filters
  @backtrace_filters
end

#development_environments ⇒ Object

A list of environments in which notifications should not be sent.



61
62
63
 
# File 'lib/hoptoad_notifier/configuration.rb', line 61

def development_environments
  @development_environments
end

#development_lookup ⇒ Object

true if you want to check for production errors matching development errors, false otherwise.



64
65
66
 
# File 'lib/hoptoad_notifier/configuration.rb', line 64

def development_lookup
  @development_lookup
end

#environment_name ⇒ Object

The name of the environment the application is running in



67
68
69
 
# File 'lib/hoptoad_notifier/configuration.rb', line 67

def environment_name
  @environment_name
end

#framework ⇒ Object

The framework HoptoadNotifier is configured to use



88
89
90
 
# File 'lib/hoptoad_notifier/configuration.rb', line 88

def framework
  @framework
end

#host ⇒ Object

The host to connect to (defaults to hoptoadapp.com).



17
18
19
 
# File 'lib/hoptoad_notifier/configuration.rb', line 17

def host
  @host
end

#http_open_timeout ⇒ Object

The HTTP open timeout in seconds (defaults to 2).



27
28
29
 
# File 'lib/hoptoad_notifier/configuration.rb', line 27

def http_open_timeout
  @http_open_timeout
end

#http_read_timeout ⇒ Object

The HTTP read timeout in seconds (defaults to 5).



30
31
32
 
# File 'lib/hoptoad_notifier/configuration.rb', line 30

def http_read_timeout
  @http_read_timeout
end

#ignore ⇒ Object (readonly)

A list of exception classes to ignore. The array can be appended to.



55
56
57
 
# File 'lib/hoptoad_notifier/configuration.rb', line 55

def ignore
  @ignore
end

#ignore_by_filters ⇒ Object (readonly)

A list of filters for ignoring exceptions. See #ignore_by_filter.



52
53
54
 
# File 'lib/hoptoad_notifier/configuration.rb', line 52

def ignore_by_filters
  @ignore_by_filters
end

#ignore_user_agent ⇒ Object (readonly)

A list of user agents that are being ignored. The array can be appended to.



58
59
60
 
# File 'lib/hoptoad_notifier/configuration.rb', line 58

def ignore_user_agent
  @ignore_user_agent
end

#logger ⇒ Object

The logger used by HoptoadNotifier



82
83
84
 
# File 'lib/hoptoad_notifier/configuration.rb', line 82

def logger
  @logger
end

#notifier_name ⇒ Object

The name of the notifier library being used to send notifications (such as “Hoptoad Notifier”)



73
74
75
 
# File 'lib/hoptoad_notifier/configuration.rb', line 73

def notifier_name
  @notifier_name
end

#notifier_url ⇒ Object

The url of the notifier library being used to send notifications



79
80
81
 
# File 'lib/hoptoad_notifier/configuration.rb', line 79

def notifier_url
  @notifier_url
end

#notifier_version ⇒ Object

The version of the notifier library being used to send notifications (such as “1.0.2”)



76
77
78
 
# File 'lib/hoptoad_notifier/configuration.rb', line 76

def notifier_version
  @notifier_version
end

#params_filters ⇒ Object (readonly)

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.



46
47
48
 
# File 'lib/hoptoad_notifier/configuration.rb', line 46

def params_filters
  @params_filters
end

#port ⇒ Object

The port on which your Hoptoad server runs (defaults to 443 for secure connections, 80 for insecure connections).



21
22
23
 
# File 'lib/hoptoad_notifier/configuration.rb', line 21

def port
  @port
end

#project_root ⇒ Object

The path to the project in which the error occurred, such as the RAILS_ROOT



70
71
72
 
# File 'lib/hoptoad_notifier/configuration.rb', line 70

def project_root
  @project_root
end

#proxy_host ⇒ Object

The hostname of your proxy server (if using a proxy)



33
34
35
 
# File 'lib/hoptoad_notifier/configuration.rb', line 33

def proxy_host
  @proxy_host
end

#proxy_pass ⇒ Object

The password to use when logging into your proxy server (if using a proxy)



42
43
44
 
# File 'lib/hoptoad_notifier/configuration.rb', line 42

def proxy_pass
  @proxy_pass
end

#proxy_port ⇒ Object

The port of your proxy server (if using a proxy)



36
37
38
 
# File 'lib/hoptoad_notifier/configuration.rb', line 36

def proxy_port
  @proxy_port
end

#proxy_user ⇒ Object

The username to use when logging into your proxy server (if using a proxy)



39
40
41
 
# File 'lib/hoptoad_notifier/configuration.rb', line 39

def proxy_user
  @proxy_user
end

#secure ⇒ Object Also known as: secure?

true for https connections, false for http connections.



24
25
26
 
# File 'lib/hoptoad_notifier/configuration.rb', line 24

def secure
  @secure
end

#user_information ⇒ Object

The text that the placeholder is replaced with. {error_id} is the actual error number.



85
86
87
 
# File 'lib/hoptoad_notifier/configuration.rb', line 85

def user_information
  @user_information
end

Instance Method Details

#[](option) ⇒ Object

Allows config options to be read like a hash

Parameters:

  • option (Symbol) —

    Key for a given attribute



185
186
187
 
# File 'lib/hoptoad_notifier/configuration.rb', line 185

def [](option)
  send(option)
end

#environment_filters ⇒ Object 



225
226
227
228
 
# File 'lib/hoptoad_notifier/configuration.rb', line 225

def environment_filters
  warn 'config.environment_filters has been deprecated and has no effect.'
  []
end

#filter_backtrace(&block) {|line| ... } ⇒ Object

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.

Examples:

config.filter_bracktrace do |line|
  line.gsub(/^#{Rails.root}/, "[RAILS_ROOT]")
end

Parameters:

  • block (Proc) —

    The new backtrace filter.

Yield Parameters:

  • line (String) —

    A line in the backtrace.



150
151
152
 
# File 'lib/hoptoad_notifier/configuration.rb', line 150

def filter_backtrace(&block)
  self.backtrace_filters << block
end

#ignore_by_filter(&block) {|data| ... } ⇒ Object

Takes a block and adds it to the list of ignore filters. When the filters run, the block will be handed the exception.

Examples:

config.ignore_by_filter do |exception_data|
  true if exception_data[:error_class] == "RuntimeError"
end

Parameters:

  • block (Proc) —

    The new ignore filter

Yield Parameters:

  • data (Hash) —

    The exception data given to HoptoadNotifier.notify

Yield Returns:

  • (Boolean) —

    If the block returns true the exception will be ignored, otherwise it will be processed by hoptoad.



164
165
166
 
# File 'lib/hoptoad_notifier/configuration.rb', line 164

def ignore_by_filter(&block)
  self.ignore_by_filters << block
end

#ignore_only=(names) ⇒ Object

Overrides the list of default ignored errors.

Parameters:

  • names (Array<Exception>) —

    A list of exceptions to ignore.



171
172
173
 
# File 'lib/hoptoad_notifier/configuration.rb', line 171

def ignore_only=(names)
  @ignore = [names].flatten
end

#ignore_user_agent_only=(names) ⇒ Object

Overrides the list of default ignored user agents

Parameters:

  • A (Array<String>) —

    list of user agents to ignore



178
179
180
 
# File 'lib/hoptoad_notifier/configuration.rb', line 178

def ignore_user_agent_only=(names)
  @ignore_user_agent = [names].flatten
end

#js_notifier=(*args) ⇒ Object 



221
222
223
 
# File 'lib/hoptoad_notifier/configuration.rb', line 221

def js_notifier=(*args)
  warn '[HOPTOAD] config.js_notifier has been deprecated and has no effect.  You should use <%= hoptoad_javascript_notifier %> directly at the top of your layouts.  Be sure to place it before all other javascript.'
end

#merge(hash) ⇒ Object

Returns a hash of all configurable options merged with hash

Parameters:

  • hash (Hash) —

    A set of configuration options that will take precedence over the defaults



199
200
201
 
# File 'lib/hoptoad_notifier/configuration.rb', line 199

def merge(hash)
  to_hash.merge(hash)
end

#protocol ⇒ Object 



213
214
215
216
217
218
219
 
# File 'lib/hoptoad_notifier/configuration.rb', line 213

def protocol
  if secure?
    'https'
  else
    'http'
  end
end

#public? ⇒ Boolean

Determines if the notifier will send notices.

Returns:

  • (Boolean) —

    Returns false if in a development environment, true otherwise.



205
206
207
 
# File 'lib/hoptoad_notifier/configuration.rb', line 205

def public?
  !development_environments.include?(environment_name)
end

#to_hash ⇒ Object

Returns a hash of all configurable options



190
191
192
193
194
 
# File 'lib/hoptoad_notifier/configuration.rb', line 190

def to_hash
  OPTIONS.inject({}) do |hash, option|
    hash.merge(option.to_sym => send(option))
  end
end