runtimeerror_notifier 0.0.10

data/CHANGELOG.md

@@ -0,0 +1 @@
+# Change Log

data/LICENSE

@@ -0,0 +1,34 @@
+All other components of this product are
+Copyright (c) 2013 Devels Advocates. All rights reserved
+
+Subject to the terms of this notice, Devels Advocates grants you a
+nonexclusive, nontransferable license, without the right to
+sublicense, to (a) install and execute one copy of these files on any
+number of workstations owned or controlled by you and (b) distribute
+verbatim copies of these files to third parties. As a condition to the
+foregoing grant, you must provide this notice along with each copy you
+distribute and you must not remove, alter, or obscure this notice. All
+other use, reproduction, modification, distribution, or other
+exploitation of these files is strictly prohibited, except as may be set
+forth in a separate written license agreement between you and Devels Advocates.
+The terms of any such license agreement will control over this
+notice. The license stated above will be automatically terminated and
+revoked if you exceed its scope or violate any of the terms of this
+notice.
+
+This License does not grant permission to use the trade names,
+trademarks, service marks, or product names of RuntimeError.net, except as
+required for reasonable and customary use in describing the origin of
+this file and reproducing the content of this notice. You may not
+mark or brand this file with any trade name, trademarks, service
+marks, or product names other than the original brand (if any)
+provided by Devels Advocates.
+
+Unless otherwise expressly agreed by Devels Advocates in a separate written
+license agreement, these files are provided AS IS, WITHOUT WARRANTY OF
+ANY KIND, including without any implied warranties of MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE, TITLE, or NON-INFRINGEMENT. As a
+condition to your use of these files, you are solely responsible for
+such use. Devels Advocates will have no liability to you for direct,
+indirect, consequential, incidental, special, or punitive damages or
+for lost profits or data.

data/README.md

