google-analytics-rails 0.0.2 → 0.0.3

data/CHANGELOG.markdown

@@ -0,0 +1,19 @@
+0.0.3
+=====
+
+* Fix #8, the directives were in the wrong order in development mode (thanks to @garnould).
+* Add support for the `_anonymizeIp` event (thanks to @rmoriz).
+* Add support for the `_deleteCustomVar` directive (thanks to @eirc).
+
+0.0.2
+=====
+
+* Documentation updates
+* Custom variable support (thanks to @asm).
+* `_setSiteSpeedSampleRate()` method support (thanks to @nikosd).
+* Event collection `size` method (thanks to @brundage).
+
+0.0.1
+=====
+
+Initial release.

data/google-analytics-rails.gemspec

@@ -14,6 +14,7 @@ Gem::Specification.new do |s|
 
   s.rubyforge_project = "google-analytics-rails"
 
+  s.add_development_dependency "rake"
   s.add_development_dependency "yard"
   s.add_development_dependency "redcarpet"
   s.add_development_dependency "activesupport", "~>3.0"

data/lib/google-analytics/events/events.rb

@@ -47,10 +47,36 @@ module GoogleAnalytics
 
     class SetCustomVar < Event
       def initialize(index, name, value, opt_scope)
+        raise ArgumentError, "The index has to be between 1 and 5" unless (1..5).include?(index.to_i)
         super('_setCustomVar', index.to_i, name.to_s, value.to_s, opt_scope.to_i)
       end
     end
 
+    class DeleteCustomVar < Event
+      def initialize(index)
+        raise ArgumentError, "The index has to be between 1 and 5" unless (1..5).include?(index.to_i)
+        super('_deleteCustomVar', index.to_i)
+      end
+    end
+
+    # @see https://developers.google.com/analytics/devguides/collection/gajs/methods/gaJSApi_gat#_gat._anonymizeIp
+    #
+    # Anonymize the visitor IP address. This seems to be mandatory for European websites and actively enforced
+    # for German ones.
+    #
+    # See the following comment by Roland Moriz for more information:
+    # https://github.com/bgarret/google-analytics-rails/pull/6#issuecomment-5946066
+    #
+    # JavaScript equivalent:
+    #
+    #     _gaq.push(['_gat._anonymizeIp']);
+    #
+    class AnonymizeIp < Event
+      def initialize
+        super('_gat._anonymizeIp')
+      end
+    end
+
     # @see http://code.google.com/apis/analytics/docs/tracking/gaTrackingEcommerce.html
     module Ecommerce
       # JavaScript equivalent:

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

@@ -57,6 +57,10 @@ module GoogleAnalytics::Rails
     #   The optional virtual page view to track through {GoogleAnalytics::Events::TrackPageview}
     # @option options [String] :tracker
     #   The tracker to use instead of the default {GoogleAnalytics.tracker}
+    # @option options [Boolean] :anonymize
+    #   Whether to anonymize the visitor ip or not.
+    #   This is required for european websites and actively enforced for german ones,
+    #   see {GoogleAnalytics::Events::AnonymizeIp}.
     #
     # @example Set the local bit in development mode
     #   analytics_init :local => Rails.env.development?
@@ -73,6 +77,7 @@ module GoogleAnalytics::Rails
       end
 
       local = options.delete(:local) || false
+      anonymize = options.delete(:anonymize) || false
       events = options.delete(:add_events) || []
       events = [events] unless events.is_a?(Array)
 
@@ -80,12 +85,14 @@ module GoogleAnalytics::Rails
 
       # unshift => reverse order
       events.unshift GA::Events::TrackPageview.new(options[:page])
-      events.unshift GA::Events::SetAccount.new(tracker)
-
+      # anonymize if needed before tracking the page view
+      events.unshift GA::Events::AnonymizeIp.new if anonymize
       if local
-        events.push GA::Events::SetDomainName.new('none')
-        events.push GA::Events::SetAllowLinker.new(true)
+        events.unshift GA::Events::SetDomainName.new('none')
+        events.unshift GA::Events::SetAllowLinker.new(true)
       end
+      events.unshift GA::Events::SetAccount.new(tracker)
+
 
       events.each do |event|
         queue << event

data/lib/google-analytics/version.rb

@@ -1,4 +1,4 @@
 module GoogleAnalytics
   # Gem version
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/test/gaq_events_test.rb

@@ -61,6 +61,30 @@ class GAEventsTest < Test::Unit::TestCase
     assert_equal([1, 'VarName1', 'VarVal1', 1], event.params)
   end
 
+  def test_set_custom_var_with_invalid_index
+    assert_raise ArgumentError do
+      GA::Events::SetCustomVar.new(6, 'VarName1', 'VarVal1', 1)
+    end
+  end
+
+  def test_delete_custom_var
+    event = GA::Events::DeleteCustomVar.new(1)
+    assert_equal('_deleteCustomVar', event.name)
+    assert_equal([1], event.params)
+  end
+
+  def test_delete_custom_var_with_invalid_index
+    assert_raise ArgumentError do
+      GA::Events::DeleteCustomVar.new(6)
+    end
+  end
+
+  def test_anonymize_ip_event
+    event = GA::Events::AnonymizeIp.new
+    assert_equal('_gat._anonymizeIp', event.name)
+    assert_equal([], event.params)
+  end
+
   def test_ecommerce_add_transaction_event
     event = GA::Events::Ecommerce::AddTransaction.new(1, 'ACME', 123.45, 13.27, 75.35, 'Dallas', 'TX', 'USA')
     assert_equal('_addTrans', event.name)

data/test/rails/views_helper_test.rb

@@ -59,9 +59,9 @@ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga
 <script type="text/javascript">
 var _gaq = _gaq || [];
 _gaq.push(['_setAccount','TEST']);
-_gaq.push(['_trackPageview']);
-_gaq.push(['_setDomainName','none']);
 _gaq.push(['_setAllowLinker',true]);
+_gaq.push(['_setDomainName','none']);
+_gaq.push(['_trackPageview']);
 (function() {
 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
@@ -74,6 +74,24 @@ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga
     assert_equal(VALID_LOCAL_INIT, analytics_init(:local => true))
   end
 
+  VALID_INIT_WITH_ANONYMIZED_IP = <<-JAVASCRIPT
+<script type="text/javascript">
+var _gaq = _gaq || [];
+_gaq.push(['_setAccount','TEST']);
+_gaq.push(['_gat._anonymizeIp']);
+_gaq.push(['_trackPageview']);
+(function() {
+var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+})();
+</script>
+  JAVASCRIPT
+
+  def test_analytics_init_with_anonymized_ip
+    assert_equal(VALID_INIT_WITH_ANONYMIZED_IP, analytics_init(:anonymize => true))
+  end
+
   VALID_EVENT_INIT = <<-JAVASCRIPT
 <script type="text/javascript">
 var _gaq = _gaq || [];

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-analytics-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,27 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-24 00:00:00.000000000Z
+date: 2012-06-29 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &82570290 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +37,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *82570290
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: redcarpet
-  requirement: &82570070 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +53,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *82570070
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &82569800 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,7 +69,12 @@ dependencies:
         version: '3.0'
   type: :development
   prerelease: false
-  version_requirements: *82569800
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: Rails helpers to manage google analytics tracking
 email:
 - benoit.garret@gadz.org
@@ -53,6 +84,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .yardopts
+- CHANGELOG.markdown
 - Gemfile
 - README.markdown
 - Rakefile
@@ -95,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: google-analytics-rails
-rubygems_version: 1.8.10
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Rails helpers to manage google analytics tracking