rackamole 0.0.1 → 0.0.2

data/README.txt

@@ -18,7 +18,10 @@ interactions and leverage these findings for the next iteration of your applicat
 
 == PROJECT INFORMATION
 
-* Developer:  Fernand Galiana [liquidrail.com]
+* Developer:  Fernand Galiana
+* Blog:       liquidrail.com
+* Site:       rackamole.com
+* Twitter:    @rackamole
 * Forum:      http://groups.google.com/group/rackamole
 * Git:        git://github.com/derailed/rackamole.git
 
@@ -55,6 +58,14 @@ interactions and leverage these findings for the next iteration of your applicat
   in the session using the :user_name key. There are other options available, please take a look
   at the docs for more information.
   
+  Given Rails exception handling logic, you can also edit your application_controller.rb file and
+  include the mole interceptor to trap exceptions in production environment
+  
+  class ApplicationController
+    include Rackamole::Interceptor
+
+  This will instruct the mole to trap the raised exception from your rails stack.
+  
 === Sinatra Applications
 
   Add the following lines in the config section and smoke it...

data/lib/rackamole.rb

@@ -1,7 +1,7 @@
 module Rackamole
 
   # :stopdoc:
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
   LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
   PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
   # :startdoc:

data/lib/rackamole/interceptor.rb

@@ -6,9 +6,17 @@ module Rackamole
     # ie include Wackamole::Interceptor
     def self.included( base )
       base.send( :alias_method_chain, :rescue_action_in_public, :mole )
+      base.send( :alias_method_chain, :rescue_action_locally, :mole )
     end
     
     private
+
+      # Instructs the mole to trap the framework exception
+      def rescue_action_locally_with_mole( exception )
+        # Stuff the exception in the env for mole rack retrieval
+        request.env['mole.exception'] = exception
+        rescue_action_locally_without_mole( exception )
+      end
           
       # Instructs the mole to trap the framework exception
       def rescue_action_in_public_with_mole( exception )

data/lib/rackamole/mole.rb

@@ -17,16 +17,22 @@ module Rack
       init_options( opts )
     end
             
-    def call( env )      
+    def call( env )
       # Bail if application is not moleable
       return @app.call( env ) unless moleable?
-      
-      response = nil
+            
+      status, headers, body = nil
       elapsed = Hitimes::Interval.measure do
-        response = @app.call( env )
+        begin
+          status, headers, body = @app.call( env )
+        rescue => boom
+          env['mole.exception'] = boom
+          @store.mole( mole_info( env, elapsed, status, headers, body ) )
+          raise boom
+        end
       end
-      @store.mole( mole_info( env, elapsed ) )
-      response
+      @store.mole( mole_info( env, elapsed, status, headers, body ) )
+      return status, headers, body
     end 
 
   # ===========================================================================  
@@ -34,31 +40,45 @@ module Rack
        
     # Load up configuration options
     def init_options( opts )
-      options         = default_options.merge( opts )      
-      @environment    = options[:environment]
-      @perf_threshold = options[:perf_threshold]
-      @moleable       = options[:moleable]
-      @app_name       = options[:app_name]
-      @user_key       = options[:user_key]
-      @store          = options[:store]      
+      options          = default_options.merge( opts )      
+      @environment     = options[:environment]
+      @perf_threshold  = options[:perf_threshold]
+      @moleable        = options[:moleable]
+      @app_name        = options[:app_name]
+      @user_key        = options[:user_key]
+      @store           = options[:store]
+      @excluded_paths  = options[:excluded_paths]
     end
     
     # Mole default options
     def default_options
       { 
-        :app_name       =>  "Moled App",
-        :moleable       =>  true,
-        :perf_threshold =>  10,
-        :store          =>  Rackamole::Store::Log.new
+        :app_name        =>  "Moled App",
+        :excluded_paths  =>  [/.?\.ico/, /.?\.png/],
+        :moleable        =>  true,
+        :perf_threshold  =>  10,
+        :store           =>  Rackamole::Store::Log.new
       }
     end
-               
+       
+    # Check if this request should be moled according to the exclude filters        
+    def mole_request?( request )
+      @excluded_paths.each do |exclude_path|
+        return false if request.path.match( exclude_path )
+      end
+      true
+    end
+    
     # Extract interesting information from the request
-    def mole_info( env, elapsed )      
-      request     = Rack::Request.new( env )
+    def mole_info( env, elapsed, status, headers, body )      
+      request = Rack::Request.new( env )
+      info    = OrderedHash.new
+            
+      return info unless mole_request?( request )
+                        
       session     = env['rack.session']      
       route       = get_route( request )
