snogmetrics 0.1.0 → 0.1.1

data/README.mdown

@@ -27,7 +27,7 @@ Yes it does.
 
 ## What if I want to call KISSmetrics from both my controllers _and_ JavaScript?
 
-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.
+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.
 
 ## Anything else I should know?
 

data/lib/snogmetrics.rb

@@ -1,5 +1,5 @@
 module Snogmetrics
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
   
   def km
     @km_api ||= KissmetricsApi.new(kissmetrics_api_key, session)
@@ -13,8 +13,6 @@ module Snogmetrics
 private
 
   class KissmetricsApi
-    include ERB::Util
-    
     def initialize(api_key, session)
       @session = session
       @api_key = api_key
@@ -23,55 +21,28 @@ private
     def record(*args)
       raise 'Not enough arguments' if args.size == 0
       raise 'Too many arguments' if args.size > 2
-
-      @session[:km_events] ||= []
-
-      if args.size == 1 && args.first.is_a?(Hash)
-        @session[:km_events] << {:properties => args.first}
-      elsif args.size == 1
-        @session[:km_events] << {:name => args.first}
-      else
-        @session[:km_events] << {:name => args.first, :properties => args.last}
-      end
+      
+      queue << ['record', *args]
     end
     
     def identify(identity)
-      unless user_identified?(identity)
+      unless @session[:km_identity] == identity
+        queue.delete_if { |e| e.first == 'identify' }
+        queue << ['identify', identity]
         @session[:km_identity] = identity
-        @session[:km_user_identified] = nil
       end
     end
     
     def js(options={})
       options = {:reset => false}.merge(options)
-
-      buffer = []
-
-      unless user_identified? || @session[:km_identity].blank?
-        identity = html_escape(@session[:km_identity])
-
-        buffer << push_call('identify', identity)
-
-        user_identified! if options[:reset]
-      end
-
-      unless events.empty?
-        safe_events.each do |event|
-          if event[:name].blank?
-            buffer << push_call('record', event[:properties])
-          elsif event[:properties].blank?
-            buffer << push_call('record', event[:name])
-          else
-            buffer << push_call('record', event[:name], event[:properties])
-          end
-        end
-
-        reset_events! if options[:reset]
-      end
-
-      if buffer.empty?
+      
+      if queue.empty?
         ''
       else
+        buffer = queue.map { |item| %(_kmq.push(#{item.to_json});) }
+        
+        queue.clear if options[:reset]
+        
         <<-JAVASCRIPT
         <script type="text/javascript">
         var _kmq = _kmq || [];
@@ -87,17 +58,9 @@ private
     end
   
   private
-    
-    def user_identified?(who=nil)
-      if who
-        @session[:km_user_identified] == who
-      else
-        !!@session[:km_user_identified]
-      end
-    end
-    
-    def push_call(*args)
-      %(_kmq.push(#{args.to_json});)
+  
+    def queue
+      @session[:km_queue] ||= []
     end
     
     def api_js
@@ -130,35 +93,5 @@ private
         JS
       end
     end
-    
-    def events
-      @session[:km_events] || []
-    end
-
-    def reset_events!
-      @session[:km_events] = []
-    end
-    
-    def user_identified!
-      @session[:km_user_identified] = @session[:km_identity]
-      @session[:km_identity] = nil
-    end
-    
-    def safe_properties(hash)
-      return {} if hash.nil? || hash.empty?
-      hash.keys.inject({}) do |h, k|
-        h[html_escape(k)] = html_escape(hash[k])
-        h
-      end
-    end
-    
-    def safe_events
-      events.map do |event|
-        safe_event = {}
-        safe_event[:name] = html_escape(event[:name].strip) unless event[:name].blank?
-        safe_event[:properties] = safe_properties(event[:properties]) unless event[:properties].blank?
-        safe_event
-      end
-    end
   end
 end

data/snogmetrics.gemspec

@@ -0,0 +1,79 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{snogmetrics}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Theo"]
+  s.date = %q{2010-03-31}
+  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 = [
+    "LICENSE",
+     "README.mdown"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "Gemfile",
+     "LICENSE",
+     "README.mdown",
+     "Rakefile",
+     "example/snoggy/.gitignore",
+     "example/snoggy/README.mdown",
+     "example/snoggy/Rakefile",
+     "example/snoggy/app/controllers/application_controller.rb",
+     "example/snoggy/app/controllers/snogs_controller.rb",
+     "example/snoggy/app/views/layouts/application.html.erb",
+     "example/snoggy/app/views/snogs/new.html.erb",
+     "example/snoggy/app/views/snogs/thank_you.html.erb",
+     "example/snoggy/config/boot.rb",
+     "example/snoggy/config/environment.rb",
+     "example/snoggy/config/environments/development.rb",
+     "example/snoggy/config/environments/production.rb",
+     "example/snoggy/config/environments/test.rb",
+     "example/snoggy/config/initializers/snogmetrics.rb",
+     "example/snoggy/config/routes.rb",
+     "example/snoggy/script/about",
+     "example/snoggy/script/console",
+     "example/snoggy/script/dbconsole",
+     "example/snoggy/script/destroy",
+     "example/snoggy/script/generate",
+     "example/snoggy/script/performance/benchmarker",
+     "example/snoggy/script/performance/profiler",
+     "example/snoggy/script/plugin",
+     "example/snoggy/script/runner",
+     "example/snoggy/script/server",
+     "example/snoggy/vendor/plugins/snogmetrics/init.rb",
+     "lib/snogmetrics.rb",
+     "rails/init.rb",
+     "snogmetrics.gemspec",
+     "spec/snogmetrics_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  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.summary = %q{SNOGmetrics is a KISSmetrics helper for Rails}
+  s.test_files = [
+    "spec/snogmetrics_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/spec/snogmetrics_spec.rb

@@ -50,9 +50,9 @@ describe Snogmetrics do
       @context.km.record('An important event', :p => 3)
       @context.km.record('An important event', :p => 4)
       js = @context.km.js
-      js.should include('_kmq.push(["record","An important event",{"p":"3"}]);')
-      js.should include('_kmq.push(["record","An important event",{"p":"4"}]);')
-      js.index('_kmq.push(["record","An important event",{"p":"3"}]);').should < js.index('_kmq.push(["record","An important event",{"p":"4"}]);')
+      js.should include('_kmq.push(["record","An important event",{"p":3}]);')
+      js.should include('_kmq.push(["record","An important event",{"p":4}]);')
+      js.index('_kmq.push(["record","An important event",{"p":3}]);').should < js.index('_kmq.push(["record","An important event",{"p":4}]);')
     end
   end
   
@@ -105,6 +105,11 @@ describe Snogmetrics do
       @context.km.js(:reset => true)
       @context.km.js.should be_empty
     end
+    
+    it 'does not let HTML slip through' do
+      @context.km.identify('</html>')
+      @context.km.js.should_not include('</html>')
+    end
   end
   
   describe '#js!' do

data/spec/spec.opts

@@ -1 +1,2 @@
 --color
+--backtrace

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Theo
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-30 00:00:00 +02:00
+date: 2010-03-31 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -62,6 +62,7 @@ files:
 - example/snoggy/vendor/plugins/snogmetrics/init.rb
 - lib/snogmetrics.rb
 - rails/init.rb
+- snogmetrics.gemspec
 - spec/snogmetrics_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb