analytical 1.9.0 → 2.0.0

data/README.rdoc

@@ -63,6 +63,21 @@ By default, Analytical will be disabled in development mode... and it will enabl
 
 New modules should be fairly easy to add.  Follow the structure that I've used in the Clicky, Google, and KISSMetrics modules... and you should be fine.  All modules should include the Analytical::Base::Api module, so that they have some default behavior for methods that they don't support or need.
 
+== Session-based command queues
+
+By default, any Analytical commands that are queued in a controller that subsequently redirects won't be emitted to the client.  This is because the redirect triggers a new request, and everything is cleared out at the beginning of each request.
+
+However, if you would like to be able to queue commands between requests... there's a new option that supports this behavior:
+
+    analytical :modules=>[:console, :google], :use_session_store=>true
+
+This will store the queued commands in the user session, clearing them out when they are emitted to the client, but allowing you to make calls like:
+
+    Analytical.track 'something'
+
+... in your controller.  After a redirect, the corresponding track() call will be emitted in the next request made by the client.
+NOTE:  This is new and somewhat experimental, and could cause problems if you store large amounts of data in the session.  (there is a 4k limit to session data)
+
 
 == Note on Patches/Pull Requests
 

data/VERSION

@@ -1 +1 @@
-1.9.0
+2.0.0

data/analytical.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{analytical}
-  s.version = "1.9.0"
+  s.version = "2.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Joshua Krall", "Nathan Phelps", "Adam Anderson"]
@@ -26,6 +26,7 @@ Gem::Specification.new do |s|
      "analytical.gemspec",
      "example/.gitignore",
      "example/Gemfile",
+     "example/Gemfile.lock",
      "example/README",
      "example/Rakefile",
      "example/app/controllers/application_controller.rb",
@@ -77,6 +78,7 @@ Gem::Specification.new do |s|
      "lib/analytical.rb",
      "lib/analytical/api.rb",
      "lib/analytical/bot_detector.rb",
+     "lib/analytical/command_store.rb",
      "lib/analytical/modules/adwords.rb",
      "lib/analytical/modules/base.rb",
      "lib/analytical/modules/chartbeat.rb",
@@ -88,9 +90,11 @@ Gem::Specification.new do |s|
      "lib/analytical/modules/hubspot.rb",
      "lib/analytical/modules/kiss_metrics.rb",
      "lib/analytical/modules/optimizely.rb",
+     "lib/analytical/session_command_store.rb",
      "rails/init.rb",
      "spec/analytical/api_spec.rb",
      "spec/analytical/bot_detector_spec.rb",
+     "spec/analytical/command_store_spec.rb",
      "spec/analytical/modules/base_spec.rb",
      "spec/analytical/modules/chartbeat_spec.rb",
      "spec/analytical/modules/clicky_spec.rb",
@@ -98,6 +102,7 @@ Gem::Specification.new do |s|
      "spec/analytical/modules/google_spec.rb",
      "spec/analytical/modules/kiss_metrics_spec.rb",
      "spec/analytical/modules/optimizely_spec.rb",
+     "spec/analytical/session_command_store_spec.rb",
      "spec/analytical_spec.rb",
      "spec/config/analytical.yml",
      "spec/spec.opts",
@@ -111,6 +116,7 @@ Gem::Specification.new do |s|
   s.test_files = [
     "spec/analytical/api_spec.rb",
      "spec/analytical/bot_detector_spec.rb",
+     "spec/analytical/command_store_spec.rb",
      "spec/analytical/modules/base_spec.rb",
      "spec/analytical/modules/chartbeat_spec.rb",
      "spec/analytical/modules/clicky_spec.rb",
@@ -118,6 +124,7 @@ Gem::Specification.new do |s|
      "spec/analytical/modules/google_spec.rb",
      "spec/analytical/modules/kiss_metrics_spec.rb",
      "spec/analytical/modules/optimizely_spec.rb",
+     "spec/analytical/session_command_store_spec.rb",
      "spec/analytical_spec.rb",
      "spec/spec_helper.rb"
   ]

data/example/Gemfile

@@ -1,6 +1,6 @@
 source 'http://rubygems.org'
 
-gem 'rails', '3.0.0.beta3'
+gem 'rails'
 
 # Bundle edge Rails instead:
 # gem 'rails', :git => 'git://github.com/rails/rails.git'

data/example/Gemfile.lock

