kmts 2.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b7fac5bf794804436935e08acc69e9e5795378d0
-  data.tar.gz: d8b375322632f2cbf62136b62cbaaea04db4d78a
+SHA256:
+  metadata.gz: 63f20f75c5fb43e2daf45c420ef3eef9c3dd9b8d8cf69c40fe85d1be139d51fb
+  data.tar.gz: ef06b72bb06e217c103c6323670b77795a876e625225fbce8b7b8e39d828c000
 SHA512:
-  metadata.gz: 9c06978b76f29e4eb415ca27923762578698f34ad95752e7c28491a252808f94caf58d5b31bb03dc467f4e2062342fd1f48d2cb014bf11f1b4bade21f661a089
-  data.tar.gz: 876e7fbcb0fab76dd6b333d047b7b9d7fdd4db8e7f1bbfa846ddf504e8a53d2e2feea59b139bb5285a2165a91b5a499f297b063fdcd4b9bb008e9b2463751267
+  metadata.gz: 2d3e134e167ea89b741083b0a3c974922cc9ee7dd227ec07b97ea8aceaadc1d04138ee271c6c90f2f9482427047671651044960e64a1ab7e23332315e9712ef7
+  data.tar.gz: c5df65fef48f3ddf437e4c6703734b800aff1b6c8348ef5a2a1a2b517a2485e4f2799dabb3aeb39a413c8d2b56371e1ced7d7508a7406c79376cb16b6e1138fd

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - 2.3.1
+  - 2.2
+  - 2.1
+  - 2.0
+cache:
+  bundler: true
+sudo: false
+before_install:
+  - gem uninstall -v '>= 2' -i $(rvm gemdir)@global -ax bundler || true
+  - gem install bundler -v '1.13.7'

data/Gemfile.lock

@@ -1,29 +1,37 @@
 PATH
   remote: .
   specs:
