trackable-click 0.0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: db63ab65ae91f2e397c995ead12090c8ef22a10a
+  data.tar.gz: 41ea76fb8895490a38eb2416504e12f04015f60f
+SHA512:
+  metadata.gz: d3b7bc8454912ecc04e54963390e32e67c9ce1f98cb4730b87f1b9565922a6067373235e866d380eb0b7d3eb3acadf54cb9fb6c99b2298c464ce79b8e669e374
+  data.tar.gz: 351cd89dfe0ff5a7f1ed444717f621db88a5bcb4e4bb43113d6111635a6dc5df09024adbc08d19fb82e8010b512ce528eea5ae9d925df94fcd983a4304af02c8

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+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,57 @@
+# TrackableClick
+
+TrackableClick provides submit and link view helpers in ROR that can be tracked via Google analytic event, Google analytic e-commerce transaction, and Facebook pixel.
+It is implemented using unobtrusive Javascript and integrates via Railties.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'trackable-click'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install trackable-click
+
+Add trackable click to your javascript manifest:
+
+    #= require trackable-click
+
+Add GA snippit to your layout file (exmaple in HAML):
+
+    - should_perform_tracking do
+      :javascript
+        (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+        (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+        m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+        })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+
+        ga('create', 'UA-4JJHHJL9-1', {'cookieDomain':'none'});
+        ga('send', 'pageview');
+
+Enable trackable click via rails config:
+
+    Application.configure do
+      config.tracking_clicks = true
+    end
+
+## Usage
+
+    1. submit example GA e-commerce
+        = trackable_submit 'Place Order', google_commerce: {id:'1', affiliation: 'test product', revenue: '10.00', shipping:'0.00', tax:'0.00'}
+    2. submit example GA Event
+        = trackable_submit 'Place Order', google_event: {action: 'click', label: 'User Placed Order'}, fp_pixel: {id: '6014085521316', value: '10.00', currency: 'USD'}
+    3. submit example Facebook Pixel
+        = trackable_submit 'Place Order', fp_pixel: {id: '6014085521316', value: '10.00', currency: 'USD'}
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,27 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'TrackableClick'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/app/assets/javascripts/trackable-click.js

@@ -0,0 +1,78 @@
+$(document).ready(function() {
+    function trackableClickOnlyIf(element, prefix) {
+      var trackable = ($(element).data(prefix + '-only-if') &&
+          eval($(element).data(prefix + '-only-if'))) ||
+          !$(element).data(prefix + '-only-if');
+      return trackable;
+    }
+
+    function trackableClickEvalAttr(element, dataAttr) {
+        var attr = '';
+
+        try {
+            attr = eval($(element).data(dataAttr));
+        } catch (e) {
+            attr = $(element).data(dataAttr);
+        }
+
+        return attr;
+    }
+
+    $('body').delegate( ".trackable-click", "click", function() {
+        if($(this).data('tc-fb-pixel-id') &&
+           $(this).data('tc-fb-pixel-value') &&
+           $(this).data('tc-fb-pixel-currency')) {
+
+            if(trackableClickOnlyIf(this, 'tc-fb-pixel')) {
+                window.fb_param = {}; // must be global by adding `window.`
+                fb_param.pixel_id = $(this).data('tc-fb-pixel-id');
+                fb_param.value = trackableClickEvalAttr(this, 'tc-fb-pixel-value');
+                fb_param.currency = trackableClickEvalAttr(this,'tc-fb-pixel-currency');
+
+                (function(){
+                    var fpw = document.createElement('script'); fpw.async = true; fpw.src = '//connect.facebook.net/en_US/fp.js';
+                    var ref = document.getElementsByTagName('script')[0];
+                    ref.parentNode.insertBefore(fpw, ref);
+                })();
+            }
+        }
+
+        if($(this).data('tc-google-event-action') &&
+           $(this).data('tc-google-event-label')){
+            var action = trackableClickEvalAttr(this,'tc-google-event-action');
+            var label = trackableClickEvalAttr(this,'tc-google-event-label');
+
+            if(trackableClickOnlyIf(this, 'tc-google-event')) {
+                if($(this).data('tc-google-button-event-value')) {
+                    ga('send', 'event', 'button', action , label, $(this).data('tc-google-button-event-value'));
+                } else {
+                    ga('send', 'event', 'button', action , label);
+                }
+            }
+        }
+
+        if($(this).data('tc-google-commerce-id') &&
+           $(this).data('tc-google-commerce-affiliation') &&
+           $(this).data('tc-google-commerce-revenue') &&
+           $(this).data('tc-google-commerce-shipping') &&
+           $(this).data('tc-google-commerce-tax')){
+
+            var id = trackableClickEvalAttr(this,'tc-google-commerce-id');
+            var affiliation = trackableClickEvalAttr(this,'tc-google-commerce-affiliation');
+            var revenue = trackableClickEvalAttr(this,'tc-google-commerce-revenue');
+            var shipping = trackableClickEvalAttr(this,'tc-google-commerce-shipping');
+            var tax = trackableClickEvalAttr(this,'tc-google-commerce-tax');
+
+            if(trackableClickOnlyIf(this, 'tc-google-commerce')) {
+                ga('ecommerce:addTransaction', {
+                    'id': id,
+                    'affiliation': affiliation,
+                    'revenue': revenue,
+                    'shipping': shipping,
+                    'tax': tax
+                });
+                ga('ecommerce:send');
+            }
+        }
+    });
+});

