exceptional 2.0.0 → 2.0.1

data/bin/exceptional

@@ -7,9 +7,9 @@ command = args.shift.strip rescue 'help'
 case command
   when 'help'
     puts <<USAGE
-help               # show this usage
-test               # send a test exception to exceptional
-install <api_key>  # create config/exceptional.yml with your api_key. Overrites existing one.
+help               # Show this usage.
+test               # Send a test exception to Exceptional.
+install <api_key>  # Create config/exceptional.yml with your api_key. Overrites existing one.
 USAGE
   when 'test'
     puts "Loading Rails environment."
@@ -22,15 +22,15 @@ USAGE
   when 'install'
     api_key = args[0]
     if (api_key.nil?)
-      puts 'missing required paramater <api-key>. Check your app configuration at http://getexceptional.com'
+      puts 'Missing required paramater <api-key>. Check your app configuration at http://getexceptional.com.'
     else
       unless File.file?('config/environment.rb')
-        puts "Run this command from the root of your rails application"
+        puts "Run this command from the root of your rails application."
       else
         config_file = File.open('config/exceptional.yml', 'w')
         config_file.puts("api-key: #{api_key}\n")
         config_file.close
-        puts "Config file written as config/exceptional.yml"
+        puts "Config file written as config/exceptional.yml."
       end
     end
 end

data/exceptional.gemspec

@@ -1,7 +1,7 @@
 # -*- encoding: utf-8 -*-
 Gem::Specification.new do |s|
   s.name = %q{exceptional}
