split-analytics 0.3.0 → 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1c137bdda5d58e5be423f480171b8db9a33ca43b
+  data.tar.gz: c2a14e14b278cccfd05b8173439eb30c1d45be2c
+SHA512:
+  metadata.gz: 75686f802c2e7089d5fa8b0653c7a063c90cf3cfb9058d58fcff56a981a3d0c26eb58bd0a84d7fd15601b7c4711ccc33991b8fbd1a18a63d80f933eaddece03c
+  data.tar.gz: d0a2ed6631741fc21ba09282f92524060e27cf98a0581dbe2b005d61e18a6ee7c82971c8ff7c3e117f09e6c8e53fc096a73acf4a04de6b3fc7e532d222d6ba29

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2011 Andrew Nesbitt
+Copyright (c) 2013 Andrew Nesbitt
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Readme.mdown

@@ -10,29 +10,83 @@ The split gem and its dependencies.
 
 If you are using bundler add split to your Gemfile:
 
-    gem 'split-analytics', :require => 'split/analytics'
+```ruby
+gem 'split-analytics', :require => 'split/analytics'
+```
 
 Then run:
 
-    bundle install
+```bash
+bundle install
+```
 
 Otherwise install the gem:
 
-    gem install split-analytics
+```bash
+gem install split-analytics
+```
 
 and require it in your project:
 
-    require 'split/analytics'
+```ruby
+require 'split/analytics'
+```
 
 ## Usage
 
 Use in your application layout template
 
-    # erb
-    <%= tracking_code(:account => 'UA-12345-6') %>
+erb example:
 
-    # haml
-    = tracking_code(:account => 'UA-12345-6')
+```erb
+<%= tracking_code(:account => 'UA-12345-6') %>
+```
+
+haml example:
+
+```haml
+= tracking_code(:account => 'UA-12345-6')
+```
+
+### With Tracking Methods
+
+See [Google Analytics Tracking Methods](https://developers.google.com/analytics/devguides/collection/gajs/methods/) for available options.
+
+```
+tracker_methods = {
+  :setDomainName => "example.com", # String argument
+  :setAllowLinker => true, # Boolean argument
+  :require => ['inpage_linkid', '//www.google-analytics.com/plugins/ga/inpage_linkid.js'] # Array argument (will be splattered)
+  :clearOrganic => "" # No argument
+}
+```
+
+erb example:
+
+```erb
+<%= tracking_code(:account => 'UA-12345-6', :tracker_methods => tracker_methods) %>
+```
+
+haml example:
+
+```haml
+= tracking_code(:account => 'UA-12345-6', :tracker_methods => tracker_methods)
+```
+### Other Tracking URLs
+
+You can use other Tracking URLs with the option tracker_url and ssl_tracker_url.
+
+erb example:
+
+```erb
+<%= tracking_code(:account => 'UA-12345-6', :tracker_url => 'stats.g.doubleclick.net/dc.js', :ssl_tracker_url => 'stats.g.doubleclick.net/dc.js') %>
+```
+
+haml example:
+
+```haml
+= tracking_code(:account => 'UA-12345-6', :tracker_url => 'stats.g.doubleclick.net/dc.js', :ssl_tracker_url => 'stats.g.doubleclick.net/dc.js')
+```
 
 ## Development
 
@@ -53,4 +107,4 @@ Tests can be ran with `rake spec`
 
 ## Copyright
 
-Copyright (c) 2011 Andrew Nesbitt. See LICENSE for details.
+Copyright (c) 2013 Andrew Nesbitt. See LICENSE for details.

data/lib/split/analytics.rb

@@ -5,18 +5,23 @@ module Split
     def tracking_code(options={})
       # needs more options: http://code.google.com/apis/analytics/docs/gaJS/gaJSApi.html
       account = options.delete(:account)
+      tracker_url = options.delete(:tracker_url)
+      ssl_tracker_url = options.delete(:ssl_tracker_url)
+      tracker_methods = options.delete(:tracker_methods)
+
+      tracker_url = 'http://' + (tracker_url || 'www.google-analytics.com/ga.js')
+      ssl_tracker_url = 'https://' + (ssl_tracker_url || 'ssl.google-analytics.com/ga.js')
 
       code = <<-EOF
         <script type="text/javascript">
           var _gaq = _gaq || [];
           _gaq.push(['_setAccount', '#{account}']);
+          #{insert_tracker_methods(tracker_methods)}
           #{custom_variables}
           _gaq.push(['_trackPageview']);
-          _gaq.push(['_trackPageLoadTime']);
-
           (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';
+            ga.src = ('https:' == document.location.protocol ? '#{ssl_tracker_url}' : '#{tracker_url}');
             var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
           })();
         </script>
@@ -33,6 +38,36 @@ module Split
       end
       arr.reverse[0..4].reverse.join("\n")
     end
+
+    private
+
+      def insert_tracker_methods(tracker_methods)
+        return nil if tracker_methods.nil?
+        arr = []
+        tracker_methods.each do |k,v|
+          if v.class == String && v.empty?
+            # No argument tracker method
+            arr << "_gaq.push(['" + "_" + "#{k}']);"
+          else
+            case v
+            when String
+              # String argument tracker method
+              arr << "_gaq.push(['" + "_" + "#{k}', '#{v}']);"
+            when TrueClass
+              # Boolean argument tracker method
+              arr << "_gaq.push(['" + "_" + "#{k}', #{v}]);"
+            when FalseClass
+              # Boolean argument tracker method
+              arr << "_gaq.push(['" + "_" + "#{k}', #{v}]);"
+            when Array
+              # Array argument tracker method
+              values = v.map { |value| "'#{value}'" }.join(', ')
+              arr << "_gaq.push(['" + "_" + "#{k}', #{values}]);"
+            end
+          end
+        end
+        arr.join("\n")
+      end
   end
 end
 

data/lib/split/analytics/version.rb

@@ -1,5 +1,5 @@
 module Split
   module Analytics
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end
 end

data/spec/analytics_spec.rb

@@ -4,7 +4,17 @@ describe Split::Analytics do
   include Split::Helper
   it "should generate valid analytics javascript" do
     tracking_code = tracking_code(:account => 'UA-12345-6')
-    tracking_code.should eql("        <script type=\"text/javascript\">\n          var _gaq = _gaq || [];\n          _gaq.push(['_setAccount', 'UA-12345-6']);\n          \n          _gaq.push(['_trackPageview']);\n          _gaq.push(['_trackPageLoadTime']);\n\n          (function() {\n            var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\n            ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\n            var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\n          })();\n        </script>\n")
+    tracking_code.should eql("        <script type=\"text/javascript\">\n          var _gaq = _gaq || [];\n          _gaq.push(['_setAccount', 'UA-12345-6']);\n          \n          \n          _gaq.push(['_trackPageview']);\n          (function() {\n            var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\n            ga.src = ('https:' == document.location.protocol ? 'https://ssl.google-analytics.com/ga.js' : 'http://www.google-analytics.com/ga.js');\n            var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\n          })();\n        </script>\n")
+  end
+
+  it "should generate valid analytics javascript with arbitrary tracker object methods" do
+    tracker_methods = {
+      :setDomainName => "example.com", # String argument
+      :setAllowLinker => true, # Boolean argument
+      :clearOrganic => "" # No argument
+    }
+    tracking_code = tracking_code(:account => 'UA-12345-6', :tracker_methods => tracker_methods)
+    tracking_code.should eql("        <script type=\"text/javascript\">\n          var _gaq = _gaq || [];\n          _gaq.push(['_setAccount', 'UA-12345-6']);\n          _gaq.push(['_setDomainName', 'example.com']);\n_gaq.push(['_setAllowLinker', true]);\n_gaq.push(['_clearOrganic']);\n          \n          _gaq.push(['_trackPageview']);\n          (function() {\n            var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\n            ga.src = ('https:' == document.location.protocol ? 'https://ssl.google-analytics.com/ga.js' : 'http://www.google-analytics.com/ga.js');\n            var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\n          })();\n        </script>\n")
   end
 
   it "should add custom variables for every test the user is involved in" do
@@ -14,6 +24,11 @@ describe Split::Analytics do
     session[:split].should eql({'link_colour' => first_alt,'link_text' => second_alt})
 
     tracking_code = tracking_code(:account => 'UA-12345-6')
