analytical 1.1.1 → 1.2.0

data/VERSION

@@ -1 +1 @@
-1.1.1
+1.2.0

data/analytical.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{analytical}
-  s.version = "1.1.1"
+  s.version = "1.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Joshua Krall"]
@@ -87,6 +87,7 @@ Gem::Specification.new do |s|
      "lib/analytical/kiss_metrics.rb",
      "rails/init.rb",
      "spec/analytical/api_spec.rb",
+     "spec/analytical/base_spec.rb",
      "spec/analytical/bot_detector_spec.rb",
      "spec/analytical/clicky_spec.rb",
      "spec/analytical/google_spec.rb",
@@ -103,6 +104,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/base_spec.rb",
      "spec/analytical/bot_detector_spec.rb",
      "spec/analytical/clicky_spec.rb",
      "spec/analytical/google_spec.rb",

data/lib/analytical/adwords.rb

@@ -9,21 +9,21 @@ module Analytical
       end
 
       def init_javascript(location)
-        return '' unless init_location?(location)
-
-        @initializing = true
-        html = "<!-- Analytical Init: Google Adwords -->\n"
-        event_commands = []
-        @commands.each do |c|
-          if c[0] == :event
-            event_commands << event(*c[1..-1])
+        init_location(location) do
+          @initializing = true
+          html = "<!-- Analytical Init: Google Adwords -->\n"
+          event_commands = []
+          @commands.each do |c|
+            if c[0] == :event
+              event_commands << event(*c[1..-1])
+            end
           end
-        end
-        html += event_commands.join("\n")
-        @commands = @commands.delete_if {|c| c[0] == :event }
-        @initializing = false
+          html += event_commands.join("\n")
+          @commands = @commands.delete_if {|c| c[0] == :event }
+          @initializing = false
 
-        html
+          html
+        end
       end
 
       #

data/lib/analytical/api.rb

@@ -70,7 +70,7 @@ module Analytical
     def tracking_javascript(location)
       commands = []
       @modules.each do |name, m|
-        commands += m.process_queued_commands if m.tracking_command_location==location
+        commands += m.process_queued_commands if m.init_location?(location) || m.initialized
       end
       commands = commands.delete_if{|c| c.blank? || c.empty?}
       unless commands.empty?

data/lib/analytical/base.rb

@@ -1,13 +1,14 @@
 module Analytical
   module Base
     module Api
-      attr_reader :tracking_command_location, :parent, :options
+      attr_reader :tracking_command_location, :parent, :options, :initialized
       attr_accessor :commands
 
       def initialize(_parent, _options={})
         @parent = _parent
         @options = _options
         @tracking_command_location = :body_prepend
+        @initialized = false
         @commands = []
       end
 
@@ -29,7 +30,7 @@ module Analytical
       def set(data); ''; end
 
       # This method generates the initialization javascript that an analytics service uses to track your site
-      def init_javascript(location); {}; end
+      def init_javascript(location); ''; end
 
       def queue(*args)
         if args.first==:identify
@@ -48,6 +49,19 @@ module Analytical
         @tracking_command_location==location
       end
 
+      def init_location(location, &block)
+        if init_location?(location)
+          @initialized = true
+          if block_given?
+            yield
+          else
+            ''
+          end
+        else
+          ''
+        end
+      end
+
     end
   end
 end

data/lib/analytical/clicky.rb

@@ -9,27 +9,27 @@ module Analytical
       end
 
       def init_javascript(location)
