spree_analytics_trackers 1.1.0 → 2.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6f1b28e6012acef941df826e5815966db364756eee0ed406993e7ffcfd2f3c8
-  data.tar.gz: a068b460859953446838873b5d89b09099e5567ab06cf65b3a2e7ebfaae4fd6e
+  metadata.gz: 6428462a2ec00ca1334068af805efecf38b751293f86623e818aca577cb7df14
+  data.tar.gz: 1bd89f20f2f4d945ecafa7b843dbcb2a167811858cc7f6e2ab16a3fb59980d27
 SHA512:
-  metadata.gz: 8179531fa524a7e17aed73f743eeafd961be9d583c54a521b7a9bf1b5a344527e1bb2a447d763ef274bea91cedc6219e5305bc4b987c837d50d3b5ca2e9e1594
-  data.tar.gz: fc3849ab2602836c69f914e2a502650ff67ba842a95e2a6e3f9e0c4622b47cb4b77b1e8a70c03958967954a3fa77969f7bdb0bcbf8f83e3ecdc8c723bd9e3545
+  metadata.gz: c42aed4a692ede105d5b39335baa86a02aab94168186a6221dbce0edcb452d15eec696556639834d30c7dfefdca4408c3a9c116f6ea14f171f8520da0953b35e
+  data.tar.gz: d38032fb537f05202f967c7777e30d2ed2f696b2733a39bd20fe560c9ec2e4024f9588dcd9b0a4e1d9ddd30aa2d66712d6aced167e0e7b8948f732529125dc67

data/.rubocop.yml

@@ -0,0 +1,2 @@
+AllCops:
+  TargetRubyVersion: 2.5

data/.travis.yml

@@ -1,50 +1,44 @@
-sudo: required
-dist: trusty
+os: linux
+dist: bionic
+
+addons:
+  apt:
+    sources:
+      - google-chrome
+    packages:
+      - google-chrome-stable
+
+services:
+  - mysql
+  - postgresql
 
 language: ruby
 
+rvm:
+  - 2.5
+  - 2.6
+
 env:
-  - DB=postgres
   - DB=mysql
-
-addons:
-  chrome: stable
-  postgresql: 9.4
+  - DB=postgres
 
 gemfile:
-  - gemfiles/spree_3_5.gemfile
-  - gemfiles/spree_3_7.gemfile
-  - gemfiles/spree_4_0.gemfile
+  - gemfiles/spree_4_1.gemfile
   - gemfiles/spree_master.gemfile
 
-script:
-  - bundle exec rake test_app
-  - bundle exec rake spec
-
-rvm:
-  - 2.5.1
-  - 2.4.4
-  - 2.3.8
-
-matrix:
+jobs:
   allow_failures:
     - gemfile: gemfiles/spree_master.gemfile
-  exclude:
-    - rvm: 2.3.8
-      gemfile: gemfiles/spree_4_0.gemfile
-    - rvm: 2.4.4
-      gemfile: gemfiles/spree_4_0.gemfile
-    - rvm: 2.3.8
-      gemfile: gemfiles/spree_master.gemfile
-    - rvm: 2.4.4
-      gemfile: gemfiles/spree_master.gemfile
-    - rvm: 2.5.1
-      gemfile: gemfiles/spree_3_5.gemfile
 
 before_install:
   - mysql -u root -e "GRANT ALL ON *.* TO 'travis'@'%';"
-  - wget -N https://chromedriver.storage.googleapis.com/2.35/chromedriver_linux64.zip -P ~/
-  - unzip ~/chromedriver_linux64.zip -d ~/
-  - rm ~/chromedriver_linux64.zip
-  - sudo mv -f ~/chromedriver /usr/local/share/
-  - sudo chmod +x /usr/local/share/chromedriver
+
+before_script:
+  - CHROME_MAIN_VERSION=`google-chrome-stable --version | sed -E 's/(^Google Chrome |\.[0-9]+ )//g'`
+  - CHROMEDRIVER_VERSION=`curl -s "https://chromedriver.storage.googleapis.com/LATEST_RELEASE_$CHROME_MAIN_VERSION"`
+  - curl "https://chromedriver.storage.googleapis.com/${CHROMEDRIVER_VERSION}/chromedriver_linux64.zip" -O
+  - unzip chromedriver_linux64.zip -d ~/bin
+
+script:
+  - bundle exec rake test_app
+  - bundle exec rake spec

data/Appraisals