@@ -0,0 +1,23 @@
+# RuntimeError.net
+
+This gem acts as the agent for [RuntimeError.net](http://runtimeerror.net). Install the gem for the agent to handle uncaught exceptions from your application.
+
+## Installation (Rails 3)
+
+**Step 1.** Add it as a gem in your __Gemfile__
+
+``` ruby
+gem 'runtimeerror_notifier', git: 'git://github.com/develsadvocates/exception_notification_http.git', branch: 'released-v0'
+```
+
+**Step 2.** Execute the following command to generate __config/initializers/runtimeerror_notifier.rb__
+
+``` sh
+RAILS_ENV=production rails generate runtimeerror_notifier:install
+```
+
+**Step 3.** Obtain a secret email address from [RuntimeError.net](http://runtimeerror.net) then set it as environment variable ``RUNTIMEERROR_EMAIL``
+
+## License
+
+© RuntimeError.net 2013. View LICENSE for details.

data/lib/generators/runtimeerror_notifier/install_generator.rb

@@ -0,0 +1,8 @@
+class RuntimeerrorNotifier::InstallGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+  desc 'Creates an initializer file for RuntimeError.net at config/initializers'
+
+  def install
+    template 'initializer.rb', 'config/initializers/runtimeerror_notifier.rb'
+  end
+end

data/lib/generators/runtimeerror_notifier/templates/initializer.rb

@@ -0,0 +1,10 @@
+if defined?(RuntimeerrorNotifier)
+  # Get your secret email address from RuntimeError.net and
+  # 1. Set it as environment variable RUNTIMEERROR_EMAIL (preferred method)
+  # 2. OR, change the value (legacy method)
+  RuntimeerrorNotifier.for ENV['RUNTIMEERROR_EMAIL']
+
+  RuntimeerrorNotifier::Notifier::IGNORED_EXCEPTIONS.push(*%w[
+    ActionController::RoutingError
+  ])
+end

data/lib/runtimeerror_notifier.rb

@@ -0,0 +1,40 @@
+require 'runtimeerror_notifier/notifier'
+
+module RuntimeerrorNotifier
+  def self.for(*emails)
+    RuntimeerrorNotifier::Notifier.for(*emails)
+    if defined?(::Rails)
+      ::Rails.application.config.middleware.insert 0, RuntimeerrorNotifier::Tracker
+    end
+    renderer_class = if defined?(::ActionDispatch::DebugExceptions)
+      ::ActionDispatch::DebugExceptions
+    elsif defined?(::ActionDispatch::ShowExceptions)
+      ::ActionDispatch::ShowExceptions
+    end
+    if renderer_class
+      renderer_class.class_eval do
+        def render_exception_with_runtimeerror_notifier(env, exception)
+          begin
+            RuntimeerrorNotifier::Notifier.notification(env, exception, {})
+          rescue Exception
+            # do nothing
+          end
+          render_exception_without_runtimeerror_notifier(env, exception)
+        end
+        alias_method_chain :render_exception, :runtimeerror_notifier
+      end
+    end
+  end
+  class Tracker
+    def initialize(app, options={})
+      @app, @options = app, options
+    end
+
+    def call(env)
+      @app.call(env)
+    rescue Exception => ex
+      RuntimeerrorNotifier::Notifier.notification(env, ex, @options)
+      raise ex
+    end
+  end
+end

data/lib/runtimeerror_notifier/missing_controller.rb

@@ -0,0 +1,3 @@
+class MissingController
+  def method_missing(*args, &block); end
+end

data/lib/runtimeerror_notifier/notifier.rb

@@ -0,0 +1,112 @@
+require 'action_dispatch'
+require 'action_mailer'
+require 'pp'
+require 'httparty'
+require File.join(File.dirname(__FILE__), 'missing_controller')
+
+module RuntimeerrorNotifier
+  class Notifier < ActionMailer::Base
+    API_ENDPOINT = ENV['RUNTIMEERROR_URL'] || 'http://runtimeerror.net/incoming_emails'
+    SENDER_ADDRESS = 'notifier@runtimeerror.net'
+    RECIPIENTS = []
+    SECTIONS = %w(request session environment backtrace)
+    TEMPLATE_NAME = 'runtimeerror_notifier'
+    IGNORED_EXCEPTIONS = []
+
+    self.mailer_name = 'runtimeerror_notifier'
+    self.append_view_path File.join(File.dirname(__FILE__), '..', '..', 'templates')
+
+    def self.for(*emails)
+      RECIPIENTS.push(*emails)
+      RECIPIENTS.uniq!
+    end
+
+    def notification(env, exception, options={})
+      original_exception = if exception.respond_to?(:original_exception)
+        exception.original_exception
+      elsif exception.respond_to?(:continued_exception)
+        exception.continued_exception
+      else
+        exception
+      end
+      case exception.class.name
+      when *IGNORED_EXCEPTIONS
+        # ignore
+      else
+        email = compose_email(env, original_exception, options)
+        make_request(email)
+      end
+    end
+
+    protected
+
+    def make_request(email)
+      HTTParty.post(API_ENDPOINT, body: {message: email.to_s})
+    end
+
+    def compose_email(env, exception, options)
+      @attr = exception_attributes(env, exception, options)
+      mail(:to => @attr[:recipients],
+           :from => @attr[:sender_address],
+           :subject => compose_subject(@attr),
+           :template_name => TEMPLATE_NAME) do |format|
+        format.html
+      end
+    end
+
+    def exception_attributes(env, exception, options={})
+      {
+        env: env,
+        exception: exception,
+        api_endpoint: options[:api_endpoint] || API_ENDPOINT,
+        kontroller: env['action_controller.instance'] || MissingController.new,
+        request: ActionDispatch::Request.new(env),
+        backtrace: exception.backtrace ? clean_backtrace(exception) : [],
+        recipients: options[:recipients] || RECIPIENTS,
+        sender_address: options[:sender_address] || SENDER_ADDRESS,
+        sections: SECTIONS
+      }
+    end
+
+    def compose_subject(attr)
+      subject = ''
+      subject << formatted_controller_name(attr[:kontroller])
+      subject << " (#{attr[:exception].class})"
+      subject << " #{attr[:exception].message.inspect}"
+      shorten_subject(subject)
+    end
+
+    def formatted_controller_name(kontroller)
+      if kontroller.present?
+        "#{kontroller.controller_name}##{kontroller.action_name}"
+      else
+        ''
+      end
+    end
+
+    def shorten_subject(subject)
+      subject
+    end
+
+    def clean_backtrace(exception)
+      if defined?(Rails) && Rails.respond_to?(:backtrace_cleaner)
+        Rails.backtrace_cleaner.send(:filter, exception.backtrace)
+      else
+        exception.backtrace
+      end
+    end
+
+    def inspect_object(object)
+      case object
+      when Hash, Array
+        object.inspect
+      when ActionController::Base
+        "#{object.controller_name}##{object.action_name}"
+      else
+        object.to_s
+      end
+    end
+    helper_method :inspect_object
+
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: runtimeerror_notifier
+version: !ruby/object:Gem::Version
+  version: 0.0.10
+  prerelease: 
+platform: ruby
+authors:
+- Wong Liang Zan
+- Chew Choon Keat
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &70134270137820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70134270137820
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70134270135820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+  type: :development
+  prerelease: false
+  version_requirements: *70134270135820
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: &70134270134180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.3.2
+  type: :development
+  prerelease: false
+  version_requirements: *70134270134180
+description: This gem installs the agent of RuntimeError.net to your application.
+  It handles uncaught exceptions from your application and tightly integrates exceptions
+  with your project management tool.
+email:
+- zan@liangzan.net
+- choonkeat@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/generators/runtimeerror_notifier/install_generator.rb
+- lib/generators/runtimeerror_notifier/templates/initializer.rb
+- lib/runtimeerror_notifier/missing_controller.rb
+- lib/runtimeerror_notifier/notifier.rb
+- lib/runtimeerror_notifier.rb
+- LICENSE
+- README.md
+- CHANGELOG.md
+homepage: https://github.com/develsadvocates/runtimeerror_notification
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Handles uncaught exceptions from your application and integrates tightly
+  with your project management tool.
+test_files: []