RubyGems - snogmetrics - Versions diffs - 0.1.9 → 0.2.1 - Mend

snogmetrics 0.1.9 → 0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (42) hide show

checksums.yaml +7 -0
data/.gitignore +23 -0
data/.rubocop.yml +1 -0
data/.rubocop_todo.yml +203 -0
data/Gemfile.lock +128 -25
data/README.mdown +11 -6
data/Rakefile +5 -12
data/lib/snogmetrics.rb +18 -130
data/lib/snogmetrics/kissmetrics_api.rb +112 -0
data/lib/snogmetrics/railtie.rb +0 -1
data/snogmetrics.gemspec +18 -12
metadata +100 -130
data/example/snoggy/.gitignore +0 -1
data/example/snoggy/README.mdown +0 -7
data/example/snoggy/Rakefile +0 -10
data/example/snoggy/app/controllers/application_controller.rb +0 -2
data/example/snoggy/app/controllers/snogs_controller.rb +0 -9
data/example/snoggy/app/views/layouts/application.html.erb +0 -12
data/example/snoggy/app/views/snogs/new.html.erb +0 -11
data/example/snoggy/app/views/snogs/thank_you.html.erb +0 -1
data/example/snoggy/config/boot.rb +0 -110
data/example/snoggy/config/environment.rb +0 -13
data/example/snoggy/config/environments/development.rb +0 -6
data/example/snoggy/config/environments/production.rb +0 -4
data/example/snoggy/config/environments/test.rb +0 -6
data/example/snoggy/config/initializers/snogmetrics.rb +0 -14
data/example/snoggy/config/routes.rb +0 -4
data/example/snoggy/script/about +0 -4
data/example/snoggy/script/console +0 -3
data/example/snoggy/script/dbconsole +0 -3
data/example/snoggy/script/destroy +0 -3
data/example/snoggy/script/generate +0 -3
data/example/snoggy/script/performance/benchmarker +0 -3
data/example/snoggy/script/performance/profiler +0 -3
data/example/snoggy/script/plugin +0 -3
data/example/snoggy/script/runner +0 -3
data/example/snoggy/script/server +0 -3
data/example/snoggy/vendor/plugins/snogmetrics/init.rb +0 -4
data/rails/init.rb +0 -4
data/spec/snogmetrics_spec.rb +0 -224
data/spec/spec.opts +0 -2
data/spec/spec_helper.rb +0 -15

data/example/snoggy/.gitignore DELETED

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

data/example/snoggy/README.mdown DELETED

@@ -1,7 +0,0 @@
-# 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 DELETED

@@ -1,10 +0,0 @@
-# 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 DELETED

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

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

@@ -1,9 +0,0 @@
-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 DELETED

@@ -1,12 +0,0 @@
-<!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 DELETED

@@ -1,11 +0,0 @@
-<% 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 DELETED

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

data/example/snoggy/config/boot.rb DELETED

@@ -1,110 +0,0 @@
-# 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 DELETED

@@ -1,13 +0,0 @@
-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 DELETED

@@ -1,6 +0,0 @@
-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 DELETED

@@ -1,4 +0,0 @@
-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 DELETED

@@ -1,6 +0,0 @@
-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 DELETED

@@ -1,14 +0,0 @@
-# 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 DELETED

@@ -1,4 +0,0 @@
-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 DELETED

@@ -1,4 +0,0 @@
-#!/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 DELETED

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

data/example/snoggy/script/dbconsole DELETED

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

data/example/snoggy/script/destroy DELETED

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

data/example/snoggy/script/generate DELETED

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

data/example/snoggy/script/performance/benchmarker DELETED

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

data/example/snoggy/script/performance/profiler DELETED

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

data/example/snoggy/script/plugin DELETED

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

data/example/snoggy/script/runner DELETED

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

data/example/snoggy/script/server DELETED

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

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

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

data/rails/init.rb DELETED

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

data/spec/snogmetrics_spec.rb DELETED

@@ -1,224 +0,0 @@
-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
-      first = '_kmq.push(["record","An important event",{"p":3}]);'
-      second = '_kmq.push(["record","An important event",{"p":4}]);'
-      js.should include(first)
-      js.should include(second)
-      js.index(first).should < js.index(second)
-    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')
-      @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 '#set' do
-    it 'will output code that pushes a set call with the provided experiment name and variant' do
-      @context.km.set('My Awesome Experiment', 'variant_a')
-      @context.km.js.should include('_kmq.push(["set",{"My Awesome Experiment":"variant_a"}])')
-    end
-  end
-  describe '#js' do
-    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 for the provided API key' do
-        @context.stub!(:kissmetrics_api_key).and_return('cab1ebeef')
-        @context.km.identify('Phil')
-        @context.km.js.should include('scripts.kissmetrics.com/cab1ebeef.1.js')
-      end
-    end
-    context 'overriding #use_fake_kissmetrics_api?' do
-      it 'will do your bidding, and not be influenced by Rails.env' do
-        Rails.stub!(:env).and_return(mock('env', :production? => true))
-        @context.stub!(:use_fake_kissmetrics_api?).and_return(true)
-        @context.km.identify('Joyce')
-        @context.km.js.should_not include('scripts.kissmetrics.com')
-      end
-    end
-    context 'overriding #output_strategy with :console_log' do
-      it 'outputs calls to console.log' do
-        Rails.stub!(:env).and_return(mock('env', :production? => true))
-        @context.stub!(:output_strategy).and_return(:console_log)
-        @context.km.identify('Joyce')
-        @context.km.js.should_not include('scripts.kissmetrics.com')
-        @context.km.js.should include('console.dir')
-      end
-    end
-    context 'overriding #output_strategy with :array' do
-      it 'just stores calls in the _kmq array' do
-        Rails.stub!(:env).and_return(mock('env', :production? => true))
-        @context.stub!(:output_strategy).and_return(:array)
-        @context.km.identify('Joyce')
-        @context.km.js.should_not include('scripts.kissmetrics.com')
-        @context.km.js.should_not include('console.dir')
-      end
-    end
-    context 'overriding #output_strategy with :live' do
-      it 'sends calls to KISSmetrics' do
-        Rails.stub!(:env).and_return(mock('env', :production? => true))
-        @context.stub!(:output_strategy).and_return(:live)
-        @context.km.identify('Joyce')
-        @context.km.js.should include('scripts.kissmetrics.com')
-        @context.km.js.should_not include('console.dir')
-      end
-    end
-    context 'overriding #output_strategy with something else' do
-      it 'raises' do
-        @context.stub!(:output_strategy).and_return(:something_else)
-        lambda {
-          @context.km.js.should include('scripts.kissmetrics.com')
-        }.should raise_error(RuntimeError, "Unknown KISSmetrics output strategy: something_else")
-      end
-    end
-    it 'outputs javascript even if there are no events and no identity' do
-      @context.km.js.should include('kmq')
-    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"\]\)/).should have(3).items
-    end
-    it 'resets the session when passed :reset => true' do
-      @context.km.record('hello world')
-      @context.km.js(:reset => true)
-      @context.km.js.should_not include('hello world')
-    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
-    it 'works like #js(:reset => true)' do
-      @context.km.record('hello world')
-      @context.km.js!
-      @context.km.js!.should_not include('_kmq.push(["record"')
-    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