km 1.1.0

data/spec/km_spec.rb

@@ -0,0 +1,186 @@
+require 'setup'
+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
+  it "shouldn't write at all without init or identify" do
+    KM::record 'My Action'
+    IO.readlines(KM::log_name(:error)).join.should =~ /Need to initialize first \(KM::init <your_key>\)/
+
+    FileUtils.rm_f KM::log_name(:error)
+    KM::set :day => 'friday'
+    IO.readlines(KM::log_name(:error)).join.should =~ /Need to initialize first \(KM::init <your_key>\)/
+
+    KM::init 'KM_KEY', :log_dir => __('log'), :host => '127.0.0.1:9292'
+    FileUtils.rm_f KM::log_name(:error)
+    KM::record 'My Action'
+    IO.readlines(KM::log_name(:error)).last.should =~ /Need to identify first \(KM::identify <user>\)/
+
+    FileUtils.rm_f KM::log_name(:error)
+    KM::set :day => 'friday'
+    IO.readlines(KM::log_name(:error)).last.should =~ /Need to identify first \(KM::identify <user>\)/
+  end
+
+  it "shouldn't fail on alias without identifying" do
+    KM::init 'KM_OTHER', :log_dir => __('log'), :host => '127.0.0.1:9292'
+    KM::alias 'peter','joe' # Alias "bob" to "robert"
+    sleep 0.1
+    res = Helper.accept(:history).first.indifferent
+    res[:path].should == '/a'
+    res[:query]['_k'].first.should == 'KM_OTHER'
+    res[:query]['_p'].first.should == 'peter'
+    res[:query]['_n'].first.should == 'joe'
+    res[:query]['_t'].first.should == Time.now.to_i.to_s
+  end
+  it "shouldn't fail on alias without identifying from commandline" do
+    KM::init 'KM_OTHER', :log_dir => __('log'), :host => '127.0.0.1:9292'
+    KM::alias 'peter','joe' # Alias "bob" to "robert"
+    sleep 0.1
+    res = Helper.accept(:history).first.indifferent
+    res[:path].should == '/a'
+    res[:query]['_k'].first.should == 'KM_OTHER'
+    res[:query]['_p'].first.should == 'peter'
+    res[:query]['_n'].first.should == 'joe'
+    res[:query]['_t'].first.should == Time.now.to_i.to_s
+  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
+    it "records an action with no action-specific properties" do
+      KM::record 'My Action'
+      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 == 'My Action'
+      res[:query]['_t'].first.should == Time.now.to_i.to_s
+    end
+    it "records an action with properties" do
+      KM::record 'Signup', 'age' => 26
+      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.to_s
+    end
+    it "should be able to hace spaces in key and value" do
+      KM::record 'Signup', 'age' => 26, 'city of residence' => 'eug ene'
+      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.to_s
+      res[:query]['city of residence'].first.should == 'eug ene'
+    end
+    it "should not override important parts" do
+      KM::record 'Signup', 'age' => 26, '_p' => 'billybob', '_k' => 'foo', '_n' => 'something else'
+      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.to_s
+    end
+    it "should work with propps using @" do
+      KM::record 'Signup', 'email' => 'test@blah.com', '_p' => 'billybob', '_k' => 'foo', '_n' => 'something else'
+      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]['email'].first.should == 'test@blah.com'
+    end
+    it "should just set properties without event" do
+      KM::record 'age' => 26
+      sleep 0.1
+      res = Helper.accept(:history).first.indifferent
+      res[:path].should == '/s'
+      res[:query]['_k'].first.should == 'KM_KEY'
+      res[:query]['_p'].first.should == 'bob'
+      res[:query]['_t'].first.should == Time.now.to_i.to_s
+      res[:query]['age'].first.should == 26.to_s
+    end
+    it "should be able to use km set directly" do
+      KM::set 'age' => 26
+      sleep 0.1
+      res = Helper.accept(:history).first.indifferent
+      res[:path].should == '/s'
+      res[:query]['_k'].first.should == 'KM_KEY'
+      res[:query]['_p'].first.should == 'bob'
+      res[:query]['_t'].first.should == Time.now.to_i.to_s
+      res[:query]['age'].first.should == 26.to_s
+    end
+    it "should work with multiple lines" do
+      # testing recording of multiple lines.
+      KM::record 'Signup', 'age' => 26
+      sleep 0.1
+      KM::record 'Signup', 'age' => 36
+      sleep 0.1
+      res = Helper.accept(:history)[0].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.to_s
+      res = Helper.accept(:history)[1].indifferent
+      res[:path].should == '/e'
+      res[:query]['_k'].first.should == 'KM_KEY'
+      res[:query]['_p'].first.should == 'bob'
+      res[:query]['_t'].first.should == Time.now.to_i.to_s
+      res[:query]['age'].first.should == 36.to_s
+    end
+    it "should not have key hardcoded anywhere" do
+      KM::init 'KM_OTHER', :log_dir => __('log')
+      KM::alias 'truman','harry' # Alias "bob" to "robert"
+      sleep 0.1
+      res = Helper.accept(:history)[0].indifferent
+      res[:path].should == '/a'
+      res[:query]['_k'].first.should == 'KM_OTHER'
+      res[:query]['_p'].first.should == 'truman'
+      res[:query]['_n'].first.should == 'harry'
+      res[:query]['_t'].first.should == Time.now.to_i.to_s
+    end
+  end
+  context "reading from files" do
+    before do
+      Dir.glob(__('log','*')).each do |file|
+        FileUtils.rm file
+      end
+      KM.reset
+    end
+    it "should run fine even though there's no server to connect to" do
+      KM::init 'KM_OTHER', :log_dir => __('log'), :host => '127.0.0.1:9291', :to_stderr => false
+      KM::identify 'bob'
+      KM::record 'My Action' # records an action with no action-specific properties;
+      Helper.accept(:history).size.should == 0
+      File.exists?(__('log/kissmetrics_production_query.log')).should == true
+      File.exists?(__('log/kissmetrics_production_error.log')).should == true
+    end
+
+    it "should escape @ properly" do
+      KM::init 'KM_OTHER', :log_dir => __('log'), :host => '127.0.0.1:9292', :to_stderr => false, :use_cron => true
+      KM::identify 'bob'
+      KM::record 'prop_with_@_in' # records an action with no action-specific properties;
+      IO.readlines(KM::log_name(:query)).join.should_not contain_string('@')
+    end
+  end
+end

