exceptional 2.0.5 → 2.0.6

data/bin/exceptional

@@ -12,25 +12,35 @@ 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."
-    require(File.join('config', 'boot'))
-    require(File.join(RAILS_ROOT, 'config', 'environment'))
-    require "exceptional/integration/tester"
-    unless Exceptional::Config.api_key.blank?
+    if defined?(RAILS_ROOT)
+      puts "Loading Rails environment."
+      require(File.join('config', 'boot'))
+      require(File.join(RAILS_ROOT, 'config', 'environment')) if defined?(RAILS_ROOT)
+      require "exceptional/integration/tester"
+    else 
+      require 'json'
+      require 'exceptional'    
+      require "exceptional/integration/tester"      
+      Exceptional::Config.load('config/exceptional.yml')
+    end    
+    unless Exceptional::Config.api_key.empty?
       Exceptional::Integration.test
-    end
+    else
+      puts 'API key not configured'
+    end 
   when 'install'
     api_key = args[0]
     if (api_key.nil?)
       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."
+      if (defined?(RAILS_ROOT) && !File.file?('config/environment.rb'))
+        puts "Run this command from the root of your rails application." and return
       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."
+        Dir.mkdir('config') unless File.exists?('config')        
       end
-    end
+    end        
+    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."
 end

data/exceptional.gemspec

@@ -1,10 +1,10 @@
 # -*- encoding: utf-8 -*-
 Gem::Specification.new do |s|
   s.name = %q{exceptional}
-  s.version = "2.0.5"
+  s.version = "2.0.6"
   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.}
