spree_gtm 0.0.14 → 0.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5664b65b255c9770d756b2a4f8655ff4837ce2e4
-  data.tar.gz: f58c52f4b815159516365a8beee6c7c33db3b251
+  metadata.gz: 68c7a090be3725ad8a368dfc8fc2d868699d57f9
+  data.tar.gz: 91b2569964948d4a9c9a25af05b6fe51361757de
 SHA512:
-  metadata.gz: 70b92688a4c1e0b7e353250f2fd9aff0b950221cc8f22ed62e18d4f223e0b6b0c5e6711ffa4265dcfc9d08792c5987881d2725afbad1c9de6b4a3479abdf5db8
-  data.tar.gz: 71f9f55c858697425f51a53707aa3610f5d8f25a4f545a2f9e72a80d0c71ca9d23d31dedc1bdbf9847d760bdc7df01f43ed6e72fa7750302810750ffdf5afb6f
+  metadata.gz: cff1c9effa20a91f7f31e42f100e875e25422ca8966d17104a89b32e29b614a1cc193104c12a0cd3555ca7079f0a86075e9678438b9c0d961e18c0efbbccb08e
+  data.tar.gz: bc2cffda908ee76c6b6ada78a96cf00fa8a47d02fb320535bd74071d23d50cde41a82565dcfad3953c66963ca27eaf465e3ab4109ac5159a3e927dcb0c8c7661

data/Gemfile

@@ -5,3 +5,8 @@ gem 'spree', github: 'spree/spree', branch: '3-1-stable'
 gem 'spree_auth_devise', github: 'spree/spree_auth_devise', branch: '3-1-stable'
 
 gemspec
+
+group :test do
+  gem 'rspec'
+  gem 'launchy'
+end

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2016 [name of plugin creator]
+Copyright (c) 2016 Rostislav Korin
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification,

data/README.md

