caboose-cms 0.5.219 → 0.5.220

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZWVlZjlkNDZjNzY0ZDY1N2IzOTgwOTQzMmFjOWU5Y2NkMmIwYTkwZQ==
+    ZDYxYWNkYjFmNGQ2NTAwZmY1Yjg5ZmQ1M2JiMzlkMTRmMWYwZmUwMQ==
   data.tar.gz: !binary |-
-    ZTBmOGRiYmZiN2M2NTI4NzVkM2NhMjUwOTBiNGMxMTQ1M2IzY2IxMA==
+    ZjgyYWMwMTAxMTJlZGZkNGI5MGU4YzM1ZDgwMGNhY2M1OTE1NzM0Zg==
 SHA512:
   metadata.gz: !binary |-
-    ZmFiZWZhMTY5MzE5ZDUwNDliYTk2NzlmOTJjOGYxNjk5MTc0YzI3YWU2N2Rl
-    YTZlYTA4ODQ2NGMxZDk5NDg5MDBjYTM1NGY2MGRhMWY1M2I4MDBiN2NlODcw
-    MGI0YjEyZDA0OWIwYjI4NjBiYzMyYjdkOGQ0NTAwOGMzNzhiZTc=
+    MTYxMzdhMzUxNTA4ZjhhZjk4Y2I3ZWQ4ZWU2ZTliZDkzYjAzODM0YzU2ZWI5
+    NzJlYjJlOGQwOTdhYmFlNTYzNjEwM2M0ZGI1ZmZkYzJlMjIyODM1MWZkYzIz
+    NGE0MWVhNWRkMjhmY2IzMzM0ODAyZTQ2MDhkOGI4MzdjZTAyN2M=
   data.tar.gz: !binary |-
-    ODJlMGY3MWRiMjE3ODI5OWQxNWM5NjhjYjExOTk4OTA5MjM3ODY4ZjMyZTFl
-    YzE0Y2RmY2FiMDRjN2NiZWMwZDE1MDE3MWQ5MDM5NDZmMTU4YmM4YzRkYjQ2
-    ZjQzMGVlYjY3OGM4ZjlkMmE3MDRhNDljZjhlYTQyM2EwMmU0ZGY=
+    ZGJiMjFiNTc3NGQ3ZmQxMzBjZDhmNDA0OGY1ODBmOTFjYjFlZDNkODhlY2Fm
+    MmNjZmQxMzkxNTNjNzVjOGY0NWZlM2U3YzdlMTkyMmZjYTFhYTkyOWNkYTli
+    OTY5NDVmMTUyZTA5MjgwNjllNWMxNTU5YTZmNGJlM2NlOTFlYzE=

data/app/controllers/caboose/application_controller.rb

@@ -13,7 +13,7 @@ module Caboose
       parse_url_params if Caboose.use_url_params
       
       @use_page_cache = !request.fullpath.starts_with?('/admin')
-      
+            
       # Get the site we're working with      
       domain = Domain.where(:domain => request.host_with_port).first
       @site = domain ? domain.site : nil
@@ -38,6 +38,7 @@ module Caboose
       @tasks        = {}
       @page_tasks   = {}
       @is_real_page = false
+      @ga_events    = []
       
       #if @find_page
         @page = Page.page_with_uri(request.host_with_port, request.fullpath)
@@ -79,6 +80,14 @@ module Caboose
       end                  
     end
     
+    def add_ga_event(cat, action, label = nil, value = nil)
+      # Category String Required  Typically the object that was interacted with (e.g. button)
+      # Action   String Required  The type of interaction (e.g. click)
+      # Label    String Option    Useful for categorizing events (e.g. nav buttons)
+      # Value    Number Option    Values must be non-negative. Useful to pass counts (e.g. 4 times)
+      @ga_events << [cat, action, label, value]
+    end
+
     # Parses any parameters in the URL and adds them to the params
     def parse_url_params      
       return if !Caboose.use_url_params      

data/app/controllers/caboose/cart_controller.rb

@@ -34,7 +34,7 @@ module Caboose
     
     # GET /cart/item-count
     def item_count
-      render :json => { :item_count => @order.item_count }
+      render :json => { :item_count => @order.item_count }            
     end
     
     # POST /cart
@@ -56,12 +56,13 @@ module Caboose
           :subtotal   => unit_price * qty,
           :status     => 'pending'
         )
