lascivious 0.1.0.pre2

data/.document

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

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,20 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.9.2)
+    rcov (0.9.9)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  rcov
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Cloudability Inc.
+
+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.rdoc

@@ -0,0 +1,218 @@
+= Lascivious
+
+This plugin simplifies the use of Kiss Metrics with Rails.
+
+Kiss Metrics really works best with Javascript. The problem is that in Rails the best place to decide whether to fire off an event is inside a Controller.
+
+Using a flash mechanism this plugin provides a series of helper functions to allow your Controller to inject the correct Javascript into any page.
+
+It's a work-in-progress right now and is pretty dumb: you have to RTFM on when to insert what. We will probably extend functionality to handle aliasing and strong typing of users.
+
+
+== Instructions
+
+1. Install the gem by adding it to your Gemfile
+2. Add an initializer in `config/initializers/kiss_metrics.rb` like:
+
+    KissMetrics.setup do |config|
+      config.api_key="0000000000000000000000000000000000000000"
+    end
+
+3. Replace the zeroes with your API key from https://www.kissmetrics.com/settings
+4. Add the kiss metrics tag to whichever layouts you want to use Kiss Metrics with, usually all of them, e.g. here's what our header partial looks like:
+
+    <title><%= title %></title>
+    <%= csrf_meta_tag %>
+    <link rel="image_src" href="/images/facebook-icon.png"/>
+    <%= kiss_metrics_tag %>
+    
+5. Now all you have to do is add Kiss Metrics tags in controllers or views wherever you need something. For instance:
+
+    class SomeController < ApplicationController
+      def index
+        kiss_record "SomeController loaded"
+      end
+    end
+
+Currently the following commands are provided:
+
+- `kiss_record <message>` - adds a 'record' event with a message of 'message'
+- `kiss_metric <event_type> <message>` - adds an event of type 'event_type' with a message of 'message'
+
+We will soon add helpers for things like `kiss_alias`, etc.
+
+
+== How to Integrate with your app
+
+Our service is built on Rails 3 with Devise and Inherited Resources. This is how we integrated Kiss Metrics into our app.
+
+0. Everywhere
+
+In all cases add this to the HEAD of your layouts:
+
+    <%= kiss_metrics_tag %>
+    
+And define your keys via an initializer in `app/config/initializers/kiss_metrics.rb` like this:
+
+    KissMetrics.setup do |config|
+      if Rails.env == 'production'
+        config.api_key="2222222222222222222222222222222222222222"
+      else
+        config.api_key="1111111111111111111111111111111111111111"
+      end
+    end
+
+
+1. Sign In
+
+We use a Controller override in Devise as we want to handle a failed login very specifically. So we have in `app/controllers/users/sessions_controller.rb`:
+
+    class Users::SessionsController < Devise::SessionsController
+      def create
+        warden_opts = { :scope => resource_name, :recall => "#{controller_path}#new" }
+        resource = warden.authenticate(warden_opts)
+        if(resource.nil?)
+          kind = :invalid
+          resource = build_resource
+          resource.errors[:base] = I18n.t("#{resource_name}.#{kind}", {
+            scope: "devise.failure",
+            default: [kind],
+            resource_name: resource_name
+          })
+        else
+          kiss_identify resource.email
+          kiss_record "Signed In"
+          set_flash_message(:notice, :signed_in) if is_navigational_format?
+          sign_in(resource_name, resource)
+        end
+        respond_with resource, :location => redirect_location(resource_name, resource)
+      end
+    end
+
+A much simpler version would be an `after_sign_in_path_for` override in `app/controllers/application_controller.rb`:
+
+    private
+
+    def after_sign_in_path_for(resource_or_scope)
+      kiss_identify resource_or_scope.email unless resource_or_scope.email.nil?
+      kiss_record "Signed In"
+      scope = Devise::Mapping.find_scope!(resource_or_scope)
+      home_path = "#{scope}_root_path"
+      respond_to?(home_path, true) ? send(home_path) : root_path
+    end
+
+2. Sign Out
+
+We added this to `app/controllers/application_controller.rb`:
+
+    private
+
+    # Record a sign out
+    def after_sign_out_path_for(resource_or_scope)
+      kiss_record "Signed Out"
+      new_user_session_path
+    end
+    
+The `new_user_session_path` is important: if you redirect to `root_path` you will be redirected to the login page (as your user will now fail authorization) and in the process your flash will be wiped clear.
+
+3. Email Open
+
+Our Mailers typically look like this:
+
+    def send_mail(user, recipient, bill_period, subject)
+      @recipient ||= user
+      @user = user
+      @bill_period = bill_period
+      @data = collate(@user, @bill_period)
+
+      mail({
+        to: formatted_address(@user, @recipient),
+        subject: subject
+      })
+    end
+    
+The @recipient variable is important to us, it allows us to send an email even if we don't have a user setup. 
+
+Now inside the email partial we do:
+
+    ... our email ERB or HAML template ...
+      <%= kiss_metrics_email_beacon @recipient.email, "Summary" %>
+    </body>
+    </html>
+
+Points to note here:
+- This only works inside HTML emails and even then not all the time. If this doesn't make sense to you go Google 'email pixels' or 'email beacons'
+- Change "Summary" to be whichever email variant you have, it could be 'Welcome Email' or 'Bill Reminder', etc.
+- We've put the kiss_metrics_email_beacon at the bottom of the email, right before the closing BODY tag. This reduces the chance the pixel kills your layout and means the open is only triggered if the email is properly downloaded and parsed.
+
+4. General Activity
+
+You get this for free on every page where you have included the `kiss_metrics_tag` included in your layout.
+
+5. Identity
+
+See the kiss_identify tag in section 1 above. We use the email address but you could use a hash of this or the user record ID if you don't want to put the email address inside a page. We prefer the email address (it's easier to understand what's happening on a user by user basis) but some folks don't like to put an email address inside a web page.
+
+6. Activation & Sign Up
+
+This gets a bit awkward. We have an 'invite' model that is a bit unusual. Without going into the details this is what the controller looks like:
+
+    class InvitesController < InheritedResources::Base
+      respond_to :html
+      actions :new, :create
+
+      def new
+        new! do
+          kiss_record "Activated"
+        end
+      end
+
+      def create
+        create! do |success, failure|
+          success.html do
+            kiss_record "Signed Up"
+            sign_in(@invite.user)
+            kiss_identify current_user.email
+            redirect_to first_page_in_your_post_sign_up_path
+          end
+        end
+      end
+    end
+
+Beyond this you're on your own here, sorry.
+
+7. Dev vs Prod
+
+If you don't setup two sites - one for prod and the other for dev - your Prod site will get polluted with your dev work. Or you can simply disable it. See the example in step 0 above for a template.
+
+8. Other Stuff
+
+You can add other events to your app by simply stating:
+
+    kiss_record "Some Other Event"
+    
+You might want to record for instance the first time someone returns to your site after they have purchased your product. You can work these events into Kiss Metrics really easily, with no setup required on the KM side.
+
+Lascivious also supports:
+
+- kiss_set(value)
+- kiss_identify(value)
+- kiss_alias(value)
+- kiss_metric(event_type, value)
+
+
+== Contributing to lascivious
+ 
+* 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
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* 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 (c) 2011 Cloudability Inc. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+require './lib/version.rb'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "lascivious"
+  gem.homepage = "https://github.com/cloudability/lascivious"
+  gem.license = "MIT"
+  gem.summary = %Q{Easy Kiss Metrics integration for Rails}
+  gem.description = %Q{Easy interface between Rails & Javascript for Kiss Metrics}
+  gem.email = "support@cloudability.com"
+  gem.authors = ["Mat Ellis"]
+  gem.version = Lascivious::Version::STRING
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "lascivious #{Lascivious::Version::STRING}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/app/views/lascivious/_email_beacon.html.erb

