kmts 2.0.0

data/lib/kmts/saas.rb

@@ -0,0 +1,39 @@
+require 'kmts'
+class KMTS
+  module SaaS
+    def signed_up(id, plan=nil, props = {})
+      props['Plan Name'] = plan unless plan.to_s.empty?
+      record id, 'Signed Up', props
+    end
+    alias signedup signed_up
+
+    def upgraded(id, plan=nil, props = {})
+      props['Plan Name'] = plan unless plan.to_s.empty?
+      record id, 'Upgraded', props
+    end
+
+    def downgraded(id, plan=nil, props = {})
+      props['Plan Name'] = plan unless plan.to_s.empty?
+      record id, 'Downgraded', props
+    end
+
+    def billed(id, amount=nil, description=nil, props={})
+      props['Billing Amount']      = amount unless amount.to_s.empty?
+      props['Billing Description'] = description unless description.to_s.empty?
+      record id, 'Billed', props
+    end
+
+    def canceled(id, props={})
+      record id, 'Canceled', props
+    end
+    alias cancelled canceled
+
+    def visited_site(id, url=nil, referrer=nil, props={})
+      props['URL']      = url unless url.to_s.empty?
+      props['Referrer'] = referrer unless referrer.to_s.empty?
+      record id, 'Visited Site', props
+    end
+    # ------------------------------------------------------------------------
+  end
+end
+KMTS.send :extend, KMTS::SaaS

data/lib/kmts/version.rb

@@ -0,0 +1,3 @@
+class KMTS
+  VERSION = "2.0.0"
+end

data/spec/accept.rb

@@ -0,0 +1,91 @@
+#!/usr/bin/env ruby
+require 'socket'
+require 'rubygems'
+require 'json'
+require 'uri'
+require 'cgi'
+
+# a library to accept connections as a server, and send back what it received on request.
+
+class Accept
+  attr_accessor :server, :session
+  attr_reader :opts
+  URI_REXEGP = /^\s*(\w+)\s+([^ ]*)\s+(.*)$/
+  def initialize(args = {})
+    opts = { :port => 9292, :debug => false }
+    opts.update(args)
+
+    puts "Starting up server on port #{opts[:port]} ..."
+    @opts           = opts
+    @server         = TCPServer.new(opts[:port])
+    @@input_history = []
+    @handle         = Thread.start do
+      loop do
+        Thread.start(@server.accept) do |client|
+          # puts "log: Connection from #{session.peeraddr[2]} at #{session.peeraddr[3]}"
+          # session.puts "Server: Connection from #{session.peeraddr[2]}\n"
+          handle_input(client)
+          client.close
+        end
+      end
+    end
+  end
+  def input_history
+    @@input_history
+  end
+  def wait
+    @handle.join
+  end
+
+  def handle_input(client)
+    input = client.gets
+    if input
+      puts "received: #{input.inspect}" if opts[:debug]
+      case input
+      when /clear/
+        clear
+      when /history/
+        client.puts input_history.to_json
+      when /exit/
+        begin
+          close
+        rescue Exception
+        end
+        return
+      when /^\s*(GET|POST|PUT|DELETE)\s+([^ ]*)\s+(.*)$/
+        @@input_history << parse_input(input)
+        client.puts "HTTP/1.1 200 OK"
+      else
+        @@input_history << input.chomp
+      end
+    end
+  end
+  def parse_input(input)
+    data = {}
+    data[:raw] = input.chomp
+    (method,uri,http) = input.scan(/^\s*(\w+)\s+([^ ]*)\s+(.*)$/).flatten
+
+    data[:method] = method
+    data[:http] = http.chomp
+    data[:uri] = uri
+    u = URI(uri)
+    data[:path] = u.path
+    data[:query] = CGI.parse(u.query)
+    return data
+  end
+  def close
+    session = nil
+    server.close
+  end
+  # clear history
+  def clear
+    @@input_history.clear
+  end
+end
+__END__
+% ruby -r './lib/ruby/accept.rb' -e 'Accept.new(:debug => true, :port => 9292).wait'
+Starting up server on port 9292 ...
+
+echo rain | nc localhost 9292
+% echo history | nc localhost 9292
+["rain"]

data/spec/km_old.rb

