exceptiontrap 0.0.1.alpha → 0.0.2.alpha

data/Gemfile

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

data/exceptiontrap.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |s|
   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.summary     = %q{Exception notifier, used to report your apps exceptions to the exceptiontrap webservice}
+  s.description = %q{Exception notifier. The Gem catches your applications exceptions and sends those to the exceptiontrap webservice hosted at http://exceptiontrap.com}
 
   s.rubyforge_project = "exceptiontrap"
 

data/generators/exceptiontrap/exceptiontrap_generator.rb

@@ -15,7 +15,6 @@ class ExceptiontrapGenerator < Rails::Generator::Base
   end
 
   def api_key
-  	return "#{options[:api_key]}"
+    return "#{options[:api_key]}"
   end
-
-end
+end

data/generators/exceptiontrap/templates/exceptiontrap.yml

@@ -12,4 +12,5 @@ ignoreExceptions:
   - 'ActionController::UnknownAction'
 filterParams:
   - 'password'
+  - 'password_confirmation'
   - 's3-key'

data/lib/exceptiontrap/catcher.rb

@@ -29,7 +29,5 @@ module Exceptiontrap
       data = Exceptiontrap::Data.rails2_data(exception, request, session, response)
       Exceptiontrap::Notifier.notify(data)
     end
-
   end
-
 end

data/lib/exceptiontrap/config.rb

@@ -2,73 +2,48 @@ module Exceptiontrap
   class Config
     class << self
       DEFAULTS = {
-        :ssl => false,
-        :disabled_by_default => %w(development test)
+        :enabled_environments => %w(production),
+        :ignored_exceptions => %w(ActiveRecord::RecordNotFound ActionController::RoutingError),
+        :filtered_params => %w(password s3-key),
+        :ssl => false
       }
 
-      attr_accessor :api_key, :enabled, :ssl
-
-      def load(config_file=nil)
+      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']
+            @api_key = config['api-key']
+            @ssl = config['ssl']
+            @ignored_exceptions = config['ignoreExceptions']
+            @enabled_environments = config['enabledEnvironments']
+            @filtered_params = config['filterParams']
           rescue Exception => e
-            raise ConfigException.new("Unable to load configuration #{config_file} for environment #{application_environment} : #{e.message}")
+            raise ConfigException.new("Unable to load configuration #{config_file} : #{e.message}")
           end
         end
       end
 
       def api_key
-        return @api_key unless @api_key.nil?
+        @api_key
       end
 
       def enabled_environments
-        @enabledEnvironments ||= [""]
+        @enabled_environments ||= DEFAULTS[:enabled_environments]
       end
 
       def ignored_exceptions
-        @ignoreExceptions ||= [""]
+        @ignored_exceptions ||= DEFAULTS[:ignored_exceptions]
       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
+        @filtered_params ||= DEFAULTS[:filtered_params]
       end
 
-      def ssl?
+      def use_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

@@ -1,106 +1,93 @@
 module Exceptiontrap
   class Data
     class << self
-      # TODO: Remove the duplication
+      # TODO: Remove the duplication or separate classes
       # 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)),
+          'location' => location(exception),
+          'root' => application_root.to_s,
+          '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] }
+          'trace' => clean_backtrace(exception.backtrace),
+          '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 = { }
+        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
+          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"])),
+          'location' => location(exception),
+          'root' => application_root.to_s,
+          '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
+          'trace' => clean_backtrace(exception.backtrace),
+          'request_components' => components
         }
       end
 
-      ### Cleanup
+      # Cleanup data
       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
+      def clean_backtrace(backtrace)
+        if Rails.respond_to?(:backtrace_cleaner)
+          Rails.backtrace_cleaner.send(:filter, backtrace)
+        else
+          backtrace
         end
+      end
 
-        new_hash
+      # Deletes params from env / set in config file
+      def remove_params
+        remove_params = ['rack.request.form_hash', 'rack.request.form_vars']
       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
+        return params unless Config.filtered_params
+
+        params.each do |k, v|
+          if filter_key?(k)
+            params[k] = '[FILTERED]'
+          elsif v.respond_to?(:to_hash)
+            filter_params(params[k])
           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)
+          key.to_s == filter.to_s # key.to_s.include?(filter.to_s)
         end
       end
 
-      ### Getter
+      # Retrieve data
       def extrap_session_data(session)
         return if session == nil
         if session.respond_to?(:to_hash)
@@ -110,6 +97,10 @@ module Exceptiontrap
         end
       end
 
+      def location(exception)
+        #TODO: Implement
+      end
+
       def application_environment
         ENV['RACK_ENV'] || ENV['RAILS_ENV'] || 'development'
       end
@@ -118,12 +109,24 @@ module Exceptiontrap
         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
+      # 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] = normalize_data(value.to_hash)
+          else
+            new_hash[key] = value.to_s
+          end
         end
+
+        new_hash
       end
 
     end

data/lib/exceptiontrap/notifier.rb

@@ -2,33 +2,48 @@ module Exceptiontrap
   class Notifier
     class << self
       def notify(data)
-        puts "DEBUG: Notify Exception"
+        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?
+        serialized_data = { :problem => data }.to_json
+        send_problem(serialized_data) unless ignore_exception?
       end
 
