exceptiontrap 0.0.1.alpha

data/.gitignore

@@ -0,0 +1,2 @@
+pkg
+*.DS_Store

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in exceptiontrap_notifier.gemspec
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 [Torsten Bühl]
+
+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.md

@@ -0,0 +1,71 @@
+# Exceptiontrap
+
+This gem is used to report your Ruby on Rails applications exceptions to the [Exceptiontrap](https://alpha.exceptiontrap.com) webservice.
+
+The gem is compatible with the following Rails versions
+
+- >= 2.3
+- >= 3
+
+**This is an Alpha Release**
+
+## Setup
+
+### Rails 3
+
+#### 1. Install
+
+Install the Exceptiontrap gem by putting this line to your `Gemfile`
+
+    gem 'exceptiontrap'
+
+then run `bundle`
+
+#### 2. Configure
+
+Now generate the `config/exceptiontrap.yml` file with
+
+    rails generate exceptiontrap --api-key YOUR_API_KEY
+
+and you should be fine.
+
+### Rails 2.3
+
+#### 1a. Install (with Bundler)
+
+Install the Exceptiontrap gem by putting this line to your `Gemfile`
+
+    gem 'exceptiontrap'
+
+then run `bundle`
+
+#### 1b. Install (without Bundler)
+
+Install the Exceptiontrap gem by putting this line to your `config/environment.rb` file
+
+    config.gem 'exceptiontrap'
+
+then run `rake gems:install`
+
+#### 2. Configure
+
+Now generate the `config/exceptiontrap.yml` file with
+
+    script/generate exceptiontrap --api-key YOUR_API_KEY
+
+and you should be fine.
+
+## Information / Further Configuration
+
+You can find your API-Key by login to your [Exceptiontrap Account](https://alpha.exceptiontrap.com/login), select the application and follow the `Setup` Link.
+
+## Known Issues / Todo
+
+At the moment ActionController::RoutingError's are not catched in Rails 3 applications.
+
+SSL-Support is not included.
+
+Optimize and insert the test suite to the gem.
+
+
+Copyright (c) 2012 [Torsten Bühl], released under the MIT license

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/exceptiontrap.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "exceptiontrap/version"
+
+Gem::Specification.new do |s|
+  s.name        = "exceptiontrap"
+  s.version     = Exceptiontrap::VERSION
+  s.authors     = ["tbuehl"]
+  s.email       = ["tbuehl@itm-labs.de"]
+  s.homepage    = "http://exceptiontrap.com"
+  s.summary     = %q{Used to report your apps exceptions to the exceptiontrap webservice}
+  s.description = %q{The gem catches your applications exceptionts and sends those to the exceptiontrap webservice}
+
+  s.rubyforge_project = "exceptiontrap"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/generators/exceptiontrap/USAGE

@@ -0,0 +1,11 @@
+Description:
+  Run this generator to create the Exceptiontrap config file
+
+Example:
+  Rails 2
+    ./script/generate exceptiontrap --api-key YOUR_API_KEY
+  Rails 3
+    rails generate exceptiontrap --api-key YOUR_API_KEY
+
+  This will create:
+    The Exceptiontrap config file in your applications config directory

data/generators/exceptiontrap/exceptiontrap_generator.rb

@@ -0,0 +1,21 @@
+class ExceptiontrapGenerator < Rails::Generator::Base
+  def add_options!(opt)
+    opt.on('-k', '--api-key=key', String, "Your Exceptiontrap API key") {|v| options[:api_key] = v}
+  end
+
+  def manifest
+    if !options[:api_key]
+      puts "You have to pass --api-key or create config/exceptiontrap.yml manually"
+      exit
+    end
+
+    record do |m|
+      m.template 'exceptiontrap.yml', 'config/exceptiontrap.yml', :assigns => {:api_key => api_key}
+    end
+  end
+
+  def api_key
+  	return "#{options[:api_key]}"
+  end
+
+end

data/generators/exceptiontrap/templates/exceptiontrap.yml

@@ -0,0 +1,15 @@
+# Exceptiontrap Config File
+api-key: <%= api_key %>
+ssl: false
+timeout: 5000
+enabledEnvironments:
+  - 'production'
+ignoreExceptions:
+  - 'ActiveRecord::RecordNotFound'
+  - 'ActionController::RoutingError'
+  - 'ActionController::InvalidAuthenticityToken'
+  - 'CGI::Session::CookieStore::TamperedWithCookie'
+  - 'ActionController::UnknownAction'
+filterParams:
+  - 'password'
+  - 's3-key'

data/init.rb

@@ -0,0 +1,9 @@
+# Include hook code here
+require 'exceptiontrap'
+
+begin
+  # puts "-- Exceptiontrap is active --"
+rescue => e
+  STDERR.puts "Problem starting Exceptiontrap Plugin. Your app will run as normal."
+  STDERR.puts e
+end

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/exceptiontrap/catcher.rb

@@ -0,0 +1,35 @@
+module Exceptiontrap
+  module Catcher
+    def self.included(base)
+      # Uses the public rescue method
+      base.send(:alias_method, :original_rescue_action_in_public, :rescue_action_in_public)
+      base.send(:alias_method, :rescue_action_in_public, :rescue_action_public_exceptiontrap)
+
+      # Uses the local rescue method
+      base.send(:alias_method, :original_rescue_action_locally, :rescue_action)
+      base.send(:alias_method, :rescue_action, :rescue_action_local_exceptiontrap)
+    end
+
+    private
+    # When the exception occured in public
+    def rescue_action_public_exceptiontrap(exception)
+      handle_with_exceptiontrap(exception)
+      original_rescue_action_in_public(exception) # to rails again
+    end
+
+    # When the exception occured locally
+    def rescue_action_local_exceptiontrap(exception)
+      handle_with_exceptiontrap(exception)
+      original_rescue_action_locally(exception) # to rails again
+    end
+
+    # Sends the exception to exceptiontrap
+    def handle_with_exceptiontrap(exception)
+      # puts "DEBUG: Raised Exceptiontrap::Catcher::Exception"
+      data = Exceptiontrap::Data.rails2_data(exception, request, session, response)
+      Exceptiontrap::Notifier.notify(data)
+    end
+
+  end
+
+end

data/lib/exceptiontrap/config.rb

@@ -0,0 +1,74 @@
+module Exceptiontrap
+  class Config
+    class << self
+      DEFAULTS = {
+        :ssl => false,
+        :disabled_by_default => %w(development test)
+      }
+
+      attr_accessor :api_key, :enabled, :ssl
+
+      def load(config_file=nil)
+        if (config_file && File.file?(config_file))
+          begin
+            config = YAML::load(File.open(config_file))
+            env_config = config[application_environment] || {}
+
+            @api_key = config['api-key'] || env_config['api-key']
+            @ssl = config['ssl'] || env_config['ssl']
+            @ignoreExceptions = config['ignoreExceptions']
+            @filterParams = config['filterParams']
+            @enabledEnvironments = config['enabledEnvironments']
+          rescue Exception => e
+            raise ConfigException.new("Unable to load configuration #{config_file} for environment #{application_environment} : #{e.message}")
+          end
+        end
+      end
+
+      def api_key
+        return @api_key unless @api_key.nil?
+      end
+
+      def enabled_environments
+        @enabledEnvironments ||= [""]
+      end
+
+      def ignored_exceptions
+        @ignoreExceptions ||= [""]
+      end
+
+      def filtered_params
+        @filterParams || nil
+      end
+
+      def application_environment
+        ENV['RACK_ENV'] || ENV['RAILS_ENV'] || 'development'
+      end
+
+      def should_send_to_api?
+        @enabled ||= DEFAULTS[:disabled_by_default].include?(application_environment) ? false : true
+      end
+
+      def application_root
+        defined?(Rails.root) ? Rails.root : Dir.pwd
+      end
+
+      def ssl?
+        @ssl ||= DEFAULTS[:ssl]
+      end
+
+      def remote_host
+        @remote_host ||= DEFAULTS[:remote_host_http]
+      end
+
+      def remote_port
+        @remote_port ||= ssl? ? 443 : 80
+      end
+
+      def reset
+        @enabled = @ssl = @api_key = nil
+      end
+
+    end
+  end
+end

data/lib/exceptiontrap/data.rb

@@ -0,0 +1,131 @@
+module Exceptiontrap
+  class Data
+    class << self
+      # TODO: Remove the duplication
+      # Creates Notification Data for action controller requests (Rails 2)
+      def rails2_data(exception, request, session, response)
+        data = {
+          'notifier' => NOTIFIER_NAME,
+          'api-key' => Config.api_key,
+          'name' => exception.class.name,
+          'message' => exception.message,
+          'root' => application_root,
+          'app-environment' => application_environment,
+          'request-uri' => request.url || REQUEST_URI,
+          'request-params' => clean_params(request.params),
+          'request-session' => clean_params(extrap_session_data(session)),
+          'environment' => clean_params(request.env),
+          'trace' => clean_backtrace(exception).join("\n"),
+          'request-components' => { :controller => request.params[:controller], :action => request.params[:action] }
+        }
+      end
+
+      # Creates Notification Data for rack requests (Rails 3)
+      def rack_data(exception, env)
+        components = { }
+        if env["action_dispatch.request.parameters"] != nil
+          components[:controller] = env["action_dispatch.request.parameters"][:controller] || nil
+          components[:action] = env["action_dispatch.request.parameters"][:action] || nil
+          components[:module] = env["action_dispatch.request.parameters"][:module] || nil
+        end
+
+        data = {
+          'notifier' => NOTIFIER_NAME,
+          'api-key' => Config.api_key,
+          'name' => exception.class.name,
+          'message' => exception.message,
+          'root' => application_root,
+          'app-environment' => application_environment,
+          'request-uri' => env["REQUEST_URI"],
+          'request-params' => clean_params(env["action_dispatch.request.parameters"]),
+          'request-session' => clean_params(extrap_session_data(env["rack.session"])),
+          'environment' => clean_params(env),
+          'trace' => clean_backtrace(exception).join("\n"),
+          'request-components' => components
+        }
+      end
+
+      ### Cleanup
+      def clean_params(params)
+        return if params == nil
+
+        params = normalize_data(params)
+        params = filter_params(params)
+        params
+      end
+
+      # Deletes params from env / set in config file
+      def remove_params
+        remove_params = ["rack.request.form_hash", "rack.request.form_vars", "rack.request.form_hash"]
+      end
+
+      # Trims first underscore from keys, to prevent "malformed" rails XML-tags
+      def normalize_data(hash)
+        new_hash = {}
+
+        # TODO: Do this nicer
+        hash.each do |key, value|
+          key_s = key.to_s.dup
+          key_s.sub!("_", "") if key_s[0].chr == "_"
+          key_s.sub!("_", "") if key_s[0].chr == "_"
+
+          if value.respond_to?(:to_hash) # if hash, normalize these too
+            new_hash[key_s] = normalize_data(value.to_hash)
+          else
+            new_hash[key_s] = value.to_s
+          end
+        end
+
+        new_hash
+      end
+
+      # Replaces parameter values with a string / set in config file
+      def filter_params(params)
+        if Config.filtered_params
+          params.each do |key, value|
+            if filter_key?(key)
+              params[key] = "[FILTERED]"
+            elsif value.respond_to?(:to_hash)
+              filter_params(params[key])
+            end
+          end
+        end
+        params
+      end
+
+      # Check, if a key should be filtered
+      def filter_key?(key)
+        Config.filtered_params.any? do |filter|
+          key.to_s.include?(filter.to_s)
+        end
+      end
+
+      ### Getter
+      def extrap_session_data(session)
+        return if session == nil
+        if session.respond_to?(:to_hash)
+          session.to_hash
+        else
+          session.data
+        end
+      end
+
+      def application_environment
+        ENV['RACK_ENV'] || ENV['RAILS_ENV'] || 'development'
+      end
+
+      def application_root
+        defined?(Rails.root) ? Rails.root : Dir.pwd
+      end
+
+      def clean_backtrace(exception)
+        if Rails.respond_to?(:backtrace_cleaner)
+          Rails.backtrace_cleaner.send(:filter, exception.backtrace)
+        else
+          exception.backtrace
+        end
+      end
+
+    end
+  end
+end

data/lib/exceptiontrap/notifier.rb

@@ -0,0 +1,34 @@
+module Exceptiontrap
+  class Notifier
+    class << self
+      def notify(data)
+        puts "DEBUG: Notify Exception"
+
+        @data = data
+        xml_data = data.to_xml({:root => 'problem', :skip_types => true}).to_s
+        send_problem(xml_data) if !ignore_exception?
+      end
+
+      def send_problem(xml_data)
+        puts "DEBUG: Send Exception"
+
+        url = URI.parse(NOTIFICATION_URL)
+        http = Net::HTTP.new(url.host, url.port)
+
+        response = begin
+          http.post(url.path, xml_data, HEADERS)
+        rescue TimeoutError => e
+          puts "ERROR: Timeout while contacting Exceptiontrap."
+          nil
+        rescue Exception => e
+          puts "ERROR: Error on sending: #{e.class} - #{e.message}"
+        end
+      end
+
+      def ignore_exception?
+        Config.ignored_exceptions.include?(@data['name'])
+      end
+
+    end
+  end
+end

data/lib/exceptiontrap/rack.rb

@@ -0,0 +1,22 @@
+module Exceptiontrap
+  class Rack
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      begin
+        puts "DEBUG: Begin Exceptiontrap::Rack"
+        response = @app.call(env)
+      rescue Exception => raised
+        puts "DEBUG: Raised Exceptiontrap::Rack::Exception"
+        data = Exceptiontrap::Data.rack_data(raised, env)
+        Exceptiontrap::Notifier.notify(data)
+        raise
+      end
+
+      response
+    end
+
+  end
+end

data/lib/exceptiontrap/railtie.rb

@@ -0,0 +1,15 @@
+require 'exceptiontrap'
+require 'exceptiontrap/data'
+require 'rails'
+
+module Exceptiontrap
+  class ExceptiontrapRailtie < Rails::Railtie
+    initializer "exceptiontrap.middleware" do |app|
+      Exceptiontrap::Config.load(File.join(Rails.root, "/config/exceptiontrap.yml"))
+      if Config.enabled_environments.include?(Exceptiontrap::Data.application_environment)
+        # puts "-> Activated Exceptiontrap::Rack for Rails 3 (Railtie)"
+        app.config.middleware.insert_after 'ActionDispatch::ShowExceptions', 'Exceptiontrap::Rack'
+      end
+    end
+  end
+end

data/lib/exceptiontrap/version.rb

@@ -0,0 +1,3 @@
+module Exceptiontrap
+  VERSION = "0.0.1.alpha"
+end

data/lib/exceptiontrap.rb

@@ -0,0 +1,38 @@
+require 'net/http'
+require 'net/https'
+require 'uri'
+
+require "exceptiontrap/version"
+require "exceptiontrap/config"
+require 'exceptiontrap/notifier'
+require 'exceptiontrap/rack'
+
+# Use Rack Middleware for Rails 3
+require 'exceptiontrap/railtie' if defined?(Rails::Railtie)
+
+# Exceptiontrap
+module Exceptiontrap
+  API_VERSION = "0.1"
+  NOTIFIER_NAME = "exceptiontrap-rails"
+  # NOTIFICATION_URL = "http://localhost:3000/problems"
+  NOTIFICATION_URL = "http://alpha.exceptiontrap.com/problems"
+
+  HEADERS = {
+    'Content-type' => 'text/xml',
+    'Accept' => 'text/xml, application/xml'
+  }
+
+  # Load for Rails 2.3 (Rack and Exceptiontrap::Catcher)
+  if !defined?(Rails::Railtie) && defined?(Rails.configuration) && Rails.configuration.respond_to?(:middleware)
+    Exceptiontrap::Config.load(File.join(Rails.root, "/config/exceptiontrap.yml"))
+
+    if Config.enabled_environments.include?(Exceptiontrap::Data.application_environment)
+      if defined?(ActionController::Base) && !ActionController::Base.include?(Exceptiontrap::Catcher)
+        ActionController::Base.send(:include, Exceptiontrap::Catcher) # puts "-> Activated Exceptiontrap::Catcher for Rails 2"
+      end
+
+      Rails.configuration.middleware.use 'Exceptiontrap::Rack' # puts "-> Activated Exceptiontrap::Rack for Rails 2.3+"
+    end
+  end
+
+end

data/lib/generators/exceptiontrap/exceptiontrap_generator.rb

@@ -0,0 +1,28 @@
+require 'rails/generators'
+
+class ExceptiontrapGenerator < Rails::Generators::Base
+  desc "Run this generator to create the Exceptiontrap config file"
+  
+  class_option :api_key, :aliases => "-k", :type => :string, :desc => "Your Exceptiontrap API key"
+  
+  def self.source_root
+    @source_root ||= File.join(File.dirname(__FILE__), 'templates')
+  end
+  
+  def install
+    if !options[:api_key]
+      puts "You have to pass --api-key or create config/exceptiontrap.yml manually"
+      exit
+    end
+    #copy_config
+  end
+  
+  def api_key
+  	s = "#{options[:api_key]}"
+  end
+  
+  def copy_config
+    puts "Copying config file to your app"
+    template 'exceptiontrap.yml', 'config/exceptiontrap.yml'
+  end
+end

data/lib/generators/exceptiontrap/templates/exceptiontrap.yml

@@ -0,0 +1,15 @@
+# Exceptiontrap Config File
+api-key: <%= api_key %>
+ssl: false
+timeout: 5000
+enabledEnvironments:
+  - 'production'
+ignoreExceptions:
+  - 'ActiveRecord::RecordNotFound'
+  - 'ActionController::RoutingError'
+  - 'ActionController::InvalidAuthenticityToken'
+  - 'CGI::Session::CookieStore::TamperedWithCookie'
+  - 'ActionController::UnknownAction'
+filterParams:
+  - 'password'
+  - 's3-key'

data/rails/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__) , '../init.rb')

