tpitale/staccato

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 allow custom dimensions and metrics
      def custom_fields_allowed?
        true
      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

      def validate_options
        if @options[:index].nil?
          raise 'Index is required on Product measurements.'
        end
        true
      end
    end
  end
end