spree_analytics_trackers 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48c88ea88bf027af900280e3c8b35acf53278b197fd1b5d52009a6c281745727
-  data.tar.gz: 93b920ab1f3a819701c598af63a6714986d90653f524dabf49610b1079c20e78
+  metadata.gz: 73068544992b2ab73b42d2d9973c61217f2e9006b1eeaf82bb487d0c06694253
+  data.tar.gz: b5487f54f759141810e350a7aabe3c89870a2586d0f79c234c02a9a2f962c96d
 SHA512:
-  metadata.gz: 8a4693c38576c0bd279305648343fbe87d82be9d0583a94e4c1368266fb8374377e414006aa7eed9f919d9d4ca2a06f3515f3bc6e382158a2937cb68b4f9e561
-  data.tar.gz: 758080aec33605cfb61d6517ff477b0db916fb6bea5ecba2609ca655d61a338d3edf8cba8fe0fc75cb12b3edd1aa070cc702c60399d46e20c3ed4472ab5ffc94
+  metadata.gz: 961549e600a21cb31dad51459269e95f304c2540ad6e4603780a74548e77331507f0ffa9b7e64663915f9ade40107422e105ec4ab3e735b22c269176b7cb0ba6
+  data.tar.gz: bb01db4431806581753611af24c40f6bfe60b9454c063a3907676bbecce138a2c5260a4e52290cecb9c05cb65e448c32056d6d91da7714b7250d7fd3987a4d22

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/.travis.yml

@@ -0,0 +1,29 @@
+sudo: required
+dist: trusty
+
+language: ruby
+
+env:
+  - DB=postgres
+  - DB=mysql
+
+gemfile:
+  - gemfiles/spree_3_5.gemfile
+  - gemfiles/spree_3_7.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:
+  allow_failures:
+    - gemfile: gemfiles/spree_master.gemfile
+
+before_install:
+  - mysql -u root -e "GRANT ALL ON *.* TO 'travis'@'%';"

data/Appraisals

@@ -0,0 +1,17 @@
+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'
+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-2018 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,73 @@
+# 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', '~> 1.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-2018
+[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/controllers/spree/admin/trackers_controller.rb

@@ -0,0 +1,6 @@
+module Spree
+  module Admin
+    class TrackersController < ResourceController
+    end
+  end
+end

data/app/controllers/spree/store_controller_decorator.rb

@@ -0,0 +1,5 @@
+if defined?(Spree::StoreController)
+  Spree::StoreController.class_eval do
+    helper Spree::TrackersHelper
+  end
+end

data/app/helpers/spree/trackers_helper.rb

@@ -0,0 +1,23 @@
+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
+      end.merge(optional).to_json.html_safe
+    end
+  end
+end

data/app/models/spree/line_item_decorator.rb

@@ -0,0 +1,6 @@
+if Gem.loaded_specs['spree_core'].version < Gem::Version.create('3.2.0')
+  Spree::LineItem.class_eval do
+    delegate :brand, :category, to: :product
+    delegate :options_text, to: :variant
+  end
+end

data/app/models/spree/order_decorator.rb

@@ -0,0 +1,7 @@
+if Gem.loaded_specs['spree_core'].version < Gem::Version.create('3.3.0')
+  Spree::Order.class_eval do
+    def promo_code
+      promotions.pluck(:code).compact.first
+    end
+  end
+end

data/app/models/spree/product_decorator.rb

@@ -0,0 +1,11 @@
+if Gem.loaded_specs['spree_core'].version < Gem::Version.create('3.2.0')
+  Spree::Product.class_eval do
+    def category
+      taxons.joins(:taxonomy).find_by(spree_taxonomies: { name: Spree.t(:taxonomy_categories_name) })
+    end
+
+    def brand
+      taxons.joins(:taxonomy).find_by(spree_taxonomies: { name: Spree.t(:taxonomy_brands_name) })
+    end
+  end
+end

data/app/models/spree/tracker.rb

@@ -0,0 +1,25 @@
+module Spree
+  class Tracker < Spree::Base
+    TRACKING_ENGINES = %i(google_analytics segment).freeze
+    enum engine: TRACKING_ENGINES
+
+    after_commit :clear_cache
+
+    validates :analytics_id, presence: true, uniqueness: { scope: :engine, case_sensitive: false }
+
+    scope :active, -> { where(active: true) }
+
+    def self.current(engine = TRACKING_ENGINES.first)
+      tracker = Rails.cache.fetch("current_tracker/#{engine}") do
+        send(engine).active.first
+      end
+      tracker.analytics_id.present? ? tracker : nil if tracker
+    end
+
+    def clear_cache
+      TRACKING_ENGINES.each do |engine|
+        Rails.cache.delete("current_tracker/#{engine}")
+      end
+    end
+  end
+end

data/app/models/spree/user_decorator.rb

@@ -0,0 +1,5 @@
+Spree.user_class.class_eval do
+  def analytics_id
+    id
+  end
+end

data/app/overrides/add_analytics_to_admin_sidebar.rb

@@ -0,0 +1,9 @@
+if Gem.loaded_specs['spree_core'].version >= Gem::Version.create('3.5.0')
+  Deface::Override.new(
+    virtual_path: 'spree/admin/shared/sub_menu/_configuration',
+    name: 'add_analytics_to_admin_configurations_sidebar_menu',
+    insert_bottom: '[data-hook="admin_configurations_sidebar_menu"]',
+    original: '72f6a33afb2627a467ae458d42991ab0ce4cc6df',
+    text: '<%= configurations_sidebar_menu_item(Spree.t(:analytics_trackers), spree.admin_trackers_path) if can? :manage, Spree::Tracker %>'
+  )
+end

data/app/overrides/add_cart_viewed_to_orders_edit.rb

@@ -0,0 +1,10 @@
+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/orders/edit',
+    name: 'add_cart_viewed_to_orders_edit',
+    insert_top: "[data-hook='cart_container']",
+    partial: 'spree/shared/trackers/segment/cart_viewed.js',
+    original: 'e0a3dcdf759c4ec9fad085cd8a5360c8d68167f5'
+  )
+end