@@ -1,19 +1,6 @@
-appraise 'spree-3-5' do
-  gem 'spree', '~> 3.5.0'
-  gem 'spree_auth_devise', '~> 3.3.0'
-  gem 'rails-controller-testing'
-end
-
-appraise 'spree-3-7' do
-  gem 'spree', '~> 3.7.0'
-  gem 'spree_auth_devise', '~> 3.5.0'
-  gem 'rails-controller-testing'
-  gem 'sass-rails'
-end
-
-appraise 'spree-4-0' do
-  gem 'spree', '~> 4.0.0.beta'
-  gem 'spree_auth_devise', '~> 4.0.0.rc2'
+appraise 'spree-4-1' do
+  gem 'spree', '~> 4.1.0'
+  gem 'spree_auth_devise', '~> 4.1.0'
   gem 'rails-controller-testing'
 end
 

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2017-2018 Spark Solutions Sp. z o.o.
+Copyright (c) 2017-2020 Spark Solutions Sp. z o.o.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification,

data/README.md

@@ -6,6 +6,7 @@ This extensions adds support for [Google Analytics Enhanced Ecommerce](https://d
 and [Segment Ecommerce](https://segment.com/docs/spec/ecommerce/v2/) tracking to [Spree Commerce](https://spreecommerce.org) stores.
 
 Via Segment.com you can plug-in also a lot of additional vendors and services like:
+
 * Mixpanel
 * Kissmetrics
 * Google Tag Manager
@@ -18,16 +19,19 @@ No additional development required.
 ## Installation
 
 1. Add this extension to your Gemfile with this line:
+
   ```ruby
-  gem 'spree_analytics_trackers', '~> 1.0'
+  gem 'spree_analytics_trackers', '~> 2.0.0.rc1'
   ```
 
 2. Install the gem using Bundler:
+
   ```ruby
   bundle install
   ```
 
 3. Copy & run migrations
+
   ```ruby
   bundle exec rails g spree_analytics_trackers:install
   ```
@@ -52,10 +56,9 @@ Simply add this require statement to your spec_helper:
 require 'spree_analytics_trackers/factories'
 ```
 
-
 ## License
 
-Spree Analytics Trackers is copyright © 2017-2018
+Spree Analytics Trackers is copyright © 2017-2020
 [Spark Solutions Sp. z o.o.][spark]. It is free software,
 and may be redistributed under the terms specified in the
 [LICENCE](LICENSE) file.
@@ -63,6 +66,7 @@ and may be redistributed under the terms specified in the
 [LICENSE]: https://github.com/spree-contrib/spree_analytics_trackers/blob/master/LICENSE
 
 ## About Spark Solutions
+
 [![Spark Solutions](http://sparksolutions.co/wp-content/uploads/2015/01/logo-ss-tr-221x100.png)][spark]
 
 Spree Analytics Trackers is maintained by [Spark Solutions Sp. z o.o.](http://sparksolutions.co?utm_source=github).

data/app/assets/javascripts/spree/frontend/add_to_cart_analytics.js

@@ -0,0 +1,46 @@
+//= require spree/frontend
+
+function gaAddToCart(variant, quantity) {
+  gtag(
+    'event',
+    'add_to_cart',
+    {
+      id: variant.sku,
+      name: variant.name,
+      category: variant.category,
+      variant: variant.options_text,
+      brand: variant.brand,
+      price: variant.price,
+      quantity: quantity
+    }
+  );
+}
+
+function segmentAddtoCart(variant, quantity, currency) {
+  analytics.track('Product Added', {
+    product_id: variant.id,
+    sku: variant.sku,
+    category: variant.category,
+    name: variant.name,
+    brand: variant.brand,
+    price: variant.price,
+    currency: currency,
+    quantity: quantity
+  });
+}
+
+Spree.ready(function(){
+  $('body').on('product_add_to_cart', function(event) {
+    var variant = event.variant
+    var quantity = event.quantity_increment
+    var currency = event.cart.currency
+
+    if (typeof gtag !== 'undefined') {
+      gaAddToCart(variant, quantity)
+    }
+
+    if (typeof analytics !== 'undefined') {
+      segmentAddtoCart(variant, quantity, currency)
+    }
+  })
+});

data/app/controllers/spree_analytics_trackers/store_controller_decorator.rb

@@ -1,11 +1,14 @@
 module SpreeAnalyticsTrackers
   module StoreControllerDecorator
-    def self.prepended(base)
-      base.helper Spree::TrackersHelper
+    def self.included(base)
+      base.include ::Spree::BaseHelper
+      base.include ::Spree::TrackersHelper
+
+      base.helper_method *::Spree::TrackersHelper.public_instance_methods
     end
   end
 end
 
 if defined?(Spree::StoreController)
-  ::Spree::StoreController.prepend(::SpreeAnalyticsTrackers::StoreControllerDecorator)
+  ::Spree::StoreController.include(::SpreeAnalyticsTrackers::StoreControllerDecorator)
 end

data/app/helpers/spree/trackers_helper.rb

@@ -1,32 +1,70 @@
 module Spree
   module TrackersHelper
     def product_for_segment(product, optional = {})
-      {
-        product_id: product.id,
-        sku: product.sku,
-        category: product.category.try(:name),
-        name: product.name,
-        brand: product.brand.try(:name),
-        price: product.price.to_f,
-        currency: product.currency,
-        url: product_url(product)
-      }.tap do |hash|
-        hash[:image_url] = product_for_segment_image_url(hash, optional)
+      cache_key = [
+        'spree-segment-product',
+        I18n.locale,
+        current_currency,
+        product.cache_key_with_version
+      ].compact.join('/')
+
+      product_hash = Rails.cache.fetch(cache_key) do
+        {
+          product_id: product.id,
+          sku: product.sku,
+          category: product.category&.name,
+          name: product.name,
+          brand: product.brand&.name,
+          price: product.price_in(current_currency).amount&.to_f,
+          currency: current_currency,
+          url: spree.product_url(product)
+        }
+      end
+
+      product_hash.tap do |hash|
+        hash[:image_url] = default_image_for_product_or_variant(product)
       end.merge(optional).to_json.html_safe
     end
 
-    private
+    def ga_line_item(line_item)
+      variant = line_item.variant
+
+      cache_key = [
+        'spree-ga-line-item',
+        I18n.locale,
+        current_currency,
+        line_item.cache_key_with_version,
+        variant.cache_key_with_version
+      ].compact.join('/')
+
+      Rails.cache.fetch(cache_key) do
+        product = line_item.product
+        {
+          id: variant.sku,
+          name: variant.name,
+          category: product.category&.name,
+          variant: variant.options_text,
+          brand: product.brand&.name,
+          quantity: line_item.quantity,
+          price: variant.price_in(current_currency).amount&.to_f
+        }.to_json.html_safe
+      end
+    end
+
+    def filtering_param_present?(param)
+      params.key?(param) && params.fetch(param).present?
+    end
 
-    # This method returns either asset_url (Paperclip) or rails_blob_path (ActiveStorage) to return the specified image(s)
-    def product_for_segment_image_url(hash, optional)
-      return unless optional[:image]
+    def any_filtering_params?
+      filtering_params.any? { |p| filtering_param_present?(p) }
+    end
 
-      # Spree 4.0 dropped Paperclip support
-      if Gem.loaded_specs['spree_core'].version >= Gem::Version.create('4.0.0.alpha') || (defined?(ActiveStorage) && !Rails.application.config.use_paperclip)
-        request.base_url + Rails.application.routes.url_helpers.rails_blob_path(optional.delete(:image).attachment, only_path: true)
-      else
-        request.base_url + asset_url(optional.delete(:image).attachment)
+    def filtering_params_with_values
+      params_with_values = {}
+      filtering_params.each do |param|
+        params_with_values[param] = params.fetch(param) if filtering_param_present?(param)
       end
+      params_with_values
     end
   end
 end

data/app/overrides/add_cart_viewed_to_orders_edit.rb

@@ -3,7 +3,7 @@ unless spree_version >= Gem::Version.create('3.4.0') && spree_version < Gem::Ver
   Deface::Override.new(
     virtual_path: 'spree/orders/edit',
     name: 'add_cart_viewed_to_orders_edit',
-    insert_top: "[data-hook='cart_container']",
+    insert_top: '[data-hook="cart_container"]',
     partial: 'spree/shared/trackers/segment/cart_viewed.js',
     original: 'e0a3dcdf759c4ec9fad085cd8a5360c8d68167f5'
   )

data/app/overrides/add_checkout_step_viewed_to_checkout_edit.rb

@@ -2,9 +2,17 @@ spree_version = Gem.loaded_specs['spree_core'].version
 unless spree_version >= Gem::Version.create('3.4.0') && spree_version < Gem::Version.create('3.5.0')
   Deface::Override.new(
     virtual_path: 'spree/checkout/edit',
-    name: 'add_checkout_step_viewed_to_checkout_edit',
-    insert_bottom: "[data-hook='checkout_summary_box']",
+    name: 'add_segment_checkout_step_viewed_to_checkout_edit',
+    insert_after: '[data-hook="checkout_content"]',
     partial: 'spree/shared/trackers/segment/checkout_step_viewed.js',
-    original: 'f7b787e3485b705d0373e248361fcb590a45478e' 
+    original: '806d2120a1ca1050fb093962fee10363c0944b0a'
+  )
+
+  Deface::Override.new(
+    virtual_path: 'spree/checkout/edit',
+    name: 'add_ga_checkout_step_viewed_to_checkout_edit',
+    insert_after: '[data-hook="checkout_content"]',
+    partial: 'spree/shared/trackers/google_analytics/checkout_step_viewed.js',
+    original: '0ac5c18a2db215bf8ba30470a0e5d69e00d0313a'
   )
 end

data/app/overrides/add_google_analytics_page_view_to_spree_application.rb

@@ -0,0 +1,18 @@
+spree_version = Gem.loaded_specs['spree_core'].version
+unless spree_version >= Gem::Version.create('3.3.0') && spree_version < Gem::Version.create('3.5.0') && spree_version != Gem::Version.create('3.5.0.alpha')
+  Deface::Override.new(
+    virtual_path: 'spree/layouts/spree_application',
+    name: 'add_google_analytics_page_viewed_to_spree_application',
+    insert_bottom: "[data-hook='body']",
+    partial: 'spree/shared/trackers/google_analytics/page_viewed.js',
+    original: '6841b819babbe4df1f03d0bc8e05dc81bf0d45ad'
+  )
+
+  Deface::Override.new(
+    virtual_path: 'spree/layouts/checkout',
+    name: 'add_google_analytics_page_viewed_to_spree_checkout',
+    insert_bottom: "[data-hook='body']",
+    partial: 'spree/shared/trackers/google_analytics/page_viewed.js',
+    original: '6841b819babbe4df1f03d0bc8e05dc81bf0d45ad'
+  )
+end

data/app/overrides/add_google_analytics_to_spree_application.rb

@@ -1,9 +1,17 @@
 if Gem.loaded_specs['spree_core'].version >= Gem::Version.create('3.5.0.alpha')
   Deface::Override.new(
     virtual_path: 'spree/layouts/spree_application',
-    name: 'add_google_analytics_to_spree_application',
-    insert_top: "[data-hook='body']",
-    partial: 'spree/shared/google_analytics',
+    name: 'add_google_analytics_initializer_to_spree_application',
+    insert_top: '[data-hook="inside_head"]',
+    partial: 'spree/shared/trackers/google_analytics/initializer.js',
     original: 'cfa30a2831d9a41394c03229cd28b3c7eee69585'
   )
+
+  Deface::Override.new(
+    virtual_path: 'spree/layouts/checkout',
+    name: 'add_google_analytics_initializer_to_spree_checkout',
+    insert_top: '[data-hook="inside_head"]',
+    partial: 'spree/shared/trackers/google_analytics/initializer.js',
+    original: 'ca3d46a134b93856baf937cf2e473da66d9d8efc'
+  )
 end

data/app/overrides/add_google_purchase_to_orders_show.rb

@@ -3,7 +3,7 @@ if Gem.loaded_specs['spree_core'].version >= Gem::Version.create('3.5.0')
     virtual_path: 'spree/orders/show',
     name: 'add_google_purchase_to_orders_show',
     insert_before: "#order_summary",
-    partial: 'spree/shared/google_purchase',
+    partial: 'spree/shared/trackers/google_analytics/purchase.js',
     original: 'ac7f302922a3c1bb080095296ccc20e42bab2967' 
   )
 end

data/app/overrides/add_product_list_filtered_to_taxons_show.rb

@@ -1,7 +1,7 @@
 spree_version = Gem.loaded_specs['spree_core'].version
 unless spree_version >= Gem::Version.create('3.4.0') && spree_version < Gem::Version.create('3.5.0')
   Deface::Override.new(
-    virtual_path: 'spree/taxons/show',
+    virtual_path: 'spree/taxons/_header',
     name: 'add_product_list_filtered_to_taxons_show',
     insert_before: ".taxon-title",
     original: '2d71d85f4cb141a6ff90264e48915493d6856e9b',

data/app/overrides/add_product_list_viewed_to_products_list.rb

@@ -3,7 +3,7 @@ unless spree_version >= Gem::Version.create('3.4.0') && spree_version < Gem::Ver
   Deface::Override.new(
     virtual_path: 'spree/shared/_products',
     name: 'add_product_list_viewed_to_products_list',
-    insert_before: "[data-hook='products_search_results_heading']",
+    insert_before: '[data-hook="homepage_products"]',
     partial: 'spree/shared/trackers/segment/product_list_viewed.js',
     original: '8b47dddca9dfaaacca3d462459c6c1ef06c09926' 
   )

data/app/overrides/add_product_viewed_to_products_show.rb

@@ -3,8 +3,8 @@ unless spree_version >= Gem::Version.create('3.4.0') && spree_version < Gem::Ver
   Deface::Override.new(
     virtual_path: 'spree/products/show',
     name: 'add_product_viewed_to_products_show',
-    insert_before: "[data-hook='product_show']",
+    insert_bottom: '[data-hook="product_show"]',
     partial: 'spree/shared/trackers/segment/product_viewed.js',
-    original: '5426c263ccfe477b270b55024abebc77cf951c91' 
+    original: '5426c263ccfe477b270b55024abebc77cf951c91'
   )
 end