-      end       
+      end
+      GA.delay.event(@site.id, 'cart', 'add', "Product #{v.product.id}, Variant #{v.id}")
       render :json => { 
         :success => li.save, 
         :errors => li.errors.full_messages,
         :item_count => @order.item_count 
-      }
+      }      
     end
     
     # PUT /cart/:line_item_id
@@ -126,6 +127,7 @@ module Caboose
         @order.calculate
         resp.success = true
         resp.order_total = @order.total
+        GA.delay.event(@site.id, 'giftcard', 'add', "Giftcard #{gc.id}")
       end
       render :json => resp
     end

data/app/controllers/caboose/checkout_controller.rb

@@ -55,7 +55,9 @@ module Caboose
       Caboose.log(@rates)
       
       #Caboose.log(@rates.inspect)
-      @logged_in_user = logged_in_user      
+      @logged_in_user = logged_in_user
+
+      add_ga_event('checkout', 'shipping')      
     end
     
     # Step 4 - Gift cards
@@ -65,6 +67,7 @@ module Caboose
       redirect_to '/checkout/addresses' and return if @order.billing_address.nil? || (@order.has_shippable_items? && @order.shipping_address.nil?)
       redirect_to '/checkout/shipping'  and return if @order.has_shippable_items? && @order.has_empty_shipping_methods?
       @logged_in_user = logged_in_user
+      add_ga_event('checkout', 'gift-cards')
     end
     
     # Step 5 - Payment
@@ -107,6 +110,7 @@ module Caboose
           @form_url = Caboose::PaymentProcessor.form_url(@order)
       end
       @logged_in_user = logged_in_user
+      add_ga_event('checkout', 'payment')
     end
         
     # GET /checkout/confirm
@@ -125,6 +129,7 @@ module Caboose
         end
       end
       @logged_in_user = logged_in_user
+      add_ga_event('checkout', 'confirm_without_payment')
     end
     
     # POST /checkout/confirm
@@ -171,7 +176,7 @@ module Caboose
       
       # Find the last order for the user
       @last_order = Order.where(:customer_id => @logged_in_user.id).order("id desc").limit(1).first
-
+      add_ga_event('checkout', 'thanks')
     end
     
     #===========================================================================

data/app/controllers/caboose/products_controller.rb

@@ -27,6 +27,7 @@ module Caboose
             @sale_categories[cat] = [] if @sale_categories[cat].nil?
             @sale_categories[cat] << p
           end
+          add_ga_event('products', 'view', 'Sales')
           render 'caboose/products/sales' and return
           
         elsif params[:id].to_i > 0 && Product.exists?(params[:id])
@@ -38,6 +39,7 @@ module Caboose
           @reviews        = Review.where(:product_id => @product.id).limit(10).order("id DESC") || nil
           @logged_in_user = logged_in_user
           
+          add_ga_event('products', 'view', "Product #{@product.id}")
           render 'caboose/products/details' and return
         end
       end
@@ -116,10 +118,11 @@ module Caboose
       @products = @pager.items
       @category = if @filter['category_id'] then Category.find(@filter['category_id'].to_i) else nil end
       
-      @pager.set_item_count            
+      @pager.set_item_count
+      add_ga_event('products', 'view', "Category #{cat.id}")      
     end
     
-    def show
+    def show      
     end
     
     # GET /product/info

data/app/controllers/caboose/social_controller.rb

@@ -35,6 +35,7 @@ module Caboose
           when 'google_plus_url'      then sc.google_plus_url      = value
           when 'linkedin_url'         then sc.linkedin_url         = value
           when 'google_analytics_id'  then sc.google_analytics_id  = value
+          when 'auto_ga_js'           then sc.auto_ga_js           = value
     	  end
     	end
     	

data/app/models/caboose/ga.rb

@@ -0,0 +1,29 @@
+require 'httparty'
+
+module Caboose
+  class GA # Google Analytics
+
+    def self.event(site_id, category, action, label = nil, value = nil)
+      
+      site = Site.where(:id => site_id).first
+      return if site.nil?
+      sc = site.social_config
+      ga_id = sc.google_analytics_id
+      return if ga_id.nil? || ga_id.strip.length == 0 
+    
+      params = {
+        'v'   => 1,
+        'tid' => ga_id,
+        'cid' => site.id,
+        't'   => "event",      
+        'ec'  => category,
+        'ea'  => action
+      }
+      params['el'] = label if label
+      params['ev'] = value if value    
+
+      HTTParty.get('https://www.google-analytics.com', { 'query' => params })      
+    end
+    
+  end  
+end

data/app/models/caboose/schema.rb

