analytical 0.6.0 → 0.7.0

data/VERSION

@@ -1 +1 @@
-0.6.0
+0.7.0

data/analytical.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{analytical}
-  s.version = "0.6.0"
+  s.version = "0.7.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Joshua Krall"]
-  s.date = %q{2010-05-02}
+  s.date = %q{2010-05-04}
   s.description = %q{Gem for managing multiple analytics services in your rails app.}
   s.email = %q{josh@transfs.com}
   s.extra_rdoc_files = [
@@ -77,12 +77,14 @@ Gem::Specification.new do |s|
      "lib/analytical.rb",
      "lib/analytical/api.rb",
      "lib/analytical/base.rb",
+     "lib/analytical/bot_detector.rb",
      "lib/analytical/clicky.rb",
      "lib/analytical/console.rb",
      "lib/analytical/google.rb",
      "lib/analytical/kiss_metrics.rb",
      "rails/init.rb",
      "spec/analytical/api_spec.rb",
+     "spec/analytical/bot_detector_spec.rb",
      "spec/analytical/clicky_spec.rb",
      "spec/analytical/google_spec.rb",
      "spec/analytical/kiss_metrics_spec.rb",
@@ -98,6 +100,7 @@ Gem::Specification.new do |s|
   s.summary = %q{Gem for managing multiple analytics services in your rails app.}
   s.test_files = [
     "spec/analytical/api_spec.rb",
+     "spec/analytical/bot_detector_spec.rb",
      "spec/analytical/clicky_spec.rb",
      "spec/analytical/google_spec.rb",
      "spec/analytical/kiss_metrics_spec.rb",

data/lib/analytical.rb

@@ -7,6 +7,7 @@ module Analytical
   # any method placed here will apply to ActionController::Base
   def analytical(options={})
     send :include, InstanceMethods
+    send :include, Analytical::BotDetector
     send :helper_method, :analytical
     send :cattr_accessor, :analytical_options
 
@@ -38,6 +39,9 @@ module Analytical
         if options[:disable_if].call(self)
           options[:modules] = options[:development_modules]
         end
+        if analytical_is_robot?(request.user_agent)
+          options[:modules] = []
+        end
         Analytical::Api.new options
       end
     end

data/lib/analytical/bot_detector.rb

@@ -0,0 +1,46 @@
+module Analytical
+  module BotDetector
+
+    def analytical_is_robot?(user_agent)
+      unless user_agent.blank?
+        user_agent = user_agent.to_s.downcase
+
+        # We mark something as a bot if it contains any of the $bot_indicators
+        # or if it does not contain one of the $browser_indicators. In addition,
+        # if the user-agent string contains "mozilla" we make sure it has version
+        # information. Finally anything that starts with a word in the $whitelist
+        # is never considered a bot.
+
+        whitelist = %w(w3m dillo links elinks lynx)
+        whitelist.each do |word|
+          return false if user_agent.index(word) == 0
+        end
+
+        bot_indicators = %w(bot spider search jeeves crawl seek heritrix slurp thumbnails capture ferret webinator scan retriever accelerator upload digg extractor grub scrub)
+        bot_indicators.each do |word|
+          return true if user_agent.index word
+        end
+
+        browser_indicators = %w(mozilla browser iphone lynx mobile opera icab)
+        has_browser_indicator = false
+
+        browser_indicators.each do |word|
+          if user_agent.index word
+            has_browser_indicator = true
+            break
+          end
+        end
+
+        return true if not has_browser_indicator
+
+        # Check for mozilla version information
+        if user_agent.include? "mozilla"
+          return true if not user_agent.include? "("
+          return true if user_agent !~ /mozilla\/\d+/i
+        end
+      end
+      return false
+    end
+
+  end
+end

data/spec/analytical/bot_detector_spec.rb

@@ -0,0 +1,24 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Analytical::BotDetector" do
+  class DummyForBotDetector
+    include Analytical::BotDetector
+  end
+  before(:each) do
+    @d = DummyForBotDetector.new
+  end
+  
+  describe 'with nil user_agent' do
+    it 'should return false' do
+      @d.analytical_is_robot?(nil).should be_false
+    end
+  end
+
+  describe 'with empty user_agent' do
+    it 'should return false' do
+      @d.analytical_is_robot?('').should be_false
+    end
+  end
+  
+
+end

data/spec/analytical_spec.rb

@@ -11,8 +11,12 @@ describe "Analytical" do
   describe 'on initialization' do
     class DummyForInit
       extend Analytical
-      def request; OpenStruct.new(:'ssl?'=>true); end
       def self.helper_method(*a); end
+      def request
+        Spec::Mocks::Mock.new 'request', 
+          :'ssl?'=>true, 
+          :user_agent=>'Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10.6; en-US; rv:1.9.2.3) Gecko/20100401 Firefox/3.6.3 GTB7.0'
+      end
     end
 
     it 'should have the default options' do
@@ -23,6 +27,23 @@ describe "Analytical" do
       d.options[:disable_if].call.should be_false
     end
 
+    it 'should use the supplied options' do
+      DummyForInit.analytical :modules=>[:google]
+      d = DummyForInit.new.analytical
+      d.options[:modules].should == [:google]
+      d.options[:development_modules].should == [:console]
+      d.options[:disable_if].call.should be_false
+    end
+    
+    describe 'with a robot request' do
+      it 'should set the modules to []' do
+        DummyForInit.analytical
+        d = DummyForInit.new
+        d.stub!(:'analytical_is_robot?').and_return(true)
+        d.analytical.options[:modules].should == []
+      end
+    end
+
     it 'should open the initialization file' do
       File.should_receive(:'exists?').with("#{RAILS_ROOT}/config/analytical.yml").and_return(true)
       DummyForInit.analytical

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 6
+  - 7
   - 0
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors: 
 - Joshua Krall
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-02 00:00:00 -05:00
+date: 2010-05-04 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -113,12 +113,14 @@ files:
 - lib/analytical.rb
 - lib/analytical/api.rb
 - lib/analytical/base.rb
+- lib/analytical/bot_detector.rb
 - lib/analytical/clicky.rb
 - lib/analytical/console.rb
 - lib/analytical/google.rb
 - lib/analytical/kiss_metrics.rb
 - rails/init.rb
 - spec/analytical/api_spec.rb
+- spec/analytical/bot_detector_spec.rb
 - spec/analytical/clicky_spec.rb
 - spec/analytical/google_spec.rb
 - spec/analytical/kiss_metrics_spec.rb
@@ -158,6 +160,7 @@ specification_version: 3
 summary: Gem for managing multiple analytics services in your rails app.
 test_files: 
 - spec/analytical/api_spec.rb
+- spec/analytical/bot_detector_spec.rb
 - spec/analytical/clicky_spec.rb
 - spec/analytical/google_spec.rb
 - spec/analytical/kiss_metrics_spec.rb