rackamole 0.0.7 → 0.0.8

data/README.rdoc

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

data/Rakefile

@@ -17,7 +17,7 @@ task :default => 'spec:run'
 PROJ.name            = 'rackamole'
 PROJ.authors         = 'Fernand Galiana'
 PROJ.email           = 'fernand.galiana@gmail.com'
-PROJ.url             = 'http://rackamole.liquidrail.com'
+PROJ.url             = 'http://www.rackamole.com'
 PROJ.version         = Rackamole::VERSION
 PROJ.spec.opts       << '--color'
 PROJ.ruby_opts       = %w[-W0]

data/lib/rackamole.rb

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

data/lib/rackamole/alert/twitt.rb

@@ -35,11 +35,11 @@ module Rackamole::Alert
     # args :: The moled info for a given feature. 
     #
     def send_alert( args )
-      twitt_msg = "#{args[:app_name]}:#{args[:host]}\n#{args[:user_name]} : #{display_feature(args)}"
+      twitt_msg = "#{args[:app_name]} on #{format_host(args[:host])} - #{args[:user_name]}\n#{display_feature(args)}"
       twitt_msg = case args[:type]
-        when Rackamole.feature : "[Feature] -- #{twitt_msg}"
-        when Rackamole.perf    : "[Perf]    -- #{twitt_msg} : #{args[:request_time]} secs"
-        when Rackamole.fault   : "[Fault]   -- #{twitt_msg} : #{args[:fault]}"
+        when Rackamole.feature : "[Feature] #{twitt_msg}"
+        when Rackamole.perf    : "[Perf] #{twitt_msg}\n#{format_time(args[:request_time])} secs"
+        when Rackamole.fault   : "[Fault] #{twitt_msg}\n#{args[:fault]}"
         else nil
       end      
       twitt.status( :post, truncate( twitt_msg ) ) if twitt_msg
@@ -63,6 +63,17 @@ module Rackamole::Alert
          "#{args[:route_info][:controller]}##{args[:route_info][:action]}"
        end
 
+      # Format host ie fred@blee.com => fred
+      def format_host( host )
+        return host.gsub( /@.+/, '' ) if host =~ /@/
+        host
+      end
+      
+      # Format precision on request time
+      def format_time( time )
+        ("%4.2f" % time).to_f
+      end
+      
       # Truncate for twitt max size       
       def truncate(text, length = 140, truncate_string = "...")
         return "" if text.nil?

data/lib/rackamole/mole.rb

@@ -30,6 +30,7 @@ module Rack
     #    :user_key => { :session_key => :user_id, :extractor => lambda{ |id| User.find( id ).name} }
     # ==
     #
+    # :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.
@@ -86,10 +87,11 @@ module Rack
     # Mole default options
     def default_options
       { 
+        :moleable        =>  true,        
         :app_name        =>  "Moled App",
+        :environment     =>  'test',
         :excluded_paths  =>  [/.?\.ico/, /.?\.png/],
-        :moleable        =>  true,
-        :perf_threshold  =>  10,
+        :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] }
@@ -98,9 +100,16 @@ module Rack
            
     # Validates all configured options... Throws error if invalid configuration
     def validate_options
-      %w[app_name moleable perf_threshold store].each do |k|
+      return unless options[:moleable]
+      
+      %w[app_name environment perf_threshold store].each do |k|
         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] )
     end
     
     # Send moled info to store and potentially send out alerts...
@@ -111,12 +120,12 @@ module Rack
       options[:store].mole( attrs )
       
       # send email alert ?
-      if configured?( :emails, [:from, :to] ) and alertable?( options[:mail_on], attrs[:type] )
+      if configured?( :emails, [:from, :to] ) and alertable?( :mail_on, attrs[:type] )
         Rackamole::Alert::Emole.deliver_alert( options[:emails][:from], options[:emails][:to], attrs ) 
       end
       
       # send twitter alert ?
-      if configured?( :twitter_auth, [:username, :password] ) and alertable?( options[:twitt_on], attrs[:type] )
+      if configured?( :twitter_auth, [:username, :password] ) and alertable?( :twitt_on, attrs[:type] )
         twitt.send_alert( attrs ) 
       end      
     rescue => boom
@@ -126,15 +135,21 @@ module Rack
     
     # Check if an options is set and configured
     def configured?( key, configs )
-      return false unless options[key]
-      configs.each { |c| return false unless options[key][c] }
+      return false unless options.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?
+        unless options[key].key?(c)
+          raise "Option #{key} is not properly configured missing #{c.inspect}"
+        end
+      end
       true
     end
     
     # Check if feature should be send to alert clients ie email or twitter
-    def alertable?( filters, type )
-      return false if !filters or filters.empty? or !filters[:enabled]
-      filters[:features].include?( type )
+    def alertable?( filter, type )
+      return false unless configured?( filter, [:enabled,:features] )
+      return false unless options[filter][:enabled]
+      options[filter][:features].include?( type )
     end
     
     # Create or retrieve twitter client

data/spec/rackamole/alert/twitt_spec.rb

@@ -36,7 +36,7 @@ describe Rackamole::Alert::Twitt do
       # 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"
