davidjrice-exceptional 0.0.1 → 0.0.2

data/Manifest

@@ -1,4 +1,3 @@
-exceptional.gemspec
 exceptional.yml
 History.txt
 init.rb
@@ -6,7 +5,9 @@ install.rb
 lib/exceptional/agent/worker.rb
 lib/exceptional/deployed_environment.rb
 lib/exceptional/exception_data.rb
+lib/exceptional/integration/merb.rb
 lib/exceptional/integration/rails.rb
+lib/exceptional/merb.rb
 lib/exceptional/rails.rb
 lib/exceptional/version.rb
 lib/exceptional.rb

data/Rakefile

@@ -1,7 +1,7 @@
 begin
   require 'echoe'
  
-  Echoe.new('exceptional', '0.0.1') do |p|
+  Echoe.new('exceptional', '0.0.2') 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)"

data/exceptional.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name     = "exceptional"
-  s.version  = "0.0.1"
+  s.version  = "0.0.2"
   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"
@@ -19,7 +19,9 @@ Gem::Specification.new do |s|
 		"lib/exceptional/agent/worker.rb",
     "lib/exceptional/deployed_environment.rb",
     "lib/exceptional/exception_data.rb",
+    "lib/exceptional/integration/merb.rb",
     "lib/exceptional/integration/rails.rb",
+    "lib/exceptional/merb.rb",
     "lib/exceptional/rails.rb",
     "lib/exceptional/version.rb",
     "lib/exceptional.rb"]
@@ -27,8 +29,8 @@ Gem::Specification.new do |s|
       "spec/exception_data_spec.rb",
       "spec/exceptional_spec.rb",
       "spec/spec_helper.rb",
-      "spec/worker_spec.rbrb"]
+      "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
+end

data/install.rb

@@ -15,4 +15,5 @@ else
   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/"
-end  
+  File.copy example_config_file, config_file
+end

data/lib/exceptional.rb

@@ -1,4 +1,6 @@
 $:.unshift File.dirname(__FILE__)
+require 'exceptional/integration/merb'
+require 'exceptional/merb'
 require 'exceptional/rails'
 require 'exceptional/deployed_environment'
 require 'exceptional/agent/worker'
@@ -95,7 +97,8 @@ module Exceptional
       e.controller_name = controller.controller_name
       e.action_name = controller.action_name
       e.application_root = self.application_root
-      e.occurred_at = Time.now.to_s
+      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
@@ -127,6 +130,45 @@ module Exceptional
       end
     end
     
+    def handle_merb(exception, request, params)
+      log! "Handling #{exception.message}", 'info'
+      e = parse(exception)
+      # Additional data for Merb Exceptions
+      e.framework = "merb"
+      e.controller_name = params['controller']
+      e.action_name = params['action']
+      e.application_root = self.application_root
+      e.occurred_at = Time.now.to_s
+      e.url = "#{request.protocol}#{request.host}#{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 ? params.to_hash : {}
+
+      if mode == :queue
+        worker.add_exception(e)
+      else # :direct mode
+        begin
+          post e
+        rescue
+          log! "Error posting data to Exceptional."
+          log! e.message
+          log! e.backtace.join("\n"), 'debug'
+        end
+      end
+    end
     # TODO these configuration methods & defaults should have their own class
     def remote_host
       @remote_host || ::REMOTE_HOST
@@ -224,4 +266,28 @@ module Exceptional
     
   end
   
+end
+
+# Hack to enable the gem as a Merb plugin.
+if defined?(Merb::Plugins)
+  Merb::BootLoader.after_app_loads do
+    def to_stderr(s)
+      STDERR.puts "** [Exceptional] " + s
+    end
+
+    config_file = File.join(Merb.root,"/config/exceptional.yml")
+    begin 
+      Exceptional.application_root = Merb.root
+      Exceptional.environment = Merb.environment.to_s
+
+      Exceptional.load_config(config_file)
+      if Exceptional.enabled?
+        Exceptional::Merb.init
+      end
+    
+    rescue Exception => e
+      to_stderr e
+      to_stderr "Plugin disabled."
+    end
+  end
 end

