snogmetrics 0.1.3 → 0.1.4

data/Gemfile

@@ -5,7 +5,7 @@ group :development do
   gem 'jeweler'
   gem 'yard'
   gem 'BlueCloth'
-  gem 'rails', '>= 2.3.5'
+  gem 'rails', '= 2.3.5'
 end
 
 group :test do

data/Gemfile.lock

@@ -0,0 +1,47 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    BlueCloth (1.0.1)
+    actionmailer (2.3.5)
+      actionpack (= 2.3.5)
+    actionpack (2.3.5)
+      activesupport (= 2.3.5)
+      rack (~> 1.0.0)
+    activerecord (2.3.5)
+      activesupport (= 2.3.5)
+    activeresource (2.3.5)
+      activesupport (= 2.3.5)
+    activesupport (2.3.5)
+    gemcutter (0.6.1)
+    git (1.2.5)
+    jeweler (1.4.0)
+      gemcutter (>= 0.1.0)
+      git (>= 1.2.5)
+      rubyforge (>= 2.0.0)
+    json_pure (1.4.6)
+    rack (1.0.1)
+    rails (2.3.5)
+      actionmailer (= 2.3.5)
+      actionpack (= 2.3.5)
+      activerecord (= 2.3.5)
+      activeresource (= 2.3.5)
+      activesupport (= 2.3.5)
+      rake (>= 0.8.3)
+    rake (0.8.7)
+    rcov (0.9.8)
+    rspec (1.3.0)
+    rubyforge (2.0.4)
+      json_pure (>= 1.1.7)
+    yard (0.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  BlueCloth
+  jeweler
+  rails (= 2.3.5)
+  rake
+  rcov
+  rspec (>= 1.3.0)
+  yard

data/README.mdown

@@ -29,6 +29,10 @@ Yes it does.
 
 Just do it. You need to make sure that the `_kmq` array exists, though. SNOGmetrics will define it where you place `<%= km.js! %>`, but that is usually at the bottom of the page (with the async API you could probably put it at the top if you wanted to), so if you want to add things to `_kmq` before that you need to define it yourself. Just add `var _kmq = _kmq || []` and you're set.
 
+## What about A/B testing
+
+SNOGmetrics implements #set, which is equivalent to `_kmq.push(["set", ...])`, the preferred way of recording which version a user saw in an A/B test. SNOGmetrics does not support the `KM.ab` function, because that's something you want to do in JavaScript only.
+
 ## Anything else I should know?
 
 Yes, SNOGmetrics will _not_ output the KISSmetrics API code unless `RAILS_ENV` is `production`. Instead it will output code that logs all calls to the console (if `console` is defined).

data/lib/snogmetrics.rb

@@ -14,7 +14,7 @@
 # the default implementation outputs the real API only when 
 # `Rails.env.production?` is true.
 module Snogmetrics
-  VERSION = '0.1.3'
+  VERSION = '0.1.4'
 
   # Returns an instance of KissmetricsApi, which is an interface to the
   # KISSmetrics API. It has the methods #record and #identify, which work just
@@ -68,6 +68,17 @@ private
       end
     end
     
+    # The equivalent of the `KM.trackClick` method of the JavaScript API. The first
+    # argument should be a selector (a tag id or class name). Furthermore you can
+    # pass either an event name, an event name and a hash of properties, or only
+    # a hash of properties.
+    def trackClick(selector, *args)
+      raise 'Not enough arguments' if args.size == 0
+      raise 'Too many arguments' if args.size > 2
+
+      queue << ['trackClick', selector, *args]
+    end
+
     # Register which variant the user saw in an A/B test.
     def set(experiment, variant)
       queue << ['set', experiment, variant]

data/snogmetrics.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{snogmetrics}
-  s.version = "0.1.3"
+  s.version = "0.1.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Theo"]
-  s.date = %q{2010-04-16}
+  s.date = %q{2010-09-02}
   s.description = %q{SNOGmetrics gives you the best of both worlds: access to KISSmetrics' JavaScript API through Ruby}
   s.email = %q{theo@iconara.net}
   s.extra_rdoc_files = [
@@ -21,6 +21,7 @@ Gem::Specification.new do |s|
      ".gitignore",
      "CHANGELOG.mdown",
      "Gemfile",
+     "Gemfile.lock",
      "LICENSE",
      "README.mdown",
      "Rakefile",
@@ -60,7 +61,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/iconara/snogmetrics}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{SNOGmetrics is a KISSmetrics helper for Rails}
   s.test_files = [
     "spec/snogmetrics_spec.rb",
@@ -71,7 +72,7 @@ Gem::Specification.new do |s|
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
     else
     end
   else

data/spec/snogmetrics_spec.rb

@@ -58,6 +58,35 @@ describe Snogmetrics do
     end
   end
   
+  describe '#trackClick' do
+    it 'will output code that pushes an event with the specified name and properties' do
+      @context.km.trackClick('tagid', 'hello world', :foo => 'bar')
+      @context.km.js.should include('_kmq.push(["trackClick","tagid","hello world",{"foo":"bar"}]);')
+    end
+
+    it 'will output code that pushes an event with name only' do
+      @context.km.trackClick('tagid', 'foo')
+      @context.km.js.should include('_kmq.push(["trackClick","tagid","foo"]);')
+    end
+
+    it 'will output code that pushes an event with properties only' do
+      @context.km.trackClick('tagid', {:foo => 'bar', :plink => :plonk})
+      @context.km.js.should match(%r#_kmq.push\(\["trackClick","tagid",\{(?:"foo":"bar","plink":"plonk"|"plink":"plonk","foo":"bar")\}\]\)#)
+    end
+
+    it 'complains if called without arguments' do
+      running { @context.km.trackClick }.should raise_error
+    end
+
+    it 'complains if called with selector only' do
+      running { @context.km.trackClick('tagid') }.should raise_error
+    end
+
+    it 'complains if called with more than three arguments' do
+      running { @context.km.trackClick('tagid', 'hello world', {:foo => 'bar'}, '12') }.should raise_error
+    end
+  end
+
   describe '#identify' do
     it 'will output code that pushes an identify call with the provided identity' do
       @context.km.identify('Phil')

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: snogmetrics
 version: !ruby/object:Gem::Version 
+  hash: 19
   prerelease: false
   segments: 
   - 0
   - 1
-  - 3
-  version: 0.1.3
+  - 4
+  version: 0.1.4
 platform: ruby
 authors: 
 - Theo
@@ -14,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-16 00:00:00 +02:00
+date: 2010-09-02 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -32,6 +33,7 @@ files:
 - .gitignore
 - CHANGELOG.mdown
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.mdown
 - Rakefile
@@ -77,23 +79,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: SNOGmetrics is a KISSmetrics helper for Rails