data/tasks/exceptiontrap_tasks.rake

@@ -0,0 +1,4 @@
+desc "Install Exceptiontrap"
+task :exceptiontrap do
+  puts "Copy Config File to your application"
+end

data/test/exceptiontrap_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class ExceptiontrapTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification 
+name: exceptiontrap
+version: !ruby/object:Gem::Version 
+  hash: 296151482
+  prerelease: 6
+  segments: 
+  - 0
+  - 0
+  - 1
+  - alpha
+  version: 0.0.1.alpha
+platform: ruby
+authors: 
+- tbuehl
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-01-04 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: The gem catches your applications exceptionts and sends those to the exceptiontrap webservice
+email: 
+- tbuehl@itm-labs.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- exceptiontrap.gemspec
+- generators/exceptiontrap/USAGE
+- generators/exceptiontrap/exceptiontrap_generator.rb
+- generators/exceptiontrap/templates/exceptiontrap.yml
+- init.rb
+- install.rb
+- lib/exceptiontrap.rb
+- lib/exceptiontrap/catcher.rb
+- lib/exceptiontrap/config.rb
+- lib/exceptiontrap/data.rb
+- lib/exceptiontrap/notifier.rb
+- lib/exceptiontrap/rack.rb
+- lib/exceptiontrap/railtie.rb
+- lib/exceptiontrap/version.rb
+- lib/generators/exceptiontrap/exceptiontrap_generator.rb
+- lib/generators/exceptiontrap/templates/exceptiontrap.yml
+- rails/init.rb
+- tasks/exceptiontrap_tasks.rake
+- test/exceptiontrap_test.rb
+- test/test_helper.rb
+- uninstall.rb
+has_rdoc: true
+homepage: http://exceptiontrap.com
+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: 25
+      segments: 
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
+requirements: []
+
+rubyforge_project: exceptiontrap
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Used to report your apps exceptions to the exceptiontrap webservice
+test_files: 
+- test/exceptiontrap_test.rb
+- test/test_helper.rb