ua-google-analytics-rails 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d0b7457b09b8246e0abe9775ccfba083c88e324c
+  data.tar.gz: a86f20da16f5596a659a6def9368e3390c4ef6e8
+SHA512:
+  metadata.gz: 89c5a81dbfc6e0dfbcadac5106db3872cb8db8c490d914f798d7a2047db7183d7428f68aaa696a10ae4c555bcec988f20cfe28f193d675c52f8f7547cf70cc49
+  data.tar.gz: cf71fbd291e672b44f1203df38b83832acc2af0d2cebcaa43643f4a4fab7e7538d40ed2176eb8af749a2d681b90473dacc48886194ba0ccefa6f856ea227c8d9

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.yardoc
+doc
+.DS_Store

data/.travis.yml

@@ -0,0 +1,23 @@
+language: ruby
+bundler_args: --without development
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+  - 2.2.1
+  - rbx-2
+  - ruby-head
+matrix:
+  include:
+    - rvm: jruby-18mode
+      env: JRUBY_OPTS="$JRUBY_OPTS --debug"
+    - rvm: jruby-19mode
+      env: JRUBY_OPTS="$JRUBY_OPTS --debug"
+    - rvm: jruby-head
+      env: JRUBY_OPTS="$JRUBY_OPTS --debug"
+  allow_failures:
+    - rvm: jruby-head
+    - rvm: rbx-2
+    - rvm: ruby-head
+  fast_finish: true

data/.yardopts

@@ -0,0 +1 @@
+-m markdown --no-private --plugin rails

data/CHANGELOG.markdown

@@ -0,0 +1,42 @@
+1.0.0
+=====
+
+* Converting to Universal Analytics
+
+0.0.6
+=====
+
+* Add support for sending `custom_vars` in proper sequence while doing `analytics_init` [PR#20](https://github.com/bgarret/google-analytics-rails/pull/20) (thanks to @yonda).
+* Make switching between DoubleClick and default `ga.js` simpler. [PR#23](https://github.com/bgarret/google-analytics-rails/pull/23) (thanks to @rafamanzo).
+* Start testing the library regularly against Ruby 1.8.7, 1.9.2, 1.9.3, 2.0.0, 2.1, JRuby-1.8mode and JRuby-1.9mode.
+
+0.0.5
+=====
+
+* Enhanced link attribution.
+
+0.0.4
+=====
+
+* Support for custom analytics script src (DoubleClick is supported).
+* Add a `:domain` option to `analytics_init`.
+
+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/Gemfile

@@ -0,0 +1,24 @@
+source "http://rubygems.org"
+
+gem 'rake'
+gem 'yard'
+gem 'i18n', '< 0.7.0'
+gem 'activesupport', "~> 3.0"
+
+group :development do
+  gem 'pry'
+  platforms :ruby_19, :ruby_20, :ruby_21 do
+    gem 'pry-stack_explorer'
+    gem 'redcarpet'
+  end
+end
+
+group :test do
+  gem 'test-unit'
+  gem 'json'
+  gem "codeclimate-test-reporter", :require => nil
+end
+
+# Specify your gem's dependencies in google-analytics-rails.gemspec
+gemspec
+

data/README.markdown

@@ -0,0 +1,107 @@
+[![Code Climate](https://codeclimate.com/github/spodlecki/ua-google-analytics-rails/badges/gpa.svg)](https://codeclimate.com/github/spodlecki/ua-google-analytics-rails)
+[![Test Coverage](https://codeclimate.com/github/spodlecki/ua-google-analytics-rails/badges/coverage.svg)](https://codeclimate.com/github/spodlecki/ua-google-analytics-rails/coverage)
+[![Build Status](https://travis-ci.org/spodlecki/ua-google-analytics-rails.svg)](https://travis-ci.org/spodlecki/ua-google-analytics-rails)
+
+
+Fast Google Analytics setup for Rails using Universal Analytics code. This gem is mostly intended for small to medium websites with a simple analytics strategy.
+
+**Note:**
+
+Original [Google Analytics Rails Project](https://github.com/bgarret/google-analytics-rails) has been MIA to update to Universal Analytics. The project is essentially a direct port from the old repo.
+
+
+Installation
+============
+
+Add the following to your `Gemfile`:
+
+    gem 'ua-google-analytics-rails'
+
+Then run:
+
+    bundle install
+
+Upgrade Notes
+============
+
+__Upgrading this gem from 0.0.6?__
+
+Use `analytics_init` to send submissions to Analytics if you are using multiple trackers. You can supply a name to tracker by passing `:name` option.
+
+**GoogleAnalytics::Events::SetAllowLinker** is no longer supported as an external variable being set. You can submit as normal in the `:add_events` array, but using the new `:setup` config is preferable so no extra array searching has to happen.
+
+**GoogleAnalytics::Events::SetCustomVar** is no longer supported by Universal Analytics. These have been changed to SetCustomDimension & SetCustomMetric. By default if you use SetCustomVar, it applies as a Dimension
+
+**GoogleAnalytics::Events::DeleteCustomVar** has been removed
+
+**Added Event Helpers**
+
+  - GoogleAnalytics::Events::ExperimentId
+  - GoogleAnalytics::Events::ExperimentVariation
+
+**TODO:** Add Double Click Snippet Support
+While the code is there, and it looks like it is simply changing the end path to the JS, this feature has not been tested.
+
+**Ruby 1.8.7 Support** While it should work on Ruby 1.8.7. No longer running test suite for it for CodeClimate Gem Requirements.
+
+
+Documentation
+=============
+
+Example configurations
+======================
+
+Production only
+---------------
+
+`config/environments/production.rb`:
+
+    # replace this with your tracker code
+    GA.tracker = "UA-xxxxxx-x"
+
+`app/views/layout/application.html.erb`, in the `<head>` tag :
+
+		<%= analytics_init if Rails.env.production? %>
+
+With DoubleClick instead of vanilla Google Analytics script
+-----------------------------------------------------------
+
+`config/environments/production.rb`:
+
+    # replace this with your tracker code
+    GA.tracker = "UA-xxxxxx-x"
+    GA.script_source = :doubleclick
+
+`app/views/layout/application.html.erb`, in the `<head>` tag :
+
+		<%= analytics_init if Rails.env.production? %>
+
+Different accounts for development and production
+-------------------------------------------------
+
+`config/environments/production.rb`:
+
+    # replace this with your production tracker code
+    GA.tracker = "UA-xxxxxx-x"
+
+`config/environments/development.rb`:
+
+    # replace this with your development tracker code
+    GA.tracker = "UA-xxxxxx-x"
+
+`app/views/layout/application.html.erb`, in the `<head>` tag :
+
+		<%= analytics_init :local => Rails.env.development? %>
+
+License
+=======
+
+[ua-google-analytics-rails](https://github.com/spodlecki/ua-google-analytics-rails) is released under the MIT license:
+
+* http://www.opensource.org/licenses/MIT
+
+Original Repo:
+
+[google-analytics-rails](https://github.com/bgarret/google-analytics-rails) is released under the MIT license:
+
+* http://www.opensource.org/licenses/MIT

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+end
+
+task :default => 'test'

data/google-analytics-rails.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "google-analytics/version"
+
+Gem::Specification.new do |s|
+  s.name        = "ua-google-analytics-rails"
+  s.version     = GoogleAnalytics::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Benoit Garret", "Ufuk Kayserilioglu", "Steven Podlecki"]
+  s.email       = ["benoit.garret@gadz.org", "ufuk@paralaus.com", "s.podlecki@gmail.com"]
+  s.homepage    = "https://github.com/spodlecki/ua-google-analytics-rails"
+  s.summary     = %q{Rails helpers to manage google analytics tracking}
+  s.description = %q{Google Analytics setup for Rails using Universal Analytics code}
+
+  s.rubyforge_project = "ua-google-analytics-rails"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/google-analytics-rails.rb

@@ -0,0 +1,60 @@
+# coding: utf-8
+
+require 'google-analytics/async_tracking_queue'
+require 'google-analytics/events'
+
+module GoogleAnalytics
+  # @private
+  PLACEHOLDER_TRACKER = "UA-xxxxxx-x"
+  # GA sources.
+  # Allowing easy switch between DEFAULT and DoubleClick scripts.
+  # @see http://support.google.com/analytics/bin/answer.py?hl=en&answer=2444872 for more info
+  #
+  # @private
+  SCRIPT_SOURCES = {
+    :default     => "'//www.google-analytics.com/analytics.js'",
+    :doubleclick => "'//stats.g.doubleclick.net/dc.js'",
+  }
+
+  # Get the current tracker id (*UA-xxxxxx-x*).
+  # @return [String]
+  def self.tracker
+    @@tracker ||= PLACEHOLDER_TRACKER
+  end
+
+  # Set the current tracker id.
+  # @param [String] tracker The tracker id (ie. "*UA-xxxxxx-x*").
+  def self.tracker=(tracker)
+    @@tracker = tracker
+  end
+
+  # @return [Boolean]
+  def self.valid_tracker?
+    tracker.nil? || tracker == "" || tracker == PLACEHOLDER_TRACKER ? false : true
+  end
+
+  # @return [String]
+  def self.script_source
+    @@src ||= SCRIPT_SOURCES[:default]
+  end
+
+  # Set the current ga src.
+  # @return [String]
+  def self.script_source=(src)
+    if SCRIPT_SOURCES.has_key?(src)
+      @@src = SCRIPT_SOURCES[src]
+    else
+      @@src = src
+    end
+  end
+end
+
+# Alias for {GoogleAnalytics}
+GA = GoogleAnalytics
+
+if defined?(Rails)
+  require 'google-analytics/rails/railtie'
+
+  # Alias for {GoogleAnalytics::Rails}
+  GAR = GoogleAnalytics::Rails
+end

data/lib/google-analytics/async_tracking_queue.rb

@@ -0,0 +1,42 @@
+# coding: utf-8
+
+module GoogleAnalytics
+  class AsyncTrackingQueue
+    def initialize
+      @events = []
+    end
+
+    def <<(event)
+      push(event)
+    end
+
+    def push(event, tracker_id = nil)
+      @events << renderer_for_event(event, tracker_id)
+    end
+
+    def to_s
+<<-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',#{GoogleAnalytics.script_source},'ga');
+#{@events.map { |event| event.to_s }.join("\n")}
+</script>
+JAVASCRIPT
+    end
+
+    private
+
+    def renderer_for_event(event, tracker_id)
+      case event
+      when SingleEvent then EventRenderer.new(event, tracker_id)
+      when Event then EventRenderer.new(event, tracker_id)
+      when EventCollection then EventCollectionRenderer.new(event, tracker_id)
+      end
+    end
+  end
+end
+
+# Alias for {GoogleAnalytics::AsyncTrackingQueue}
+GAQ = GoogleAnalytics::AsyncTrackingQueue

data/lib/google-analytics/events.rb

@@ -0,0 +1,9 @@
+# coding: utf-8
+
+module GoogleAnalytics
+  autoload :Events, 'google-analytics/events/events'
+  autoload :Event, 'google-analytics/events/event'
+  autoload :EventRenderer, 'google-analytics/events/event_renderer'
+  autoload :EventCollection, 'google-analytics/events/event_collection'
+  autoload :EventCollectionRenderer, 'google-analytics/events/event_collection_renderer'
+end

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

@@ -0,0 +1,27 @@
+# coding: utf-8
+
+module GoogleAnalytics
+  class Event
+    attr_reader :action, :name, :params
+
+    def initialize(action, name, *params)
+      @action = action
+      @name = name
+      @params = params
+    end
+
+    def single_event?
+      false
+    end
+  end
+  class SingleEvent
+    attr_reader :action, :name, :params
+    def initialize(action, *params)
+      @action = action
+      @params = params
+    end
+    def single_event?
+      true
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# coding: utf-8
+
+module GoogleAnalytics
+  class EventCollection
+    include Enumerable
+    
+    class InvalidEventError < StandardError
+      def initialize(non_event)
+        super("EventCollection#<< expects instances of Event, you passed #{non_event}")
+      end
+    end
+    
+    def initialize
+      @events = []
+    end
+    
+    def <<(event)
+      raise InvalidEventError.new(event) unless event.is_a?(Event) || event.is_a?(SingleEvent)
+
+      @events << event
+    end
+
+    def each
+      @events.each { |e| yield e }
+    end
+
+    def length
+      @events.length
+    end
+    alias_method :size, :length
+
+  end
+end

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

@@ -0,0 +1,14 @@
+# coding: utf-8
+
+module GoogleAnalytics
+  class EventCollectionRenderer
+    def initialize(event_collection, tracker_id)
+      @event_collection = event_collection
+      @tracker_id = tracker_id
+    end
+
+    def to_s
+      @event_collection.map { |event| EventRenderer.new(event, @tracker_id).to_s }.join("\n")
+    end
+  end
+end