-  s.version = "2.0.0"
+  s.version = "2.0.1"
   s.authors = ["Contrast"]
   s.summary = %q{Exceptional is the core Ruby library for communicating with http://getexceptional.com (hosted error tracking service)}
   s.description = %q{Exceptional is the core Ruby library for communicating with http://getexceptional.com (hosted error tracking service). Use it to find out about errors that happen in your live app. It captures lots of helpful information to help you fix the errors.}
@@ -11,5 +11,5 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.executables << 'exceptional'
   s.rubyforge_project = %q{exceptional}
-  s.add_dependency('json', ">= 1.0.0")
-end
+  s.requirements << "json_pure, json-jruby or json gem required"
+end

data/init.rb

@@ -1,12 +1,27 @@
 require 'exceptional'
 
+unless Object.const_defined?(:JSON)
+  begin
+    require 'json'
+  rescue LoadError
+    begin
+      require 'json-ruby'
+    rescue LoadError
+      require 'json_pure'
+    end
+  end
+end
+unless Object.const_defined?(:JSON)
+  raise "Could not load json gem; make sure you install one of json_pure, json-ruby, or the C-based json gem."
+end
+
 # If old plugin still installed then we don't want to install this one.
 # In production environments we should continue to work as before, but in development/test we should
 # advise how to correct the problem and exit
-if defined?(Exceptional::VERSION::STRING) && %w(development test).include?(RAILS_ENV)
+if (defined?(Exceptional::VERSION::STRING) rescue nil) && %w(development test).include?(RAILS_ENV)
   message = %Q(
   ***********************************************************************
-  You seem to still have an old version of the exceptional plugin installed.
+  You seem to still have an old version of the Exceptional plugin installed.
   Remove it from /vendor/plugins and try again.
   ***********************************************************************
   )

data/install.rb

@@ -10,10 +10,10 @@ if File::exists? config_file
   puts "Exceptional config file already exists. Please ensure it is up-to-date with the current format."
   puts "See #{example_config_file}"
 else  
-  puts "Installing default Exceptional config"
+  puts "Installing default Exceptional config."
   puts "  From #{example_config_file}"
-  puts "For exceptional to work you need to configure your API Key"
+  puts "For exceptional to work you need to configure your API key."
   puts "  See #{example_config_file}"
-  puts "If you don't have an API Key, get one at http://getexceptional.com/"
+  puts "If you don't have an API key, get one at http://getexceptional.com/."
   File.copy example_config_file, config_file
 end

data/lib/exceptional/catcher.rb

@@ -1,9 +1,16 @@
 module Exceptional
   class Catcher
     class << self
-      def handle(exception, controller=nil, request=nil)
+      def handle_with_controller(exception, controller=nil, request=nil)
         if Config.should_send_to_api?
-          data = ExceptionData.new(exception, controller, request)
+          data = ControllerExceptionData.new(exception, controller, request)
+          Remote.error(data)
+        end
+      end
+
+      def handle(exception, name=nil)
+        if Config.should_send_to_api?
+          data = ExceptionData.new(exception, name)
           Remote.error(data)
         end
       end

data/lib/exceptional/config.rb

@@ -2,11 +2,8 @@ module Exceptional
   class Config
     class << self
       DEFAULTS = {
-        :ssl_enabled => false,
-        :remote_host_http => 'api.getexceptional.com',
-        :remote_port_http => 80,
-        :remote_host_https => 'getexceptional.appspot.com',
-        :remote_port_https => 443,
+        :ssl => false,
+        :remote_host_http => 'plugin.getexceptional.com',
         :http_open_timeout => 2,
         :http_read_timeout => 4,
         :disabled_by_default => %w(development test)
@@ -14,7 +11,7 @@ module Exceptional
 
       attr_accessor :api_key
       attr_accessor :http_proxy_host, :http_proxy_port, :http_proxy_username, :http_proxy_password
-      attr_writer :ssl_enabled
+      attr_writer :ssl
 
       def load(config_file=nil)
         if (config_file && File.file?(config_file))
@@ -30,7 +27,7 @@ module Exceptional
             @http_open_timeout = config['http-open-timeout']
             @http_read_timeout = config['http-read-timeout'] 
 
-            @ssl_enabled = config['ssl'] || env_config['ssl']
+            @ssl = config['ssl'] || env_config['ssl']
             @enabled = env_config['enabled']
             @remote_port = config['remote-port'].to_i unless config['remote-port'].nil?
             @remote_host = config['remote-host'] unless config['remote-host'].nil?
@@ -57,20 +54,20 @@ module Exceptional
         defined?(RAILS_ROOT) ? RAILS_ROOT : Dir.pwd
       end
 
-      def ssl_enabled?
-        @ssl_enabled ||= DEFAULTS[:ssl_enabled]
+      def ssl?
+        @ssl ||= DEFAULTS[:ssl]
       end
 
       def remote_host
-        @remote_host ||= ssl_enabled? ? DEFAULTS[:remote_host_https] : DEFAULTS[:remote_host_http]
+        @remote_host ||= DEFAULTS[:remote_host_http]
       end
 
       def remote_port
-        @remote_port ||= ssl_enabled? ? DEFAULTS[:remote_port_https] : DEFAULTS[:remote_port_http]
+        @remote_port ||= ssl? ? 443 : 80
       end
 
       def reset
-        @enabled = @ssl_enabled = @remote_host = @remote_port = @api_key = nil
+        @enabled = @ssl = @remote_host = @remote_port = @api_key = nil
       end
 
       def http_open_timeout

data/lib/exceptional/controller_exception_data.rb

@@ -0,0 +1,60 @@
+require 'digest/md5'
+
+module Exceptional
+  class ControllerExceptionData < ExceptionData
+    def initialize(exception, controller=nil, request=nil)
+      super(exception)
+      @request = request
+      @controller = controller
+    end
+
+    def extra_stuff
+      return {} if @request.nil?
+      {
+        'request' => {
+          'url' => "#{@request.protocol}#{@request.host}#{@request.request_uri}",
+          'controller' => @controller.class.to_s,
+          'action' => @request.parameters['action'],
+          'parameters' => filter_paramaters(@request.parameters),
+          'request_method' => @request.request_method.to_s,
+          'remote_ip' => @request.remote_ip,
+          'headers' => extract_http_headers(@request.env),
+          'session' => Exceptional::ControllerExceptionData.sanitize_session(@request)
+        }
+      }
+    end
+
+    def filter_paramaters(hash)
+      if @controller.respond_to?(:filter_parameters)
+        @controller.send(:filter_parameters, hash)
+      else
+        hash
+      end
+    end
+
+    def extract_http_headers(env)
+      headers = {}
+      env.select{|k, v| k =~ /^HTTP_/}.each do |name, value|
+        proper_name = name.sub(/^HTTP_/, '').split('_').map{|upper_case| upper_case.capitalize}.join('-')
+        headers[proper_name] = value
+      end
+      unless headers['Cookie'].nil?
+        headers['Cookie'] = headers['Cookie'].sub(/_session=\S+/, '_session=[FILTERED]')
+      end
+      headers
+    end
+
+    def self.sanitize_session(request)
+      session = request.session
+      session_hash = {}
+      session_hash['session_id'] = request.session_options ? request.session_options[:id] : nil
+      session_hash['session_id'] ||= session.respond_to?(:session_id) ? session.session_id : session.instance_variable_get("@session_id")
+      session_hash['data'] = session.respond_to?(:to_hash) ? session.to_hash : session.instance_variable_get("@data") || {}
+      session_hash['session_id'] ||= session_hash['data'][:session_id]
+      session_hash['data'].delete(:session_id)
+      ControllerExceptionData.sanitize_hash(session_hash)
+    rescue
+      {}
+    end
+  end
+end

data/lib/exceptional/exception_data.rb

@@ -2,10 +2,9 @@ require 'digest/md5'
 
 module Exceptional
   class ExceptionData
-    def initialize(exception, controller=nil, request=nil)
+    def initialize(exception, name=nil)
       @exception = exception
-      @request = request
-      @controller = controller
+      @name = name
     end
 
     def to_hash
@@ -18,23 +17,20 @@ module Exceptional
           'occurred_at' => Time.now.strftime("%Y%m%d %H:%M:%S %Z")
         }
       })
