snogmetrics 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,24 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+/coverage
+/rdoc
+/yardoc
+/coverage
+/pkg
+/.bundle
+
+## PROJECT::SPECIFIC

data/Gemfile

@@ -0,0 +1,13 @@
+source :gemcutter
+
+group :development do
+  gem 'rake'
+  gem 'jeweler'
+  gem 'yard'
+  gem 'rails', '>= 2.3.5'
+end
+
+group :test do
+  gem 'rspec', '>= 1.3.0'
+  gem 'rcov'
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Theo
+
+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.mdown

@@ -0,0 +1,50 @@
+# SNOGmetrics
+
+SNOGmetrics is a bridge between Rails and KISSmetrics' JavaScript API.
+
+## But KISSmetrics has a Ruby API!
+
+Yes, but it's not as good as the JavaScript one, they even say so themselves:
+
+> One thing to note about the Ruby API  is that it is not as full featured as the JavaScript client. Therefore, in most cases we recommend using the JavaScript client. However, some things are easier to track server-side, therefore we have provided a basic Ruby client.
+
+It's true, but why settle for either or?
+
+SNOGmetrics works similarly to flash messages. Events are recorded and saved to the session, and are then sent when the next page is rendered. This way you get all of the benefits of the JavaScript API, but you can record events in your controllers. All you have to do is install this gem, configure it, and add a snipplet of code to your layout.
+
+## How do I use it?
+
+1. `gem install snogmetrics`
+2. Edit `config/environment.rb` and add `config.gem 'snogmetrics'`
+3. Edit your layout(s) and add `<%= km.js! %>` where you keep your JavaScript includes.
+4. Replace all your `KM.record(...)` and `KM.identify(...)` calls in JavaScript with calls to `km.record(...)` and `km.identify(...)`
+
+Have a look at the included example application to see it in action.
+
+## Does it use the asynchronous API?
+
+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.
+
+## 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).
+
+In a future version this behaviour might be overrideable.
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2010 Theo Hultberg / Burt. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,44 @@
+require 'spec/rake/spectask'
+
+
+begin
+  require 'jeweler'
+  require File.expand_path('../lib/snogmetrics', __FILE__)
+  Jeweler::Tasks.new do |gem|
+    gem.name = 'snogmetrics'
+    gem.summary = %Q{SNOGmetrics is a KISSmetrics helper for Rails}
+    gem.description = %Q{SNOGmetrics gives you the best of both worlds: access to KISSmetrics' JavaScript API through Ruby}
+    gem.email = 'theo@iconara.net'
+    gem.homepage = 'http://github.com/iconara/snogmetrics'
+    gem.authors = ['Theo']
+    gem.version = Snogmetrics::VERSION
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts 'Jeweler (or a dependency) not available. Install it with: gem install jeweler'
+end
+
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort 'YARD is not available. In order to run yardoc, you must: sudo gem install yard'
+  end
+end

data/example/snoggy/.gitignore

@@ -0,0 +1 @@
+/log

data/example/snoggy/README.mdown

@@ -0,0 +1,7 @@
+# SNOGmetrics example application
+
+This is a small Rails application that uses SNOGmetrics. Look in `app/controllers/snogs_controller.rb` to see how you interact with the API from a controller, and look at `app/views/layouts/application.html.erb` to see the snipplet you need to add to your layout file.
+
+Because it's easier for me when I code I've added SNOGmetrics as a plugin in the `vendor/plugins` directory (by way of symlinks), but in a real application you would add the gem in `config/environment.rb` (there's a out-commented line there if you want to see how it's done).
+
+To set the KISSmetrics API key you need to add an initializer, see `config/initializers/snogmetrics.rb` for an example.

data/example/snoggy/Rakefile

@@ -0,0 +1,10 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require(File.join(File.dirname(__FILE__), 'config', 'boot'))
+
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+require 'tasks/rails'

data/example/snoggy/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

data/example/snoggy/app/controllers/snogs_controller.rb

@@ -0,0 +1,9 @@
+class SnogsController < ApplicationController
+
+  def create
+    km.identify(params[:snog][:who])
+    km.record('want_to_snog', :whom => params[:snog][:whom])
+    redirect_to thank_you_snogs_path
+  end
+  
+end

data/example/snoggy/app/views/layouts/application.html.erb

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
+  <head>
+    <title>SNOGmetrics</title>
+  </head>
+  <body>
+    <%= yield %>
+  </body>
+  
+  <%= km.js! %>
+</html>

data/example/snoggy/app/views/snogs/new.html.erb

@@ -0,0 +1,11 @@
+<% form_for :snog, :url => {:action => :create} do |f| -%>
+  <p>
+    <%= f.label :who, 'Who are you?' %><br/>
+    <%= f.text_field :who %>
+  </p>
+  <p>
+    <%= f.label :whom, 'Whom would you like to snog?' %><br/>
+    <%= f.text_field :whom %>
+  </p>
+  <p><%= f.submit 'Fullfill my wish!' %></p>
+<% end -%>

data/example/snoggy/app/views/snogs/thank_you.html.erb

@@ -0,0 +1 @@
+Thank you for participating!

data/example/snoggy/config/boot.rb

@@ -0,0 +1,110 @@
+# Don't change this file!
+# Configure your app in config/environment.rb and config/environments/*.rb
+
+RAILS_ROOT = "#{File.dirname(__FILE__)}/.." unless defined?(RAILS_ROOT)
+
+module Rails
+  class << self
+    def boot!
+      unless booted?
+        preinitialize
+        pick_boot.run
+      end
+    end
+
+    def booted?
+      defined? Rails::Initializer
+    end
+
+    def pick_boot
+      (vendor_rails? ? VendorBoot : GemBoot).new
+    end
+
+    def vendor_rails?
+      File.exist?("#{RAILS_ROOT}/vendor/rails")
+    end
+
+    def preinitialize
+      load(preinitializer_path) if File.exist?(preinitializer_path)
+    end
+
+    def preinitializer_path
+      "#{RAILS_ROOT}/config/preinitializer.rb"
+    end
+  end
+
+  class Boot
+    def run
+      load_initializer
+      Rails::Initializer.run(:set_load_path)
+    end
+  end
+
+  class VendorBoot < Boot
+    def load_initializer
+      require "#{RAILS_ROOT}/vendor/rails/railties/lib/initializer"
+      Rails::Initializer.run(:install_gem_spec_stubs)
+      Rails::GemDependency.add_frozen_gem_path
+    end
+  end
+
+  class GemBoot < Boot
+    def load_initializer
+      self.class.load_rubygems
+      load_rails_gem
+      require 'initializer'
+    end
+
+    def load_rails_gem
+      if version = self.class.gem_version
+        gem 'rails', version
+      else
+        gem 'rails'
+      end
+    rescue Gem::LoadError => load_error
+      $stderr.puts %(Missing the Rails #{version} gem. Please `gem install -v=#{version} rails`, update your RAILS_GEM_VERSION setting in config/environment.rb for the Rails version you do have installed, or comment out RAILS_GEM_VERSION to use the latest version installed.)
+      exit 1
+    end
+
+    class << self
+      def rubygems_version
+        Gem::RubyGemsVersion rescue nil
+      end
+
+      def gem_version
+        if defined? RAILS_GEM_VERSION
+          RAILS_GEM_VERSION
+        elsif ENV.include?('RAILS_GEM_VERSION')
+          ENV['RAILS_GEM_VERSION']
+        else
+          parse_gem_version(read_environment_rb)
+        end
+      end
+
+      def load_rubygems
+        min_version = '1.3.2'
+        require 'rubygems'
+        unless rubygems_version >= min_version
+          $stderr.puts %Q(Rails requires RubyGems >= #{min_version} (you have #{rubygems_version}). Please `gem update --system` and try again.)
+          exit 1
+        end
+
+      rescue LoadError
+        $stderr.puts %Q(Rails requires RubyGems >= #{min_version}. Please install RubyGems and try again: http://rubygems.rubyforge.org)
+        exit 1
+      end
+
+      def parse_gem_version(text)
+        $1 if text =~ /^[^#]*RAILS_GEM_VERSION\s*=\s*["']([!~<>=]*\s*[\d.]+)["']/
+      end
+
+      private
+        def read_environment_rb
+          File.read("#{RAILS_ROOT}/config/environment.rb")
+        end
+    end
+  end
+end
+
+# All that for this:
+Rails.boot!

data/example/snoggy/config/environment.rb

@@ -0,0 +1,13 @@
+RAILS_GEM_VERSION = '2.3.5' unless defined? RAILS_GEM_VERSION
+
+require File.join(File.dirname(__FILE__), 'boot')
+
+Rails::Initializer.run do |config|
+  # Usually you would add SNOGmetrics by adding the gem here, but in this
+  # example app I have put the code as a plugin, because it's more convenient
+  # when I code new features.
+  #config.gem 'snogmetrics'
+  
+  config.frameworks -= [:active_record, :active_resource, :action_mailer]
+  config.action_controller.session = {:key => '_snoggy_session', :secret => 'd08d2ef897ba8d7477bc3088dde396ac'}
+end

data/example/snoggy/config/environments/development.rb

@@ -0,0 +1,6 @@
+config.cache_classes = false
+config.whiny_nils = true
+config.action_controller.consider_all_requests_local = true
+config.action_view.debug_rjs                         = true
+config.action_controller.perform_caching             = false
+config.action_mailer.raise_delivery_errors = false

data/example/snoggy/config/environments/production.rb

@@ -0,0 +1,4 @@
+config.cache_classes = true
+config.action_controller.consider_all_requests_local = false
+config.action_controller.perform_caching             = true
+config.action_view.cache_template_loading            = true

data/example/snoggy/config/environments/test.rb

@@ -0,0 +1,6 @@
+config.cache_classes = true
+config.whiny_nils = true
+config.action_controller.consider_all_requests_local = true
+config.action_controller.perform_caching             = false
+config.action_view.cache_template_loading            = true
+config.action_controller.allow_forgery_protection    = false

data/example/snoggy/config/initializers/snogmetrics.rb

@@ -0,0 +1,14 @@
+# This is where you configure SNOGmetrics. Just override the #kissmetrics_api_key
+# method of the module to return the API key.
+module Snogmetrics
+  def kissmetrics_api_key
+    'abc123'
+  end
+end
+
+# If you need to load the API from a YAML file, you can do something like the
+# following. It loads the key and puts it in a local variable, then it overrides
+# the #kissmetrics_api_key method with a closure that has access to the local
+# variable 'key'.
+#key = YAML.load(ERB.new(File.read('path/to/file.yml')).result)[RAILS_ENV].symbolize_keys[:kissmetrics_api_key]
+#Snogmetrics.send(:define_method, :kissmetrics_api_key) { key }

data/example/snoggy/config/routes.rb

@@ -0,0 +1,4 @@
+ActionController::Routing::Routes.draw do |map|
+  map.resources :snogs, :only => %w(new create), :collection => {:thank_you => :get}
+  map.root :controller => :snogs, :action => :new
+end

data/example/snoggy/script/about

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require File.expand_path('../../config/boot',  __FILE__)
+$LOAD_PATH.unshift "#{RAILTIES_PATH}/builtin/rails_info"
+require 'commands/about'

data/example/snoggy/script/console

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.expand_path('../../config/boot',  __FILE__)
+require 'commands/console'

data/example/snoggy/script/dbconsole

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.expand_path('../../config/boot',  __FILE__)
+require 'commands/dbconsole'

data/example/snoggy/script/destroy

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.expand_path('../../config/boot',  __FILE__)
+require 'commands/destroy'

data/example/snoggy/script/generate

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.expand_path('../../config/boot',  __FILE__)
+require 'commands/generate'

data/example/snoggy/script/performance/benchmarker

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.expand_path('../../../config/boot',  __FILE__)
+require 'commands/performance/benchmarker'

data/example/snoggy/script/performance/profiler

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.expand_path('../../../config/boot',  __FILE__)
+require 'commands/performance/profiler'

data/example/snoggy/script/plugin

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.expand_path('../../config/boot',  __FILE__)
+require 'commands/plugin'

data/example/snoggy/script/runner

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.expand_path('../../config/boot',  __FILE__)
+require 'commands/runner'

data/example/snoggy/script/server

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.expand_path('../../config/boot',  __FILE__)
+require 'commands/server'

data/example/snoggy/vendor/plugins/snogmetrics/init.rb

@@ -0,0 +1,4 @@
+require 'snogmetrics'
+
+ActionController::Base.send(:include, Snogmetrics)
+ActionView::Base.send(:include, Snogmetrics)

data/lib/snogmetrics.rb

@@ -0,0 +1,164 @@
+module Snogmetrics
+  VERSION = '0.1.0'
+  
+  def km
+    @km_api ||= KissmetricsApi.new(kissmetrics_api_key, session)
+  end
+
+  # Override this method to set the KISSmetrics API key
+  def kissmetrics_api_key
+    ''
+  end
+  
+private
+
+  class KissmetricsApi
+    include ERB::Util
+    
+    def initialize(api_key, session)
+      @session = session
+      @api_key = api_key
+    end
+    
+    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
+    end
+    
+    def identify(identity)
+      unless user_identified?(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?
+        ''
+      else
+        <<-JAVASCRIPT
+        <script type="text/javascript">
+        var _kmq = _kmq || [];
+        #{api_js}
+        #{buffer.join("\n")}
+        </script>
+        JAVASCRIPT
+      end
+    end
+    
+    def js!
+      js(:reset => true)
+    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});)
+    end
+    
+    def api_js
+      if Rails.env.production?
+        %((function(){function _kms(u,d){if(navigator.appName.indexOf("Microsoft")==0 && d)document.write("<scr"+"ipt defer='defer' async='true' src='"+u+"'></scr"+"ipt>");else{var s=document.createElement('script');s.type='text/javascript';s.async=true;s.src=u;(document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(s);}}_kms('https://i.kissmetrics.com/i.js');_kms('http'+('https:'==document.location.protocol ? 's://s3.amazonaws.com/' : '://')+'scripts.kissmetrics.com/#{@api_key}.1.js',1);})();)
+      else
+        <<-JS
+        var KM = {
+          record: function() {
+            _kmq.push(["record"].concat(Array.prototype.slice.apply(arguments)));
+          },
+          identify: function() {
+            _kmq.push(["identify"].concat(Array.prototype.slice.apply(arguments)));
+          }
+        };
+
+        if (window.console) {
+          _kmq = (function(queue) {
+            function printCall() {
+              console.dir(arguments);
+            }
+
+            for (var i = 0; i < queue.length; i++) {
+              printCall.apply(null, queue[i]);
+            }
+
+            return {push: printCall};
+          })(_kmq);
+        }
+        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/rails/init.rb

@@ -0,0 +1,4 @@
+require 'snogmetrics'
+
+ActionController::Base.send(:include, Snogmetrics)
+ActionView::Base.send(:include, Snogmetrics)

data/spec/snogmetrics_spec.rb

@@ -0,0 +1,132 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+
+module Rails
+  def self.env
+    self
+  end
+  
+  def self.production?
+    false
+  end
+end
+
+
+describe Snogmetrics do
+  
+  before do
+    @session = {}
+    @context = Object.new
+    @context.extend(Snogmetrics)
+    @context.stub!(:session).and_return(@session)
+    @context.stub!(:kissmetrics_api_key).and_return('abc123')
+  end
+  
+  describe '#record' do
+    it 'will output code that pushes an event with the specified name and properties' do
+      @context.km.record('hello world', :foo => 'bar')
+      @context.km.js.should include('_kmq.push(["record","hello world",{"foo":"bar"}]);')
+    end
+    
+    it 'will output code that pushes an event with name only' do
+      @context.km.record('foo')
+      @context.km.js.should include('_kmq.push(["record","foo"]);')
+    end
+    
+    it 'will output code that pushes an event with properties only' do
+      @context.km.record({:foo => 'bar', :plink => :plonk})
+      @context.km.js.should match(%r#_kmq.push\(\["record",\{(?:"foo":"bar","plink":"plonk"|"plink":"plonk","foo":"bar")\}\]\)#)
+    end
+    
+    it 'complains if called without arguments' do
+      running { @context.km.record }.should raise_error
+    end
+    
+    it 'complains if called with more than two arguments' do
+      running { @context.km.record(1, 2, 3) }.should raise_error
+    end
+    
+    it 'will output code that pushes events with the same name in the order they were recorded' 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"}]);')
+    end
+  end
+  
+  describe '#identify' do
+    it 'will output code that pushes an identify call with the provided identity' do
+      @context.km.identify('Phil')
+      @context.km.js.should include('_kmq.push(["identify","Phil"]);')
+    end
+    
+    it 'will only output the last identity set' do
+      @context.km.identify('Phil')
+      @context.km.identify('Anne')
+      @context.km.identify('Steve')
+      @context.km.js.should_not include('Phil')
+      @context.km.js.should_not include('Anne')
+      @context.km.js.should     include('Steve')
+    end
+  end
+  
+  describe '#js' do
+    it 'outputs nothing if there are no events and no identity' do
+      @context.km.js.should be_empty
+    end
+    
+    context 'in production' do
+      before do
+        Rails.stub!(:env).and_return(mock('env', :production? => true))
+      end
+      
+      it 'outputs a JavaScript tag that loads the KISSmetrics API' do
+        @context.km.identify('Phil')
+        @context.km.js.should include('scripts.kissmetrics.com/abc123.1.js')
+      end
+    end
+    
+    it 'outputs code that conditionally sets the _kmq variable' do
+      @context.km.identify('Phil')
+      @context.km.js.should include('var _kmq = _kmq || [];')
+    end
+        
+    it 'outputs code that pushes an event for every #record call' do
+      @context.km.record('1')
+      @context.km.record('2')
+      @context.km.record('3')
+      @context.km.js.scan(/_kmq.push\(\["record","\d"\]\)/).size.should == 3
+    end
+    
+    it 'resets the session when passed :reset => true' do
+      @context.km.record('hello world')
+      @context.km.js(:reset => true)
+      @context.km.js.should be_empty
+    end
+  end
+  
+  describe '#js!' do
+    it 'works like #js(:reset => true)' do
+      @context.km.record('hello world')
+      @context.km.js!
+      @context.km.js.should be_empty
+    end
+    
+    it 'does not push an identify call if the identity has already been sent once' do
+      @context.km.identify('Steve')
+      @context.km.js!
+      @context.km.identify('Steve')
+      @context.km.js!.should_not include('_kmq.push(["identify"')
+    end
+    
+    it 'ouputs code that pushes an identify call if #identify is called with a new identity' do
+      @context.km.identify('Steve')
+      @context.km.js!
+      @context.km.identify('Anne')
+      @context.km.js!.should include('_kmq.push(["identify","Anne"])')
+    end
+  end
+  
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'snogmetrics'
+require 'active_support'
+require 'action_view/erb/util'
+require 'spec'
+require 'spec/autorun'
+
+
+alias :running :lambda
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification 
+name: snogmetrics
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Theo
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-30 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: "SNOGmetrics gives you the best of both worlds: access to KISSmetrics' JavaScript API through Ruby"
+email: theo@iconara.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.mdown
+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
+- spec/snogmetrics_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/iconara/snogmetrics
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: SNOGmetrics is a KISSmetrics helper for Rails
+test_files: 
+- spec/snogmetrics_spec.rb
+- spec/spec_helper.rb