event-tracker 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bc7102810ab7b2ebbedcdd8d6384f2388ed86e9d
+  data.tar.gz: a9e5c3a2c4a846b7d99e36a83918d10bc8c043b7
+SHA512:
+  metadata.gz: bd06c36ce0da7b40fab4e7f1931e88717be67440eb391cc2104801414f7d92d0bf41c31c70c94fc7316571d024e0a4df398e96de57c5a8c2934ea99afef27748
+  data.tar.gz: 81d71fa242817d86beb2b528dd602110c4a4e6b9d6d61e187b9c82daa90cb89620edc1fb21d0c5ce21dff6a11972a780520ca69b2095293b6e0cb7fd6279c33b

data/MIT-LICENSE

@@ -0,0 +1,19 @@
+# Copyright (c) 2014 Donald Piret.
+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.

data/README.rdoc

@@ -0,0 +1,4 @@
+= Event Tracker
+
+This library allows the easy implementation of server-side and client side tracking of various events.
+It is currently designed to work with Segment.io (http://segment.io), but should be able to support other trackers as well.

data/lib/core_ext/hash.rb

@@ -0,0 +1,9 @@
+class Hash
+  def merge_if(condition, target = nil)
+    condition ? self.merge(target ? target : condition) : self
+  end
+
+  def deep_merge_if(condition, target)
+    condition ? self.deep_merge(target) : self
+  end
+end

data/lib/event_tracker.rb

@@ -0,0 +1,157 @@
+require 'core_ext/hash'
+require 'event_tracker/tracker'
+require 'event_tracker/segment_io'
+
+module EventTracker
+  class Config
+    attr_accessor :segment_io_key
+    attr_accessor :disabled
+  end
+
+  def self.config
+    @config ||= Config.new
+  end
+
+  def self.configure
+    yield self.config
+  end
+
+  def self.disabled?
+    @config.disabled == true
+  end
+
+  # Defines all the helper methods that become available at the controller level
+  module HelperMethods
+    def track_event(event_name, args = {})
+      (session[:tracker_events] ||= []) << [event_name, _sanitize_args(args)]
+    end
+
+    def register_properties(args)
+      (session[:tracker_properties] ||= {}).merge!(_sanitize_args(args))
+    end
+
+    def track_pageview(name, category, args = {})
+      (session[:tracker_pageviews] ||= []) << [name, category, _sanitize_args(args)]
+    end
+
+    def create_alias(identity1, identity2)
+      (session[:tracker_alias] ||= []) << [identity1, identity2]
+    end
+
+    def track_transaction(event_name, args = {})
+      (session[:tracker_transactions] ||= []) << [event_name, _sanitize_args(args)]
+    end
+
+    def identify_for_user(user, with_info = false)
+      _trackers.each do |tracker|
+        tracker.identify_for_identity(_tracker_identity(user), with_info)
+      end
+    end
+
+    def create_alias_for_user(identity1, identity2)
+      _trackers.each do |tracker|
+        tracker.create_alias_for_identity(identity1, identity2)
+      end
+    end
+
+    def track_event_for_user(user, event_name, args = {})
+      _trackers.each do |tracker|
+        tracker.track_event_for_identity(_tracker_identity(user), event_name, _sanitize_args(args))
+      end
+    end
+
+    def track_transaction_for_user(user, event_name, args = {})
+      _trackers.each do |tracker|
+        tracker.track_transaction_for_identity(_tracker_identity(user), event_name, _sanitize_args(args))
+      end
+    end
+  end
+
+  module ActionControllerExtension
+    def append_tracker
+      return if EventTracker.disabled? || _trackers.empty?
+      body = response.body
+      head_insert_at = body.index('</head')
+      return unless head_insert_at
+      body.insert head_insert_at, view_context.javascript_tag(_trackers.map {|t| t.init }.join("\n"))
+      body_insert_at = body.index('</body')
+      return unless body_insert_at
+      a = [] # Array of all javascript strings to insert
+
+      properties = session.delete(:tracker_properties)
+      events = session.delete(:tracker_events)
+      pageviews = session.delete(:tracker_pageviews)
+      alias_list = session.delete(:tracker_alias)
+      transactions = session.delete(:tracker_transactions)
+
+      _trackers.each do |tracker|
+        tracker.set_options(request: request)
+
+        a << tracker.identify(_tracker_identity)
+
+        # a << tracker.track_pageview() # No need for this anymore. Done by default
+        if pageviews.present?
+          pageviews.each do |url, properties|
+            a << tracker.track_pageview(url, properties)
+          end
+        end
+
+        a << tracker.add_properties(properties) if properties.present?
+
+        if events.present?
+          events.each do |event_name, properties|
+            a << tracker.track_event(event_name, properties)
+          end
+        end
+
+        if alias_list.present?
+          alias_list.each do |identity1, identity2|
+            a << tracker.create_alias(identity1, identity2)
+          end
+        end
+
+        if transactions.present?
+          transactions.each do |event_name, properties|
+            a << tracker.track_transaction(event_name, properties)
+          end
+        end
+      end
+
+      body.insert body_insert_at, view_context.javascript_tag(a.compact.join("\n"))
+      response.body = body
+    end
+
+    def _trackers
+      return [] if EventTracker.disabled?
+      @_trackers ||= begin
+        t = []
+        t << _segment_io_tracker if _segment_io_tracker
+        t
+      end
+    end
+
+    def _sanitize_args(args)
+      args.each do |k, v|
+        if v.is_a?(Hash)
+          args[k] = _sanitize_args(v)
+        elsif v.is_a?(String)
+          args[k] = ActionController::Base.helpers.sanitize(v)
+        else
+          args[k] = v
+        end
+      end
+      return args
+    end
+
+    def _tracker_identity(user = nil)
+      respond_to?(:analytics_identity, true) ? send(:analytics_identity, user) : nil
+    end
+
+    def _segment_io_tracker
+      @_segment_io_tracker ||= begin
+        key = EventTracker.config.segment_io_key
+        key ? EventTracker::SegmentIo.new(key: key) : nil
+      end
+    end
+  end
+end

data/lib/event_tracker/railtie.rb

@@ -0,0 +1,10 @@
+module EventTracker
+  require 'rails'
+
+  class Railtie < Rails::Railtie
+
+    initializer 'event_tracker' do |app|
+
+    end
+  end
+end

data/lib/event_tracker/segment_io.rb

@@ -0,0 +1,126 @@
+module EventTracker
+  class SegmentIo < Tracker
+    JS_ESCAPE_MAP = {
+        '\\'    => '\\\\',
+        '</'    => '<\/',
+        "\r\n"  => '\n',
+        "\n"    => '\n',
+        "\r"    => '\n',
+        '"'     => '\\"',
+        "'"     => "\\'"
+    }
+
+
+    def initialize(options = {})
+      @key = options[:key]
+    end
+
+    def init
+      <<-EOD
+      window.analytics=window.analytics||[],window.analytics.methods=["identify","group","track","page","pageview","alias","ready","on","once","off","trackLink","trackForm","trackClick","trackSubmit"],window.analytics.factory=function(t){return function(){var a=Array.prototype.slice.call(arguments);return a.unshift(t),window.analytics.push(a),window.analytics}};for(var i=0;i<window.analytics.methods.length;i++){var key=window.analytics.methods[i];window.analytics[key]=window.analytics.factory(key)}window.analytics.load=function(t){if(!document.getElementById("analytics-js")){var a=document.createElement("script");a.type="text/javascript",a.id="analytics-js",a.async=!0,a.src=("https:"===document.location.protocol?"https://":"http://")+"cdn.segment.io/analytics.js/v1/"+t+"/analytics.min.js";var n=document.getElementsByTagName("script")[0];n.parentNode.insertBefore(a,n)}},window.analytics.SNIPPET_VERSION="2.0.9",
+      window.analytics.load("#{@key}");
+      window.analytics.page();
+      EOD
+    end
+
+    def identify(identity = nil)
+      if identity.present? && identity.has_key?(:id)
+        %Q{analytics.identify('#{identity[:id]}');}
+      elsif identity.present?
+        %Q{analytics.identify(#{ruby_hash_to_js(identity)});}
+      else
+        nil
+      end
+    end
+
+    def create_alias(identity1, identity2)
+      %Q{analytics.alias('#{identity1}', '#{identity2}');}
+    end
+
+    def add_properties(properties = nil)
+      %Q{analytics.track('set', #{ruby_hash_to_js(properties)});}
+    end
+
+    def track_pageview(name = nil, category = nil, properties = {}, options = {})
+      p = properties.empty? ? "" : ", #{ruby_hash_to_js(properties)}"
+      if category.present? && name.present?
+        %Q{analytics.page('#{category}', '#{name}'#{p});}
+      elsif name.present?
+        %Q{analytics.page('#{name}'#{p});}
+      else
+        %Q{analytics.page('');}
+      end
+    end
+
+    def track_event(event_name, properties)
+      p = properties.empty? ? "" : ", #{ruby_hash_to_js(properties.except(:analytics))}"
+      %Q{analytics.track('#{event_name}'#{p});}
+    end
+
+    def track_transaction(event_name, properties = {})
+      track_event(event_name, properties)
+    end
+
+    def identify_for_identity(identity, with_info = false)
+      return if EventTracker.disabled?
+      if identity.present? && identity.has_key?(:id)
+        client.identify({
+            user_id: "#{identity[:id]}",
+        }.merge_if(with_info, { traits: camelize_hash(identity.except(:id)) }))
+      end
+    end
+
+    def create_alias_for_identity(identity1, identity2)
+      return if EventTracker.disabled?
+      if identity1.present? && identity2.present?
+        client.alias(from: identity1, to: identity2)
+      end
+    end
+
+    def track_event_for_identity(identity, event_name, properties = {})
+      return if EventTracker.disabled?
+      if identity.present? && identity.has_key?(:id)
+        client.track(
+            user_id: "#{identity[:id]}",
+            event: "#{event_name}",
+            properties: camelize_hash(properties.except(:analytics))
+        )
+      end
+    end
+
+    def track_transaction_for_identity(identity, event_name, properties = {})
+      track_event_for_identity(identity, event_name, properties)
+    end
+
+    private
+
+    def camelize_hash(hash)
+      Hash[hash.map { |k, v| [k.to_s.camelize(:lower), v] }]
+    end
+
+    def ruby_hash_to_js(hash)
+      "{#{hash.collect{|key, val| "#{key.to_s.camelize(:lower)}: #{value_for_js(val)}" }.join(', ')}}"
+    end
+
+    def value_for_js(value)
+      case value
+        when Numeric, TrueClass, FalseClass
+          value
+        else
+          "'#{escape_javascript(value.try(:to_s))}'"
+      end
+    end
+
+    def escape_javascript(javascript)
+      if javascript
+        javascript.gsub(/(\\|<\/|\r\n|\342\200\250|\342\200\251|[\n\r"'])/u) {|match| JS_ESCAPE_MAP[match] }
+      else
+        ''
+      end
+    end
+
+    def client
+      AnalyticsRuby
+    end
+  end
+end

data/lib/event_tracker/tracker.rb

@@ -0,0 +1,52 @@
+module EventTracker
+  # Abstract class from which every tracker inherits. Shows all supported methods
+  class Tracker
+    def init
+
+    end
+
+    def set_options(options = {})
+
+    end
+
+    def identify(identity = nil)
+
+    end
+
+    def create_alias(identity1, identity2)
+
+    end
+
+    def add_properties(properties = nil)
+
+    end
+
+    def track_pageview(url = nil, properties = {})
+
+    end
+
+    def track_event(event_name = nil, properties = {})
+
+    end
+
+    def track_transaction(event_name, properties = {})
+
+    end
+
+    def identify_for_identity(identity = nil, with_info = false)
+
+    end
+
+    def create_alias_for_identity(identity1, identity2)
+
+    end
+
+    def track_event_for_identity(identity, event_name = nil, properties = {})
+
+    end
+
+    def track_transaction_for_identity(identity, event_name, properties = {})
+
+    end
+  end
+end

data/lib/event_tracker/version.rb

@@ -0,0 +1,3 @@
+module EventTracker
+  VERSION = '0.1'
+end

data/spec/controllers/events_controller_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe EventsController, type: :controller do
+  render_views
+
+  describe '#index' do
+    it 'includes the segment.io javascript in the user browser' do
+      get :index
+      expect(response.body).to include('http://")+"cdn.segment.io/analytics.js/v1/"+t+"/analytics.min.js"') # Invluding the JS
+    end
+
+    it 'identifies the user for segment.io' do
+      get :index
+      expect(response.body).to include('analytics.identify(\'dummyId\');') # Identifying the user
+    end
+
+    it 'tracks the event for segment.io' do
+      get :index
+      expect(response.body).to include('analytics.track(\'List events\');') # Tracking the event
+    end
+  end
+end

data/spec/event_tracker_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe EventTracker do
+
+end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: event-tracker
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Donald Piret
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: analytics-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: This library allows the easy implementation of server-side and client
+  side tracking of various events.
+email: donald@donaldpiret.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.rdoc
+- lib/core_ext/hash.rb
+- lib/event_tracker.rb
+- lib/event_tracker/railtie.rb
+- lib/event_tracker/segment_io.rb
+- lib/event_tracker/tracker.rb
+- lib/event_tracker/version.rb
+- spec/controllers/events_controller_spec.rb
+- spec/event_tracker_spec.rb
+homepage: https://github.com/donaldpiret/event-tracker
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Quick and easy tracking of server-side and client side events for Rails
+test_files:
+- spec/controllers/events_controller_spec.rb
+- spec/event_tracker_spec.rb