@@ -0,0 +1 @@
+<img src="https://trk.kissmetrics.com/e?_k=<%= kiss_metrics_api_key %>&_n=<%= event_type %><% unless email.blank? -%>&_p=<%= email %><% end -%><% unless variation.blank? -%>&email_variation=<%= variation %><% end -%>"/>

data/app/views/lascivious/_header.html.erb

@@ -0,0 +1,16 @@
+<% if kiss_metrics_api_key.blank? -%>
+<!-- ERR: Kiss Metrics API key from https://www.kissmetrics.com/settings must be defined in kiss_metrics_key -->
+<% Rails.logger.warn "Missing Kiss Metrics API Key, set api key from https://www.kissmetrics.com/settings via KissMetrics.api_key" -%>
+<% else -%>
+<script type="text/javascript">
+  var _kmq = _kmq || [];
+  function _kms(u){
+    setTimeout(function(){
+      var s = document.createElement('script'); var f = document.getElementsByTagName('script')[0]; s.type = 'text/javascript'; s.async = true;
+      s.src = u; f.parentNode.insertBefore(s, f);
+    }, 1);
+  }
+  _kms('//i.kissmetrics.com/i.js');_kms('//doug1izaerwt3.cloudfront.net/<%= kiss_metrics_api_key %>.1.js');
+  <%= kiss_metrics_flash -%>
+</script>
+<% end -%>