-      unless @request.nil?
-        hash.merge!({
-          'request' => {
-            'url' => "#{@request.protocol}#{@request.host}#{@request.request_uri}",
-            'controller' => @controller.class.to_s,
-            'action' => @request.parameters['action'],
-            'parameters' => filter_paramaters(@request.parameters),
-            'request_method' => @request.request_method.to_s,
-            'remote_ip' => @request.remote_ip,
-            'headers' => extract_http_headers(@request.env),
-            'session' => Exceptional::ExceptionData.sanitize_session(@request)
-          }
-        })
-      end
+      hash.merge!(extra_stuff)
+      hash.merge!(context_stuff)
       hash
     end
 
+    def extra_stuff
+      { 'rescue_block' => { 'name' => @name} }
+    end
+
+    def context_stuff
+      context = Thread.current[:exceptional_context]
+      context.blank? ? {} : {'context' => context}
+    end
+
     def to_json
       to_hash.to_json
     end
@@ -44,26 +40,6 @@ module Exceptional
       Digest::MD5.hexdigest(@exception.backtrace.join)
     end
 
-    def filter_paramaters(hash)
-      if @controller.respond_to?(:filter_parameters)
-        @controller.send(:filter_parameters, hash)
-      else
-        hash
-      end
-    end
-
-    def extract_http_headers(env)
-      headers = {}
-      env.select{|k, v| k =~ /^HTTP_/}.each do |name, value|
-        proper_name = name.sub(/^HTTP_/, '').split('_').map{|upper_case| upper_case.capitalize}.join('-')
-        headers[proper_name] = value
-      end
-      unless headers['Cookie'].nil?
-        headers['Cookie'] = headers['Cookie'].sub(/_session=\S+/, '_session=[FILTERED]')
-      end
-      headers
-    end
-
     def self.sanitize_hash(hash)
       case hash
         when Hash
@@ -78,18 +54,5 @@ module Exceptional
     rescue
       {}
     end
-
-    def self.sanitize_session(request)
-      session = request.session
-      session_hash = {}
-      session_hash['session_id'] = request.session_options ? request.session_options[:id] : nil
-      session_hash['session_id'] ||= session.respond_to?(:session_id) ? session.session_id : session.instance_variable_get("@session_id")
-      session_hash['data'] = session.respond_to?(:to_hash) ? session.to_hash : session.instance_variable_get("@data") || {}
-      session_hash['session_id'] ||= session_hash['data'][:session_id]
-      session_hash['data'].delete(:session_id)
-      ExceptionData.sanitize_hash(session_hash)
-    rescue
-      {}
-    end
   end
 end

data/lib/exceptional/integration/rails.rb

@@ -8,7 +8,8 @@ if defined? ActionController
     class Base
       def rescue_action_with_exceptional(exception)
         unless exception_handled_by_rescue_from?(exception)
