km 1.1.0

data/lib/km.rb

@@ -0,0 +1,263 @@
+require 'cgi'
+require 'socket'
+require 'fileutils'
+require 'km/saas'
+
+class Hash
+  def reverse_merge(other_hash)
+    other_hash.merge(self)
+  end if !respond_to?(:reverse_merge)
+  def reverse_merge!(other_hash)
+    replace(reverse_merge(other_hash))
+  end if !respond_to?(:reverse_merge)
+end
+
+class KMError < StandardError; end
+
+class KM
+  @id        = nil
+  @key       = nil
+  @logs      = {}
+  @host      = 'trk.kissmetrics.com:80'
+  @log_dir   = '/tmp'
+  @to_stderr = true
+  @use_cron  = false
+
+  class << self
+    class IdentError < StandardError; end
+    class InitError < StandardError; end
+
+    def init(key, options={})
+      default = {
+        :host      => @host,
+        :log_dir   => @log_dir,
+        :to_stderr => @to_stderr,
+        :use_cron  => @use_cron,
+        :env       => set_env,
+      }
+      options.reverse_merge!(default)
+      begin
+        @key       = key
+        @host      = options[:host]
+        @log_dir   = options[:log_dir]
+        @use_cron  = options[:use_cron]
+        @to_stderr = options[:to_stderr]
+        @env       = options[:env]
+        log_dir_writable?
+      rescue Exception => e
+        log_error(e)
+      end
+    end
+
+    def set_env
+      @env = Rails.env if defined? Rails
+      @env ||= ENV['RACK_ENV']
+      @env ||= 'production'
+    end
+
+    def identify(id)
+      @id = id
+    end
+
+    def record(action,props={})
+      props = hash_keys_to_str(props)
+      begin
+        return unless is_initialized_and_identified?
+        return set(action) if action.class == Hash
+
+        props.update('_n' => action)
+        generate_query('e', props)
+      rescue Exception => e
+        log_error(e)
+      end
+    end
+
+    def alias(name, alias_to)
+      begin
+        return unless is_initialized?
+        generate_query('a', { '_n' => alias_to, '_p' => name }, false)
+      rescue Exception => e
+        log_error(e)
+      end
+    end
+
+    def set(data)
+      begin
+        return unless is_initialized_and_identified?
+        generate_query('s', data)
+      rescue Exception => e
+        log_error(e)
+      end
+    end
+
+    def send_logged_queries # :nodoc:
+      line = nil
+      begin
+        query_log = log_name(:query_old)
+        query_log = log_name(:query) unless File.exists?(query_log)
+        return unless File.exists?(query_log) # can't find logfile to send
+        FileUtils.move(query_log, log_name(:send))
+        File.open(log_name(:send)) do |fh|
+          while not fh.eof?
+            begin
+              line = fh.readline.chomp
+              send_query(line)
+            rescue Exception => e
+              log_query(line) if line
+              log_error(e)
+            end
+          end
+        end
+        FileUtils.rm(log_name(:send))
+      rescue Exception => e
+        log_error(e)
+      end
+    end
+
+    def log_dir
+      @log_dir
+    end
+    def host
+      @host
+    end
+
+    # :stopdoc:
+    protected
+    def hash_keys_to_str(hash)
+      Hash[*hash.map { |k,v| k.class == Symbol ? [k.to_s,v] : [k,v] }.flatten] # convert all keys to strings
+    end
+    def reset
+      @id        = nil
+      @key       = nil
+      @logs      = {}
+      @host      = 'trk.kissmetrics.com:80'
+      @log_dir   = '/tmp'
+      @to_stderr = true
+      @use_cron  = false
+    end
+
+    def log_name(type)
+      return @logs[type] if @logs[type]
+      fname = ''
+      env = @env ? "_#{@env}" : ''
+      case type
+      when :error
+        fname = "kissmetrics#{env}_error.log"
+      when :query
+        fname = "kissmetrics#{env}_query.log"
+      when :query_old # backwards compatibility
+        fname = "kissmetrics_query.log"
+      when :sent
+        fname = "kissmetrics#{env}_sent.log"
+      when :send
+        fname = Time.now.to_i.to_s + "kissmetrics_#{env}_sending.log"
+      end
+      @logs[type] = File.join(@log_dir,fname)
+    end
+
+    def log_query(msg)
+      log(:query,msg)
+    end
+
+    def log_sent(msg)
+      log(:sent,msg)
+    end
+
+    def log_send(msg)
+      log(:send,msg)
+    end
+
+    def log_error(error)
+      if defined?(HoptoadNotifier)
+        HoptoadNotifier.notify_or_ignore(KMError.new(error))
+      end
+      msg = Time.now.strftime("<%c> ") + error.message
+      $stderr.puts msg if @to_stderr
+      log(:error, msg)
+      rescue Exception # rescue incase hoptoad has issues
+    end
+
+    def log(type,msg)
+      begin
+        File.open(log_name(type), 'a') do |fh|
+          fh.puts(msg)
+        end
+      rescue Exception => e
+        raise KMError.new(e) if type.to_s == 'query'
+        # just discard at this point otherwise
+      end
+    end
+
+
+    def generate_query(type, data, update=true)
+      data = hash_keys_to_str(data)
+      query_arr = []
+      query     = ''
+      data.update('_p' => @id) unless update == false
+      data.update('_k' => @key)
+      data.update '_d' => 1 if data['_t']
+      data.reverse_merge!('_t' => Time.now.to_i)
+      data.inject(query) do |query,key_val|
+        query_arr <<  key_val.collect { |i| CGI.escape i.to_s }.join('=')
+      end
+      query = '/' + type + '?' + query_arr.join('&')
+      if @use_cron
+        log_query(query)
+      else
+        begin
+          send_query(query)
+        rescue Exception => e
+          log_query(query)
+          log_error(e)
+        end
+      end
+    end
+
+    def send_query(line)
+      if @env != 'production'
+        log_sent(line)
+        return
+      end
+      host,port = @host.split(':')
+      begin
+        sock = TCPSocket.open(host,port)
+        request = 'GET ' +  line + " HTTP/1.1\r\n"
+        request += "Host: " + Socket.gethostname + "\r\n"
+        request += "Connection: Close\r\n\r\n";
+        sock.print(request)
+        sock.close
+      rescue Exception => e
+        raise KMError.new("#{e} for host #{@host}")
+      end
+      log_sent(line)
+    end
+
+    def log_dir_writable?
+      if not FileTest.writable? @log_dir
+        $stderr.puts("Could't open #{log_name(:query)} for writing. Does #{@log_dir} exist? Permissions?") if @to_stderr
+      end
+    end
+
+    def is_identified?
+      if @id == nil
+        log_error IdentError.new("Need to identify first (KM::identify <user>)")
+        return false
+      end
+      return true
+    end
+
+    def is_initialized_and_identified?
+      return false unless is_initialized?
+      return is_identified?
+    end
+
+    def is_initialized?
+      if @key == nil
+        log_error InitError.new("Need to initialize first (KM::init <your_key>)")
+        return false
+      end
+      return true
+    end
+    # :startdoc:
+  end
+end

