exception_handling 0.1.1

data/test/mocha_patch.rb

@@ -0,0 +1,63 @@
+_ = ActiveSupport::Testing::SetupAndTeardown::ForClassicTestUnit
+module ActiveSupport::Testing::SetupAndTeardown::ForClassicTestUnit
+  # This redefinition is unfortunate but test/unit shows us no alternative.
+  # Doubly unfortunate: hax to support Mocha's hax.
+  # Triply unfortunate to be monkey patching it here. -Colin
+  def run(result)
+    return if @method_name.to_s == "default_test"
+
+    mocha_counter = retrieve_mocha_counter(self, result)
+    yield(Test::Unit::TestCase::STARTED, name)
+    @_result = result
+
+    begin
+      begin
+        run_callbacks :setup do
+          setup
+          __send__(@method_name)
+          mocha_verify(mocha_counter) if mocha_counter
+        end
+      rescue Mocha::ExpectationError => e
+        add_failure(e.message, e.backtrace)
+      rescue Test::Unit::AssertionFailedError => e
+        add_failure(e.message, e.backtrace)
+      rescue Exception => e
+        raise if PASSTHROUGH_EXCEPTIONS.include?(e.class)
+        add_error(e)
+      ensure
+        begin
+          teardown
+          run_callbacks :teardown
+        rescue Mocha::ExpectationError => e
+          add_failure(e.message, e.backtrace)
+        rescue Test::Unit::AssertionFailedError => e
+          add_failure(e.message, e.backtrace)
+        rescue Exception => e
+          raise if PASSTHROUGH_EXCEPTIONS.include?(e.class)
+          add_error(e)
+        end
+      end
+    ensure
+      mocha_teardown if mocha_counter
+    end
+
+    result.add_run
+    yield(Test::Unit::TestCase::FINISHED, name)
+  end
+
+  protected
+
+  def retrieve_mocha_counter(test_case, result) #:nodoc:
+    if respond_to?(:mocha_verify) # using mocha
+      if defined?(Mocha::TestCaseAdapter::AssertionCounter)
+        Mocha::TestCaseAdapter::AssertionCounter.new(result)
+      elsif defined?(Mocha::Integration::TestUnit::AssertionCounter)
+        Mocha::Integration::TestUnit::AssertionCounter.new(result)
+      elsif defined?(Mocha::MonkeyPatching::TestUnit::AssertionCounter)
+        Mocha::MonkeyPatching::TestUnit::AssertionCounter.new(result)
+      else
+        Mocha::Integration::AssertionCounter.new(test_case)
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,93 @@
+require 'active_support'
+require 'active_support/time'
+require 'active_support/test_case'
+require 'action_mailer'
+require 'shoulda'
+require 'mocha/setup'
+require 'test/mocha_patch'
+
+ActionMailer::Base.delivery_method = :test
+
+_ = ActiveSupport
+_ = ActiveSupport::TestCase
+
+class ActiveSupport::TestCase
+  @@constant_overrides = []
+
+  setup do
+    unless @@constant_overrides.nil? || @@constant_overrides.empty?
+      raise "Uh-oh! constant_overrides left over: #{@@constant_overrides.inspect}"
+    end
+
+    Time.now_override = nil
+
+    ActionMailer::Base.deliveries.clear
+  end
+
+  teardown do
+    @@constant_overrides && @@constant_overrides.reverse.each do |parent_module, k, v|
+      ExceptionHandling.ensure_safe "constant cleanup #{k.inspect}, #{parent_module}(#{parent_module.class})::#{v.inspect}(#{v.class})" do
+        silence_warnings do
+          if v == :never_defined
+            parent_module.send(:remove_const, k)
+          else
+            parent_module.const_set(k, v)
+          end
+        end
+      end
+    end
+    @@constant_overrides = []
+  end
+
+  def set_test_const(const_name, value)
+    const_name.is_a?(Symbol) and const_name = const_name.to_s
+    const_name.is_a?(String) or raise "Pass the constant name, not its value!"
+
+    final_parent_module = final_const_name = nil
+    original_value =
+      const_name.split('::').reduce(Object) do |parent_module, nested_const_name|
+        parent_module == :never_defined and raise "You need to set each parent constant earlier! #{nested_const_name}"
+        final_parent_module = parent_module
+        final_const_name    = nested_const_name
+        parent_module.const_get(nested_const_name) rescue :never_defined
+      end
+
+    @@constant_overrides << [final_parent_module, final_const_name, original_value]
+
+    silence_warnings { final_parent_module.const_set(final_const_name, value) }
+  end
+
+  def assert_emails(expected, message = nil)
+    if block_given?
+      original_count = ActionMailer::Base.deliveries.size
+      yield
+    else
+      original_count = 0
+    end
+    assert_equal expected, ActionMailer::Base.deliveries.size - original_count, "wrong number of emails#{ ': ' + message.to_s if message}"
+  end
+end
+
+class Time
+  class << self
+    attr_reader :now_override
+
+    def now_override= override_time
+      if ActiveSupport::TimeWithZone === override_time
+        override_time = override_time.localtime
+      else
+        override_time.nil? || Time === override_time or raise "override_time should be a Time object, but was a #{override_time.class.name}"
+      end
+      @now_override = override_time
+    end
+
+    unless defined? @@_old_now_defined
+      alias old_now now
+      @@_old_now_defined = true
+    end
+  end
+
+  def self.now
+    now_override ? now_override.dup : old_now
+  end
+end