@@ -0,0 +1,82 @@
+PATH
+  remote: /Users/krall/Programming/analytical
+  specs:
+    analytical (1.8.0)
+      activesupport
+      json
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.0)
+      actionpack (= 3.0.0)
+      mail (~> 2.2.5)
+    actionpack (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4.1)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.12)
+      rack-test (~> 0.5.4)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.0)
+      activesupport (= 3.0.0)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activerecord (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+      arel (~> 1.0.0)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+    activesupport (3.0.0)
+    arel (1.0.1)
+      activesupport (~> 3.0.0)
+    builder (2.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    i18n (0.4.1)
+    json (1.4.6)
+    mail (2.2.5)
+      activesupport (>= 2.3.6)
+      mime-types
+      treetop (>= 1.4.5)
+    mime-types (1.16)
+    polyglot (0.3.1)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.4)
+      rack (>= 1.0)
+    rails (3.0.0)
+      actionmailer (= 3.0.0)
+      actionpack (= 3.0.0)
+      activerecord (= 3.0.0)
+      activeresource (= 3.0.0)
+      activesupport (= 3.0.0)
+      bundler (~> 1.0.0)
+      railties (= 3.0.0)
+    railties (3.0.0)
+      actionpack (= 3.0.0)
+      activesupport (= 3.0.0)
+      rake (>= 0.8.4)
+      thor (~> 0.14.0)
+    rake (0.8.7)
+    sqlite3-ruby (1.3.1)
+    thor (0.14.0)
+    treetop (1.4.8)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.23)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  analytical!
+  rails
+  sqlite3-ruby

data/example/app/controllers/application_controller.rb

@@ -2,5 +2,5 @@ class ApplicationController < ActionController::Base
   protect_from_forgery
   layout 'application'
 
-  analytical :modules=>[:console, :google, :clicky], :disable_if=>lambda{false}
+  analytical :modules=>[:console, :google, :clicky], :disable_if=>lambda{false}, :use_session_store=>true
 end

data/example/app/controllers/page_controller.rb

@@ -6,6 +6,13 @@ class PageController < ApplicationController
   end
 
   def test_b
+    analytical.clicky.track('track link in A')
     analytical.track 'track in controller'
   end
+
+  def test_c
+    analytical.track 'track in controller that redirects'
+    redirect_to root_path
+  end
+
 end

data/example/app/views/page/index.html.erb

@@ -2,4 +2,5 @@
 <p>
 	<%= link_to 'A', '/page/test_a' %><br />
 	<%= link_to 'B', '/page/test_b' %><br />
+	<%= link_to 'C', '/page/test_c' %><br />
 </p>

data/example/app/views/page/test_a.html.erb

@@ -3,6 +3,7 @@
 <h1>Page#test_a</h1>
 <p>
 	<%= link_to 'B', '/page/test_b' %><br />
+	<%= link_to 'C', '/page/test_c' %><br />
 	<%= link_to 'index', '/' %><br />
 	<a href='#' onclick="<%= analytical.now.track('track link in A') %>; return false;">click me to track all modules</a><br />
 </p>

data/example/app/views/page/test_b.html.erb

@@ -1,6 +1,7 @@
 <h1>Page#test_b</h1>
 <p>
 	<%= link_to 'A', '/page/test_a' %><br />
+	<%= link_to 'C', '/page/test_c' %><br />
 	<%= link_to 'index', '/' %><br />
-	<a href='#' onclick="<%= analytical.clicky.track('track link in A') %>; return false;">track clicky only</a><br />
+	<a href='#' onclick="<%= analytical.console.track('track link in A') %>; return false;">track console only</a><br />
 </p>

data/example/config/environment.rb

@@ -3,3 +3,5 @@ require File.expand_path('../application', __FILE__)
 
 # Initialize the rails application
 Example::Application.initialize!
+
+# Rails.backtrace_cleaner.remove_silencers!

data/example/config/environments/development.rb

@@ -16,4 +16,6 @@ Example::Application.configure do
 
   # Don't care if the mailer can't send
   config.action_mailer.raise_delivery_errors = false
+
+  config.active_support.deprecation = :log
 end

data/example/config/routes.rb

@@ -2,8 +2,7 @@ Example::Application.routes.draw do |map|
   get "page/index"
   get "page/test_a"
   get "page/test_b"
-  get "index/test_a"
-  get "index/test_b"
+  get "page/test_c"
 
   # You can have the root of your site routed with "root"
   # just remember to delete public/index.html.

data/lib/analytical.rb

@@ -40,6 +40,7 @@ module Analytical
         if options[:disable_if].call(self)
           options[:modules] = options[:development_modules]
         end
+        options[:session] = session if options[:use_session_store]
         if analytical_is_robot?(request.user_agent)
           options[:modules] = []
         end