@@ -1,12 +1,20 @@
- Spree Google Tag Maneger Plugin
---------------------------------
+SPREE GOOGLE TAG MANAGER PLUGIN
+============
 
 [![Gem Version](https://badge.fury.io/rb/spree_gtm.svg)](https://badge.fury.io/rb/spree_gtm)
  [![Code Climate](https://codeclimate.com/github/RostislavKorin/spree_gtm/badges/gpa.svg)](https://codeclimate.com/github/RostislavKorin/spree_gtm)
  [![Build Status](https://travis-ci.org/RostislavKorin/spree_gtm.svg?branch=master)](https://travis-ci.org/RostislavKorin/spree_gtm)
 
+DESCRIPTION
+--------------------------------
+spree_gtm  is an extension to Spree (a complete open source commerce solution for Ruby on Rails) that uses for implementation Google Tag Manager
+
+REQUIREMENTS
+--------------------------------
+Spree Core 3.0.0 or greater
+
 Installation
-============
+--------------------------------
 
 Add to your spree shop Gemfile
 
@@ -15,6 +23,65 @@ Add to your spree shop Gemfile
 Run bundle install
 
 Configuration
-=============
+--------------------------------
 
 Go to admin >  Configuration > gtm, fill in your gtm account id
+
+Examples
+--------------------------------
+This is an exemple of configuration s2m order tag:
+
+```
+<script type="text/javascript">
+  <!--
+    function _s2m_t()
+    {
+      var s2m_shop = S2MOrderTransaction( 1347, "4.1.20160413" );
+      var orderInfo = new Object();
+      orderInfo.trans_id     = {{transactionId}};
+      orderInfo.trans_type   = "order";
+      orderInfo.amount_1     = {{transactionTotal}} - {{transactionShipping}};
+      orderInfo.amount_2     = {{transactionTotal}} - {{transactionShipping}} - {{transactionTax}};
+      orderInfo.amount_3     = {{transactionShipping}} + {{transactionTax}};
+      s2m_shop.set_order_info( orderInfo );
+
+      // Repeat itemInfo# where # increases per product
+      var itemInfo1 = new Object();
+  	  var  products = {{transactionProducts}}
+  	  for (i=0; i<products.length; i++){
+      itemInfo1.trans_id      = {{transactionId}};
+      itemInfo1.item_id       = {{transactionProducts}}[i].sku;
+      itemInfo1.item_info_1   = {{transactionProducts}}[i].name;
+      itemInfo1.item_amount_1 = {{transactionProducts}}[i].price;
+      itemInfo1.item_amount_2 = {{transactionProducts}}[i].price;
+      itemInfo1.quantity      = {{transactionProducts}}[i].quantity;
+      s2m_shop.add_item_info( itemInfo1 );}
+
+      var userInfo = new Object();
+      userInfo.user_email      = {{transactionEmail}};
+      userInfo.customer_id     = {{userid}};
+      s2m_shop.set_user_info( userInfo );
+      s2m_shop.transact();
+    }
+    try{
+      var __s2m_host = "demo.shop2market.com";
+      var __s2m_js = document.createElement('script');
+      __s2m_js.type = 'text/javascript'; __s2m_js.async = true;
+      __s2m_js.src = (("https:" == document.location.protocol) ? "https://" : "http://") + __s2m_host + "/javascripts/s2m.js";
+      __s2m_js.onload = _s2m_t;
+      __s2m_js.onreadystatechange = function () {
+        if (this.readyState == 'complete'|| this.readyState == 'loaded') _s2m_t();
+      }
+      var __s2m_script = document.getElementsByTagName('script')[0];
+      __s2m_script.parentNode.insertBefore( __s2m_js, __s2m_script );
+    }catch(err){}
+  -->
+</script>
+```
+where {{transactionId}}, {{transactionTotal}}, {{transactionProducts}} etc. are VARIABLES which you must create in GOOGLE TAG MANAGER taking date from Data Layer.
+
+RESOURCES
+--------------------------------
+https://www.google.com/analytics/tag-manager/
+
+https://spreecommerce.com/

data/app/views/spree/gtm/_google_tag_manager_head.html.erb

@@ -15,9 +15,39 @@
   <% if @order.present? and @order.email.present? %>
     dataLayer.push({'transactionEmail': '<%= @order.email %>'});
   <% end %>
+
+  <% if current_page?('/cart') %>
+    dataLayer.push({'cart': [
+      <%=raw @order.line_items.map { |line_item| "{ 'sku': '#{h line_item.variant.sku}',
+                                                    'name': '#{h line_item.variant.product.name}',
+                                                    'category': '',
+                                                    'price': #{h line_item.price},
+                                                    'quantity': #{h line_item.quantity}}" } .join(",") %>
+        ]
+      });
+  <% end %>
+
+   <% if @product %>
+      dataLayer.push({'product': [
+        'name': '<%= @product.name %>',
+        'sku': '<%= @product.sku %>',
+        'price': '<%= @product.price %>'
+        ]
+      });
+   <% end %>
+
+   <% if @category %>
+     dataLayer.push({'category': ['name': '<%= @category.name %>']});
+   <% end %>
+
+   <% if @search %>
+     dataLayer.push({'search': ['name': '<%= @category.name %>']});
+   <% end %>
+
   <% if @order.present? and @order.user.present? %>
     dataLayer.push({'userid': '<%= @order.user.id %>'});
   <% end %>
+
     <% if @order.present? && @order.bill_address.present?  %>
 
       dataLayer.push({

data/spec/requests/admin/gtm_render_tag_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe "GTM value set in controller" do
+  context "value set in controller " do
+    it "should render tag" do
+      user = create(:admin_user, :email => "test@example.com", :password => "spree123")
+      sign_in_as!(user)
+      visit spree.admin_path
+      click_link "Configurations"
+      click_link "Google Tag Manager"
+      fill_in('Gtm accountid', :with => 'bag')
+      click_button "Save"
+      page.should have_content("Gtm has been successfully")
+      visit ('/')
+      page.all('body script', visible: false).each do |script|
+        script.text == "dataLayer, bag"
+      end
+    end
+  end
+end

data/spec/requests/gtm_dont_render_tag_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe "GTM value doesnt set in controller" do
+  context "value doesnt set in controller " do
+    it "should doesnt render tag" do
+      visit ('/')
+      page.all('body script', visible: false).each do |script|
+        script.text != "dataLayer"
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -22,7 +22,7 @@ require 'ffaker'
 # Requires supporting ruby files with custom matchers and macros, etc,
 # in spec/support/ and its subdirectories.
 Dir[File.join(File.dirname(__FILE__), 'support/**/*.rb')].each { |f| require f }
-
+Capybara.ignore_hidden_elements = false
 # Requires factories and other useful helpers defined in spree_core.
 require 'spree/testing_support/authorization_helpers'
 require 'spree/testing_support/capybara_ext'
@@ -34,6 +34,9 @@ require 'spree/testing_support/url_helpers'
 require 'spree_gtm/factories'
 
 RSpec.configure do |config|
+
+  config.include AuthenticationHelpers, :type => :request
+  config.include Capybara::DSL
   config.include FactoryGirl::Syntax::Methods
 
   # Infer an example group's spec type from the file location.

data/spec/support/authentication_helpers.rb

@@ -0,0 +1,9 @@
+module AuthenticationHelpers
+    def sign_in_as!(user)
+        visit '/login'
+        fill_in "Email", :with => "test@example.com"
+        fill_in "Password", :with => "spree123"
+        click_button "Login"
+        page.should have_content("Logged in successfully")
+    end
+end

data/spree_gtm.gemspec

@@ -2,7 +2,7 @@
 Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.name        = 'spree_gtm'
-  s.version     = '0.0.14'
+  s.version     = '0.0.15'
   s.summary     = 'some summary here'
   s.description = 'some gem description here'
   s.required_ruby_version = '>= 2.1.0'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spree_gtm
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 0.0.15
 platform: ruby
 authors:
 - Stanislav O. Pogrebnyak
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-26 00:00:00.000000000 Z
+date: 2016-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: spree_core
@@ -200,7 +200,10 @@ files:
 - lib/spree_gtm.rb
 - lib/spree_gtm/engine.rb
 - lib/spree_gtm/factories.rb
+- spec/requests/admin/gtm_render_tag_spec.rb
+- spec/requests/gtm_dont_render_tag_spec.rb
 - spec/spec_helper.rb
+- spec/support/authentication_helpers.rb
 - spree_gtm.gemspec
 homepage: 
 licenses: