staccato 0.1.1 → 0.2.0

data/lib/staccato/measurable.rb

@@ -0,0 +1,44 @@
+module Staccato
+  # Measurable adds field mapping and param collection
+  #   for Measurement classes to be add to Hit
+  module Measurable
+    def self.included(model)
+      model.extend Forwardable
+
+      model.class_eval do
+        attr_accessor :options
+
+        def_delegators :@options, *model::FIELDS.keys
+      end
+    end
+
+    # @param options [Hash] options for the measurement fields
+    def initialize(options = {})
+      self.options = OptionSet.new(options)
+    end
+
+    # fields from options for this measurement
+    def fields
+      self.class::FIELDS
+    end
+
+    # measurement option prefix
+    # @return [String]
+    def prefix
+      ''
+    end
+
+    # collects the parameters from options for this measurement
+    # @return [Hash]
+    def params
+      Hash[
+        fields.map { |field,key|
+          next if key.nil?
+          key = (prefix+key.to_s)
+
+          [key, options[field]] unless options[field].nil?
+        }.compact
+      ]
+    end
+  end
+end

data/lib/staccato/measurement.rb

@@ -0,0 +1,43 @@
+require 'staccato/measurable'
+require 'staccato/null_measurement'
+
+require 'staccato/measurement/checkout'
+require 'staccato/measurement/checkout_option'
+require 'staccato/measurement/impression_list'
+require 'staccato/measurement/product'
+require 'staccato/measurement/product_impression'
+require 'staccato/measurement/promotion'
+require 'staccato/measurement/transaction'
+
+module Staccato
+  # Classes for measurements to be add to Hits
+  module Measurement
+    # List of measurement classes by lookup key
+    TYPES = Hash[
+      [
+        Checkout,
+        CheckoutOption,
+        ImpressionList,
+        Product,
+        ProductImpression,
+        Promotion,
+        Transaction
+      ].map { |k| [k.lookup_key, k] }
+    ].freeze
+
+    # Lookup a measurement class by its key
+    # @param key [Symbol]
+    # @return [Class] measurement class or NullMeasurement
+    def lookup(key)
+      measurement_types[key] || NullMeasurement
+    end
+    module_function :lookup
+
+    # List of measurement classes by lookup key
+    # @return [Hash]
+    def measurement_types
+      TYPES
+    end
+    module_function :measurement_types
+  end
+end

data/lib/staccato/measurement/checkout.rb

@@ -0,0 +1,20 @@
+module Staccato
+  module Measurement
+    # Measurement class for checkout action steps
+    class Checkout
+      # lookup key for use in Hit#add_measurement
+      # @return [Symbol]
+      def self.lookup_key
+        :checkout
+      end
+
+      # Checkout measurement options fields
+      FIELDS = {
+        step: 'cos', # integer
+        step_options: 'col' # text
+      }.freeze
+
+      include Measurable
+    end
+  end
+end

data/lib/staccato/measurement/checkout_option.rb

@@ -0,0 +1,20 @@
+module Staccato
+  module Measurement
+    # Measurement class for checkout options
+    class CheckoutOption
+      # lookup key for use in Hit#add_measurement
+      # @return [Symbol]
+      def self.lookup_key
+        :checkout_option
+      end
+
+      # Checkout option measurement options fields
+      FIELDS = {
+        step: 'cos', # integer
+        step_options: 'col' # text
+      }.freeze
+
+      include Measurable
+    end
+  end
+end

data/lib/staccato/measurement/impression_list.rb

@@ -0,0 +1,26 @@
+module Staccato
+  module Measurement
+    # Measurement class for impressions in a list for products
+    class ImpressionList
+      # lookup key for use in Hit#add_measurement
+      # @return [Symbol]
+      def self.lookup_key
+        :impression_list
+      end
+
+      # impression list prefix
+      # @return [String]
+      def prefix
+        'il'+index.to_s
+      end
+
+      # Impression list measurement options fields
+      FIELDS = {
+        index: nil,
+        name: 'nm'
+      }.freeze
+
+      include Measurable
+    end
+  end
+end

