mrhenry-failtale-reporter 0.0.1

data/README.textile

@@ -0,0 +1,24 @@
+h2. LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Mr. Henry
+
+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/lib/failtale-reporter.rb

@@ -0,0 +1,2 @@
+
+require File.dirname(__FILE__)+'/failtale_reporter'

data/lib/failtale_reporter.rb

@@ -0,0 +1,62 @@
+
+begin
+  require 'digest/sha1'
+  require 'httparty'
+rescue LoadError
+  retry if require 'rubygems'
+end
+
+require File.dirname(__FILE__)+'/failtale_reporter/error'
+
+module ErrorReporter
+  
+  include HTTParty
+  
+  base_uri 'errors.be'
+  format :xml
+  
+  def self.load_adapter(name)
+    require File.dirname(__FILE__)+"/failtale_reporter/adapters/#{name}"
+  end
+  
+  class << self
+    def reportable_exceptions(*arr)
+      arr = [Exception] if arr.empty?
+      @reportable_exceptions ||= arr.flatten
+    end
+    def ignored_exceptions(*arr)
+      @ignored_exceptions ||= arr.flatten
+    end
+    def api_token(token=nil)
+      @api_token ||= token
+    end
+    def configure
+      yield self
+    end
+  end
+  
+  def self.report(error=nil)
+    error = handle_exception(error)
+    yield if block_given? and error.nil?
+  rescue Exception => exception
+    error = handle_exception(exception)
+  ensure
+    post_report(error) unless error.nil?
+    raise exception unless exception.nil?
+  end
+  
+  def self.handle_exception(exception)
+    return exception if exception.nil?
+    return exception if exception.is_a? ErrorReporter::Error
+    return nil unless reportable_exceptions.any? {|c| exception.is_a? c }
+    return nil if     ignored_exceptions.any?    {|c| exception.is_a? c }
+    Error.new(exception)
+  end
+  
+  def self.post_report(error)
+    params = error.to_param
+    params[:report][:project] = { :api_token => api_token }
+    self.post('/reports.xml', :body => params)
+  end
+  
+end

data/lib/failtale_reporter/adapters/rails.rb

@@ -0,0 +1,31 @@
+
+module ErrorReporter
+  module Adapters
+    
+    module Rails
+      
+      IGNORED_EXCEPTIONS = [ActiveRecord::RecordNotFound,
+                            ActionController::RoutingError,
+                            ActionController::InvalidAuthenticityToken,
+                            CGI::Session::CookieStore::TamperedWithCookie]
+      
+      def self.included(target)
+        target.send :alias_method_chain, :rescue_action_in_public, :errors
+        
+        ErrorReporter.configure do |config|
+          config.ignored_exceptions IGNORED_EXCEPTIONS
+        end
+      end
+      
+      def rescue_action_in_public_with_errors(exception)
+        is_private = ::Rails.env.development? or ::Rails.env.test?
+        ErrorReporter.report(exception) unless is_private
+        rescue_action_in_public_without_errors(exception)
+      end
+      
+    end
+    
+  end
+end
+
+::ActionController::Base.send :include, ErrorReporter::Adapters::Rails

data/lib/failtale_reporter/error.rb

@@ -0,0 +1,36 @@
+
+module ErrorReporter
+  class Error
+    
+    attr_accessor :hash_string
+    attr_accessor :name
+    attr_accessor :description
+    attr_accessor :properties
+    attr_accessor :backtrace
+    attr_accessor :environment
+    
+    def initialize(exception)
+      self.name = "#{exception.class} #{exception.message}"
+      self.description = exception.message
+      self.backtrace = exception.backtrace.join("\n")
+      self.environment = { :application => $0 }
+      self.hash_string = Digest::SHA1.hexdigest(
+        [exception.class, exception.message, exception.backtrace.first].join('--')
+      )
+    end
+    
+    def to_param
+      { :report =>
+        { :error => {
+          :hash_string => self.hash_string
+        },:occurence => {
+          :name => self.name,
+          :description => self.description,
+          :backtrace => self.backtrace,
+          :properties => self.environment
+        } }
+      }
+    end
+    
+  end
+end

data/lib/mrhenry-failtale-reporter.rb

@@ -0,0 +1,2 @@
+
+require File.dirname(__FILE__)+'/failtale_reporter'

data/rails/init.rb

@@ -0,0 +1,2 @@
+
+::ErrorReporter.load_adapter('rails')

data/spec/error_reporter_spec.rb

@@ -0,0 +1,33 @@
+
+describe "ErrorReporter" do
+  
+  it "should send error reports" do
+    ErrorReporter.should_receive(:post).with('/reports.xml', an_instance_of(Hash))
+    lambda do
+      ErrorReporter.report do
+        raise "hello"
+      end
+    end.should raise_error(RuntimeError, "hello")
+  end
+  
+  it "should send error reports for selected exceptions" do
+    ErrorReporter.should_receive(:post).with('/reports.xml', an_instance_of(Hash))
+    ErrorReporter.reportable_exceptions ArgumentError
+    lambda do
+      ErrorReporter.report do
+        raise ArgumentError, "hello"
+      end
+    end.should raise_error(ArgumentError, "hello")
+  end
+  
+  it "should not send error reports for non-selected exceptions" do
+    ErrorReporter.should_not_receive(:post)
+    ErrorReporter.reportable_exceptions ArgumentError
+    lambda do
+      ErrorReporter.report do
+        raise RuntimeError, "hello"
+      end
+    end.should raise_error(RuntimeError, "hello")
+  end
+  
+end

data/spec/error_spec.rb

@@ -0,0 +1,22 @@
+
+require File.dirname(__FILE__)+'/../lib/failtale_reporter'
+
+describe "ErrorReporter::Error" do
+  
+  describe "#to_param" do
+    
+    it "should generate valid data" do
+      begin
+        raise "hello"
+      rescue Exception => exception
+        error = ErrorReporter::Error.new(exception)
+        
+        error.backtrace.should   be_eql(exception.backtrace.join("\n"))
+        error.description.should be_eql(exception.message)
+        error.name.should        be_eql("#{exception.class} raised at #{exception.backtrace.first}")
+      end
+    end
+    
+  end
+  
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: mrhenry-failtale-reporter
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Simon Menke
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-30 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.2.6
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.2.6
+    version: 
+description: 
+email: simon.menke@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- rails/init.rb
+- spec/error_reporter_spec.rb
+- spec/error_spec.rb
+- README.textile
+- lib/failtale-reporter.rb
+- lib/failtale_reporter/adapters/rails.rb
+- lib/failtale_reporter/error.rb
+- lib/failtale_reporter.rb
+- lib/mrhenry-failtale-reporter.rb
+has_rdoc: false
+homepage: http://github.com/mrhenry
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: failtale-reporter
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A Ruby error reporter for our failtale service
+test_files: 
+- spec/error_reporter_spec.rb
+- spec/error_spec.rb
+- spec/error_reporter_spec.rb
+- spec/error_spec.rb