whoops_rails_notifier 0.0.1

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,3 @@
+= WhoopsRailsNotifier
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,25 @@
+# encoding: UTF-8
+require 'rubygems'
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rake'
+require 'rake/rdoctask'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'WhoopsRailsNotifier'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/whoops_rails_notifier.rb

@@ -0,0 +1,24 @@
+require "digest"
+require "whoops_notifier"
+require "whoops_rails_notifier/action_controller_catcher"
+require "whoops_rails_notifier/controller_methods"
+require "whoops_rails_notifier/exception_strategy"
+require "whoops_rails_notifier/rack"
+require "whoops_rails_notifier/railtie"
+
+module WhoopsRailsNotifier
+  def self.initialize
+    configure
+    create_exception_strategy
+  end
+  
+  def self.configure
+    config = YAML.load_file(File.join(Rails.root, "config", "whoops.yml"))[Rails.env]
+    WhoopsNotifier.config.set(config)
+    WhoopsNotifier.config.logger = Rails.logger
+  end
+  
+  def self.create_exception_strategy
+    strategy = WhoopsRailsNotifier::ExceptionStrategy.new(:rails_exception)
+  end  
+end

data/lib/whoops_rails_notifier/action_controller_catcher.rb

@@ -0,0 +1,19 @@
+module WhoopsRailsNotifier
+  module ActionControllerCatcher
+    # Sets up an alias chain to catch exceptions when Rails does
+    def self.included(base) #:nodoc:
+      # base.send(:alias_method, :rescue_action_in_public_without_whoops, :rescue_action_in_public)
+      # base.send(:alias_method, :rescue_action_in_public, :rescue_action_in_public_with_whoops)
+    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_whoops(exception)        
+      evidence = {:exception => exception}.merge(whoops_request_data)
+       WhoopsRailsNotifier.notify(evidence)
+      rescue_action_in_public_without_whoops(exception)
+    end
+  end
+end

data/lib/whoops_rails_notifier/controller_methods.rb

@@ -0,0 +1,50 @@
+module WhoopsRailsNotifier
+  module ControllerMethods
+    private
+
+    # This method should be used for sending manual notifications while you are still
+    # inside the controller. Otherwise it works like WhoopsNotifierRails.notify.
+    def notify_whoops(exception)
+      evidence = {:exception => exception}.merge(whoops_request_data)
+      WhoopsRailsNotifier.notify(:rails, evidence)
+    end
+
+    def whoops_request_data
+      { :parameters       => whoops_filter_if_filtering(params.to_hash),
+        :session_data     => whoops_filter_if_filtering(whoops_session_data),
+        :controller       => params[:controller],
+        :action           => params[:action],
+        :url              => whoops_request_url,
+        :cgi_data         => whoops_filter_if_filtering(request.env) }
+    end
+
+    def whoops_filter_if_filtering(hash)
+      return hash if ! hash.is_a?(Hash)
+
+      if respond_to?(:filter_parameters)
+        filter_parameters(hash) rescue hash
+      else
+        hash
+      end
+    end
+
+    def whoops_session_data
+      if session.respond_to?(:to_hash)
+        session.to_hash
+      else
+        session.data
+      end
+    end
+
+    def whoops_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/whoops_rails_notifier/evidence.rb

@@ -0,0 +1,29 @@
+module WhoopsRailsNotifier
+  class Evidence
+    attr_accessor :exception
+    attr_accessor :url
+    
+    def initialize(exception, rack)
+      self.exception    = exception
+      self.rack         = rack
+      self.url          = args[:url] || rack_env(:url)
+
+      self.parameters          = args[:parameters] ||
+                                   action_dispatch_params ||
+                                   rack_env(:params) ||
+                                   {}
+      self.component           = args[:component] || args[:controller] || parameters['controller']
+      self.action              = args[:action] || parameters['action']
+
+      self.environment_name = args[:environment_name]
+      self.cgi_data         = args[:cgi_data] || args[:rack_env]
+      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|
+    end
+    
+    def action_dispatch_params
+      rack[:rack_env]['action_dispatch.request.parameters'] if rack
+    end
+  end
+end

data/lib/whoops_rails_notifier/exception_strategy.rb

