ua-google-analytics-rails 1.0.0

data/lib/google-analytics/version.rb

@@ -0,0 +1,6 @@
+# coding: utf-8
+
+module GoogleAnalytics
+  # Gem version
+  VERSION = "1.0.0"
+end

data/lib/ua-google-analytics-rails.rb

@@ -0,0 +1 @@
+require 'google-analytics'

data/test/async_tracking_queue_test.rb

@@ -0,0 +1,94 @@
+require 'test_helper'
+
+class AsyncTrackingQueueTest < Test::Unit::TestCase
+  def teardown
+    GoogleAnalytics.script_source = nil
+  end
+
+  VALID_SNIPPET = <<-JAVASCRIPT
+<script type="text/javascript">
+(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+ga('send','event',1);
+ga('send','event',2);
+ga('t2.send','event',1);
+ga('t2.send','event',2);
+</script>
+  JAVASCRIPT
+
+  def test_queue_renders_valid_javascript_snippit
+    gaq = GAQ.new
+
+    # Add 2 events to the default tracker
+    gaq << GA::Event.new('send', 'event', 1)
+    gaq << GA::Event.new('send', 'event', 2)
+
+    # Add 2 events for an alternate tracker
+    gaq.push(GA::Event.new('send', 'event', 1), 't2')
+    gaq.push(GA::Event.new('send', 'event', 2), 't2')
+
+    assert_equal(VALID_SNIPPET, gaq.to_s)
+  end
+
+# TODO: Add Double Click Snippet Support
+#
+#   VALID_DOUBLECLICK_SNIPPET = <<-JAVASCRIPT
+# <script type="text/javascript">
+# var _gaq = _gaq || [];
+# _gaq.push(['event1',1]);
+# _gaq.push(['event2',2]);
+# _gaq.push(['t2.event1',1]);
+# _gaq.push(['t2.event2',2]);
+# (function() {
+# var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+# ga.src = ('https:' == document.location.protocol ? 'https://' : 'http://') + 'stats.g.doubleclick.net/dc.js';
+# var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+# })();
+# </script>
+#   JAVASCRIPT
+
+#   def test_queue_renders_valid_javascript_snippit_with_doubleclick_src
+#     GoogleAnalytics.script_source = :doubleclick
+#     gaq = GAQ.new
+
+#     # Add 2 events to the default tracker
+#     gaq << GA::Event.new('event1', 1)
+#     gaq << GA::Event.new('event2', 2)
+
+#     # Add 2 events for an alternate tracker
+#     gaq.push(GA::Event.new('event1', 1), 't2')
+#     gaq.push(GA::Event.new('event2', 2), 't2')
+
+#     assert_equal(VALID_DOUBLECLICK_SNIPPET, gaq.to_s)
+#   end
+
+  VALID_CUSTOM_SNIPPET = <<-JAVASCRIPT
+<script type="text/javascript">
+(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+})(window,document,'script','http://127.0.0.1/custom.js','ga');
+ga('send','event',1);
+ga('send','event',2);
+ga('t2.send','event',1);
+ga('t2.send','event',2);
+</script>
+  JAVASCRIPT
+
+  def test_queue_renders_valid_javascript_snippit_with_custom_src
+    GoogleAnalytics.script_source = "'http://127.0.0.1/custom.js'"
+    gaq = GAQ.new
+
+    # Add 2 events to the default tracker
+    gaq << GA::Event.new('send', 'event', 1)
+    gaq << GA::Event.new('send', 'event', 2)
+
+    # Add 2 events for an alternate tracker
+    gaq.push(GA::Event.new('send', 'event', 1), 't2')
+    gaq.push(GA::Event.new('send', 'event', 2), 't2')
+
+    assert_equal(VALID_CUSTOM_SNIPPET, gaq.to_s)
+  end
+end

data/test/event_collection_renderer_test.rb

