km 1.1.2 → 1.1.3

data/.gitignore

@@ -2,3 +2,4 @@ pkg/*
 *.gem
 .bundle
 spec/log/*
+.rvmrc

data/Gemfile.lock

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

data/bin/km_send

@@ -4,11 +4,17 @@ require 'optparse'
 require 'km'
 
 env = 'production'
+force = false
 begin
   parser = OptionParser.new()
   parser.banner = "#{File.basename($0)} [<log_dir>]\n\n"
+
+  parser.on("-f", "--force", "Force sending the data to KM, ignoring the environment.") do |e|
+    force = true
+  end
+
   parser.on("-e", "--env ENVIRONMENT", "The environment to run in. Default: production") do |e|
-    puts "Note, only production will actually send queries to the kissmetrics servers."
+    puts "Note, only production will actually send queries to the kissmetrics servers unless the --force flag is used." unless force
     env = e
   end
 
@@ -24,5 +30,6 @@ rescue => e
   exit(-1)
 end
 
-KM.init('', :log_dir => opts[0] || KM.log_dir, :host => opts[1] || KM.host, :env => env)
+
+KM.init('', :log_dir => opts[0] || KM.log_dir, :host => opts[1] || KM.host, :force => force, :env => env)
 KM.send_logged_queries

data/lib/km.rb

@@ -14,6 +14,7 @@ class KM
   @log_dir   = '/tmp'
   @to_stderr = true
   @use_cron  = false
+  @dryrun    = false
 
   class << self
     class IdentError < StandardError; end
@@ -25,6 +26,7 @@ class KM
         :log_dir   => @log_dir,
         :to_stderr => @to_stderr,
         :use_cron  => @use_cron,
+        :dryrun    => @dryrun,
         :env       => set_env,
       }
       options = default.merge(options)
@@ -35,6 +37,7 @@ class KM
         @log_dir   = options[:log_dir]
         @use_cron  = options[:use_cron]
         @to_stderr = options[:to_stderr]
+        @dryrun    = options[:dryrun]
         @env       = options[:env]
         log_dir_writable?
       rescue Exception => e
@@ -120,13 +123,15 @@ class KM
       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
+      @id         = nil
+      @key        = nil
+      @logs       = {}
+      @host       = 'trk.kissmetrics.com:80'
+      @log_dir    = '/tmp'
+      @to_stderr  = true
+      @use_cron   = false
+      @env        = nil
+      @force = false
     end
 
     def log_name(type)
@@ -210,20 +215,20 @@ class KM
     end
 
     def send_query(line)
-      if @env != 'production'
+      if @dryrun
         log_sent(line)
-        return
-      end
-      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)
+      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
+        rescue Exception => e
+          raise KMError.new("#{e} for host #{@host}")
         end
-      rescue Exception => e
-        raise KMError.new("#{e} for host #{@host}")
+        log_sent(line)
       end
-      log_sent(line)
     end
 
     def log_dir_writable?

data/lib/km/version.rb

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

data/spec/km_send_spec.rb

@@ -11,11 +11,82 @@ describe 'km_send' do
       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
+    context "with default environment" do
+      before do
+        KM::init 'KM_KEY', :log_dir => __('log'), :host => '127.0.0.1:9292', :use_cron => true
+      end
+      it "should test commandline version" do
+        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 "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`
+        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
+      KM::init 'KM_KEY', :log_dir => __('log'), :host => '127.0.0.1:9292', :use_cron => true, :env => 'development', :force => true
       KM::identify 'bob'
       KM::record 'Signup', 'age' => 26
-      `bundle exec km_send #{__('log/')} 127.0.0.1:9292`
+      `bundle exec km_send -f -e development #{__('log/')} 127.0.0.1:9292`
       sleep 0.1
       res = Helper.accept(:history).first.indifferent
       res[:path].should == '/e'
@@ -25,58 +96,5 @@ describe 'km_send' do
       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

data/spec/km_spec.rb

@@ -175,7 +175,6 @@ describe KM do
       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'

metadata

@@ -1,84 +1,88 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: km
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 1
-  - 1
-  - 2
-  version: 1.1.2
+version: !ruby/object:Gem::Version
+  version: 1.1.3
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - KISSmetrics
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-04-30 00:00:00 -05:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: bundler
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 0
-        - 0
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
+  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 
-        segments: 
-        - 2
-        - 4
-        - 0
+      - !ruby/object:Gem::Version
         version: 2.4.0
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  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
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: json
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  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
-  version_requirements: *id004
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: KISSmetrics ruby API gem
-email: 
+email:
 - support@kissmetrics.com
-executables: 
+executables:
 - km_send
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - CHANGELOG
 - Gemfile
@@ -149,39 +153,34 @@ files:
 - spec/log/.hold
 - spec/setup.rb
 - spec/watchr.rb
-has_rdoc: true
 homepage: https://github.com/kissmetrics/km
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 1
-      - 3
-      - 6
+      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.3.6
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: KISSmetrics ruby API gem
-test_files: 
+test_files:
 - spec/accept.rb
 - spec/km_old.rb
 - spec/km_saas_spec.rb