rackamole 0.0.6 → 0.0.7

data/lib/rackamole/store.rb

@@ -1 +1,5 @@
+# Provides various transient/persistent storage for the mole.
+# Currently, you can send moled info to the console, a file, or a mongo database.
+# Please see the various stores for more info...
+#
 Rackamole.require_all_libs_relative_to(__FILE__)

data/lib/rackamole/store/log.rb

@@ -1,57 +1,62 @@
-module Rackamole
-  module Store
-    # Logger adapter. Stores mole information to a log file or dump it to stdout
-    class Log
-                  
-      def initialize( file_name=$stdout )
-        @logger = Rackamole::Logger.new( :log_file => file_name )
+module Rackamole::Store
+  class Log
+            
+    # Stores mole information to a log file or dump it to the console. All
+    # available mole info will dumped to the logger.
+    #
+    # === Params:
+    # file_name :: Specifies a file to send the logs to. By default mole info
+    # will be sent out to stdout.
+    def initialize( file_name=$stdout )
+      @logger = Rackamole::Logger.new( :log_file => file_name )
+    end
+    
+    # Dump mole info to logger
+    #
+    # === Params:
+    # attrs :: The available moled information for a given feature
+    def mole( attrs )
+      return if attrs.empty?
+              
+      display_head( attrs )
+      display_commons( attrs )          
+    rescue => mole_boom
+      log.error "MOLE STORE CRAPPED OUT -- #{mole_boom}"
+      log.error mole_boom.backtrace.join( "\n   " )        
+    end
+       
+    # =======================================================================
+    private
+
+      # dump moled info to log
+      def display_commons( args )
+        args.each do |k,v|
+          display_info( k.to_s.capitalize, v.inspect )
+        end
       end
       
-      # Dump mole info to logger
-      def mole( args )
-        return if args.empty?
-        
-        if args[:stack]
-          display_head "MOLED EXCEPTION" 
-        elsif args[:performance]
-          display_head "MOLED PERFORMANCE" 
-        else
-          display_head "MOLED FEATURE"
-        end
-        display_commons( args )          
-      rescue => mole_boom
-        log.error "MOLE STORE CRAPPED OUT -- #{mole_boom}"
-        log.error mole_boom.backtrace.join( "\n   " )        
+      # retrieves logger instance
+      def log
+        @logger
       end
-         
-      # =======================================================================
-      private
-
-        # dump moled info to log
-        def display_commons( args )
-          args.each do |k,v|
-            display_info( k.to_s.capitalize, v.inspect )
-          end
-        end
-        
-        # retrieves logger instance
-        def log
-          @logger
-        end
-        
-        # Console layout spacer
-        def spacer() 20; end
+      
+      # Console layout spacer
+      def spacer() 20; end
 
-        # Display mole type
-        def display_head( msg )
-          log.info "-"*100
-          log.info msg
+      # Display mole type
+      def display_head( args )
+        log.info "-"*100
+        log.info case args[:type]
+          when Rackamole.feature : "FEATURE m()le"
+          when Rackamole.fault   : "FAULT m()le"
+          when Rackamole.perf    : "PERFORMANCE m()le"
+          else "Unknown type #{args[:type].inspect}"
         end
-        
-        # Output formating...         
-        def display_info( key, value )
-          log.info "%-#{spacer}s : %s" % [key, value]
-        end        
-    end
+      end
+      
+      # Output formating...         
+      def display_info( key, value )
+        log.info "%-#{spacer}s : %s" % [key, value]
+      end        
   end
 end

data/lib/rackamole/store/mongo_db.rb

@@ -4,28 +4,36 @@ require 'mongo'
 # BOZO !! Deal with indexes here ?
 module Rackamole
   module Store
-    # Mongo adapter. Stores mole info in a mongo database.
+    # Mongo adapter. Stores mole info to a mongo database.
     class MongoDb
       
-      attr_reader :database, :logs, :features
-      
-      # Defines the various feature types
-      FEATURE     = 0
-      PERFORMANCE = 1
-      EXCEPTION   = 2
-      
+      attr_reader :database, :logs, :features #:nodoc:
+            
+      # Initializes the mongo db store. MongoDb can be used as a persitent store for
+      # mole information. This is a preferred store for the mole as it will allow you
+      # to gather up reports based on application usage, perf or faults...
+      #
+      # Setup rackamole to use the mongodb store as follows:
+      #
+      #   config.middleware.use Rack::Mole, { :store => Rackamole::Store::MongoDb.new }
+      #
+      # === Options
+      #
+      # :host     :: The name of the host running the mongo server. Default: localhost
+      # :port     :: The port for the mongo server instance. Default: 27017
+      # :database :: The name of the mole databaase. Default: mole_mdb
+      #
       def initialize( options={} )
         opts = default_options.merge( options )
+        validate_options( opts )
         init_mongo( opts )
       end
-      
-      # clear out db content ( used in testing... )
-      def reset!
-        logs.remove
-        features.remove
-      end
-      
-      # Dump mole info to logger
+            
+      # Dump mole info to a mongo database. There are actually 2 collections
+      # for mole information. Namely features and logs. The features collection hold
+      # application and feature information and is referenced in the mole log. The logs
+      # collections holds all information that was gathered during the request
+      # such as user, params, session, request time, etc...
       def mole( arguments )
         return if arguments.empty?       
         
@@ -41,6 +49,12 @@ module Rackamole
 
       # =======================================================================
       private
+        
+        # Clear out mole database content ( Careful there - testing only! )
+        def reset!
+          logs.remove
+          features.remove
+        end
 
         def init_mongo( opts )
           @connection = Mongo::Connection.new( opts[:host], opts[:port], :logger => opts[:logger] )
@@ -48,6 +62,15 @@ module Rackamole
           @features   = database.collection( 'features' )
           @logs       = database.collection( 'logs' )
         end
+
+        # Validates option hash.
+        def validate_options( opts )     
+          %w[host port database].each do |option|
+            unless opts[option.to_sym]
+              raise "[MOle] Mongo store configuration error -- You must specify a value for option `:#{option}" 
+            end
+          end
+        end
                 
         # Set up mongo default options ie localhost host, default mongo port and
         # the database being mole_mdb      
@@ -65,7 +88,7 @@ module Rackamole
           route_info  = args.delete( :route_info )
           environment = args.delete( :environment )
         
-          row = { min_field(:app_name) => app_name, min_field(:env) => environment }
+          row = { min_field(:app_name) => app_name, min_field(:env) => environment.to_s }
           if route_info
             row[min_field(:controller)] = route_info[:controller]
             row[min_field(:action)]     = route_info[:action]
@@ -81,17 +104,12 @@ module Rackamole
         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
+        # NOTE : Using min key to reduce storage needs. I know not that great for higher level api's :-(
+        # also saving date and time as ints. same deal...
+        def save_log( feature, args )        
           now = Time.now
           row = {
-            min_field( :type )       => type,
+            min_field( :type )       => args[: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
@@ -111,6 +129,7 @@ module Rackamole
         # Normalize all accessors to 3 chars. 
         def field_map
           @field_map ||= {
+            :env          => :env,
             :app_name     => :app,
             :context      => :ctx,
             :controller   => :ctl,
@@ -131,6 +150,7 @@ module Rackamole
             :session      => :ses,
             :params       => :par,
             :ruby_version => :ver,
+            :fault        => :msg,
             :stack        => :sta
           }
         end      

data/spec/expected_results/mole_exception.log

@@ -1,8 +1,8 @@
 ----------------------------------------------------------------------------------------------------
-MOLED EXCEPTION
+FAULT m()le
+Type                 : 2
 App_name             : "Test app"
 Environment          : :test
-Perf_issue           : false
 Ip                   : "1.1.1.1"
 Browser              : "Ibrowse"
 User_id              : 100
@@ -13,5 +13,6 @@ Path                 : "/fred"
 Method               : "GET"
 Params               : {:blee=>"\"duh\""}
 Session              : {:fred=>"10"}
+Fault                : "Shiet"
 Stack                : ["Oh snap!"]
 Ruby_version         : "ruby 1.8.6 (2007-03-13 patchlevel 0) [i686-darwin8.10.1]"

data/spec/expected_results/mole_feature.log

@@ -1,8 +1,8 @@
 ----------------------------------------------------------------------------------------------------
-MOLED FEATURE
+FEATURE m()le
+Type                 : 0
 App_name             : "Test app"
 Environment          : :test
-Perf_issue           : false
 Ip                   : "1.1.1.1"
 Browser              : "Ibrowse"
 User_id              : 100

data/spec/expected_results/mole_perf.log

@@ -1,8 +1,8 @@
 ----------------------------------------------------------------------------------------------------
-MOLED PERFORMANCE
+PERFORMANCE m()le
+Type                 : 1
 App_name             : "Test app"
 Environment          : :test
-Perf_issue           : false
 Ip                   : "1.1.1.1"
 Browser              : "Ibrowse"
 User_id              : 100
@@ -13,4 +13,3 @@ Path                 : "/fred"
 Method               : "GET"
 Params               : {:blee=>"\"duh\""}
 Session              : {:fred=>"10"}
-Performance          : true

data/spec/rackamole/alert/emole_spec.rb

@@ -0,0 +1,109 @@
+require File.join(File.dirname(__FILE__), %w[.. .. spec_helper])
+
+describe Rackamole::Alert::Emole do
+  
+  before( :each ) do
+    @from = "fernand"
+    @to   = %w[fernand bobo blee]
+    
+    @expected = TMail::Mail.new
+    @expected.set_content_type 'text', 'plain', { 'charset' => 'utf-8' }
+    @expected.mime_version = '1.0'
+    @expected.from    = @from
+    @expected.to      = @to    
+
+    @args = OrderedHash.new
+    @args[:type]      = Rackamole.feature
+    @args[:app_name]  = 'Test'
+    @args[:host]      = 'Fred'
+    @args[:user_name] = 'Fernand'
+  end
+  
+  describe "#alert" do
+    
+    it "should send a feature email correctly" do
+      @expected.subject = "[M()le] (Feature) -Test@Fred- for user Fernand"
+      @expected.body    = feature_body
+      Rackamole::Alert::Emole.create_alert( @from, @to, @args ).encoded.should == @expected.encoded
+    end
+
+    it "should send a perf email correctly" do
+      @args[:type] = Rackamole.perf
+      @args[:request_time] = 10.0
+      @expected.subject = "[M()le] (Performance:10.0) -Test@Fred- for user Fernand"
+      @expected.body    = perf_body
+      Rackamole::Alert::Emole.create_alert( @from, @to, @args ).encoded.should == @expected.encoded
+    end
+
+    it "should send a fault email correctly" do
+      @args[:type]   = Rackamole.fault
+      @args[:fault]  = 'Oh Snap!'
+      @args[:stack]  = ['fred', 'blee']
+      @args[:params] = { :id => 10 }
+      @expected.subject = "[M()le] (Fault) -Test@Fred- for user Fernand"
+      @expected.body    = fault_body
+      Rackamole::Alert::Emole.create_alert( @from, @to, @args ).encoded.should == @expected.encoded
+    end
+
+  end
+  
+  
+  def feature_body
+msg=<<MSG
+A watched feature was triggered in application `Test on host `Fred
+
+Details...
+
+ type                                     0
+ app_name                                 \"Test\"
+ host                                     \"Fred\"
+ user_name                                \"Fernand\"
+
+- Your Rackamole
+
+This message was generated automatically. Please do not respond directly.
+MSG
+  end
+  
+  def perf_body
+msg=<<MSG
+A watched feature was triggered in application `Test on host `Fred
+
+Details...
+
+ type                                     1
+ app_name                                 \"Test\"
+ host                                     \"Fred\"
+ user_name                                \"Fernand\"
+ request_time                             10.0
+
+- Your Rackamole
+
+This message was generated automatically. Please do not respond directly.
+MSG
+  end
+
+  def fault_body
+msg=<<MSG
+A watched feature was triggered in application `Test on host `Fred
+
+Details...
+
+ type                                     2
+ app_name                                 \"Test\"
+ host                                     \"Fred\"
+ user_name                                \"Fernand\"
+ fault                                    \"Oh Snap!\"
+ stack                                   
+   fred                                   
+   blee                                   
+ params                                  
+   id                                      10
+
+- Your Rackamole
+
+This message was generated automatically. Please do not respond directly.
+MSG
+  end
+  
+end

data/spec/rackamole/alert/twitt_spec.rb

@@ -0,0 +1,68 @@
+require File.join(File.dirname(__FILE__), %w[.. .. spec_helper])
+
+describe Rackamole::Alert::Twitt do
+  before( :each ) do
+    @alert = Rackamole::Alert::Twitt.new( 'fernand', "blee" )
+  end
+  
+  it "should truncate a message correctly" do
+    @alert.send( :truncate, "a"*141 ).should == "a"*137 + '...'
+  end
+  
+  describe '#display_feature' do
+    it "should display a rails feature correctly" do
+      @alert.send( :display_feature, :route_info => { :controller => 'fred', :action => 'blee'} ).should == "fred#blee"
+    end
+    
+    it "should display a path feature for other rack framword" do
+      @alert.send( :display_feature, :path => '/fred/blee' ).should == "/fred/blee"
+    end
+  end
+  
+  describe '#send_alert' do
+    before( :each ) do      
+      @args = OrderedHash.new
+      @args[:type]      = Rackamole.feature
+      @args[:app_name]  = 'Test'
+      @args[:host]      = 'Fred'
+      @args[:user_name] = 'Fernand'
+      @args[:path]      = '/blee/fred'
+    end
+    
+    it "should twitt a feature alert correctly" do
+      client = stub( Twitter::Client )
+
+      @alert.should_receive( :twitt ).once.and_return( client )
+      # client.should_receive( :new ).exactly(1).with( 'fernand', 'blee' )
+      client.should_receive( :status ).once
+    
+      @alert.send_alert( @args ).should == "[Feature] -- Test:Fred\nFernand : /blee/fred"
+    end
+  
+    it "should twitt a perf alert correctly" do
+      @args[:type]         = Rackamole.perf
+      @args[:request_time] = 10.0
+      
+      client = stub( Twitter::Client )
+    
+      @alert.should_receive( :twitt ).once.and_return( client )
+      client.should_receive( :status ).once
+    
+      @alert.send_alert( @args ).should == "[Perf]    -- Test:Fred\nFernand : /blee/fred : 10.0 secs"
+    end
+
+    it "should twitt a perf alert correctly" do
+      @args[:type]  = Rackamole.fault
+      @args[:fault] = 'Oh snap!'
+      
+      client = stub( Twitter::Client )
+    
+      @alert.should_receive( :twitt ).once.and_return( client )
+      client.should_receive( :status ).once
+    
+      @alert.send_alert( @args ).should == "[Fault]   -- Test:Fred\nFernand : /blee/fred : Oh snap!"
+    end
+
+  end
+  
+end