ga_events 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 2127aed8e42aa7cdf0f703a92841a4a6a0392a7d
-  data.tar.gz: 35a89d2b3d7f419c3951b889bbc86ab627aee8ee
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    N2FlNTM2ZmYyMDRlOTQ0MjRjZTZmNTNiZWQwMDBiOTgyNTM1MTNmYQ==
+  data.tar.gz: !binary |-
+    Mzk2ZmY4OGNlYjI0NTUzOWNkZTBjYjQyMDM3MmM4Y2VmNmIyZThmNA==
 SHA512:
-  metadata.gz: 285032374bdfefe0dd823ace6fc89fbf8445eb167b3292f33212479d8a18f5fa2c1f39dfa7ee726bc5587ab668bf69fadc7a2e7e4eedf9fe0d9dc6225a3a9f2b
-  data.tar.gz: 42a0012e1810332cdc2629ea7b50f79b8bae36fb1ac8c754e62eef49a2e55075e8fb70d8a9f78da7ba8d9114f8e6ab87adeb3df5a55a2ee4714866bf5814a9a9
+  metadata.gz: !binary |-
+    N2UxZGZiOTQ0NTI3ZmEyY2Y4ODY1NWY3ZmIzYTA4OWQzNWJjY2E0MWM4ZmYw
+    Njc2NzhjMzFjY2ZhYmZhZDczNjUzZTY2NzAwYTZiNTY5ZmYxNmQ0MzIzYzI5
+    NzY0MjA4NWRlZmMyOTZmMDc2OWNjYjU5MGM4ZTJhZTBkMGE1ZTM=
+  data.tar.gz: !binary |-
+    NDFlZjM5NjI3ODdiNjdmMWI4ZGMwMDE2MGI0MDQ4Y2UzOGE3NDA5NTQ5NTc1
+    MDYxNWJmZDkwMDJiNDY3YjYzZDM3YjkzNTMzZGZkYmNhMDRiYzY1MmE0Y2Zh
+    ZDY1MmYzNWQ4ZjVlOWQwNzJmZmU1ZmExYzg4MmVkNjJiMzM2MDA=

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+The format suggested at http://keepachangelog.com/ is used.
+
+## 1.0.1 - 2014-04-29
+
+### Fixed
+- Universal Analytics Adapter now marks event as non-interaction.
+
+## 1.1.0 - 2014-10-17
+
+### Added
+- Some documentation regarding controller specs (closes #10)
+- More middleware specs
+
+### Fixed
+- Error returns white page

data/Gemfile

@@ -2,3 +2,7 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in ga_events.gemspec
 gemspec
+
+gem 'rake'
+gem 'rspec', '~> 3.1.0'
+gem 'pry'

data/README.md

@@ -13,6 +13,7 @@ pushes it to Google Analytics via ga.js or Google Tag Manager.
 
 ## Dependencies
 
+* Ruby >= 1.9
 * Rails 3.1 onwards
 * jQuery
 
@@ -32,9 +33,9 @@ Add to the top of your `application.js` (but after requiring jQuery):
 //= require ga_events.js
 ```
 
-After requiring `ga_events.js`, choose an adapter.
+After requiring `ga_events.js`, you have to choose an adapter.
 
-For stock Google Analytics (ga.js) use:
+### Google Analytics (ga.js)
 
 ```javascript
 GaEvents.Event.adapter = function() {
@@ -42,7 +43,7 @@ GaEvents.Event.adapter = function() {
 }
 ```
 
-For Google Universal Analytics (analytics.js) use:
+### Google Universal Analytics (analytics.js)
 
 ```javascript
 GaEvents.Event.adapter = function() {
@@ -50,6 +51,16 @@ GaEvents.Event.adapter = function() {
 }
 ```
 
+Optionally you can specify a custom method to call and a custom tracker name:
+
+```javascript
+GaEvents.Event.adapter = function() {
+  return new GaEvents.GoogleUniversalAnalyticsAdapter("sendNow", "customTracker");
+}
+```
+
+### Google TagManager
+
 If you are using Google Tag Manager you can add custom events which are then
 passed through to Google Analytics.
 
@@ -59,7 +70,9 @@ GaEvents.Event.adapter = function() {
 }
 ```
 
-If you are using a staging system you can use the `NullAdapter`.
+### Testing
+
+For your testing pleasure we included `NullAdapter`.
 
 ```javascript
 GaEvents.Event.adapter = function() {
@@ -112,13 +125,29 @@ class ApplicationController < ActionController::Base
 end
 ```
 
+### Testing
+
+Middlewares aren't loaded in controller specs, so you have to initialize
+GaEvents by hand. You can do this eg. in your `spec_helper.rb`:
+
+```ruby
+RSpec.configure do |config|
+  [...]
+  config.before(:each, type: :controller) do
+    GaEvents::List.init
+  end
+end
+```
+
 ## Contributing
 
 Yes please! Use pull requests.
 
 ### Credits
 
-* [jhilden](https://github.com/jhilden) for ideas and Rails 4 support
+* [danielbayerlein](https://github.com/danielbayerlein) former core committer
+* [jhilden](https://github.com/jhilden) for ideas and bug reports
+* [brain-geek](https://github.com/brain-geek) for bug fixes, specs, features
 
 ## More docs and tools
 

data/Rakefile

@@ -1,2 +1,7 @@
 #!/usr/bin/env rake
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+task default: :spec

data/app/assets/javascripts/ga_events.js.coffee

@@ -61,9 +61,12 @@ class GaEvents.GoogleTagManagerAdapter
     window.dataLayer.push data
 
 class GaEvents.GoogleUniversalAnalyticsAdapter
+  constructor: (@method_call_name = "send", tracker_name) ->
+    @method_call_name = "#{tracker_name}.#{@method_call_name}" if tracker_name
+
   push: (h) ->
-    window.ga "send", "event", h.category, h.action, h.label, h.value,
-              {"nonInteraction": true}
+    window.ga @method_call_name, "event", h.category, h.action, h.label,
+              h.value, {"nonInteraction": true}
 
 class GaEvents.GoogleAnalyticsAdapter
   # Send events non_interactive => no influence on bounce rates

data/ga_events.gemspec

@@ -2,12 +2,11 @@
 require File.expand_path('../lib/ga_events/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.authors       = ['Florian Dütsch', 'Sven Winkler', 'Daniel Bayerlein']
+  gem.authors       = ['Florian Dütsch', 'Sven Winkler']
   gem.email         = ['florian.duetsch@nix-wie-weg.de',
-                       'sven.winkler@nix-wie-weg.de',
-                       'daniel.bayerlein@nix-wie-weg.de']
+                       'sven.winkler@nix-wie-weg.de']
   gem.description   =
-    %q{Google Analytics' Event Tracking everywhere in your Rails app}
+    "Google Analytics' Event Tracking everywhere in your Rails app)"
   gem.summary       = 'This gem allows you to annotate events everywhere in ' \
                       'the code of your Rails app. A rack middleware is ' \
                       'automatically inserted into the stack. It transports ' \
@@ -19,11 +18,11 @@ Gem::Specification.new do |gem|
                       'Tag Manager.'
   gem.homepage      = 'https://github.com/Nix-wie-weg/ga_events'
 
-  gem.files         = `git ls-files`.split($\)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.name          = "ga_events"
-  gem.require_paths = ["lib"]
+  gem.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
+  gem.executables   = gem.files.grep(/^bin\//).map { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(/^(test|spec|features)\//)
+  gem.name          = 'ga_events'
+  gem.require_paths = ['lib']
   gem.version       = GaEvents::VERSION
 
   gem.add_dependency 'rails', '>= 3.1'

data/lib/ga_events/list.rb

@@ -1,28 +1,29 @@
 # NOTE: Collecting the events is thread-safe, but will cause problems in an
 #       asynchronous/evented environment.
 
-module GaEvents::List
-  def self.<<(event)
-    data << event
-  end
+require 'forwardable'
 
-  def self.to_s
-    data.collect(&:to_s).join('$')
-  end
+module GaEvents
+  module List
+    class << self
+      extend Forwardable
+      def_delegators :data, :<<, :present?
 
-  def self.present?
-    data.present?
-  end
+      def to_s
+        data.collect(&:to_s).join('$')
+      end
 
-  # 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
+      # Init list, optionally with a string of serialized events
+      def init(str = nil)
+        Thread.current[:ga_events] = []
+        (str || '').split('$').each { |s| GaEvents::Event.from_string(s) }
+      end
 
-  def self.data
-    Thread.current[:ga_events]
-  end
+      private
 
-  private_class_method :data
+      def data
+        Thread.current[:ga_events]
+      end
+    end
+  end
 end

data/lib/ga_events/middleware.rb

@@ -5,17 +5,9 @@ module GaEvents
     def initialize(app)
       @app = app
     end
-    def call(env)
-      # 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']
-      
-      # Fix for Rails 4
-      flash &&= flash['flashes'] if Rails::VERSION::MAJOR > 3
-
-      GaEvents::List.init(flash && flash['ga_events'])
 
+    def call(env)
+      init_event_list(env)
       status, headers, response = @app.call(env)
 
       headers = Rack::Utils::HeaderHash.new(headers)
@@ -30,17 +22,10 @@ module GaEvents
 
         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.sub('</body>',
-            "<div data-ga-events='#{serialized}'></div>\\0")
-          response = [body]
+          add_events_to_flash(env, serialized)
+
+        elsif html?(status, headers)
+          response = inject_div(response, serialized)
         end
       end
 
@@ -49,9 +34,39 @@ module GaEvents
 
     private
 
+    def init_event_list(env)
+      # 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']
+
+      # Fix for Rails 4
+      flash &&= flash['flashes'] if Rails::VERSION::MAJOR > 3
+
+      GaEvents::List.init(flash && flash['ga_events'])
+    end
+
+    def add_events_to_flash env, serialized_data
+      flash_hash = env[ActionDispatch::Flash::KEY]
+      flash_hash ||= ActionDispatch::Flash::FlashHash.new
+      flash_hash['ga_events'] = serialized_data
+      env[ActionDispatch::Flash::KEY] = flash_hash
+    end
+
+    def normalize_response(r)
+      r = r.body if r.respond_to?(:body)
+      r = r.join if r.respond_to?(:join)
+      r
+    end
+
+    def inject_div(response, serialized_data)
+      r = normalize_response(response)
+      [r.sub('</body>', "<div data-ga-events='#{serialized_data}'></div>\\0")]
+    end
+
     # Taken from:
     # https://github.com/rack/rack-contrib/blob/master/lib/rack/contrib/jsonp.rb
-    def is_html?(status, headers)
+    def html?(status, headers)
       !Rack::Utils::STATUS_WITH_NO_ENTITY_BODY.include?(status.to_i) &&
         headers.key?('Content-Type') &&
         headers['Content-Type'].include?('text/html')

data/lib/ga_events/version.rb

@@ -1,3 +1,3 @@
 module GaEvents
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
 end

data/spec/middleware_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe GaEvents::Middleware do
+  let(:app) do
+    proc { [200, { 'Content-Type' => 'text/html' }, [response_body]] }
+  end
+  let(:response_body) { 'Hello, world.' }
+
+  let(:stack) { described_class.new(app) }
+  let(:request) { Rack::MockRequest.new(stack) }
+
+  describe 'Body code injection' do
+    context 'no events in GaEvents::List' do
+      context 'there is no body closing tag' do
+        let(:response) { request.get('/') }
+        it 'leaves everything as it was' do
+          expect(response.body).to eq response_body
+        end
+      end
+
+      context 'there exists body closing tag' do
+        let(:response) { request.get('/') }
+        let(:response_body) { 'something awesome!</body>' }
+
+        it 'leaves everything as it was' do
+          expect(response.body).to eq response_body
+        end
+      end
+    end
+
+    context 'events present in GaEvents::List' do
+      let(:app) do
+        proc do |_|
+          GaEvents::Event.new('category', 'action', 'label', 'value')
+          [200, { 'Content-Type' => 'text/html' }, response_body]
+        end
+      end
+
+      context 'there is no body closing tag' do
+        let(:response) { request.get('/') }
+        it 'leaves everything as it was' do
+          expect(response.body).to eq response_body
+        end
+      end
+
+      context 'there exists body closing tag' do
+        let(:response) { request.get('/') }
+        let(:response_body) { 'something awesome!</body>' }
+
+        it 'injects data-ga-events' do
+          expect(response.body).to eq(
+            'something awesome!' \
+            "<div data-ga-events='category|action|label|value'></div></body>"
+          )
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'bundler/setup'
+require 'pry'
+require 'rspec'
+require 'rails'
+require 'ga_events'
+
+# Disabling old rspec 'should' syntax
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  config.raise_errors_for_deprecations!
+
+  config.before do
+    GaEvents::List.init
+  end
+end

metadata

@@ -1,41 +1,40 @@
 --- !ruby/object:Gem::Specification
 name: ga_events
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Florian Dütsch
 - Sven Winkler
-- Daniel Bayerlein
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-29 00:00:00.000000000 Z
+date: 2014-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '3.1'
-description: Google Analytics' Event Tracking everywhere in your Rails app
+description: Google Analytics' Event Tracking everywhere in your Rails app)
 email:
 - florian.duetsch@nix-wie-weg.de
 - sven.winkler@nix-wie-weg.de
-- daniel.bayerlein@nix-wie-weg.de
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
+- .gitignore
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -49,6 +48,8 @@ files:
 - lib/ga_events/list.rb
 - lib/ga_events/middleware.rb
 - lib/ga_events/version.rb
+- spec/middleware_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/Nix-wie-weg/ga_events
 licenses: []
 metadata: {}
@@ -58,17 +59,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
 summary: This gem allows you to annotate events everywhere in the code of your Rails
@@ -77,4 +78,6 @@ summary: This gem allows you to annotate events everywhere in the code of your R
   a data-pounded custom HTTP header appended.  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.
-test_files: []
+test_files:
+- spec/middleware_spec.rb
+- spec/spec_helper.rb