km 1.1.3 → 1.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a89b64035c1a9d1996e1f616df410ae7c33f418d7cc270383dd57ae8ddbd325c
+  data.tar.gz: f9703377aa66bedb75242e1b6f9658300626bed5ce3c3fd1bb8aef2f01cb4f93
+SHA512:
+  metadata.gz: f5bde36d4e54a90618df8c49461b2fce0fbd1da3a0cdbb4349b4eda3f125be3b824dd5d6516abc6ba46ef8a02ab4b161b56cf924e1ce87ee964b087c9108bc59
+  data.tar.gz: 0a656e53e5c23e39c453bb4024b44c676ff8716eb1655946ffba3e6ef07a95b9c6f89db653f4e9e793d5d0ea63eea87730b079d77d7f4ea34d70e60fd6956692

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    km (1.1.3)
+    km (1.3.0)
 
 GEM
   remote: http://rubygems.org/

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.rdoc

@@ -1,6 +1,16 @@
 = Documentation
 
-We are hosting our documentation for our Ruby API here: http://support.kissmetrics.com/apis/ruby
+<b>The original +km+ Ruby gem is not thread safe.</b> We have released a new gem, {kmts}[https://github.com/kissmetrics/kmts], that is threadsafe.
+
+We are hosting our documentation for our Ruby API here: https://support.kissmetrics.io/reference#ruby
+
+= +kmts+ version 1.0.2
+
+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+ gem, or update your code to use the thread-safe +kmts+ gem version >= 2.0.0.
+
+= km version 1.3.0
+
+This version uses the `trk.kissmetrics.io` tracking server domain.
 
 = Installation
 
@@ -9,6 +19,6 @@ We are hosting our documentation for our Ruby API here: http://support.kissmetri
 = SaaS
 
 This gem includes SaaS calls. For more information please refer to:
-http://support.kissmetrics.com/getting-started/saas_basics
+https://support.kissmetrics.io/docs/saas-essentials
 
 For the methods used, see the {rdoc for SaaS}[link:KM/SaaS.html]

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="./KM.html">KM</a></li>
-        
+
           <li><a href="./KM/IdentError.html">KM::IdentError</a></li>
-        
+
           <li><a href="./KM/InitError.html">KM::InitError</a></li>
-        
+
           <li><a href="./KM/SaaS.html">KM::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">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">support.kissmetrics.io/docs/saas-essentials</a></p>
 
 <p>In order to get the API for SaaS, be sure to:</p>
 

data/km.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |s|
   s.version     = KM::VERSION
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["KISSmetrics"]
-  s.email       = ["support@kissmetrics.com"]
+  s.email       = ["support@kissmetrics.io"]
   s.homepage    = "https://github.com/kissmetrics/km"
   s.summary     = "KISSmetrics ruby API gem"
   s.description = "KISSmetrics ruby API gem"

data/lib/km.rb

@@ -10,7 +10,7 @@ class KM
   @id        = nil
   @key       = nil
   @logs      = {}
-  @host      = 'trk.kissmetrics.com:80'
+  @host      = 'trk.kissmetrics.io:80'
   @log_dir   = '/tmp'
   @to_stderr = true
   @use_cron  = false
@@ -20,6 +20,8 @@ class KM
     class IdentError < StandardError; end
     class InitError < StandardError; end
 
+    attr_reader :key
+
     def init(key, options={})
       default = {
         :host      => @host,
@@ -126,7 +128,7 @@ class KM
       @id         = nil
       @key        = nil
       @logs       = {}
-      @host       = 'trk.kissmetrics.com:80'
+      @host       = 'trk.kissmetrics.io:80'
       @log_dir    = '/tmp'
       @to_stderr  = true
       @use_cron   = false
@@ -192,12 +194,12 @@ class KM
       query_arr = []
       query     = ''
       data.update('_p' => @id) unless update == false
-      data.update('_k' => @key)
-      data.update '_d' => 1 if data['_t']
+      data.update('_k' => key)
+      data.update '_d' => 1
       data['_t'] ||= Time.now.to_i
-      
+
       unsafe = Regexp.new("[^#{URI::REGEXP::PATTERN::UNRESERVED}]", false, 'N')
-      
+
       data.inject(query) do |query,key_val|
         query_arr <<  key_val.collect { |i| URI.escape(i.to_s, unsafe) }.join('=')
       end
@@ -251,7 +253,7 @@ class KM
     end
 
     def is_initialized?
-      if @key == nil
+      if key == nil
         log_error InitError.new("Need to initialize first (KM::init <your_key>)")
         return false
       end

data/lib/km/version.rb

@@ -1,3 +1,3 @@
 class KM
-  VERSION = "1.1.3"
+  VERSION = "1.3.0"
 end

data/spec/km_saas_spec.rb

@@ -64,13 +64,13 @@ describe KM do
         res[:query]['_n'].first.should == 'Canceled'
       end
       it "records a visited site event" do
-        KM.visited_site 'http://duckduckgo.com', 'http://kissmetrics.com'
+        KM.visited_site '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
@@ -111,7 +111,7 @@ describe KM do
         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'
+        KM.visited_site '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_spec.rb

@@ -182,4 +182,12 @@ describe KM do
       IO.readlines(KM::log_name(:query)).join.should_not contain_string('@')
     end
   end
+
+  describe ".key" do
+    it "should return the key" do
+      key = "4923i50934u54309h"
+      KM::init(key)
+      KM::key.should == key
+    end
+  end
 end

metadata

@@ -1,92 +1,84 @@
 --- !ruby/object:Gem::Specification
 name: km
 version: !ruby/object:Gem::Version
-  version: 1.1.3
-  prerelease: 
+  version: 1.3.0
 platform: ruby
 authors:
 - KISSmetrics
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-02 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
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.4.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: KISSmetrics ruby API gem
 email:
-- support@kissmetrics.com
+- support@kissmetrics.io
 executables:
 - km_send
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - CHANGELOG
 - Gemfile
 - Gemfile.lock
+- LICENSE
 - README.rdoc
 - Rakefile
 - bin/km_send
@@ -155,30 +147,25 @@ files:
 - spec/watchr.rb
 homepage: https://github.com/kissmetrics/km
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3712010892193717644
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubyforge_project: kissmetrics
-rubygems_version: 1.8.24
+rubygems_version: 3.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: KISSmetrics ruby API gem
 test_files:
 - spec/accept.rb