@@ -0,0 +1,23 @@
+require 'test_helper'
+
+class EventCollectionRendererTest < Test::Unit::TestCase
+  def test_event_collection_renderer_yield_proper_javascript_snippit_for_default_tracker
+    event_collection = GA::EventCollection.new
+    event_collection << GA::Event.new('send', 'evt', '1')
+    event_collection << GA::Event.new('send', 'evt', '2')
+    event_collection << GA::Event.new('send', 'evt', '3')
+
+    ecr = GA::EventCollectionRenderer.new(event_collection, nil)
+    assert_equal("ga('send','evt','1');\nga('send','evt','2');\nga('send','evt','3');", ecr.to_s)
+  end
+
+  def test_event_collection_renderer_yield_proper_javascript_snippit_for_custom_tracker
+    event_collection = GA::EventCollection.new
+    event_collection << GA::Event.new('send', 'evt', 1)
+    event_collection << GA::Event.new('send', 'evt', 2)
+    event_collection << GA::Event.new('send', 'evt', 3)
+
+    ecr = GA::EventCollectionRenderer.new(event_collection, 't2')
+    assert_equal("ga('t2.send','evt',1);\nga('t2.send','evt',2);\nga('t2.send','evt',3);", ecr.to_s)
+  end
+end

data/test/event_collection_test.rb

@@ -0,0 +1,42 @@
+require 'test_helper'
+
+class EventCollectionTest < Test::Unit::TestCase
+  def test_event_collection_raises_on_non_event_insertion
+    ec = GA::EventCollection.new
+    assert_raise(GA::EventCollection::InvalidEventError) { ec << "This is invalid" }
+  end
+
+  def test_event_collection_is_enumerable_and_iterates_in_insertion_order
+    ec = GA::EventCollection.new
+
+    assert(ec.respond_to?(:each))
+
+    ec << (event0 = GA::Event.new('sample', 'test'))
+    ec << (event1 = GA::Event.new('sample2', 'test2'))
+    ec << (event3 = GA::Event.new('sample3', 'test3'))
+
+    items = ec.map { |e| e }
+
+    assert_equal(event0, items[0])
+    assert_equal(event1, items[1])
+    assert_equal(event3, items[2])
+  end
+
+  def test_event_collection_delegates_size_and_length
+    ec = GA::EventCollection.new
+
+    assert(ec.respond_to?(:size))
+    assert(ec.respond_to?(:length))
+
+    assert_equal(0, ec.size)
+    assert_equal(ec.size, ec.length)
+
+    ec << GA::Event.new('sample', 'test')
+    assert_equal(1, ec.size)
+    assert_equal(ec.size, ec.length)
+
+    ec << GA::Event.new('sample2', 'test2')
+    assert_equal(2, ec.size)
+    assert_equal(ec.size, ec.length)
+  end
+end

data/test/event_renderer_test.rb

@@ -0,0 +1,27 @@
+require 'test_helper'
+
+class EventRendererTest < Test::Unit::TestCase
+  def test_event_renderer_yield_proper_javascript_snippit_for_default_tracker
+    er = GA::EventRenderer.new(GA::Event.new('send', 'something', 1, 2, 3), nil)
+    assert_equal("ga('send','something',1,2,3);", er.to_s)
+  end
+
+  def test_event_renderer_yield_proper_javascript_snippit_for_custom_tracker
+    er = GA::EventRenderer.new(GA::Event.new('send', 'something', 1, 2, 3), 't2')
+    assert_equal("ga('t2.send','something',1,2,3);", er.to_s)
+  end
+  def test_event_renderer_yield_proper_javascript_snippit_for_custom_tracker_creation
+    er = GA::EventRenderer.new(GA::Events::SetupAnalytics.new('TEST', {:name => 't2'}), 't2')
+    assert_match(Regexp.new('"cookieDomain":"auto"'), er.to_s)
+    assert_match(Regexp.new('"name":"t2"'), er.to_s)
+  end
+
+  def test_single_event_renderer_yield_proper_javascript_snippit_for_transaction_send
+    er = GA::EventRenderer.new(GA::Events::Ecommerce::TrackTransaction.new, nil)
+    assert_equal("ga('ecommerce:send');", er.to_s)
+  end
+  def test_single_event_renderer_yield_proper_javascript_snippit_for_transaction_send_with_custom_tracker
+    er = GA::EventRenderer.new(GA::Events::Ecommerce::TrackTransaction.new, 't2')
+    assert_equal("ga('t2.ecommerce:send');", er.to_s)
+  end
+end

