kissmetrics 0.0.1

data/.document

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,15 @@
+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 "rspec", "~> 2.3.0"
+  gem "yard", "~> 0.6.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.2"
+  gem "rcov", ">= 0"
+  gem "webmock", "~> 1.6.2"
+end

data/Gemfile.lock

@@ -0,0 +1,36 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.2.6)
+    crack (0.1.8)
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    jeweler (1.6.2)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.9.1)
+    rcov (0.9.9)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    webmock (1.6.4)
+      addressable (~> 2.2, > 2.2.5)
+      crack (>= 0.1.7)
+    yard (0.6.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.2)
+  rcov
+  rspec (~> 2.3.0)
+  webmock (~> 1.6.2)
+  yard (~> 0.6.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Jason Morrison
+
+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,26 @@
+= kissmetrics
+
+This is a very simple wrapper around the KISSmetrics HTTP API: http://support.kissmetrics.com/apis/specifications
+
+== Usage
+
+  kissmetrics = Kissmetrics.new('api-key-here')
+  kissmetrics.identify('user_identity')
+  kissmetrics.alias('old_identity', 'new_identity')
+  kissmetrics.set({ 'some property' => 'some value', 'another property' => 'another value' })
+  kissmetrics.record('action', { 'Property' => 'Value' })
+
+== Contributing to kissmetrics
+
+* 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 Jason Morrison. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,42 @@
+# 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'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "kissmetrics"
+  gem.homepage = "http://github.com/jasonm/kissmetrics"
+  gem.license = "MIT"
+  gem.summary = "A simple, clean wrapper around the KISSmetrics HTTP API"
+  gem.description = "Use the KISSmetrics HTTP API to identify and alias users, track events, and set properties."
+  gem.email = "jmorrison@thoughtbot.com"
+  gem.authors = ["Jason Morrison"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/kissmetrics.gemspec

@@ -0,0 +1,66 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{kissmetrics}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jason Morrison"]
+  s.date = %q{2011-06-02}
+  s.description = %q{Use the KISSmetrics HTTP API to identify and alias users, track events, and set properties.}
+  s.email = %q{jmorrison@thoughtbot.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "kissmetrics.gemspec",
+    "lib/kissmetrics.rb",
+    "spec/kissmetrics_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/jasonm/kissmetrics}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{A simple, clean wrapper around the KISSmetrics HTTP API}
+
+  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<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<yard>, ["~> 0.6.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<webmock>, ["~> 1.6.2"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<yard>, ["~> 0.6.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<webmock>, ["~> 1.6.2"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<yard>, ["~> 0.6.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<webmock>, ["~> 1.6.2"])
+  end
+end
+

data/lib/kissmetrics.rb

@@ -0,0 +1,60 @@
+require 'net/http'
+require 'net/https'
+require 'cgi'
+
+class Kissmetrics
+  attr_reader :api_key
+
+  def initialize(api_key)
+    @api_key = api_key
+  end
+
+  def identify(identity)
+    @identity = identity
+  end
+
+  def record(event, properties={})
+    request('/e', properties.merge({
+      '_n' => event
+    }))
+  end
+
+  def alias(old_identity, new_identity)
+    request('/a', {
+      '_p' => old_identity,
+      '_n' => new_identity
+    })
+  end
+
+  def set(properties)
+    request('/s', properties)
+  end
+
+  private
+
+  def host
+    'trk.kissmetrics.com'
+  end
+
+  def port
+    443
+  end
+
+  def request(path, params)
+    http = Net::HTTP.new(host, port)
+    http.use_ssl = true
+    http.get("#{path}?#{query_string(params)}")
+  end
+
+  def query_string(params)
+    query = params.clone
+    query['_k'] = @api_key
+    query['_p'] = @identity if @identity
+
+    hash_to_query_string(query)
+  end
+
+  def hash_to_query_string(hash)
+    hash.collect { |k,v| "#{k}=#{CGI.escape(v.to_s)}" }.join('&')
+  end
+end

data/spec/kissmetrics_spec.rb

@@ -0,0 +1,111 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Kissmetrics, "class" do
+  it "is constructed with an API key" do
+    Kissmetrics.new("my-api-key").api_key.should == "my-api-key"
+  end
+end
+
+describe Kissmetrics, "events" do
+  subject { Kissmetrics.new("my-api-key") }
+
+  before do
+    stub_request(:get, %r{https://trk.kissmetrics.com/e}).to_return(:body => "")
+  end
+
+  it "records events without properties" do
+    subject.record('Signed Up')
+    WebMock.should have_requested(:get, "https://trk.kissmetrics.com/e").with({
+      :query => {
+        :_k => 'my-api-key',
+        :_n => 'Signed Up'
+      }
+    })
+  end
+
+  it "records events with properties" do
+    subject.record('Signed Up', { 'Plan' => 'Medium', 'Duration' => 'Year' })
+    WebMock.should have_requested(:get, "https://trk.kissmetrics.com/e").with({
+      :query => {
+        :_k        => 'my-api-key',
+        :_n        => 'Signed Up',
+        'Plan'     => 'Medium',
+        'Duration' => 'Year'
+      }
+    })
+  end
+
+  it "includes identity when recording an event" do
+    subject.identify('user@example.com')
+    subject.record('Signed Up', { 'Plan' => 'Medium', 'Duration' => 'Year' })
+    WebMock.should have_requested(:get, "https://trk.kissmetrics.com/e").with({
+      :query => {
+        :_k        => 'my-api-key',
+        :_n        => 'Signed Up',
+        :_p        => 'user@example.com',
+        'Plan'     => 'Medium',
+        'Duration' => 'Year'
+      }
+    })
+  end
+end
+
+describe Kissmetrics, "aliasing" do
+  before do
+    stub_request(:get, %r{https://trk.kissmetrics.com/a}).to_return(:body => "")
+  end
+
+  subject { Kissmetrics.new("my-api-key") }
+
+  it "aliases a person" do
+    subject.alias('old_identity', 'new_identity')
+
+    WebMock.should have_requested(:get, "https://trk.kissmetrics.com/a").with({
+      :query => {
+        :_k => 'my-api-key',
+        :_p => 'old_identity',
+        :_n => 'new_identity'
+      }
+    })
+  end
+end
+
+describe Kissmetrics, "setting properties" do
+  before do
+    stub_request(:get, %r{https://trk.kissmetrics.com/s}).to_return(:body => "")
+  end
+
+  subject { Kissmetrics.new("my-api-key") }
+
+  it "sets properties when unidentified" do
+    subject.set({
+      'Button color'     => 'Blue',
+      'Background color' => 'Gray'
+    })
+
+    WebMock.should have_requested(:get, "https://trk.kissmetrics.com/s").with({
+      :query => {
+        :_k                => 'my-api-key',
+        'Button color'     => 'Blue',
+        'Background color' => 'Gray'
+      }
+    })
+  end
+
+  it "sets properties when identified" do
+    subject.identify('user@example.com')
+    subject.set({
+      'Button color'     => 'Blue',
+      'Background color' => 'Gray'
+    })
+
+    WebMock.should have_requested(:get, "https://trk.kissmetrics.com/s").with({
+      :query => {
+        :_k                => 'my-api-key',
+        :_p                => 'user@example.com',
+        'Button color'     => 'Blue',
+        'Background color' => 'Gray'
+      }
+    })
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'kissmetrics'
+require 'webmock/rspec'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.before do
+    WebMock.disable_net_connect!
+  end
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification 
+name: kissmetrics
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jason Morrison
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-02 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: yard
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.6.2
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: webmock
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.6.2
+  type: :development
+  prerelease: false
+  version_requirements: *id006
+description: Use the KISSmetrics HTTP API to identify and alias users, track events, and set properties.
+email: jmorrison@thoughtbot.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- kissmetrics.gemspec
+- lib/kissmetrics.rb
+- spec/kissmetrics_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/jasonm/kissmetrics
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 970554408361776796
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: A simple, clean wrapper around the KISSmetrics HTTP API
+test_files: []
+