gtm_on_rails 0.1.12 → 0.1.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f95bfc0b90f29aa34530add86ae984e9840c2d7c
-  data.tar.gz: 07b3ec87f742d769cd75885611bc65cc3155d048
+  metadata.gz: 2286c644421d286b191d0dcf4d13630a1eb68e64
+  data.tar.gz: '0595efe9d6e06b2ae8c722b791cbf738d3ee284f'
 SHA512:
-  metadata.gz: 26403d1c6beca9c2d30dd1c74bd2cad3d82619d7686d04e1e16634096dd6c296279e63db3c2289d661af219d811af4d30684bf4447c9a0a5f711fc18a70d6ff0
-  data.tar.gz: 1d2fd5e5732c12a565a991aa56e32d9c0fddea5607947b5261e629e05839c5c7a7597048da033074f239c791eba5e5115a101d7799db9d24fa8b55b7984bd919
+  metadata.gz: 49686ed7d4c9dbcf126474313987b491161f2a9f0c09c47f09e18ef8eb8b40f765943d6192f3bc19d16791a9779974c0b791a2292948b3e5a3eef84d8aef19b6
+  data.tar.gz: aea4782dab512cc8e90f783b243080118dc6bdc088c58c34db8e223de17958c69f7707a209a9c4a648b4f9f90f9e20a3ba783035df9655c5e3f52b663f751eab

data/lib/gtm_on_rails/models/data_layer/ecommerce.rb

@@ -3,10 +3,15 @@ module GtmOnRails
   class DataLayer::Ecommerce < DataLayer::Object
     ACTIVITY_TYPES = [:product_impression, :product_click, :product_detail, :add_to_cart, :remove_from_cart, :promotion_impression, :promotion_click, :checkout, :purchase, :refund]
 
-    def initialize(activity_type, **args)
+    def initialize(activity_type, *args)
       raise ArgumentError.new("'#{activity_type}' is undefined activity type.") unless activity_type.in?(ACTIVITY_TYPES)
 
-      @data = send(:"generate_#{activity_type}_hash", args).with_indifferent_access
+      sanitize = true
+      if args.first.keys.count == 1 && args.first.keys.first.to_sym == :sanitize
+        sanitize = args.shift[:sanitize]
+      end
+
+      @data = send(:"generate_#{activity_type}_hash", *[sanitize, args.first]).with_indifferent_access
     end
 
     class << self
@@ -24,214 +29,187 @@ module GtmOnRails
     end
 
     private
-      def generate_product_impression_hash(args)
-        result = {}
 
-        result[:event] = args[:event] if args[:event].present?
+      def generate_product_impression_hash(sanitize, args)
+        result = get_default_data(args)
 
-        result[:ecommerce]                = {}
-        result[:ecommerce][:currencyCode] = args[:currency] || GtmOnRails.config.ecommerce_default_currency
+        result[:event] = args.delete(:event) if args[:event].present?
 
-        if args[:impressions].present?
-          result[:ecommerce][:impressions] = args[:impressions].map{|impression| impression.is_a?(Hash) ? GtmOnRails::DataLayer::Ecommerce::Impression.new(impression) : impression}
-        end
+        result[:ecommerce][:impressions] = get_impression(args) if args[:impressions].present?
+
+        result.merge!(args) unless sanitize
 
         return result
       end
 
-      def generate_product_click_hash(args)
-        result = {}
+      def generate_product_click_hash(sanitize, args)
+        result = get_default_data(args)
 
-        result[:event] = args[:event] || 'productClick'
+        result[:event] = args.delete(:event) || 'productClick'
 
-        result[:event_category] = args[:event_category] || 'Enhanced Ecommerce'
-        result[:event_action]   = args[:event_action]   || 'Product Click'
-        result[:event_label]    = args[:event_label]    || 'Enhanced Ecommerce Product Click'
+        result[:event_category] = args.delete(:event_category) || 'Enhanced Ecommerce'
+        result[:event_action]   = args.delete(:event_action)   || 'Product Click'
+        result[:event_label]    = args.delete(:event_label)    || 'Enhanced Ecommerce Product Click'
 
-        result[:ecommerce]                = {}
-        result[:ecommerce][:currencyCode] = args[:currency] || GtmOnRails.config.ecommerce_default_currency
+        result[:ecommerce][:click]               = {}
+        result[:ecommerce][:click][:actionField] = get_action(args)   if args[:action].present?
+        result[:ecommerce][:click][:products]    = get_products(args) if args[:products].present?
 
