staccato-rails 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 79453c5e3437d648aabe2a13cd116db0ba2073ea
-  data.tar.gz: c163d245693375382faf05e44dee976c1bafc013
+  metadata.gz: c5ffa71cc4564ecb6712bdcc9afb3aef2ea095d4
+  data.tar.gz: 7d60616ef0a17d347d288951f0831cb03ae9948e
 SHA512:
-  metadata.gz: c221d044d4d9656d4be4b0ac6500b691533a2c9c8ee177ef4717737ac4f0358a5a0709c586d51a7eaa9e847ea277ddcfd999005c8b382ea63c57535d57f4ed29
-  data.tar.gz: abb48affccf27c06d39982439de6ad5ef9e42686a6f3cfaeaf1bdb1be78f95512f9c514fb655c721cbdf29c0de6548b982f1fa27c435c836b61c00a30ce5e0a0
+  metadata.gz: ea22eab05dfbc4d2992bd90a90c1115d87d0d4c28d885d883c729d9314f000c43da395bb96ab2befddab82d129d2f5c754444657169730ae31c371ec177955e1
+  data.tar.gz: f91310fce5330337318e41d55e49cd51b83bf03c018b5e5b72a821da0e9c11a021eae761d3c2a2b790ab3ad1227629587510ff944695b9e668d193ad4b0c06c2

data/.ruby-version

@@ -1 +1 @@
-2.3.0
+2.4

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## Staccato-Rails 0.1.0 ##
+
+*   Support the addition of details into the hit via `global_context` and `hit_context`
+
+    *Tony Pitale <@tpitale>*
+
 ## Staccato-Rails 0.0.1 ##
 
 *   Initial implementation

data/README.md

@@ -49,6 +49,8 @@ In controllers, `tracker` is made available to you:
 tracker.event(category: 'video', action: 'play', label: 'cars', value: 1)
 ```
 
+Note: if you have an existing method named `tracker`, this is also available with the more verbose `staccato_tracker`.
+
 ## Overriding the client_id ##
 
 A method is added to your controller called `staccato_client_id`. By default, it's implementation looks like:
@@ -83,6 +85,30 @@ config.staccato.pageviews = false
 config.staccato.exceptions = false # default
 ```
 
+## Adding Global and Hit context ##
+
+To add values like `user_ip` to all hits called by `tracker` (in both your own code, and staccato-rails) create a method `global_context` in your controller and return a hash:
+
+```ruby
+def global_context
+  {
+    user_ip: request.remote_ip
+  }
+end
+```
+
+To add values only to the hits sent by staccato-rails (but not your own use of `tracker`) for pageviews and timing create a method `hit_context` in your controller and return a hash:
+
+```ruby
+def hit_context
+  {
+    user_agent: "cURL"
+  }
+end
+```
+
+If per-action control over the hits sent to GA is required you're better off just using `Staccato` directly at this point.
+
 ## Contributing
 
 1. Fork it

data/lib/staccato-rails/version.rb

@@ -1,4 +1,4 @@
 # Do not use this module for anything but version
 module StaccatoRails
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
 end

data/lib/staccato/session_tracking.rb

@@ -1,7 +1,21 @@
 module Staccato
   module SessionTracking
-    def tracker
-      @tracker ||= Staccato.tracker(staccato_tracker_id, staccato_client_id)
+    def self.included(controller)
+      controller.class_eval do
+        alias_method :tracker, :staccato_tracker unless defined?(tracker)
+      end
+    end
+
+    def global_context
+      {}
+    end
+
+    def hit_context
+      {}
+    end
+
+    def staccato_tracker
+      @staccato_tracker ||= Staccato.tracker(staccato_tracker_id, staccato_client_id, global_context)
     end
 
     # pull tracker id from config
@@ -14,10 +28,13 @@ module Staccato
       session['staccato.client_id'] ||= Staccato.build_client_id
     end
 
+    # This is called in an `ensure` block by actionpack
+    #   errors raised here _may_ be particularly dangerous
     def append_info_to_payload(payload)
       super
 
-      payload["staccato.tracker"] = tracker
+      payload["staccato.tracker"] = staccato_tracker
+      payload["staccato.context"] = hit_context
     end
   end
 end

data/lib/staccato/subscribers/page.rb

@@ -23,7 +23,7 @@ module Staccato
 
       def track!
         return unless get?
-        tracker.pageview(path: path, hostname: hostname)
+        tracker.pageview(context.merge(path: path, hostname: hostname))
       end
 
       private
@@ -39,6 +39,10 @@ module Staccato
         @tracker ||= payload['staccato.tracker']
       end
 
+      def context
+        @context ||= payload['staccato.context']
+      end
+
       def path_prefix
         Rails.application.config.staccato.pageview_prefix.to_s
       end

data/lib/staccato/subscribers/timing.rb

@@ -21,10 +21,20 @@ module Staccato
         @view_runtime ||= payload[:view_runtime]
       end
 
+      def times
+        [
+          {label: :total, time: total_runtime},
+          {label: :db, time: db_runtime},
+          {label: :view, time: view_runtime}
+        ]
+      end
+
       def track!
-        tracker.timing(category: :rails, variable: :runtime, label: :total, time: total_runtime)
-        tracker.timing(category: :rails, variable: :runtime, label: :db, time: db_runtime)
-        tracker.timing(category: :rails, variable: :runtime, label: :view, time: view_runtime)
+        params = context.merge(category: :rails, variable: :runtime)
+
+        times.each do |time|
+          tracker.timing(params.merge(time))
+        end
       end
 
       private
@@ -39,6 +49,10 @@ module Staccato
       def tracker
         @tracker ||= payload['staccato.tracker']
       end
+
+      def context
+        @context ||= payload['staccato.context']
+      end
     end
   end
 end

data/spec/lib/staccato/subscribers/page_spec.rb

@@ -3,6 +3,7 @@ require 'spec_helper'
 describe Staccato::Subscribers::Page do
 
   let(:tracker) { Staccato.tracker(nil) }
+  let(:context) { {} }
   let(:now) {Time.now.to_i}
   let(:duration) {49}
 
@@ -18,7 +19,8 @@ describe Staccato::Subscribers::Page do
       status: 200,
       view_runtime: 46.848,
       db_runtime: 0.157,
-      'staccato.tracker' => tracker
+      'staccato.tracker' => tracker,
+      'staccato.context' => context
     }
   }
 

data/spec/lib/staccato/subscribers/timing_spec.rb

@@ -3,6 +3,7 @@ require 'spec_helper'
 describe Staccato::Subscribers::Timing do
 
   let(:tracker) { Staccato.tracker(nil) }
+  let(:context) { {user_ip: "127.0.0.1"} }
   let(:now) {Time.now.to_i}
   let(:duration) {49} # in seconds
 
@@ -19,7 +20,8 @@ describe Staccato::Subscribers::Timing do
       status: 200,
       view_runtime: 46.848, # milliseconds
       db_runtime: 0.157, # milliseconds
-      'staccato.tracker' => tracker
+      'staccato.tracker' => tracker,
+      'staccato.context' => context
     }
   }
 
@@ -43,14 +45,14 @@ describe Staccato::Subscribers::Timing do
   it 'tracks total run time' do
     # convert duration time to milliseconds
     total_runtime = duration.to_f*1000
-    expect(tracker).to have_received(:timing).with(category: :rails, variable: :runtime, label: :total, time: total_runtime)
+    expect(tracker).to have_received(:timing).with(user_ip: "127.0.0.1", category: :rails, variable: :runtime, label: :total, time: total_runtime)
   end
 
   it 'tracks db run time' do
-    expect(tracker).to have_received(:timing).with(category: :rails, variable: :runtime, label: :db, time: 0.157)
+    expect(tracker).to have_received(:timing).with(user_ip: "127.0.0.1", category: :rails, variable: :runtime, label: :db, time: 0.157)
   end
 
   it 'tracks view rendering run time' do
-    expect(tracker).to have_received(:timing).with(category: :rails, variable: :runtime, label: :view, time: 46.848)
+    expect(tracker).to have_received(:timing).with(user_ip: "127.0.0.1", category: :rails, variable: :runtime, label: :view, time: 46.848)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: staccato-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Tony Pitale
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-10 00:00:00.000000000 Z
+date: 2017-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -177,7 +177,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Rails integration with Staccato for Google Analytics measurement.