rackamole 0.1.1 → 0.2.0

data/HISTORY

@@ -5,4 +5,9 @@
 * Updated mongo store strategy
   * Tossed out mongo mapper. Trying to stay closer to the metal
   * Shortened col names for saving space. Unfortunately lame but necessary
-  * Moved user info into separate collection.
+  * Moved user info into separate collection.
+  
+0.2.0
+* YAML options - You can now load the rack component from a yaml file. This is
+  very handy in framework where Rackamole options varies depending on the environment.
+  Please refer to spec/test_configs/rackamole_test.yml for an example

data/README.rdoc

@@ -1,4 +1,5 @@
 == RackAMole
+
   Observe your web applications in the wild!
   
 == DESCRIPTION:
@@ -37,6 +38,9 @@ interactions and leverage these findings for the next iteration of your applicat
 * Logging
 * Hitimes
 * MongoDb + mongo ruby adapter
+* Twitter4r
+* Chronic
+* Actionmailer
 
 == INSTALL:
 
@@ -77,6 +81,12 @@ interactions and leverage these findings for the next iteration of your applicat
   This assumes that you have session enabled to identify a user if not the mole will log the user
   as 'Unknown'
   
+=== Notables
+
+  Rackamole also comes with an option to specify a yaml config file to initialize the various settings.
+  This comes in very handy when you need to specify different options depending on the environment you
+  are operating in. Please see the spec/test_configs/rackamole_test.yml for an example.
+  
 === Storing moled information
  
   Rackamole currently comes with a single storage strategy. More will come in the near future, but
@@ -93,6 +103,10 @@ interactions and leverage these findings for the next iteration of your applicat
   This expect a local mongo instance to be running on the default port. You can change the 
   location by adding :host and :port options.
   
+  NOTE: If you intend to use Wackamole please use the following mongo database naming convention
+  
+  mole_{app_name}_{environment}_mdb
+  
 == LICENSE:
 
 (The MIT License)

data/lib/rackamole/mole.rb

@@ -1,8 +1,8 @@
 require 'hitimes'
 require 'json'
 require 'mongo'
+require 'yaml'
 
-# BOZO !! - Need args validator or use dsl as the args are out of control...
 module Rack
   class Mole
     
@@ -16,6 +16,11 @@ module Rack
     #
     # === Options
     #
+    # :config_file    :: This option will load rackamole options from a file versus individual options. 
+    #                    You can leverage yaml and erb with the current rackamole context to specify each of
+    #                    the following options but within a yaml file. This gives more flexibility to customize
+    #                    the rack component for specific environment. You can specify the :environment option or
+    #                    the default will be development.
     # :app_name       :: The name of the application (Default: Moled App)
     # :log_level      :: Rackamole logger level. (Default: info )
     # :environment    :: The environment for the application ie :environment => RAILS_ENV
@@ -92,7 +97,16 @@ module Rack
         
     # Load up configuration options
     def init_options( opts )
-      @options = default_options.merge( opts )      
+      if opts[:config_file] && (env = opts[:environment] || "development")
+        raise "Unable to find rackamole config file #{opts[:config_file]}" unless ::File.exists?( opts[:config_file] )
+        begin
+          opts = YAML.load( ERB.new( IO.read( opts[:config_file] ) ).result( binding ) )[env]
+          opts[:environment] = env
+        rescue => boom
+          raise "Unable to parse Rackamole config file #{boom}"
+        end        
+      end      
+      @options = default_options.merge( opts )
     end
     
     # Mole default options
@@ -102,7 +116,7 @@ module Rack
         :log_level       =>  :info,
         :expiration      =>  60*60, # 1 hour    
         :app_name        =>  "Moled App",
-        :environment     =>  'test',
+        :environment     =>  'development',
         :excluded_paths  =>  [/.?\.ico/, /.?\.png/],
         :perf_threshold  =>  10.0,
         :store           =>  Rackamole::Store::Log.new

data/lib/rackamole/store/mongo_db.rb

@@ -7,7 +7,7 @@ module Rackamole
     # Mongo adapter. Stores mole info to a mongo database.
     class MongoDb
       
-      attr_reader :database, :logs, :features, :users #:nodoc:
+      attr_reader :host, :port, :db_name, :database, :logs, :features, :users #: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
@@ -29,6 +29,16 @@ module Rackamole
         init_mongo( opts )
       end
             
+      def to_yaml( opts={} )
+        YAML::quick_emit( object_id, opts ) do |out|
+          out.map( taguri, to_yaml_style ) do |map|
+            map.add( :host    , host )
+            map.add( :port    , port )
+            map.add( :db_name , db_name )
+          end
+        end
+      end
+      
       # 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
@@ -37,6 +47,10 @@ module Rackamole
       def mole( arguments )
         return if arguments.empty?       
         
+        unless @connection
+          init_mongo( :host => host, :port => port, :db_name => db_name )
+        end
+        
         # get a dup of the args since will mock with the original
         args = arguments.clone
 
@@ -58,8 +72,13 @@ module Rackamole
         end
 
         def init_mongo( opts )
-          @connection = Mongo::Connection.new( opts[:host], opts[:port], :logger => opts[:logger] )
-          @database   = @connection.db( opts[:database] )
+          @host       = opts[:host]
+          @port       = opts[:port]
+          @db_name    = opts[:db_name]
+          
+          @connection = Mongo::Connection.new( @host, @port, :logger => opts[:logger] )          
+          @database   = @connection.db( @db_name )
+          
           @features   = database.collection( 'features' )
           @logs       = database.collection( 'logs' )
           @users      = database.collection( 'users' )
@@ -80,7 +99,7 @@ module Rackamole
           {
              :host     => 'localhost',
              :port     => Mongo::Connection::DEFAULT_PORT,
-             :database => 'mole_mdb'
+             :db_name  => 'mole_mdb'
           }
         end
         