data/lib/analytical/api.rb

@@ -1,4 +1,10 @@
 module Analytical
+  module Modules
+    class DummyModule
+      include Analytical::Modules::Base
+      def method_missing(method, *args, &block); nil; end
+    end
+  end
 
   class Api
     attr_accessor :options, :modules
@@ -7,9 +13,12 @@ module Analytical
       @options = options
       @modules = @options[:modules].inject(ActiveSupport::OrderedHash.new) do |h, m|
         module_options = @options.merge(@options[m] || {})
+        module_options.delete(:modules)
+        module_options[:session_store] = Analytical::SessionCommandStore.new(@options[:session], m) if @options[:session]
         h[m] = "Analytical::Modules::#{m.to_s.camelize}".constantize.new(module_options)
         h
       end
+      @dummy_module = Analytical::Modules::DummyModule.new
     end
 
     #
@@ -18,10 +27,13 @@ module Analytical
     # analytical.console.go 'make', :some=>:cookies
     #
     def method_missing(method, *args, &block)
-      if @modules.keys.include?(method.to_sym)
-        @modules[method.to_sym]
+      method = method.to_sym
+      if @modules.keys.include?(method)
+        @modules[method]
+      elsif available_modules.include?(method)
+        @dummy_module
       else
-        process_command method.to_sym, *args
+        process_command method, *args
       end
     end
 
@@ -93,6 +105,13 @@ module Analytical
         m.init_javascript(location)
       end.compact.join("\n")
     end
+
+    def available_modules
+      Dir.glob(File.dirname(__FILE__)+'/modules/*.rb').collect do |f|
+        File.basename(f).sub(/.rb/,'').to_sym
+      end - [:base]
+    end
+
   end
 
 end

data/lib/analytical/command_store.rb

@@ -0,0 +1,19 @@
+module Analytical
+  class CommandStore
+    attr_accessor :commands
+
+    def initialize(initial_list=nil)
+      @commands = initial_list || []
+    end
+
+    def flush
+      @commands = []
+    end
+
+    # Pass any array methods on to the internal array
+    def method_missing(method, *args, &block)
+      @commands.send(method, *args, &block)
+    end
+
+  end
+end

data/lib/analytical/modules/base.rb

@@ -2,13 +2,13 @@ module Analytical
   module Modules
     module Base
       attr_reader :tracking_command_location, :options, :initialized
-      attr_accessor :commands
+      attr_reader :command_store
 
       def initialize(_options={})
         @options = _options
         @tracking_command_location = :body_prepend
         @initialized = false
-        @commands = []
+        @command_store = @options[:session_store] || Analytical::CommandStore.new
       end
 
       def protocol
@@ -43,16 +43,16 @@ module Analytical
 
       def queue(*args)
         if args.first==:identify
-          @commands.unshift args
+          @command_store.unshift args
         else
-          @commands << args
+          @command_store << args
         end
       end
       def process_queued_commands
-        command_strings = @commands.collect do |c|
+        command_strings = @command_store.collect do |c|
           send(*c) if respond_to?(c.first)
         end.compact
-        @commands = []
+        @command_store.flush
         command_strings
       end
 

data/lib/analytical/modules/clicky.rb

@@ -18,13 +18,13 @@ module Analytical
           HTML
 
           identify_commands = []
-          @commands.each do |c|
+          @command_store.commands.each do |c|
             if c[0] == :identify
               identify_commands << identify(*c[1..-1])
             end
           end
           js = identify_commands.join("\n") + "\n" + js
-          @commands = @commands.delete_if {|c| c[0] == :identify }
+          @command_store.commands = @command_store.commands.delete_if {|c| c[0] == :identify }
 
           js
         end

data/lib/analytical/session_command_store.rb

@@ -0,0 +1,39 @@
+module Analytical
+  class SessionCommandStore
+    attr_reader :session, :module_key
+
+    def initialize(session, module_key, initial_list=nil)
+      @session = session
+      @module_key = module_key
+      @session_key = ('analytical_'+module_key.to_s).to_sym
+      ensure_session_setup!(initial_list)
+    end
+
+    def assign(v)
+      self.commands = v
+    end
+
+    def commands
+      @session[@session_key]
+    end
+    def commands=(v)
+      @session[@session_key] = v
+    end
+
+    def flush
+      self.commands = []
+    end
+
+    # Pass any array methods on to the internal array
+    def method_missing(method, *args, &block)
+      commands.send(method, *args, &block)
+    end
+
+    private
+
+    def ensure_session_setup!(initial_list=nil)
+      self.commands ||= (initial_list || [])
+    end
+
+  end
+end

