saucy-kiss 0.0.2 → 0.1.0

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+0.1.0
+
+Instead of:
+
+    before_filter Saucy::Kiss::KissmetricsIdentityControllerFilter
+
+include filters as:
+
+    include Saucy::Kiss::ControllerFilters
+
 0.0.2
 
 Add Ben Orenstein as additional author.

data/README.rdoc

@@ -1,6 +1,6 @@
 = saucy-kiss
 
-Saucy-KISS is an extension to the Saucy gem for tracking your SaaS events
+Saucy-kiss is an extension to the Saucy gem for tracking your SaaS events
 in KISSmetrics.
 
 It depends on the unofficial KISSmetrics gem http://rubygems.org/gems/kissmetrics
@@ -16,19 +16,6 @@ We assume that:
   advantage of KISSmetrics' anonymous identity tracking, automatic handling
   of the "Visited Site" metric, bot/crawler blacklisting, etc.
 
-By using the kissmetrics gem, we support:
-
-* Testing your KISSmetrics integration points.
-
-* Using the KISSmetrics JS API from the request/response cycle by storing
-  identity, events, and properties in the session and rendering them into your
-  view as JS calls, similar to the Rails flash.
-
-* Using the KISSmetrics HTTP API from outside the request/response cycle (think
-  billing callbacks, or queued operations) delivered directly.  Patches for
-  queued delivery of HTTP API calls (Resque, Delayed::Job, QueueClassic, etc.)
-  are welcome.
-
 == Supported events
 
 Saucy-kiss records all the KISSmetrics SaaS events http://support.kissmetrics.com/apis/saas_events:
@@ -39,6 +26,8 @@ Saucy-kiss records all the KISSmetrics SaaS events http://support.kissmetrics.co
 * Billed
 * Canceled
 
+== Future work
+
 TODO: Additional events provided by Saucy:
 
 * Viewed Plan List
@@ -69,8 +58,7 @@ http://support.kissmetrics.com/advanced/identity-management
 
 In your Gemfile:
 
-  gem "saucy-kiss" # depend on kissmetrics, snogmetrics
-  gem "snogmetrics", :git => "git://github.com/jasonm/snogmetrics" # only until snogmetrics accepts my patch
+  gem "saucy-kiss"
 
 Then:
 
@@ -89,7 +77,7 @@ Add an initializer in config/initializers/saucy_kiss.rb:
 
 Add a filter to each request in ApplicationController:
 
-    before_filter Saucy::Kiss::KissmetricsIdentityControllerFilter
+    include Saucy::Kiss::ControllerFilters
 
 Note: Saucy::Kiss will automatically instantiate the Snogmetrics gem like this:
 
@@ -140,6 +128,13 @@ Saucy-kiss distinguishes between in-request events and out-of-request events,
 because it prefers delivering events to KISSmetrics via the JS API where
 possible; this is only possible for in-request events.
 
+Using the snogmetrics gem, we record to the KISSmetrics JS API from within the
+request/response cycle by storing identity, events, and properties in the session
+and rendering them into your view as JS calls, similar to the Rails flash.
+
+Using the kissmetrics gem, we record to the KISSmetrics HTTP API from outside the
+request/response cycle (think billing callbacks, or queued operations) delivered directly.
+
 == Contributing to saucy-kiss
 
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet

data/lib/saucy/kiss/controller_filters.rb

@@ -0,0 +1,18 @@
+module Saucy
+  module Kiss
+    module ControllerFilters
+      def identify_to_kissmetrics
+        if current_account
+          km.identify("account-#{current_account.id}")
+        else
+          km.identify(nil)
+        end
+      end
+
+      def self.included(base)
+        base.send(:hide_action, :identify_to_kissmetrics)
+        base.send(:before_filter, :identify_to_kissmetrics)
+      end
+    end
+  end
+end

data/lib/saucy-kiss.rb

@@ -1,2 +1,2 @@
 require 'saucy/kiss/observer'
-require 'saucy/kiss/controller_identity_filter'
+require 'saucy/kiss/controller_filters'

data/spec/saucy/kiss/controller_filters_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+class FakeController
+  class << self
+    attr_accessor :before_filters, :hidden_actions
+  end
+
+  attr_reader :km
+
+  def initialize(km)
+    @km = km
+  end
+
+  def self.before_filter(filter)
+    @before_filters ||= []
+    @before_filters << filter
+  end
+
+  def self.hide_action(hidden_actions)
+    @hidden_actions ||= []
+    @hidden_actions << hidden_actions
+  end
+end
+
+describe Saucy::Kiss::ControllerFilters do
+  let(:km) { stub('kissmetrics client', :identify => true) }
+  let(:account) { stub('account', :id => 12345) }
+
+  let(:controller_class) do
+    Class.new(FakeController) do
+      include Saucy::Kiss::ControllerFilters
+    end
+  end
+
+  let(:controller) { controller_class.new(km) }
+
+  it "includes #identify_to_kissmetrics as a before_filter" do
+    controller_class.before_filters.should == [:identify_to_kissmetrics]
+  end
+
+  it "hides the #identify_to_kissmetrics method" do
+    controller_class.hidden_actions.should == [:identify_to_kissmetrics]
+  end
+
+  it "sets identity based on the account if there is a current_account when there is a current_account" do
+    controller.stub(:current_account => account)
+    km.should_receive(:identify).with("account-12345")
+    controller.identify_to_kissmetrics
+  end
+
+  it "clears identity when there is not a current_account" do
+    controller.stub(:current_account => nil)
+    km.should_receive(:identify).with(nil)
+    controller.identify_to_kissmetrics
+  end
+end

metadata

@@ -2,7 +2,7 @@
 name: saucy-kiss
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors: 
 - Jason Morrison
@@ -123,10 +123,10 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.rdoc
 files: 
-- lib/saucy/kiss/controller_identity_filter.rb
+- lib/saucy/kiss/controller_filters.rb
 - lib/saucy/kiss/observer.rb
 - lib/saucy-kiss.rb
-- spec/saucy/kiss/controller_identity_filter_spec.rb
+- spec/saucy/kiss/controller_filters_spec.rb
 - spec/saucy/kiss/observer_spec.rb
 - spec/spec_helper.rb
 - spec/support/rails_env.rb

data/lib/saucy/kiss/controller_identity_filter.rb

@@ -1,13 +0,0 @@
-module Saucy
-  module Kiss
-    class ControllerIdentityFilter
-      def self.filter(controller)
-        if controller.current_account
-          controller.km.identify("account-#{controller.current_account.id}")
-        else
-          controller.km.identify(nil)
-        end
-      end
-    end
-  end
-end

data/spec/saucy/kiss/controller_identity_filter_spec.rb

@@ -1,27 +0,0 @@
-require 'spec_helper'
-
-describe Saucy::Kiss::ControllerIdentityFilter do
-  let(:km) { stub('kissmetrics client', :identify => true) }
-  let(:account) { stub('account', :id => 12345) }
-
-  context "when there is a current_account" do
-    let(:controller) { stub('controller', :km => km, :current_account => account) }
-
-    it "sets identity based on the account if there is a current_account" do
-      controller.should_receive(:km).with()
-      km.should_receive(:identify).with("account-12345")
-
-      Saucy::Kiss::ControllerIdentityFilter.filter(controller)
-    end
-  end
-
-  context "when there is not a current_account" do
-    let(:controller) { stub('controller', :km => km, :current_account => nil) }
-
-    it "clears identity" do
-      controller.should_receive(:km).with()
-      km.should_receive(:identify).with(nil)
-      Saucy::Kiss::ControllerIdentityFilter.filter(controller)
-    end
-  end
-end