@@ -652,7 +652,8 @@ class Caboose::Schema < Caboose::Utilities::Schema
         [ :rss_url              , :string ],
         [ :google_plus_url      , :string ],
         [ :linkedin_url         , :string ],
-        [ :google_analytics_id  , :string ]
+        [ :google_analytics_id  , :string ],
+        [ :auto_ga_js           , :boolean , { :default => false }]
       ],
       Caboose::StackableGroup => [       
         [ :name           , :string  ],

data/app/views/caboose/blocks/_ga.html.erb

@@ -0,0 +1,27 @@
+<%
+sc = site.social_config
+if sc.auto_ga_js && sc.google_analytics_id 
+%>
+  <script>
+    (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', '<%= raw sc.google_analytics_id %>', 'auto');
+    ga('send', 'pageview');
+    <% if ga_events && ga_events.count > 0 %>    
+      <% ga_events.each do |arr| %>
+        <%
+        cat    = arr[0] ? arr[0] : nil 
+        action = arr[1] ? arr[1] : nil 
+        label  = arr[2] ? arr[2] : nil 
+        value  = arr[3] ? arr[3] : nil
+        arr2 = [cat, action]
+        arr2 << (label ? label : '') if label || (label.nil? && value)    
+        arr2 << value if value          
+        %>
+    ga('send', 'event'<% arr2.each do |x| %>, <%= raw Caboose.json(x) %><% end %>);
+      <% end %>    
+    <% end %>
+  </script>
+<% end %>

data/app/views/caboose/blocks/_ga_events.html.erb

@@ -0,0 +1,16 @@
+<% if ga_events && ga_events.count > 0 %>
+<script type='text/javascript'>
+<% ga_events.each do |arr| %>
+  <%
+  cat    = arr[0] ? arr[0] : nil 
+  action = arr[1] ? arr[1] : nil 
+  label  = arr[2] ? arr[2] : nil 
+  value  = arr[3] ? arr[3] : nil
+  arr2 = [cat, action]
+  arr2 << (label ? label : '') if label || (label.nil? && value)    
+  arr2 << value if value          
+  %>
+  ga('send', 'event', <% arr2.each do |x| %>, <%= raw Caboose.json(x) %><% end %>);
+<% end %>
+</script>
+<% end %>

data/app/views/caboose/social/admin_edit.html.erb

@@ -14,6 +14,7 @@ sc = @social_config
 <p><div id="socialconfig_<%= sc.id %>_google_plus_url"      ></div></p>
 <p><div id="socialconfig_<%= sc.id %>_linkedin_url"         ></div></p>
 <p><div id="socialconfig_<%= sc.id %>_google_analytics_id"  ></div></p>
+<p><div id="socialconfig_<%= sc.id %>_auto_ga_js"           ></div></p>
       
 <div id='message'></div>
 
@@ -29,16 +30,17 @@ $(document).ready(function() {
     update_url: '/admin/social',
     authenticity_token: '<%= form_authenticity_token %>',
     attributes: [      
-      { name: 'facebook_page_id' , nice_name: 'Facebook Page ID' , type: 'text', value: <%= raw Caboose.json(sc.facebook_page_id) %>, width: 500 },
-      { name: 'twitter_username' , nice_name: 'Twitter Username' , type: 'text', value: <%= raw Caboose.json(sc.twitter_username) %>, width: 500 },
-      { name: 'instagram_username' , nice_name: 'Instagram Username' , type: 'text', value: <%= raw Caboose.json(sc.instagram_username) %>, width: 500 },
-      { name: 'youtube_url' , nice_name: 'YouTube Channel ID' , type: 'text', value: <%= raw Caboose.json(sc.youtube_url) %>, width: 500 },
-      { name: 'pinterest_url' , nice_name: 'Pinterest URL' , type: 'text', value: <%= raw Caboose.json(sc.pinterest_url) %>, width: 500 },
-      { name: 'vimeo_url' , nice_name: 'Vimeo URL' , type: 'text', value: <%= raw Caboose.json(sc.vimeo_url) %>, width: 500 },
-      { name: 'rss_url' , nice_name: 'RSS Feed URL' , type: 'text', value: <%= raw Caboose.json(sc.rss_url) %>, width: 500 },
-      { name: 'google_plus_url' , nice_name: 'Google Plus URL' , type: 'text', value: <%= raw Caboose.json(sc.google_plus_url) %>, width: 500 },
-      { name: 'linkedin_url' , nice_name: 'LinkedIn URL' , type: 'text', value: <%= raw Caboose.json(sc.linkedin_url) %>, width: 500 },
-      { name: 'google_analytics_id' , nice_name: 'Google Analytics Tracking ID' , type: 'text', value: <%= raw Caboose.json(sc.google_analytics_id) %>, width: 500 }
+      { name: 'facebook_page_id'    , nice_name: 'Facebook Page ID'               , type: 'text'     , value: <%= raw Caboose.json(sc.facebook_page_id) %>, width: 500 },
+      { name: 'twitter_username'    , nice_name: 'Twitter Username'               , type: 'text'     , value: <%= raw Caboose.json(sc.twitter_username) %>, width: 500 },
+      { name: 'instagram_username'  , nice_name: 'Instagram Username'             , type: 'text'     , value: <%= raw Caboose.json(sc.instagram_username) %>, width: 500 },
+      { name: 'youtube_url'         , nice_name: 'YouTube Channel ID'             , type: 'text'     , value: <%= raw Caboose.json(sc.youtube_url) %>, width: 500 },
+      { name: 'pinterest_url'       , nice_name: 'Pinterest URL'                  , type: 'text'     , value: <%= raw Caboose.json(sc.pinterest_url) %>, width: 500 },
+      { name: 'vimeo_url'           , nice_name: 'Vimeo URL'                      , type: 'text'     , value: <%= raw Caboose.json(sc.vimeo_url) %>, width: 500 },
+      { name: 'rss_url'             , nice_name: 'RSS Feed URL'                   , type: 'text'     , value: <%= raw Caboose.json(sc.rss_url) %>, width: 500 },
+      { name: 'google_plus_url'     , nice_name: 'Google Plus URL'                , type: 'text'     , value: <%= raw Caboose.json(sc.google_plus_url) %>, width: 500 },
+      { name: 'linkedin_url'        , nice_name: 'LinkedIn URL'                   , type: 'text'     , value: <%= raw Caboose.json(sc.linkedin_url) %>, width: 500 },
+      { name: 'google_analytics_id' , nice_name: 'Google Analytics Tracking ID'   , type: 'text'     , value: <%= raw Caboose.json(sc.google_analytics_id) %>, width: 500 },
+      { name: 'auto_ga_js'          , nice_name: 'Auto Embed Google Analytics JS' , type: 'checkbox' , value: <%= sc.auto_ga_js ? 1 : 0 %>, width: 500 }
     ]    
   });
       

data/app/views/layouts/caboose/application.html.erb

@@ -48,9 +48,10 @@
     :csrf_meta_tags => '|CABOOSE_CSRF|',
     :csrf_meta_tags2 => '|CABOOSE_CSRF|',
     :logged_in_user => @logged_in_user,
-    :site => @site
+    :site => @site,
+    :ga_events => @ga_events
   }
-  @block_options.each{ |k,v| options[k] = v } if @block_options      
+  @block_options.each{ |k,v| options[k] = v } if @block_options  
     
   str = nil    
   #if @use_page_cache
@@ -88,6 +89,8 @@
   if @site.use_retargeting
     js << b.partial('retargeting', options)
   end
+      
+  js << b.partial('ga', options)  
   
   str.gsub!('|CABOOSE_CSS|'        , css)
   str.gsub!('|CABOOSE_PROTOCOL|'   , protocol)  

data/lib/caboose/version.rb

@@ -1,3 +1,3 @@
 module Caboose
-  VERSION = '0.5.219'
+  VERSION = '0.5.220'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: caboose-cms
 version: !ruby/object:Gem::Version
-  version: 0.5.219
+  version: 0.5.220
 platform: ruby
 authors:
 - William Barry
@@ -615,6 +615,7 @@ files:
 - app/models/caboose/discount.rb
 - app/models/caboose/domain.rb
 - app/models/caboose/font.rb
+- app/models/caboose/ga.rb
 - app/models/caboose/gift_card.rb
 - app/models/caboose/line_item.rb
 - app/models/caboose/line_item_modification.rb
@@ -700,6 +701,8 @@ files:
 - app/views/caboose/blocks/_checkbox.html.erb
 - app/views/caboose/blocks/_controller_view_content.html.erb
 - app/views/caboose/blocks/_file.html.erb
+- app/views/caboose/blocks/_ga.html.erb
+- app/views/caboose/blocks/_ga_events.html.erb
 - app/views/caboose/blocks/_google_spreadsheet_cell_value.html.erb
 - app/views/caboose/blocks/_heading.html.erb
 - app/views/caboose/blocks/_html.html.erb