-          Exceptional::Catcher.handle(exception, self, request)
+          Exceptional::Catcher.handle_with_controller(exception, self, request)
+          Exceptional.context.clear!
         end
         rescue_action_without_exceptional exception
       end
@@ -23,4 +24,4 @@ if defined? ActionController
       end
     end
   end
-end
+end

data/lib/exceptional/integration/tester.rb

@@ -4,11 +4,11 @@ module Exceptional
     end
 
     def self.test
-      data = Exceptional::ExceptionData.new(ExceptionalTestException.new)
+      data = Exceptional::ExceptionData.new(ExceptionalTestException.new, 'Test exception')
       unless Exceptional::Remote.error(data)
-        puts "Problem sending error to Exceptional. Check your api key"
+        puts "Problem sending exception to Exceptional. Check your API key."
       else
-        puts "Exception sent successfully"
+        puts "Exception sent successfully."
       end
     end
   end

data/lib/exceptional/remote.rb

@@ -30,7 +30,8 @@ module Exceptional
         client = optional_proxy.new(config.remote_host, config.remote_port)
         client.open_timeout = config.http_open_timeout
         client.read_timeout = config.http_read_timeout
-        client.use_ssl = config.ssl_enabled?
+        client.use_ssl = config.ssl?
+        client.verify_mode = OpenSSL::SSL::VERIFY_NONE if config.ssl?
         begin
           response = client.post(url, data)
           case response

data/lib/exceptional.rb

@@ -6,12 +6,12 @@ require 'exceptional/log_factory'
 require 'exceptional/config'
 require 'exceptional/application_environment'
 require 'exceptional/exception_data'
+require 'exceptional/controller_exception_data'
 require 'exceptional/remote'
-require 'exceptional/integration/rack'
 
 module Exceptional
   PROTOCOL_VERSION = 5
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
   CLIENT_NAME = 'getexceptional-rails-plugin'
 
   def self.logger
@@ -22,12 +22,38 @@ module Exceptional
     Exceptional::Config.api_key = api_key
   end
 
-  def self.rescue(&block)
+  def self.handle(exception, name=nil)
+    Exceptional::Catcher.handle(exception, name)
+  end
+  
+  def self.rescue(name=nil, context=nil, &block)
     begin
+      self.context(context) unless context.nil?
       block.call
     rescue Exception => e
-      Exceptional::Catcher.handle(e)
+      Exceptional::Catcher.handle(e,name)
+      self.clear!
+    end
+  end
+
+  def self.rescue_and_reraise(name=nil, context=nil, &block)
+    begin
+      self.context(context) unless context.nil?
+      block.call
+    rescue Exception => e
+      Exceptional::Catcher.handle(e,name)
+      self.clear!
       raise(e)
     end
   end
+
+  def self.clear!
+    Thread.current[:exceptional_context] = nil
+  end
+
+  def self.context(hash = {})
+    Thread.current[:exceptional_context] ||= {}
+    Thread.current[:exceptional_context].merge!(hash)
+    self
+  end
 end

data/spec/exceptional/catcher_spec.rb

@@ -6,8 +6,8 @@ describe Exceptional::Catcher do
     exception = mock('exception')
     controller = mock('controller')
     request = mock('request')
-    Exceptional::ExceptionData.should_receive(:new).with(exception,controller,request).and_return(data = mock('exception_data'))
+    Exceptional::ControllerExceptionData.should_receive(:new).with(exception,controller,request).and_return(data = mock('exception_data'))
     Exceptional::Remote.should_receive(:error).with(data)
-    Exceptional::Catcher.handle(exception,controller,request)
+    Exceptional::Catcher.handle_with_controller(exception,controller,request)
   end
 end

data/spec/exceptional/config_spec.rb

@@ -5,8 +5,8 @@ describe Exceptional::Config, 'defaults' do
     Exceptional::Config.reset
   end
   it "have sensible defaults" do
-    Exceptional::Config.ssl_enabled?.should == false
-    Exceptional::Config.remote_host.should == 'api.getexceptional.com'
+    Exceptional::Config.ssl?.should == false
+    Exceptional::Config.remote_host.should == 'plugin.getexceptional.com'
     Exceptional::Config.remote_port.should == 80
     Exceptional::Config.application_root.should == Dir.pwd
     Exceptional::Config.http_proxy_host.should be_nil
@@ -16,9 +16,9 @@ describe Exceptional::Config, 'defaults' do
     Exceptional::Config.http_open_timeout.should == 2
     Exceptional::Config.http_read_timeout.should == 4
   end
-  it "have correct defaults when ssl_enabled" do
-    Exceptional::Config.ssl_enabled = true
-    Exceptional::Config.remote_host.should == 'getexceptional.appspot.com'
+  it "have correct defaults when ssl" do
+    Exceptional::Config.ssl = true
+    Exceptional::Config.remote_host.should == 'plugin.getexceptional.com'
     Exceptional::Config.remote_port.should == 443
   end
   it "be enabled based on environment by default" do
@@ -38,7 +38,7 @@ describe Exceptional::Config, 'defaults' do
     it "allow a new simpler format for exception.yml" do
       Exceptional::Config.load('spec/fixtures/exceptional.yml')
       Exceptional::Config.api_key.should == 'abc123'
-      Exceptional::Config.ssl_enabled?.should == true
+      Exceptional::Config.ssl?.should == true
       Exceptional::Config.remote_host.should == 'example.com'
       Exceptional::Config.remote_port.should == 123
       Exceptional::Config.should_send_to_api?.should == true
@@ -52,7 +52,7 @@ describe Exceptional::Config, 'defaults' do
     it "allow olded format for exception.yml" do
       Exceptional::Config.load('spec/fixtures/exceptional_old.yml')
       Exceptional::Config.api_key.should == 'abc123'
-      Exceptional::Config.ssl_enabled?.should == true
+      Exceptional::Config.ssl?.should == true
       Exceptional::Config.should_send_to_api?.should == true
     end
     it "load api_key from environment variable" do

data/spec/exceptional/exception_data_spec.rb

@@ -1,5 +1,6 @@
 require File.dirname(__FILE__) + '/../spec_helper'
 require 'digest/md5'
+require 'json'
 
 class Exceptional::FunkyError < StandardError
   def backtrace
@@ -7,7 +8,7 @@ class Exceptional::FunkyError < StandardError
   end
 end
 
-describe Exceptional::ExceptionData, 'when no request/controller/params' do
+describe Exceptional::ControllerExceptionData, 'when no request/controller/params' do
   before :each do
     ENV['LOGNAME'] = 'bob'
     ENV['SOMEVAR'] = 'something'
@@ -15,8 +16,8 @@ describe Exceptional::ExceptionData, 'when no request/controller/params' do
     RAILS_ENV = 'test' unless defined?(RAILS_ENV)
     Time.stub!(:now).and_return(Time.mktime(1970,1,1))
     error = Exceptional::FunkyError.new('some message')
-    data = Exceptional::ExceptionData.new(error)
-    @hash = data.to_hash
+    @data = Exceptional::ControllerExceptionData.new(error)
+    @hash = @data.to_hash
   end
 
   it "capture exception details" do
@@ -31,6 +32,10 @@ describe Exceptional::ExceptionData, 'when no request/controller/params' do
     client_hash['protocol_version'].should == Exceptional::PROTOCOL_VERSION
   end
 
+  it "generates json" do
+    JSON.parse(@data.to_json)
+  end
+
   it "capture application_environment" do
     application_env_hash = @hash['application_environment']
     application_env_hash['environment'].should == 'test'
@@ -46,7 +51,7 @@ describe Exceptional::ExceptionData, 'when no request/controller/params' do
   end
 end
 
-describe Exceptional::ExceptionData, 'with request/controller/params' do
+describe Exceptional::ControllerExceptionData, 'with request/controller/params' do
   class Exceptional::SomeController < ActionController::Base
       filter_parameter_logging :filter_me
   end
@@ -60,7 +65,7 @@ describe Exceptional::ExceptionData, 'with request/controller/params' do
     @request.stub!(:remote_ip).and_return('1.2.3.4')
     @request.stub!(:env).and_return({'SOME_VAR' => 'abc', 'HTTP_CONTENT_TYPE' => 'text/html'})
     error = Exceptional::FunkyError.new('some message')
-    data = Exceptional::ExceptionData.new(error, @controller, @request)
+    data = Exceptional::ControllerExceptionData.new(error, @controller, @request)
     @hash = data.to_hash
   end
 
@@ -83,7 +88,12 @@ describe Exceptional::ExceptionData, 'with request/controller/params' do
     end
     crazy = Crazy.new
     input = {'crazy' => crazy, :simple => '123', :some_hash => {'1' => '2'}, :array => ['1','2']}
-    Exceptional::ExceptionData.sanitize_hash(input).should == {'crazy' => crazy.to_s, :simple => '123', :some_hash => {'1' => '2'}, :array => ['1','2']}
+    Exceptional::ControllerExceptionData.sanitize_hash(input).should == {'crazy' => crazy.to_s, :simple => '123', :some_hash => {'1' => '2'}, :array => ['1','2']}
+  end
+
+  it "to_strings regex because JSON.parse(/aa/.to_json) doesn't work" do
+    input = {'crazy' => /abc.*/}
+    Exceptional::ExceptionData.sanitize_hash(input).should == {'crazy' => /abc.*/.to_s}
   end
 
   it "handles session objects with various interfaces" do
@@ -97,27 +107,27 @@ describe Exceptional::ExceptionData, 'with request/controller/params' do
     session = SessionWithInstanceVariables.new
     request.stub!(:session).and_return(session)
     request.stub!(:session_options).and_return({})
-    Exceptional::ExceptionData.sanitize_session(request).should == {'session_id' => '123', 'data' => {'a' => '1'}}
+    Exceptional::ControllerExceptionData.sanitize_session(request).should == {'session_id' => '123', 'data' => {'a' => '1'}}
     session = mock('session', :session_id => '123', :instance_variable_get => {'a' => '1'})
     request.stub!(:session).and_return(session)
-    Exceptional::ExceptionData.sanitize_session(request).should == {'session_id' => '123', 'data' => {'a' => '1'}}
+    Exceptional::ControllerExceptionData.sanitize_session(request).should == {'session_id' => '123', 'data' => {'a' => '1'}}
     session = mock('session', :session_id => nil, :to_hash => {:session_id => '123', 'a' => '1'})
     request.stub!(:session).and_return(session)
-    Exceptional::ExceptionData.sanitize_session(request).should == {'session_id' => '123', 'data' => {'a' => '1'}}
+    Exceptional::ControllerExceptionData.sanitize_session(request).should == {'session_id' => '123', 'data' => {'a' => '1'}}
     request.stub!(:session_options).and_return({:id => 'xyz'})
-    Exceptional::ExceptionData.sanitize_session(request).should == {'session_id' => 'xyz', 'data' => {'a' => '1'}}
+    Exceptional::ControllerExceptionData.sanitize_session(request).should == {'session_id' => 'xyz', 'data' => {'a' => '1'}}
   end
 
   it "filter session cookies from headers" do
     @request.stub!(:env).and_return({'SOME_VAR' => 'abc', 'HTTP_COOKIE' => '_something_else=faafsafafasfa; _myapp-lick-nation_session=BAh7DDoMbnVtYmVyc1sJaQZpB2kIaQk6FnNvbWVfY3Jhenlfb2JqZWN0bzobU3Bpa2VDb250cm9sbGVyOjpDcmF6eQY6CUBiYXJABzoTc29tZXRoaW5nX2Vsc2UiCGNjYzoKYXBwbGUiDUJyYWVidXJuOgloYXNoewdpBmkHaQhpCToPc2Vzc2lvbl9pZCIlMmJjZTM4MjVjMThkNzYxOWEyZDA4NTJhNWY1NGQzMmU6C3RvbWF0byIJQmVlZg%3D%3D--66fb4606851f06bf409b8bc4ba7aea47a0259bf7'})
-    @hash = Exceptional::ExceptionData.new(Exceptional::FunkyError.new('some message'), @controller, @request).to_hash
+    @hash = Exceptional::ControllerExceptionData.new(Exceptional::FunkyError.new('some message'), @controller, @request).to_hash
     @hash['request']['headers'].should == {'Cookie' => '_something_else=faafsafafasfa; _myapp-lick-nation_session=[FILTERED]'}
   end
 
   it "creates a uniqueness_hash from backtrace" do
     myException = Exception.new
     myException.stub!(:backtrace).and_return(['123'])
