contrast-exceptional 0.0.1 → 0.0.6

data/History.txt

@@ -0,0 +1,6 @@
+0.0.6 - Added a better 'safe' to_json method which works more effectively for rails integration avoiding cyclic reference and un-jsonable data
+0.0.5 - Fixed a bug in the plugin where request.env was being modified directly. dup to solve issues.
+0.0.4 - Restructured the plugin to extract all different concerns into self contained modules, will give a better base to extend. Also plays nicer with Rdoc + singleton classes
+0.0.3 - Dropped background queing of exceptions, send them all directly. Fixed issues with session/environment data. Working with rails 2.3 (some hacks needed to get there, need to refactor.)
+0.0.2 - Fix a bug introduced with nil sessions
+0.0.1 - First Version

data/Manifest

@@ -3,18 +3,24 @@ exceptional.yml
 History.txt
 init.rb
 install.rb
-lib/exceptional/agent/worker.rb
-lib/exceptional/deployed_environment.rb
+lib/exceptional/api.rb
+lib/exceptional/bootstrap.rb
+lib/exceptional/config.rb
 lib/exceptional/exception_data.rb
 lib/exceptional/integration/rails.rb
-lib/exceptional/rails.rb
+lib/exceptional/log.rb
+lib/exceptional/remote.rb
 lib/exceptional/version.rb
 lib/exceptional.rb
 Manifest
 Rakefile
 README
-spec/deployed_environment_spec.rb
+spec/api_spec.rb
+spec/bootstrap_spec.rb
+spec/config_spec.rb
 spec/exception_data_spec.rb
+spec/exceptional_rescue_from_spec.rb
 spec/exceptional_spec.rb
+spec/log_spec.rb
+spec/remote_spec.rb
 spec/spec_helper.rb
-spec/worker_spec.rb

data/README

