staccato 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format nested

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in staccato.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Tony Pitale
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,50 @@
+# Staccato
+
+Ruby Google Analytics Measurement
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'staccato'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install staccato
+
+## 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 a Pageview (all values optional)
+    tracker.pageview(path: '/page-path', hostname: 'mysite.com', title: 'A Page!')
+
+    # Track an Event (all values optional)
+    tracker.event(category: 'video', action: 'play', label: 'cars', value: 1)
+
+    # Track social activity (all values REQUIRED)
+    tracker.social(action: 'like', network: 'facebook', target: '/something')
+
+    # Track exceptions (all values optional)
+    tracker.exception(description: 'RuntimeException', fatal: true)
+
+## Google Documentation
+
+https://developers.google.com/analytics/devguides/collection/protocol/v1/devguide
+https://developers.google.com/analytics/devguides/collection/protocol/v1/reference
+https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/staccato.rb

@@ -0,0 +1,23 @@
+require 'ostruct'
+require 'net/http'
+require 'forwardable'
+require 'securerandom'
+
+require "staccato/version"
+
+module Staccato
+  def self.tracker(id, client_id = nil)
+    Staccato::Tracker.new(id, client_id)
+  end
+
+  def self.tracking_uri
+    URI('http://www.')
+  end
+end
+
+require 'staccato/hit'
+require 'staccato/pageview'
+require 'staccato/event'
+require 'staccato/social'
+require 'staccato/exception'
+require 'staccato/tracker'

data/lib/staccato/event.rb

@@ -0,0 +1,16 @@
+module Staccato
+  class Event
+    FIELDS = {
+      category: 'ec',
+      action: 'ea',
+      label: 'el',
+      value: 'ev'
+    }
+
+    include Hit
+
+    def type
+      :event
+    end
+  end
+end

data/lib/staccato/exception.rb

@@ -0,0 +1,19 @@
+module Staccato
+  class Exception
+    FIELDS = {
+      description: 'exd',
+      fatal: 'exf'
+    }
+
+    include Hit
+
+    def initialize(*)
+      super
+      options[:fatal] = 1 if options[:fatal]
+    end
+
+    def type
+      :exception
+    end
+  end
+end

data/lib/staccato/hit.rb

@@ -0,0 +1,41 @@
+module Staccato
+  module Hit
+    def self.included(model)
+      model.extend Forwardable
+
+      model.class_eval do
+        attr_accessor :tracker, :options
+
+        def_delegators :@options, *model::FIELDS.keys
+      end
+    end
+
+    def initialize(tracker, options = {})
+      self.tracker = tracker
+      self.options = OpenStruct.new(options)
+    end
+
+    def fields
+      self.class::FIELDS
+    end
+
+    def params
+      {
+        'v' => 1,
+        'tid' => tracker.id,
+        'cid' => tracker.client_id,
+        't' => type.to_s
+      }.merge(Hash[
+        fields.map {|field,key| [key, options[field]]}
+      ]).reject {|_,v| v.nil?}
+    end
+
+    def track!
+      post(Staccato.tracking_uri, params)
+    end
+
+    def post(uri, params = {})
+      Net::HTTP.post_form(uri, params)
+    end
+  end
+end

data/lib/staccato/pageview.rb

@@ -0,0 +1,15 @@
+module Staccato
+  class Pageview
+    FIELDS = {
+      hostname: 'dh',
+      path: 'dp',
+      title: 'dt'
+    }
+
+    include Hit
+
+    def type
+      :pageview
+    end
+  end
+end

data/lib/staccato/social.rb

@@ -0,0 +1,15 @@
+module Staccato
+  class Social
+    FIELDS = {
+      action: 'sa',
+      network: 'sn',
+      target: 'st'
+    }
+
+    include Hit
+
+    def type
+      :social
+    end
+  end
+end

data/lib/staccato/tracker.rb

@@ -0,0 +1,32 @@
+module Staccato
+  class Tracker
+    def initialize(id, client_id = nil)
+      @id = id
+      @client_id = client_id
+    end
+
+    def id
+      @id
+    end
+
+    def client_id
+      @client_id ||= SecureRandom.uuid
+    end
+
+    def pageview(options = {})
+      Staccato::Pageview.new(self, options).track!
+    end
+
+    def event(options = {})
+      Staccato::Event.new(self, options).track!
+    end
+
+    def social(options = {})
+      Staccato::Social.new(self, options).track!
+    end
+
+    def exception(options = {})
+      Staccato::Exception.new(self, options).track!
+    end
+  end
+end

data/lib/staccato/version.rb

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

data/spec/integration/tracker_spec.rb