data/spec/accept.rb

@@ -0,0 +1,90 @@
+#!/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
+      while (@session = server.accept)
+        Thread.start do
+          # puts "log: Connection from #{session.peeraddr[2]} at #{session.peeraddr[3]}"
+          # session.puts "Server: Connection from #{session.peeraddr[2]}\n"
+          handle_input
+          session.close
+        end
+      end
+    end
+  end
+  def input_history
+    @@input_history
+  end
+  def wait
+    @handle.join
+  end
+
+  def handle_input
+    input = session.gets
+    if input
+      puts "received: #{input.inspect}" if opts[:debug]
+      case input
+      when /clear/
+        clear
+      when /history/
+        session.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)
+      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 KM do
+  attr_accessor :send_query, :log
+  before do
+    @send_query = []
+    @log = []
+    KM.stub(:send_query).and_return { |*args| send_query << args }
+    KM.stub(:log).and_return { |*args| log << Hash[*args] }
+    time = Time.at 1234567890
+    Time.stub!(:now).and_return(time)
+    KM.reset
+  end
+  context "initialization" do
+    it "should not record without initialization" do
+      KM::record 'My Action'
+      log.first[:error].should =~ /Need to initialize first \(KM::init <your_key>\)/
+    end
+    it "should not set initialization" do
+      KM::set :day => 'friday'
+      log.first[:error].should =~ /Need to initialize first \(KM::init <your_key>\)/
+    end
+  end
+  context "identification" do
+    before do
+      KM::init 'KM_KEY'
+    end
+    it "should not record without identification" do
+      KM::record 'My Action'
+      log.first[:error].should include("Need to identify first (KM::identify <user>)")
+    end
+    it "should set without identification" do
+      KM::record 'My Action'
+      log.first[:error].should include("Need to identify first (KM::identify <user>)")
+    end
+
+    context "aliasing" do
+      it "shouldn't fail on alias without identifying" do
+        KM::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
+      KM::init 'KM_KEY'
+      KM::identify 'bob'
+    end
+    it "should record an action with no specific props" do
+      KM::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
+      KM::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
+      KM::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
+      KM::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
+      KM::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
+      KM::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
+      KM::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
+      KM::record 'Signup', 'age' => 26
+      KM::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
+      KM::init 'KM_OTHER'
+      KM::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
+      KM::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
+      KM::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,121 @@
+require 'setup'
+require 'km/saas'
+describe KM do
+  before do
+    KM::reset
+    now = Time.now
+    Time.stub!(:now).and_return(now)
+    FileUtils.rm_f KM::log_name(:error)
+    FileUtils.rm_f KM::log_name(:query)
+    Helper.clear
+  end
+
+  describe "should record events" do
+    before do
+      KM::init 'KM_KEY', :log_dir => __('log'), :host => '127.0.0.1:9292'
+      KM::identify 'bob'
+    end
+    context "plain usage" do
+      it "records a signup event" do
+        KM.signed_up '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
+        KM.upgraded '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
+        KM.downgraded '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
+        KM.billed 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
+        KM.canceled
+        sleep 0.1
+        res = Helper.accept(:history).first.indifferent
+        res[:path].should == '/e'
+        res[:query]['_n'].first.should == 'Canceled'
+      end
+      it "records a cancelled event" do
+        KM.cancelled
+        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
+        KM.visited_site '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
+        KM.signed_up '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
+        KM.upgraded '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
+        KM.downgraded '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
+        KM.billed 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
+        KM.canceled :foo => 'bar'
+        sleep 0.1
+        res = Helper.accept(:history).first.indifferent
+        res[:query]['foo'].first.should == 'bar'
+      end
+      it "records a cancelled event" do
+        KM.cancelled :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
+        KM.visited_site '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,82 @@
+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
+      KM.reset
+      Helper.clear
+    end
+    it "should test commandline version" do
+      KM::init 'KM_KEY', :log_dir => __('log'), :host => '127.0.0.1:9292', :use_cron => true
+      KM::identify 'bob'
+      KM::record '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 "should not send from diff environment as we only send when env is production" 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 == nil
+    end
+  end
+end