kmts 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 461172f5701b7d8840f666b3131bac59f8ea42ac
-  data.tar.gz: dc35083fbcc97e01fd7aaace188202a7e3d4af06
+  metadata.gz: d062019c23e872496154215188aa3303a540f16d
+  data.tar.gz: d0ac18313b30ebada5046e7f391e66b2cb21b41c
 SHA512:
-  metadata.gz: 1cf189936af9fc333ce783aeb05225f4d9bb4ebbeeafaab6c1a05891750ca76846729e87b25940a228cab5d106bf5db7847420d745b97b96f1cefe9594530547
-  data.tar.gz: 66f001d5e5f7e667f9590f6454ef1e71d6da62ec2b5b1ba60fc2eb4918609b5da6b9c9c0fb45d178eeadb6cca953b77c0f17f34bbdc9bfa804b41546094423e6
+  metadata.gz: 543a825b9ab4943ff00682fac683d48d9f8bd2e510d9a72de30857db9e23544ad5d5d7fc0b007ef3a42a7afc41250ebeb0fc63ff4988e2aac3d6acc4d1402508
+  data.tar.gz: d94347a16e24ba5f6370cae4629f38ce68f117f42d8718e53acaf4ad0795f75d2a6f8f878b6e2040331d341b41760300ffd561d83f1b81c0a42af87bb69018ff

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    kmts (3.0.0)
+    kmts (3.0.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -35,6 +35,7 @@ The available options are:
 * `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.
 * `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:
 

data/lib/kmts.rb

@@ -17,6 +17,7 @@ class KMTS
   @to_stderr = true
   @use_cron  = true
   @dryrun    = false
+  @force_key = true
 
   class << self
     class IdentError < StandardError; end
@@ -30,6 +31,7 @@ class KMTS
         :use_cron  => @use_cron,
         :dryrun    => @dryrun,
         :env       => set_env,
+        :force_key => @force_key
       }
       options = default.merge(options)
 
@@ -41,6 +43,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)
@@ -130,6 +133,7 @@ class KMTS
       @use_cron   = false
       @env        = nil
       @force = false
+      @force_key  = true
     end
 
     def log_name(type)
@@ -191,10 +195,15 @@ class KMTS
       query_arr = []
       query     = ''
       data.update('_p' => id) if id
-      data.update('_k' => @key)
       data.update '_d' => 1 if data['_t'] || @use_cron
       data['_t'] ||= Time.now.to_i
 
+      if @force_key
+        data['_k'] = @key
+      else
+        data['_k'] ||= @key
+      end
+
       unsafe = Regexp.new("[^#{URI::REGEXP::PATTERN::UNRESERVED}]", false, 'N')
 
       data.inject(query) do |query,key_val|

data/lib/kmts/version.rb

@@ -1,3 +1,3 @@
 class KMTS
-  VERSION = "3.0.0"
+  VERSION = "3.0.1"
 end

data/spec/km_spec.rb

@@ -157,6 +157,34 @@ describe KMTS do
       res[:query]['_n'].first.should == 'harry'
       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
     before do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kmts
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Kissmetrics
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-04 00:00:00.000000000 Z
+date: 2017-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler