staccato 0.0.1 → 0.0.2

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+coverage

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3-p448

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+script: bundle exec rake

data/CHANGELOG.md

@@ -0,0 +1,20 @@
+## Staccato 0.0.2 ##
+
+*   adds timing tracking with block timing
+*   adds ecommerce tracking
+*   adds non-interactive tracking option
+*   automate building a random client id with SecureRandom.uuid
+*   adds no-op tracking for unconfigured and testing environments
+*   adds travis CI
+*   adds coverage metric
+*   adds code climate
+
+    *Tony Pitale*
+
+## Staccato 0.0.1 ##
+
+*   Initial implementation
+*   Track a pageview
+*   Track an event
+
+    *Tony Pitale*

data/README.md

@@ -2,6 +2,9 @@
 
 Ruby Google Analytics Measurement
 
+[![Build Status](https://travis-ci.org/tpitale/staccato.png?branch=master)](https://travis-ci.org/tpitale/staccato)
+[![Code Climate](https://codeclimate.com/github/tpitale/staccato.png)](https://codeclimate.com/github/tpitale/staccato)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -16,13 +19,15 @@ Or install it yourself as:
 
     $ gem install staccato
 
-## Usage
+## Usage ##
 
     tracker = Staccato.tracker('UA-XXXX-Y') # REQUIRED, your Google Analytics Tracking ID
 
 `#tracker` optionally takes a second param for the `client_id` value
 By default, the `client_id` is set to a random UUID with `SecureRandom.uuid`
 
+### Track some data ###
+
     # Track a Pageview (all values optional)
     tracker.pageview(path: '/page-path', hostname: 'mysite.com', title: 'A Page!')
 
@@ -35,6 +40,44 @@ By default, the `client_id` is set to a random UUID with `SecureRandom.uuid`
     # Track exceptions (all values optional)
     tracker.exception(description: 'RuntimeException', fatal: true)
 
+    # Track timing (all values optional, but should include time)
+    tracker.timing(category: 'runtime', variable: 'db', label: 'query', time: 50) # time in milliseconds
+
+    tracker.timing(category: 'runtime', variable: 'db', label: 'query') do
+      some_code_here
+    end
+
+    # Track transaction (transaction_id REQUIRED)
+    tracker.transaction({
+      transaction_id: 12345,
+      affiliation: 'clothing',
+      revenue: 17.98,
+      shipping: 2.00,
+      tax: 2.50,
+      currency: 'EUR'
+    })
+
+    # Track transaction item (matching transaction_id and item name REQUIRED)
+    tracker.transaction_item({
+      transaction_id: 12345,
+      name: 'Shirt',
+      price: 8.99,
+      quantity: 2,
+      code: 'afhcka1230',
+      variation: 'red',
+      currency: 'EUR'
+    })
+
+### "Global" Options ###
+
+    # Track a Non-Interactive Event
+    tracker.event(category: 'video', action: 'play', non_interactive: true)
+
+Non-Interactive events are useful for tracking things like emails sent, or other
+events that are not directly the result of a user's interaction.
+
+The option `non_interactive` is accepted for all methods on `tracker`.
+
 ## Google Documentation
 
 https://developers.google.com/analytics/devguides/collection/protocol/v1/devguide

data/lib/staccato.rb

@@ -7,17 +7,29 @@ require "staccato/version"
 
 module Staccato
   def self.tracker(id, client_id = nil)
-    Staccato::Tracker.new(id, client_id)
+    if id.nil?
+      Staccato::NoopTracker.new
+    else
+      Staccato::Tracker.new(id, client_id)
+    end
+  end
+
+  def self.build_client_id
+    SecureRandom.uuid
   end
 
   def self.tracking_uri
-    URI('http://www.')
+    URI('http://www.google-analytics.com/collect')
   end
 end
 
+require 'staccato/option_set'
 require 'staccato/hit'
 require 'staccato/pageview'
 require 'staccato/event'
 require 'staccato/social'
 require 'staccato/exception'
+require 'staccato/timing'
+require 'staccato/transaction'
+require 'staccato/transaction_item'
 require 'staccato/tracker'

data/lib/staccato/hit.rb

@@ -12,7 +12,7 @@ module Staccato
 
     def initialize(tracker, options = {})
       self.tracker = tracker
-      self.options = OpenStruct.new(options)
+      self.options = OptionSet.new(options)
     end
 
     def fields
@@ -24,12 +24,17 @@ module Staccato
         'v' => 1,
         'tid' => tracker.id,
         'cid' => tracker.client_id,
+        'ni' => non_interactive,
         't' => type.to_s
       }.merge(Hash[
         fields.map {|field,key| [key, options[field]]}
       ]).reject {|_,v| v.nil?}
     end
 
+    def non_interactive
+      1 if options[:non_interactive] # defaults to nil
+    end
+
     def track!
       post(Staccato.tracking_uri, params)
     end

data/lib/staccato/option_set.rb

@@ -0,0 +1,9 @@
+module Staccato
+  class OptionSet < OpenStruct
+    unless OpenStruct.instance_methods.include?(:[])
+      extend Forwardable
+
+      def_delegators :@table, :[], :[]=
+    end
+  end
+end

data/lib/staccato/timing.rb

@@ -0,0 +1,28 @@
+module Staccato
+  class Timing
+    FIELDS = {
+      category: 'utc',
+      variable: 'utv',
+      label: 'utl',
+      time: 'utt'
+    }
+
+    include Hit
+
+    def type
+      :timing
+    end
+
+    def track!(&block)
+      if block_given?
+        start_at = Time.now
+        block.call
+        end_at = Time.now
+
+        self.options.time = (end_at - start_at).to_i*1000
+      end
+
+      super
+    end
+  end
+end

data/lib/staccato/tracker.rb

@@ -10,7 +10,7 @@ module Staccato
     end
 
     def client_id
-      @client_id ||= SecureRandom.uuid
+      @client_id ||= Staccato.build_client_id
     end
 
     def pageview(options = {})
@@ -28,5 +28,37 @@ module Staccato
     def exception(options = {})
       Staccato::Exception.new(self, options).track!
     end
+
+    def timing(options = {}, &block)
+      Staccato::Timing.new(self, options).track!(&block)
+    end
+
+    def transaction(options = {})
+      Staccato::Transaction.new(self, options).track!
+    end
+
+    def transaction_item(options = {})
+      Staccato::TransactionItem.new(self, options).track!
+    end
+  end
+
+  class NoopTracker
+    def initialize(*); end
+
+    def id
+      nil
+    end
+
+    def client_id
+      nil
+    end
+
+    def pageview(*); end
+    def event(*); end
+    def social(*); end
+    def exception(*); end
+    def timing(*)
+      yield if block_given?
+    end
   end
 end

data/lib/staccato/transaction.rb

@@ -0,0 +1,18 @@
+module Staccato
+  class Transaction
+    FIELDS = {
+      transaction_id: 'ti',
+      affiliation: 'ta',
+      revenue: 'tr',
+      shipping: 'ts',
+      tax: 'tt',
+      currency: 'cu'
+    }
+
+    include Hit
+
+    def type
+      :transaction
+    end
+  end
+end

data/lib/staccato/transaction_item.rb

@@ -0,0 +1,19 @@
+module Staccato
+  class TransactionItem
+    FIELDS = {
+      transaction_id: 'ti',
+      name: 'in',
+      price: 'ip',
+      quantity: 'iq',
+      code: 'ic',
+      variation: 'iv',
+      currency: 'cu'
+    }
+
+    include Hit
+
+    def type
+      :item
+    end
+  end
+end

data/lib/staccato/version.rb

@@ -1,3 +1,3 @@
 module Staccato
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/integration/noop_tracker_spec.rb

@@ -0,0 +1,102 @@
+require 'spec_helper'
+
+describe Staccato::NoopTracker do
+  let(:uri) {Staccato.tracking_uri}
+  let(:tracker) {Staccato.tracker(nil)}
+  let(:response) {stub(:body => '', :status => 201)}
+
+  before(:each) do
+    SecureRandom.stubs(:uuid).returns('555')
+    Net::HTTP.stubs(:post_form).returns(response)
+  end
+
+  describe "#pageview" do
+    before(:each) do
+      tracker.pageview(path: '/foobar', title: 'FooBar', hostname: 'mysite.com')
+    end
+
+    it 'does not track page path and page title' do
+      Net::HTTP.should have_received(:post_form).never
+    end
+  end
+
+  describe "#event" do
+    before(:each) do
+      tracker.event({
+        category: 'video',
+        action: 'play',
+        label: 'cars',
+        value: 1
+      })
+    end
+
+    it 'does not track event category, action, label, value' do
+      Net::HTTP.should have_received(:post_form).never
+    end
+  end
+
+  describe "#social" do
+    before(:each) do
+      tracker.social({
+        action: 'like',
+        network: 'facebook',
+        target: '/blog'
+      })
+    end
+
+    it 'does not track social action, network, target' do
+      Net::HTTP.should have_received(:post_form).never
+    end
+  end
+
+  describe "#exception" do
+    before(:each) do
+      tracker.exception({
+        description: 'RuntimeException',
+        fatal: true
+      })
+    end
+
+    it 'does not track exception description and fatality' do
+      Net::HTTP.should have_received(:post_form).never
+    end
+  end
+
+  describe "#timing" do
+    before(:each) do
+      tracker.timing({
+        category: 'view',
+        variable: 'runtime',
+        label: 'rails',
+        time: 1000
+      })
+    end
+
+    it 'does not track user timing category, variable, label, and time' do
+      Net::HTTP.should have_received(:post_form).never
+    end
+  end
+
+  describe "#timing with block" do
+    let(:codez) {stub(:test => true)}
+
+    before(:each) do
+      start_at = Time.now
+      end_at = start_at + 1 # 1 second
+
+      Time.stubs(:now).returns(start_at).returns(end_at)
+
+      tracker.timing({ category: 'view', variable: 'runtime', label: 'rails' }) do
+        codez.test
+      end
+    end
+
+    it 'does not track user timing category, variable, label, and time' do
+      Net::HTTP.should have_received(:post_form).never
+    end
+
+    it 'yields to the block' do
+      codez.should have_received(:test)
+    end
+  end
+end

data/spec/integration/tracker_spec.rb

@@ -78,19 +78,141 @@ describe Staccato::Tracker do
     before(:each) do
       tracker.exception({
         description: 'RuntimeException',
-        fatal: true
+        fatal: true,
+        non_interactive: true
       })
     end
 
-    it 'tracks social action, network, target' do
+    it 'tracks exception description and fatality' do
       Net::HTTP.should have_received(:post_form).with(uri, {
         'v' => 1,
         'tid' => 'UA-XXXX-Y',
         'cid' => '555',
+        'ni' => 1,
         't' => 'exception',
         'exd' => 'RuntimeException',
         'exf' => 1
       })
     end
   end
+
+  describe "#timing" do
+    before(:each) do
+      tracker.timing({
+        category: 'view',
+        variable: 'runtime',
+        label: 'rails',
+        time: 1000
+      })
+    end
+
+    it 'tracks user timing category, variable, label, and time' do
+      Net::HTTP.should have_received(:post_form).with(uri, {
+        'v' => 1,
+        'tid' => 'UA-XXXX-Y',
+        'cid' => '555',
+        't' => 'timing',
+        'utc' => 'view',
+        'utv' => 'runtime',
+        'utl' => 'rails',
+        'utt' => 1000 # value in milliseconds
+      })
+    end
+  end
+
+  describe "#timing with block" do
+    let(:codez) {stub(:test => true)}
+
+    before(:each) do
+      start_at = Time.now
+      end_at = start_at + 1 # 1 second
+
+      Time.stubs(:now).returns(start_at).returns(end_at)
+
+      tracker.timing({ category: 'view', variable: 'runtime', label: 'rails' }) do
+        codez.test
+      end
+    end
+
+    it 'tracks user timing category, variable, label, and time' do
+      Net::HTTP.should have_received(:post_form).with(uri, {
+        'v' => 1,
+        'tid' => 'UA-XXXX-Y',
+        'cid' => '555',
+        't' => 'timing',
+        'utc' => 'view',
+        'utv' => 'runtime',
+        'utl' => 'rails',
+        'utt' => 1000
+      })
+    end
+
+    it 'yields to the block' do
+      codez.should have_received(:test)
+    end
+  end
+
+  describe "Transactions" do
+    describe "#transaction" do
+      let(:transaction_id) {1293281}
+
+      before(:each) do
+        tracker.transaction({
+          transaction_id: transaction_id,
+          affiliation: 'western',
+          revenue: 5.99,
+          shipping: 12.00,
+          tax: 1.40,
+          currency: 'USD'
+        })
+      end
+
+      it 'tracks the transaction values' do
+        Net::HTTP.should have_received(:post_form).with(uri, {
+          'v' => 1,
+          'tid' => 'UA-XXXX-Y',
+          'cid' => '555',
+          't' => 'transaction',
+          'ti' => transaction_id,
+          'ta' => 'western',
+          'tr' => 5.99,
+          'ts' => 12.0,
+          'tt' => 1.4,
+          'cu' => 'USD'
+        })
+      end
+    end
+
+    describe "#transaction_item" do
+      let(:transaction_id) {1293281}
+
+      before(:each) do
+        tracker.transaction_item({
+          transaction_id: transaction_id,
+          name: 'Sofa',
+          price: 804.99,
+          quantity: 2,
+          code: 'afhcka1230',
+          variation: 'furniture',
+          currency: 'USD'
+        })
+      end
+
+      it 'tracks the item values' do
+        Net::HTTP.should have_received(:post_form).with(uri, {
+          'v' => 1,
+          'tid' => 'UA-XXXX-Y',
+          'cid' => '555',
+          't' => 'item',
+          'ti' => transaction_id,
+          'in' => 'Sofa',
+          'ip' => 804.99,
+          'iq' => 2,
+          'ic' => 'afhcka1230',
+          'iv' => 'furniture',
+          'cu' => 'USD'
+        })
+      end
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,3 +1,6 @@
+require 'simplecov'
+SimpleCov.start
+
 require 'bundler/setup'
 
 require 'rspec'

data/staccato.gemspec

@@ -23,6 +23,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "mocha"
   spec.add_development_dependency "bourne"
-
-  # spec.add_runtime_dependency "uuid"
+  spec.add_development_dependency "simplecov"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: staccato
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-04 00:00:00.000000000 Z
+date: 2014-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -91,6 +91,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ruby Google Analytics Measurement
 email:
 - tpitale@gmail.com
@@ -100,6 +116,8 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .ruby-version
+- .travis.yml
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -109,10 +127,15 @@ files:
 - lib/staccato/event.rb
 - lib/staccato/exception.rb
 - lib/staccato/hit.rb
+- lib/staccato/option_set.rb
 - lib/staccato/pageview.rb
 - lib/staccato/social.rb
+- lib/staccato/timing.rb
 - lib/staccato/tracker.rb
+- lib/staccato/transaction.rb
+- lib/staccato/transaction_item.rb
 - lib/staccato/version.rb
+- spec/integration/noop_tracker_spec.rb
 - spec/integration/tracker_spec.rb
 - spec/lib/stacatto_spec.rb
 - spec/lib/staccato/event_spec.rb
@@ -146,9 +169,11 @@ signing_key:
 specification_version: 3
 summary: Ruby Google Analytics Measurement
 test_files:
+- spec/integration/noop_tracker_spec.rb
 - spec/integration/tracker_spec.rb
 - spec/lib/stacatto_spec.rb
 - spec/lib/staccato/event_spec.rb
 - spec/lib/staccato/pageview_spec.rb
 - spec/lib/staccato/tracker_spec.rb
 - spec/spec_helper.rb
+has_rdoc: