analytical 2.2.0 → 2.3.0

data/README.rdoc

@@ -55,7 +55,7 @@ You can sprinkle the track() and event() tracking methods throughout your views
     analytical.track '/a/really/nice/url'
     analytical.event 'Some Awesome Event', :with=>:data
 
-By default, Analytical will be disabled in development mode... and it will enable the Console module only.  To change this behavior, you can pass a Proc/lambda to the :disable_if option, as well as specify the :development_modules that you want to use:
+By default, Analytical will be disabled in all environments except 'production'... and it will enable the Console module only.  To change this behavior, you can pass a Proc/lambda to the :disable_if option, as well as specify the :development_modules that you want to use:
 
     analytical :modules=>[:google], :development_modules=>[], :disable_if=>lambda{ |controller| controller.i_can_haz_tracking? }
 

data/VERSION

@@ -1 +1 @@
-2.2.0
+2.3.0

data/analytical.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{analytical}
-  s.version = "2.2.0"
+  s.version = "2.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Joshua Krall", "Nathan Phelps", "Adam Anderson"]
-  s.date = %q{2010-09-30}
+  s.date = %q{2011-01-12}
   s.description = %q{Gem for managing multiple analytics services in your rails app.}
   s.email = %q{josh@transfs.com}
   s.extra_rdoc_files = [
@@ -89,6 +89,7 @@ Gem::Specification.new do |s|
      "lib/analytical/modules/google.rb",
      "lib/analytical/modules/hubspot.rb",
      "lib/analytical/modules/kiss_metrics.rb",
+     "lib/analytical/modules/mixpanel.rb",
      "lib/analytical/modules/optimizely.rb",
      "lib/analytical/session_command_store.rb",
      "rails/init.rb",
@@ -102,6 +103,7 @@ Gem::Specification.new do |s|
      "spec/analytical/modules/comscore_spec.rb",
      "spec/analytical/modules/google_spec.rb",
      "spec/analytical/modules/kiss_metrics_spec.rb",
+     "spec/analytical/modules/mixpanel_spec.rb",
      "spec/analytical/modules/optimizely_spec.rb",
      "spec/analytical/session_command_store_spec.rb",
      "spec/analytical_spec.rb",
@@ -125,6 +127,7 @@ Gem::Specification.new do |s|
      "spec/analytical/modules/comscore_spec.rb",
      "spec/analytical/modules/google_spec.rb",
      "spec/analytical/modules/kiss_metrics_spec.rb",
+     "spec/analytical/modules/mixpanel_spec.rb",
      "spec/analytical/modules/optimizely_spec.rb",
      "spec/analytical/session_command_store_spec.rb",
      "spec/analytical_spec.rb",

data/lib/analytical/modules/mixpanel.rb

@@ -0,0 +1,51 @@
+module Analytical
+  module Modules
+    class Mixpanel
+      include Analytical::Modules::Base
+
+      def initialize(options={})
+        super
+        @tracking_command_location = :body_append
+      end
+
+      def init_javascript(location)
+        init_location(location) do
+          js = <<-HTML
+          <!-- Analytical Init: Mixpanel -->
+          <script type="text/javascript" src="http://api.mixpanel.com/site_media/js/api/mixpanel.js"></script>
+          <script type="text/javascript">
+              try {
+                  var mix = new MixpanelLib('#{options[:key]}');
+              } catch(err) {
+                  null_fn = function () {};
+                  var mpmetrics = { track: null_fn, track_funnel: null_fn, register: null_fn, register_once: null_fn };
+              }
+          </script>
+          HTML
+          js
+        end
+      end
+
+      def track(event, properties = {})
+        callback = properties.delete(:callback) || "function(){}"
+        "mpmetrics.track('#{event}', #{properties.to_json}, #{callback});"
+      end
+
+      def identify(id, *args)
+        "mpmetrics.identify('#{id}');"
+      end
+
+      def event(funnel, *args)
+        data = args.last || {}
+        step = data.delete(:step)
+        goal = data.delete(:goal)
+        callback = data.delete(:callback) || "function(){}"
+        return "/* API Error: Funnel is not set for 'mpmetrics.track_funnel(funnel:string, step:int, goal:string, properties:object, callback:function); */" if funnel.blank?
+        return "/* API Error: Step is not set for 'mpmetrics.track_funnel(#{funnel}, ...); */" unless step && step.to_i >= 0
+        return "/* API Error: Goal is not set for 'mpmetrics.track_funnel(#{funnel}, #{step}, ...); */" if goal.blank?
+        "mpmetrics.track_funnel('#{funnel}', '#{step}', '#{goal}', #{data.to_json}, #{callback});"
+      end
+
+    end
+  end
+end

data/spec/analytical/modules/mixpanel_spec.rb

@@ -0,0 +1,71 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe "Analytical::Modules::Mixpanel" do
+  before(:each) do
+    @parent = mock('api', :options=>{:google=>{:js_url_key=>'abc'}})
+  end
+  describe 'on initialize' do
+    it 'should set the command_location' do
+      a = Analytical::Modules::Mixpanel.new :parent=>@parent, :js_url_key=>'abc'
+      a.tracking_command_location.should == :body_append
+    end
+    it 'should set the options' do
+      a = Analytical::Modules::Mixpanel.new :parent=>@parent, :js_url_key=>'abc'
+      a.options.should == {:js_url_key=>'abc', :parent=>@parent}
+    end
+  end
+  describe '#identify' do
+    it 'should return a js string' do
+      @api = Analytical::Modules::Mixpanel.new :parent=>@parent, :js_url_key=>'abcdef'
+      @api.identify('id', {:email=>'test@test.com'}).should == "mpmetrics.identify('id');"
+    end
+  end
+  describe '#track' do
+    it 'should return the tracking javascript' do
+      @api = Analytical::Modules::Mixpanel.new :parent=>@parent, :key=>'abcdef'
+      @api.track('pagename', {:some=>'data'}).should == "mpmetrics.track('pagename', {\"some\":\"data\"}, function(){};);"
+    end
+    it 'should return the tracking javascript with a callback' do
+      @api = Analytical::Modules::Mixpanel.new :parent=>@parent, :key=>'abcdef'
+      @api.track('pagename', {:some=>'data', :callback=>'fubar'}).should == "mpmetrics.track('pagename', {\"some\":\"data\"}, fubar);"
+    end
+  end
+  describe '#event' do
+    it 'should return a js string' do
+      @api = Analytical::Modules::Mixpanel.new :parent=>@parent, :js_url_key=>'abcdef'
+      @api.event('My Funnel', {:step=>5, :goal=>'thegoal'}).should == "mpmetrics.track_funnel('My Funnel', '5', 'thegoal', {}, function(){};);"
+    end
+    describe 'without the proper data' do
+      it 'should return an error string with blank funnel' do
+        @api = Analytical::Modules::Mixpanel.new :parent=>@parent, :js_url_key=>'abcdef'
+        @api.event('', {:step=>5, :goal=>'thegoal'}).should =~ /Funnel is not set/
+      end
+      it 'should return an error string with blank step' do
+        @api = Analytical::Modules::Mixpanel.new :parent=>@parent, :js_url_key=>'abcdef'
+        @api.event('My Funnel', {:goal=>'thegoal'}).should =~ /Step is not set/
+      end
+      it 'should return an error string with step < 0' do
+        @api = Analytical::Modules::Mixpanel.new :parent=>@parent, :js_url_key=>'abcdef'
+        @api.event('My Funnel', {:step=>-1, :goal=>'thegoal'}).should =~ /Step is not set/
+      end
+      it 'should return an error string with blank goal' do
+        @api = Analytical::Modules::Mixpanel.new :parent=>@parent, :js_url_key=>'abcdef'
+        @api.event('My Funnel', {:step=>5}).should =~ /Goal is not set/
+      end
+    end
+    it 'should return a js string' do
+      @api = Analytical::Modules::Mixpanel.new :parent=>@parent, :js_url_key=>'abcdef'
+      @api.event('My Funnel', {:step=>5, :goal=>'thegoal', :callback=>'thecallback', :other=>'data'}).should == "mpmetrics.track_funnel('My Funnel', '5', 'thegoal', {\"other\":\"data\"}, thecallback);"
+    end
+  end
+  describe '#init_javascript' do
+    it 'should return the init javascript' do
+      @api = Analytical::Modules::Mixpanel.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 == ''
+      @api.init_javascript(:body_append).should =~ /api\.mixpanel\.com\/site_media\/js\/api\/mixpanel\.js/
+      @api.init_javascript(:body_append).should =~ /new MixpanelLib\('.*'\)/
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -8,11 +8,6 @@ require 'spec'
 require 'spec/autorun'
 
 require 'analytical'
-require 'analytical/api'
-require 'analytical/base'
-require 'analytical/console'
-require 'analytical/google'
-require 'analytical/clicky'
 
 Spec::Runner.configure do |config|
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 2
-  - 2
+  - 3
   - 0
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors: 
 - Joshua Krall
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-30 00:00:00 -05:00
+date: 2011-01-12 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -127,6 +127,7 @@ files:
 - lib/analytical/modules/google.rb
 - lib/analytical/modules/hubspot.rb
 - lib/analytical/modules/kiss_metrics.rb
+- lib/analytical/modules/mixpanel.rb
 - lib/analytical/modules/optimizely.rb
 - lib/analytical/session_command_store.rb
 - rails/init.rb
@@ -140,6 +141,7 @@ files:
 - spec/analytical/modules/comscore_spec.rb
 - spec/analytical/modules/google_spec.rb
 - spec/analytical/modules/kiss_metrics_spec.rb
+- spec/analytical/modules/mixpanel_spec.rb
 - spec/analytical/modules/optimizely_spec.rb
 - spec/analytical/session_command_store_spec.rb
 - spec/analytical_spec.rb
@@ -187,6 +189,7 @@ test_files:
 - spec/analytical/modules/comscore_spec.rb
 - spec/analytical/modules/google_spec.rb
 - spec/analytical/modules/kiss_metrics_spec.rb
+- spec/analytical/modules/mixpanel_spec.rb
 - spec/analytical/modules/optimizely_spec.rb
 - spec/analytical/session_command_store_spec.rb
 - spec/analytical_spec.rb