@@ -0,0 +1,105 @@
+require 'setup'
+
+describe KMTS do
+  attr_accessor :send_query, :log
+  before do
+    @send_query = []
+    @log = []
+    KMTS.stub(:send_query).and_return { |*args| send_query << args }
+    KMTS.stub(:log).and_return { |*args| log << Hash[*args] }
+    time = Time.at 1234567890
+    Time.stub!(:now).and_return(time)
+    KMTS.reset
+  end
+  context "initialization" do
+    it "should not record without initialization" do
+      KMTS::record 'My Action'
+      log.first[:error].should =~ /Need to initialize first \(KMTS::init <your_key>\)/
+    end
+    it "should not set initialization" do
+      KMTS::set :day => 'friday'
+      log.first[:error].should =~ /Need to initialize first \(KMTS::init <your_key>\)/
+    end
+  end
+  context "identification" do
+    before do
+      KMTS::init 'KM_KEY'
+    end
+    it "should not record without identification" do
+      KMTS::record 'My Action'
+      log.first[:error].should include("Need to identify first (KMTS::identify <user>)")
+    end
+    it "should set without identification" do
+      KMTS::record 'My Action'
+      log.first[:error].should include("Need to identify first (KMTS::identify <user>)")
+    end
+
+    context "aliasing" do
+      it "shouldn't fail on alias without identifying" do
+        KMTS::alias 'peter','joe' # Alias "bob" to "robert"
+        send_query.first.first.should have_query_string("/a?_n=joe&_p=peter&_k=KM_KEY&_t=1234567890")
+      end
+    end
+  end
+
+  context "events" do
+    before do
+      KMTS::init 'KM_KEY'
+      KMTS::identify 'bob'
+    end
+    it "should record an action with no specific props" do
+      KMTS::record 'My Action'
+      send_query.first.first.should have_query_string("/e?_n=My+Action&_p=bob&_k=KM_KEY&_t=1234567890")
+    end
+    it "should record an action with properties" do
+      KMTS::record 'Signup', 'age' => 26
+      send_query.first.first.should have_query_string("/e?age=26&_n=Signup&_p=bob&_k=KM_KEY&_t=1234567890")
+    end
+    it "should reocrd properties with spaces in key and value" do
+      KMTS::record 'Signup', 'age' => 26, 'city of residence' => 'eug ene'
+      send_query.first.first.should have_query_string("/e?age=26&city+of+residence=eug+ene&_n=Signup&_p=bob&_k=KM_KEY&_t=1234567890")
+    end
+    it "should not over-write special keys" do
+      KMTS::record 'Signup', 'age' => 26, '_p' => 'billybob', '_k' => 'foo', '_n' => 'something else'
+      send_query.first.first.should have_query_string("/e?age=26&_p=bob&_k=KM_KEY&_n=Signup&_t=1234567890")
+    end
+    it "should not over-write special keys with symbols" do
+      KMTS::record 'Signup', 'age' => 26, '_p' => 'billybob', :'_k' => 'foo', :'_n' => 'something else'
+      send_query.first.first.should have_query_string("/e?age=26&_p=bob&_k=KM_KEY&_n=Signup&_t=1234567890")
+    end
+    it "should work with properties with @" do
+      KMTS::record 'Signup', 'email' => 'test@blah.com', '_p' => 'billybob', '_k' => 'foo', '_n' => 'something else'
+      send_query.first.first.should have_query_string("/e?email=test%40blah.com&_p=bob&_k=KM_KEY&_n=Signup&_t=1234567890")
+    end
+    it "should work with just set" do
+      KMTS::record 'age' => 26
+      send_query.first.first.should have_query_string("/s?age=26&_p=bob&_k=KM_KEY&_t=1234567890")
+    end
+    it "should record ok with multiple calls" do
+      KMTS::record 'Signup', 'age' => 26
+      KMTS::record 'Signup', 'age' => 36
+      send_query.first.first.should have_query_string("/e?age=26&_n=Signup&_p=bob&_k=KM_KEY&_t=1234567890")
+      send_query.last.first.should have_query_string("/e?age=36&_n=Signup&_p=bob&_k=KM_KEY&_t=1234567890")
+    end
+    it "shouldn't store the key anywhere" do
+      KMTS::init 'KM_OTHER'
+      KMTS::alias 'truman','harry' # Alias "bob" to "robert"
+      send_query.first.first.should have_query_string("/a?_n=harry&_p=truman&_k=KM_OTHER&_t=1234567890")
+    end
+    it "should override the time if defined" do
+      KMTS::record 'Signup', 'age' => 36, '_t' => 1234567891
+      send_query.last.first.should have_query_string("/e?age=36&_n=Signup&_p=bob&_k=KM_KEY&_t=1234567891&_d=1")
+    end
+    it "should work with either symbols or strings" do
+      KMTS::record :Signup, :age => 36, :_t => 1234567891
+      send_query.last.first.should have_query_string("/e?age=36&_n=Signup&_p=bob&_k=KM_KEY&_t=1234567891&_d=1")
+    end
+  end
+
+  it "should test cron" do
+    pending
+  end
+  it "should send logged queries" do
+    pending
+  end
+end

data/spec/km_saas_spec.rb