-    data = Exceptional::ExceptionData.new(myException)
+    data = Exceptional::ControllerExceptionData.new(myException)
     data.uniqueness_hash.should == Digest::MD5.hexdigest('123')
   end
 end

data/spec/exceptional_rescue_spec.rb

@@ -1,17 +1,64 @@
 require File.dirname(__FILE__) + '/spec_helper'
 
 context 'resuce errors from within a block' do
-  class FunkyException < StandardError; end
-  it "send them to catcher and reraise" do
+  class FunkyException < StandardError;
+  end
+  it "Exceptional.rescue should send to exceptional and swallow error " do
+    to_raise = FunkyException.new
+    Exceptional::Catcher.should_receive(:handle).with(to_raise, 'my rescue name')
+    Exceptional.rescue('my rescue name') do
+      raise to_raise
+    end
+  end
+
+  it "reraises error with rescue_and_reraise" do
     to_raise = FunkyException.new
-    Exceptional::Catcher.should_receive(:handle).with(to_raise)
+    Exceptional::Catcher.should_receive(:handle).with(to_raise, 'my rescue name')
     begin
-      Exceptional.rescue do
+      Exceptional.rescue_and_reraise('my rescue name') do
         raise to_raise
       end
-      fail "expected to raise"
+      fail 'expected a reraise'
     rescue FunkyException => e
-      e.should == to_raise
     end
   end
+
+  it "Exceptional.handle calls Exceptional::Catcher.handle" do
+    to_raise = FunkyException.new
+    Exceptional::Catcher.should_receive(:handle).with(to_raise, 'optional name for where it has occurred')
+    begin
+      raise to_raise
+    rescue => e
+      Exceptional.handle(e, 'optional name for where it has occurred')
+    end
+  end
+
+  it "collects context information but leaves thread local empty after block" do
+    to_raise = FunkyException.new
+    Exceptional::Config.should_receive(:should_send_to_api?).and_return(true)
+    Exceptional::Remote.should_receive(:error) {|exception_data|
+      exception_data.to_hash['context']['foo'] == 'bar'
+      exception_data.to_hash['context']['baz'] == 42
+      exception_data.to_hash['context']['cats'] == {'lol' => 'bot'}
+    }
+    Exceptional.rescue('my rescue name') do
+      Exceptional.context('foo' => 'bar')
+      Exceptional.context('baz' => 42)
+      Exceptional.context('cats' => {'lol' => 'bot'})
+      raise to_raise
+    end
+    Thread.current[:exceptional_context].should == nil
+  end
+
+  it "clearr context with Exceptional.context.clear!" do
+    Exceptional.context('foo' => 'bar')
+    Thread.current[:exceptional_context].should_not == nil
+    Exceptional.context.clear!
+    Thread.current[:exceptional_context].should == nil
+  end
+
+  it "allows optional second paramater hash to get added to context" do
+    Exceptional.should_receive(:context).with(context_hash = {'foo' => 'bar', 'baz' => 42})
+    Exceptional.rescue('my resccue', context_hash) {}
+  end
 end

data/spec/rails_integration_spec.rb

