gabba-gmp 0.0.2 → 0.0.3

data/.gitignore

@@ -35,4 +35,5 @@ Icon
 .Spotlight-V100
 .Trashes
 
-*.project
+*.project
+*.gem

data/Readme.md

@@ -1,6 +1,6 @@
 # Gabba-GMP
 
-
+[![Gem Version](https://badge.fury.io/rb/gabba-gmp.svg)](http://badge.fury.io/rb/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/
@@ -13,22 +13,28 @@ Refactored from the [gabba](https://github.com/hybridgroup/gabba) project.
 ### 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("UT-1234", request, cookies)
+
+gabba.page_view(request)
+
+```
 
-gabba = GabbaGMP::GabbaGMP.new(google_tracker_id, host, visitor_id, client_ip, user_agent)
+You can also include the page title:
+```ruby
+gabba.page_view(request, "Page Title")
+
+```
+
+Or if you want to get really fancy you can update the parameters for the page view only..
+```ruby
+gabba.page_view(request, "Page Title", document_path: "/manually/fiddled/url")
 
-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 = GabbaGMP::GabbaGMP.new("UT-1234", request, cookies)
 
 gabba.event("Videos", "Play", "ID", "123")
 ```
@@ -36,14 +42,10 @@ gabba.event("Videos", "Play", "ID", "123")
 ### Setting custom vars
 
 ```ruby
-# Index: 1 through 50
+# Index: 1 through 200 (for pro or 20 for free)
 index = 1
 
-# Scope: VISITOR, SESSION or PAGE
-scope = GabbaGMP::GabbaGMP::VISITOR
-
-# Set var
-gabba.set_custom_var(index, 'Name', 'Value', scope)
+gabba.set_custom_var(index, 'Name', 'Value')
 
 # Track the event (all vars will be included)
 gabba.event(...)
@@ -52,6 +54,44 @@ gabba.event(...)
 gabba.page_view(...)
 ```
 
+### Campaigns
+
+It's easy to track campaigns! You can either use the GabbaGMP campaign object or your own(assuming it has the magic fields)!
+
+Note that you can also send in `nil` into campaigns, and it will still work... one less check to do!
+
+```ruby
+
+campaign = GabbaGMP::Campaign()
+
+campaign.name = "GabbaCMP"
+campaign.source = "gemfile"
+campaign.medium = "email"
+campaign.keyword = nil
+campaign.content = "gems"
+
+gabba.campaign = campaign
+
+```
+
+### Manually setting parameters
+
+If you find that you absolutely must override variables that are used internally then you can override the session parameters:
+
+```ruby
+gabba = GabbaGMP::GabbaGMP.new("UT-1234", request, cookies)
+
+#Manually override the user agent so that we can detect local calls in GA! 
+gabba.add_options(user_agent: "LocalUse") if request.remote_ip == "127.0.0.1"
+
+#This pageview has the new user agent! (if you are accessing from localhost)
+gabba.page_view(request)
+
+#This event also has the user agent! Easy as!
+gabba.event("Videos", "Play", "ID", "123")
+
+```
+
 ### License
 
 Gabba is released under the [MIT License](http://opensource.org/licenses/MIT).

data/lib/gabba-gmp/gabba_gmp.rb

@@ -37,12 +37,12 @@ module GabbaGMP
 
     # 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.
+    # ga_tracking_id  - A String containing your Google Analytics account id.
+    # request         - The request this tracker relates to.
+    # cookies         - The cookies object for this request. Will be updated with the client_id cookie
+    # options         - Allows for:
+    #                           -client_id_cookie_expiry = Set the expiry of the visitor cookie manually
+    #                           -client_id_cookie_sym = The symbol to store the visitor id cookie under
     # Example:
     #
     #   g = GabbaGMP::GabbaGMP.new("UT-1234", "mydomain.com")
@@ -61,11 +61,20 @@ module GabbaGMP
                       document_host: request.host, 
                       client_id: cookies[client_id_cookie], 
                       user_ip_address: request.remote_ip, 
-                      user_agent: request.env["HTTP_USER_AGENT"]}
+                      user_agent: request.user_agent,
+                      user_language: preferred_language(request.accept_language)}
+        
+      @sessionopts[:document_referrer] = request.referrer if request.referrer.present?
         
       debug = false
     end
 
+    def preferred_language(language)
+      return "" unless language.present?
+      
+      language_arr = language.split(",").map {|lang_pref| lang_pref.split(";")}
+      language_arr[0][0] #just get the first language. Will probably be correct.
+    end
 
     # Public: Set the session's parameters. This will be added to all actions that are sent to analytics.
     #  

data/lib/gabba-gmp/parameter_map.rb

@@ -6,9 +6,14 @@ module GabbaGMP
         protocol_version: :v,
         tracking_id: :tid,
 
-        user_ip_address: :uip,
         client_id: :cid,
+        user_id: :uid,                #currently untested
+        user_ip_address: :uip,
         user_agent: :ua,
+        user_language: :ul,
+        user_screen_resolution: :sr,  #currently untested
+        user_viewport_size: :vp,      #currently untested
+        user_screen_colors: :sd,      #currently untested
 
         hit_type: :t,
         

data/lib/gabba-gmp/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gabba-gmp
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2014-09-08 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-http-persistent
-  requirement: &23922576 !ruby/object:Gem::Requirement
+  requirement: &26367252 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '2.9'
   type: :runtime
   prerelease: false
-  version_requirements: *23922576
+  version_requirements: *26367252
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &23922276 !ruby/object:Gem::Requirement
+  requirement: &26366952 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 10.1.0
   type: :development
   prerelease: false
-  version_requirements: *23922276
+  version_requirements: *26366952
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &23922000 !ruby/object:Gem::Requirement
+  requirement: &26366676 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 2.14.1
   type: :development
   prerelease: false
-  version_requirements: *23922000
+  version_requirements: *26366676
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &23921724 !ruby/object:Gem::Requirement
+  requirement: &26366400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,7 +54,7 @@ dependencies:
         version: 1.13.0
   type: :development
   prerelease: false
-  version_requirements: *23921724
+  version_requirements: *26366400
 description: Google Measurement Protocol rewite of the Gabba library
 email:
 - julz dot west at gmail dot com