@@ -0,0 +1,107 @@
+require 'setup'
+require 'kmts/saas'
+describe KMTS do
+  before do
+    KMTS::reset
+    now = Time.now
+    Time.stub!(:now).and_return(now)
+    FileUtils.rm_f KMTS::log_name(:error)
+    FileUtils.rm_f KMTS::log_name(:query)
+    Helper.clear
+  end
+
+  describe "should record events" do
+    before do
+      KMTS::init 'KM_KEY', :log_dir => __('log'), :host => '127.0.0.1:9292'
+    end
+    context "plain usage" do
+      it "records a signup event" do
+        KMTS.signed_up 'bob', 'Premium'
+        sleep 0.1
+        res = Helper.accept(:history).first.indifferent
+        res[:path].should == '/e'
+        res[:query]['_n'].first.should == 'Signed Up'
+        res[:query]['Plan Name'].first.should == 'Premium'
+      end
+      it "records an upgraded event" do
+        KMTS.upgraded 'bob', 'Unlimited'
+        sleep 0.1
+        res = Helper.accept(:history).first.indifferent
+        res[:path].should == '/e'
+        res[:query]['_n'].first.should == 'Upgraded'
+        res[:query]['Plan Name'].first.should == 'Unlimited'
+      end
+      it "records a downgraded event" do
+        KMTS.downgraded 'bob', 'Free'
+        sleep 0.1
+        res = Helper.accept(:history).first.indifferent
+        res[:path].should == '/e'
+        res[:query]['_n'].first.should == 'Downgraded'
+        res[:query]['Plan Name'].first.should == 'Free'
+      end
+      it "records a billed event" do
+        KMTS.billed 'bob', 32, 'Upgraded'
+        sleep 0.1
+        res = Helper.accept(:history).first.indifferent
+        res[:path].should == '/e'
+        res[:query]['_n'].first.should == 'Billed'
+        res[:query]['Billing Amount'].first.should == '32'
+        res[:query]['Billing Description'].first.should == 'Upgraded'
+      end
+      it "records a canceled event" do
+        KMTS.canceled 'bob'
+        sleep 0.1
+        res = Helper.accept(:history).first.indifferent
+        res[:path].should == '/e'
+        res[:query]['_n'].first.should == 'Canceled'
+      end
+      it "records a visited site event" do
+        KMTS.visited_site 'bob', 'http://duckduckgo.com', 'http://kissmetrics.com'
+        sleep 0.1
+        res = Helper.accept(:history).first.indifferent
+        res[:path].should == '/e'
+        res[:query]['_n'].first.should == 'Visited Site'
+        res[:query]['URL'].first.should == 'http://duckduckgo.com'
+        res[:query]['Referrer'].first.should == 'http://kissmetrics.com'
+      end
+    end
+    context "usage with props" do
+      it "records a signup event" do
+        KMTS.signed_up 'bob', 'Premium', :foo => 'bar'
+        sleep 0.1
+        res = Helper.accept(:history).first.indifferent
+        res[:query]['foo'].first.should == 'bar'
+      end
+      it "records an upgraded event" do
+        KMTS.upgraded 'bob', 'Unlimited', :foo => 'bar'
+        sleep 0.1
+        res = Helper.accept(:history).first.indifferent
+        res[:query]['foo'].first.should == 'bar'
+      end
+      it "records a downgraded event" do
+        KMTS.downgraded 'bob', 'Free', :foo => 'bar'
+        sleep 0.1
+        res = Helper.accept(:history).first.indifferent
+        res[:query]['foo'].first.should == 'bar'
+      end
+      it "records a billed event" do
+        KMTS.billed 'bob', 32, 'Upgraded', :foo => 'bar'
+        sleep 0.1
+        res = Helper.accept(:history).first.indifferent
+        res[:query]['foo'].first.should == 'bar'
+      end
+      it "records a canceled event" do
+        KMTS.canceled 'bob', :foo => 'bar'
+        sleep 0.1
+        res = Helper.accept(:history).first.indifferent
+        res[:query]['foo'].first.should == 'bar'
+      end
+      it "records a visited site event" do
+        KMTS.visited_site 'bob', 'http://duckduckgo.com', 'http://kissmetrics.com', :foo => 'bar'
+        sleep 0.1
+        res = Helper.accept(:history).first.indifferent
+        res[:query]['foo'].first.should == 'bar'
+      end
+    end
+  end
+end

data/spec/km_send_spec.rb