@@ -4,10 +4,10 @@ This plugin posts exception data to Exceptional (http://getexceptional.com). Dat
 
 = Exceptional
 
-Exceptional (http://getexceptional.com) is a web-based exception tracking and managing system for Ruby on Rails folks and their apps. It's currently in early, private beta.
+Exceptional (http://getexceptional.com) is a web-based exception tracking and managing system for Ruby on Rails folks and their apps.
 
 = Installation
 
-For installation instructions, follow the steps displayed after adding a new app to your account. Please send any questions or comments to hello@getexceptional.com.
+For installation instructions, follow the steps displayed after adding a new app to your account. Please send any questions or comments to feedback@getexceptional.com.
 
-Copyright © 2008 Contrast.
+Copyright © 2008, 2009 Contrast.

data/Rakefile

@@ -1,13 +1,13 @@
 begin
   require 'echoe'
  
-  Echoe.new('exceptional', '0.0.1') do |p|
+  Echoe.new('exceptional', '0.0.6') do |p|
     p.rubyforge_name = 'exceptional'
     p.summary      = "Exceptional is the core Ruby library for communicating with http://getexceptional.com (hosted error tracking service)"
     p.description  = "Exceptional is the core Ruby library for communicating with http://getexceptional.com (hosted error tracking service)"
     p.url          = "http://getexceptional.com/"
-    p.author       = ['David Rice']
-    p.email        = "david@contrast.ie"
+    p.author       = ["Contrast"]
+    p.email        = "hello@contrast.ie"
     p.dependencies = ["json"]
   end
  
@@ -24,17 +24,16 @@ begin
     t.spec_files = FileList['spec/**/*_spec.rb']
     t.spec_opts = ['--color']
   end
- 
+  
   task :test do
     Rake::Task['spec'].invoke
   end
- 
+  
   Spec::Rake::SpecTask.new("coverage") do |t|
     t.spec_files = FileList['spec/**/*_spec.rb']
     t.spec_opts = ['--color']
     t.rcov = true
     t.rcov_opts = ['--exclude', '^spec,/gems/']
   end
-
   
 end

data/exceptional.gemspec

@@ -1,34 +1,34 @@
+# -*- encoding: utf-8 -*-
+
 Gem::Specification.new do |s|
-  s.name     = "exceptional"
-  s.version  = "0.0.1"
-  s.date     = "2008-10-13"
-  s.summary  = "Exceptional is the core Ruby library for communicating with http://getexceptional.com (hosted error tracking service)"
-  s.email    = "david@getexceptional.com"
-  s.homepage = "http://github.com/contrast/exceptional"
-  s.description = "Exceptional is the core Ruby library for communicating with http://getexceptional.com (hosted error tracking service)"
+  s.name = %q{exceptional}
+  s.version = "0.0.6"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Contrast"]
+  s.date = %q{2009-07-09}
+  s.description = %q{Exceptional is the core Ruby library for communicating with http://getexceptional.com (hosted error tracking service)}
+  s.email = %q{hello@contrast.ie}
+  s.extra_rdoc_files = ["lib/exceptional/api.rb", "lib/exceptional/bootstrap.rb", "lib/exceptional/config.rb", "lib/exceptional/exception_data.rb", "lib/exceptional/integration/rails.rb", "lib/exceptional/log.rb", "lib/exceptional/remote.rb", "lib/exceptional/version.rb", "lib/exceptional.rb", "README"]
+  s.files = ["exceptional.gemspec", "exceptional.yml", "History.txt", "init.rb", "install.rb", "lib/exceptional/api.rb", "lib/exceptional/bootstrap.rb", "lib/exceptional/config.rb", "lib/exceptional/exception_data.rb", "lib/exceptional/integration/rails.rb", "lib/exceptional/log.rb", "lib/exceptional/remote.rb", "lib/exceptional/version.rb", "lib/exceptional.rb", "Manifest", "Rakefile", "README", "spec/api_spec.rb", "spec/bootstrap_spec.rb", "spec/config_spec.rb", "spec/exception_data_spec.rb", "spec/exceptional_rescue_from_spec.rb", "spec/exceptional_spec.rb", "spec/log_spec.rb", "spec/remote_spec.rb", "spec/spec_helper.rb"]
   s.has_rdoc = true
-  s.authors  = ["David Rice", "Paul Campbell"]
-  s.files    = ["History.txt", 
-		"Manifest", 
-		"README", 
-		"Rakefile", 
-		"exceptional.gemspec",
-		"exceptional.yml",
-		"init.rb", 
-		"install.rb", 
-		"lib/exceptional/agent/worker.rb",
-    "lib/exceptional/deployed_environment.rb",
-    "lib/exceptional/exception_data.rb",
-    "lib/exceptional/integration/rails.rb",
-    "lib/exceptional/rails.rb",
-    "lib/exceptional/version.rb",
-    "lib/exceptional.rb"]
-  s.test_files = ["spec/deployed_environment_spec.rb",
-      "spec/exception_data_spec.rb",
-      "spec/exceptional_spec.rb",
-      "spec/spec_helper.rb",
-      "spec/worker_spec.rb"]
-  s.rdoc_options = ["--main", "README"]
-  s.extra_rdoc_files = ["History.txt", "Manifest", "README"]
-  s.add_dependency("json", ["> 0.0.0"])
-end
+  s.homepage = %q{http://getexceptional.com/}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Exceptional", "--main", "README"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{exceptional}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Exceptional is the core Ruby library for communicating with http://getexceptional.com (hosted error tracking service)}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+    else
+      s.add_dependency(%q<json>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<json>, [">= 0"])
+  end
+end

data/init.rb

@@ -1,20 +1,2 @@
 require 'exceptional'
-
-def to_stderr(s)
-  STDERR.puts "** [Exceptional] " + s
-end
-
-config_file = File.join(RAILS_ROOT,"/config/exceptional.yml")
-
-begin 
-  Exceptional.application_root = RAILS_ROOT
-  Exceptional.environment = RAILS_ENV
-  
-  Exceptional.load_config(config_file)
-  if Exceptional.enabled?
-    Exceptional::Rails.init
-  end
-rescue Exception => e
-  to_stderr e
-  to_stderr "Plugin disabled."
-end
+Exceptional.bootstrap(RAILS_ENV, RAILS_ROOT)

data/lib/exceptional.rb

@@ -1,231 +1,20 @@
 $:.unshift File.dirname(__FILE__)
-require 'exceptional/rails'
-require 'exceptional/deployed_environment'
-require 'exceptional/agent/worker'
+
 require 'exceptional/exception_data'
 require 'exceptional/version'
-require 'rubygems'
-
-require 'zlib'
-require 'cgi'
-require 'net/http'
-require 'logger'
-require 'yaml'
-require 'json' unless defined? Rails
-# Hack to force Rails version prior to 2.0 to use quoted JSON as per the JSON standard... (TODO: could be cleaner!)
-ActiveSupport::JSON.unquote_hash_key_identifiers = false if (defined?(ActiveSupport::JSON) && ActiveSupport::JSON.respond_to?(:unquote_hash_key_identifiers))
+require 'exceptional/log'
+require 'exceptional/config'
+require 'exceptional/remote'
+require 'exceptional/api'
+require 'exceptional/bootstrap'
 
 module Exceptional
-  class LicenseException < StandardError; end
-  class ConfigurationException < StandardError; end
-  
-  ::PROTOCOL_VERSION = 3
-  # Defaults for configuration variables
-  ::REMOTE_HOST = "getexceptional.com"
-  ::REMOTE_PORT = 80
-  ::REMOTE_SSL_PORT = 443
-  ::SSL = false
-  ::LOG_LEVEL = 'info'
-  ::LOG_PATH = nil
-  ::WORKER_TIMEOUT = 10 # seconds
-  ::MODE = :direct
-  
-  class << self
-    attr_accessor :api_key, :log, :deployed_environment, :log_path, :worker, 
-                  :worker_thread, :environment, :application_root
-    attr_writer   :remote_host, :remote_port, :ssl_enabled, :log_level
-    
-    # rescue any exceptions within the given block,
-    # send it to exceptional,
-    # then raise
-    def rescue(&block)
-      begin
-        block.call 
-      rescue Exception => e
-        self.catch(e)
-        raise(e)
-      end
-    end 
-    
-    # parse an exception into an ExceptionData object
-    def parse(exception)
-      exception_data = ExceptionData.new
-      exception_data.exception_backtrace = exception.backtrace
-      exception_data.exception_message = exception.message
-      exception_data.exception_class = exception.class.to_s
-      exception_data
-    end
-    
-    # authenticate with getexceptional.com
-    # returns true if the configured api_key is registered and can send data
-    # otherwise false
-    def authenticate
-      begin    
-        # TODO No data required to authenticate, send a nil string? hacky
-        # TODO should retry if a http connection failed
-        return @authenticated if @authenticated
-        authenticated = call_remote(:authenticate, "")
-        @authenticated = authenticated =~ /true/
-      rescue 
-        @authenticated = false
-      ensure
-        return @authenticated
-      end
-    end
-    
-    # post the given exception data to getexceptional.com
-    def post(exception_data)
-      call_remote(:errors, exception_data.to_json)
-    end
-    
-    # given a regular ruby Exception class, will parse into an ExceptionData
-    # object and post to getexceptional.com
-    def catch(exception)
-      exception_data = parse(exception)
-      exception_data.controller_name = File.basename($0)
-      post(exception_data)
-    end
-    
-    # used with Rails, takes an exception, controller, request and parameters
-    # creates an ExceptionData object
-    # if Exceptional is running in :direct mode, will post to getexceptional.com
-    # if Exceptional is running in :queue mode, the data will be queued and posted later
-    def handle(exception, controller, request, params)
-      log! "Handling #{exception.message}", 'info'
-      e = parse(exception)
-      # Additional data for Rails Exceptions
-      e.framework = "rails"
-      e.controller_name = controller.controller_name
-      e.action_name = controller.action_name
-      e.application_root = self.application_root
-      e.occurred_at = Time.now.strftime("%Y%m%d %H:%M:%S %Z")
-      e.environment = request.env.to_hash
-      e.url = "#{request.protocol}#{request.host}#{request.request_uri}"
-      # Need to remove rack data from environment hash
-      safe_environment = request.env.to_hash
-      safe_environment.delete_if { |k,v| k =~ /rack/ }
-      e.environment = safe_environment
-      
-      safe_session = {}
-      request.session.instance_variables.each do |v|
-        next if v =~ /cgi/
-        next if v =~ /db/
-        # remove prepended @'s
-        var = v.sub("@","")
-        safe_session[var] = request.session.instance_variable_get(v)
-      end
-      
-      e.session = safe_session
-      e.parameters = params.to_hash
 
-      if mode == :queue
-        worker.add_exception(e)
-      else # :direct mode
-        begin
-          post e
-        rescue Exception => exception
-          log! "Error posting data to Exceptional."
-          log! exception.message
-          log! exception.backtace.join("\n"), 'debug'
-        end
-      end
-    end
-    
-    # TODO these configuration methods & defaults should have their own class
-    def remote_host
-      @remote_host || ::REMOTE_HOST
-    end
-    
-    def remote_port
-      @remote_port || default_port
-    end
-    
-    def log_level
-      @log_level || ::LOG_LEVEL
-    end
-    
-    def mode
-      deployed_environment ? deployed_environment.determine_mode : ::MODE
-    end
-    
-    def default_port
-      ssl_enabled? ? ::REMOTE_SSL_PORT : ::REMOTE_PORT  
-    end
-    
-    def ssl_enabled?
-      @ssl_enabled || ::SSL
-    end
-    
-    def enabled?
-      @enabled
-    end
-    
-    def log!(msg, level = 'info')
-      to_stderr msg
-      log.send level, msg if log
-    end
-    
-    def to_stderr(msg)
-      if deployed_environment && deployed_environment.server != :unknown
-        STDERR.puts "** [Exceptional] " + msg 
-      end
-    end
-    
-    def log_config_info
-      log! "API Key: #{api_key}", 'debug'
-      log! "Deployed Environment: #{deployed_environment.to_s}", 'debug'
-      log! "Remote Host: #{remote_host}:#{remote_port}", 'debug'
-      log! "Mode: #{mode}", 'debug'
-      log! "Log level: #{log_level}", 'debug'
-      log! "Log path: #{log_path}", 'debug'
-    end
-    
-    def load_config(file)
-      begin
-        config = YAML::load(File.open(file))[self.environment]
-        @api_key = config['api-key'] unless config['api-key'].nil?
-        @ssl_enabled = config['ssl'] unless config['ssl'].nil?
-        @log_level = config['log-level'] unless config['log-level'].nil?
-        @enabled = config['enabled'] unless config['enabled'].nil?
-        @remote_port = config['remote-port'].to_i unless config['remote-port'].nil?
-        @remote_host = config['remote-host'] unless config['remote-host'].nil?
-      rescue Exception => e
-        raise ConfigurationException.new("Unable to load configuration file:#{file} for environment:#{environment}")
-      end
-    end
-    
-    protected 
-    
-    def valid_api_key?
-      @api_key && @api_key.length == 40
-    end
-
-    
-    def call_remote(method, data)
-      if @api_key.nil?
-        raise LicenseException.new("API Key must be configured") 
-      end
-      
-      http = Net::HTTP.new(remote_host, remote_port) 
-      uri = "/#{method.to_s}?&api_key=#{@api_key}&protocol_version=#{::PROTOCOL_VERSION}"
-      headers = { 'Content-Type' => 'application/x-gzip', 'Accept' => 'application/x-gzip' }
-      compressed_data = CGI::escape(Zlib::Deflate.deflate(data, Zlib::BEST_SPEED))
-      response = http.start do |http|
-        http.post(uri, compressed_data, headers) 
-      end
-      
-      if response.kind_of? Net::HTTPSuccess
-        return response.body
-      else
-        raise Exception.new("#{response.code}: #{response.message}")
-      end 
-
-    rescue Exception => e
-      log! "Error contacting Exceptional: #{e}", 'info'
-      log! e.backtrace.join("\n"), 'debug'
-      raise e
-    end
-    
+  class << self
+    include Exceptional::Config
+    include Exceptional::Api
+    include Exceptional::Remote
+    include Exceptional::Log
+    include Exceptional::Bootstrap
   end
-  
 end

data/lib/exceptional/api.rb

@@ -0,0 +1,108 @@
+require 'json' unless defined? Rails
+
+
+module Exceptional
+
+  module Api
+    # parse an exception into an ExceptionData object
+    def parse(exception)
+      exception_data = ExceptionData.new
+      exception_data.exception_backtrace = exception.backtrace
+      exception_data.exception_message = exception.message
+      exception_data.exception_class = exception.class.to_s
+      exception_data
+    end
+
+    # post the given exception data to getexceptional.com
+    def post(exception_data)
+      hash = exception_data.to_hash
+      if hash[:session]
+        hash[:session].delete("initialization_options")
+        hash[:session].delete("request")
+      end
+
+      Exceptional.post_exception(hash.to_json)
+    end
+
+    # used with Rails, takes an exception, controller, request and parameters
+    # creates an ExceptionData object
+    def handle(exception, controller, request, params)
+      Exceptional.log! "Handling #{exception.message}", 'info'
+      begin
+        e = parse(exception)
+        # Additional data for Rails Exceptions
+        e.framework = "rails"
+        e.controller_name = controller.controller_name
+        e.action_name = controller.action_name
+        e.application_root = Exceptional.application_root
+        e.occurred_at = Time.now.strftime("%Y%m%d %H:%M:%S %Z")
+        e.environment = request.env.to_hash
+        e.url = "#{request.protocol}#{request.host}#{request.request_uri}"
+        e.environment = safe_environment(request)
+        e.session = safe_session(request.session)
+        e.parameters = sanitize_hash(params.to_hash)
+
+        post(e)
+      rescue Exception => exception
+        Exceptional.log! "Error preparing exception data."
+        Exceptional.log! exception.message
+        Exceptional.log! exception.backtrace.join("\n"), 'debug'
+      end
+    end
+
+    # rescue any exceptions within the given block,
+    # send it to exceptional,
+    # then raise
+    def rescue(&block)
+      begin
+        block.call
+      rescue Exception => e
+        self.catch(e)
+        raise(e)
+      end
+    end
+
+    def catch(exception)
+      exception_data = parse(exception)
+      exception_data.controller_name = File.basename($0)
+      post(exception_data)
+    end
+
+    protected
+
+    def safe_environment(request)
+      safe_environment = request.env.dup.to_hash
+      # From Rails 2.3 these objects that cause a circular reference error on .to_json need removed
+      # TODO potentially remove this case, should be covered by sanitize_hash
+      safe_environment.delete_if { |k,v| k =~ /rack/ || k =~ /action_controller/ || k == "_"}
+      # needed to add a filter for the hash for "_", causing invalid xml.
+      sanitize_hash(safe_environment)
+    end
+
+    def safe_session(session)
+      result = {}
+      session.instance_variables.each do |v|
+        next if v =~ /cgi/ || v =~ /db/ || v =~ /env/
+        var = v.sub("@","") # remove prepended @'s
+        result[var] = session.instance_variable_get(v)
+      end
+      sanitize_hash(result)
+    end
+
+    private
+
+    def sanitize_hash(hash)
+      return {} if hash.nil?
+      hash.reject { |key, val| !ensure_json_able(val) }
+    end
+
+    def ensure_json_able(value)
+      begin
+        value.to_json
+        true && value.instance_values.all? { |e| ensure_json_able(e)}        
+      rescue Exception => e
+        false
+      end
+    end
+  end
+end