data/test/gaq_events_test.rb

@@ -0,0 +1,147 @@
+require 'test_helper'
+
+class GAEventsTest < Test::Unit::TestCase
+  def test_default_account_creation
+    event = GA::Events::SetupAnalytics.new('ABC123')
+    assert_equal('create', event.action)
+    assert_equal('ABC123', event.name)
+    assert_equal(['auto'], event.params)
+  end
+  def test_account_creation_with_cookie_domain
+    event = GA::Events::SetupAnalytics.new('ABC123', 'example.com')
+    assert_equal('create', event.action)
+    assert_equal('ABC123', event.name)
+    assert_equal([{:cookieDomain=>"example.com"}], event.params)
+  end
+  def test_account_creation_with_no_cookie_domain
+    event = GA::Events::SetupAnalytics.new('ABC123', 'none')
+    assert_equal('create', event.action)
+    assert_equal('ABC123', event.name)
+    assert_equal(['none'], event.params)
+  end
+
+  def test_require_statement
+    event = GA::Events::Require.new('ecommerce', 'ecommerce.js')
+    assert_equal('require', event.action)
+    assert_equal('ecommerce', event.name)
+    assert_equal(['ecommerce.js'], event.params)
+  end
+
+  def test_track_pageview_event
+    event = GA::Events::TrackPageview.new
+    assert_equal('send', event.action)
+    assert_equal('pageview', event.name)
+    assert_equal([], event.params)
+  end
+
+  def test_track_pageview_event_with_virtual_page
+    event = GA::Events::TrackPageview.new('/foo/bar')
+    assert_equal('send', event.action)
+    assert_equal('pageview', event.name)
+    assert_equal(['/foo/bar'], event.params)
+  end
+
+  def test_track_event_without_category_or_label
+    event = GA::Events::TrackEvent.new('Search', 'Executed')
+    assert_equal('send', event.action)
+    assert_equal('event', event.name)
+    assert_equal(['Search', 'Executed'], event.params)
+  end
+
+  def test_track_event_with_label
+    event = GA::Events::TrackEvent.new('Search', 'Executed', 'Son of Sam')
+    assert_equal('send', event.action)
+    assert_equal('event', event.name)
+    assert_equal(['Search', 'Executed', 'Son of Sam', nil], event.params)
+  end
+
+  def test_track_event_with_value
+    event = GA::Events::TrackEvent.new('Search', 'Executed', nil, 1)
+    assert_equal('send', event.action)
+    assert_equal('event', event.name)
+    assert_equal(['Search', 'Executed', nil, 1], event.params)
+  end
+
+  def test_track_event_with_label_and_value
+    event = GA::Events::TrackEvent.new('Search', 'Executed', 'Son of Sam', 1)
+    assert_equal('send', event.action)
+    assert_equal('event', event.name)
+    assert_equal(['Search', 'Executed', 'Son of Sam', 1], event.params)
+  end
+
+  def test_set_custom_dimension
+    event = GA::Events::SetCustomDimension.new(1, 2)
+    assert_equal('set', event.action)
+    assert_equal("dimension1", event.name)
+    assert_equal(['2'], event.params)
+  end
+
+  def test_set_custom_dimension_with_invalid_index
+    assert_raise ArgumentError do
+      GA::Events::SetCustomDimension.new(6, 1)
+    end
+  end
+
+  def test_set_custom_metric
+    event = GA::Events::SetCustomMetric.new(1, 2)
+    assert_equal('set', event.action)
+    assert_equal("metric1", event.name)
+    assert_equal(['2'], event.params)
+  end
+
+  def test_set_custom_metric_with_invalid_index
+    assert_raise ArgumentError do
+      GA::Events::SetCustomMetric.new(6, 1)
+    end
+  end
+
+  def test_anonymize_ip_event
+    event = GA::Events::AnonymizeIp.new
+    assert_equal('set', event.action)
+    assert_equal('anonymizeIp', event.name)
+    assert_equal([true], event.params)
+  end
+
+  def test_ecommerce_add_transaction_event_old_format
+    event = GA::Events::Ecommerce::AddTransaction.new(1, 'ACME', 123.45, 13.27, 75.35, 'Dallas', 'TX', 'USA')
+    assert_equal('ecommerce:addTransaction', event.action)
+    assert_equal({
+      :id => '1',
+      :affiliation => 'ACME',
+      :revenue => '123.45',
+      :tax => '13.27',
+      :shipping => '75.35'
+    }, event.name)
+  end
+
+  def test_ecommerce_add_transaction_event_new_format
+    event = GA::Events::Ecommerce::AddTransaction.new(1, 'ACME', 123.45, 13.27, 75.35)
+    assert_equal('ecommerce:addTransaction', event.action)
+    assert_equal({
+      :id => '1',
+      :affiliation => 'ACME',
+      :revenue => '123.45',
+      :tax => '13.27',
+      :shipping => '75.35'
+    }, event.name)
+  end
+
+  def test_ecommerce_add_item_event
+    event = GA::Events::Ecommerce::AddItem.new(1, 123, 'Bacon', 'Chunky', 5.00, 42)
+    assert_equal('ecommerce:addItem', event.action)
+    assert_equal({
+      :id => '1',
+      :sku => '123',
+      :name => 'Bacon',
+      :category => 'Chunky',
+      :price => '5.0',
+      :quantity => '42'
+    }, event.name)
+  end
+
+  def test_ecommerce_track_trans_event
+    event = GA::Events::Ecommerce::TrackTransaction.new
+    assert_equal('ecommerce:send', event.action)
+    assert_equal([], event.params)
+  end
+end