@@ -0,0 +1,98 @@
+require 'setup'
+
+describe 'km_send' do
+  context "using cron for sending logs" do
+    before do
+      now = Time.now
+      Time.stub!(:now).and_return(now)
+      Dir.glob(__('log','*')).each do |file|
+        FileUtils.rm file
+      end
+      KMTS.reset
+      Helper.clear
+    end
+    context "with default environment" do
+      before do
+        KMTS::init 'KM_KEY', :log_dir => __('log'), :host => '127.0.0.1:9292', :use_cron => true
+      end
+      it "should test commandline version" do
+        KMTS::record 'bob', 'Signup', 'age' => 26
+        `bundle exec km_send #{__('log/')} 127.0.0.1:9292`
+        sleep 0.1
+        res = Helper.accept(:history).first.indifferent
+        res[:path].should == '/e'
+        res[:query]['_k'].first.should == 'KM_KEY'
+        res[:query]['_p'].first.should == 'bob'
+        res[:query]['_n'].first.should == 'Signup'
+        res[:query]['_t'].first.should == Time.now.to_i.to_s
+        res[:query]['age'].first.should == '26'
+      end
+      it "should send from query_log" do
+        write_log :query, "/e?_t=1297105499&_n=Signup&_p=bob&_k=KM_KEY&age=26"
+        `bundle exec km_send #{__('log/')} 127.0.0.1:9292`
+        sleep 0.1
+        res = Helper.accept(:history).first.indifferent
+        res[:path].should == '/e'
+        res[:query]['_k'].first.should == 'KM_KEY'
+        res[:query]['_p'].first.should == 'bob'
+        res[:query]['_n'].first.should == 'Signup'
+        res[:query]['_t'].first.should == '1297105499'
+        res[:query]['age'].first.should == '26'
+      end
+      it "should send from query_log_old" do
+        write_log :query_old, "/e?_t=1297105499&_n=Signup&_p=bob&_k=KM_KEY&age=26"
+        `bundle exec km_send #{__('log/')} 127.0.0.1:9292`
+        sleep 0.1
+        res = Helper.accept(:history).first.indifferent
+        res[:path].should == '/e'
+        res[:query]['_k'].first.should == 'KM_KEY'
+        res[:query]['_p'].first.should == 'bob'
+        res[:query]['_n'].first.should == 'Signup'
+        res[:query]['_t'].first.should == '1297105499'
+        res[:query]['age'].first.should == '26'
+      end
+      it "should send from both query_log and query_log_old" do
+        File.open(__('log/kissmetrics_query.log'), 'w+') { |h| h.puts "/e?_t=1297105499&_n=Signup&_p=bob&_k=KM_KEY&age=27" }
+        File.open(__('log/kissmetrics_production_query.log'), 'w+') { |h| h.puts "/e?_t=1297105499&_n=Signup&_p=bob&_k=KM_KEY&age=26" }
+        `bundle exec km_send #{__('log/')} 127.0.0.1:9292`
+        sleep 0.1
+        res = Helper.accept(:history).first.indifferent
+        res[:path].should == '/e'
+        res[:query]['_k'].first.should == 'KM_KEY'
+        res[:query]['_p'].first.should == 'bob'
+        res[:query]['_n'].first.should == 'Signup'
+        res[:query]['_t'].first.should == '1297105499'
+        res[:query]['age'].first.should == '27'
+        Helper.clear
+        `bundle exec km_send #{__('log/')} 127.0.0.1:9292`
+        sleep 0.1
+        res = Helper.accept(:history).first.indifferent
+        res[:path].should == '/e'
+        res[:query]['_k'].first.should == 'KM_KEY'
+        res[:query]['_p'].first.should == 'bob'
+        res[:query]['_n'].first.should == 'Signup'
+        res[:query]['_t'].first.should == '1297105499'
+        res[:query]['age'].first.should == '26'
+      end
+      it "sends unless dryrun is specified" do
+        File.open(__('log/kissmetrics_alpha_query.log'), 'w+') { |h| h.puts "/e?_t=1297105499&_n=Signup&_p=bob&_k=KM_KEY&age=26" }
+        `bundle exec km_send -e alpha #{__('log/')} 127.0.0.1:9292`
+        sleep 0.1
+        res = Helper.accept(:history).first.should_not be_nil
+      end
+    end
+    it "should send from diff environment when force flag is used" do
+      KMTS::init 'KM_KEY', :log_dir => __('log'), :host => '127.0.0.1:9292', :use_cron => true, :env => 'development', :force => true
+      KMTS::record 'bob', 'Signup', 'age' => 26
+      `bundle exec km_send -f -e development #{__('log/')} 127.0.0.1:9292`
+      sleep 0.1
+      res = Helper.accept(:history).first.indifferent
+      res[:path].should == '/e'
+      res[:query]['_k'].first.should == 'KM_KEY'
+      res[:query]['_p'].first.should == 'bob'
+      res[:query]['_n'].first.should == 'Signup'
+      res[:query]['_t'].first.should == Time.now.to_i.to_s
+      res[:query]['age'].first.should == '26'
+    end
+  end
+end