-        return '' unless init_location?(location)
-
-        protocol = options[:ssl] ? 'https' : 'http'
-
-        js = <<-HTML
-        <!-- Analytical Init: Clicky -->
-        <script src="#{protocol}://static.getclicky.com/js" type="text/javascript"></script>
-        <script type="text/javascript">clicky.init('#{@options[:key]}');</script>
-        <noscript><p><img alt="Clicky" width="1" height="1" src="#{protocol}://in.getclicky.com/#{@options[:key]}ns.gif" /></p></noscript>
-        HTML
-
-        identify_commands = []
-        @commands.each do |c|
-          if c[0] == :identify
-            identify_commands << identify(*c[1..-1])
+        init_location(location) do
+          protocol = options[:ssl] ? 'https' : 'http'
+
+          js = <<-HTML
+          <!-- Analytical Init: Clicky -->
+          <script src="#{protocol}://static.getclicky.com/js" type="text/javascript"></script>
+          <script type="text/javascript">clicky.init('#{@options[:key]}');</script>
+          <noscript><p><img alt="Clicky" width="1" height="1" src="#{protocol}://in.getclicky.com/#{@options[:key]}ns.gif" /></p></noscript>
+          HTML
+
+          identify_commands = []
+          @commands.each do |c|
+            if c[0] == :identify
+              identify_commands << identify(*c[1..-1])
+            end
           end
-        end
-        js = identify_commands.join("\n") + "\n" + js
-        @commands = @commands.delete_if {|c| c[0] == :identify }
+          js = identify_commands.join("\n") + "\n" + js
+          @commands = @commands.delete_if {|c| c[0] == :identify }
 
-        js
+          js
+        end
       end
 
       def track(*args)

data/lib/analytical/console.rb

@@ -9,14 +9,15 @@ module Analytical
       end
 
       def init_javascript(location)
-        return '' unless init_location?(location)
-        js = <<-HTML
-        <!-- Analytical Init: Console -->
-        <script type="text/javascript">
-          console.log('Analytical Init: Console');
-        </script>
-        HTML
-        js
+        init_location(location) do
+          js = <<-HTML
+          <!-- Analytical Init: Console -->
+          <script type="text/javascript">
+            console.log('Analytical Init: Console');
+          </script>
+          HTML
+          js
+        end
       end
 
       def track(*args)

data/lib/analytical/crazy_egg.rb

@@ -9,14 +9,15 @@ module Analytical
       end
 
       def init_javascript(location)
-        return '' unless init_location?(location)
-        code_url = "#{options[:key][0,4]}/#{options[:key][4,4]}"
-        protocol = options[:ssl] ? 'https' : 'http'
-        js = <<-HTML
-        <!-- Analytical Init: CrazyEgg -->
-        <script type="text/javascript" src="#{protocol}://s3.amazonaws.com/new.cetrk.com/pages/scripts/#{code_url}.js"> </script>
-        HTML
-        js
+        init_location(location) do
+          code_url = "#{options[:key][0,4]}/#{options[:key][4,4]}"
+          protocol = options[:ssl] ? 'https' : 'http'
+          js = <<-HTML
+          <!-- Analytical Init: CrazyEgg -->
+          <script type="text/javascript" src="#{protocol}://s3.amazonaws.com/new.cetrk.com/pages/scripts/#{code_url}.js"> </script>
+          HTML
+          js
+        end
       end
 
     end

data/lib/analytical/google.rb

@@ -9,20 +9,21 @@ module Analytical
       end
 
       def init_javascript(location)
-        return '' unless init_location?(location)
-        js = <<-HTML
-        <!-- Analytical Init: Google -->
-        <script type="text/javascript">
-          var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
-          document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
-        </script>
-        <script type="text/javascript">
-          var googleAnalyticsTracker = _gat._getTracker("#{options[:key]}");
-          googleAnalyticsTracker._initData();
-          googleAnalyticsTracker._trackPageview();
-        </script>
-        HTML
-        js
+        init_location(location) do
+          js = <<-HTML
+          <!-- Analytical Init: Google -->
+          <script type="text/javascript">
+            var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
+            document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
+          </script>
+          <script type="text/javascript">
+            var googleAnalyticsTracker = _gat._getTracker("#{options[:key]}");
+            googleAnalyticsTracker._initData();
+            googleAnalyticsTracker._trackPageview();
+          </script>
+          HTML
+          js
+        end
       end
 
       def track(*args)

data/lib/analytical/hubspot.rb

@@ -9,17 +9,18 @@ module Analytical
       end
 
       def init_javascript(location)