+  s.summary = %q{ getexceptional.com is a hosted service for tracking errors in your Ruby/Rails/Rack apps }
+  s.description = %q{Exceptional is the Ruby gem 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.}
   s.email = %q{hello@contrast.ie}
   s.files =  Dir['lib/**/*'] + Dir['spec/**/*'] + Dir['spec/**/*'] + Dir['rails/**/*'] + Dir['tasks/**/*'] + Dir['*.rb'] + ["exceptional.gemspec"]
   s.homepage = %q{http://getexceptional.com/}

data/lib/exceptional.rb

@@ -7,12 +7,15 @@ require 'exceptional/config'
 require 'exceptional/application_environment'
 require 'exceptional/exception_data'
 require 'exceptional/controller_exception_data'
+require 'exceptional/rack_exception_data'
 require 'exceptional/remote'
+require 'exceptional/integration/rack'
 
 module Exceptional
+
   PROTOCOL_VERSION = 5
-  VERSION = '2.0.3'
-  CLIENT_NAME = 'getexceptional-rails-plugin'
+  VERSION = '2.0.6'
+  CLIENT_NAME = 'getexceptional-gem'
 
   def self.logger
     ::Exceptional::LogFactory.logger

data/lib/exceptional/application_environment.rb

@@ -2,8 +2,8 @@ require 'digest/md5'
 
 module Exceptional
   class ApplicationEnvironment
-    def self.to_hash
-      hash = {
+    def self.to_hash(framework)
+      {
         'client' => {
           'name' => Exceptional::CLIENT_NAME,
           'version' => Exceptional::VERSION,
@@ -21,11 +21,6 @@ module Exceptional
           'libraries_loaded' => libraries_loaded
         }
       }
-      hash
-    end
-
-    def self.framework
-      defined?(RAILS_ENV) ? "rails" : nil
     end
 
     def self.environment

data/lib/exceptional/catcher.rb

@@ -7,6 +7,13 @@ module Exceptional
           Remote.error(data)
         end
       end
+      
+      def handle_with_rack(exception, environment, request) 
+        if Config.should_send_to_api?
+          data = RackExceptionData.new(exception, environment, request)
+          Remote.error(data)
+        end
+      end
 
       def handle(exception, name=nil)
         if Config.should_send_to_api?
@@ -16,4 +23,4 @@ module Exceptional
       end
     end
   end
-end
+end

data/lib/exceptional/controller_exception_data.rb

@@ -8,6 +8,10 @@ module Exceptional
       @controller = controller
     end
 
+    def framework
+      "rails"
+    end
+
     def extra_stuff
       return {} if @request.nil?
       {

data/lib/exceptional/exception_data.rb

@@ -8,7 +8,7 @@ module Exceptional
     end
 
     def to_hash
-      hash = ::Exceptional::ApplicationEnvironment.to_hash
+      hash = ::Exceptional::ApplicationEnvironment.to_hash(framework)
       hash.merge!({
         'exception' => {
           'exception_class' => @exception.class.to_s,
@@ -43,6 +43,10 @@ module Exceptional
         end
       end
     end
+    
+    def framework
+      nil
+    end    
 
     def uniqueness_hash
       return nil if (@exception.backtrace.nil? || @exception.backtrace.empty?)

data/lib/exceptional/integration/rack.rb

@@ -0,0 +1,21 @@
+require 'rubygems'
+require 'rack'
+
+module Rack  
+  class Exceptional    
+
+    def initialize(app, exceptional_config = "config/exceptional.yml")
+      @app = app
+      ::Exceptional::Config.load(exceptional_config)
+    end    
+    
+    def call(env)
+      begin
+        status, headers, body =  @app.call(env)
+      rescue Exception => e
+        ::Exceptional::Catcher.handle_with_rack(e,env, Rack::Request.new(env))
+        raise(e)
+      end
+    end
+  end
+end

data/lib/exceptional/rack_exception_data.rb

@@ -0,0 +1,29 @@
+require 'digest/md5'
+
+module Exceptional
+  class RackExceptionData < ExceptionData
+    def initialize(exception, environment, request)
+      super(exception)
+      @environment = environment
+      @request = request
+    end
+
+    def framework
+      "rack"
+    end
+
+    def extra_stuff
+      return {} if @request.nil?
+      {
+        'request' => {
+          'url' => "#{@request.url}",
+          'parameters' => @request.params,
+          'request_method' => @request.request_method.to_s,
+          'remote_ip' => @request.ip,
+          'headers' => @environment.reject{|k,v| !k.match(/^HTTP_/)},
+          'session' => @request.session
+        }
+      }
+    end
+  end
+end

data/lib/exceptional/remote.rb

@@ -37,10 +37,10 @@ module Exceptional
           response = client.post(url, data)
           case response
             when Net::HTTPSuccess
-              Exceptional.logger.info('Successful')
+              Exceptional.logger.info( "#{url} Successful")
               return true
             else
-              Exceptional.logger.error('Failed')
+              Exceptional.logger.error("#{url} - #{response.code} - Failed")
           end
         rescue Exception => e
           Exceptional.logger.error('Problem notifying Exceptional about the error')

data/lib/exceptional/startup.rb

@@ -7,7 +7,7 @@ module Exceptional
         if Config.api_key.blank?
           raise StartupException, 'API Key must be configured (/config/exceptional.yml)'
         end
-        Remote.startup_announce(::Exceptional::ApplicationEnvironment.to_hash)
+        Remote.startup_announce(::Exceptional::ApplicationEnvironment.to_hash('rails'))
       end
     end
   end

data/spec/exceptional/exception_data_spec.rb

@@ -118,6 +118,7 @@ describe Exceptional::ControllerExceptionData, 'with request/controller/params'
         @session_id = '123'
       end
     end
+    
     request = ActionController::TestRequest.new
     session = SessionWithInstanceVariables.new
     request.stub!(:session).and_return(session)
@@ -159,4 +160,6 @@ describe Exceptional::ControllerExceptionData, 'with request/controller/params'
     data = Exceptional::ControllerExceptionData.new(myException)
     data.uniqueness_hash.should == nil
   end
+  
+  
 end

data/spec/exceptional/rack_exception_data_spec.rb

@@ -0,0 +1,87 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require 'digest/md5'
+
+describe Exceptional::RackExceptionData do
+
+  class Exceptional::FunkyError < StandardError
+    def backtrace
+      'backtrace'
+    end
+  end
+
+  before :each do
+    app = lambda { |env| [200, {'Content-Type'=>'text/plain'}, 'Hello World']}     
+        
+    @env = {
+      "HTTP_HOST" =>"localhost:9292",
+      "HTTP_ACCEPT" =>"*/*",
+      "SERVER_NAME" =>"localhost",
+      "REQUEST_PATH" =>"/",
+      "rack.url_scheme" =>"http",
+      "HTTP_USER_AGENT" =>"curl/7.19.6 (i386-apple-darwin9.8.0) libcurl/7.19.6 zlib/1.2.3",
+      "REMOTE_HOST" =>"testing.com",
+      "rack.errors" => StringIO.new,
+      "SERVER_PROTOCOL" =>"HTTP/1.1",
+      "rack.version" =>[1, 1],
+      "rack.run_once" =>false,
+      "SERVER_SOFTWARE" =>"WEBrick/1.3.1 (Ruby/1.8.7/2009-06-12)",
+      "REMOTE_ADDR" =>"127.0.0.1",
+      "PATH_INFO" => "/",
+      "SCRIPT_NAME" =>"",
+      "HTTP_VERSION" =>"HTTP/1.1",
+      "rack.multithread" =>true,
+      "rack.multiprocess" =>false,
+      "REQUEST_URI" =>"http://localhost:9292/",
+      "SERVER_PORT" =>"9292",
+      "REQUEST_METHOD" =>"GET",
+      "rack.input" => StringIO.new,
+      "QUERY_STRING" =>"cockle=shell&bay=cool",
+      "GATEWAY_INTERFACE" =>"CGI/1.1"
+    }
+                        
+    error = Exceptional::FunkyError.new('some message')
+    request = Rack::Request.new(@env)
+    @data = Exceptional::RackExceptionData.new(error, @env, request)
+  end
+  
+  it "capture exception details" do    
+    error_hash = @data.to_hash['exception']
+    error_hash['exception_class'].should == 'Exceptional::FunkyError'
+    error_hash['message'].should == 'some message'
+    error_hash['backtrace'].should == 'backtrace'
+    error_hash['occurred_at'].should == Time.now.strftime("%Y%m%d %H:%M:%S %Z")
+  end
+
+  it "should capture request details" do
+    request_hash = @data.to_hash['request']
+    request_hash['url'].should == 'http://localhost:9292/?cockle=shell&bay=cool'
+    request_hash['parameters'].should == {"cockle"=>"shell", "bay"=>"cool"} 
+    request_hash['request_method'].should == 'GET'
+    request_hash['remote_ip'].should == '127.0.0.1'
+    request_hash['headers'].should == {"HTTP_HOST"=>"localhost:9292", "HTTP_ACCEPT"=>"*/*", "HTTP_USER_AGENT"=>"curl/7.19.6 (i386-apple-darwin9.8.0) libcurl/7.19.6 zlib/1.2.3", "HTTP_VERSION"=>"HTTP/1.1"}
+    request_hash['session'].should == {}
+  end
+
+  it "should capture client detais" do
+    client_hash = @data.to_hash['client']
+    client_hash['name'].should == Exceptional::CLIENT_NAME
+    client_hash['version'].should == Exceptional::VERSION
+    client_hash['protocol_version'].should == Exceptional::PROTOCOL_VERSION
+  end
+  
+  it "should captire application environment" do
+    env_hash = @data.to_hash['application_environment']
+    env_hash['env'].should_not be_empty #execution dependent
+    env_hash['libraries_loaded'].should_not be_empty #execution dependent
+    env_hash['language'].should == 'ruby' #execution dependent
+    
+    env_hash['language_version'].should_not be_empty #execution dependent
+    env_hash['environment'].should == 'test'
+    env_hash['application_root_directory'].should_not be_empty
+    env_hash['run_as_user'].should_not be_empty
+    env_hash['host'].should_not be_empty
+    
+    env_hash['framework'].should == 'rack'
+  end
+  
+end

data/spec/rack_integration_spec.rb

@@ -0,0 +1,21 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require 'rack/mock'
+
+class ExceptionalTestError < StandardError
+end
+
+describe Rack::Exceptional do
+    
+  before(:each) do 
+    Exceptional::Config.should_receive(:load)
+    @error = ExceptionalTestError.new
+    @app = lambda { |env| raise @error, 'Whoops!' }
+    @env = env = Rack::MockRequest.env_for("/foo")      
+  end
+  
+  it 're-raises errors caught in the middleware' do       
+    rr = Rack::Exceptional.new(@app)        
+    Exceptional::Catcher.should_receive(:handle_with_rack)
+    lambda { rr.call(@env)}.should raise_error(ExceptionalTestError)    
+  end
+end

data/spec/rails_integration_spec.rb

@@ -3,7 +3,7 @@ require File.join(File.dirname(__FILE__), '..', 'lib', 'exceptional', 'integrati
 
 describe Exceptional, 'version number' do
   it "be available proramatically" do
-    Exceptional::VERSION.should == '2.0.3'
+    Exceptional::VERSION.should == '2.0.6'
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: exceptional
 version: !ruby/object:Gem::Version 
-  version: 2.0.5
+  version: 2.0.6
 platform: ruby
 authors: 
 - Contrast
@@ -9,11 +9,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-12 00:00:00 +00:00
+date: 2010-01-26 00:00:00 +00:00
 default_executable: 
 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.
+description: Exceptional is the Ruby gem 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: 
 - exceptional
@@ -27,9 +27,11 @@ files:
 - 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
+- lib/exceptional/rack_exception_data.rb
 - lib/exceptional/remote.rb
 - lib/exceptional/startup.rb
 - lib/exceptional.rb
@@ -37,12 +39,14 @@ files:
 - spec/exceptional/catcher_spec.rb
 - spec/exceptional/config_spec.rb
 - spec/exceptional/exception_data_spec.rb
+- spec/exceptional/rack_exception_data_spec.rb
 - spec/exceptional/remote_spec.rb
 - spec/exceptional/startup_spec.rb
 - spec/exceptional_rescue_spec.rb
 - spec/fixtures/exceptional.yml
 - spec/fixtures/exceptional_old.yml
 - spec/ginger_scenarios.rb
+- spec/rack_integration_spec.rb
 - spec/rails_integration_spec.rb
 - spec/spec_helper.rb
 - spec/standalone_spec.rb
@@ -78,6 +82,6 @@ rubyforge_project: exceptional
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: Exceptional is the core Ruby library for communicating with http://getexceptional.com (hosted error tracking service)
+summary: getexceptional.com is a hosted service for tracking errors in your Ruby/Rails/Rack apps
 test_files: []