gabba-gmp 0.0.2

data/.gitattributes

@@ -0,0 +1,22 @@
+# Auto detect text files and perform LF normalization
+* text=auto
+
+# Custom for Visual Studio
+*.cs     diff=csharp
+*.sln    merge=union
+*.csproj merge=union
+*.vbproj merge=union
+*.fsproj merge=union
+*.dbproj merge=union
+
+# Standard to msysgit
+*.doc	 diff=astextplain
+*.DOC	 diff=astextplain
+*.docx diff=astextplain
+*.DOCX diff=astextplain
+*.dot  diff=astextplain
+*.DOT  diff=astextplain
+*.pdf  diff=astextplain
+*.PDF	 diff=astextplain
+*.rtf	 diff=astextplain
+*.RTF	 diff=astextplain

data/.gitignore

@@ -0,0 +1,38 @@
+# Windows image file caches
+Thumbs.db
+ehthumbs.db
+
+# Folder config file
+Desktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msm
+*.msp
+
+# =========================
+# Operating System Files
+# =========================
+
+# OSX
+# =========================
+
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must ends with two \r.
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear on external disk
+.Spotlight-V100
+.Trashes
+
+*.project

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in gabba.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,9 @@
+Copyright (c) 2010-2013 The Hybrid Group
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+http://opensource.org/licenses/MIT

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler"
+require 'rspec/core/rake_task'
+
+task :default => :spec
+
+Bundler::GemHelper.install_tasks
+RSpec::Core::RakeTask.new :spec

data/Readme.md

@@ -0,0 +1,60 @@
+# Gabba-GMP
+
+
+
+Simple class to send custom server-side events to Google Analytics via Google Measurement Protocol
+https://developers.google.com/analytics/devguides/collection/protocol/v1/
+
+Refactored from the [gabba](https://github.com/hybridgroup/gabba) project.
+ - Heavily influenced by the [serversidegoogleanalytics][] project.
+
+## Examples
+
+### Track page views
+
+```ruby
+google_tracker_id = "UT-1234"
+host = "#{request.host}"
+cookies[:utm_visitor_uuid] = { value: "#{SecureRandom.uuid}", expires: 1.year.from_now} if !cookies[:utm_visitor_uuid].present?
+visitor_id = "#{cookies[:utm_visitor_uuid]}"
+client_ip = "#{request.remote_ip}"
+user_agent = "#{request.env["HTTP_USER_AGENT"]}"
+
+gabba = GabbaGMP::GabbaGMP.new(google_tracker_id, host, visitor_id, client_ip, user_agent)
+
+gabba.page_view("page title", "page/1.html")
+```
+
+### Track custom events
+
+```ruby
+gabba = GabbaGMP::GabbaGMP.new(google_tracker_id, host, visitor_id, client_ip, user_agent)
+
+gabba.event("Videos", "Play", "ID", "123")
+```
+
+### Setting custom vars
+
+```ruby
+# Index: 1 through 50
+index = 1
+
+# Scope: VISITOR, SESSION or PAGE
+scope = GabbaGMP::GabbaGMP::VISITOR
+
+# Set var
+gabba.set_custom_var(index, 'Name', 'Value', scope)
+
+# Track the event (all vars will be included)
+gabba.event(...)
+
+# Track the page view (all vars will be included)
+gabba.page_view(...)
+```
+
+### License
+
+Gabba is released under the [MIT License](http://opensource.org/licenses/MIT).
+
+
+[serversidegoogleanalytics]: http://code.google.com/p/serversidegoogleanalytics

data/gabba-gmp.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path '../lib/gabba-gmp/version', __FILE__
+
+Gem::Specification.new do |s|
+  s.name        = "gabba-gmp"
+  s.version     = GabbaGMP::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Julian West"]
+  s.email       = ["julz dot west at gmail dot com"]
+  s.homepage    = "https://github.com/fuzzyjulz/gabba-gmp"
+  s.summary     = %q{Google Measurement Protocol rewite of the Gabba library}
+  s.description = %q{Google Measurement Protocol rewite of the Gabba library}
+  s.license = "MIT"
+
+  s.rubyforge_project = "gabba-gmp"
+
+  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"]
+
+  s.add_dependency 'net-http-persistent', '~> 2.9'
+  s.add_development_dependency 'rake', '~> 10.1.0'
+  s.add_development_dependency 'rspec', '~> 2.14.1'
+  s.add_development_dependency 'webmock', '~> 1.13.0'
+end

data/lib/gabba-gmp/campaign.rb

@@ -0,0 +1,8 @@
+module GabbaGMP
+  class GabbaGMP
+    class Campaign
+      attr_accessor :name, :source, :medium, :keyword, :content
+    end
+  end
+end
+

data/lib/gabba-gmp/custom_vars.rb

@@ -0,0 +1,23 @@
+module GabbaGMP
+  class GabbaGMP
+    module CustomVars
+      # Public: Set a custom variable to be passed along and logged by Google Analytics
+      # (http://code.google.com/apis/analytics/docs/tracking/gaTrackingCustomVariables.html)
+      #
+      # index  - Integer between 1 and 200 for this custom dimension (limit is 20 normally, but is 200 for GA Premium)
+      # name   - String with the name of the custom dimension
+      # value  - String with the value for the custom dimension
+      #
+      # Example:
+      #
+      #   g.set_custom_var(1, 'awesomeness', 'supreme')
+      #
+      # Returns array with the custom variable data
+      def set_custom_var(index, name, value)
+        raise "Index must be between 1 and #{GabbaGMP::DIMENSION_MAX}" unless (1..GabbaGMP::DIMENSION_MAX).include?(index)
+        
+        @sessionopts["dimension_#{index}".to_sym] = value
+      end
+    end
+  end
+end

data/lib/gabba-gmp/event.rb

@@ -0,0 +1,35 @@
+module GabbaGMP
+  class GabbaGMP
+    module Event
+      # Public: Record an event in Google Analytics
+      # (https://developers.google.com/analytics/devguides/collection/protocol/v1/devguide)
+      #
+      # category::  
+      # action::    
+      # label::     
+      # value::     
+      # options::   Optional. Any additional parameters to send with the page view
+      #
+      # Example:
+      #
+      #   g.event("Videos", "Play", "ID", "123")
+      #
+      def event(category, action, label = nil, value = nil, options = {})
+        hey(event_params(category, action, label, value, options))
+      end
+
+      # Public: Renders event params data in the format needed for GA
+      # Called before actually sending the data along to GA in GabbaGMP#event
+      def event_params(category, action, label, value, event_options)
+        options = {
+          hit_type: "event",
+          event_category: category,
+          event_action: action
+        }
+        options[:event_label] = label if label.present?
+        options[:event_value] = value if value.present?
+        @sessionopts.merge(options).merge!(event_options)
+      end
+    end
+  end
+end

data/lib/gabba-gmp/gabba_gmp.rb

@@ -0,0 +1,142 @@
+# yo, easy server-side tracking for Google Analytics... hey!
+require 'uri'
+require 'net/http'
+require 'ipaddr'
+require 'cgi'
+require 'net/http/persistent'
+
+require "#{File.dirname(__FILE__)}/parameter_map"
+require "#{File.dirname(__FILE__)}/campaign"
+require "#{File.dirname(__FILE__)}/custom_vars"
+require "#{File.dirname(__FILE__)}/event"
+require "#{File.dirname(__FILE__)}/page_view"
+require "#{File.dirname(__FILE__)}/version"
+
+module GabbaGMP
+
+  class GoogleAnalyticsInvalidParameterError < RuntimeError; end
+  class GoogleAnalyticsRequiredParameterMissingError < RuntimeError; end
+  class GoogleAnalyticsParameterNotFoundError < RuntimeError; end
+  class NoGoogleAnalyticsAccountError < RuntimeError; end
+  class NoGoogleAnalyticsDomainError < RuntimeError; end
+  class GoogleAnalyticsNetworkError < RuntimeError; end
+
+  class GabbaGMP
+    GOOGLE_HOST = "www.google-analytics.com"
+    BEACON_PATH = "/collect"
+    USER_AGENT = "Gabba GMP #{VERSION} Agent"
+
+    include ParameterMap
+    include CustomVars
+    include Event
+    include PageView
+
+    ESCAPES = %w{ ' ! * ) }
+
+    attr_accessor :debug
+
+    # Public: Initialize Gabba Google Analytics Tracking Object.
+    #
+    # ga_acct - A String containing your Google Analytics account id.
+    # domain  - A String containing which domain you want the tracking data to be logged from.
+    # visitor_uuid - a uuid to uniquely identify the user - use SecureRandom.uuid to generate
+    # client_ip - The IP address of the connected client
+    # agent   - A String containing the user agent you want the tracking to appear to be coming from.
+    #           Defaults to "Gabba 0.2 Agent" or whatever the correct version is.
+    # Example:
+    #
+    #   g = GabbaGMP::GabbaGMP.new("UT-1234", "mydomain.com")
+    #
+    def initialize(ga_tracking_id, request, cookies, options = {})
+      client_id_cookie = options[:client_id_cookie_sym]
+      client_id_cookie = :utm_visitor_uuid if !client_id_cookie.present? or !client_id_cookie.kind_of? Symbol
+      
+      if !cookies[client_id_cookie].present?
+        cookie_expiry = options[:client_id_cookie_expiry] ? options[:client_id_cookie_expiry] : 1.year.from_now
+        cookies[client_id_cookie] = { value: "#{SecureRandom.uuid}", expires: cookie_expiry}
+      end
+      
+      @sessionopts = {protocol_version: 1, 
+                      tracking_id: ga_tracking_id, 
+                      document_host: request.host, 
+                      client_id: cookies[client_id_cookie], 
+                      user_ip_address: request.remote_ip, 
+                      user_agent: request.env["HTTP_USER_AGENT"]}
+        
+      debug = false
+    end
+
+
+    # Public: Set the session's parameters. This will be added to all actions that are sent to analytics.
+    #  
+    #  See::  ParameterMap:GA_PARAMS
+    def add_options(options)
+      options.keys.each do |key| 
+        raise GoogleAnalyticsParameterNotFoundError, "Parameter '#{key}'" unless GA_PARAMS[key].present?
+      end
+      
+      @sessionopts.merge!(options)
+      self
+    end
+
+    # Public: Set the campaign details from a campaign object. You can also use your own Campaign object so long
+    #  as they support the 5 methods (name, source, medium, keyword, content)
+    def campaign=(campaign)
+      campaign ||= Campaign.new
+      {}.tap do |campaign_params|
+        @sessionopts[:campaign_name] = campaign.name
+        @sessionopts[:campaign_name] ||= "(direct)"
+          
+        @sessionopts[:campaign_source] = campaign.source
+        @sessionopts[:campaign_source] ||= "(direct)"
+          
+        @sessionopts[:campaign_medium] = campaign.medium
+        @sessionopts[:campaign_medium] ||= "(none)"
+          
+        @sessionopts[:campaign_keyword] = campaign.keyword if campaign.keyword.present?
+          
+        @sessionopts[:campaign_content] = campaign.content if campaign.content.present?
+      end
+    end
+    
+    # Sanity check that we have needed params to even call GA
+    def validate_session_parameters(params)
+      raise GoogleAnalyticsRequiredParameterMissingError, "Protocol version is required" unless params[:protocol_version].present?
+      raise GoogleAnalyticsRequiredParameterMissingError, "Tracking id is required" unless params[:tracking_id].present?
+      raise GoogleAnalyticsRequiredParameterMissingError, "Client id is required" unless params[:client_id].present?
+      raise GoogleAnalyticsRequiredParameterMissingError, "Hit type is required" unless params[:hit_type].present?
+      
+      params.keys.each do |param|
+        raise GoogleAnalyticsInvalidParameterError, "The parameter '#{param}' is not currently recognised." unless GA_PARAMS[param].present?
+      end
+    end
+
+    # makes the tracking call to Google Analytics
+    def hey(params)
+      validate_session_parameters(params)
+      query = params.map {|k,v| "#{GA_PARAMS[k]}=#{URI.escape("#{v}", Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))}" }.join('&')
+
+      @http ||= Net::HTTP::Persistent.new 'GabbaGMP'
+
+      Rails.logger.info "GABBA_GMP: request params: #{query}" if debug
+      
+      request = Net::HTTP::Get.new("#{BEACON_PATH}?#{query}")
+      request["User-Agent"] = URI.escape(params[:user_agent])
+      request["Accept"] = "*/*"
+      uri = URI "http://#{GOOGLE_HOST}/#{BEACON_PATH}"
+      response = @http.request(uri, request)
+
+      raise GoogleAnalyticsNetworkError unless response.code == "200"
+      response
+    end
+
+    def escape(t)
+      return t if !t || (/\w/ !~ t.to_s)
+
+      t.to_s.gsub(/[\*'!\)]/) do |m|
+        "'#{ESCAPES.index(m)}"
+      end
+    end
+  end
+end
+

data/lib/gabba-gmp/page_view.rb

@@ -0,0 +1,30 @@
+module GabbaGMP
+  class GabbaGMP
+    module PageView
+      # Public: Record a page view in Google Analytics
+      #
+      # request:: String with the path for the page view
+      # title::   Optional. String with the page title for the page view
+      # options:: Optional. Any additional parameters to send with the page view
+      #
+      # Example:
+      #
+      #   g.page_view(request, "page title")
+      #
+      def page_view(request, title = nil, options = {})
+        
+        hey(page_view_params(title, request.fullpath, options))
+      end
+
+      # Public: Renders the page view params data in the format needed for GA
+      # Called before actually sending the data along to GA.
+      def page_view_params(title, doc_path, options)
+        @sessionopts.merge({
+          hit_type: "pageview",
+          document_title: title,
+          document_path: doc_path
+        }).merge!(options)
+      end
+    end
+  end
+end

data/lib/gabba-gmp/parameter_map.rb

@@ -0,0 +1,34 @@
+module GabbaGMP
+  class GabbaGMP
+    DIMENSION_MAX = 200
+    module ParameterMap
+      GA_PARAMS = {
+        protocol_version: :v,
+        tracking_id: :tid,
+
+        user_ip_address: :uip,
+        client_id: :cid,
+        user_agent: :ua,
+
+        hit_type: :t,
+        
+        document_title: :dt,
+        document_path: :dp,
+        document_referrer: :dr,
+        document_host: :dh,
+        
+        event_category: :ec,
+        event_action: :ea,
+        event_label: :el,
+        event_value: :ev,
+        
+        campaign_name: :cn,
+        campaign_source: :cs,
+        campaign_medium: :cm,
+        campaign_keyword: :ck,
+        campaign_content: :cc
+        
+      }.merge(Hash[(1..GabbaGMP::DIMENSION_MAX).map {|index| ["dimension_#{index}".to_sym, "cd#{index}".to_sym]}])
+    end
+  end
+end

data/lib/gabba-gmp/version.rb

@@ -0,0 +1,5 @@
+module GabbaGMP
+  unless const_defined?('VERSION')
+    VERSION = "0.0.2"
+  end
+end

data/lib/gabba-gmp.rb

@@ -0,0 +1 @@
+require 'gabba-gmp/gabba_gmp'

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: gabba-gmp
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Julian West
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-08 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: net-http-persistent
+  requirement: &23922576 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: *23922576
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &23922276 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+  type: :development
+  prerelease: false
+  version_requirements: *23922276
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &23922000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: *23922000
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &23921724 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.13.0
+  type: :development
+  prerelease: false
+  version_requirements: *23921724
+description: Google Measurement Protocol rewite of the Gabba library
+email:
+- julz dot west at gmail dot com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitattributes
+- .gitignore
+- Gemfile
+- LICENSE
+- Rakefile
+- Readme.md
+- gabba-gmp.gemspec
+- lib/gabba-gmp.rb
+- lib/gabba-gmp/campaign.rb
+- lib/gabba-gmp/custom_vars.rb
+- lib/gabba-gmp/event.rb
+- lib/gabba-gmp/gabba_gmp.rb
+- lib/gabba-gmp/page_view.rb
+- lib/gabba-gmp/parameter_map.rb
+- lib/gabba-gmp/version.rb
+homepage: https://github.com/fuzzyjulz/gabba-gmp
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: gabba-gmp
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: Google Measurement Protocol rewite of the Gabba library
+test_files: []