data/spec/analytical/api_spec.rb

@@ -16,6 +16,18 @@ describe "Analytical::Api" do
       Analytical::Modules::Console.should_receive(:new).with(hash_including(:ssl=>true)).and_return(@console = mock('console'))
       Analytical::Api.new :modules=>[:console], :ssl=>true
     end
+    describe 'with a session option' do
+      before(:each) do
+        @session = {}
+      end
+      it 'should create a new SessionCommandStore for each module' do
+        Analytical::SessionCommandStore.should_receive(:new).with(@session, :console).and_return(@console_store = mock('console_store'))
+        Analytical::SessionCommandStore.should_receive(:new).with(@session, :google).and_return(@google_store = mock('google_store'))        
+        Analytical::Modules::Console.should_receive(:new).with(:session_store=>@console_store, :session=>@session).and_return(mock('console'))
+        Analytical::Modules::Google.should_receive(:new).with(:session_store=>@google_store, :session=>@session).and_return(mock('google'))
+        Analytical::Api.new :modules=>[:console, :google], :session=>@session
+      end
+    end
   end
 
   describe 'with modules' do

data/spec/analytical/command_store_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe Analytical::CommandStore do
+  
+  describe 'when behaving exactly like an array' do
+    it 'should add elements' do
+      @store = Analytical::CommandStore.new ['a']
+      @store << 'b'
+      @store.commands.should == ['a', 'b']
+    end
+    it 'should unshift elements' do
+      @store = Analytical::CommandStore.new ['b']
+      @store.unshift 'a'
+      @store.commands.should == ['a', 'b']
+    end
+    it 'should iterate over elements' do
+      @store = Analytical::CommandStore.new ['a', 'b']
+      @store.each do |elem|
+        ['a', 'b'].include?(elem).should be_true
+      end
+    end
+    it 'should have size' do
+      @store = Analytical::CommandStore.new ['a', 'b']
+      @store.size.should == 2
+    end
+  end
+  
+  describe 'when flushing' do
+    it 'should empty the list' do
+      @store = Analytical::CommandStore.new ['a', 'b']
+      @store.flush
+      @store.size.should == 0
+    end
+  end
+  
+end

data/spec/analytical/modules/base_spec.rb

@@ -24,18 +24,18 @@ describe Analytical::Modules::Base do
   describe '#queue' do
     before(:each) do
       @api = BaseApiDummy.new(:parent=>mock('parent'))
-      @api.commands = [:a, :b, :c]
+      @api.command_store.commands = [:a, :b, :c]
     end
     describe 'with an identify command' do
       it 'should store it at the head of the command list' do
         @api.queue :identify, 'someone', {:some=>:args}
-        @api.commands.should == [[:identify, 'someone', {:some=>:args}], :a, :b, :c]
+        @api.command_store.commands.should == [[:identify, 'someone', {:some=>:args}], :a, :b, :c]
       end
     end
     describe 'with any other command' do
       it 'should store it at the end of the command list' do
         @api.queue :other, {:some=>:args}
-        @api.commands.should == [:a, :b, :c, [:other, {:some=>:args}]]
+        @api.command_store.commands.should == [:a, :b, :c, [:other, {:some=>:args}]]
       end
     end
   end
@@ -43,7 +43,7 @@ describe Analytical::Modules::Base do
   describe '#process_queued_commands' do
     before(:each) do
       @api = BaseApiDummy.new(:parent=>mock('parent'))
-      @api.commands = [[:a, 1, 2, 3], [:b, {:some=>:args}]]
+      @api.command_store.commands = [[:a, 1, 2, 3], [:b, {:some=>:args}]]
       @api.stub!(:a).and_return('a')
       @api.stub!(:b).and_return('b')
     end
@@ -57,10 +57,10 @@ describe Analytical::Modules::Base do
     end
     it 'should clear the commands list' do
       @api.process_queued_commands
-      @api.commands == []
+      @api.command_store.commands == []
     end
     it "should not store an unrecognized command" do
-      @api.commands << [:c, 1]
+      @api.command_store.commands << [:c, 1]
       @api.process_queued_commands.should == ['a','b']
     end
   end
@@ -84,7 +84,7 @@ describe Analytical::Modules::Base do
 
   describe '#init_location' do
     before(:each) do
-      @api = BaseApiDummy.new(:parent=>mock('parent'))
+      @api = BaseApiDummy.new
     end
     it 'should check for the init_location' do
       @api.should_receive(:init_location?).with(:some_location).and_return(false)