data/init.rb

@@ -0,0 +1,3 @@
+require 'lascivious'
+::ActionView::Base.send(:include, Lascivious)
+::ActionController::Base.send(:include, Lascivious)

data/lib/lascivious.rb

@@ -0,0 +1,70 @@
+module Lascivious
+  
+  # API key for Kiss Metrics. Available via https://www.kissmetrics.com/settings
+  mattr_accessor :api_key
+  @@api_key = ""
+  
+  # For use in config so we can do KissMetrics.setup
+  def self.setup
+    yield self
+  end
+  
+  # The main kiss metrics javascript & stuff
+  def kiss_metrics_tag
+    render :partial => "kiss_metrics/header"
+  end
+  
+  # The email beacon
+  def kiss_metrics_email_beacon(email_address, variation, event_type = "Opened Email")
+    render :partial => "kiss_metrics/email_beacon", :locals => {
+      :event_type => event_type,
+      :api_key => kiss_metrics_api_key,
+      :email => email_address,
+      :variation => variation
+    }
+  end
+  
+  # Flash for all kiss metrics
+  def kiss_metrics_flash
+    messages = flash[:kiss_metrics]
+    unless messages.blank? || messages.empty?
+      return messages.map do |type_hash|
+        type_hash.map do |e|
+          %Q{_kmq.push(['#{e.first.to_s}', '#{e.last.to_s}']);}
+        end
+      end.flatten.join("\n")
+    end
+    return nil
+  end
+
+  # Trigger an event at Kiss (specific: message of event_type 'record', e.g. User Signed Up)
+  def kiss_record(value)
+    kiss_metric :record, value
+  end
+  
+  # Set values (e.g. country: uk)
+  def kiss_set(value)
+    kiss_metric :set, value
+  end
+  
+  # Strong identifier (e.g. user ID)
+  def kiss_identify(value)
+    kiss_metric :identify, value
+  end
+  
+  # Weak identifier (e.g. cookie)
+  def kiss_alias(value)
+    kiss_metric :alias, value
+  end
+
+  # 
+  def kiss_metric(event_type, value)
+    flash[:kiss_metrics] ||= []
+    flash[:kiss_metrics] << { event_type => value }
+  end
+  
+  # Get kiss metrics key
+  def kiss_metrics_api_key
+    return KissMetrics.api_key
+  end
+end

data/lib/version.rb

@@ -0,0 +1,10 @@
+class Lascivious
+  module Version
+    MAJOR = 0
+    MINOR = 1
+    PATCH = 0
+    BUILD = 'pre2'
+
+    STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')
+  end
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'lascivious'
+
+class Test::Unit::TestCase
+end

data/test/test_lascivious.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestLascivious < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: lascivious
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre2
+  prerelease: 6
+platform: ruby
+authors:
+- Mat Ellis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-14 00:00:00.000000000 -07:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: &70101459603320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70101459603320
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70101459601560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *70101459601560
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &70101459600260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *70101459600260
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &70101459598960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70101459598960
+description: Easy interface between Rails & Javascript for Kiss Metrics
+email: support@cloudability.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- app/views/lascivious/_email_beacon.html.erb
+- app/views/lascivious/_header.html.erb
+- init.rb
+- lib/lascivious.rb
+- lib/version.rb
+- test/helper.rb
+- test/test_lascivious.rb
+has_rdoc: true
+homepage: https://github.com/cloudability/lascivious
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 191209867734086694
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Easy Kiss Metrics integration for Rails
+test_files: []