lascivious 0.1.0 → 1.0.1

data/CHANGELOG.md

@@ -0,0 +1,62 @@
+### dev
+[full changelog](http://github.com/Cloudability/lascivious/compare/v1.0.1...master)
+
+
+### v1.0.1
+[full changelog](http://github.com/Cloudability/lascivious/compare/v1.0.0...v1.0.1)
+
+Fixes
+
+* Forgot to update changelog.
+
+
+### v1.0.0
+[full changelog](http://github.com/Cloudability/lascivious/compare/v0.1.0...v1.0.0)
+
+Fixes
+
+* Overhaul documentation.
+* Remove cruft.
+* Change how we use Jeweler to update the gem
+
+
+### v0.1.0
+[full changelog](http://github.com/Cloudability/lascivious/compare/v0.1.0.pre6...v0.1.0)
+
+Fixes
+
+* Fix references to `KissMetrics` class in documentation.
+* Loosen `RubyGems` requirement.
+
+
+### v0.1.0.pre6
+[full changelog](http://github.com/Cloudability/lascivious/compare/v0.1.0.pre5...v0.1.0.pre6)
+
+Fixes
+
+* Fix one last reference to `KissMetrics` class.
+
+
+### v0.1.0.pre5
+[full changelog](http://github.com/Cloudability/lascivious/compare/v0.1.0.pre4...v0.1.0.pre5)
+
+Fixes
+
+* Turn this into a proper Rails Engine to fix missing partials issue.
+* Fix a few more `KissMetrics` references.
+
+
+### v0.1.0.pre4
+[full changelog](http://github.com/Cloudability/lascivious/compare/v0.1.0.pre3...v0.1.0.pre4)
+
+Fixes
+
+* Fix a few more `KissMetrics` references.
+
+
+### v0.1.0.pre3
+[full changelog](http://github.com/Cloudability/lascivious/compare/v0.1.0.pre2...v0.1.0.pre3)
+
+Fixes
+
+* Fix loading order-of-operations issue.

data/{LICENSE.txt → LICENSE}

@@ -1,3 +1,5 @@
+(The MIT License)
+
 Copyright (c) 2011 Cloudability Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining

data/README.md

@@ -0,0 +1,269 @@
+# Lascivious
+
+This plugin simplifies the use of KISSmetrics with Rails.
+
+KISSmetrics 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.
+
+
+## Instructions
+
+1. Install the gem by adding it to your Gemfile
+2. Add an initializer in `config/initializers/kiss_metrics.rb` like:
+
+```ruby
+Lascivious.setup do |config|
+  config.api_key = "0000000000000000000000000000000000000000"
+end
+```
+
+3. Replace the zeroes with your API key from <https://www.kissmetrics.com/settings>
+4. Add `kiss_metrics_tag` to whichever layouts you want to use KISSmetrics
+with, usually all of them, e.g. here's what our header partial looks like:
+
+```erb
+<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 KISSmetricss tags in controllers or views wherever you need something. For instance:
+
+```ruby
+class SomeController < ApplicationController
+  def index
+    kiss_record "SomeController loaded"
+  end
+end
+```
+
+Currently the following commands are provided:
+
+* `kiss_set <message>` - adds a 'set' event, e.g. 'country: uk'
+* `kiss_identify <user_id>` - adds an 'identity' event, associating the given
+  user ID with the KISSmetrics identifier.
+* `kiss_alias <value>` - adds an 'alias' event (weak identifier), e.g. user_id from a tracking cookie that may or may not be on a shared machine
+* `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'
+
+
+## How to Integrate with your app
+
+Our service is built on Rails 3 with Devise and Inherited Resources. This is
+how we integrated KISSmetricss into our app.
+
+### Everywhere
+
+In all cases add this to the HEAD of your layouts:
+
+```erb
+<%= kiss_metrics_tag %>
+```
+
+And define your keys via an initializer in `app/config/initializers/kiss_metrics.rb`
+like this:
+
+```ruby
+Lascivious.setup do |config|
+  if Rails.env == 'production'
+    config.api_key = ENV['KISS_METRICS_API_KEY']
+  else
+    # Development/testing/staging account key...
+    config.api_key = "1111111111111111111111111111111111111111"
+  end
+end
+```
+
+### 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`:
+
+```ruby
+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`:
+
+```ruby
+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
+```
+
+### Sign Out
+
+We added this to `app/controllers/application_controller.rb`:
+
+```ruby
+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.
+
+### Email Open
+
+Our Mailers typically look like this:
+
+```ruby
+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:
+
+```erb
+... our email ERB 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.
+
+### General Activity
+
+You get this for free on every page where you have included the
+`kiss_metrics_tag` included in your layout.
+
+### Identity
+
+See the `kiss_identify` tag 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.
+
+### 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:
+
+```ruby
+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.
+
+### Development vs Production
+
+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 above for a template.
+
+### Other Stuff
+
+You can add other events to your app by simply stating:
+
+```ruby
+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
+KISSmetricss really easily, with no setup required on the KM side.
+
+See the API section for more details on what tools you have for doing this.
+
+
+## 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-2012 Cloudability Inc.
+
+See LICENSE for further details.
+

data/lascivious.gemspec

@@ -4,59 +4,42 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{lascivious}
-  s.version = "0.1.0"
+  s.name = "lascivious"
+  s.version = "1.0.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Mat Ellis"]
-  s.date = %q{2011-09-14}
-  s.description = %q{Easy interface between Rails & Javascript for Kiss Metrics}
-  s.email = %q{support@cloudability.com}
+  s.authors = ["Mat Ellis", "Jon Frisby"]
+  s.date = "2012-08-14"
+  s.description = "Easy interface between Rails & Javascript for KISSmetrics"
+  s.email = "support@cloudability.com"
   s.extra_rdoc_files = [
-    "LICENSE.txt",
-    "README.rdoc"
+    "CHANGELOG.md",
+    "LICENSE",
+    "README.md"
   ]
   s.files = [
-    ".document",
-    "Gemfile",
-    "Gemfile.lock",
-    "LICENSE.txt",
-    "README.rdoc",
-    "Rakefile",
+    "CHANGELOG.md",
+    "LICENSE",
+    "README.md",
     "app/views/lascivious/_email_beacon.html.erb",
     "app/views/lascivious/_header.html.erb",
     "lascivious.gemspec",
     "lib/engine.rb",
-    "lib/lascivious.rb",
-    "lib/version.rb",
-    "test/helper.rb",
-    "test/test_lascivious.rb"
+    "lib/lascivious.rb"
   ]
-  s.homepage = %q{https://github.com/cloudability/lascivious}
+  s.homepage = "https://github.com/cloudability/lascivious"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.6.2}
-  s.summary = %q{Easy Kiss Metrics integration for Rails}
+  s.rubygems_version = "1.8.24"
+  s.summary = "Easy KISSmetrics integration for Rails"
 
   if s.respond_to? :specification_version then
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<shoulda>, [">= 0"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
-      s.add_development_dependency(%q<rcov>, [">= 0"])
     else
-      s.add_dependency(%q<shoulda>, [">= 0"])
-      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
-      s.add_dependency(%q<rcov>, [">= 0"])
     end
   else
-    s.add_dependency(%q<shoulda>, [">= 0"])
-    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
-    s.add_dependency(%q<rcov>, [">= 0"])
   end
 end
 

data/lib/lascivious.rb

@@ -1,23 +1,23 @@
 require 'engine'
 
 module Lascivious
-  
+
   # API key for Kiss Metrics. Available via https://www.kissmetrics.com/settings
   mattr_accessor :api_key
   @@api_key = ""
   ::ActionView::Base.send(:include, Lascivious)
   ::ActionController::Base.send(:include, Lascivious)
-  
+
   # For use in config so we can do Lascivious.setup
   def self.setup
     yield self
   end
-  
+
   # The main kiss metrics javascript & stuff
   def kiss_metrics_tag
     render :partial => "lascivious/header"
   end
-  
+
   # The email beacon
   def kiss_metrics_email_beacon(email_address, variation, event_type = "Opened Email")
     render :partial => "lascivious/email_beacon", :locals => {
@@ -27,7 +27,7 @@ module Lascivious
       :variation => variation
     }
   end
-  
+
   # Flash for all kiss metrics
   def kiss_metrics_flash
     messages = flash[:kiss_metrics]
@@ -45,30 +45,30 @@ module Lascivious
   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
 
-  # 
+  # Record an arbitrary event-type and its value.
   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 Lascivious.api_key
   end
-end
+end

metadata

@@ -1,84 +1,34 @@
 --- !ruby/object:Gem::Specification
 name: lascivious
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
 - Mat Ellis
+- Jon Frisby
 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: &70221463513840 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *70221463513840
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: &70221463512940 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :development
-  prerelease: false
-  version_requirements: *70221463512940
-- !ruby/object:Gem::Dependency
-  name: jeweler
-  requirement: &70221463511900 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.6.4
-  type: :development
-  prerelease: false
-  version_requirements: *70221463511900
-- !ruby/object:Gem::Dependency
-  name: rcov
-  requirement: &70221463485940 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *70221463485940
-description: Easy interface between Rails & Javascript for Kiss Metrics
+date: 2012-08-14 00:00:00.000000000 Z
+dependencies: []
+description: Easy interface between Rails & Javascript for KISSmetrics
 email: support@cloudability.com
 executables: []
 extensions: []
 extra_rdoc_files:
-- LICENSE.txt
-- README.rdoc
+- CHANGELOG.md
+- LICENSE
+- README.md
 files:
-- .document
-- Gemfile
-- Gemfile.lock
-- LICENSE.txt
-- README.rdoc
-- Rakefile
+- CHANGELOG.md
+- LICENSE
+- README.md
 - app/views/lascivious/_email_beacon.html.erb
 - app/views/lascivious/_header.html.erb
 - lascivious.gemspec
 - lib/engine.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
@@ -94,7 +44,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1716301593935205180
+      hash: 2788297189396306074
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -103,8 +53,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Easy Kiss Metrics integration for Rails
+summary: Easy KISSmetrics integration for Rails
 test_files: []

data/.document

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

data/Gemfile

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

@@ -1,20 +0,0 @@
-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/README.rdoc

@@ -1,218 +0,0 @@
-= 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:
-
-    Lascivious.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:
-
-    Lascivious.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

@@ -1,53 +0,0 @@
-# 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/lib/version.rb

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

data/test/helper.rb

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

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