@@ -112,4 +112,14 @@ describe Analytical::Modules::Base do
     end
   end
 
+  describe 'with a custom session_store' do
+    before(:each) do
+      @session = {}
+      @store = Analytical::SessionCommandStore.new @session, :some_module
+    end
+    it 'should use the session_store' do
+      @api = BaseApiDummy.new :session_store=>@store
+      @api.command_store.should == @store
+    end
+  end
 end

data/spec/analytical/session_command_store_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe Analytical::SessionCommandStore do
+  
+  describe 'with a session hash' do
+    before(:each) do
+      @session = {}
+    end
+    
+    it 'should add elements' do
+      @store = Analytical::SessionCommandStore.new @session, :some_module, ['a']
+      @store << 'b'
+      @session[:analytical_some_module].should == ['a', 'b']
+    end
+    it 'should unshift elements' do
+      @store = Analytical::SessionCommandStore.new @session, :some_module, ['b']
+      @store.unshift 'a'
+      @session[:analytical_some_module].should == ['a', 'b']
+    end
+    it 'should iterate over elements' do
+      @store = Analytical::SessionCommandStore.new @session, :some_module, ['a', 'b']
+      @store.each do |elem|
+        ['a', 'b'].include?(elem).should be_true
+      end
+    end
+    it 'should have size' do
+      @store = Analytical::SessionCommandStore.new @session, :some_module, ['a', 'b']
+      @store.size.should == 2
+    end
+
+    it 'should set up the :analytical session hash' do
+      @store = Analytical::SessionCommandStore.new @session, :some_module, ['a', 'b']
+      @session[:analytical_some_module].should_not be_nil   
+    end
+
+    describe 'when flushing' do
+      it 'should empty the list' do
+        @store = Analytical::SessionCommandStore.new @session, :some_module, ['a', 'b']
+        @store.flush
+        @store.size.should == 0
+      end
+      it 'should empty the session key' do
+        @store = Analytical::SessionCommandStore.new @session, :some_module, ['a', 'b']
+        @store.flush
+        @session[:analytical_some_module].should == []
+      end
+    end
+  end
+  
+end

metadata

@@ -3,10 +3,10 @@ name: analytical
 version: !ruby/object:Gem::Version 
   prerelease: false
   segments: 
-  - 1
-  - 9
+  - 2
   - 0
-  version: 1.9.0
+  - 0
+  version: 2.0.0
 platform: ruby
 authors: 
 - Joshua Krall
@@ -64,6 +64,7 @@ files:
 - analytical.gemspec
 - example/.gitignore
 - example/Gemfile
+- example/Gemfile.lock
 - example/README
 - example/Rakefile
 - example/app/controllers/application_controller.rb
@@ -115,6 +116,7 @@ files:
 - lib/analytical.rb
 - lib/analytical/api.rb
 - lib/analytical/bot_detector.rb
+- lib/analytical/command_store.rb
 - lib/analytical/modules/adwords.rb
 - lib/analytical/modules/base.rb
 - lib/analytical/modules/chartbeat.rb
@@ -126,9 +128,11 @@ files:
 - lib/analytical/modules/hubspot.rb
 - lib/analytical/modules/kiss_metrics.rb
 - lib/analytical/modules/optimizely.rb
+- lib/analytical/session_command_store.rb
 - rails/init.rb
 - spec/analytical/api_spec.rb
 - spec/analytical/bot_detector_spec.rb
+- spec/analytical/command_store_spec.rb
 - spec/analytical/modules/base_spec.rb
 - spec/analytical/modules/chartbeat_spec.rb
 - spec/analytical/modules/clicky_spec.rb
@@ -136,6 +140,7 @@ files:
 - spec/analytical/modules/google_spec.rb
 - spec/analytical/modules/kiss_metrics_spec.rb
 - spec/analytical/modules/optimizely_spec.rb
+- spec/analytical/session_command_store_spec.rb
 - spec/analytical_spec.rb
 - spec/config/analytical.yml
 - spec/spec.opts
@@ -173,6 +178,7 @@ 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/command_store_spec.rb
 - spec/analytical/modules/base_spec.rb
 - spec/analytical/modules/chartbeat_spec.rb
 - spec/analytical/modules/clicky_spec.rb
@@ -180,5 +186,6 @@ test_files:
 - spec/analytical/modules/google_spec.rb
 - spec/analytical/modules/kiss_metrics_spec.rb
 - spec/analytical/modules/optimizely_spec.rb
+- spec/analytical/session_command_store_spec.rb
 - spec/analytical_spec.rb
 - spec/spec_helper.rb