-        return '' unless init_location?(location)
-        js = <<-HTML
-        <!-- Analytical Init: Hubspot -->
-        <script type="text/javascript" language="javascript">
-        var hs_portalid=#{options[:portal_id]};
-        var hs_salog_version = "2.00";
-        var hs_ppa = "#{options[:domain]}";
-        document.write(unescape("%3Cscript src='" + document.location.protocol + "//" + hs_ppa + "/salog.js.aspx' type='text/javascript'%3E%3C/script%3E"));
-        </script>
-        HTML
-        js
+        init_location(location) do
+          js = <<-HTML
+          <!-- Analytical Init: Hubspot -->
+          <script type="text/javascript" language="javascript">
+          var hs_portalid=#{options[:portal_id]};
+          var hs_salog_version = "2.00";
+          var hs_ppa = "#{options[:domain]}";
+          document.write(unescape("%3Cscript src='" + document.location.protocol + "//" + hs_ppa + "/salog.js.aspx' type='text/javascript'%3E%3C/script%3E"));
+          </script>
+          HTML
+          js
+        end
       end
 
     end

data/lib/analytical/kiss_metrics.rb

@@ -9,18 +9,19 @@ module Analytical
       end
 
       def init_javascript(location)
-        return '' unless init_location?(location)
-        js = <<-HTML
-        <!-- Analytical Init: KissMetrics -->
-        <script type="text/javascript">
-          var _kmq = _kmq || [];
-          (function(){function _kms(u,d){if(navigator.appName.indexOf("Microsoft")==0 && d)document.write("<scr"+"ipt defer='defer' async='true' src='"+u+"'></scr"+"ipt>");else{var s=document.createElement('script');s.type='text/javascript';s.async=true;s.src=u;(document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(s);}}_kms('http' + ('https:' == document.location.protocol ? 's://': '://') + 'i.kissmetrics.com/i.js', 1);_kms('http'+('https:'==document.location.protocol ? 's://s3.amazonaws.com/' : '://')+'scripts.kissmetrics.com/#{options[:key]}.1.js',1);})();
-        </script>
-        <script type="text/javascript">
-          _kmq.push(['pageView']);
-        </script>
-        HTML
-        js
+        init_location(location) do
+          js = <<-HTML
+          <!-- Analytical Init: KissMetrics -->
+          <script type="text/javascript">
+            var _kmq = _kmq || [];
+            (function(){function _kms(u,d){if(navigator.appName.indexOf("Microsoft")==0 && d)document.write("<scr"+"ipt defer='defer' async='true' src='"+u+"'></scr"+"ipt>");else{var s=document.createElement('script');s.type='text/javascript';s.async=true;s.src=u;(document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(s);}}_kms('http' + ('https:' == document.location.protocol ? 's://': '://') + 'i.kissmetrics.com/i.js', 1);_kms('http'+('https:'==document.location.protocol ? 's://s3.amazonaws.com/' : '://')+'scripts.kissmetrics.com/#{options[:key]}.1.js',1);})();
+          </script>
+          <script type="text/javascript">
+            _kmq.push(['pageView']);
+          </script>
+          HTML
+          js
+        end
       end
 
       def identify(id, *args)

data/spec/analytical/api_spec.rb

@@ -8,8 +8,8 @@ describe "Analytical::Api" do
       Analytical::Google::Api.should_receive(:new).and_return(@google = mock('google'))
       a = Analytical::Api.new :modules=>[:console, :google]
       a.modules.should == {
-        :console=>@console, 
-        :google=>@google, 
+        :console=>@console,
+        :google=>@google,
       }
     end
   end
@@ -18,47 +18,47 @@ describe "Analytical::Api" do
     before(:each) do
       Analytical::Console::Api.stub!(:new).and_return(@console = mock('console'))
       Analytical::Google::Api.stub!(:new).and_return(@google = mock('google'))
-      Analytical::Clicky::Api.stub!(:new).and_return(@clicky = mock('clicky'))      
-      
+      Analytical::Clicky::Api.stub!(:new).and_return(@clicky = mock('clicky'))
+
       @api = Analytical::Api.new :modules=>[:console, :google]
     end
 
     describe '#track' do
       it 'should store the #track command for each module api class' do
         @api = Analytical::Api.new :modules=>[:console, :google, :clicky]
-              
+
         @console.should_receive(:queue).with(:track, 'something', {:a=>1, :b=>2})
         @clicky.should_receive(:queue).with(:track, 'something', {:a=>1, :b=>2})
         @google.should_receive(:queue).with(:track, 'something', {:a=>1, :b=>2})
-        
+
         @api.track('something', {:a=>1, :b=>2})
       end
     end
-    
+
     describe '#identify' do
       it 'should store the #track command for each module api class' do
         @api = Analytical::Api.new :modules=>[:console, :google, :clicky]
-              
+
         @console.should_receive(:queue).with(:identify, 'something', {:a=>1, :b=>2})
         @clicky.should_receive(:queue).with(:identify, 'something', {:a=>1, :b=>2})
         @google.should_receive(:queue).with(:identify, 'something', {:a=>1, :b=>2})
-        
+
         @api.identify('something', {:a=>1, :b=>2})
       end
     end
-    
+
     describe '#now' do
       it 'should call a command on each module and collect the results' do
-        @api = Analytical::Api.new :modules=>[:console, :google, :clicky]        
+        @api = Analytical::Api.new :modules=>[:console, :google, :clicky]
 
         @console.should_receive(:track).with('something', {:a=>1, :b=>2}).and_return('console track')
         @clicky.should_receive(:track).with('something', {:a=>1, :b=>2}).and_return('clicky track')
         @google.should_receive(:track).with('something', {:a=>1, :b=>2}).and_return('google track')
-        
+
         @api.now.track('something', {:a=>1, :b=>2}).should == "console track\ngoogle track\nclicky track"
       end
     end
-    
+
     describe 'when accessing a module by name' do
       it 'should return the module api object' do
         @api = Analytical::Api.new :modules=>[:console, :google, :clicky]
@@ -67,12 +67,14 @@ describe "Analytical::Api" do
         @api.google.should == @google
       end
     end
-        
+
     describe 'gathering javascript' do
       before(:each) do
-        @console.stub!(:tracking_command_location).and_return(:body_prepend)
+        @console.stub!(:init_location?).and_return(false)
+        @console.stub!(:initialized).and_return(false)
         @console.stub!(:process_queued_commands).and_return([])
-        @google.stub!(:tracking_command_location).and_return(:body_prepend)
+        @google.stub!(:init_location?).and_return(false)
+        @google.stub!(:initialized).and_return(false)
         @google.stub!(:process_queued_commands).and_return([])
       end
       describe '#head_javascript' do
@@ -91,19 +93,23 @@ describe "Analytical::Api" do
       end
       describe '#body_append_javascript' do
         it 'should return the javascript' do
-          @console.should_receive(:init_javascript).with(:body_append).and_return('console_c')                
-          @google.should_receive(:init_javascript).with(:body_append).and_return('google_c')                
+          @console.should_receive(:init_javascript).with(:body_append).and_return('console_c')
+          @google.should_receive(:init_javascript).with(:body_append).and_return('google_c')
           @api.body_append_javascript.should == "console_c\ngoogle_c"
         end
       end
       describe 'with stored commands' do
         before(:each) do
+          @console.stub!(:init_location?).and_return(true)
+          @console.stub!(:initialized).and_return(false)
           @console.stub!(:track).and_return('console track called')
           @console.stub!(:queue)
-          @console.stub!(:process_queued_commands).and_return(['console track called'])          
+          @console.stub!(:process_queued_commands).and_return(['console track called'])
+          @google.stub!(:init_location?).and_return(false)
+          @google.stub!(:initialized).and_return(true)
           @google.stub!(:track).and_return('google track called')
-          @google.stub!(:queue)          
-          @google.stub!(:process_queued_commands).and_return(['google track called'])          
+          @google.stub!(:queue)
+          @google.stub!(:process_queued_commands).and_return(['google track called'])
           @api.track('something', {:a=>1, :b=>2})
         end
         describe '#body_prepend_javascript' do

data/spec/analytical/base_spec.rb

@@ -0,0 +1,96 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Analytical::Base::Api do
+  
+  class BaseApiDummy
+    include Analytical::Base::Api
+  end
+  
+  describe '#queue' do
+    before(:each) do
+      @api = BaseApiDummy.new(mock('parent'))
+      @api.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]
+      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}]]
+      end
+    end
+  end
+
+  describe '#process_queued_commands' do
+    before(:each) do
+      @api = BaseApiDummy.new(mock('parent'))
+      @api.commands = [[:a, 1, 2, 3], [:b, {:some=>:args}]]
+      @api.stub!(:a).and_return('a')
+      @api.stub!(:b).and_return('b')      
+    end
+    it 'should send each of the args arrays in the command list' do
+      @api.should_receive(:a).with(1, 2, 3).and_return('a')
+      @api.should_receive(:b).with({:some=>:args}).and_return('b')
+      @api.process_queued_commands
+    end
+    it 'should return the results as an array' do
+      @api.process_queued_commands.should == ['a', 'b']
+    end
+    it 'should clear the commands list' do
+      @api.process_queued_commands
+      @api.commands == []
+    end
+  end
+
+  describe '#init_location?' do
+    before(:each) do
+      @api = BaseApiDummy.new(mock('parent'))
+      @api.instance_variable_set '@tracking_command_location', :my_location
+    end
+    describe 'when the command location matches the init location' do
+      it 'should return true' do
+        @api.init_location?(:my_location).should be_true
+      end
+    end
+    describe 'when the command location does not match the init location' do
+      it 'should return false' do
+        @api.init_location?(:not_my_location).should be_false
+      end
+    end
+  end
+
+  describe '#init_location' do
+    before(:each) do
+      @api = BaseApiDummy.new(mock('parent'))
+    end
+    it 'should check for the init_location' do
+      @api.should_receive(:init_location?).with(:some_location).and_return(false)
+      @api.init_location(:some_location)
+    end
+    describe 'for a valid init location' do
+      before(:each) { @api.stub!(:init_location?).and_return(true) }      
+      it 'should set initialized to true' do
+        @api.init_location(:some_location)
+        @api.initialized.should be_true
+      end
+      it 'should yield to the block and return its result' do
+        @api.init_location(:some_location) do
+          'result from the block'
+        end.should == 'result from the block'
+      end
+    end
+    describe 'not for an init location' do
+      before(:each) do
+        @api.stub!(:init_location?).and_return(false)
+      end
+      it 'should return an empty string' do
+        @api.init_location(:not_my_init_location).should == ''
+      end
+    end
+  end
+  
+end