data/lib/staccato/measurement/product.rb

@@ -0,0 +1,34 @@
+module Staccato
+  module Measurement
+    # Measurement class for products in a transaction or other action
+    class Product
+      # lookup key for use in Hit#add_measurement
+      # @return [Symbol]
+      def self.lookup_key
+        :product
+      end
+
+      # product prefix
+      # @return [String]
+      def prefix
+        'pr'+index.to_s
+      end
+
+      # Product measurement options fields
+      FIELDS = {
+        index: nil,
+        id: 'id', # text
+        name: 'nm', # text
+        brand: 'br', # text
+        category: 'ca', # text
+        variant: 'va', # text
+        price: 'pr', # currency (looks like a double?)
+        quantity: 'qt', # integer
+        coupon_code: 'cc', # text
+        position: 'ps' # integer
+      }.freeze
+
+      include Measurable
+    end
+  end
+end

data/lib/staccato/measurement/product_impression.rb

@@ -0,0 +1,33 @@
+module Staccato
+  module Measurement
+    # Measurement class for product impressions in a list
+    class ProductImpression
+      # lookup key for use in Hit#add_measurement
+      # @return [Symbol]
+      def self.lookup_key
+        :product_impression
+      end
+
+      # product impress prefix
+      # @return [String]
+      def prefix
+        'il' + list_index.to_s + 'pr' + index.to_s
+      end
+
+      # Product impression measurement options fields
+      FIELDS = {
+        index: nil,
+        list_index: nil,
+        id: 'id', # text
+        name: 'nm', # text
+        brand: 'br', # text
+        category: 'ca', # text
+        variant: 'va', # text
+        price: 'pr', # currency (looks like a double?)
+        position: 'ps' # integer
+      }.freeze
+
+      include Measurable
+    end
+  end
+end

data/lib/staccato/measurement/promotion.rb

@@ -0,0 +1,29 @@
+module Staccato
+  module Measurement
+    # Measurement class for promotion impressions/clicks
+    class Promotion
+      # lookup key for use in Hit#add_measurement
+      # @return [Symbol]
+      def self.lookup_key
+        :promotion
+      end
+
+      # promotion prefix
+      # @return [String]
+      def prefix
+        'promo'+index.to_s
+      end
+
+      # Promotion measurement options fields
+      FIELDS = {
+        index: nil,
+        id: 'id', # text
+        name: 'nm', # text
+        creative: 'cr', # text
+        position: 'ps' # text
+      }.freeze
+
+      include Measurable
+    end
+  end
+end

data/lib/staccato/measurement/transaction.rb

@@ -0,0 +1,25 @@
+module Staccato
+  module Measurement
+    # Measurement class for transaction (non-hit data)
+    class Transaction
+      # lookup key for use in Hit#add_measurement
+      # @return [Symbol]
+      def self.lookup_key
+        :transaction
+      end
+
+      # Transaction measurement options fields
+      FIELDS = {
+        transaction_id: 'ti',
+        affiliation: 'ta',
+        revenue: 'tr',
+        shipping: 'ts',
+        tax: 'tt',
+        currency: 'cu',
+        coupon_code: 'tcc'
+      }.freeze
+
+      include Measurable
+    end
+  end
+end

data/lib/staccato/null_measurement.rb

@@ -0,0 +1,12 @@
+# Measurement class for when we need a standin
+class NullMeasurement
+  # Measurement fields for a noop
+  FIELDS = {}.freeze
+
+  # Initialize a noop measurement standin
+  def initialize(*); end
+
+  # Params for this noop measurement
+  # @return [Hash]
+  def params(*); {}; end
+end

data/lib/staccato/tracker.rb

@@ -9,6 +9,7 @@ module Staccato
     # sets up a new tracker
     # @param id [String] the GA tracker id
     # @param client_id [String, nil] unique value to track user sessions
+    # @param hit_defaults [Hash]
     def initialize(id, client_id = nil, hit_defaults = {})
       @id = id
       @client_id = client_id
@@ -28,6 +29,17 @@ module Staccato
       @client_id ||= Staccato.build_client_id
     end
 