data/views/exception_handling/mailer/escalation_notification.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <title>Exception Escalation</title>
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+  </head>
+  <body>
+    <h3><%=h @summary %></h3>
+    <b>Error #:</b>  <%= h(@cleaned_data[:timestamp]).presence || '<i>no error #</i>'.html_safe -%><br />
+    <b>Exception:</b>  <%= h(@cleaned_data[:error_string]).gsub("\n","<br/>\n").gsub(/ {2,}/) { |spaces| '&nbsp;'*spaces.size }.html_safe %><br />
+    <b>Server:</b>   <%= h(@server).presence || '<i>hostname not set</i>'.html_safe -%><br />
+  </body>
+</html>

data/views/exception_handling/mailer/exception_notification.html.erb

@@ -0,0 +1,81 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <title>Exception Email</title>
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+  </head>
+  <body>
+
+    <% if @cleaned_data[:first_seen_at] %>
+        <p> This exception occurred <%= @cleaned_data[:occurrences] %> times since <%= @cleaned_data[:first_seen_at] %>.</p>
+    <% end %>
+
+    <b>Error #:</b>  <%= @cleaned_data[:timestamp] -%><br />
+    <b>Server:</b>   <%= @cleaned_data[:server].presence || '<i>hostname not set</i>'.html_safe -%><br />
+
+    <b>URL:</b><br />
+      <% if (request = @cleaned_data[:request]) %>
+        <%= request[:url] || '<i>no URL in request data</i>'.html_safe %> <br />
+        Referred from: <%= @cleaned_data[:environment]['HTTP_REFERER'] || '<i>no referrer</i>'.html_safe -%><br/>
+      <% else %>
+        <i>no URL accessed</i>
+      <% end %>
+    <br />
+    <br />
+
+    <b>User summary:</b><br />
+    <% if (user_details = @cleaned_data[:user_details]) && ( user_details[:user] || user_details[:organization] ) %>
+      User: <%= user_details[:user] %> (<%= user_details[:username] %>)<br />
+      Organization: <%= user_details[:organization] %> <br />
+
+      <% if user_details[:impersonated_organization] %>
+        <br />
+        <b>Impersonating:</b><br />
+        Organization: <%= user_details[:impersonated_organization] %>
+      <% end %>
+    <% else %>
+     <i>No user logged in.</i>
+    <% end %>
+
+    <br />
+    <br />
+    <hr />
+
+    <h3>Exception:</h3>
+    <%= h(@cleaned_data[:error]).gsub("\n","<br/>\n").gsub(/ {2,}/) { |spaces| '&nbsp;'*spaces.size }.html_safe %>
+
+    <br />
+    <br />
+
+    <h3>Where:</h3>
+    <% location = @cleaned_data[:location] %>
+    <%= "#{location[:controller]}##{location[:action]}<br />" if location && location[:controller] -%>
+    <%= "#{location[:file]}, line #{location[:line]}<br />"   if location && location[:file] -%>
+
+    <% for section in ExceptionHandling::SECTIONS %>
+      <% section_value = @cleaned_data[section] %>
+      <% if section_value %>
+        <h3><%= section.to_s.capitalize -%>:</h3>
+<pre style="font-size: 12px; font-family: 'Courier New','Arial',sans-serif">
+<%= case section_value
+   when Hash
+     section_value[:to_s]
+   when Array
+     section_value.join( "\n" )
+   when NilClass # omitted
+   else
+        if section_value.respond_to?(:to_s)
+          section_value.to_s
+        else
+          raise "Unexpected value #{section_value.inspect} for section #{section}"
+        end
+   end
+-%>
+</pre>
+      <% end %>
+
+    <% end %>
+
+  </body>
+</html>

data/views/exception_handling/mailer/log_parser_exception_notification.html.erb

@@ -0,0 +1,82 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <title>Exception Email</title>
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+  </head>
+  <body>
+
+    <% if @cleaned_data[:first_seen_at] %>
+    <p> This exception occurred <%= @cleaned_data[:occurrences] %> times since <%= @cleaned_data[:first_seen_at] %>.</p>
+    <% end %>
+
+    <b>Error # </b><%= @cleaned_data[:timestamp] -%><br />
+
+    <b>URL:</b><br />
+      <% if (request = @cleaned_data[:request]) %>
+        <%= request[:url] || '<i>no URL in request data</i>'.html_safe %> <br />
+        Referred from: <%= (@cleaned_data[:environment]['HTTP_REFERER'] || '<i>no referrer</i>').html_safe %>
+      <% else %>
+        <i>no URL accessed</i>
+      <% end %>
+    <br />
+    <br />
+
+    <b>User summary:</b><br />
+    <% if (user_details = @cleaned_data[:user_details]) && ( user_details[:user] || user_details[:organization] ) %>
+      User: <%= h user_details[:user] %> (<%= h user_details[:username] %>)<br />
+      Organization: <%= user_details[:organization] %> <br />
+      <%= "Network: #{h user_details[:organization].network if user_details[:organization]}" if !user_details[:organization].is_a?(Network) %>
+
+      <% if @cleaned_data[:user_details][:impersonated_organization] %>
+        <br />
+        <b>Impersonating:</b><br />
+        Organization: <%= h @cleaned_data[:user_details][:impersonated_organization] %>
+      <% end %>
+    <% else %>
+     <i>No user logged in.</i>
+    <% end %>
+
+    <br />
+    <br />
+    <hr />
+
+    <h3>Exception:</h3>
+    <span id="error">
+    <%= h(@cleaned_data[:error]).gsub("\n","<br/>\n").gsub(/ {2,}/) { |spaces| '&nbsp;'*spaces.size }.html_safe %>
+    </span>
+
+    <br />
+    <br />
+
+    <h3>Where:</h3>
+    <%= "#{ h location[:controller]}##{ h location[:action]}<br />".html_safe if (location = @cleaned_data[:location]) && location[:controller] -%>
+    <%= "#{ h location[:file]}, line #{ h location[:line]}<br />".html_safe   if (location = @cleaned_data[:location]) && location[:file] -%>
+
+    <br />
+
+
+
+    <% for section in ExceptionHandling::SECTIONS %>
+      <% section_value = @cleaned_data[section] %>
+      <% if section_value %>
+        <h3><%= section.to_s.capitalize -%>:</h3>
+        <pre id="<%= section.to_s.capitalize -%>" style="font-size: 12px; font-family: 'Courier New',Arial,sans-serif">
+  <%= case section_value
+       when Hash
+         section_value[:to_s]
+       when Array
+         section_value.join( "\n" )
+       when NilClass # omitted
+       else
+         raise "Unexpected value #{section_value.inspect} for section #{section}"
+       end
+-%>
+    </pre>
+      <% end %>
+
+    <% end %>
+
+  </body>
+</html>

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification 
+name: exception_handling
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Colin Kelley
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-08-26 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 12
+        - 10
+        version: 0.12.10
+  name: eventmachine
+  requirement: *id001
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 2
+        - 13
+        version: 3.2.13
+  name: activesupport
+  requirement: *id002
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 2
+        - 13
+        version: 3.2.13
+  name: actionpack
+  requirement: *id003
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 2
+        - 13
+        version: 3.2.13
+  name: actionmailer
+  requirement: *id004
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 9
+        version: "0.9"
+  name: rake
+  requirement: *id005
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 1
+        - 1
+        version: 3.1.1
+  name: shoulda
+  requirement: *id006
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 13
+        - 0
+        version: 0.13.0
+  name: mocha
+  requirement: *id007
+  prerelease: false
+description: Exception handling logger/emailer
+email: 
+- colindkelley@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README
+- Rakefile
+- config/exception_filters.yml
+- exception_handling.gemspec
+- lib/exception_handling.rb
+- lib/exception_handling/version.rb
+- lib/exception_handling_mailer.rb
+- test/exception_handling_test.rb
+- test/mocha_patch.rb
+- test/test_helper.rb
+- views/exception_handling/mailer/escalation_notification.html.erb
+- views/exception_handling/mailer/exception_notification.html.erb
+- views/exception_handling/mailer/log_parser_exception_notification.html.erb
+has_rdoc: true
+homepage: https://github.com/RingRevenue/exception_handling
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: RingRevenue's exception handling logger/emailer layer, based on exception_notifier. Works with Rails or EventMachine or EventMachine+Synchrony.
+test_files: 
+- test/exception_handling_test.rb
+- test/mocha_patch.rb
+- test/test_helper.rb