data/spec/analytical/kiss_metrics_spec.rb

@@ -35,7 +35,7 @@ describe "Analytical::KissMetrics::Api" do
   describe '#set' do
     it 'should return a js string' do
       @api = Analytical::KissMetrics::Api.new @parent, {:key=>'abcdef'}
-      @api.set({:something=>'good', :b=>2}).should == "_kmq.push([\"set\", {\"something\":\"good\",\"b\":2}]);"
+      @api.set({:something=>'good', :b=>2}).should == "_kmq.push([\"set\", #{{:something=>'good', :b=>2}.to_json}]);"
     end
   end
   describe '#init_javascript' do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: analytical
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 31
   prerelease: false
   segments: 
   - 1
-  - 1
-  - 1
-  version: 1.1.1
+  - 2
+  - 0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Joshua Krall
@@ -128,6 +128,7 @@ files:
 - lib/analytical/kiss_metrics.rb
 - rails/init.rb
 - spec/analytical/api_spec.rb
+- spec/analytical/base_spec.rb
 - spec/analytical/bot_detector_spec.rb
 - spec/analytical/clicky_spec.rb
 - spec/analytical/google_spec.rb
@@ -172,6 +173,7 @@ specification_version: 3
 summary: Gem for managing multiple analytics services in your rails app.
 test_files: 
 - spec/analytical/api_spec.rb
+- spec/analytical/base_spec.rb
 - spec/analytical/bot_detector_spec.rb
 - spec/analytical/clicky_spec.rb
 - spec/analytical/google_spec.rb