+    # Build a pageview
+    # 
+    # @param options [Hash] options include:
+    #   * path (optional) the path of the current page view
+    #   * hostname (optional) the hostname of the current page view
+    #   * title (optional) the page title
+    # @return [Pageview]
+    def build_pageview(options = {})
+      Staccato::Pageview.new(self, options)
+    end
+
     # Track a pageview
     # 
     # @param options [Hash] options include:
@@ -36,7 +48,19 @@ module Staccato
     #   * title (optional) the page title
     # @return [<Net::HTTPOK] the GA `/collect` endpoint always returns a 200
     def pageview(options = {})
-      Staccato::Pageview.new(self, options).track!
+      build_pageview(options).track!
+    end
+
+    # Build an event
+    # 
+    # @param options [Hash] options include:
+    #   * category (optional)
+    #   * action (optional)
+    #   * label (optional)
+    #   * value (optional)
+    # @return [Event]
+    def build_event(options = {})
+      Staccato::Event.new(self, options)
     end
 
     # Track an event
@@ -48,7 +72,7 @@ module Staccato
     #   * value (optional)
     # @return [<Net::HTTPOK] the GA `/collect` endpoint always returns a 200
     def event(options = {})
-      Staccato::Event.new(self, options).track!
+      build_event(options).track!
     end
 
     # Track a social event such as a Facebook Like or Twitter Share
@@ -123,8 +147,10 @@ module Staccato
   #   Useful in testing
   class NoopTracker
     # (see Tracker#initialize)
-    def initialize(*); end
+    def initialize(id = nil, client_id = nil, hit_defaults = {}); end
 
+    # hit defaults for our noop
+    # @return [Hash]
     def hit_defaults
       {}
     end
@@ -139,26 +165,31 @@ module Staccato
       nil
     end
 
+    # (see Tracker#build_pageview)
+    def build_pageview(options = {}); end
     # (see Tracker#pageview)
-    def pageview(*); end
+    def pageview(options = {}); end
+    # (see Tracker#build_event)
+    def build_event(options = {}); end
     # (see Tracker#event)
-    def event(*); end
+    def event(options = {}); end
     # (see Tracker#social)
-    def social(*); end
+    def social(options = {}); end
     # (see Tracker#exception)
-    def exception(*); end
+    def exception(options = {}); end
     # (see Tracker#timing)
-    def timing(*)
+    def timing(options = {}, &block)
       yield if block_given?
     end
     # (see Tracker#transaction)
-    def transaction(*)
+    def transaction(options = {})
     end
     # (see Tracker#transaction_item)
-    def transaction_item(*)
+    def transaction_item(options = {})
     end
 
-    def track(*)
+    # (see Tracker#track)
+    def track(params = {})
     end
   end
 end

data/lib/staccato/version.rb

@@ -1,4 +1,4 @@
 module Staccato
   # The current Staccato VERSION
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/spec/integration/measurement/checkout_option_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe Staccato::Measurement::CheckoutOption do
+  let(:uri) {Staccato.tracking_uri}
+  let(:tracker) {Staccato.tracker('UA-XXXX-Y')}
+  let(:response) {stub(:body => '', :status => 201)}
+
+  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: '/checkout', hostname: 'mystore.com',
+        title: 'Complete Your Checkout', product_action: 'checkout_option'
+      })
+    }
+
+    let(:measurment_options) {{
+      step: 1,
+      step_options: 'Visa'
+    }}
+
+    before(:each) do
+      pageview.add_measurement(:checkout_option, measurment_options)
+
+      pageview.track!
+    end
+
+    it 'tracks the measurment' do
+      Net::HTTP.should have_received(:post_form).with(uri, {
+        'v' => 1,
+        'tid' => 'UA-XXXX-Y',
+        'cid' => '555',
+        't' => 'pageview',
+        'dh' => 'mystore.com',
+        'dp' => '/checkout',
+        'dt' => 'Complete Your Checkout',
+        'pa' => 'checkout_option',
+        'cos' => 1,
+        'col' => 'Visa'
+      })
+    end
+  end
+end