data/lib/tasks/trackable-click_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :trackable-click do
+#   # Task goes here
+# end

data/lib/trackable-click.rb

@@ -0,0 +1,5 @@
+require "trackable-click/view_helpers"
+require "trackable-click/engine"
+
+module TrackableClick
+end

data/lib/trackable-click/engine.rb

@@ -0,0 +1,14 @@
+module TrackableClick
+  class Engine < ::Rails::Engine
+    isolate_namespace TrackableClick
+
+    config.generators do |g|
+      g.test_framework :rspec
+      g.integration_tool :rspec
+    end
+
+    initializer "trackable-click.view_helpers" do |app|
+      ::ActionView::Base.send :include, ::TrackableClick::ViewHelpers
+    end
+  end
+end

data/lib/trackable-click/version.rb

@@ -0,0 +1,3 @@
+module TrackableClick
+  VERSION = "0.0.6"
+end

data/lib/trackable-click/view_helpers.rb

@@ -0,0 +1,93 @@
+module TrackableClick
+  module ViewHelpers
+    def tracking_clicks?
+      Rails.configuration.tracking_clicks
+    end
+
+    def should_perform_tracking
+      if block_given? && tracking_clicks?
+        yield
+      end
+    end
+
+    def trackable_submit(value, options = {})
+      expand_options!(options) if tracking_clicks?
+      submit_tag(value, options)
+    end
+
+    def trackable_link_to(name = nil, options = nil, html_options = nil, &block)
+      expand_options!(options) if tracking_clicks?
+      link_to(name, options, html_options, block)
+    end
+
+    private
+
+    def expand_options!(options)
+      options[:class] = make_trackable_class_from_options(options)
+      fp_pixel_data_attrs = make_fp_pixel_data_attrs_from_options!(options)
+      google_event_attrs = make_google_event_data_attrs_from_options!(options)
+      google_commerce_attrs = make_google_commerce_data_attrs_from_options!(options)
+
+      options[:data] ||= {}
+      options[:data].merge!(fp_pixel_data_attrs)
+      options[:data].merge!(google_event_attrs)
+      options[:data].merge!(google_commerce_attrs)
+    end
+
+    def make_trackable_class_from_options(options)
+      css_class = options[:class] || ""
+      css_class << " trackable-click"
+      css_class
+    end
+
+    def make_fp_pixel_data_attrs_from_options!(options)
+      data_attrs = {}
+      fp_pixel_options = options[:fp_pixel]
+
+      unless fp_pixel_options.nil?
+         data_attrs[:tc_fb_pixel_only_if] = fp_pixel_options[:only_if]
+         data_attrs[:tc_fb_pixel_id] = fp_pixel_options[:id]
+         data_attrs[:tc_fb_pixel_value] = fp_pixel_options[:value]
+         data_attrs[:tc_fb_pixel_currency] = fp_pixel_options[:currency]
+      end
+
+      options.delete(:fp_pixel)
+      data_attrs
+    end
+
+    def make_google_event_data_attrs_from_options!(options)
+       data_attrs = {}
+       google_event_options = options[:google_event]
+
+       unless google_event_options.nil?
+         data_attrs[:tc_google_event_only_if] = google_event_options[:only_if]
+         data_attrs[:tc_google_event_action] = google_event_options[:action]
+         data_attrs[:tc_google_event_label] = google_event_options[:label]
+
+         if google_event_options[:value]
+           data_attrs[:google_event_value] = google_event_options[:value]
+         end
+       end
+
+       options.delete(:google_event)
+       data_attrs
+    end
+
+    def make_google_commerce_data_attrs_from_options!(options)
+      data_attrs = {}
+      google_commerce_options = options[:google_commerce]
+
+      unless google_commerce_options.nil?
+        data_attrs[:tc_google_commerce_only_if] = google_commerce_options[:only_if]
+        data_attrs[:tc_google_commerce_id] = google_commerce_options[:id]
+        data_attrs[:tc_google_commerce_affiliation] =google_commerce_options[:affiliation]
+        data_attrs[:tc_google_commerce_revenue] = google_commerce_options[:revenue]
+        data_attrs[:tc_google_commerce_shipping] = google_commerce_options[:shipping]
+        data_attrs[:tc_google_commerce_tax] = google_commerce_options[:tax]
+      end
+
+      options.delete(:google_commerce)
+      data_attrs
+    end
+  end
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: trackable-click
+version: !ruby/object:Gem::Version
+  version: 0.0.6
+platform: ruby
+authors:
+- Christopher Parratto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.16
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.16
+- !ruby/object:Gem::Dependency
+  name: jquery-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Currently only provides a form helper for submit tags.
+email:
+- cparratto@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- app/assets/javascripts/trackable-click.js
+- lib/tasks/trackable-click_tasks.rake
+- lib/trackable-click.rb
+- lib/trackable-click/engine.rb
+- lib/trackable-click/version.rb
+- lib/trackable-click/view_helpers.rb
+homepage: https://www.github.com/cparratto/trackable-click
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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
+signing_key: 
+specification_version: 4
+summary: Trackable click allows you to attach fb pixels and google events as clickable
+  items in rails
+test_files: []