data/test/rails/views_helper_test.rb

@@ -0,0 +1,133 @@
+require 'test_helper'
+require 'google-analytics/rails/view_helpers'
+
+class ViewHelpersTest < Test::Unit::TestCase
+  include GoogleAnalytics::Rails::ViewHelpers
+
+  VALID_JS_INCLUDE = <<-JAVASCRIPT
+(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+  JAVASCRIPT
+
+  VALID_INIT = <<-JAVASCRIPT
+<script type="text/javascript">
+(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+ga('create','TEST','auto');
+ga('send','pageview');
+</script>
+  JAVASCRIPT
+
+  def test_analytics_init
+    assert_equal(VALID_INIT, analytics_init)
+  end
+
+  def test_analytics_init_with_special_name
+    str = analytics_init(:name => 't2').to_s
+    assert(str.include?(VALID_JS_INCLUDE))
+    assert_match(/.+ga\('create','TEST',\{.+\}\);.+/m, str)
+    assert_match(/.+"cookieDomain":"auto".+/m, str)
+    assert_match(/.+"name":"t2".+/m, str)
+    assert_match(/.+ga\('t2.send','pageview'\);.+/m, str)
+  end
+
+  def test_analytics_init_with_virtual_pageview
+    str = analytics_init(:page => '/some/virtual/url').to_s
+    assert(str.include?(VALID_JS_INCLUDE))
+    assert_match(/.+ga\('create','TEST','auto'\);.+/m, str)
+    assert_match(/.+ga\('send','pageview','\/some\/virtual\/url'\);.+/m, str)
+  end
+
+  def test_analytics_init_with_virtual_pageview_and_custom_title
+    str = analytics_init(:page => '/some/virtual/url', :title => 'Hello World').to_s
+    assert(str.include?(VALID_JS_INCLUDE))
+    assert_match(/.+ga\('create','TEST','auto'\);.+/m, str)
+    assert_match(/.+ga\('send','pageview'.+/m, str)
+    assert_match(/.+"page":"\/some\/virtual\/url".+/m, str)
+    assert_match(/.+"title":"Hello World".+/m, str)
+  end
+
+  def test_analytics_init_with_custom_tracker
+    str = analytics_init(:tracker => 'UA-CUSTOM-XX').to_s
+    assert(str.include?(VALID_JS_INCLUDE))
+    assert_match(/.+ga\('create','UA-CUSTOM-XX','auto'\);.+/m, str)
+    assert_match(/.+ga\('send','pageview'\);.+/m, str)
+  end
+
+  def test_analytics_init_with_custom_domain
+    str = analytics_init(:domain => 'example.com').to_s
+    assert(str.include?(VALID_JS_INCLUDE))
+    assert_match(/.+ga\('create','TEST',\{"cookieDomain":"example.com"\}\);.+/m, str)
+    assert_match(/.+ga\('send','pageview'\);.+/m, str)
+  end
+
+  def test_local_analytics_init
+    str = analytics_init(:local => true).to_s
+    assert(str.include?(VALID_JS_INCLUDE))
+    assert_match(/.+ga\('create','TEST',\{.+\}\);.+/m, str)
+    assert_match(/.+"cookieDomain":"none".+/m, str)
+    assert_match(/.+"allowLinker":true.+/m, str)
+    assert_match(/.+ga\('send','pageview'\);.+/m, str)
+  end
+
+  def test_analytics_init_with_anonymized_ip
+    str = analytics_init(:anonymize => true).to_s
+    assert(str.include?(VALID_JS_INCLUDE))
+    assert_match(/.+ga\('create','TEST','auto'\);.+/m, str)
+    assert_match(/.+ga\('set','anonymizeIp',true\);.+/m, str)
+    assert_match(/.+ga\('send','pageview'\);.+/m, str)
+  end
+
+  def test_analytics_init_with_link_attribution
+    str = analytics_init(:enhanced_link_attribution => true).to_s
+    assert(str.include?(VALID_JS_INCLUDE))
+    assert_match(/.+ga\('create','TEST','auto'\);.+/m, str)
+    assert_match(/.+ga\('require','linkid'\);.+/m, str)
+    assert_match(/.+ga\('send','pageview'\);.+/m, str)
+  end
+
+  def test_analytics_init_with_events
+    str = analytics_init(:add_events => GA::Events::SetAllowLinker.new(true)).to_s
+    assert(str.include?(VALID_JS_INCLUDE))
+    assert_match(/.+ga\('create','TEST',\{.+\}\);.+/m, str)
+    assert_match(/.+"cookieDomain":"auto".+/m, str)
+    assert_match(/.+"allowLinker":true.+/m, str)
+    assert_match(/.+ga\('send','pageview'\);.+/m, str)
+  end
+
+  def test_analytics_init_with_samplerate_events
+    str = analytics_init(:add_events => GA::Events::SetSiteSpeedSampleRate.new(5)).to_s
+    assert(str.include?(VALID_JS_INCLUDE))
+    assert_match(/.+ga\('create','TEST',\{.+\}\);.+/m, str)
+    assert_match(/.+"cookieDomain":"auto".+/m, str)
+    assert_match(/.+"siteSpeedSampleRate":5.+/m, str)
+    assert_match(/.+ga\('send','pageview'\);.+/m, str)
+  end
+
+  def test_analytics_init_with_custom_vars
+    str = analytics_init(:custom_vars => GA::Events::SetCustomVar.new(1, 'test', 'hoge',1)).to_s
+    assert(str.include?(VALID_JS_INCLUDE))
+    assert_match(/.+ga\('create','TEST','auto'\);.+/m, str)
+    assert_match(/.+ga\('set','dimension1','hoge'\);.+/m, str)
+    assert_match(/.+ga\('send','pageview'\);.+/m, str)
+  end
+
+  def test_analytics_init_with_custom_dimension
+    str = analytics_init(:custom_vars => GA::Events::SetCustomDimension.new(1, 'hoge')).to_s
+    assert(str.include?(VALID_JS_INCLUDE))
+    assert_match(/.+ga\('create','TEST','auto'\);.+/m, str)
+    assert_match(/.+ga\('set','dimension1','hoge'\);.+/m, str)
+    assert_match(/.+ga\('send','pageview'\);.+/m, str)
+  end
+
+  VALID_TRACK_EVENT = "ga('send','event','Videos','Play','Gone With the Wind',null);"
+
+  def test_analytics_track_event
+    event = analytics_track_event("Videos", "Play", "Gone With the Wind")
+    assert_equal(VALID_TRACK_EVENT, event)
+  end
+end