-      info        = OrderedHash.new
+
       ip, browser = identify( env )
       user_id     = nil
       user_name   = nil
@@ -105,9 +125,11 @@ module Rack
         info[:ruby_version]   = %x[ruby -v]
         info[:stack]          = trim_stack( exception )
         env['mole.exception'] = nil
-      end
-      
+      end      
       info
+    rescue => boom
+      $stderr.puts "!! MOLE RECORDING CRAPPED OUT !! -- #{boom}"
+      boom.backtrace.each { |l| $stderr.puts l }
     end
         
     # Trim stack trace
@@ -128,7 +150,7 @@ module Rack
     # Fetch route info if any...
     def get_route( request )
       return nil unless defined?( RAILS_ENV )      
-      ::ActionController::Routing::Routes.recognize_path( request.path, {:method => request.request_method } )
+      ::ActionController::Routing::Routes.recognize_path( request.path, {:method => request.request_method.downcase.to_sym } )
     end
   end
 end

data/lib/rackamole/store/log.rb

@@ -9,6 +9,8 @@ module Rackamole
       
       # Dump mole info to logger
       def mole( args )
+        return if args.empty?
+        
         if args[:stack]
           display_head "MOLED EXCEPTION" 
         elsif args[:performance]

data/lib/rackamole/store/mongo.rb

@@ -5,12 +5,15 @@ include Mongo
 # TODO !! Need to deal with auth
 module Rackamole
   module Store
-    # Mongo adapter. Stores mole info in a mongo database
+    # Mongo adapter. Stores mole info in a mongo database.
+    # Two collections are available namely features and logs. Logs references
+    # the features collection.
     class Mongo          
       
       attr_reader :connection
       
-      def initialize( opts )
+      def initialize( options )
+        opts = default_options.merge( options )
         @connection = Connection.new( opts[:hostname], opts[:port] ).db( opts[:database] )  
       end
       
@@ -22,6 +25,8 @@ module Rackamole
       
       # Dump mole info to logger
       def mole( args )
+        return if args.empty?
+        
         feature = find_or_create_feature( args )
         log_feature( feature, args )
       rescue => mole_boom
@@ -29,17 +34,29 @@ module Rackamole
         $stderr.puts mole_boom.backtrace.join( "\n   " )        
       end
 
+      # Convenience to access mole features cltn
       def features
         @features ||= @connection['features']
       end
       
+      # Convenience to access mole log cltn
       def logs
         @logs ||= @connection['logs']
       end
 
       # =======================================================================
       private
-              
+        
+        # Set up mongo default options ie localhost host, default mongo port and
+        # the database being mole_mdb      
+        def default_options
+          {
+             :host     => 'localhost',
+             :port     => 77926,
+             :database => 'mole_mdb'
+          }
+        end
+        
         # retrieves a feature if exists or create a new one otherwise
         def find_or_create_feature( args )
           if args[:route_info]
@@ -88,7 +105,7 @@ module Rackamole
           
           row = {
             :type        => type,
-            :feature     => ::DBRef.new( 'features', feature ),
+            :feature     => ::DBRef.new( 'features', feature.instance_of?( ObjectID ) ? feature : feature['_id'] ),
             :created_at  => Time.now,
             :updated_at  => Time.now
           }

data/samples/rails/moled/app/controllers/application_controller.rb

@@ -1,4 +1,6 @@
 class ApplicationController < ActionController::Base
+  include Rackamole::Interceptor
+  
   helper :all # include all helpers, all the time
   protect_from_forgery # See ActionController::RequestForgeryProtection for details
 
@@ -10,4 +12,10 @@ class ApplicationController < ActionController::Base
   def setup
     session[:user_name] = "Fernand"
   end
+  
+  protected
+  
+     def local_request?
+       return false
+     end
 end

data/samples/rails/moled/app/controllers/fred_controller.rb

@@ -1,4 +1,13 @@
 class FredController < ApplicationController
   def index
+    session[:fred] = 'hello'
+  end
+  
+  def edit
+    raise 'Oh snap!'
+  end
+  
+  def show
+    @id = params[:id]
   end
 end

data/samples/rails/moled/app/views/fred/show.html.erb

@@ -0,0 +1 @@
+<h1>Hello <%=@id%></h1>

data/samples/rails/moled/config/routes.rb

@@ -1,43 +1,6 @@
 ActionController::Routing::Routes.draw do |map|
-  # The priority is based upon order of creation: first created -> highest priority.
+  map.resources :fred
 
-  # Sample of regular route:
-  #   map.connect 'products/:id', :controller => 'catalog', :action => 'view'
-  # Keep in mind you can assign values other than :controller and :action
-
-  # Sample of named route:
-  #   map.purchase 'products/:id/purchase', :controller => 'catalog', :action => 'purchase'
-  # This route can be invoked with purchase_url(:id => product.id)
-
-  # Sample resource route (maps HTTP verbs to controller actions automatically):
-  #   map.resources :products
-
-  # Sample resource route with options:
-  #   map.resources :products, :member => { :short => :get, :toggle => :post }, :collection => { :sold => :get }
-
-  # Sample resource route with sub-resources:
-  #   map.resources :products, :has_many => [ :comments, :sales ], :has_one => :seller
-  
-  # Sample resource route with more complex sub-resources
-  #   map.resources :products do |products|
-  #     products.resources :comments
-  #     products.resources :sales, :collection => { :recent => :get }
-  #   end
-
-  # Sample resource route within a namespace:
-  #   map.namespace :admin do |admin|
-  #     # Directs /admin/products/* to Admin::ProductsController (app/controllers/admin/products_controller.rb)
-  #     admin.resources :products
-  #   end
-
-  # You can have the root of your site routed with map.root -- just remember to delete public/index.html.
-  # map.root :controller => "welcome"
-
-  # See how all your routes lay out with "rake routes"
-
-  # Install the default routes as the lowest priority.
-  # Note: These default routes make all actions in every controller accessible via GET requests. You should
-  # consider removing the them or commenting them out if you're using named routes and resources.
   map.connect ':controller/:action/:id'
   map.connect ':controller/:action/:id.:format'
 end

data/samples/rails/moled/log/development.log

@@ -28,3 +28,53 @@ Completed in 113ms (View: 4, DB: 0) | 200 OK [http://localhost/fred]
 Processing FredController#index (for 127.0.0.1 at 2009-11-14 01:18:26) [GET]
 Rendering fred/index
 Completed in 6ms (View: 4, DB: 0) | 200 OK [http://localhost/fred]
+
+
+Processing FredController#index (for 127.0.0.1 at 2009-11-15 11:36:33) [GET]
+Rendering fred/index
+Completed in 120ms (View: 4, DB: 0) | 200 OK [http://localhost/fred]
+
+
+Processing FredController#show (for 127.0.0.1 at 2009-11-15 11:36:59) [GET]
+  Parameters: {"id"=>"list"}
+Rendering fred/show
+Completed in 4ms (View: 2, DB: 0) | 200 OK [http://localhost/fred/list]
+
+
+Processing FredController#edit (for 127.0.0.1 at 2009-11-15 11:38:36) [GET]
+  Parameters: {"id"=>"10"}
+
+RuntimeError (Oh snap!):
+  app/controllers/fred_controller.rb:7:in `edit'
+
+Rendered rescues/_trace (27.9ms)
+Rendered rescues/_request_and_response (1.2ms)
+Rendering rescues/layout (internal_server_error)
+
+
+Processing FredController#edit (for 127.0.0.1 at 2009-11-15 11:44:54) [GET]
+  Parameters: {"id"=>"10"}
+
+RuntimeError (Oh snap!):
+  app/controllers/fred_controller.rb:7:in `edit'
+
+Rendered rescues/_trace (29.1ms)
+Rendered rescues/_request_and_response (1.2ms)
+Rendering rescues/layout (internal_server_error)
+
+
+Processing FredController#edit (for 127.0.0.1 at 2009-11-15 11:53:40) [GET]
+  Parameters: {"id"=>"10"}
+
+RuntimeError (Oh snap!):
+  app/controllers/fred_controller.rb:7:in `edit'
+
+Rendered rescues/_trace (28.4ms)
+Rendered rescues/_request_and_response (1.3ms)
+Rendering rescues/layout (internal_server_error)
+
+
+Processing FredController#show (for 127.0.0.1 at 2009-11-15 11:54:08) [GET]
+  Parameters: {"id"=>"10"}
+Rendering fred/show
+Completed in 7ms (View: 6, DB: 0) | 200 OK [http://localhost/fred/10]

data/samples/rails/moled/log/production.log

@@ -0,0 +1,36 @@
+
+
+Processing FredController#edit (for 127.0.0.1 at 2009-11-15 11:39:29) [GET]
+  Parameters: {"id"=>"10"}
+
+RuntimeError (Oh snap!):
+  app/controllers/fred_controller.rb:7:in `edit'
+
+Rendering rescues/layout (internal_server_error)
+
+
+Processing FredController#edit (for 127.0.0.1 at 2009-11-15 11:40:41) [GET]
+  Parameters: {"id"=>"10"}
+
+RuntimeError (Oh snap!):
+  app/controllers/fred_controller.rb:7:in `edit'
+
+Rendering /Users/fgaliana/work/git/rackamole/samples/rails/moled/public/500.html (500 Internal Server Error)
+
+
+Processing FredController#edit (for 127.0.0.1 at 2009-11-15 11:41:39) [GET]
+  Parameters: {"id"=>"10"}
+
+RuntimeError (Oh snap!):
+  app/controllers/fred_controller.rb:7:in `edit'
+
+Rendering /Users/fgaliana/work/git/rackamole/samples/rails/moled/public/500.html (500 Internal Server Error)
+
+
+Processing FredController#edit (for 127.0.0.1 at 2009-11-15 11:43:03) [GET]
+  Parameters: {"id"=>"10"}
+
+RuntimeError (Oh snap!):
+  app/controllers/fred_controller.rb:7:in `edit'
+
+Rendering /Users/fgaliana/work/git/rackamole/samples/rails/moled/public/500.html (500 Internal Server Error)

data/samples/sinatra/blee.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'sinatra'
+require 'forwardable'
+
+get '/' do
+  'Hello world!'
+end

data/samples/sinatra/moled.rb

@@ -13,8 +13,23 @@ before do
   session[:user_name] = "Fernand"
 end
 
-get '/fred' do  
-  @blee = "No shit"
+get '/normal' do  
+  @blee = "Snap!!"
   session[:fred] = "duh me"
-  "<h1>Hello World</h1>"
+  erb :normal
+end
+
+get '/params/:id' do  
+  @blee = params[:id]
+  session[:fred] = "duh me"
+  erb :params
+end
+
+get '/error' do
+  raise "Oh Shit!!"
+end
+
+get '/slow' do
+  sleep 10
+  '<h1> I am the slow one...</h1>'
 end

data/samples/sinatra/views/normal.erb

@@ -0,0 +1 @@
+<h1>Normal -- <%=@blee%></h1>

data/samples/sinatra/views/params.erb

@@ -0,0 +1 @@
+<h1>Params -- <%=@blee%></h1>

data/spec/rackamole/interceptor_spec.rb

@@ -6,6 +6,9 @@ describe Rackamole::Interceptor do
     class Fred
       def rescue_action_in_public( exception )
       end
+
+      def rescue_action_locally( exception )
+      end
     
       def request
         @request ||= OpenStruct.new( :env => {} )
@@ -20,10 +23,19 @@ describe Rackamole::Interceptor do
     end
   end
     
-  it "should include the correct methods" do    
+  it "should include the correct methods" do
+    Fred.instance_methods.should be_include( 'rescue_action_locally_without_mole' )    
+    Fred.private_instance_methods.should be_include( 'rescue_action_locally_with_mole' )
+    
     Fred.instance_methods.should be_include( 'rescue_action_in_public_without_mole' )    
     Fred.private_instance_methods.should be_include( 'rescue_action_in_public_with_mole' )
   end
+
+  it "should set the env correctly when a local exception is raised" do
+    fred = Fred.new
+    fred.send( :rescue_action_locally, "Fred" )
+    fred.request.env['mole.exception'].should == "Fred"
+  end
     
   it "should set the env correctly when an exception is raised" do
     fred = Fred.new

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rackamole
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Fernand Galiana
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-14 00:00:00 -07:00
+date: 2009-11-15 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -96,6 +96,7 @@ files:
 - samples/rails/moled/app/controllers/fred_controller.rb
 - samples/rails/moled/app/helpers/application_helper.rb
 - samples/rails/moled/app/views/fred/index.html.erb
+- samples/rails/moled/app/views/fred/show.html.erb
 - samples/rails/moled/config/boot.rb
 - samples/rails/moled/config/database.yml
 - samples/rails/moled/config/environment.rb
@@ -110,6 +111,7 @@ files:
 - samples/rails/moled/config/locales/en.yml
 - samples/rails/moled/config/routes.rb
 - samples/rails/moled/db/development.sqlite3
+- samples/rails/moled/db/production.sqlite3
 - samples/rails/moled/doc/README_FOR_APP
 - samples/rails/moled/log/development.log
 - samples/rails/moled/log/production.log
@@ -139,7 +141,10 @@ files:
 - samples/rails/moled/script/server
 - samples/rails/moled/test/performance/browsing_test.rb
 - samples/rails/moled/test/test_helper.rb
+- samples/sinatra/blee.rb
 - samples/sinatra/moled.rb
+- samples/sinatra/views/normal.erb
+- samples/sinatra/views/params.erb
 - spec/expected_results/mole_exception.log
 - spec/expected_results/mole_feature.log
 - spec/expected_results/mole_perf.log