staccato 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 77a4bb9be23d9d9cefe9806374d07466fe8720bb
-  data.tar.gz: 5a8c255a6a421a29bbe66552db15e16e4d2c2400
+  metadata.gz: 1de9ca3518d24e4139fc2311de9ff15aa79d18a2
+  data.tar.gz: bccdd80d9c617e2303ce2290ceddcd06828d888d
 SHA512:
-  metadata.gz: ca6efa1c2142f14c64ee0860bb9687d8b0fa4a8f4eb39ef3d068b031bc99ce90de0ee408c8365c355b6f8d9e6e1adcd0085e79f34a7445eb0694b55a1d4f6bdb
-  data.tar.gz: 4a492e972ea4776380c7ed2f041323bdffacca2c02feefab612ab96952e148a18038640c9ae2fbfbbcae3916a81851973c52a25980cbccdaf28bec90c9aa8c88
+  metadata.gz: fde81fda9b06a81f5c45cea7ed60cfe51fd4942ff7f104227817e2424666654976ab6ad935efb27a114e5d2b6ae1840bc5cdde33bd451770a1e92cd15a5eba70
+  data.tar.gz: 58e26c6147b312c0a8ed846d39b36edd416d6a8a7f20c60f6a5eb048c8a8417fe21a387924145da2e9e5560e088920444838edefb005c2209ceb4e669e59e9ef

data/.ruby-version

@@ -1 +1 @@
-1.9.3
+2.2.2

data/.travis.yml

@@ -1,8 +1,7 @@
 language: ruby
 rvm:
-  - 1.9.2
   - 1.9.3
   - 2.0.0
-  - 2.1.0
-  - 2.2.0
+  - 2.1.6
+  - 2.2.2
 script: bundle exec rake

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## Staccato 0.3.1 ##
+
+*   Add customer dimensions and metrics to Product and ProductImpression measurements
+
+    *Agustin Cavilliotti <@cavi21>*
+
 ## Staccato 0.3.0 ##
 
 *   HTTP Adapters for HTTP, net/http, and Faraday

data/README.md

@@ -431,7 +431,7 @@ You can also make your own Adapters by implementing any class that responds to `
 One such example might be for a new `net/http` adapter which accepts more options for configuring the connection:
 
 ```ruby
-class CustomerAdapter
+class CustomAdapter
   attr_reader :uri
 
   def initialize(uri, options={})

data/lib/staccato/hit.rb

@@ -135,11 +135,15 @@ module Staccato
     end
 
     # Add a measurement by its symbol name with options
-    # 
+    #
     # @param key [Symbol] any one of the measurable classes lookup key
-    # @param options [Hash] options for the measurement
+    # @param options [Hash or Object] for the measurement
     def add_measurement(key, options = {})
-      self.measurements << Measurement.lookup(key).new(options)
+      if options.is_a?(Hash)
+        self.measurements << Measurement.lookup(key).new(options)
+      else
+        self.measurements << options
+      end
     end
 
     # Measurements for this hit

data/lib/staccato/measurable.rb

@@ -28,9 +28,53 @@ module Staccato
       ''
     end
 
+    # not all measurements allow custom dimensions or metrics
+    def custom_fields_allowed?
+      false
+    end
+
     # collects the parameters from options for this measurement
     # @return [Hash]
     def params