data/app/overrides/add_checkout_step_viewed_to_checkout_edit.rb

@@ -0,0 +1,10 @@
+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']",
+    partial: 'spree/shared/trackers/segment/checkout_step_viewed.js',
+    original: 'f7b787e3485b705d0373e248361fcb590a45478e' 
+  )
+end

data/app/overrides/add_google_analytics_to_spree_application.rb

@@ -0,0 +1,9 @@
+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',
+    original: 'cfa30a2831d9a41394c03229cd28b3c7eee69585'
+  )
+end

data/app/overrides/add_google_checkout_to_checkout_edit.rb

@@ -0,0 +1,9 @@
+if Gem.loaded_specs['spree_core'].version >= Gem::Version.create('3.5.0')
+  Deface::Override.new(
+    virtual_path: 'spree/checkout/edit',
+    name: 'add_google_checkout_to_checkout_edit',
+    insert_before: "#checkout",
+    partial: 'spree/shared/google_checkout',
+    original: '1bc9409097210501fee61bc448df937682546308' 
+  )
+end

data/app/overrides/add_google_purchase_to_orders_show.rb

@@ -0,0 +1,9 @@
+if Gem.loaded_specs['spree_core'].version >= Gem::Version.create('3.5.0')
+  Deface::Override.new(
+    virtual_path: 'spree/orders/show',
+    name: 'add_google_purchase_to_orders_show',
+    insert_before: "#order_summary",
+    partial: 'spree/shared/google_purchase',
+    original: 'ac7f302922a3c1bb080095296ccc20e42bab2967' 
+  )
+end

data/app/overrides/add_order_complete_to_orders_show.rb

@@ -0,0 +1,10 @@
+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')
+  Deface::Override.new(
+    virtual_path: 'spree/orders/show',
+    name: 'add_order_complete_to_orders_show',
+    insert_before: "#order_summary",
+    partial: 'spree/shared/trackers/segment/order_complete.js',
+    original: 'ac7f302922a3c1bb080095296ccc20e42bab2967' 
+  )
+end

data/app/overrides/add_product_added_to_orders_edit.rb

@@ -0,0 +1,10 @@
+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/orders/edit',
+    name: 'add_product_added_to_orders_edit',
+    insert_top: "[data-hook='cart_container']",
+    partial: 'spree/shared/trackers/segment/product_added.js',
+    original: '75a9171ce7647353a00bdfa178b131872e7f9bdc'
+  )
+end

data/app/overrides/add_product_list_filtered_to_taxons_show.rb

@@ -0,0 +1,10 @@
+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',
+    name: 'add_product_list_filtered_to_taxons_show',
+    insert_before: ".taxon-title",
+    original: '2d71d85f4cb141a6ff90264e48915493d6856e9b',
+    partial: 'spree/shared/trackers/segment/product_list_filtered.js'
+  )
+end

data/app/overrides/add_product_list_viewed_to_products_list.rb

@@ -0,0 +1,10 @@
+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/shared/_products',
+    name: 'add_product_list_viewed_to_products_list',
+    insert_before: "[data-hook='products_search_results_heading']",
+    partial: 'spree/shared/trackers/segment/product_list_viewed.js',
+    original: '8b47dddca9dfaaacca3d462459c6c1ef06c09926' 
+  )
+end