data/lib/exceptional/deployed_environment.rb

@@ -80,5 +80,7 @@ module Exceptional
         @identifier = 'passenger'
       end
     end
+    
   end
-end
+end
+

data/lib/exceptional/integration/merb.rb

@@ -0,0 +1,36 @@
+module Exceptional
+  module Integration
+    module Merb
+      def self.included(mod)
+        mod.class_eval do
+          def base
+            self.render_with_exceptional template_or_message, :layout=>false
+          end
+
+          def exception
+            self.render_with_exceptional template_or_message, :layout=>false
+          end
+
+          private
+
+          def template_or_message
+            if File.exists?(Exceptional.application_root / 'app' / 'views' / 'exceptions' / 'internal_server_error.html.erb')
+              :internal_server_error
+            else
+              '500 exception. Please customize this page by creating app/views/exceptions/internal_server_error.html.erb.'
+            end
+          end
+        end
+      end
+      
+      def render_with_exceptional(*opts)
+        self.render_then_call(render(*opts)) { post_to_exceptional }
+      end
+      
+      def post_to_exceptional
+        exception = self.request.exceptions.first
+        Exceptional.handle_merb(exception, request, params)
+      end
+    end
+  end
+end

data/lib/exceptional/merb.rb

@@ -0,0 +1,51 @@
+module Exceptional
+    # TODO this class could really be 'drier', merge with Exceptional::Rails
+    # perhaps create an initializers module.
+    class Merb
+      
+      def self.init
+        # With Merb, we can't determine the deployed environment on boot as that
+        # appears to load after the app & plugins.
+        setup_log
+        Exceptional.log_config_info
+        
+        if Exceptional.authenticate
+        
+          if Exceptional.mode == :queue
+            Exceptional.worker = Agent::Worker.new(Exceptional.log)
+            Exceptional.worker_thread = Thread.new do
+              Exceptional.worker.run
+            end
+          end
+          
+          # Install hook in Merb's Exceptions controller.
+          Exceptions.send(:include, Exceptional::Integration::Merb)
+          
+          at_exit do
+            if Exceptional.mode == :queue         
+              Exceptional.worker_thread.terminate if Exceptional.worker_thread
+            end
+          end
+        else
+          Exceptional.log! "Plugin not authenticated, check your API Key"
+          Exceptional.log! "Disabling Plugin."
+        end        
+      end
+      
+      def self.setup_log
+        log_file = "#{Exceptional.application_root}/log/exceptional.log"
+
+        @log = Logger.new log_file
+        @log.level = Logger::INFO
+
+        allowed_log_levels = ['debug', 'info', 'warn', 'error', 'fatal']
+        if Exceptional.log_level && allowed_log_levels.include?(Exceptional.log_level)
+          @log.level = eval("Logger::#{Exceptional.log_level.upcase}")
+        end
+
+        Exceptional.log = @log
+      end
+      
+    end
+      
+end

data/spec/worker_spec.rb

@@ -0,0 +1,21 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Exceptional::Agent::Worker do 
+  
+  before(:each) do
+    @worker = Exceptional::Agent::Worker.new
+  end
+  
+  describe "after initialisation" do
+    
+    it "should default worker timeout" do
+      @worker.timeout.should == 10
+    end
+  
+    it "should have no exceptions" do
+      @worker.exceptions.should == []
+    end
+    
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: davidjrice-exceptional
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - David Rice
@@ -44,7 +44,9 @@ files:
 - lib/exceptional/agent/worker.rb
 - lib/exceptional/deployed_environment.rb
 - lib/exceptional/exception_data.rb
+- lib/exceptional/integration/merb.rb
 - lib/exceptional/integration/rails.rb
+- lib/exceptional/merb.rb
 - lib/exceptional/rails.rb
 - lib/exceptional/version.rb
 - lib/exceptional.rb
@@ -80,4 +82,4 @@ test_files:
 - spec/exception_data_spec.rb
 - spec/exceptional_spec.rb
 - spec/spec_helper.rb
-- spec/worker_spec.rbrb
+- spec/worker_spec.rb