analytical 1.6.0 → 1.7.0

data/README.rdoc

@@ -10,7 +10,7 @@ Service implementations include:
 * Hubspot[http://hubspot.com]
 * CrazyEgg[http://www.crazyegg.com]
 * Chartbeat[http://chartbeat.com]
-* comScore Direct[http://direct.comscore.com]
+* "ComScore Direct"[http://direct.comscore.com]
 * Optimizely[http://www.optimizely.com]
 
 == Usage
@@ -75,6 +75,16 @@ I would be extremely happy to accept contributions to this project!  If you thin
   (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
 * Send me a pull request. Bonus points for topic branches.
 
+== Current Contributors
+
+These fine folks have contributed patches and new features to this project:
+
+* "Adam Anderson"[http://github.com/scudco]
+* "Bryan Liles"[http://github.com/bryanl]
+
+Thanks guys!
+
+
 == Copyright
 
 Copyright (c) 2010 Joshua Krall. See LICENSE for details.

data/Rakefile

@@ -9,7 +9,7 @@ begin
     gem.description = %Q{Gem for managing multiple analytics services in your rails app.}
     gem.email = "josh@transfs.com"
     gem.homepage = "http://github.com/jkrall/analytical"
-    gem.authors = ["Joshua Krall", "Nathan Phelps"]
+    gem.authors = ["Joshua Krall", "Nathan Phelps", "Adam Anderson"]
     gem.add_development_dependency "rspec", ">= 1.2.9"
     gem.add_dependency "activesupport"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings

data/VERSION

@@ -1 +1 @@
-1.6.0
+1.7.0

data/analytical.gemspec

@@ -5,10 +5,10 @@
 
 Gem::Specification.new do |s|
   s.name = %q{analytical}
-  s.version = "1.6.0"
+  s.version = "1.7.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Joshua Krall", "Nathan Phelps"]
+  s.authors = ["Joshua Krall", "Nathan Phelps", "Adam Anderson"]
   s.date = %q{2010-09-10}
   s.description = %q{Gem for managing multiple analytics services in your rails app.}
   s.email = %q{josh@transfs.com}
@@ -106,7 +106,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/jkrall/analytical}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
+  s.rubygems_version = %q{1.3.6}
   s.summary = %q{Gem for managing multiple analytics services in your rails app.}
   s.test_files = [
     "spec/analytical/api_spec.rb",
@@ -126,7 +126,7 @@ Gem::Specification.new do |s|
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
       s.add_runtime_dependency(%q<activesupport>, [">= 0"])
     else

data/lib/analytical/base.rb

@@ -12,25 +12,31 @@ module Analytical
         @commands = []
       end
 
+      #
+      # The core methods that most analytics services implement are listed below.
+      # Modules will ignore any calls that they don't respond to, allowing them to
+      # only partially implement this basic template (or implement their own arbitrary custom methods)
+      #
+
       # This is used to record page-view events, where you want to pass a URL to an analytics service
-      def track(*args); ''; end
+      # def track(*args)
 
       # Identify provides a unique identifier to an analytics service to keep track of the current user
       # id should be a unique string (depending on which service you use), and some services also
       # make use of a data hash as a second parameters, containing :email=>'test@test.com', for instance
-      def identify(id, *args); ''; end
+      # def identify(id, *args)
 
       # Event is meant to track important funnel conversions in your app, or other important events
       # that you want to inform a funnel analytics service about.  You can pass optional data to this method as well.
-      def event(name, *args); ''; end
+      # def event(name, *args)
 
       # Set passes some data to the analytics service that should be attached to the current user identity
       # It can be used to set AB-testing choices and other unique data, so that split testing results can be
       # reported by an analytics service
-      def set(data); ''; end
+      # def set(data)
 
       # This method generates the initialization javascript that an analytics service uses to track your site
-      def init_javascript(location); ''; end
+      # def init_javascript(location)
 
       def queue(*args)
         if args.first==:identify
@@ -40,7 +46,9 @@ module Analytical
         end
       end
       def process_queued_commands
-        command_strings = @commands.collect {|c| send(*c) }
+        command_strings = @commands.collect do |c|
+          send(*c) if respond_to?(c.first)
+        end.compact
         @commands = []
         command_strings
       end
@@ -68,4 +76,4 @@ module Analytical
 
     end
   end
-end
+end

data/lib/analytical/console.rb

@@ -51,6 +51,12 @@ module Analytical
         HERE
       end
 
+      def alias_identity(old_identity,new_identity)
+        check_for_console <<-HERE
+        console.log("Analytical Alias: #{old_identity} => #{new_identity}");
+        HERE
+      end
+
       private
 
       CONSOLE_JS_ESCAPE_MAP = {
@@ -61,7 +67,7 @@ module Analytical
         "\r" => '\n',
         '"' => '\\"',
         "'" => "\\'"
-      }
+      } unless defined?(CONSOLE_JS_ESCAPE_MAP)
 
       def escape(js)
         js.to_s.gsub(/(\\|<\/|\r\n|[\n\r"'])/) { CONSOLE_JS_ESCAPE_MAP[$1] }

data/lib/analytical/kiss_metrics.rb

@@ -45,6 +45,10 @@ module Analytical
         "_kmq.push([\"set\", #{data.to_json}]);"
       end
 
+      def alias_identity(old_identity, new_identity)
+        "_kmq.push([\"alias\", \"#{old_identity}\", \"#{new_identity}\"]);"
+      end
+
     end
   end
-end
+end

data/spec/analytical/base_spec.rb

@@ -1,11 +1,11 @@
 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(:parent=>mock('parent'))
@@ -30,7 +30,7 @@ describe Analytical::Base::Api do
       @api = BaseApiDummy.new(:parent=>mock('parent'))
       @api.commands = [[:a, 1, 2, 3], [:b, {:some=>:args}]]
       @api.stub!(:a).and_return('a')
-      @api.stub!(:b).and_return('b')      
+      @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')
@@ -44,6 +44,10 @@ describe Analytical::Base::Api do
       @api.process_queued_commands
       @api.commands == []
     end
+    it "should not store an unrecognized command" do
+      @api.commands << [:c, 1]
+      @api.process_queued_commands.should == ['a','b']
+    end
   end
 
   describe '#init_location?' do
@@ -72,7 +76,7 @@ describe Analytical::Base::Api do
       @api.init_location(:some_location)
     end
     describe 'for a valid init location' do
-      before(:each) { @api.stub!(:init_location?).and_return(true) }      
+      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
@@ -92,5 +96,5 @@ describe Analytical::Base::Api do
       end
     end
   end
-  
+
 end

data/spec/analytical/chartbeat_spec.rb

@@ -14,18 +14,6 @@ describe "Analytical::Chartbeat::Api" do
       a.options.should == {:key=>12345, :domain => 'abcdef.com', :parent=>@parent}
     end
   end
-  describe '#track' do
-    it 'should return the tracking javascript' do
-      @api = Analytical::Chartbeat::Api.new :parent=>@parent, :key=>12345
-      @api.track.should == ''
-    end
-  end
-  describe '#identify' do
-    it 'should return an empty string' do
-      @api = Analytical::Chartbeat::Api.new :parent=>@parent, :key=>12345
-      @api.identify('nothing', {:matters=>'at all'}).should == ''
-    end
-  end
   describe '#init_javascript' do
     it 'should return the init javascript' do
       @api = Analytical::Chartbeat::Api.new :parent=>@parent, :key=>12345, :domain =>'abcdef.com'

data/spec/analytical/comscore_spec.rb

@@ -14,20 +14,6 @@ describe "Analytical::Comscore::Api" do
       a.options.should == {:key=>1234, :parent=>@parent}
     end
   end
-  describe '#track' do
-    it 'should return the tracking javascript' do
-      @api = Analytical::Comscore::Api.new :parent=>@parent, :key=>123
-      @api.track('pagename', {:some=>'data'}).should == ''
-    end
-  end
-
-  describe '#identify' do
-    it 'should return an empty string' do
-      @api = Analytical::Comscore::Api.new :parent=>@parent, :key=>123
-      @api.identify('nothing', {:matters=>'at all'}).should == ''
-    end
-  end
-
   describe '#init_javascript' do
     it 'should return the init javascript' do
       @api = Analytical::Comscore::Api.new :parent=>@parent, :key=>1234

data/spec/analytical/google_spec.rb

@@ -21,12 +21,6 @@ describe "Analytical::Google::Api" do
       @api.track('pagename', {:some=>'data'}).should ==  "_gaq.push(['_trackPageview', \"pagename\"]);"
     end
   end
-  describe '#identify' do
-    it 'should return an empty string' do
-      @api = Analytical::Google::Api.new :parent=>@parent, :key=>'abcdef'
-      @api.identify('nothing', {:matters=>'at all'}).should == ''
-    end
-  end
   describe '#init_javascript' do
     it 'should return the init javascript' do
       @api = Analytical::Google::Api.new :parent=>@parent, :key=>'abcdef'

data/spec/analytical/kiss_metrics_spec.rb

@@ -14,12 +14,6 @@ describe "Analytical::KissMetrics::Api" do
       a.options.should == {:js_url_key=>'abc', :parent=>@parent}
     end
   end
-  describe '#track' do
-    it 'should return the tracking javascript' do
-      @api = Analytical::KissMetrics::Api.new :parent=>@parent, :js_url_key=>'abcdef'
-      @api.track('pagename', {:some=>'data'}).should == ''
-    end
-  end
   describe '#identify' do
     it 'should return a js string' do
       @api = Analytical::KissMetrics::Api.new :parent=>@parent, :js_url_key=>'abcdef'
@@ -38,13 +32,19 @@ describe "Analytical::KissMetrics::Api" do
       @api.set({:something=>'good', :b=>2}).should == "_kmq.push([\"set\", #{{:something=>'good', :b=>2}.to_json}]);"
     end
   end
+  describe '#alias_identity' do
+    it 'should return a js string' do
+      @api = Analytical::KissMetrics::Api.new :parent=>@parent, :js_url_key=>'abcdef'
+      @api.alias_identity('foo', 'bar').should == "_kmq.push([\"alias\", \"foo\", \"bar\"]);"
+    end
+  end
   describe '#init_javascript' do
     it 'should return the init javascript' do
       @api = Analytical::KissMetrics::Api.new :parent=>@parent, :js_url_key=>'abcdef'
       @api.init_javascript(:head_prepend).should == ''
       @api.init_javascript(:head_append).should == ''
       @api.init_javascript(:body_prepend).should =~ /i\.kissmetrics\.com/
-      @api.init_javascript(:body_prepend).should =~ /abcdef/      
+      @api.init_javascript(:body_prepend).should =~ /abcdef/
       @api.init_javascript(:body_append).should == ''
     end
   end

data/spec/analytical/optimizely_spec.rb

@@ -14,20 +14,6 @@ describe "Analytical::Optimizely::Api" do
       a.options.should == {:key=>'abc', :parent=>@parent}
     end
   end
-  describe '#track' do
-    it 'should return the tracking javascript' do
-      @api = Analytical::Optimizely::Api.new :parent=>@parent, :key=>'abcdef'
-      @api.track('pagename', {:some=>'data'}).should == ''
-    end
-  end
-
-  describe '#identify' do
-    it 'should return an empty string' do
-      @api = Analytical::Optimizely::Api.new :parent=>@parent, :key=>'abcdef'
-      @api.identify('nothing', {:matters=>'at all'}).should == ''
-    end
-  end
-
   describe '#init_javascript' do
     it 'should return the init javascript' do
       @api = Analytical::Optimizely::Api.new :parent=>@parent, :key=>'abcdef'

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification 
 name: analytical
 version: !ruby/object:Gem::Version 
-  hash: 15
   prerelease: false
   segments: 
   - 1
-  - 6
+  - 7
   - 0
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors: 
 - Joshua Krall
 - Nathan Phelps
+- Adam Anderson
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -23,11 +23,9 @@ dependencies:
   name: rspec
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 13
         segments: 
         - 1
         - 2
@@ -39,11 +37,9 @@ dependencies:
   name: activesupport
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
@@ -154,27 +150,23 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Gem for managing multiple analytics services in your rails app.