+      {}.
+      merge!(measurable_params).
+      merge!(custom_dimensions).
+      merge!(custom_metrics).
+      reject {|_,v| v.nil?}
+    end
+
+    # Set a custom dimension value at an index
+    # @param dimension_index [Integer]
+    # @param value
+    def add_custom_dimension(dimension_index, value)
+      return unless custom_fields_allowed?
+      self.custom_dimensions["#{prefix}cd#{dimension_index}"] = value
+    end
+
+    # Custom dimensions for this measurable
+    # @return [Hash]
+    def custom_dimensions
+      @custom_dimensions ||= {}
+    end
+
+    # Set a custom metric value at an index
+    # @param metric_index [Integer]
+    # @param value
+    def add_custom_metric(metric_index, value)
+      return unless custom_fields_allowed?
+      self.custom_metrics["#{prefix}cm#{metric_index}"] = value
+    end
+
+    # Custom metrics for this measurable
+    # @return [Hash]
+    def custom_metrics
+      @custom_metrics ||= {}
+    end
+
+    private
+
+    # @private
+    def measurable_params
       Hash[
         fields.map { |field,key|
           next if key.nil?

data/lib/staccato/measurement/product.rb

@@ -14,6 +14,11 @@ module Staccato
         'pr'+index.to_s
       end
 
+      # product allow custom dimensions and metrics
+      def custom_fields_allowed?
+        true
+      end
+
       # Product measurement options fields
       FIELDS = {
         index: nil,

data/lib/staccato/measurement/product_impression.rb

@@ -14,6 +14,11 @@ module Staccato
         'il' + list_index.to_s + 'pi' + index.to_s
       end
 
+      # product impression allow custom dimensions and metrics
+      def custom_fields_allowed?
+        true
+      end
+
       # Product impression measurement options fields
       FIELDS = {
         index: nil,

data/lib/staccato/version.rb

@@ -1,4 +1,4 @@
 module Staccato
   # The current Staccato VERSION
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/spec/integration/measurement/checkout_option_spec.rb

@@ -18,18 +18,18 @@ describe Staccato::Measurement::CheckoutOption do
       })
     }
 
-    let(:measurment_options) {{
+    let(:measurement_options) {{
       step: 1,
       step_options: 'Visa'
     }}
 
     before(:each) do
-      pageview.add_measurement(:checkout_option, measurment_options)
+      pageview.add_measurement(:checkout_option, measurement_options)
 
       pageview.track!
     end
 
-    it 'tracks the measurment' do
+    it 'tracks the measurement' do
       expect(Net::HTTP).to have_received(:post_form).with(uri, {
         'v' => 1,
         'tid' => 'UA-XXXX-Y',

data/spec/integration/measurement/checkout_spec.rb

@@ -18,18 +18,18 @@ describe Staccato::Measurement::Checkout do
       })
     }
 
-    let(:measurment_options) {{
+    let(:measurement_options) {{
       step: 1,
       step_options: 'Visa'
     }}
 
     before(:each) do
-      pageview.add_measurement(:checkout, measurment_options)
+      pageview.add_measurement(:checkout, measurement_options)
 
       pageview.track!
     end
 
-    it 'tracks the measurment' do
+    it 'tracks the measurement' do
       expect(Net::HTTP).to have_received(:post_form).with(uri, {
         'v' => 1,
         'tid' => 'UA-XXXX-Y',

data/spec/integration/measurement/product_impression_spec.rb

@@ -5,40 +5,48 @@ describe Staccato::Measurement::ProductImpression do
   let(:tracker) {Staccato.tracker('UA-XXXX-Y')}
   let(:response) {stub(:body => '', :status => 201)}
 
+  let(:pageview) {
+    tracker.build_pageview({
+      path: '/home',
+      hostname: 'mystore.com',
+      title: 'Home Page'
+    })
+  }
+
+  let(:impression_list_options) {{
+    index: 1,
+    name: 'Search Results'
+  }}
+
+  let(:product_impression_options) {{
+    index: 1,
+    list_index: 1, # match the impression_list above
+    id: 'P12345',
+    name: 'T-Shirt',
+    category: 'Apparel',
+    brand: 'Your Brand',
+    variant: 'Purple',
+    position: 1,
+    price: 14.60
+  }}
+
+  let(:product_impression) { Staccato::Measurement::ProductImpression.new(product_impression_options) }
+
   before(:each) do
     SecureRandom.stubs(:uuid).returns('555')
     Net::HTTP.stubs(:post_form).returns(response)
   end
 
-  context 'a pageview with a transaction' do
-    let(:pageview) {
-      tracker.build_pageview({
-        path: '/home',
-        hostname: 'mystore.com',
-        title: 'Home Page'
-      })
-    }
-
-    let(:measurment_options) {{
-      index: 1,
-      list_index: 1, # match the impression_list above
-      id: 'P12345',
-      name: 'T-Shirt',
-      category: 'Apparel',
-      brand: 'Your Brand',
-      variant: 'Purple',
-      position: 1,
-      price: 14.60
-    }}
+  context 'a pageview with an List Impression' do
 
     before(:each) do
-      pageview.add_measurement(:impression_list, index: 1, name: 'Search Results')
-      pageview.add_measurement(:product_impression, measurment_options)
+      pageview.add_measurement(:impression_list, impression_list_options)
+      pageview.add_measurement(:product_impression, product_impression_options)
 
       pageview.track!
     end
 
-    it 'tracks the measurment' do
+    it 'tracks the measurement' do
       expect(Net::HTTP).to have_received(:post_form).with(uri, {
         'v' => 1,
         'tid' => 'UA-XXXX-Y',
@@ -58,4 +66,73 @@ describe Staccato::Measurement::ProductImpression do
       })
     end
   end
+
+  context 'with some custom dimensions' do
+
+    before(:each) do
+      pageview.add_measurement(:impression_list, impression_list_options)
+      product_impression.add_custom_dimension(1, 'Apple')
+      product_impression.add_custom_dimension(5, 'Samsung')
+      pageview.add_measurement(:product_impression, product_impression)
+
+      pageview.track!
+    end
+
+    it 'has custom dimensions data' do
+      expect(Net::HTTP).to have_received(:post_form).with(uri, {
+        'v' => 1,
+        'tid' => 'UA-XXXX-Y',
+        'cid' => '555',
+        't' => 'pageview',
+        'dh' => 'mystore.com',
+        'dp' => '/home',
+        'dt' => 'Home Page',
+        'il1nm' => 'Search Results',
+        'il1pi1id' => 'P12345',
+        'il1pi1nm' => 'T-Shirt',
+        'il1pi1br' => 'Your Brand',
+        'il1pi1ca' => 'Apparel',
+        'il1pi1va' => 'Purple',
+        'il1pi1pr' => 14.60,
+        'il1pi1ps' => 1,
+        'il1pi1cd1' => 'Apple',
+        'il1pi1cd5' => 'Samsung'
+      })
+    end
+  end
+
+  context 'with some custom metrics' do
+
+    before(:each) do
+      pageview.add_measurement(:impression_list, impression_list_options)
+      product_impression.add_custom_metric(1, 43.20)
+      product_impression.add_custom_metric(3, 8)
+      pageview.add_measurement(:product_impression, product_impression)
+
+      pageview.track!
+    end
+
+    it 'has custom metric data' do
+      expect(Net::HTTP).to have_received(:post_form).with(uri, {
+        'v' => 1,
+        'tid' => 'UA-XXXX-Y',
+        'cid' => '555',
+        't' => 'pageview',
+        'dh' => 'mystore.com',
+        'dp' => '/home',
+        'dt' => 'Home Page',
+        'il1nm' => 'Search Results',
+        'il1pi1id' => 'P12345',
+        'il1pi1nm' => 'T-Shirt',
+        'il1pi1br' => 'Your Brand',
+        'il1pi1ca' => 'Apparel',
+        'il1pi1va' => 'Purple',
+        'il1pi1pr' => 14.60,
+        'il1pi1ps' => 1,
+        'il1pi1cm1' => 43.20,
+        'il1pi1cm3' => 8
+      })
+    end
+  end
+
 end

data/spec/integration/measurement/product_spec.rb

@@ -5,42 +5,113 @@ describe Staccato::Measurement::Product do
   let(:tracker) {Staccato.tracker('UA-XXXX-Y')}
   let(:response) {stub(:body => '', :status => 201)}
 
+  let(:event) {
+    tracker.build_event({
+      category: 'search',
+      action: 'click',
+      label: 'results',
+      product_action: 'click',
+      product_action_list: 'Search Results'
+    })
+  }
+
+  let(:product_options) {{
+    index: 1,
+    id: 'P12345',
+    name: 'T-Shirt',
+    category: 'Apparel',
+    brand: 'Your Brand',
+    variant: 'Purple',
+    quantity: 2,
+    position: 1,
+    price: 14.60,
+    coupon_code: 'ILUVTEES'
+  }}
+
+  let(:product) { Staccato::Measurement::Product.new(product_options) }
+
   before(:each) do
     SecureRandom.stubs(:uuid).returns('555')
     Net::HTTP.stubs(:post_form).returns(response)
   end
 
-  context 'a pageview with a transaction' do
-    let(:event) {
-      tracker.build_event({
-        category: 'search',
-        action: 'click',
-        label: 'results',
-        product_action: 'click',
-        product_action_list: 'Search Results'
+  context 'a pageview with an event' do
+
+    before do
+      event.add_measurement(:product, product_options)
+      event.track!
+    end
+
+    it 'tracks the measurement' do
+      expect(Net::HTTP).to have_received(:post_form).with(uri, {
+        'v' => 1,
+        'tid' => 'UA-XXXX-Y',
+        'cid' => '555',
+        't' => 'event',
+        'ec' => 'search',
+        'ea' => 'click',
+        'el' => 'results',
+        'pa' => 'click',
+        'pal' => 'Search Results',
+        'pr1id' => 'P12345',
+        'pr1nm' => 'T-Shirt',
+        'pr1ca' => 'Apparel',
+        'pr1br' => 'Your Brand',
+        'pr1va' => 'Purple',
+        'pr1qt' => 2,
+        'pr1ps' => 1,
+        'pr1pr' => 14.60,
+        'pr1cc' => 'ILUVTEES'
       })
-    }
+    end
 
-    let(:measurment_options) {{
-      index: 1,
-      id: 'P12345',
-      name: 'T-Shirt',
-      category: 'Apparel',
-      brand: 'Your Brand',
-      variant: 'Purple',
-      quantity: 2,
-      position: 1,
-      price: 14.60,
-      coupon_code: 'ILUVTEES'
-    }}
+  end
+
+  context "with some custom dimensions" do
 
     before(:each) do
-      event.add_measurement(:product, measurment_options)
+      product.add_custom_dimension(1, 'Apple')
+      product.add_custom_dimension(5, 'Samsung')
+      event.add_measurement(:product, product)
+      event.track!
+    end
 
+    it 'has custom dimensions' do
+      expect(Net::HTTP).to have_received(:post_form).with(uri, {
+        'v' => 1,
+        'tid' => 'UA-XXXX-Y',
+        'cid' => '555',
+        't' => 'event',
+        'ec' => 'search',
+        'ea' => 'click',
+        'el' => 'results',
+        'pa' => 'click',
+        'pal' => 'Search Results',
+        'pr1id' => 'P12345',
+        'pr1nm' => 'T-Shirt',
+        'pr1ca' => 'Apparel',
+        'pr1br' => 'Your Brand',
+        'pr1va' => 'Purple',
+        'pr1qt' => 2,
+        'pr1ps' => 1,
+        'pr1pr' => 14.60,
+        'pr1cc' => 'ILUVTEES',
+        'pr1cd1' => 'Apple',
+        'pr1cd5' => 'Samsung'
+      })
+    end
+  end
+
+  context "with some custom metrics" do
+
+    before do
+      product.add_custom_metric(1, 78)
+      product.add_custom_metric(3, 30.40)
+      event.add_measurement(:product, product)
       event.track!
     end
 
-    it 'tracks the measurment' do
+    it 'has custom metrics' do
       expect(Net::HTTP).to have_received(:post_form).with(uri, {
         'v' => 1,
         'tid' => 'UA-XXXX-Y',
@@ -59,7 +130,9 @@ describe Staccato::Measurement::Product do
         'pr1qt' => 2,
         'pr1ps' => 1,
         'pr1pr' => 14.60,
-        'pr1cc' => 'ILUVTEES'
+        'pr1cc' => 'ILUVTEES',
+        'pr1cm1' => 78,
+        'pr1cm3' => 30.40
       })
     end
   end

data/spec/integration/measurement/promotion_spec.rb

@@ -18,7 +18,7 @@ describe Staccato::Measurement::Promotion do
       })
     }
 
-    let(:measurment_options) {{
+    let(:measurement_options) {{
       index: 1,
       id: 'PROMO_1234',
       name: 'Summer Sale',
@@ -27,12 +27,12 @@ describe Staccato::Measurement::Promotion do
     }}
 
     before(:each) do
-      pageview.add_measurement(:promotion, measurment_options)
+      pageview.add_measurement(:promotion, measurement_options)
 
       pageview.track!
     end
 
-    it 'tracks the measurment' do
+    it 'tracks the measurement' do
       expect(Net::HTTP).to have_received(:post_form).with(uri, {
         'v' => 1,
         'tid' => 'UA-XXXX-Y',

data/spec/integration/measurement/transaction_spec.rb

@@ -18,7 +18,7 @@ describe Staccato::Measurement::Transaction do
       })
     }
 
-    let(:measurment_options) {{
+    let(:measurement_options) {{
       transaction_id: 'T12345',
       affiliation: 'Your Store',
       revenue: 37.39,
@@ -29,12 +29,12 @@ describe Staccato::Measurement::Transaction do
     }}
 
     before(:each) do
-      pageview.add_measurement(:transaction, measurment_options)
+      pageview.add_measurement(:transaction, measurement_options)
 
       pageview.track!
     end
 
-    it 'tracks the measurment' do
+    it 'tracks the measurement' do
       expect(Net::HTTP).to have_received(:post_form).with(uri, {
         'v' => 1,
         'tid' => 'UA-XXXX-Y',

data/spec/lib/staccato/pageview_spec.rb

@@ -146,7 +146,7 @@ describe Staccato::Pageview do
       pageview.add_custom_metric(1, 11)
     end
 
-    it 'has custom dimensions' do
+    it 'has custom metrics' do
       expect(pageview.params).to eq({
         'v' => 1,
         'tid' => 'UA-XXXX-Y',

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: staccato
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Tony Pitale
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-15 00:00:00.000000000 Z
+date: 2015-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -173,7 +173,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Ruby Google Analytics Measurement
@@ -194,4 +194,3 @@ test_files:
 - spec/lib/staccato/pageview_spec.rb
 - spec/lib/staccato/tracker_spec.rb
 - spec/spec_helper.rb
-has_rdoc: