rackamole 0.0.4 → 0.0.6

data/{README.txt → README.rdoc}

@@ -19,9 +19,9 @@ interactions and leverage these findings for the next iteration of your applicat
 == PROJECT INFORMATION
 
 * Developer:  Fernand Galiana
-* Blog:       liquidrail.com
-* Site:       rackamole.com
-* Twitter:    @rackamole
+* Blog:       http://www.liquidrail.com
+* Site:       http://rackamole.com
+* Twitter:    https://twitter.com/rackamole
 * Forum:      http://groups.google.com/group/rackamole
 * Git:        git://github.com/derailed/rackamole.git
 

data/Rakefile

@@ -19,10 +19,13 @@ PROJ.authors         = 'Fernand Galiana'
 PROJ.email           = 'fernand.galiana@gmail.com'
 PROJ.url             = 'http://rackamole.liquidrail.com'
 PROJ.version         = Rackamole::VERSION
-PROJ.spec.opts      << '--color'
+PROJ.spec.opts       << '--color'
 PROJ.ruby_opts       = %w[-W0]
+PROJ.readme          = 'README.rdoc'
+PROJ.rcov.opts       = ["--sort", "coverage", "-T", '-x mongo']
 
 # Dependencies
 depend_on "logging"      , ">= 1.2.2"
 depend_on "hitimes"      , ">= 1.0.3"
-depend_on "mongodb-mongo", ">= 0.14.1"
+depend_on "mongo"        , ">= 0.17.1"
+depend_on "darkfish-rdoc", ">= 1.1.5"

data/lib/rackamole/mole.rb

@@ -1,6 +1,6 @@
 require 'hitimes'
-require 'mongo/util/ordered_hash'
 require 'json'
+require 'mongo'
 
 module Rack
   class Mole
@@ -81,33 +81,33 @@ module Rack
       session     = env['rack.session']      
       route       = get_route( request )
 
-      ip, browser = identify( env )
-      user_id     = nil
-      user_name   = nil
+      ip, user_agent = identify( env )
+      user_id        = nil
+      user_name      = nil
            
       # BOZO !! This could be slow if have to query db to get user name...
       # Preferred store username in session and give at key
       if session and @user_key
-        if @user_key.instance_of? Symbol
-          user_name = session[@user_key]
-        elsif @user_key.instance_of? Hash
+        if @user_key.instance_of? Hash
           user_id  = session[ @user_key[:session_key] ]
           if @user_key[:extractor]
             user_name = @user_key[:extractor].call( user_id )
           end
+        else
+          user_name = session[@user_key]
         end
       end
             
       info[:app_name]     = @app_name
-      info[:environment]  = @environment if @environment
+      info[:environment]  = @environment || "Unknown"
       info[:user_id]      = user_id      if user_id
       info[:user_name]    = user_name || "Unknown"
       info[:ip]           = ip
-      info[:browser]      = browser
+      info[:browser]      = id_browser( user_agent )
       info[:host]         = env['SERVER_NAME']
       info[:software]     = env['SERVER_SOFTWARE']
       info[:request_time] = elapsed if elapsed
-      info[:perf_issue]   = (elapsed and elapsed > @perf_threshold)
+      info[:performance]  = (elapsed and elapsed > @perf_threshold)
       info[:url]          = request.url
       info[:method]       = env['REQUEST_METHOD']
       info[:path]         = request.path
@@ -138,6 +138,18 @@ module Rack
       boom.backtrace.each { |l| $stderr.puts l }
     end
         
+    # Attempts to detect browser type from agent info.
+    # BOZO !! Probably more efficient way to do this...
+    def browser_types() @browsers ||= [ 'Firefox', 'Safari', 'MSIE 8.0', 'MSIE 7.0', 'MSIE 6.0', 'Opera', 'Chrome' ] end
+      
+    def id_browser( user_agent )
+      return "N/A" if !user_agent or user_agent.empty?
+      browser_types.each do |b|
+        return b if user_agent.match( /.*?#{b.gsub(/\./,'\.')}.*?/ )
+      end
+      "N/A"
+    end
+    
     # Trim stack trace
     def trim_stack( boom )
       boom.backtrace[0...4]
@@ -155,23 +167,29 @@ 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.downcase.to_sym } )
+      return nil unless defined?( RAILS_ENV )
+      
+      # Check for invalid route exception...
+      begin
+        return ::ActionController::Routing::Routes.recognize_path( request.path, {:method => request.request_method.downcase.to_sym } )
+      rescue
+        return nil
+      end
     end
     
     # Dump env to stdout
-    def dump( env, level=0 )
-      env.keys.sort{ |a,b| a.to_s <=> b.to_s }.each do |k|
-        value = env[k]
-        if value.respond_to?(:each_pair) 
-          puts "%s %-#{40-level}s" % ['  '*level,k]
-          dump( env[k], level+1 )
-        elsif value.instance_of?(::ActionController::Request) or value.instance_of?(::ActionController::Response) 
-          puts "%s %-#{40-level}s %s" % [ '  '*level, k, value.class ]
-        else
-          puts "%s %-#{40-level}s %s" % [ '  '*level, k, value.inspect ]
-        end        
-      end
-    end
+    # def dump( env, level=0 )
+    #   env.keys.sort{ |a,b| a.to_s <=> b.to_s }.each do |k|
+    #     value = env[k]
+    #     if value.respond_to?(:each_pair) 
+    #       puts "%s %-#{40-level}s" % ['  '*level,k]
+    #       dump( env[k], level+1 )
+    #     elsif value.instance_of?(::ActionController::Request) or value.instance_of?(::ActionController::Response) 
+    #       puts "%s %-#{40-level}s %s" % [ '  '*level, k, value.class ]
+    #     else
+    #       puts "%s %-#{40-level}s %s" % [ '  '*level, k, value.inspect ]
+    #     end        
+    #   end
+    # end
   end
 end

data/lib/rackamole/store/mongo_db.rb

@@ -0,0 +1,139 @@
+require 'mongo'
+
+# TODO !! Need to deal with auth
+# BOZO !! Deal with indexes here ?
+module Rackamole
+  module Store
+    # Mongo adapter. Stores mole info in a mongo database.
+    class MongoDb
+      
+      attr_reader :database, :logs, :features
+      
+      # Defines the various feature types
+      FEATURE     = 0
+      PERFORMANCE = 1
+      EXCEPTION   = 2
+      
+      def initialize( options={} )
+        opts = default_options.merge( options )
+        init_mongo( opts )
+      end
+      
+      # clear out db content ( used in testing... )
+      def reset!
+        logs.remove
+        features.remove
+      end
+      
+      # Dump mole info to logger
+      def mole( arguments )
+        return if arguments.empty?       
+        
+        # get a dup of the args since will mock with the original
+        args = arguments.clone
+
+        # dump request info to mongo
+        save_log( save_feature( args ), args )
+      rescue => mole_boom
+        $stderr.puts "MOLE STORE CRAPPED OUT -- #{mole_boom}"
+        $stderr.puts mole_boom.backtrace.join( "\n   " )        
+      end
+
+      # =======================================================================
+      private
+
+        def init_mongo( opts )
+          @connection = Mongo::Connection.new( opts[:host], opts[:port], :logger => opts[:logger] )
+          @database   = @connection.db( opts[:database] )
+          @features   = database.collection( 'features' )
+          @logs       = database.collection( 'logs' )
+        end
+                
+        # Set up mongo default options ie localhost host, default mongo port and
+        # the database being mole_mdb      
+        def default_options
+          {
+             :host     => 'localhost',
+             :port     => 27017,
+             :database => 'mole_mdb'
+          }
+        end
+        
+        # Find or create a mole feature
+        def save_feature( args )
+          app_name    = args.delete( :app_name )
+          route_info  = args.delete( :route_info )
+          environment = args.delete( :environment )
+        
+          row = { min_field(:app_name) => app_name, min_field(:env) => environment }
+          if route_info
+            row[min_field(:controller)] = route_info[:controller]
+            row[min_field(:action)]     = route_info[:action]
+          else
+            row[min_field(:context)] = args.delete( :path )
+          end
+          
+          feature = features.find_one( row )
+          return feature if feature
+          
+          id = features.save( row )
+          features.find_one( id )
+        end
+                                    
+        # Insert a new feature in the db
+        def save_log( feature, args )               
+          type  = FEATURE
+          type  = EXCEPTION   if args[:stack]
+          type  = PERFORMANCE if args.delete(:performance)
+          
+          # BOZO !! to reduce collection space...
+          # Using cryptic key to reduce storage needs.
+          # Also narrowing date/time to ints
+          now = Time.now
+          row = {
+            min_field( :type )       => type,
+            min_field( :feature_id ) => feature['_id'].to_s,
+            min_field( :date_id )    => ("%4d%02d%02d" %[now.year, now.month, now.day]).to_i,
+            min_field( :time_id )    => ("%02d%02d%02d" %[now.hour, now.min, now.sec] ).to_i
+          }
+          
+          args.each do |k,v|
+            row[min_field(k)] = v if v
+          end
+          logs.save( row )
+        end
+        
+        # For storage reason minify the json to save space...
+        def min_field( field )
+          field_map[field] || field
+        end
+            
+        # Normalize all accessors to 3 chars. 
+        def field_map
+          @field_map ||= {
+            :app_name     => :app,
+            :context      => :ctx,
+            :controller   => :ctl,
+            :action       => :act,
+            :type         => :typ,
+            :feature_id   => :fid,
+            :date_id      => :did,
+            :time_id      => :tid,
+            :user_id      => :uid,
+            :user_name    => :una,
+            :browser      => :bro,            
+            :host         => :hos,
+            :software     => :sof,
+            :request_time => :rti,
+            :performance  => :per,
+            :method       => :met,
+            :path         => :pat,
+            :session      => :ses,
+            :params       => :par,
+            :ruby_version => :ver,
+            :stack        => :sta
+          }
+        end      
+    end
+  end
+end

data/lib/rackamole/store.rb

@@ -0,0 +1 @@
+Rackamole.require_all_libs_relative_to(__FILE__)

data/lib/rackamole.rb

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

data/spec/rackamole/mole_spec.rb

@@ -1,16 +1,16 @@
 require File.join(File.dirname(__FILE__), %w[.. spec_helper])
-require 'actionpack'
+# require 'actionpack'
 
 describe Rack::Mole do
   include Rack::Test::Methods
     
   before :each do
     @response = [ 200, {"Content-Type" => "text/plain"}, ["success"] ]
+    @test_env = { 'rack.session' => { :user_id => 100 }, 'HTTP_X_FORWARDED_FOR' => '1.1.1.1', 'HTTP_USER_AGENT' => "Firefox" }    
   end
       
   class TestStore
-    attr_accessor :mole_result
-    
+    attr_accessor :mole_result    
     def mole( args )
       @mole_result = args
     end
@@ -24,11 +24,34 @@ describe Rack::Mole do
       run lambda { |env| response }
     end
   end
-  
+
+  def error_app( opts={} )
+    @app ||= Rack::Builder.new do
+      use Rack::Lint
+      use Rack::Mole, opts
+      run lambda { |env| raise "Oh Snap!" }
+    end
+  end
+
+  it "should mole a framwework exception correctly" do
+    @test_store = TestStore.new
+    error_app( 
+      :app_name       => "Test App", 
+      :environment    => :test,
+      :perf_threshold => 0.1,
+      :user_key       => { :session_key => :user_id, :extractor => lambda{ |k| "Test user #{k}"} },
+      :store          => @test_store )
+    
+    begin
+      get "/", nil, @test_env
+    rescue 
+      @test_store.mole_result[:stack].should have(4).items      
+    end
+  end
+    
   describe 'moling a request' do
     before :each do
       @test_store = TestStore.new
-      @test_env   = { 'rack.session' => { :user_id => 100 }, 'HTTP_X_FORWARDED_FOR' => '1.1.1.1', 'HTTP_USER_AGENT' => "IBrowse" }
       app( 
         :app_name       => "Test App", 
         :environment    => :test,
@@ -44,11 +67,11 @@ describe Rack::Mole do
       @test_store.mole_result[:user_id].should     == 100
       @test_store.mole_result[:user_name].should   == 'Test user 100'
       @test_store.mole_result[:ip].should          == '1.1.1.1'
-      @test_store.mole_result[:browser].should     == 'IBrowse'
+      @test_store.mole_result[:browser].should     == 'Firefox'
       @test_store.mole_result[:method].should      == 'GET'
       @test_store.mole_result[:url].should         == 'http://example.org/'
       @test_store.mole_result[:path].should        == '/'
-      @test_store.mole_result[:perf_issue].should  == false
+      @test_store.mole_result[:performance].should == false
       @test_store.mole_result[:params].should      be_nil
       @test_store.mole_result[:session].should_not be_nil
       @test_store.mole_result[:session].should    == { :user_id => '100' }
@@ -58,11 +81,11 @@ describe Rack::Mole do
       begin
         raise 'Oh snap!'
       rescue => boom
-        get "/", nil, { 'mole.exception' => boom, 'rack.session' => { :user_id => 100 }, 'HTTP_X_FORWARDED_FOR' => '1.1.1.1', 'HTTP_USER_AGENT' => "IBrowse" }
+        get "/", nil, @test_env.merge( { 'mole.exception' => boom } )
         @test_store.mole_result[:stack].should have(4).items
       end
     end
-    
+        
     it "should capture request parameters correctly" do
         get "/", { :blee => 'duh' }, @test_env
         @test_store.mole_result[:params].should == { :blee => "duh".to_json }
@@ -72,7 +95,6 @@ describe Rack::Mole do
   describe 'username in session' do
     before :each do
       @test_store = TestStore.new
-      @test_env   = { 'rack.session' => { :user_name => "Fernand" } }
       app( 
         :app_name       => "Test App", 
         :environment    => :test,
@@ -81,10 +103,25 @@ describe Rack::Mole do
         :store          => @test_store )
     end
     
-    it "should mole the user correctly" do
-      get "/", nil, @test_env
-      @test_store.mole_result[:user_id].should be_nil
-      @test_store.mole_result[:user_name].should   == 'Fernand'
-    end    
+    it "should pickup the user name from the session correctly" do
+      get "/", nil, @test_env.merge( { 'rack.session' => { :user_name => "Fernand" } } )
+      @test_store.mole_result[:user_id].should   be_nil
+      @test_store.mole_result[:user_name].should == 'Fernand'
+    end
+  end
+  
+  describe '#id_browser' do
+    before :all do
+      @rack = Rack::Mole.new( nil )
+    end
+    
+    it "should detect a browser type correctly" do
+      browser = @rack.send( :id_browser, "Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 5.1; .NET CLR 1.1.4322; .NET CLR 2.0.50727; .NET CLR 3.0.04506.30; .NET CLR 3.0.04506.648; InfoPath.2; MS-RTC LM 8; SPC 3.1 P1 Ta)")
+      browser.should == 'MSIE 7.0'
+    end
+    
+    it "should return unknow if can't detect it" do
+      @rack.send( :id_browser, 'IBrowse' ).should == 'N/A'
+    end
   end
 end

data/spec/rackamole/store/log_spec.rb

@@ -1,5 +1,4 @@
 require File.join(File.dirname(__FILE__), %w[.. .. spec_helper])
-require 'mongo/util/ordered_hash'
 
 describe Rackamole::Store::Log do  
   describe "#mole" do

data/spec/rackamole/store/mongo_db_spec.rb

@@ -0,0 +1,128 @@
+require File.join(File.dirname(__FILE__), %w[.. .. spec_helper])
+
+describe Rackamole::Store::MongoDb do
+  
+  describe "#mole" do
+    before( :all ) do
+      @store = Rackamole::Store::MongoDb.new( 
+        :host     => 'localhost', 
+        :port     => 27017, 
+        :database => 'test_mole_mdb',
+        :logger   => Rackamole::Logger.new( :file_name => $stdout, :log_level => 'info' ) )
+      @db = @store.database
+    end
+    
+    before( :each ) do
+      @store.reset!
+      
+      @args = OrderedHash.new
+      @args[:app_name]     = "Test app"
+      @args[:environment]  = :test
+      @args[:perf_issue]   = false
+      @args[:ip]           = "1.1.1.1"
+      @args[:browser]      = "Ibrowse"
+      @args[:user_id]      = 100
+      @args[:user_name]    = "Fernand"
+      @args[:request_time] = 1.0
+      @args[:url]          = "http://test_me/"
+      @args[:path]         = "/fred"
+      @args[:method]       = 'GET'
+      @args[:params]       = { :blee => "duh".to_json }
+      @args[:session]      = { :fred => 10.to_json }
+    end
+    
+    it "should mole a context based feature correctly" do
+      @store.mole( @args )      
+      @store.features.count.should == 1
+      @store.logs.count.should     == 1
+      
+      feature = @store.features.find_one()
+      feature.should_not be_nil
+      feature['app'].should     == 'Test app'
+      feature['env'].should     == :test      
+      feature['ctx'].should     == '/fred'
+     
+      log = @store.logs.find_one()
+      log.should_not        be_nil
+      log['typ'].should == Rackamole::Store::MongoDb::FEATURE  
+      log['fid'].should_not be_nil
+      log['par'].should     == { 'blee' => 'duh'.to_json }
+      log['ip'].should      == '1.1.1.1'
+      log['bro'].should     == 'Ibrowse'
+      log['url'].should     == 'http://test_me/'
+      log['met'].should     == 'GET'
+      log['ses'].should     == { 'fred' => '10' }
+      log['una'].should     == 'Fernand'
+      log['uid'].should     == 100
+      log['rti'].should     == 1.0
+      log['did'].should_not be_nil
+      log['tid'].should_not be_nil    
+
+      @store.features.find_one( Mongo::ObjectID.from_string( log['fid'] ) )['app'].should  == 'Test app'                     
+    end
+    
+    it "should mole a rails feature correctly" do
+      @args[:path]       = '/fred/blee/duh'
+      @args[:route_info] = { :controller => 'fred', :action => 'blee', :id => 'duh' }
+      @store.mole( @args )
+      
+      @store.features.count.should == 1
+      @store.logs.count.should     == 1
+      
+      feature = @store.features.find_one()
+      feature.should_not be_nil      
+      feature['ctl'].should == 'fred'
+      feature['act'].should == 'blee'
+      feature['ctx'].should be_nil 
+      
+      log = @store.logs.find_one()      
+      log.should_not be_nil
+      log['typ'].should == Rackamole::Store::MongoDb::FEATURE
+      log['pat'].should_not be_nil
+    end
+    
+    it "should reuse an existing feature" do
+      @store.mole( @args )
+      @store.mole( @args )
+
+      @store.features.count.should == 1
+      @store.logs.count.should     == 2
+    end
+  
+    it "should mole perf correctly" do
+      @args[:performance] = true
+      @store.mole( @args )
+  
+      @store.features.count.should == 1
+      @store.logs.count.should     == 1
+      
+      feature = @store.features.find_one()
+      feature.should_not be_nil      
+  
+      log = @store.logs.find_one()
+      log.should_not be_nil
+      log['typ'].should == Rackamole::Store::MongoDb::PERFORMANCE
+    end
+    
+    it 'should mole an exception correctly' do
+      @args[:stack] = ['fred']
+      @store.mole( @args )
+  
+      @store.features.count.should == 1
+      @store.logs.count.should     == 1
+      
+      feature = @store.features.find_one()
+      feature.should_not be_nil
+  
+      log = @store.logs.find_one()
+      log.should_not be_nil      
+      log['typ'].should == Rackamole::Store::MongoDb::EXCEPTION
+      log['sta'].should == ['fred']      
+    end
+    
+    it 'should keep count an similar exceptions or perf issues' do
+      pending "NYI"
+    end
+  end
+  
+end

data/tasks/rdoc.rake

@@ -0,0 +1,54 @@
+require 'rake/rdoctask'
+require 'darkfish-rdoc'
+
+namespace :doc do
+
+  desc 'Generate RDoc documentation'
+  Rake::RDocTask.new do |rd|
+    rdoc = PROJ.rdoc
+    rd.main = rdoc.main
+    rd.rdoc_dir = rdoc.dir
+
+    incl = Regexp.new(rdoc.include.join('|'))
+    excl = Regexp.new(rdoc.exclude.join('|'))
+    files = PROJ.gem.files.find_all do |fn|
+              case fn
+              when excl; false
+              when incl; true
+              else false end
+            end
+    rd.rdoc_files.push(*files)
+
+    name    = PROJ.name
+    rf_name = PROJ.rubyforge.name
+
+    title = "#{name}-#{PROJ.version} Documentation"
+    title = "#{rf_name}'s " + title if rf_name.valid? and rf_name != name
+
+    rd.options << "-t #{title}"
+    rd.options << "-SHN"
+    rd.options << "-f"
+    rd.options << "darkfish"    
+    rd.options.concat(rdoc.opts)
+  end
+
+  desc 'Generate ri locally for testing'
+  task :ri => :clobber_ri do
+    sh "#{RDOC} --ri -o ri ."
+  end
+
+  task :clobber_ri do
+    rm_r 'ri' rescue nil
+  end
+
+end  # namespace :doc
+
+desc 'Alias to doc:rdoc'
+task :doc => 'doc:rdoc'
+
+desc 'Remove all build products'
+task :clobber => %w(doc:clobber_rdoc doc:clobber_ri)
+
+remove_desc_for_task %w(doc:clobber_rdoc)
+
+# EOF

data/tasks/setup.rb

@@ -28,7 +28,7 @@ PROJ = OpenStruct.new(
   :ruby_opts => %w(-w),
   :libs => [],
   :history_file => 'History.txt',
-  :readme_file => 'README.txt',
+  :readme_file => 'README.rdoc',
   :ignore_file => '.bnsignore',
 
   # Announce

data/tasks/spec.rake

@@ -28,7 +28,7 @@ namespace :spec do
       t.spec_files = PROJ.spec.files
       t.libs += PROJ.libs
       t.rcov = true
-      t.rcov_dir = PROJ.rcov.dir
+      t.rcov_dir = PROJ.rcov.dir       
       t.rcov_opts = PROJ.rcov.opts + ['--exclude', 'spec']
     end
 

data/tasks/test.rake

@@ -37,4 +37,4 @@ task :clobber => 'test:clobber_rcov' if HAVE_RCOV
 
 end
 
-# EOF
+# EOF

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rackamole
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
+  version: 0.0.6
 platform: ruby
 authors: 
 - Fernand Galiana
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-17 00:00:00 -07:00
+date: 2009-11-21 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -33,14 +33,24 @@ dependencies:
         version: 1.0.3
     version: 
 - !ruby/object:Gem::Dependency 
-  name: mongodb-mongo
+  name: mongo
   type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.14.1
+        version: 0.17.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: darkfish-rdoc
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.5
     version: 
 - !ruby/object:Gem::Dependency 
   name: bones
@@ -64,22 +74,18 @@ description: "The MOle is a rack application that monitors user interactions wit
   your coolest features are thought as such by your users. You will be able to elegantly record user\n\
   interactions and leverage these findings for the next iteration of your application. "
 email: fernand.galiana@gmail.com
-executables: 
-- rackamole
+executables: []
+
 extensions: []
 
 extra_rdoc_files: 
-- History.txt
-- README.txt
+- README.rdoc
 - aaa.txt
-- bin/rackamole
 - samples/rails/moled/public/robots.txt
 files: 
-- History.txt
-- README.txt
+- README.rdoc
 - Rakefile
 - aaa.txt
-- bin/rackamole
 - images/mole_logo.png
 - images/mole_logo.psd
 - images/mole_logo_small.png
@@ -88,8 +94,9 @@ files:
 - lib/rackamole/interceptor.rb
 - lib/rackamole/logger.rb
 - lib/rackamole/mole.rb
+- lib/rackamole/store.rb
 - lib/rackamole/store/log.rb
-- lib/rackamole/store/mongo.rb
+- lib/rackamole/store/mongo_db.rb
 - samples/rails/moled/README
 - samples/rails/moled/Rakefile
 - samples/rails/moled/app/controllers/application_controller.rb
@@ -152,7 +159,7 @@ files:
 - spec/rackamole/logger_spec.rb
 - spec/rackamole/mole_spec.rb
 - spec/rackamole/store/log_spec.rb
-- spec/rackamole/store/mongo_spec.rb
+- spec/rackamole/store/mongo_db_spec.rb
 - spec/rackamole_spec.rb
 - spec/spec_helper.rb
 - tasks/bones.rake
@@ -160,6 +167,7 @@ files:
 - tasks/git.rake
 - tasks/notes.rake
 - tasks/post_load.rake
+- tasks/rdoc.rake
 - tasks/rubyforge.rake
 - tasks/setup.rb
 - tasks/spec.rake
@@ -173,7 +181,7 @@ licenses: []
 post_install_message: 
 rdoc_options: 
 - --main
-- README.txt
+- README.rdoc
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 

data/History.txt

@@ -1,3 +0,0 @@
-== 0.0.2 / 2009-11-11
-
-* Hello World...

data/bin/rackamole

@@ -1,8 +0,0 @@
-#!/usr/bin/env ruby
-
-require File.expand_path(
-    File.join(File.dirname(__FILE__), %w[.. lib rackamole]))
-
-# Put your code here
-
-# EOF

data/lib/rackamole/store/mongo.rb

@@ -1,121 +0,0 @@
-require 'mongo'
-
-include Mongo
-
-# TODO !! Need to deal with auth
-module Rackamole
-  module Store
-    # 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( options={} )
-        opts = default_options.merge( options )
-        @connection = Connection.new( opts[:host], opts[:port] ).db( opts[:database] )  
-      end
-      
-      # clear out db content
-      def reset!
-        features.clear
-        logs.clear
-      end
-      
-      # 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
-        $stderr.puts "MOLE STORE CRAPPED OUT -- #{mole_boom}"
-        $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     => 27017,
-             :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]
-            controller = args[:route_info][:controller]
-            action     = args[:route_info][:action]
-          end
-          
-          feature = find_feature( args[:app_name], args[:path], controller, action )
-          
-          # Got one
-          return feature if feature
-
-          # If not create a new feature          
-          row = { :app_name => args[:app_name] }
-          if controller and action
-            row['controller'] = controller
-            row['action']     = action
-          else
-            row['context'] = args[:path]
-          end
-          row['created_at'] = Time.now
-          row['updated_at'] = Time.now
-          features.insert( row )
-        end
-            
-        # Attempt to find a mole feature
-        def find_feature( app_name, path, controller, action )    
-          conds = { 'app_name' => app_name }
-        
-          # For rails use controller/action  
-          if controller and action
-            conds['controller'] = controller
-            conds['action']     = action
-          # otherwise use path...
-          else
-            conds['context'] = path
-          end
-          features.find_one( conds )
-        end
-                
-        # Insert a new feature in the db
-        def log_feature( feature, args )
-          type  = 'Feature'
-          type  = 'Exception'   if args[:stack]
-          type  = 'Performance' if args[:performance]
-          
-          row = {
-            :type        => type,
-            :feature     => ::DBRef.new( 'features', feature.instance_of?( ObjectID ) ? feature : feature['_id'] ),
-            :created_at  => Time.now,
-            :updated_at  => Time.now
-          }
-          
-          skip_cols = [:app_name]
-          args.each do |k,v|
-            row[k] = v unless skip_cols.include?( k )
-          end
-          logs.insert( row )
-        end
-    end
-  end
-end

data/spec/rackamole/store/mongo_spec.rb

@@ -1,120 +0,0 @@
-require File.join(File.dirname(__FILE__), %w[.. .. spec_helper])
-require 'mongo/util/ordered_hash'
-
-describe Rackamole::Store::Mongo do
-  
-  describe "#mole" do
-    before( :each ) do
-      @store = Rackamole::Store::Mongo.new( :host => 'localhost', :port => 27017, :database => 'test_mole_mdb' )
-      @store.reset!
-      
-      @args = OrderedHash.new
-      @args[:app_name]     = "Test app"
-      @args[:environment]  = :test
-      @args[:perf_issue]   = false
-      @args[:ip]           = "1.1.1.1"
-      @args[:browser]      = "Ibrowse"
-      @args[:user_id]      = 100
-      @args[:user_name]    = "Fernand"
-      @args[:request_time] = 1.0
-      @args[:url]          = "http://test_me/"
-      @args[:path]         = "/fred"
-      @args[:method]       = 'GET'
-      @args[:params]       = { :blee => "duh".to_json }
-      @args[:session]      = { :fred => 10.to_json }
-    end
-    
-    it "should mole a feature correctly" do
-      @store.mole( @args )      
-      @store.features.count.should == 1
-      @store.logs.count.should     == 1
-      
-      feature = @store.features.find_one( {} )
-      feature.should_not be_nil
-      feature['app_name'].should       == 'Test app'
-      feature['context'].should        == '/fred'
-      feature['created_at'].should_not be_nil
-      feature['updated_at'].should_not be_nil
-     
-      log = @store.logs.find_one( {} )
-      log.should_not be_nil
-      log['params'].should         == { 'blee' => 'duh'.to_json }
-      log['ip'].should             == '1.1.1.1'
-      log['browser'].should        == 'Ibrowse'
-      log['environment'].should    == :test
-      log['path'].should           == '/fred'       
-      log['url'].should            == 'http://test_me/'
-      log['method'].should         == 'GET'
-      log['session'].should        == { 'fred' => '10' }
-      log['user_name'].should      == 'Fernand'
-      log['user_id'].should        == 100
-      log['request_time'].should   == 1.0       
-      log['perf_issue'].should     == false
-      log['created_at'].should_not be_nil
-      log['updated_at'].should_not be_nil                   
-      @store.connection.dereference( log['feature'] )['app_name'].should == 'Test app'
-    end
-    
-    it "should mole a rails feature correctly" do
-      @args[:path]       = '/fred/blee/duh'
-      @args[:route_info] = { :controller => 'fred', :action => 'blee', :id => 'duh' }
-      @store.mole( @args )
-      
-      @store.features.count.should == 1
-      @store.logs.count.should     == 1
-      
-      feature = @store.features.find_one( {} )
-      feature.should_not be_nil      
-      feature['controller'].should == 'fred'
-      feature['action'].should     == 'blee'
-      feature['context'].should    be_nil 
-      
-      log = @store.logs.find_one( {} )
-      log.should_not be_nil
-      log['route_info'].should_not be_nil
-    end
-    
-    it "should reuse an existing feature" do
-      @store.mole( @args )
-      @store.mole( @args )
-
-      @store.features.count.should == 1
-      @store.logs.count.should     == 2
-    end
-
-    it "should mole perf correctly" do
-      @args[:perf_issue] = true
-      @store.mole( @args )
-
-      @store.features.count.should == 1
-      @store.logs.count.should     == 1
-      
-      feature = @store.features.find_one( {} )
-      feature.should_not be_nil      
-
-      log = @store.logs.find_one( {} )
-      log.should_not be_nil
-      log['perf_issue'].should == true
-    end
-    
-    it 'should mole an exception correctly' do
-      @args[:exception] = ['fred']
-      @store.mole( @args )
-
-      @store.features.count.should == 1
-      @store.logs.count.should     == 1
-      
-      feature = @store.features.find_one( {} )
-      feature.should_not be_nil      
-
-      log = @store.logs.find_one( {} )
-      log.should_not be_nil
-      log['exception'].should == ['fred']      
-    end
-    
-    it 'should keep count an similar exceptions or perf issues' do
-      pending "NYI"
-    end
-  end
-  
-end