spree_analytics_trackers 1.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48c88ea88bf027af900280e3c8b35acf53278b197fd1b5d52009a6c281745727
-  data.tar.gz: 93b920ab1f3a819701c598af63a6714986d90653f524dabf49610b1079c20e78
+  metadata.gz: 502cf1fa8e70cb9ceb4e1b24ec08c257cb5314249e5ab3403aa61ae463fb69fc
+  data.tar.gz: 4c44fd4f1c8172a51499a1e4bcef65538e185ad2c8ace20728a05c28e8347542
 SHA512:
-  metadata.gz: 8a4693c38576c0bd279305648343fbe87d82be9d0583a94e4c1368266fb8374377e414006aa7eed9f919d9d4ca2a06f3515f3bc6e382158a2937cb68b4f9e561
-  data.tar.gz: 758080aec33605cfb61d6517ff477b0db916fb6bea5ecba2609ca655d61a338d3edf8cba8fe0fc75cb12b3edd1aa070cc702c60399d46e20c3ed4472ab5ffc94
+  metadata.gz: 7824a5e18c3a7d0cd5afdb714f5ef4f727acfbc13e542ad7d33451b5478db03a530ae17dacb48a2dfc799084b3fd4a266417a6c6dfa2dd58d6d98a01c4625c2e
+  data.tar.gz: 54f3aeb09eb35e8c0a285778b5e2c91a57dcdd5971b618343a006fcc8a5dbaf7073fbcf902d540c52788d630848992f8e83ff4ec5511dde26295ea64a9ffa959

data/.bundle/config

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

data/.gitignore

@@ -0,0 +1,21 @@
+\#*
+*~
+.#*
+.DS_Store
+.idea
+.localeapp/locales
+.project
+coverage
+default
+Gemfile.lock
+tmp
+nbproject
+pkg
+*.sw?
+spec/dummy
+.rvmrc
+.sass-cache
+public/spree
+.ruby-version
+.ruby-gemset
+gemfiles/*.gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--color
+-r spec_helper
+-f documentation

data/.rubocop.yml

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

data/.travis.yml

@@ -0,0 +1,44 @@
+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=mysql
+  - DB=postgres
+
+gemfile:
+  - gemfiles/spree_4_1.gemfile
+  - gemfiles/spree_master.gemfile
+
+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

@@ -0,0 +1,11 @@
+appraise 'spree-4-1' do
+  gem 'spree', '~> 4.1.0'
+  gem 'spree_auth_devise', '~> 4.1.0'
+  gem 'rails-controller-testing'
+end
+
+appraise 'spree-master' do
+  gem 'spree', github: 'spree/spree', branch: 'master'
+  gem 'spree_auth_devise', github: 'spree/spree_auth_devise', branch: 'master'
+  gem 'rails-controller-testing'
+end

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gem 'spree', github: 'spree/spree', branch: 'master'
+gem 'spree_auth_devise', github: 'spree/spree_auth_devise', branch: 'master'
+gem 'rails-controller-testing'
+
+gemspec

data/LICENSE

@@ -0,0 +1,26 @@
+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,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name Spree nor the names of its contributors may be used to
+      endorse or promote products derived from this software without specific
+      prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,77 @@
+# Spree Analytics Trackers
+
+[![Build Status](https://travis-ci.org/spree-contrib/spree_analytics_trackers.svg?branch=master)](https://travis-ci.org/spree-contrib/spree_analytics_trackers)
+
+This extensions adds support for [Google Analytics Enhanced Ecommerce](https://developers.google.com/analytics/devguides/collection/analyticsjs/enhanced-ecommerce)
+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
+* Facebook Pixels
+* Google Adwords remarketing
+* [and hundreds others](https://segment.com/catalog#integrations/all)
+
+No additional development required.
+
+## Installation
+
+1. Add this extension to your Gemfile with this line:
+
+  ```ruby
+  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
+  ```
+
+4. Restart your server
+
+  If your server was running, restart it so that it can find the assets properly.
+
+## Testing
+
+First bundle your dependencies, then run `rake`. `rake` will default to building the dummy app if it does not exist, then it will run specs. The dummy app can be regenerated by using `rake test_app`.
+
+```shell
+bundle
+bundle exec rake
+```
+
+When testing your applications integration with this extension you may use it's factories.
+Simply add this require statement to your spec_helper:
+
+```ruby
+require 'spree_analytics_trackers/factories'
+```
+
+## License
+
+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.
+
+[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).
+
+We are passionate about open source software.
+We are [available for hire][spark].
+
+[spark]:http://sparksolutions.co?utm_source=github

data/Rakefile

@@ -0,0 +1,21 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+require 'spree/testing_support/extension_rake'
+
+RSpec::Core::RakeTask.new
+
+task :default do
+  if Dir["spec/dummy"].empty?
+    Rake::Task[:test_app].invoke
+    Dir.chdir("../../")
+  end
+  Rake::Task[:spec].invoke
+end
+
+desc 'Generates a dummy app for testing'
+task :test_app do
+  ENV['LIB_NAME'] = 'spree_analytics_trackers'
+  Rake::Task['extension:test_app'].invoke
+end

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

@@ -0,0 +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/store_controller_decorator.rb

@@ -0,0 +1,14 @@
+module SpreeAnalyticsTrackers
+  module StoreControllerDecorator
+    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.include(::SpreeAnalyticsTrackers::StoreControllerDecorator)
+end

data/app/helpers/spree/trackers_helper.rb

@@ -0,0 +1,86 @@
+module Spree
+  module TrackersHelper
+    def product_for_segment(product, 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
+
+    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