data/spec/setup.rb

@@ -0,0 +1,78 @@
+require 'ap'
+require 'km'
+require 'fileutils'
+require 'accept'
+
+class KM
+  class << self
+    public :log_name, :reset, :log
+  end
+end
+
+def __(*args)
+  file_this_included_from = caller.first.split(":").first
+  app_root = File.expand_path(File.dirname(file_this_included_from))
+  args = [app_root]+args
+  File.expand_path(File.join(args))
+end
+
+class Helper
+  def self.accept(cmd)
+    c = TCPSocket.new('localhost', 9292)
+    c.puts cmd.to_s
+    return JSON.parse(c.read) rescue nil
+  end
+  def self.history
+    accept :history
+  end
+  def self.clear
+    accept :clear
+  end
+  def self.exit
+    accept :exit
+  end
+end
+class String
+  def sort
+    self.split('').sort.join('')
+  end
+  def sort!
+    replace(self.sort)
+  end
+end
+
+RSpec::Matchers.define :have_query_string do |expected|
+  match do |value|
+    expected.sort == value.sort
+  end
+
+  failure_message_for_should do |value|
+    "expected #{value.inspect} to match #{expected.inspect}"
+  end
+end
+#======================================#
+#=           contain_string           =#
+#======================================#
+# Check if a string has another string. Usage:
+# some_string.should contain("my string")
+RSpec::Matchers.define :contain_string do |needle|
+  match do |haystack|
+    haystack.index(needle) ? true : false
+  end
+end
+
+class Hash
+  def indifferent
+    Hash.new { |hash,key| hash[key.to_s] if key.class == Symbol }.merge(self)
+  end
+end
+
+def write_log(type, content)
+  KM.instance_eval { @log_dir = __('log') }
+  log_name = KM.send :log_name, type
+  File.open(log_name, 'w+') do |fh|
+    fh.puts content
+  end
+end
+
+accept = Accept.new