-      def send_problem(xml_data)
-        puts "DEBUG: Send Exception"
+      def send_problem(serialized_data)
+        puts 'DEBUG: Send Exception'
 
-        url = URI.parse(NOTIFICATION_URL)
-        http = Net::HTTP.new(url.host, url.port)
+        url = URI.parse((Config.use_ssl? ? 'https://' : 'http://') << NOTIFICATION_URL)
+        client = prepare_client(url)
+
+        headers = HEADERS
+        headers['X-Api-Key'] = Config.api_key
 
         response = begin
-          http.post(url.path, xml_data, HEADERS)
+          client.post(url.path, serialized_data, headers)
         rescue TimeoutError => e
-          puts "ERROR: Timeout while contacting Exceptiontrap."
+          puts 'ERROR: Timeout while contacting Exceptiontrap.'
           nil
         rescue Exception => e
           puts "ERROR: Error on sending: #{e.class} - #{e.message}"
         end
       end
 
+      private
       def ignore_exception?
         Config.ignored_exceptions.include?(@data['name'])
       end
 
+      def prepare_client(url)
+        if Config.use_ssl?
+          client = Net::HTTP.new(url.host, url.port || 443)
+          client.use_ssl = true
+          client.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        else
+          client = Net::HTTP.new(url.host, url.port || 80)
+        end
+
+        client
+      end
     end
   end
 end

data/lib/exceptiontrap/rack.rb

@@ -6,10 +6,10 @@ module Exceptiontrap
 
     def call(env)
       begin
-        puts "DEBUG: Begin Exceptiontrap::Rack"
+        puts 'DEBUG: Begin Exceptiontrap::Rack'
         response = @app.call(env)
       rescue Exception => raised
-        puts "DEBUG: Raised Exceptiontrap::Rack::Exception"
+        puts 'DEBUG: Raised Exceptiontrap::Rack::Exception'
         data = Exceptiontrap::Data.rack_data(raised, env)
         Exceptiontrap::Notifier.notify(data)
         raise
@@ -19,4 +19,4 @@ module Exceptiontrap
     end
 
   end
-end
+end

data/lib/exceptiontrap/railtie.rb

@@ -4,12 +4,12 @@ require 'rails'
 
 module Exceptiontrap
   class ExceptiontrapRailtie < Rails::Railtie
-    initializer "exceptiontrap.middleware" do |app|
-      Exceptiontrap::Config.load(File.join(Rails.root, "/config/exceptiontrap.yml"))
+    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
+end

data/lib/exceptiontrap/version.rb

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

data/lib/exceptiontrap.rb

@@ -12,19 +12,19 @@ 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"
+  API_VERSION = '1'
+  NOTIFIER_NAME = 'exceptiontrap-rails'
+  NOTIFICATION_URL = 'alpha.exceptiontrap.com/notifier/api/v1/problems'
+  DEPLOYMENT_URL = 'alpha.exceptiontrap.com/notifier/api/v1/deployments'
 
   HEADERS = {
-    'Content-type' => 'text/xml',
-    'Accept' => 'text/xml, application/xml'
+    'Content-type' => 'application/json',
+    'Accept' => 'application/json'
   }
 
   # 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"))
+    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)

data/lib/generators/exceptiontrap/exceptiontrap_generator.rb

@@ -2,27 +2,27 @@ 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"
-  
+
+  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"
+      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]}"
+    s = "#{options[:api_key]}"
   end
-  
+
   def copy_config
-    puts "Copying config file to your app"
+    puts 'Copying config file to your app'
     template 'exceptiontrap.yml', 'config/exceptiontrap.yml'
   end
 end

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

@@ -12,4 +12,5 @@ ignoreExceptions:
   - 'ActionController::UnknownAction'
 filterParams:
   - 'password'
+  - 'password_confirmation'
   - 's3-key'

metadata

@@ -1,35 +1,24 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: exceptiontrap
-version: !ruby/object:Gem::Version 
-  hash: 296151482
+version: !ruby/object:Gem::Version
+  version: 0.0.2.alpha
   prerelease: 6
-  segments: 
-  - 0
-  - 0
-  - 1
-  - alpha
-  version: 0.0.1.alpha
 platform: ruby
-authors: 
+authors:
 - tbuehl
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-01-04 00:00:00 +01:00
-default_executable: 
+date: 2012-08-18 00:00:00.000000000 Z
 dependencies: []
-
-description: The gem catches your applications exceptionts and sends those to the exceptiontrap webservice
-email: 
+description: Exception notifier. The Gem catches your applications exceptions and
+  sends those to the exceptiontrap webservice hosted at http://exceptiontrap.com
+email:
 - tbuehl@itm-labs.de
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - MIT-LICENSE
@@ -56,42 +45,31 @@ files:
 - 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: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+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 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      hash: 25
-      segments: 
-      - 1
-      - 3
-      - 1
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-
 rubyforge_project: exceptiontrap
-rubygems_version: 1.6.2
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Used to report your apps exceptions to the exceptiontrap webservice
-test_files: 
+summary: Exception notifier, used to report your apps exceptions to the exceptiontrap
+  webservice
+test_files:
 - test/exceptiontrap_test.rb
 - test/test_helper.rb