+      @alert.send_alert( @args ).should == "[Feature] Test on Fred - Fernand\n/blee/fred"
     end
   
     it "should twitt a perf alert correctly" do
@@ -48,7 +48,7 @@ describe Rackamole::Alert::Twitt do
       @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"
+      @alert.send_alert( @args ).should == "[Perf] Test on Fred - Fernand\n/blee/fred\n10.0 secs"
     end
 
     it "should twitt a perf alert correctly" do
@@ -60,9 +60,28 @@ describe Rackamole::Alert::Twitt do
       @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!"
+      @alert.send_alert( @args ).should == "[Fault] Test on Fred - Fernand\n/blee/fred\nOh snap!"
     end
+  end
 
+  describe "#format_time" do
+    it "should format a request time correctly" do
+      @alert.send( :format_time, 12.1234455 ).should == 12.12
+    end
+  end
+  
+  describe "#format_host" do
+    it "should format a host with domain name correctly" do
+      @alert.send( :format_host, 'blee@acme.com' ).should == 'blee'
+    end
+    
+    it "should deal with ip host" do
+      @alert.send( :format_host, '1.1.1.1' ).should == '1.1.1.1'
+    end
+
+    it "should deal with aliases" do
+      @alert.send( :format_host, 'fred' ).should == 'fred'
+    end
   end
   
 end

data/spec/rackamole/mole_spec.rb

@@ -113,35 +113,36 @@ describe Rack::Mole do
   
   describe '#alertable?' do
     before( :each ) do
-      @filter = { :enabled => true, :features => [Rackamole.perf, Rackamole.fault] }
-      @rack = Rack::Mole.new( nil )
+      @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] }  )
     end
     
-    it "should return true if a feature can be twitted on" do
-      @rack.send( :alertable?, @filter, Rackamole.perf ).should == true
+    it "should succeeed if a feature can be twitted on" do
+      @rack.send( :alertable?, :twitt_on, Rackamole.perf ).should == true
     end
     
     it "should fail if the type is not in range" do
-      @rack.send( :alertable?, @filter, 10 ).should == false
+      @rack.send( :alertable?, :twitt_on, 10 ).should == false
     end
     
     it "should fail if this is not an included feature" do
-      @rack.send( :alertable?, @filter, Rackamole.feature ).should == false
+      @rack.send( :alertable?, :twitt_on, Rackamole.feature ).should == false
     end
     
     it "should always return false if the alert is disabled" do
-      @filter[:enabled] = false
-      @rack.send( :alertable?, @filter, Rackamole.perf ).should == false
+      @rack.send( :alertable?, :mail_on, Rackamole.perf ).should == false
     end
     
     it "should fail if the alert is not configured" do
-      @rack.send( :alertable?, nil, Rackamole.perf ).should == false
+      @rack.send( :alertable?, :fred, Rackamole.perf ).should == false
     end    
   end
 
   describe '#configured?' do
     before( :each ) do
       options = {
+        :blee         => [1,2,3],
         :twitter_auth => { :username => 'Fernand', :password => "Blee" },
         :twitt_on     => { :enabled => true, :features => [Rackamole.perf, Rackamole.fault] }
       }
@@ -153,12 +154,20 @@ describe Rack::Mole do
       @rack.send( :configured?, :twitt_on, [:enabled, :features] ).should == true
     end
     
-    it "should fail is an option is not set" do
+    it "should fail if an option is not set" do
       @rack.send( :configured?, :twitter, [:username, :password] ).should == false
     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    
     
-    it "should fail is an option is not correctly configured" do
-      @rack.send( :configured?, :twitter_auth, [:username, :pwd] ).should == false
+    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/ )
     end    
   end
   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rackamole
 version: !ruby/object:Gem::Version 
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors: 
 - Fernand Galiana
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-22 00:00:00 -07:00
+date: 2009-11-24 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -100,15 +100,12 @@ extensions: []
 
 extra_rdoc_files: 
 - README.rdoc
-- aa.txt
-- aaa.txt
 - lib/rackamole/alert/templates/rackamole/alert/emole/alert.erb
 - samples/rails/moled/public/robots.txt
 files: 
+- ...
 - README.rdoc
 - Rakefile
-- aa.txt
-- aaa.txt
 - images/mole_logo.png
 - images/mole_logo.psd
 - images/mole_logo_small.png
@@ -204,7 +201,7 @@ files:
 - tasks/zentest.rake
 - z_experiments/config.rb
 has_rdoc: true
-homepage: http://rackamole.liquidrail.com
+homepage: http://www.rackamole.com
 licenses: []
 
 post_install_message: 

data/aa.txt

@@ -1,10 +0,0 @@
-:twitt_if       => [Rackamole.feature, Rackamole.fault, Rackamole.perf],
-:twitter        => { :username => 'moled', :password => 'fernand~1' },
-        
-require 'action_mailer'
-ActionMailer::Base.delivery_method       = :sendmail
-ActionMailer::Base.raise_delivery_errors = true                                       
-        
-:email          => { :from => 'fernand@collectiveintellect.com', :to => ['fernand@collectiveintellect.com'] },
-:email_if       => [Rackamole.feature, Rackamole.fault],
-