-    kmts (2.0.1)
+    kmts (3.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    diff-lcs (1.1.2)
-    json (1.5.1)
-    rake (0.8.7)
-    rspec (2.4.0)
-      rspec-core (~> 2.4.0)
-      rspec-expectations (~> 2.4.0)
-      rspec-mocks (~> 2.4.0)
-    rspec-core (2.4.0)
-    rspec-expectations (2.4.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.4.0)
+    diff-lcs (1.2.5)
+    json (2.0.2)
+    rake (12.0.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (>= 1.0.0)
-  json
+  bundler (~> 1.13)
+  json (~> 2.0)
   kmts!
-  rake
-  rspec (~> 2.4.0)
+  rake (~> 12.0)
+  rspec (~> 3.5)
+
+BUNDLED WITH
+   1.13.7

data/README.md

@@ -1,4 +1,4 @@
-## KISSmetrics Threadsafe Ruby library
+## Kissmetrics Threadsafe Ruby library
 
 This gem is a threadsafe fork of the original `km` gem.
 
@@ -6,19 +6,23 @@ This gem is a threadsafe fork of the original `km` gem.
 
 Version 1.0.2 of the `kmts` gem had an issue where it was found to not actually be thread safe. If you were using version 1.0.2 of the `kmts` gem, you were likely using non thread-safe code. In this case, you will want to either switch to using the non thread-safe [`km`](https://github.com/kissmetrics/km) gem, or update your code to use the thread-safe `kmts` gem version >= 2.0.0.
 
+## `kmts` version 3.1.0
+
+Uses the `trk.kissmetrics.io` tracking domain.
+
 ## Setup
 
 The best way to install the gem is using `gem install kmts` or by adding it to your `Gemfile`:
 
 ```ruby
-gem 'kmts', '~> 2.0.0'
+gem 'kmts', '~> 3.0.0'
 ```
 
 Otherwise, the gem is available on GitHub:
 
 https://github.com/kissmetrics/kmts
 
-You will need your API key which you can find in your [site settings](http://support.kissmetrics.com/misc/site-settings).
+You will need your API key which you can find in your [site settings](https://support.kissmetrics.io/docs/product-settings).
 
 ## Usage
 
@@ -30,11 +34,12 @@ KMTS.init('KM_KEY' [, options])
 
 The available options are:
 
-* `log_dir`: sets the logging directory. Default is `'/tmp'`. Please make sure that the directory exists, and that whatever web process is writing to the log has permission to write to that directory. The log file will contain a list of the URLs that would be requested (`trk.kissmetrics.com` URLs - please refer to [API Specifications](http://support.kissmetrics.com/apis/specifications.html).
-* `use_cron`: toggles whether to send data directly to KISSmetrics, or log to a file and send in the background via cron (see [Sending Data with Cron](http://support.kissmetrics.com/apis/cron) for more information). Default is `false`, which means data is sent directly to KISSmetrics. Using cron is optional, but **recommended**.
+* `log_dir`: sets the logging directory. Default is `'/tmp'`. Please make sure that the directory exists, and that whatever web process is writing to the log has permission to write to that directory. The log file will contain a list of the URLs that would be requested (`trk.kissmetrics.io` URLs - please refer to [API Specifications](https://support.kissmetrics.io/reference#api-specifications-1).
+* `use_cron`: toggles whether to send data directly to Kissmetrics, or log to a file and send in the background via cron (see [Sending Data with Cron](http://support.kissmetrics.com/apis/cron) for more information). As of version 3.0, the default is `true`, which means data is saved to a local log file. Using cron is optional, but **recommended**.
 * `to_stderr`: allows toggling of printing output to `stderr`. Default is `true`.
-* `dryrun`: New option as of November 25, 2012. Toggles whether to send data to KISSmetrics, or just log it to a file to review for debugging. Default is `false`, which means data is sent to KISSmetrics, regardless of whether you're working in a production or development environment.
+* `dryrun`: New option as of November 25, 2012. Toggles whether to send data to Kissmetrics, or just log it to a file to review for debugging. Default is `false`, which means data is sent to Kissmetrics, regardless of whether you're working in a production or development environment.
 * `env`: Updated option as of November 25, 2012. The environment variable now just helps us name the log files that store the history of event requests. This uses the Rails and Rack variables to determine if your Ruby environment is in `development`. If the Rails and Rack variables are not available, we default to `production`.
+* `force_key`: Allows each individual request to specify the API key through the `_k` param. By default the `_k` is set on all requests using the value provided to `KMTS.init`. The `_k` key will default to the API key if no value is passed in. Defaults to **true**.
 
 ### Sample:
 
@@ -56,7 +61,7 @@ KMTS.alias('bob', 'bob@bob.com')
 
 ## Troubleshooting
 
-If you were watching for the events in [KISSmetrics Live](http://support.kissmetrics.com/tools/live) and did not see them, it helps to review what our library logged. In the log directory, you may see these files:
+If you were watching for the events in [Kissmetrics Live](https://support.kissmetrics.io/docs/live-1) and did not see them, it helps to review what our library logged. In the log directory, you may see these files:
 
 * `kissmetrics_production_sent.log`
 * `kissmetrics_production_query.log`

data/Rakefile

@@ -1,5 +1,10 @@
 require 'bundler'
-require 'rspec/core/rake_task'
 Bundler::GemHelper.install_tasks
 
-RSpec::Core::RakeTask.new(:spec)
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+end
+
+task default: 'spec'

data/doc/README_rdoc.html

@@ -33,21 +33,21 @@
     </div>
 
     <div id="project-metadata">
-      
-      
+
+
       <div id="fileindex-section" class="section project-section">
         <h3 class="section-header">Files</h3>
         <ul>
-        
+
           <li class="file"><a href="./Gemfile.html">Gemfile</a></li>
-        
+
           <li class="file"><a href="./README_rdoc.html">README.rdoc</a></li>
-        
+
           <li class="file"><a href="./Rakefile.html">Rakefile</a></li>
-        
+
         </ul>
       </div>
-      
+
 
       <div id="classindex-section" class="section project-section">
         <h3 class="section-header">Class Index
@@ -63,46 +63,46 @@
         </form>
 
         <ul class="link-list">
-        
+
           <li><a href="./KMTS.html">KMTS</a></li>
-        
+
           <li><a href="./KMTS/IdentError.html">KMTS::IdentError</a></li>
-        
+
           <li><a href="./KMTS/InitError.html">KMTS::InitError</a></li>
-        
+
           <li><a href="./KMTS/SaaS.html">KMTS::SaaS</a></li>
-        
+
           <li><a href="./Accept.html">Accept</a></li>
-        
+
           <li><a href="./Hash.html">Hash</a></li>
-        
+
           <li><a href="./Helper.html">Helper</a></li>
-        
+
           <li><a href="./KMError.html">KMError</a></li>
-        
+
           <li><a href="./Object.html">Object</a></li>
-        
+
           <li><a href="./String.html">String</a></li>
-        
+
         </ul>
         <div id="no-class-search-results" style="display: none;">No matching classes.</div>
       </div>
 
-      
+
     </div>
   </div>
 
   <div id="documentation">
-    
+
 <h1>Documentation</h1>
 
 <p>We are hosting our documentation for our Ruby API here: <a
-href="http://support.kissmetrics.com/apis/ruby">support.kissmetrics.com/apis/ruby</a></p>
+href="https://support.kissmetrics.io/reference#ruby">https://support.kissmetrics.io/reference#ruby</a></p>
 
 <h1>SaaS</h1>
 
 <p>This gem includes SaaS calls. For more information please refer to: <a
-href="http://support.kissmetrics.com/getting-started/saas_basics">support.kissmetrics.com/getting-started/saas_basics</a></p>
+href="https://support.kissmetrics.io/docs/saas-essentials">https://support.kissmetrics.io/docs/saas-essentials</a></p>
 
 <p>In order to get the API for SaaS, be sure to:</p>
 

data/kmts.gemspec

@@ -5,19 +5,20 @@ Gem::Specification.new do |s|
   s.name        = "kmts"
   s.version     = KMTS::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["KISSmetrics"]
-  s.email       = ["support@kissmetrics.com"]
+  s.license     = "Apache-2.0"
+  s.authors     = ["Kissmetrics"]
+  s.email       = ["support@kissmetrics.io"]
   s.homepage    = "https://github.com/kissmetrics/kmts"
-  s.summary     = "KISSmetrics threadsafe ruby API gem"
-  s.description = "KISSmetrics threadsafe ruby API gem"
+  s.summary     = "Threadsafe Ruby gem for Kissmetrics tracking API"
+  s.description = "A threadsafe Ruby gem that can be used to interact with the Kissmetrics tracking API."
 
   s.required_rubygems_version = ">= 1.3.6"
   s.rubyforge_project         = "kissmetrics"
 
-  s.add_development_dependency "bundler", ">= 1.0.0"
-  s.add_development_dependency "rspec", "~> 2.4.0"
-  s.add_development_dependency "rake"
-  s.add_development_dependency "json"
+  s.add_development_dependency "bundler", "~> 1.13"
+  s.add_development_dependency "rspec", "~> 3.5"
+  s.add_development_dependency "rake", "~> 12.0"
+  s.add_development_dependency "json", "~> 2.0"
 
   s.files        = `git ls-files`.split("\n")
   s.test_files   = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/kmts.rb

@@ -1,4 +1,5 @@
 require 'uri'
+require 'erb'
 require 'socket'
 require 'net/http'
 require 'fileutils'
@@ -7,13 +8,17 @@ require 'kmts/saas'
 class KMError < StandardError; end
 
 class KMTS
+  DEFAULT_TRACKING_SERVER = 'https://trk.kissmetrics.io'.freeze
+  PROTOCOL_MATCHER = %r(://)
+
   @key       = nil
   @logs      = {}
-  @host      = 'trk.kissmetrics.com:80'
+  @host      = DEFAULT_TRACKING_SERVER
   @log_dir   = '/tmp'
   @to_stderr = true
-  @use_cron  = false
+  @use_cron  = true
   @dryrun    = false
+  @force_key = true
 
   class << self
     class IdentError < StandardError; end
@@ -27,6 +32,7 @@ class KMTS
         :use_cron  => @use_cron,
         :dryrun    => @dryrun,
         :env       => set_env,
+        :force_key => @force_key
       }
       options = default.merge(options)
 
@@ -38,6 +44,7 @@ class KMTS
         @to_stderr = options[:to_stderr]
         @dryrun    = options[:dryrun]
         @env       = options[:env]
+        @force_key = options[:force_key]
         log_dir_writable?
       rescue Exception => e
         log_error(e)
@@ -121,12 +128,13 @@ class KMTS
       @id         = nil
       @key        = nil
       @logs       = {}
-      @host       = 'trk.kissmetrics.com:80'
+      @host       = DEFAULT_TRACKING_SERVER
       @log_dir    = '/tmp'
       @to_stderr  = true
       @use_cron   = false
       @env        = nil
       @force = false
+      @force_key  = true
     end
 
     def log_name(type)
@@ -143,7 +151,9 @@ class KMTS
       when :sent
         fname = "kissmetrics#{env}_sent.log"
       when :send
-        fname = Time.now.to_i.to_s + "kissmetrics_#{env}_sending.log"
+        now = Time.now.to_i
+        id = rand(2**64).to_s(16)
+        fname = "#{now}_#{id}_kissmetrics_#{env}_sending.log"
       end
       @logs[type] = File.join(@log_dir,fname)
     end
@@ -188,14 +198,17 @@ class KMTS
       query_arr = []
       query     = ''
       data.update('_p' => id) if id
-      data.update('_k' => @key)
-      data.update '_d' => 1 if data['_t']
+      data.update '_d' => 1 if data['_t'] || @use_cron
       data['_t'] ||= Time.now.to_i
-      
-      unsafe = Regexp.new("[^#{URI::REGEXP::PATTERN::UNRESERVED}]", false, 'N')
-      
+
+      if @force_key
+        data['_k'] = @key
+      else
+        data['_k'] ||= @key
+      end
+
       data.inject(query) do |query,key_val|
-        query_arr <<  key_val.collect { |i| URI.escape(i.to_s, unsafe) }.join('=')
+        query_arr <<  key_val.collect { |i| ERB::Util.url_encode(i.to_s) }.join('=')
       end
       query = '/' + type + '?' + query_arr.join('&')
       if @use_cron
@@ -215,11 +228,13 @@ class KMTS
         log_sent(line)
       else
         begin
-          host,port = @host.split(':')
-          proxy = URI.parse(ENV['http_proxy'] || ENV['HTTP_PROXY'] || '')
-          res = Net::HTTP::Proxy(proxy.host, proxy.port, proxy.user, proxy.password).start(host, port) do |http|
-            http.get(line)
-          end
+          host = @host
+          host = "http://#{host}" unless host =~ PROTOCOL_MATCHER
+          uri = URI.parse(host)
+
+          http = Net::HTTP.new(uri.host, uri.port)
+          http.use_ssl = uri.is_a?(URI::HTTPS)
+          http.get(line)
         rescue Exception => e
           raise KMError.new("#{e} for host #{@host}")
         end

data/lib/kmts/version.rb

@@ -1,3 +1,3 @@
 class KMTS
-  VERSION = "2.0.1"
+  VERSION = "3.1.0"
 end

data/spec/accept.rb

@@ -17,7 +17,7 @@ class Accept
 
     puts "Starting up server on port #{opts[:port]} ..."
     @opts           = opts
-    @server         = TCPServer.new(opts[:port])
+    @server         = TCPServer.new('127.0.0.1', opts[:port])
     @@input_history = []
     @handle         = Thread.start do
       loop do

data/spec/km_old.rb

@@ -2,15 +2,15 @@ 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'

data/spec/km_saas_spec.rb

@@ -3,8 +3,6 @@ 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
@@ -12,7 +10,7 @@ describe KMTS do
 
   describe "should record events" do
     before do
-      KMTS::init 'KM_KEY', :log_dir => __('log'), :host => '127.0.0.1:9292'
+      KMTS::init 'KM_KEY', :log_dir => __('log'), :host => 'http://127.0.0.1:9292'
     end
     context "plain usage" do
       it "records a signup event" do
@@ -56,13 +54,13 @@ describe KMTS do
         res[:query]['_n'].first.should == 'Canceled'
       end
       it "records a visited site event" do
-        KMTS.visited_site 'bob', 'http://duckduckgo.com', 'http://kissmetrics.com'
+        KMTS.visited_site 'bob', 'http://duckduckgo.com', 'http://kissmetrics.io'
         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'
+        res[:query]['Referrer'].first.should == 'http://kissmetrics.io'
       end
     end
     context "usage with props" do
@@ -97,7 +95,7 @@ describe KMTS do
         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'
+        KMTS.visited_site 'bob', 'http://duckduckgo.com', 'http://kissmetrics.io', :foo => 'bar'
         sleep 0.1
         res = Helper.accept(:history).first.indifferent
         res[:query]['foo'].first.should == 'bar'

data/spec/km_send_spec.rb

@@ -4,32 +4,33 @@ 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
+        KMTS::init 'KM_KEY', :log_dir => __('log'), :host => 'http://127.0.0.1:9292', :use_cron => true, :env => 'production'
       end
       it "should test commandline version" do
         KMTS::record 'bob', 'Signup', 'age' => 26
-        `bundle exec km_send #{__('log/')} 127.0.0.1:9292`
+        `bundle exec km_send #{__('log/')} http://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]['_d'].first.should == '1'
+        res[:query]['_t'].first.to_i.should be_within(10.0).of(Time.now.to_i)
         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`
+        `bundle exec km_send #{__('log/')} http://127.0.0.1:9292`
         sleep 0.1
         res = Helper.accept(:history).first.indifferent
         res[:path].should == '/e'
@@ -41,7 +42,7 @@ describe 'km_send' do
       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`
+        `bundle exec km_send #{__('log/')} http://127.0.0.1:9292`
         sleep 0.1
         res = Helper.accept(:history).first.indifferent
         res[:path].should == '/e'
@@ -54,7 +55,7 @@ describe 'km_send' do
       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`
+        `bundle exec km_send #{__('log/')} http://127.0.0.1:9292`
         sleep 0.1
         res = Helper.accept(:history).first.indifferent
         res[:path].should == '/e'
@@ -64,7 +65,7 @@ describe 'km_send' do
         res[:query]['_t'].first.should == '1297105499'
         res[:query]['age'].first.should == '27'
         Helper.clear
-        `bundle exec km_send #{__('log/')} 127.0.0.1:9292`
+        `bundle exec km_send #{__('log/')} http://127.0.0.1:9292`
         sleep 0.1
         res = Helper.accept(:history).first.indifferent
         res[:path].should == '/e'
@@ -76,22 +77,23 @@ describe 'km_send' do
       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`
+        `bundle exec km_send -e alpha #{__('log/')} http://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::init 'KM_KEY', :log_dir => __('log'), :host => 'http://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`
+      `bundle exec km_send -f -e development #{__('log/')} http://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]['_d'].first.should == '1'
+      res[:query]['_t'].first.to_i.should be_within(10.0).of(Time.now.to_i)
       res[:query]['age'].first.should == '26'
     end
   end

data/spec/km_spec.rb

@@ -2,8 +2,6 @@ require 'setup'
 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
@@ -19,7 +17,7 @@ describe KMTS do
   end
 
   it "shouldn't fail on alias without identifying" do
-    KMTS::init 'KM_OTHER', :log_dir => __('log'), :host => '127.0.0.1:9292'
+    KMTS::init 'KM_OTHER', :log_dir => __('log'), :host => 'http://127.0.0.1:9292'
     KMTS::alias 'peter','joe' # Alias "bob" to "robert"
     sleep 0.1
     res = Helper.accept(:history).first.indifferent
@@ -27,11 +25,11 @@ describe KMTS do
     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
+    res[:query]['_t'].first.to_i.should be_within(2.0).of(Time.now.to_i)
   end
 
   it "shouldn't fail on alias without identifying from commandline" do
-    KMTS::init 'KM_OTHER', :log_dir => __('log'), :host => '127.0.0.1:9292'
+    KMTS::init 'KM_OTHER', :log_dir => __('log'), :host => 'http://127.0.0.1:9292'
     KMTS::alias 'peter','joe' # Alias "bob" to "robert"
     sleep 0.1
     res = Helper.accept(:history).first.indifferent
@@ -39,12 +37,20 @@ describe KMTS do
     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
+    res[:query]['_t'].first.to_i.should be_within(2.0).of(Time.now.to_i)
+  end
+
+  it "should allow sending to https endpoints" do
+    lambda do
+      allow(KMTS).to receive(:log_error).and_raise('Error')
+      KMTS::init 'KM_OTHER', :log_dir => __('log'), :host => 'https://trk.kissmetrics.io/'
+      KMTS::record 'bob', 'My Action'
+    end.should_not raise_error
   end
 
   describe "should record events" do
     before do
-      KMTS::init 'KM_KEY', :log_dir => __('log'), :host => '127.0.0.1:9292'
+      KMTS::init 'KM_KEY', :log_dir => __('log'), :host => 'http://127.0.0.1:9292'
     end
     it "records an action with no action-specific properties" do
       KMTS::record 'bob', 'My Action'
@@ -54,7 +60,7 @@ describe KMTS do
       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
+      res[:query]['_t'].first.to_i.should be_within(2.0).of(Time.now.to_i)
     end
     it "records an action with properties" do
       KMTS::record 'bob', 'Signup', 'age' => 26
@@ -64,7 +70,7 @@ describe KMTS do
       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]['_t'].first.to_i.should be_within(2.0).of(Time.now.to_i)
       res[:query]['age'].first.should == 26.to_s
     end
     it "should be able to hace spaces in key and value" do
@@ -75,7 +81,7 @@ describe KMTS do
       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]['_t'].first.to_i.should be_within(2.0).of(Time.now.to_i)
       res[:query]['age'].first.should == 26.to_s
       res[:query]['city of residence'].first.should == 'eug ene'
     end
@@ -87,7 +93,7 @@ describe KMTS do
       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]['_t'].first.to_i.should be_within(2.0).of(Time.now.to_i)
       res[:query]['age'].first.should == 26.to_s
     end
     it "should work with propps using @" do
@@ -97,7 +103,7 @@ describe KMTS do
       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]['_t'].first.to_i.should be_within(2.0).of(Time.now.to_i)
       res[:query]['email'].first.should == 'test@blah.com'
     end
     it "should just set properties without event" do
@@ -107,7 +113,7 @@ describe KMTS do
       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]['_t'].first.to_i.should be_within(2.0).of(Time.now.to_i)
       res[:query]['age'].first.should == 26.to_s
     end
     it "should be able to use km set directly" do
@@ -117,7 +123,7 @@ describe KMTS do
       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]['_t'].first.to_i.should be_within(2.0).of(Time.now.to_i)
       res[:query]['age'].first.should == 26.to_s
     end
     it "should work with multiple lines" do
@@ -131,13 +137,13 @@ describe KMTS do
       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]['_t'].first.to_i.should be_within(2.0).of(Time.now.to_i)
       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]['_t'].first.to_i.should be_within(2.0).of(Time.now.to_i)
       res[:query]['age'].first.should == 36.to_s
     end
     it "should not have key hardcoded anywhere" do
@@ -149,7 +155,35 @@ describe KMTS do
       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
+      res[:query]['_t'].first.to_i.should be_within(2.0).of(Time.now.to_i)
+    end
+
+    it "allows overriding of km_key" do
+      KMTS::init 'KM_OTHER', :log_dir => __('log'), :force_key => false
+      KMTS::record 'bob', 'Signup', 'age' => 36, '_k' => 'OTHER_KEY'
+      sleep 0.1
+
+      res = Helper.history.first.indifferent
+      res[:path].should == '/e'
+      res[:query]['_k'].first.should == 'OTHER_KEY'
+      res[:query]['_p'].first.should == 'bob'
+      res[:query]['_n'].first.should == 'Signup'
+      res[:query]['_t'].first.to_i.should be_within(2.0).of(Time.now.to_i)
+      res[:query]['age'].first.should == 36.to_s
+    end
+
+    it "uses default key when force_key is disabled" do
+      KMTS::init 'KM_OTHER', :log_dir => __('log'), :force_key => false
+      KMTS::record 'bob', 'Signup', 'age' => 36
+      sleep 0.1
+
+      res = Helper.history.first.indifferent
+      res[:path].should == '/e'
+      res[:query]['_k'].first.should == 'KM_OTHER'
+      res[:query]['_p'].first.should == 'bob'
+      res[:query]['_n'].first.should == 'Signup'
+      res[:query]['_t'].first.to_i.should be_within(2.0).of(Time.now.to_i)
+      res[:query]['age'].first.should == 36.to_s
     end
   end
   context "reading from files" do
@@ -160,14 +194,14 @@ describe KMTS do
       KMTS.reset
     end
     it "should run fine even though there's no server to connect to" do
-      KMTS::init 'KM_OTHER', :log_dir => __('log'), :host => '127.0.0.1:9291', :to_stderr => false
+      KMTS::init 'KM_OTHER', :log_dir => __('log'), :host => '127.0.0.1:9291', :to_stderr => false, :env => 'production'
       KMTS::record 'bob', '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
-      KMTS::init 'KM_OTHER', :log_dir => __('log'), :host => '127.0.0.1:9292', :to_stderr => false, :use_cron => true
+      KMTS::init 'KM_OTHER', :log_dir => __('log'), :host => 'http://127.0.0.1:9292', :to_stderr => false, :use_cron => true
       KMTS::record 'bob', 'prop_with_@_in' # records an action with no action-specific properties;
       IO.readlines(KMTS::log_name(:query)).join.should_not contain_string('@')
     end

data/spec/setup.rb

@@ -17,7 +17,7 @@ end
 
 class Helper
   def self.accept(cmd)
-    c = TCPSocket.new('localhost', 9292)
+    c = TCPSocket.new('127.0.0.1', 9292)
     c.puts cmd.to_s
     return JSON.parse(c.read) rescue nil
   end
@@ -75,3 +75,7 @@ def write_log(type, content)
 end
 
 accept = Accept.new
+
+RSpec.configure do |config|
+  config.expect_with(:rspec) { |c| c.syntax = :should }
+end

metadata

@@ -1,86 +1,87 @@
 --- !ruby/object:Gem::Specification
 name: kmts
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 3.1.0
 platform: ruby
 authors:
-- KISSmetrics
+- Kissmetrics
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-08 00:00:00.000000000 Z
+date: 2020-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.13'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: KISSmetrics threadsafe ruby API gem
+        version: '2.0'
+description: A threadsafe Ruby gem that can be used to interact with the Kissmetrics
+  tracking API.
 email:
-- support@kissmetrics.com
+- support@kissmetrics.io
 executables:
 - km_send
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".travis.yml"
 - CHANGELOG
 - Gemfile
 - Gemfile.lock
 - LICENSE
 - README.md
-- README.rdoc
 - Rakefile
 - bin/km_send
 - doc/Accept.html
@@ -147,7 +148,8 @@ files:
 - spec/setup.rb
 - spec/watchr.rb
 homepage: https://github.com/kissmetrics/kmts
-licenses: []
+licenses:
+- Apache-2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -155,20 +157,19 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubyforge_project: kissmetrics
-rubygems_version: 2.0.3
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: KISSmetrics threadsafe ruby API gem
+summary: Threadsafe Ruby gem for Kissmetrics tracking API
 test_files:
 - spec/accept.rb
 - spec/km_old.rb

data/README.rdoc

@@ -1,14 +0,0 @@
-= Documentation
-
-We are hosting our documentation for our Ruby API here: http://support.kissmetrics.com/apis/ruby
-
-= Installation
-
-  gem install kmts
-
-= SaaS
-
-This gem includes SaaS calls. For more information please refer to:
-http://support.kissmetrics.com/getting-started/saas_basics
-
-For the methods used, see the {rdoc for SaaS}[link:KMTS/SaaS.html]