saucy-kiss 0.2.3 → 0.2.4

data/CHANGELOG.md

@@ -1,6 +1,12 @@
-0.2.3
+0.2.4
 
-Use snogmetrics 0.1.9, fix to correctly use KM JS property syntax.
+Fix file list in gemspec.
+
+0.2.3 (not on Gemcutter)
+
+Added events:
+* Viewed Plan List (called by Saucy's PlansController)
+* Activated
 
 0.2.2
 

data/{README.rdoc → README.md}

@@ -1,11 +1,11 @@
-= saucy-kiss
+# saucy-kiss
 
 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
+It depends on [the unofficial KISSmetrics gem](http://rubygems.org/gems/kissmetrics).
 
-== Features and assumptions
+## Features and assumptions
 
 We assume that:
 
@@ -16,22 +16,28 @@ We assume that:
   advantage of KISSmetrics' anonymous identity tracking, automatic handling
   of the "Visited Site" metric, bot/crawler blacklisting, etc.
 
-== Supported events
+## Supported events
 
-Saucy-kiss records all the KISSmetrics SaaS events http://support.kissmetrics.com/apis/saas_events:
+Saucy-kiss records all the [KISSmetrics SaaS events](http://support.kissmetrics.com/apis/saas_events):
 
 * Visited Site (handled automatically by the KISSmetrics JS library)
 * Signed Up
-* Upgraded / Downgraded (distinguised by plan price)
+* Upgraded / Downgraded (distinguished by plan price)
 * Billed
 * Canceled
+* Activated
+  * Called the first time that account.activated is set to true. It should be set once you are providing value to the user, so
+    for Trajectory this might be when the user creates their first story, while
+    for Copycopter an account might be activated once the user is syncing data to the client.
+* Viewed Plan (plan_viewed)
+* Viewed Plan List (plan_list_viewed)
+  * Called by Saucy's PlansController
 
-== Future work
+
+## Future work
 
 TODO: Additional events provided by Saucy:
 
-* Viewed Plan List
-* Viewed Plan
 * Invited New User
 * Accepted Invite
 * Tried to Exceed Project Limit
@@ -43,28 +49,28 @@ TODO: And events provided by Clearance:
 
 TODO: Examples of additional meta-events?:
 
-* Give example of Visit Retention (>1 signins per month with a Visit model and Clearance instrumentation)
+* Give example of Visit Retention (> 1 signins per month with a Visit model and Clearance instrumentation)
 
-== Identity
+## Identity
 
-It will identify users to the current account where ever possible, and as anonymous
-otherwise.  KISSmetrics will correctly handling aliasing between anonymous and
+It will identify users to the current account wherever possible, and as anonymous
+otherwise.  KISSmetrics will correctly handle aliasing between anonymous and
 named identities, and distinguishing between successive named identites, such as
-when you switch accounts.  For more information, see: 
+when you switch accounts.  For more information, see:
 
 http://support.kissmetrics.com/advanced/identity-management
 
-== Installation
+## Installation
 
 In your Gemfile:
 
-  gem "saucy-kiss"
+    gem "saucy-kiss"
 
 Then:
 
-  $ bundle
+    $ bundle
 
-== Implementation in your application
+## Implementation in your application
 
 Add an initializer in config/initializers/saucy_kiss.rb:
 
@@ -86,30 +92,19 @@ Emit KISSmetrics javascript into your view (note the %== or equivalent #html_saf
 The KISSmetrics javascript is asynchronous, so it's safe to load at the top of
 your page.
 
-Configure Snogmetrics separately in config/initializers/snogmetrics.rb:
-(eventually this should be handled by saucy-kiss automatically)
-
-  module Snogmetrics
-    def output_strategy
-      case Rails.env.to_s
-      when 'development'
-        :console_log
-      when 'test'
-        :array
-      else
-        :live
-      end
-    end
+Note: Saucy::Kiss will automatically instantiate the Snogmetrics gem like this:
 
-    def kissmetrics_api_key
-      {
-        'staging'    => 'abc123',
-        'production' => 'def456'
-      }[Rails.env]
-    end
-  end
+    api_key = Saucy::Kiss::API_KEYS[Rails.env]
+    session = data[:request].session
+    Snogmetrics::KissmetricsApi.new(api_key, session, snogmetrics_output_strategy)
+    # snogmetrics_output_strategy returns :console_log in development, :array in test, and
+    # :live otherwise.
+
+and the Kissmetrics gem like this:
 
-== Customization
+    Kissmetrics::HttpClient.new(Saucy::Kiss::API_KEYS[Rails.env])
+
+## Customization
 
 You may like to customize the events delivered to KISSmetrics.  For example,
 you may want to track the referring ad campaign in a Signed Up event.
@@ -129,13 +124,13 @@ create a subclass of the observer and register it instead:
     end
 
     Rails.configuration.after_initialize do
-      Saucy::Notifications.register_observer(M)yAppObserver.new({
+      Saucy::Notifications.register_observer(MyAppObserver.new({
         'staging'    => 'abc123',
         'production' => 'def456'
       }[Rails.env]))
     end
 
-== How it works
+## How it works
 
 Saucy accepts observers in its configuration and publishes events for the
 SaaS events it implements.  This gem implements an observer for these events,
@@ -152,7 +147,7 @@ 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
+## 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
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
@@ -162,8 +157,7 @@ request/response cycle (think billing callbacks, or queued operations) delivered
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
-== Copyright
+## Copyright
 
 Copyright (c) 2011 Jason Morrison. See LICENSE.txt for
 further details.
-

data/lib/saucy/kiss/observer.rb

@@ -16,6 +16,10 @@ module Saucy
         })
       end
 
+      def plan_list_viewed(data)
+        javascript_client(data).record('Viewed Plan List')
+      end
+
       def account_created(data)
         javascript_client(data).record('Signed Up', {
           'Plan Name' => data[:account].plan.name,
@@ -43,8 +47,7 @@ module Saucy
       end
 
       def billed(data)
-        account_identifier = "account-#{data[:account].id}"
-        http_client.record(account_identifier, 'Billed', {
+        http_client.record(account_identifier(data), 'Billed', {
           'Billing Description' => "Monthly billing for #{data[:account].plan.name} plan",
           'Billing Amount' => data[:account].plan.price
         })
@@ -59,6 +62,15 @@ module Saucy
         })
       end
 
+      def activated(data)
+        plan = data[:account].plan
+        http_client.record(account_identifier(data), 'Activated', {
+          'Plan Name' => plan.name,
+          'Plan Price' => plan.price,
+          'Is Trial Plan?'=> plan.trial
+        })
+      end
+
       private
 
       def javascript_client(data)
@@ -76,6 +88,10 @@ module Saucy
         end
       end
 
+      def account_identifier(data)
+        "account-#{data[:account].id}"
+      end
+
       def http_client
         Kissmetrics::HttpClient.new(@api_key)
       end

data/spec/saucy/kiss/observer_spec.rb

@@ -70,6 +70,13 @@ describe Saucy::Kiss::Observer do
     subject.plan_viewed(:request => request, :plan => small_plan)
   end
 
+  it "records a Viewed Plan List event through the KISSmetrics JS API for #plan_list_viewed" do
+    javascript_client.should_receive(:record).
+      with('Viewed Plan List')
+
+    subject.plan_list_viewed(:request => request, :account => account)
+  end
+
   it "records a Signed Up event through the KISSmetrics JS API for #account_created" do 
     javascript_client.should_receive(:record).
       with('Signed Up', { 'Plan Name' => 'Small', 'Plan Price' => 10, 'Is Trial Plan?' => false })
@@ -109,4 +116,15 @@ describe Saucy::Kiss::Observer do
 
     subject.canceled(:request => request, :account => account)
   end
+
+  it "records an Activated event through the KISSmetrics HTTP API for #activated" do
+    Kissmetrics::HttpClient.should_receive(:new).
+      with('abc123')
+
+    account_identity = "account-#{account.id}"
+    http_client.should_receive(:record).
+      with(account_identity, 'Activated', { 'Plan Name' => 'Small', 'Plan Price' => 10, 'Is Trial Plan?' => false })
+
+    subject.activated(:request => request, :account => account)
+  end
 end

metadata

@@ -1,128 +1,124 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: saucy-kiss
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.2.4
   prerelease: 
-  version: 0.2.3
 platform: ruby
-authors: 
+authors:
 - Jason Morrison
 - Ben Orenstein
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-06-27 00:00:00 -04:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-06-27 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rspec
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2152828000 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 2.3.0
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: yard
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2152828000
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &2152824980 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 0.6.0
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: bundler
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *2152824980
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2152822880 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: jeweler
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *2152822880
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &2152821420 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 1.6.2
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: rcov
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *2152821420
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &2152819820 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: activesupport
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: *2152819820
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &2152818800 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "3.0"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :development
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  name: kissmetrics
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  version_requirements: *2152818800
+- !ruby/object:Gem::Dependency
+  name: kissmetrics
+  requirement: &2152816040 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 1.0.2
   type: :runtime
-  version_requirements: *id007
-- !ruby/object:Gem::Dependency 
-  name: snogmetrics
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  version_requirements: *2152816040
+- !ruby/object:Gem::Dependency
+  name: snogmetrics
+  requirement: &2152812600 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: 0.1.9
+      - !ruby/object:Gem::Version
+        version: 0.1.8
   type: :runtime
-  version_requirements: *id008
-- !ruby/object:Gem::Dependency 
-  name: saucy
   prerelease: false
-  requirement: &id009 !ruby/object:Gem::Requirement 
+  version_requirements: *2152812600
+- !ruby/object:Gem::Dependency
+  name: saucy
+  requirement: &2152808420 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 0.10.0
   type: :runtime
-  version_requirements: *id009
+  prerelease: false
+  version_requirements: *2152808420
 description: Record Saucy SaaS events to KISSmetrics
 email: jason.p.morrison@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE.txt
-- README.rdoc
-files: 
+- README.md
+files:
 - lib/saucy/kiss/controller_filters.rb
 - lib/saucy/kiss/observer.rb
 - lib/saucy-kiss.rb
@@ -132,36 +128,32 @@ files:
 - spec/support/rails_env.rb
 - Gemfile
 - LICENSE.txt
-- README.rdoc
+- README.md
 - CHANGELOG.md
 - Rakefile
-has_rdoc: true
 homepage: http://github.com/jasonm/saucy-kiss
-licenses: 
+licenses:
 - MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.8
 signing_key: 
 specification_version: 3
 summary: Record Saucy SaaS events to KISSmetrics
 test_files: []
-