rackamole 0.0.8 → 0.0.9

data/Rakefile

@@ -28,6 +28,6 @@ PROJ.rcov.opts       = ["--sort", "coverage", "-T", '-x mongo']
 depend_on "logging"      , ">= 1.2.2"
 depend_on "hitimes"      , ">= 1.0.3"
 depend_on "mongo"        , ">= 0.17.1"
-depend_on "darkfish-rdoc", ">= 1.1.5"
+# depend_on "darkfish-rdoc", ">= 1.1.5"
 depend_on "twitter4r"    , ">= 0.3.0"
 depend_on "actionmailer" , ">= 2.1.0"

data/aaa.txt

@@ -0,0 +1,52 @@
+Information:
+
+* Fernand Galiana: fernand.galiana@gmail.com : @kitesufer
+* Rackamole: http://rackamole.com : @rackamole
+* Forum:     http://groups.google.com/group/rackamole
+* Git:       git://github.com/derailed/rackamole.git
+
+Rackamole: Observe your web applications in the wild...
+
+These days, companies love to claim their entire devotion to the Agile process. 
+We all iterate, do the SCRUM thing, often for longer than we care for, and we are 
+all sworn into delivering early and often... 
+
+But how can you really measure if your application is a success or a bust? 
+We all know that page hits and heat maps are only good in the eyes of marketeers, 
+or some usability PHD... How do you accurately assess that the "must have" features
+in your application are actually being used and how are your customers actually using them ? 
+More importantly, how can you accurately assess you are iterating down the right path for 
+your product and company success, and not simply digging further in the rat hole ?
+
+In other word, at times do you feel you are adhering to the frAgile methodology 
+whose motto is 'Deliver early and often deliver the wrong shit?
+
+Rackamole is a rack application that allows you to cover the 'death zone' in your application
+life cycle. Prior to your next iteration, why not take the time to observe the interactions of your 
+customers with your application in the wild. Rackmole specializes in trapping and recording 
+feature usage, performance issues and application exception. By being part and not seating
+outside your application stack, the mole can record the very essence of an interaction.
+You can then leverage this new found knowledge to prepare for your next iterations.
+As an added bonus, you can leverage Rackamole, to track your QA team progress and making sure  
+no features is left unturned prior to the big push.
+
+Installation:
+
+> gem install rackamole -s http://gemcutter.org
+
+Usage:
+
+use Rack::Mole, {...}
+
+You can simply log the interaction to the console (the default) or log file.
+Alternatively leverage the mongo adapter to use MongoDB to store the information 
+for later querying and reporting.
+
+The gem comes bundled with an email notifier to alert you when something is happening and 
+needs your attention. Granted this won't improve your social ranking much, but additionally 
+you and your team can follow your application 'happenings' on twitter...
+
+We are currently working on companion application aka 'Wackamole' that will allow you to view 
+and drilldown on the collected information.
+
+Thanks for stopping by!

data/lib/rackamole.rb

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

data/lib/rackamole/config.rb

@@ -0,0 +1,5 @@
+module Rackamole::Config
+  def twitter( &block )
+    puts "Twitt options"
+  end
+end

data/lib/rackamole/mole.rb

@@ -31,22 +31,21 @@ module Rack
     # ==
     #
     # :excluded_paths:: Exclude paths that you do not wish to mole by specifying an array of regular expresssions.
-    # :twitter_auth  :: You can setup the MOle twit interesting events to a private (public if you indulge pain!) twitter account.
-    #                   Specified your twitter account information using a hash with :username and :password key
-    # :twitt_on      :: You must configure your twitter auth and configuration using this hash. By default this option is disabled.
+    # :twitter       :: Set this option to have the mole twitt certain alerts. You must configure your twitter auth 
+    #                   via the :username and :password keys and :alert_on with an array of mole types you
+    #                   wish to be notified on.
     # ==
-    #   :twitt_on => { :enabled  => false, :features => [Rackamole.perf, Rackamole.fault] }
+    #   :twitter => { :username => 'fred', :password => 'blee', :alert_on => [Rackamole.perf, Rackamole.fault] }
     # ==
     # ==== BOZO! currently there is not support for throttling or monitoring these alerts. 
     # ==
-    # :emails        :: The mole can be configured to send out emails bases on interesting mole features.
-    #                   This feature uses actionmailer. You must specify a hash for the from and to options.
+    # :email        :: The mole can be configured to send out emails bases on interesting mole features.
+    #                  This feature uses actionmailer. You must specify a hash with the following keys :from, :to 
+    #                  and :alert_on options to indicate which mole type your wish to be alerted on.
     # ==
-    #   :emails => { :from => 'fred@acme.com', :to => ['blee@acme.com', 'doh@acme.com'] }
+    #   :email => { :from => 'fred@acme.com', :to => ['blee@acme.com', 'doh@acme.com'], :alert_on => [Rackamole.perf, Rackamole.fault]  }
     # ==