data/spec/watchr.rb

@@ -0,0 +1,3 @@
+watch('spec/.*spec\.rb') { |md| system("bundle exec rspec --color #{md[0]}") }
+watch('lib/km\.rb') { |md| system("bundle exec rake spec") }
+watch('lib/km/saas\.rb') { |md| system("bundle exec rspec --color spec/km_saas_spec.rb") }

metadata

@@ -0,0 +1,224 @@
+--- !ruby/object:Gem::Specification 
+name: km
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 1
+  - 0
+  version: 1.1.0
+platform: ruby
+authors: 
+- KISSmetrics
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-08 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 4
+        - 0
+        version: 2.4.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: awesome_print
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: watchr
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+description: KISSmetrics ruby API gem
+email: 
+- support@kissmetrics.com
+executables: 
+- km_send
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- CHANGELOG
+- Gemfile
+- Gemfile.lock
+- README.rdoc
+- Rakefile
+- bin/km_send
+- doc/Accept.html
+- doc/Gemfile.html
+- doc/Hash.html
+- doc/Helper.html
+- doc/KM.html
+- doc/KM/IdentError.html
+- doc/KM/InitError.html
+- doc/KM/SaaS.html
+- doc/KMError.html
+- doc/Object.html
+- doc/README_rdoc.html
+- doc/Rakefile.html
+- doc/String.html
+- doc/bin/km_send.html
+- doc/created.rid
+- doc/images/brick.png
+- doc/images/brick_link.png
+- doc/images/bug.png
+- doc/images/bullet_black.png
+- doc/images/bullet_toggle_minus.png
+- doc/images/bullet_toggle_plus.png
+- doc/images/date.png
+- doc/images/find.png
+- doc/images/loadingAnimation.gif
+- doc/images/macFFBgHack.png
+- doc/images/package.png
+- doc/images/page_green.png
+- doc/images/page_white_text.png
+- doc/images/page_white_width.png
+- doc/images/plugin.png
+- doc/images/ruby.png
+- doc/images/tag_green.png
+- doc/images/wrench.png
+- doc/images/wrench_orange.png
+- doc/images/zoom.png
+- doc/index.html
+- doc/js/darkfish.js
+- doc/js/jquery.js
+- doc/js/quicksearch.js
+- doc/js/thickbox-compressed.js
+- doc/lib/km/saas_rb.html
+- doc/lib/km/version_rb.html
+- doc/lib/km_rb.html
+- doc/rdoc.css
+- doc/spec/accept_rb.html
+- doc/spec/km_old_rb.html
+- doc/spec/km_saas_spec_rb.html
+- doc/spec/km_send_spec_rb.html
+- doc/spec/km_spec_rb.html
+- doc/spec/setup_rb.html
+- doc/spec/watchr_rb.html
+- km.gemspec
+- lib/km.rb
+- lib/km/saas.rb
+- lib/km/version.rb
+- spec/accept.rb
+- spec/km_old.rb
+- spec/km_saas_spec.rb
+- spec/km_send_spec.rb
+- spec/km_spec.rb
+- spec/log/.hold
+- spec/setup.rb
+- spec/watchr.rb
+has_rdoc: true
+homepage: http://rubygems.org/gems/km
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: kissmetrics
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: KISSmetrics ruby API gem
+test_files: 
+- spec/accept.rb
+- spec/km_old.rb
+- spec/km_saas_spec.rb
+- spec/km_send_spec.rb
+- spec/km_spec.rb
+- spec/log/.hold
+- spec/setup.rb
+- spec/watchr.rb