@@ -0,0 +1,96 @@
+require 'spec_helper'
+
+describe Staccato::Tracker 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
+
+  describe "#pageview" do
+    before(:each) do
+      tracker.pageview(path: '/foobar', title: 'FooBar', hostname: 'mysite.com')
+    end
+
+    it 'tracks page path and page title' do
+      Net::HTTP.should have_received(:post_form).with(uri, {
+        'v' => 1,
+        'tid' => 'UA-XXXX-Y',
+        'cid' => '555',
+        't' => 'pageview',
+        'dh' => 'mysite.com',
+        'dp' => '/foobar',
+        'dt' => 'FooBar'
+      })
+    end
+  end
+
+  describe "#event" do
+    before(:each) do
+      tracker.event({
+        category: 'video',
+        action: 'play',
+        label: 'cars',
+        value: 1
+      })
+    end
+
+    it 'tracks event category, action, label, value' do
+      Net::HTTP.should have_received(:post_form).with(uri, {
+        'v' => 1,
+        'tid' => 'UA-XXXX-Y',
+        'cid' => '555',
+        't' => 'event',
+        'ec' => 'video',
+        'ea' => 'play',
+        'el' => 'cars',
+        'ev' => 1
+      })
+    end
+  end
+
+  describe "#social" do
+    before(:each) do
+      tracker.social({
+        action: 'like',
+        network: 'facebook',
+        target: '/blog'
+      })
+    end
+
+    it 'tracks social action, network, target' do
+      Net::HTTP.should have_received(:post_form).with(uri, {
+        'v' => 1,
+        'tid' => 'UA-XXXX-Y',
+        'cid' => '555',
+        't' => 'social',
+        'sa' => 'like',
+        'sn' => 'facebook',
+        'st' => '/blog'
+      })
+    end
+  end
+
+  describe "#exception" do
+    before(:each) do
+      tracker.exception({
+        description: 'RuntimeException',
+        fatal: true
+      })
+    end
+
+    it 'tracks social action, network, target' do
+      Net::HTTP.should have_received(:post_form).with(uri, {
+        'v' => 1,
+        'tid' => 'UA-XXXX-Y',
+        'cid' => '555',
+        't' => 'exception',
+        'exd' => 'RuntimeException',
+        'exf' => 1
+      })
+    end
+  end
+end

data/spec/lib/stacatto_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Staccato do
+
+  context 'configuring a tracker' do
+
+    let(:tracker) {Staccato.tracker 'UA-XXXX-Y'}
+
+    it 'has an assigned id' do
+      tracker.id.should eq('UA-XXXX-Y')
+    end
+
+    it 'uses a uuid for the client_id' do
+      SecureRandom.stubs(:uuid).returns("a-uuid")
+
+      tracker.client_id.should eq('a-uuid')
+    end
+
+  end
+
+end

data/spec/lib/staccato/event_spec.rb

@@ -0,0 +1,87 @@
+require 'spec_helper'
+
+describe Staccato::Event do
+
+  let(:tracker) {Staccato.tracker('UA-XXXX-Y', '555')}
+
+  context "with all options" do
+    let(:event) do
+      Staccato::Event.new(tracker, {
+        :category => 'video',
+        :action => 'play',
+        :label => 'cars',
+        :value => 12
+      })
+    end
+
+    it 'has a category' do
+      event.category.should eq('video')
+    end
+
+    it 'has a action' do
+      event.action.should eq('play')
+    end
+
+    it 'has a label' do
+      event.label.should eq('cars')
+    end
+
+    it 'has a value' do
+      event.value.should eq(12)
+    end
+
+    it 'has all params' do
+      event.params.should eq({
+        'v' => 1,
+        'tid' => 'UA-XXXX-Y',
+        'cid' => '555',
+        't' => 'event',
+        'ec' => 'video',
+        'ea' => 'play',
+        'el' => 'cars',
+        'ev' => 12
+      })
+    end
+  end
+
+  context "with extra options" do
+    let(:event) do
+      Staccato::Event.new(tracker, {
+        :category => 'video',
+        :action => 'play',
+        :label => 'cars',
+        :value => 12,
+        :hostname => 'mysite.com',
+        :path => '/foobar'
+      })
+    end
+
+    it 'has all params' do
+      event.params.should eq({
+        'v' => 1,
+        'tid' => 'UA-XXXX-Y',
+        'cid' => '555',
+        't' => 'event',
+        'ec' => 'video',
+        'ea' => 'play',
+        'el' => 'cars',
+        'ev' => 12
+      })
+    end
+  end
+
+  context "with no options" do
+    let(:event) do
+      Staccato::Event.new(tracker, {})
+    end
+
+    it 'has require params' do
+      event.params.should eq({
+        'v' => 1,
+        'tid' => 'UA-XXXX-Y',
+        'cid' => '555',
+        't' => 'event'
+      })
+    end
+  end
+end

