kissmetrics 0.0.2 → 1.0.0

data/README.rdoc

@@ -4,11 +4,11 @@ This is a very simple wrapper around the KISSmetrics HTTP API: http://support.ki
 
 == Usage
 
-  kissmetrics = Kissmetrics.new('api-key-here')
-  kissmetrics.identify('user_identity')
+  kissmetrics = Kissmetrics::HttpClient.new('api-key-here')
   kissmetrics.alias('old_identity', 'new_identity')
-  kissmetrics.set({ 'some property' => 'some value', 'another property' => 'another value' })
-  kissmetrics.record('action', { 'Property' => 'Value' })
+  kissmetrics.set('identity', { 'some property' => 'some value', 'another property' => 'another value' })
+  kissmetrics.record('identity', 'action', { 'Property' => 'Value' })
+
 
 == Contributing to kissmetrics
 

data/VERSION

@@ -1 +1 @@
-0.0.2
+1.0.0

data/kissmetrics.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{kissmetrics}
-  s.version = "0.0.2"
+  s.version = "1.0.0"
 
   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.date = %q{2011-06-12}
   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 = [
@@ -27,7 +27,8 @@ Gem::Specification.new do |s|
     "VERSION",
     "kissmetrics.gemspec",
     "lib/kissmetrics.rb",
-    "spec/kissmetrics_spec.rb",
+    "lib/kissmetrics/http_client.rb",
+    "spec/kissmetrics/http_client_spec.rb",
     "spec/spec_helper.rb"
   ]
   s.homepage = %q{http://github.com/jasonm/kissmetrics}

data/lib/kissmetrics.rb

@@ -1,66 +1,2 @@
-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
-
-    QueryStringHash.new(query)
-  end
-
-  class QueryStringHash
-    def initialize(hash)
-      @hash = hash
-    end
-
-    def to_s
-      @hash.collect { |key, value| "#{key}=#{CGI.escape(value.to_s)}" }.join('&')
-    end
-  end
+module Kissmetrics
 end

data/lib/kissmetrics/http_client.rb

@@ -0,0 +1,69 @@
+require 'net/http'
+require 'net/https'
+require 'cgi'
+
+module Kissmetrics
+  class HttpClient
+    attr_reader :api_key
+
+    def initialize(api_key)
+      @api_key = api_key
+    end
+
+    def record(identity, event, properties={})
+      request('/e', properties.merge({
+        '_p' => identity,
+        '_n' => event
+      }))
+    end
+
+    def alias(old_identity, new_identity)
+      request('/a', {
+        '_p' => old_identity,
+        '_n' => new_identity
+      })
+    end
+
+    def set(identity, properties)
+      request('/s', properties.merge({
+        '_p' => identity
+      }))
+    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
+
+      QueryStringHash.new(query)
+    end
+
+    class QueryStringHash
+      def initialize(hash)
+        @hash = hash
+      end
+
+      def to_s
+        @hash.collect do |key, value|
+          "#{key}=#{CGI.escape(value.to_s)}"
+        end.join('&')
+      end
+    end
+  end
+end

data/spec/{kissmetrics_spec.rb → kissmetrics/http_client_spec.rb}

@@ -1,61 +1,49 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'spec_helper'
 
-describe Kissmetrics, "class" do
+describe Kissmetrics::HttpClient, "class" do
   it "is constructed with an API key" do
-    Kissmetrics.new("my-api-key").api_key.should == "my-api-key"
+    Kissmetrics::HttpClient.new("my-api-key").api_key.should == "my-api-key"
   end
 end
 
-describe Kissmetrics, "events" do
-  subject { Kissmetrics.new("my-api-key") }
+describe Kissmetrics::HttpClient, "events" do
+  subject { Kissmetrics::HttpClient.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')
+    subject.record('identity', 'Signed Up')
     WebMock.should have_requested(:get, "https://trk.kissmetrics.com/e").with({
       :query => {
         :_k => 'my-api-key',
+        :_p => 'identity',
         :_n => 'Signed Up'
       }
     })
   end
 
   it "records events with properties" do
-    subject.record('Signed Up', { 'Plan' => 'Medium', 'Duration' => 'Year' })
+    subject.record('identity', 'Signed Up', { 'Plan' => 'Medium', 'Duration' => 'Year' })
     WebMock.should have_requested(:get, "https://trk.kissmetrics.com/e").with({
       :query => {
         :_k        => 'my-api-key',
+        :_p        => 'identity',
         :_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
+describe Kissmetrics::HttpClient, "aliasing" do
   before do
     stub_request(:get, %r{https://trk.kissmetrics.com/a}).to_return(:body => "")
   end
 
-  subject { Kissmetrics.new("my-api-key") }
+  subject { Kissmetrics::HttpClient.new("my-api-key") }
 
   it "aliases a person" do
     subject.alias('old_identity', 'new_identity')
@@ -70,31 +58,15 @@ describe Kissmetrics, "aliasing" do
   end
 end
 
-describe Kissmetrics, "setting properties" do
+describe Kissmetrics::HttpClient, "setting properties" do
   before do
     stub_request(:get, %r{https://trk.kissmetrics.com/s}).to_return(:body => "")
   end
 
-  subject { Kissmetrics.new("my-api-key") }
+  subject { Kissmetrics::HttpClient.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({
+    subject.set('identity', {
       'Button color'     => 'Blue',
       'Background color' => 'Gray'
     })
@@ -102,7 +74,7 @@ describe Kissmetrics, "setting properties" do
     WebMock.should have_requested(:get, "https://trk.kissmetrics.com/s").with({
       :query => {
         :_k                => 'my-api-key',
-        :_p                => 'user@example.com',
+        :_p                => 'identity',
         'Button color'     => 'Blue',
         'Background color' => 'Gray'
       }

data/spec/spec_helper.rb

@@ -2,6 +2,7 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'rspec'
 require 'kissmetrics'
+require 'kissmetrics/http_client'
 require 'webmock/rspec'
 
 # Requires supporting files with custom matchers and macros, etc,

metadata

@@ -2,7 +2,7 @@
 name: kissmetrics
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.2
+  version: 1.0.0
 platform: ruby
 authors: 
 - Jason Morrison
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-02 00:00:00 -04:00
+date: 2011-06-12 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -99,7 +99,8 @@ files:
 - VERSION
 - kissmetrics.gemspec
 - lib/kissmetrics.rb
-- spec/kissmetrics_spec.rb
+- lib/kissmetrics/http_client.rb
+- spec/kissmetrics/http_client_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/jasonm/kissmetrics
@@ -115,7 +116,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -1757115897083586638
+      hash: 4373313552260173621
       segments: 
       - 0
       version: "0"