-        result[:ecommerce][:click] = {}
-
-        if args[:action].present?
-          action = args[:action].is_a?(Hash) ? GtmOnRails::DataLayer::Ecommerce::Action.new(args[:action]) : args[:action]
-          result[:ecommerce][:click][:actionField] = action
-        end
-
-        if args[:products].present?
-          result[:ecommerce][:click][:products] = args[:products].map{|product| product.is_a?(Hash) ? GtmOnRails::DataLayer::Ecommerce::Product.new(product) : product}
-        end
+        result.merge!(args) unless sanitize
 
         return result
       end
 
-      def generate_product_detail_hash(args)
-        result = {}
-
-        result[:event] = args[:event] if args[:event].present?
+      def generate_product_detail_hash(sanitize, args)
+        result = get_default_data(args)
 
-        result[:ecommerce]                = {}
-        result[:ecommerce][:currencyCode] = args[:currency] || GtmOnRails.config.ecommerce_default_currency
+        result[:event] = args.delete(:event) if args[:event].present?
 
-        result[:ecommerce][:detail] = {}
+        result[:ecommerce][:detail]               = {}
+        result[:ecommerce][:detail][:actionField] = get_action(args)   if args[:action].present?
+        result[:ecommerce][:detail][:products]    = get_products(args) if args[:products].present?
 
-        if args[:action].present?
-          action = args[:action].is_a?(Hash) ? GtmOnRails::DataLayer::Ecommerce::Action.new(args[:action]) : args[:action]
-          result[:ecommerce][:detail][:actionField] = action
-        end
-
-        if args[:products].present?
-          result[:ecommerce][:detail][:products] = args[:products].map{|product| product.is_a?(Hash) ? GtmOnRails::DataLayer::Ecommerce::Product.new(product) : product}
-        end
+        result.merge!(args) unless sanitize
 
         return result
       end
 
-      def generate_add_to_cart_hash(args)
-        result = {}
+      def generate_add_to_cart_hash(sanitize, args)
+        result = get_default_data(args)
 
-        result[:event] = args[:event] || 'addToCart'
+        result[:event] = args.delete(:event) || 'addToCart'
 
-        result[:event_category] = args[:event_category] || 'Enhanced Ecommerce'
-        result[:event_action]   = args[:event_action]   || 'Add to Cart'
-        result[:event_label]    = args[:event_label]    || 'Enhanced Ecommerce Add to Cart'
+        result[:event_category] = args.delete(:event_category) || 'Enhanced Ecommerce'
+        result[:event_action]   = args.delete(:event_action)   || 'Add to Cart'
+        result[:event_label]    = args.delete(:event_label)    || 'Enhanced Ecommerce Add to Cart'
 
-        result[:ecommerce]                = {}
-        result[:ecommerce][:currencyCode] = args[:currency] || GtmOnRails.config.ecommerce_default_currency
+        result[:ecommerce][:add]            = {}
+        result[:ecommerce][:add][:products] = get_products(args) if args[:products].present?
 
-        result[:ecommerce][:add] = {}
-        if args[:products].present?
-          result[:ecommerce][:add][:products] = args[:products].map{|product| product.is_a?(Hash) ? GtmOnRails::DataLayer::Ecommerce::Product.new(product) : product}
-        end
+        result.merge!(args) unless sanitize
 
         return result
       end
 
-      def generate_remove_from_cart_hash(args)
-        result = {}
+      def generate_remove_from_cart_hash(sanitize, args)
+        result = get_default_data(args)
 
-        result[:event] = args[:event] || 'removeFromCart'
+        result[:event] = args.delete(:event) || 'removeFromCart'
 
-        result[:event_category] = args[:event_category] || 'Enhanced Ecommerce'
-        result[:event_action]   = args[:event_action]   || 'Remove from Cart'
-        result[:event_label]    = args[:event_label]    || 'Enhanced Ecommerce Remove from Cart'
+        result[:event_category] = args.delete(:event_category) || 'Enhanced Ecommerce'
+        result[:event_action]   = args.delete(:event_action)   || 'Remove from Cart'
+        result[:event_label]    = args.delete(:event_label)    || 'Enhanced Ecommerce Remove from Cart'
 
-        result[:ecommerce]                = {}
-        result[:ecommerce][:currencyCode] = args[:currency] || GtmOnRails.config.ecommerce_default_currency
+        result[:ecommerce][:remove]            = {}
+        result[:ecommerce][:remove][:products] = get_products(args) if args[:products].present?
 
