ga_events 0.1.7 → 0.2.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ODBkOTkyODRlNzNiN2Y0YmExMDdkZmVmOGYyZThjZTliMzVjMjIyYw==
+    YTJhMGE3MTIxYTVhNDZlOGI2ZjhmZjgwNDFkZjU4M2ZhYmUxZmQzYg==
   data.tar.gz: !binary |-
-    ZTY5NzA1ODEyZjZiZmJjZjhiZjgxYzM3MzdhMzQ1M2E0NzRmOWE2Mg==
+    N2QzYzE4MWM4NjY0ZjY4MWY4MDk5ZTlmYmU4ZDY1ODZiODNhYTI0Zg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    YjIzMWFjMjU0MjZjYmE0ZDQ2MGZlMWZlZTUyMzI0OTQ4YzA1MzVlNDcwNzNl
-    ZDQyMmQ5ZDIxYjJjOTgyNmJiMjhiZDc1MTkxOWJjOTA4N2RkZWE3ZThiZGI5
-    NmZjY2RhZmQzZjA5Yzc0MjMyYjFiZjE3OGY4OTE1NWI5N2YzY2I=
+    MmJmMjJlY2EwOWE4ZDA4N2QwM2QwZjZlM2M5OGIzMWUwZjEzNWFjZGY5NTc3
+    YTNmMjkwMmI0ODViMGJlOTNhYjMyZWVhNmQ5NGEzOGRhOGEyOWUyOTRjZjEx
+    ZjFhOTZmMzRiMWEwZTZkMjEwZDllNzlmMTA3YzhjOTQ2MzU0YTg=
   data.tar.gz: !binary |-
-    ZmNmNDRlMTI1ZDQ3NTk5YThjZjE4MTY3Zjk2NThlMmQ5ZjhjMjFmYWU2OWVl
-    ZGQ1MjljNmMzZGI5ZWM2ZjZmODM1YTYxZGQ0NTIwNTZlNGQwM2YzYWE0NDc0
-    NzM1ZGI0ZWU1ZTFiODVkYTZiNmQ2MWE1YjRmYjliYThmN2E2YTA=
+    ZDM3NmFiY2Q1OGFjMTM2ZDQ3NDE2Yzg0NDU1ZTI4MGU0NWU0Yjk3MzcwY2E2
+    ZGY3OWVkMzcwMzdlMTM1MzgwMDhmMGE4MTllZjUyM2VjYjFmZTUzYTM4YWFj
+    OTRkMzU1NTFjYTA2ZDA5MzNiNzJlYTliYjAwZjgwZTU4ZGRmNDQ=

data/README.md

@@ -6,13 +6,19 @@ This gem alllows you to annotate events everywhere in the code of your Rails
 app.
 A rack middleware is automatically inserted into the stack. It transports
 the event data to the client. Normal requests get a DIV injected, Ajax requests
-get a data-pounded custom HTTP header appended.
+get a data-pounded custom HTTP header appended. In case of redirects the data
+survives inside Rails' flash.
 The asset pipeline-ready CoffeeScript extracts this data on the client-side and
 pushes it to Google Analytics via ga.js or Google Tag Manager.
 
+## Dependencies
+
+* Rails 3.1 onwards
+* jQuery
+
 ## Installation
 
-GaEvents works with Rails 3.1 onwards. You can add it to your `Gemfile` with:
+Add it to your `Gemfile` with:
 
 ```ruby
 gem 'ga_events'
@@ -20,7 +26,7 @@ gem 'ga_events'
 
 Run the `bundle` command to install it.
 
-Add to the top of your `application.js`:
+Add to the top of your `application.js` (but after requiring jQuery):
 
 ```javascript
 //= require ga_events.js

data/lib/ga_events/event.rb

@@ -8,6 +8,9 @@ module GaEvents
     def to_s
       [category, action, label, value].join('|')
     end
+
+    def self.from_string(str)
+      new(*str.split('|'))
+    end
   end
 end
-

data/lib/ga_events/list.rb

@@ -14,8 +14,10 @@ module GaEvents::List
     data.present?
   end
 
-  def self.init
+  # Init list, optionally with a string of serialized events
+  def self.init(str = nil)
     Thread.current[:ga_events] = []
+    (str || '').split('$').each { |s| GaEvents::Event.from_string(s) }
   end
 
   def self.data

data/lib/ga_events/middleware.rb

@@ -2,15 +2,19 @@ require 'rack/utils'
 
 module GaEvents
   class Middleware
-
     def initialize(app)
       @app = app
     end
     def call(env)
-      GaEvents::List.init
+      # Handle events stored in flash
+      # Parts borrowed from Rails:
+      # https://github.com/rails/rails/blob/v3.2.14/actionpack/lib/action_dispatch/middleware/flash.rb
+      flash = env['rack.session'] && env['rack.session']['flash']
+      GaEvents::List.init(flash && flash['ga_events'])
+
       status, headers, response = @app.call(env)
-      headers = Rack::Utils::HeaderHash.new(headers)
 
+      headers = Rack::Utils::HeaderHash.new(headers)
       if GaEvents::List.present?
         request = Rack::Request.new(env)
 
@@ -18,10 +22,19 @@ module GaEvents
         serialized = GaEvents::List.to_s
 
         if request.xhr?
+          # AJAX request
           headers['X-GA-Events'] = serialized
+
+        elsif (300..399).include?(status)
+          # 30x/redirect? Then add event list to flash to survive the redirect.
+          flash_hash = env[ActionDispatch::Flash::KEY]
+          flash_hash ||= ActionDispatch::Flash::FlashHash.new
+          flash_hash['ga_events'] = serialized
+          env[ActionDispatch::Flash::KEY] = flash_hash
+
         elsif is_html?(status, headers)
           body = response
-          body = body.each.to_a.join('') if body.respond_to?(:each)
+          body = body.each.to_a.join if body.respond_to?(:each)
           body = body.sub('</body>',
             "<div data-ga-events='#{serialized}'></div>\\0")
           response = [body]

data/lib/ga_events/version.rb

@@ -1,3 +1,3 @@
 module GaEvents
-  VERSION = "0.1.7"
+  VERSION = '0.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ga_events
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.2.0
 platform: ruby
 authors:
 - Florian Dütsch
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-02 00:00:00.000000000 Z
+date: 2013-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -68,7 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.7
 signing_key: 
 specification_version: 4
 summary: This gem allows you to annotate events everywhere in the code of your Rails