@@ -0,0 +1,38 @@
+module WhoopsRailsNotifier
+  class ExceptionStrategy < WhoopsNotifier::Strategy
+    attr_accessor :service, :environment
+    def initialize(strategy_name)
+      super
+      
+      self.service     = ::Rails.application.class.name.split("::").first.downcase
+      self.environment = ::Rails.env
+      
+      add_report_modifiers
+    end
+    
+    def add_report_modifiers
+      self.add_report_modifier(:basic_details) do |report, evidence|
+        report.service     = self.service
+        report.environment = self.environment
+        report.event_type  = "exception"
+        report.message     = evidence[:exception].message
+        report.event_time  = Time.now
+      end
+      
+      self.add_report_modifier(:details) do |report, evidence|
+        exception = evidence[:exception]
+        rack_env  = evidence[:rack_env]
+        
+        details = {}
+        details[:backtrace] = exception.backtrace.collect{|l| l.sub(/^#{ENV['GEM_HOME']}/, '%GEM_HOME').sub(/^#{Rails.root}/, '%Rails.root')}
+        report.details      = details
+      end
+
+      self.add_report_modifier(:create_event_group_identifier) do |report, evidence|
+        identifier = "#{evidence[:controller]}##{evidence[:action]}"
+        identifier << evidence[:exception].backtrace.collect{|l| l.sub(Rails.root, "")}.join("\n")
+        report.event_group_identifier = Digest::MD5.hexdigest(identifier)
+      end
+    end
+  end
+end

data/lib/whoops_rails_notifier/rack.rb

@@ -0,0 +1,45 @@
+module WhoopsRailsNotifier
+  # Middleware for Rack applications. Any errors raised by the upstream
+  # application will be delivered to Hoptoad and re-raised.
+  #
+  # Synopsis:
+  #
+  #   require 'rack'
+  #   require 'hoptoad_notifier'
+  #
+  #   HoptoadNotifier.configure do |config|
+  #     config.api_key = 'my_api_key'
+  #   end
+  #
+  #   app = Rack::Builder.app do
+  #     use HoptoadNotifier::Rack
+  #     run lambda { |env| raise "Rack down" }
+  #   end
+  #
+  # Use a standard HoptoadNotifier.configure call to configure your api key.
+  class Rack
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      begin
+        response = @app.call(env)
+      rescue Exception => raised
+        evidence = {
+          :exception => raised,
+          :rack_env  => env
+        }
+        WhoopsNotifier.notify(:rails_exception, evidence)
+        raise
+      end
+
+      # if env['rack.exception']
+      #   WhoopsRailsNotifier.notify_or_ignore(env['rack.exception'], :rack_env => env)
+      #   env['hoptoad.error_id'] = error_id
+      # end
+
+      response
+    end
+  end
+end

data/lib/whoops_rails_notifier/railtie.rb

@@ -0,0 +1,11 @@
+module WhoopsRailsNotifier
+  class Railtie < Rails::Railtie
+    # config.app_middleware.insert_after "ActionDispatch::Callbacks"
+    config.app_middleware.use WhoopsRailsNotifier::Rack
+    
+    config.after_initialize do
+      WhoopsRailsNotifier.initialize
+      ::ActionController::Base.send(:include, WhoopsRailsNotifier::ControllerMethods)
+    end
+  end
+end

metadata

@@ -0,0 +1,194 @@
+--- !ruby/object:Gem::Specification 
+name: whoops_rails_notifier
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Daniel Higginbotham
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-11 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: whoops_notifier
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 0
+        - 0
+        - 3
+        version: 0.0.3
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 3
+        version: "3"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 49
+        segments: 
+        - 0
+        - 8
+        - 7
+        version: 0.8.7
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec-rails
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: ruby-debug
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: capybara
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 0
+        - 4
+        - 0
+        version: 0.4.0
+  type: :development
+  version_requirements: *id008
+description: A Whoops Notifier for Rails 3 apps.
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/whoops_rails_notifier/action_controller_catcher.rb
+- lib/whoops_rails_notifier/controller_methods.rb
+- lib/whoops_rails_notifier/evidence.rb
+- lib/whoops_rails_notifier/exception_strategy.rb
+- lib/whoops_rails_notifier/rack.rb
+- lib/whoops_rails_notifier/railtie.rb
+- lib/whoops_rails_notifier.rb
+- MIT-LICENSE
+- Rakefile
+- Gemfile
+- README.rdoc
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A Whoops Notifier for Rails 3 apps.
+test_files: []
+