spree_analytics_trackers 1.0.1 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73068544992b2ab73b42d2d9973c61217f2e9006b1eeaf82bb487d0c06694253
-  data.tar.gz: b5487f54f759141810e350a7aabe3c89870a2586d0f79c234c02a9a2f962c96d
+  metadata.gz: 39824346c7fd7f4f0369de8f15513e63cb3c3c490ea1ff746ab2022e644c0316
+  data.tar.gz: 6df1197ae57739e09de6f7abc91e3f3b44bec114efa608fa1b97c1f0e2b3a6d4
 SHA512:
-  metadata.gz: 961549e600a21cb31dad51459269e95f304c2540ad6e4603780a74548e77331507f0ffa9b7e64663915f9ade40107422e105ec4ab3e735b22c269176b7cb0ba6
-  data.tar.gz: bb01db4431806581753611af24c40f6bfe60b9454c063a3907676bbecce138a2c5260a4e52290cecb9c05cb65e448c32056d6d91da7714b7250d7fd3987a4d22
+  metadata.gz: 196444a2a5020015e889c7f8a4f09180338372a900b4f44e0af2c0637cca747ae00249a9afab3d8c7f67c6edb68821ee86bd59b181641b25121d630440ccd773
+  data.tar.gz: 73956ab392e0802b1256aac939ea280b846a7464d2fbfaeba5d4bf386622e750fc81cd936226cece3984b1badf8d00679301251609433cb13e37d02121362cad

data/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_JOBS: "8"

data/.rubocop.yml

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

data/.travis.yml

@@ -1,29 +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
+  - DB=postgres
 
 gemfile:
-  - gemfiles/spree_3_5.gemfile
-  - gemfiles/spree_3_7.gemfile
+  - gemfiles/spree_4_1.gemfile
   - gemfiles/spree_master.gemfile
 
-script:
-  - bundle exec rake test_app
-  - bundle exec rake spec
-
-rvm:
-  - 2.3.3
-  - 2.4.2
-  - 2.5.2
-
-matrix:
+jobs:
   allow_failures:
     - gemfile: gemfiles/spree_master.gemfile
 
 before_install:
   - mysql -u root -e "GRANT ALL ON *.* TO 'travis'@'%';"