-    tracking_code.should eql("        <script type=\"text/javascript\">\n          var _gaq = _gaq || [];\n          _gaq.push(['_setAccount', 'UA-12345-6']);\n          _gaq.push(['_setCustomVar', 1, 'link_colour', '#{first_alt}', 1]);\n_gaq.push(['_setCustomVar', 2, 'link_text', '#{second_alt}', 1]);\n          _gaq.push(['_trackPageview']);\n          _gaq.push(['_trackPageLoadTime']);\n\n          (function() {\n            var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\n            ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\n            var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\n          })();\n        </script>\n")
+    tracking_code.should eql("        <script type=\"text/javascript\">\n          var _gaq = _gaq || [];\n          _gaq.push(['_setAccount', 'UA-12345-6']);\n          _gaq.push(['_setCustomVar', 1, 'link_colour', '#{first_alt}', 1]);\n_gaq.push(['_setCustomVar', 2, 'link_text', '#{second_alt}', 1]);\n\n          (function() {\n            var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\n            ga.src = ('https:' == document.location.protocol ? 'https://ssl.google-analytics.com/ga.js' : 'http://www.google-analytics.com/ga.js');\n            var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\n          })();\n        </script>\n")
+  end
+
+  it "uses doubleclick as tracker url" do
+    tracking_code = tracking_code(:account => 'UA-12345-6', :tracker_url => 'stats.g.doubleclick.net/dc.js', :ssl_tracker_url => 'stats.g.doubleclick.net/dc.js')
+    tracking_code.should eql("        <script type=\"text/javascript\">\n          var _gaq = _gaq || [];\n          _gaq.push(['_setAccount', 'UA-12345-6']);\n          \n          \n          _gaq.push(['_trackPageview']);\n          (function() {\n            var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\n            ga.src = ('https:' == document.location.protocol ? 'https://stats.g.doubleclick.net/dc.js' : 'http://stats.g.doubleclick.net/dc.js');\n            var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\n          })();\n        </script>\n")
   end
 end

data/spec/spec_helper.rb

@@ -18,4 +18,4 @@ def request(ua = 'Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_6_6; de-de) Apple
   r.user_agent = ua
   r.ip = '192.168.1.1'
   @request ||= r
-end
+end

data/split-analytics.gemspec

@@ -7,6 +7,7 @@ Gem::Specification.new do |gem|
   gem.email         = ["andrewnez@gmail.com"]
   gem.summary       = %q{Split extension to push test data to google analytics}
   gem.homepage      = "https://github.com/andrew/split-analytics"
+  gem.license       = 'MIT'
 
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   gem.files         = `git ls-files`.split("\n")
@@ -15,8 +16,8 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
   gem.version       = Split::Analytics::VERSION
 
-  gem.add_dependency(%q<split>, ["~>  0.3"])
+  gem.add_dependency(%q<split>, [">=  0.3.0"])
 
   # Development Dependencies
-  gem.add_development_dependency(%q<rspec>, ["~>  2.6"])
+  gem.add_development_dependency(%q<rspec>, ["~>  2.14"])
 end

metadata

@@ -1,63 +1,50 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: split-analytics
-version: !ruby/object:Gem::Version 
-  hash: 19
-  prerelease: false
-  segments: 
-  - 0
-  - 3
-  - 0
-  version: 0.3.0
+version: !ruby/object:Gem::Version
+  version: 0.4.0
 platform: ruby
-authors: 
+authors:
 - Andrew Nesbitt
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-12-13 00:00:00 +00:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2014-03-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: split
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 13
-        segments: 
-        - 0
-        - 3
-        version: "0.3"
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.0
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 2
-        - 6
-        version: "2.6"
+      - !ruby/object:Gem::Version
+        version: '2.14'
   type: :development
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
 description: 
-email: 
+email:
 - andrewnez@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - LICENSE
@@ -68,40 +55,30 @@ files:
 - spec/analytics_spec.rb
 - spec/spec_helper.rb
 - split-analytics.gemspec
-has_rdoc: true
 homepage: https://github.com/andrew/split-analytics
-licenses: []
-
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+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"
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Split extension to push test data to google analytics
-test_files: 
+test_files:
 - spec/analytics_spec.rb
 - spec/spec_helper.rb