@@ -133,8 +152,6 @@ module Rackamole
         # 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( user_id, feature_id, args )
-puts "Saving LOG for #{feature_id} -- #{user_id}"
-puts caller.inspect    
           now = args.delete( :created_at )
           row = {
             min_field( :type )       => args[:type],

data/lib/rackamole.rb

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

data/samples/sinatra/moled.rb

@@ -11,16 +11,18 @@ puts "mole_sinatra_#{Sinatra::Application.environment}_mdb"
   use Rack::Lint
   use Rack::Session::Cookie
   use Rack::Mole, { 
-    :app_name       => "Moled Franky",
+    :app_name       => "Franky",
     :environment    => Sinatra::Application.environment,
     :log_level      => :debug,
     :user_key       => :user_name,
-    # :store          => Rackamole::Store::MongoDb.new( :database => "mole_sinatra_dev_mdb" ),
-    :store          => Rackamole::Store::MongoDb.new( :database => "mole_sinatra_#{Sinatra::Application.environment}_mdb" ),
+    :store          => Rackamole::Store::MongoDb.new( 
+      :host     => 'ec2-174-129-88-130.compute-1.amazonaws.com', 
+      :database => "mole_franky_#{Sinatra::Application.environment}_mdb" ),
+    # :store          => Rackamole::Store::MongoDb.new( :database => "mole_franky_#{Sinatra::Application.environment}_mdb" ),
     :expiration     => 10,
     :perf_threshold => 0.2,
-    :twitter        => { :username => 'moled', :password => 'fernand~1', :alert_on => [Rackamole.perf, Rackamole.fault] },
-    :excluded_paths => [ /.+?\.css/, /.+?\.js/, /.+?\.png/ ]
+    # :twitter        => { :username => 'moled', :password => 'fernand~1', :alert_on => [Rackamole.perf, Rackamole.fault] },
+    :excluded_paths => [ /.+?\.css/, /.+?\.js/, /.+?\.png/, /.+?\.ico/ ]
   }
 end
 

data/spec/rackamole/mole_spec.rb

@@ -365,4 +365,42 @@ describe Rack::Mole do
       @rack.send( :id_browser, 'IBrowse' ).should == 'N/A'
     end
   end
+  
+  # ---------------------------------------------------------------------------
+  describe 'YAML load' do
+    before :all do
+      @config_file = File.join( File.dirname(__FILE__), %w[.. test_configs rackamole_test.yml] )
+    end
+    
+    it "should load the test env correctly from a yaml file" do
+      @rack = Rack::Mole.new( nil, :environment => 'test', :config_file => @config_file )
+      @rack.send( 'options' )[:moleable].should == false
+    end
+    
+    it "should load the dev env correctly from a yaml file" do
+      @rack = Rack::Mole.new( nil, :environment => 'development', :config_file => @config_file )
+      opts  = @rack.send( 'options' )
+      opts[:moleable].should       == true
+      opts[:app_name].should       == 'TestApp'
+      opts[:user_key].should       == :user_name 
+      opts[:perf_threshold].should == 2
+      
+      @rack.send( :alertable?, :twitter, Rackamole.perf ).should  == true
+      @rack.send( :alertable?, :twitter, Rackamole.fault ).should == false
+      @rack.send( :alertable?, :email, Rackamole.fault ).should   == true
+      @rack.send( :alertable?, :email, Rackamole.perf ).should    == false            
+    end
+    
+    it "should load the prod env correctly" do      
+      @rack = Rack::Mole.new( nil, :environment => 'production', :config_file => @config_file )
+      opts  = @rack.send( 'options' )
+      opts[:moleable].should       == true
+      opts[:app_name].should       == 'TestApp'
+      opts[:perf_threshold].should == 5
+      (opts[:store].instance_of?(Rackamole::Store::MongoDb)).should == true
+      opts[:store].db_name.should == "mole_fred_production"
+      opts[:store].port.should    == 10
+      opts[:store].host.should    == "fred"
+    end        
+  end
 end

data/spec/test_configs/rackamole_test.yml

@@ -0,0 +1,42 @@
+# -----------------------------------------------------------------------------
+# Rackamole Test rack configuration file
+# -----------------------------------------------------------------------------
+
+# -----------------------------------------------------------------------------
+# Shared configuration
+defaults: &defaults
+  :moleable:       true  
+  :app_name:       TestApp
+  :user_key:       :user_name
+  :twitter:
+   :username: bumblebtuna
+   :password: secret
+   :alert_on:
+     - <%= Rackamole.perf %>
+  :email:
+    :from: Bozo@acme.com
+    :to: 
+      - 'fernand@acme.com'
+    :alert_on:
+      - <%= Rackamole.fault %>
+
+# -----------------------------------------------------------------------------
+# 
+development:
+  <<:             *defaults
+  :perf_threshold: 2
+     
+# ----------------------------------------------------------------------------- 
+# Turn mole off in test
+test:
+  :moleable: false
+
+# ----------------------------------------------------------------------------- 
+# Use mongo based store in production env     
+production: 
+  <<:             *defaults
+  :perf_threshold: 5
+  :store:          !ruby/object:Rackamole::Store::MongoDb
+    host:    fred
+    port:    10
+    db_name: mole_fred_production    

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rackamole
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors: 
 - Fernand Galiana
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-09 00:00:00 -07:00
+date: 2009-12-21 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -203,6 +203,7 @@ files:
 - spec/rackamole/store/mongo_db_spec.rb
 - spec/rackamole_spec.rb
 - spec/spec_helper.rb
+- spec/test_configs/rackamole_test.yml
 - tasks/bones.rake
 - tasks/gem.rake
 - tasks/git.rake