data/spec/lib/staccato/pageview_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+describe Staccato::Pageview do
+
+  let(:tracker) {Staccato.tracker('UA-XXXX-Y', '555')}
+
+  context "with all options" do
+    let(:pageview) do
+      Staccato::Pageview.new(tracker, {
+        :hostname => 'mysite.com',
+        :path => '/foobar',
+        :title => 'FooBar'
+      })
+    end
+
+    it 'has a hostname' do
+      pageview.hostname.should eq('mysite.com')
+    end
+
+    it 'has a path' do
+      pageview.path.should eq('/foobar')
+    end
+
+    it 'has a title' do
+      pageview.title.should eq('FooBar')
+    end
+
+    it 'has all params' do
+      pageview.params.should eq({
+        'v' => 1,
+        'tid' => 'UA-XXXX-Y',
+        'cid' => '555',
+        't' => 'pageview',
+        'dh' => 'mysite.com',
+        'dp' => '/foobar',
+        'dt' => 'FooBar'
+      })
+    end
+  end
+
+  context "with extra options" do
+    let(:pageview) do
+      Staccato::Pageview.new(tracker, {
+        :hostname => 'mysite.com',
+        :path => '/foobar',
+        :title => 'FooBar',
+        :action => 'play'
+      })
+    end
+
+    it 'has all params' do
+      pageview.params.should eq({
+        'v' => 1,
+        'tid' => 'UA-XXXX-Y',
+        'cid' => '555',
+        't' => 'pageview',
+        'dh' => 'mysite.com',
+        'dp' => '/foobar',
+        'dt' => 'FooBar'
+      })
+    end
+  end
+
+  context "with no options" do
+    let(:pageview) do
+      Staccato::Pageview.new(tracker, {})
+    end
+
+    it 'has require params' do
+      pageview.params.should eq({
+        'v' => 1,
+        'tid' => 'UA-XXXX-Y',
+        'cid' => '555',
+        't' => 'pageview'
+      })
+    end
+  end
+end

data/spec/lib/staccato/tracker_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe Staccato::Tracker do
+
+  let(:tracker) {Staccato.tracker('UA-XXXX-Y')}
+
+  context "#pageview" do
+    let(:pageview) {Staccato::Pageview.new(tracker, {})}
+
+    before(:each) do
+      pageview.stubs(:track!)
+      Staccato::Pageview.stubs(:new).returns(pageview)
+
+      tracker.pageview(path: '/foobar')
+    end
+
+    it "creates a new Pageview" do
+      Staccato::Pageview.should have_received(:new).with(tracker, path: '/foobar')
+    end
+
+    it "tracks on the Pageview" do
+      pageview.should have_received(:track!)
+    end
+  end
+
+  context "#event" do
+    let(:event) {Staccato::Event.new(tracker, {})}
+
+    before(:each) do
+      event.stubs(:track!)
+      Staccato::Event.stubs(:new).returns(event)
+
+      tracker.event(category: 'video', action: 'play')
+    end
+
+    it "creates a new Event" do
+      Staccato::Event.should have_received(:new).with(tracker, category: 'video', action: 'play')
+    end
+
+    it "tracks on the Event" do
+      event.should have_received(:track!)
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+require 'bundler/setup'
+
+require 'rspec'
+require 'mocha/api'
+require 'bourne'
+
+require File.expand_path('../../lib/staccato', __FILE__)
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.mock_with :mocha
+
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/staccato.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'staccato/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "staccato"
+  spec.version       = Staccato::VERSION
+  spec.authors       = ["Tony Pitale"]
+  spec.email         = ["tpitale@gmail.com"]
+  spec.description   = "Ruby Google Analytics Measurement"
+  spec.summary       = "Ruby Google Analytics Measurement"
+  spec.homepage      = "https://github.com/tpitale/staccato"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "mocha"
+  spec.add_development_dependency "bourne"
+
+  # spec.add_runtime_dependency "uuid"
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: staccato
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Tony Pitale
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  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'
+- !ruby/object:Gem::Dependency
+  name: bourne
+  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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/staccato.rb
+- lib/staccato/event.rb
+- lib/staccato/exception.rb
+- lib/staccato/hit.rb
+- lib/staccato/pageview.rb
+- lib/staccato/social.rb
+- lib/staccato/tracker.rb
+- lib/staccato/version.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
+- staccato.gemspec
+homepage: https://github.com/tpitale/staccato
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Ruby Google Analytics Measurement
+test_files:
+- 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