-    # :mail_on      :: Hash for email alert triggers. May be enabled or disabled per env settings. Default is disabled
-    # ==
-    #   :mail_on => {:enabled => true, :features => [Rackamole.perf, Rackamole.fault] }
+    #
     def initialize( app, opts={} )
       @app = app
       init_options( opts )
@@ -92,9 +91,7 @@ module Rack
         :environment     =>  'test',
         :excluded_paths  =>  [/.?\.ico/, /.?\.png/],
         :perf_threshold  =>  10.0,
-        :store           =>  Rackamole::Store::Log.new,
-        :twitt_on        =>  { :enabled => false, :features => [Rackamole.perf, Rackamole.fault] },
-        :mail_on         =>  { :enabled => false, :features => [Rackamole.perf, Rackamole.fault] }
+        :store           =>  Rackamole::Store::Log.new
       }
     end
            
@@ -106,10 +103,9 @@ module Rack
         raise "[M()le] -- Unable to locate required option key `#{k}" unless options[k.to_sym]
       end
       
-      configured?( :twitter_auth, [:username, :password] )
-      configured?( :twitt_on    , [:enabled, :features] )
-      configured?( :emails      , [:from, :to] )
-      configured?( :mail_on     , [:enabled, :features] )
+      # Barf early if something is wrong in the configuration
+      configured?( :twitter, [:username, :password, :alert_on], true )
+      configured?( :email  , [:from, :to, :alert_on], true )
     end
     
     # Send moled info to store and potentially send out alerts...
@@ -120,12 +116,12 @@ module Rack
       options[:store].mole( attrs )
       
       # send email alert ?
-      if configured?( :emails, [:from, :to] ) and alertable?( :mail_on, attrs[:type] )
-        Rackamole::Alert::Emole.deliver_alert( options[:emails][:from], options[:emails][:to], attrs ) 
+      if alertable?( :email, attrs[:type] )
+        Rackamole::Alert::Emole.deliver_alert( options[:email][:from], options[:email][:to], attrs ) 
       end
       
       # send twitter alert ?
-      if configured?( :twitter_auth, [:username, :password] ) and alertable?( :twitt_on, attrs[:type] )
+      if alertable?( :twitter, attrs[:type] )
         twitt.send_alert( attrs ) 
       end      
     rescue => boom
@@ -134,12 +130,13 @@ module Rack
     end
     
     # Check if an options is set and configured
-    def configured?( key, configs )
-      return false unless options.key?(key)      
+    def configured?( key, configs, optional=true )
+      return false if optional and !options.has_key?(key)
+      raise "Missing option key :#{key}" unless options.has_key?(key)
       configs.each do |c|
-        raise "Invalid value for option #{key}. Expecting a hash with symbols #{configs.join(',')}." unless options[key].respond_to? :key?
+        raise "Invalid value for option :#{key}. Expecting a hash with symbols [#{configs.join(',')}]" unless options[key].respond_to? :key?
         unless options[key].key?(c)
-          raise "Option #{key} is not properly configured missing #{c.inspect}"
+          raise "Option :#{key} is not properly configured. Missing #{c.inspect} in [#{options[key].keys.sort{|a,b| a.to_s <=> b.to_s}.join(',')}]"
         end
       end
       true
@@ -147,14 +144,14 @@ module Rack
     
     # Check if feature should be send to alert clients ie email or twitter
     def alertable?( filter, type )
-      return false unless configured?( filter, [:enabled,:features] )
-      return false unless options[filter][:enabled]
-      options[filter][:features].include?( type )
+      return false unless configured?( filter, [:alert_on] )
+      return false unless options[filter][:alert_on]
+      options[filter][:alert_on].include?( type )
     end
     
     # Create or retrieve twitter client
     def twitt
-      @twitt ||= Rackamole::Alert::Twitt.new( options[:twitter_auth][:username], options[:twitter_auth][:password] )
+      @twitt ||= Rackamole::Alert::Twitt.new( options[:twitter][:username], options[:twitter][:password] )
     end
         
     # Check if this request should be moled according to the exclude filters        

data/spec/rackamole/mole_spec.rb

@@ -114,12 +114,20 @@ describe Rack::Mole do
   describe '#alertable?' do
     before( :each ) do
       @rack = Rack::Mole.new( nil, 
-        :twitt_on => { :enabled => true , :features => [Rackamole.perf, Rackamole.fault] },
-        :mail_on  => { :enabled => false, :features => [Rackamole.perf, Rackamole.fault, Rackamole.feature] }  )
+        :twitter => { 
+          :username => 'fred', 
+          :password => 'blee', 
+          :alert_on => [Rackamole.perf, Rackamole.fault] 
+        },
+        :email => { 
+          :from     => 'fred', 
+          :to       => 'blee', 
+          :alert_on => [Rackamole.perf, Rackamole.fault, Rackamole.feature] 
+        } )
     end
     
     it "should succeeed if a feature can be twitted on" do
-      @rack.send( :alertable?, :twitt_on, Rackamole.perf ).should == true
+      @rack.send( :alertable?, :twitter, Rackamole.perf ).should == true
     end
     
     it "should fail if the type is not in range" do
@@ -127,15 +135,11 @@ describe Rack::Mole do
     end
     
     it "should fail if this is not an included feature" do
-      @rack.send( :alertable?, :twitt_on, Rackamole.feature ).should == false
+      @rack.send( :alertable?, :twitter, Rackamole.feature ).should == false
     end
     
-    it "should always return false if the alert is disabled" do
+    it "should fail if an alert is not configured" do
       @rack.send( :alertable?, :mail_on, Rackamole.perf ).should == false
-    end
-    
-    it "should fail if the alert is not configured" do
-      @rack.send( :alertable?, :fred, Rackamole.perf ).should == false
     end    
   end
 
@@ -143,31 +147,32 @@ describe Rack::Mole do
     before( :each ) do
       options = {
         :blee         => [1,2,3],
-        :twitter_auth => { :username => 'Fernand', :password => "Blee" },
-        :twitt_on     => { :enabled => true, :features => [Rackamole.perf, Rackamole.fault] }
+        :twitter      => { :username => 'Fernand', :password => "Blee", :alert_on => [Rackamole.perf, Rackamole.fault] },
       }
       @rack = Rack::Mole.new( nil, options )
     end
     
     it "should return true if an option is correctly configured" do
-      @rack.send( :configured?, :twitter_auth, [:username, :password] ).should == true
-      @rack.send( :configured?, :twitt_on, [:enabled, :features] ).should == true
+      @rack.send( :configured?, :twitter, [:username, :password] ).should == true
+      @rack.send( :configured?, :twitter, [:alert_on] ).should            == true
     end
     
     it "should fail if an option is not set" do
-      @rack.send( :configured?, :twitter, [:username, :password] ).should == false
+      lambda {      
+        @rack.send( :configured?, :twitter, [:username, :password, :blee] )
+      }.should raise_error(RuntimeError, /Option \:twitter is not properly configured. Missing \:blee in \[alert_on,password,username\]/)
     end
 
     it "should fail if an option is not a hash" do
       lambda {
         @rack.send( :configured?, :blee, [:username, :pwd] )
-      }.should raise_error(RuntimeError, /Invalid value for option blee. Expecting a hash with symbols username,pwd/ )
-    end    
+      }.should raise_error(RuntimeError, /Invalid value for option \:blee\. Expecting a hash with symbols \[username,pwd\]/ )
+    end
     
     it "should fail if an option is not correctly configured" do
       lambda {
-        @rack.send( :configured?, :twitter_auth, [:username, :pwd] )
-      }.should raise_error(RuntimeError, /missing :pwd/ )
+        @rack.send( :configured?, :fred, [:username, :pwd], false )
+      }.should raise_error(RuntimeError, /Missing option key \:fred/ )
     end    
   end
   

data/z_experiments/config_sample.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require File.join( File.dirname(__FILE__), %w[.. lib rackamole] )
+
+include Rackamole::Config
+
+twitter do
+  username 'duh'
+  password 'fred'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rackamole
 version: !ruby/object:Gem::Version 
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors: 
 - Fernand Galiana
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-24 00:00:00 -07:00
+date: 2009-11-25 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -42,16 +42,6 @@ dependencies:
       - !ruby/object:Gem::Version 
         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: twitter4r
   type: :runtime
@@ -100,12 +90,14 @@ extensions: []
 
 extra_rdoc_files: 
 - README.rdoc
+- aaa.txt
 - lib/rackamole/alert/templates/rackamole/alert/emole/alert.erb
 - samples/rails/moled/public/robots.txt
 files: 
 - ...
 - README.rdoc
 - Rakefile
+- aaa.txt
 - images/mole_logo.png
 - images/mole_logo.psd
 - images/mole_logo_small.png
@@ -114,6 +106,7 @@ files:
 - lib/rackamole/alert/emole.rb
 - lib/rackamole/alert/templates/rackamole/alert/emole/alert.erb
 - lib/rackamole/alert/twitt.rb
+- lib/rackamole/config.rb
 - lib/rackamole/interceptor.rb
 - lib/rackamole/logger.rb
 - lib/rackamole/mole.rb
@@ -200,6 +193,7 @@ files:
 - tasks/test.rake
 - tasks/zentest.rake
 - z_experiments/config.rb
+- z_experiments/config_sample.rb
 has_rdoc: true
 homepage: http://www.rackamole.com
 licenses: []