@@ -3,13 +3,13 @@ require File.join(File.dirname(__FILE__), '..', 'lib', 'exceptional', 'integrati
 
 describe Exceptional, 'version number' do
   it "be available proramatically" do
-    Exceptional::VERSION.should == '0.2.0'
+    Exceptional::VERSION.should == '0.2.1'
   end
 end
 
 describe ActiveSupport::JSON, 'standards compliant json' do
   it "quote keys" do
-    {:a => '123'}.to_json.gsub(/ /,'').should == '{"a":"123"}'
+    {:a => '123'}.to_json.gsub(/ /, '').should == '{"a":"123"}'
   end
 end
 
@@ -25,27 +25,36 @@ describe TestingController do
   end
 
   it 'handle exception with Exceptional::Catcher' do
-    Exceptional::Catcher.should_receive(:handle).with(an_instance_of(StandardError), @controller, an_instance_of(ActionController::TestRequest))
+    Exceptional::Catcher.should_receive(:handle_with_controller).with(an_instance_of(StandardError), @controller, an_instance_of(ActionController::TestRequest))
     send_request(:raises_something)
   end
 
   it "still return an error response to the user" do
-    Exceptional::Catcher.stub!(:handle)
+    Exceptional::Catcher.stub!(:handle_with_controller)
     send_request(:raises_something)
     @response.code.should == '500'
   end
 end
 
 if ActionController::Base.respond_to?(:rescue_from)
-  class CustomError < StandardError; end
+  class CustomError < StandardError;
+  end
   class TestingWithRescueFromController < ActionController::Base
     rescue_from CustomError, :with => :custom_handler
+
     def raises_custom_error
       raise CustomError.new
     end
+
     def raises_other_error
       raise StandardError.new
     end
+
+    def raises_with_context
+      Exceptional.context('foo' => 'bar')
+      raise StandardError.new
+    end
+
     def custom_handler
       head :ok
     end
@@ -57,12 +66,20 @@ if ActionController::Base.respond_to?(:rescue_from)
     end
 
     it 'not handle exception with Exceptional that is dealt with by rescue_from' do
-      Exceptional::Catcher.should_not_receive(:handle)
+      Exceptional::Catcher.should_not_receive(:handle_with_controller)
       send_request(:raises_custom_error)
     end
     it 'handle exception with Exceptional that is not dealt with by rescue_from' do
-      Exceptional::Catcher.should_receive(:handle)
+      Exceptional::Catcher.should_receive(:handle_with_controller)
       send_request(:raises_other_error)
     end
+    it "has context and clears context after request" do
+      Exceptional::Config.should_receive(:should_send_to_api?).and_return(true)
+      Exceptional::Remote.should_receive(:error) {|exception_data|
+        exception_data.to_hash['context']['foo'] == 'bar'
+      }
+      send_request(:raises_with_context)
+      Thread.current[:exceptional_context].should == nil
+    end
   end
 end

data/spec/spec_helper.rb

@@ -4,6 +4,7 @@ begin
 rescue LoadError
   raise "cant load ginger"
 end
+
 gem 'rails'
 require File.dirname(__FILE__) + '/../lib/exceptional' unless defined?(Exceptional)
 
@@ -17,4 +18,4 @@ def send_request(action = nil)
   @request.action = action ? action.to_s : ""
   @response = ActionController::TestResponse.new
   @controller.process(@request, @response)
-end
+end

data/tasks/exceptional_tasks.rake

@@ -2,7 +2,7 @@ namespace :exceptional do
   desc 'Send a test exception to Exceptional.'
   task :test => :environment do
     unless Exceptional::Config.api_key.blank?
-      puts "Sending test exception to Exceptional"
+      puts "Sending test exception to Exceptional."
       require "exceptional/integration/tester"
       Exceptional::Integration.test
       puts "Done."

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: exceptional
 version: !ruby/object:Gem::Version 
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors: 
 - Contrast
@@ -9,19 +9,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-13 00:00:00 +00:00
+date: 2009-12-18 00:00:00 +00:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: json
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.0.0
-    version: 
+dependencies: []
+
 description: Exceptional is the core Ruby library for communicating with http://getexceptional.com (hosted error tracking service). Use it to find out about errors that happen in your live app. It captures lots of helpful information to help you fix the errors.
 email: hello@contrast.ie
 executables: 
@@ -34,8 +25,8 @@ files:
 - lib/exceptional/application_environment.rb
 - lib/exceptional/catcher.rb
 - lib/exceptional/config.rb
+- lib/exceptional/controller_exception_data.rb
 - lib/exceptional/exception_data.rb
-- lib/exceptional/integration/rack.rb
 - lib/exceptional/integration/rails.rb
 - lib/exceptional/integration/tester.rb
 - lib/exceptional/log_factory.rb
@@ -81,8 +72,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version 
       version: "0"
   version: 
-requirements: []
-
+requirements: 
+- json_pure, json-jruby or json gem required
 rubyforge_project: exceptional
 rubygems_version: 1.3.5
 signing_key: 

data/lib/exceptional/integration/rack.rb

@@ -1,14 +0,0 @@
-module Exceptional
-  class Rack
-    def initialize(app, api_key)
-      @app = app
-      @api_key= api_key
-    end
-
-    def call(env)
-      @app.call(env)
-    rescue Exception => e
-      raise e
-    end
-  end
-end