+
+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,12 +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'
+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'
   ```
 
 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,50 @@
+//= require spree/frontend
+
+function gaAddToCart(variant, quantity) {
+  clearGAplugins();
+  var price = typeof variant.price === 'object' ? variant.price.amount : variant.price
+  gtag(
+    'event',
+    'add_to_cart',
+    {
+      items: [{
+        id: variant.sku,
+        name: variant.name,
+        category: variant.category,
+        variant: variant.options_text,
+        brand: variant.brand,
+        price: 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/assets/javascripts/spree/frontend/remove_from_cart_analytics.js

@@ -0,0 +1,34 @@
+//= require spree/frontend
+
+function gaRemoveFromCart(variant) {
+  clearGAplugins();
+  gtag(
+    'event',
+    'remove_from_cart',
+    {
+      items: [{
+        id: variant.sku,
+        name: variant.name,
+        price: variant.price,
+        variant: variant.options,
+        quantity: variant.quantity
+      }]
+    }
+  );
+}
+
+Spree.ready(function(){
+  $('body').on('product_remove_from_cart', function(event) {
+    var variant = {
+      sku: event.variant_sku,
+      name: event.variant_name,
+      price: event.variant_price,
+      options: event.variant_options,
+      quantity: event.variant_quantity
+    }
+
+    if (typeof gtag !== 'undefined') {
+      gaRemoveFromCart(variant)
+    }
+  })
+})

data/app/controllers/spree/admin/trackers_controller.rb

@@ -1,6 +1,14 @@
 module Spree
   module Admin
     class TrackersController < ResourceController
+      before_action :load_data
+
+      private
+
+      def load_data
+        @engines = Spree::Tracker.engines.keys.sort.map { |k| [k.humanize, k] }
+        @stores = Spree::Store.all
+      end
     end
   end
 end

data/app/controllers/spree_analytics_trackers/checkout_controller_decorator.rb

@@ -0,0 +1,11 @@
+module SpreeAnalyticsTrackers
+  module CheckoutControllerDecorator
+    def self.included(base)
+      base.helper 'spree/trackers'
+    end
+  end
+end
+
+if defined?(Spree::CheckoutController)
+  ::Spree::CheckoutController.include(::SpreeAnalyticsTrackers::CheckoutControllerDecorator)
+end

data/app/controllers/spree_analytics_trackers/store_controller_decorator.rb

@@ -0,0 +1,13 @@
+module SpreeAnalyticsTrackers
+  module StoreControllerDecorator
+    def self.included(base)
+      base.include ::Spree::BaseHelper
+      
+      base.helper 'spree/trackers'
+    end
+  end
+end
+
+if defined?(Spree::StoreController)
+  ::Spree::StoreController.include(::SpreeAnalyticsTrackers::StoreControllerDecorator)
+end

data/app/controllers/spree_analytics_trackers/user_confirmations_controller_decorator.rb

@@ -0,0 +1,11 @@
+module SpreeAnalyticsTrackers
+  module UserConfirmationsControllerDecorator
+    def self.included(base)
+      base.helper 'spree/trackers'
+    end
+  end
+end
+
+if defined?(Spree::UserConfirmationsController)
+  ::Spree::UserConfirmationsController.include(::SpreeAnalyticsTrackers::UserConfirmationsControllerDecorator)
+end

data/app/controllers/spree_analytics_trackers/user_passwords_controller_decorator.rb

@@ -0,0 +1,11 @@
+module SpreeAnalyticsTrackers
+  module UserPasswordsControllerDecorator
+    def self.included(base)
+      base.helper 'spree/trackers'
+    end
+  end
+end
+
+if defined?(Spree::UserPasswordsController)
+  ::Spree::UserPasswordsController.include(::SpreeAnalyticsTrackers::UserPasswordsControllerDecorator)
+end

data/app/controllers/spree_analytics_trackers/user_registrations_controller_decorator.rb

@@ -0,0 +1,11 @@
+module SpreeAnalyticsTrackers
+  module UserRegistrationsControllerDecorator
+    def self.included(base)
+      base.helper 'spree/trackers'
+    end
+  end
+end
+
+if defined?(Spree::UserRegistrationsController)
+  ::Spree::UserRegistrationsController.include(::SpreeAnalyticsTrackers::UserRegistrationsControllerDecorator)
+end

data/app/controllers/spree_analytics_trackers/user_sessions_controller_decorator.rb

@@ -0,0 +1,11 @@
+module SpreeAnalyticsTrackers
+  module UserSessionsControllerDecorator
+    def self.included(base)
+      base.helper 'spree/trackers'
+    end
+  end
+end
+
+if defined?(Spree::UserSessionsController)
+  ::Spree::UserSessionsController.include(::SpreeAnalyticsTrackers::UserSessionsControllerDecorator)
+end

data/app/helpers/spree/trackers_helper.rb

@@ -1,23 +1,86 @@
 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|
-        # This method returns either asset_url (Paperclip) or rails_blob_path (ActiveStorage) to return the specified image(s)
-        if defined?(ActiveStorage) && !Rails.application.config.use_paperclip
-          hash[:image_url] =  request.base_url + Rails.application.routes.url_helpers.rails_blob_path(optional.delete(:image).attachment, only_path: true) if optional[:image]
-        else
-          hash[:image_url] = request.base_url + asset_url(optional.delete(:image).attachment) if optional[:image]
-        end
+      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
+
+    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
+
+    def any_filtering_params?
+      filtering_params.any? { |p| filtering_param_present?(p) }
+    end
+
+    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
+
+    def segment_tracker
+      @segment_tracker ||= Spree::Tracker.current(:segment, current_store)
+    end
+
+    def segment_enabled?
+      segment_tracker.present?
+    end
+
+    def ga_tracker
+      @ga_tracker ||= Spree::Tracker.current(:google_analytics, current_store)
+    end
+
+    def ga_enabled?
+      ga_tracker.present?
+    end
   end
 end

data/app/models/spree/tracker.rb

@@ -5,20 +5,26 @@ module Spree
 
     after_commit :clear_cache
 
-    validates :analytics_id, presence: true, uniqueness: { scope: :engine, case_sensitive: false }
+    validates :analytics_id, presence: true, uniqueness: { scope: [:engine, :store_id], case_sensitive: false }
+    validates :store, presence: true
 
     scope :active, -> { where(active: true) }
 
-    def self.current(engine = TRACKING_ENGINES.first)
-      tracker = Rails.cache.fetch("current_tracker/#{engine}") do
-        send(engine).active.first
+    belongs_to :store
+
+    def self.current(engine = nil, store = nil)
+      engine ||= TRACKING_ENGINES.first
+      store  ||= Spree::Store.default
+
+      tracker = Rails.cache.fetch("current_tracker/#{engine}/#{store.id}") do
+        active.find_by(store: store, engine: engine)
       end
       tracker.analytics_id.present? ? tracker : nil if tracker
     end
 
     def clear_cache
       TRACKING_ENGINES.each do |engine|
-        Rails.cache.delete("current_tracker/#{engine}")
+        Rails.cache.delete("current_tracker/#{engine}/#{store_id}")
       end
     end
   end