-        result[:ecommerce][:remove] = {}
-        if args[:products].present?
-          result[:ecommerce][:remove][:products] = args[:products].map{|product| product.is_a?(Hash) ? GtmOnRails::DataLayer::Ecommerce::Product.new(product) : product}
-        end
+        result.merge!(args) unless sanitize
 
         return result
       end
 
-      def generate_promotion_impression_hash(args)
-        result = {}
+      def generate_promotion_impression_hash(sanitize, args)
+        result = get_default_data(args)
 
-        result[:event] = args[:event] if args[:event].present?
+        result[:event] = args.delete(:event) if args[:event].present?
 
-        result[:ecommerce]                = {}
-        result[:ecommerce][:currencyCode] = args[:currency] || GtmOnRails.config.ecommerce_default_currency
+        result[:ecommerce][:promoView]              = {}
+        result[:ecommerce][:promoView][:promotions] = get_promotion(args) if args[:promotions].present?
 
-        result[:ecommerce][:promoView] = {}
-
-        if args[:promotions].present?
-          result[:ecommerce][:promoView][:promotions] = args[:promotions].map{|promotion| promotion.is_a?(Hash) ? GtmOnRails::DataLayer::Ecommerce::Promotion.new(promotion) : promotion}
-        end
+        result.merge!(args) unless sanitize
 
         return result
       end
 
-      def generate_promotion_click_hash(args)
-        result = {}
+      def generate_promotion_click_hash(sanitize, args)
+        result = get_default_data(args)
 
-        result[:event] = args[:event] || 'promotionClick'
+        result[:event] = args.delete(:event) || 'promotionClick'
 
-        result[:event_category] = args[:event_category] || 'Enhanced Ecommerce'
-        result[:event_action]   = args[:event_action]   || 'Promotion Click'
-        result[:event_label]    = args[:event_label]    || 'Enhanced Ecommerce Promotion Click'
+        result[:event_category] = args.delete(:event_category) || 'Enhanced Ecommerce'
+        result[:event_action]   = args.delete(:event_action)   || 'Promotion Click'
+        result[:event_label]    = args.delete(:event_label)    || 'Enhanced Ecommerce Promotion Click'
 
-        result[:ecommerce]                = {}
-        result[:ecommerce][:currencyCode] = args[:currency] || GtmOnRails.config.ecommerce_default_currency
+        result[:ecommerce][:promoClick]              = {}
+        result[:ecommerce][:promoClick][:promotions] = get_promotion(args) if args[:promotions].present?
 
-        result[:ecommerce][:promoClick] = {}
-
-        if args[:promotions].present?
-          result[:ecommerce][:promoClick][:promotions] = args[:promotions].map{|promotion| promotion.is_a?(Hash) ? GtmOnRails::DataLayer::Ecommerce::Promotion.new(promotion) : promotion}
-        end
+        result.merge!(args) unless sanitize
 
         return result
       end
 
-      def generate_checkout_hash(args)
-        result = {}
+      def generate_checkout_hash(sanitize, args)
+        result = get_default_data(args)
 
-        result[:event] = args[:event] || 'checkout'
+        result[:event] = args.delete(:event) || 'checkout'
 
-        result[:event_category] = args[:event_category] || 'Enhanced Ecommerce'
-        result[:event_action]   = args[:event_action]   || 'Checkout'
-        result[:event_label]    = args[:event_label]    || 'Enhanced Ecommerce Checkout'
+        result[:event_category] = args.delete(:event_category) || 'Enhanced Ecommerce'
+        result[:event_action]   = args.delete(:event_action)   || 'Checkout'
+        result[:event_label]    = args.delete(:event_label)    || 'Enhanced Ecommerce Checkout'
 
-        result[:ecommerce]                = {}
-        result[:ecommerce][:currencyCode] = args[:currency] || GtmOnRails.config.ecommerce_default_currency
+        result[:ecommerce][:checkout]               = {}
+        result[:ecommerce][:checkout][:actionField] = get_action(args)   if args[:action].present?
+        result[:ecommerce][:checkout][:products]    = get_products(args) if args[:products].present?
 
-        result[:ecommerce][:checkout] = {}
+        result.merge!(args) unless sanitize
 
-        if args[:action].present?
-          action = args[:action].is_a?(Hash) ? GtmOnRails::DataLayer::Ecommerce::Action.new(args[:action]) : args[:action]
-          result[:ecommerce][:checkout][:actionField] = action
-        end
+        return result
+      end
 
-        if args[:products].present?
-          result[:ecommerce][:checkout][:products] = args[:products].map{|product| product.is_a?(Hash) ? GtmOnRails::DataLayer::Ecommerce::Product.new(product) : product}
-        end
+      def generate_purchase_hash(sanitize, args)
+        result = get_default_data(args)
+
+        result[:event] = args.delete(:event) if args[:event].present?
+
+        result[:ecommerce][:purchase]               = {}
+        result[:ecommerce][:purchase][:actionField] = get_action(args)   if args[:action].present?
+        result[:ecommerce][:purchase][:products]    = get_products(args) if args[:products].present?
+
+        result.merge!(args) unless sanitize
 
         return result
       end
 
-      def generate_purchase_hash(args)
-        result = {}
+      def generate_refund_hash(sanitize, args)
+        result = get_default_data(args)
 
-        result[:event] = args[:event] if args[:event].present?
+        result[:event] = args.delete(:event) if args[:event].present?
 
-        result[:ecommerce]                = {}
-        result[:ecommerce][:currencyCode] = args[:currency] || GtmOnRails.config.ecommerce_default_currency
+        result[:ecommerce][:refund]               = {}
+        result[:ecommerce][:refund][:actionField] = get_action(args)   if args[:action].present?
+        result[:ecommerce][:refund][:products]    = get_products(args) if args[:products].present?
 
-        result[:ecommerce][:purchase] = {}
-
-        action = args[:action] || {}
-        action = action.is_a?(Hash) ? GtmOnRails::DataLayer::Ecommerce::Action.new(action) : action
-        result[:ecommerce][:purchase][:actionField] = action
-        
-        if args[:products].present?
-          result[:ecommerce][:purchase][:products] = args[:products].map{|product| product.is_a?(Hash) ? GtmOnRails::DataLayer::Ecommerce::Product.new(product) : product}
-        end
+        result.merge!(args) unless sanitize
 
         return result
       end
 
-      def generate_refund_hash(args)
-        result = {}
 
-        result[:event] = args[:event] if args[:event].present?
+      def get_default_data(args)
+        hash = {}
+        hash[:ecommerce]                = {}
+        hash[:ecommerce][:currencyCode] = get_currency(args)
+        hash
+      end
 
-        result[:ecommerce]                = {}
-        result[:ecommerce][:currencyCode] = args[:currency] || GtmOnRails.config.ecommerce_default_currency
+      def get_currency(args)
+        args.delete(:currency) || GtmOnRails.config.ecommerce_default_currency
+      end
 
-        result[:ecommerce][:refund] = {}
+      def get_impression(args)
+        args.delete(:impressions).map{|impression| impression.is_a?(Hash) ? GtmOnRails::DataLayer::Ecommerce::Impression.new(impression) : impression}
+      end
 
-        if args[:action].present?
-          action = args[:action].is_a?(Hash) ? GtmOnRails::DataLayer::Ecommerce::Action.new(args[:action]) : args[:action]
-          result[:ecommerce][:refund][:actionField] = action
-        end
-        
-        if args[:products].present?
-          result[:ecommerce][:refund][:products] = args[:products].map{|product| product.is_a?(Hash) ? GtmOnRails::DataLayer::Ecommerce::Product.new(product) : product}
-        end
+      def get_promotion(args)
+        args.delete(:promotions).map{|promotion| promotion.is_a?(Hash) ? GtmOnRails::DataLayer::Ecommerce::Promotion.new(promotion) : promotion}
+      end
 
-        return result
+      def get_products(args)
+        args.delete(:products).map{|product| product.is_a?(Hash) ? GtmOnRails::DataLayer::Ecommerce::Product.new(product) : product}
+      end
+
+      def get_action(args)
+        args[:action].is_a?(Hash) ? GtmOnRails::DataLayer::Ecommerce::Action.new(args.delete(:action)) : args.delete(:action)
       end
   end
 end

data/lib/gtm_on_rails/version.rb

@@ -1,3 +1,3 @@
 module GtmOnRails
-  VERSION = '0.1.12'
+  VERSION = '0.1.13'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gtm_on_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.12
+  version: 0.1.13
 platform: ruby
 authors:
 - ykogure
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-25 00:00:00.000000000 Z
+date: 2018-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails