kronk 1.7.8 → 1.8.0

data/History.rdoc

@@ -1,3 +1,35 @@
+=== 1.8.0 / 2011-12
+
+* Major Enhancements:
+
+  * Support for TSV player output (read gnuplot).
+
+  * Removed evented model support; too costly to maintain.
+
+* Enhancements:
+
+  * Parsed Response headers now also return parsed cookies.
+
+  * Many Player performance improvements.
+
+  * Player outputs are now Player subclasses.
+
+  * Support for setting player qps.
+
+  * Support for response streaming.
+
+  * Support for gzip and inflate decoding.
+
+  * Diff accuracy improvements.
+
+  * Support forwarding HTTP auth information to redirected hosts.
+
+* Bugfixes:
+
+  * Pass request init options to redirects.
+
+  * QueueRunner multithreading fix for Rubys with no GIL.
+
 === 1.7.8 / 2011-11-10
 
 * Enhancements:

data/Manifest.txt

@@ -5,10 +5,6 @@ README.rdoc
 Rakefile
 bin/kronk
 lib/kronk.rb
-lib/kronk/async.rb
-lib/kronk/async/em_ext.rb
-lib/kronk/async/request.rb
-lib/kronk/async/response.rb
 lib/kronk/cmd.rb
 lib/kronk/constants.rb
 lib/kronk/core_ext.rb
@@ -17,6 +13,8 @@ lib/kronk/diff.rb
 lib/kronk/diff/ascii_format.rb
 lib/kronk/diff/color_format.rb
 lib/kronk/diff/output.rb
+lib/kronk/http.rb
+lib/kronk/buffered_io.rb
 lib/kronk/path.rb
 lib/kronk/path/matcher.rb
 lib/kronk/path/match.rb
@@ -24,10 +22,10 @@ lib/kronk/path/transaction.rb
 lib/kronk/player.rb
 lib/kronk/player/benchmark.rb
 lib/kronk/player/input_reader.rb
-lib/kronk/player/output.rb
 lib/kronk/player/request_parser.rb
 lib/kronk/player/suite.rb
 lib/kronk/player/stream.rb
+lib/kronk/player/tsv.rb
 lib/kronk/plist_parser.rb
 lib/kronk/queue_runner.rb
 lib/kronk/request.rb
@@ -38,6 +36,8 @@ lib/kronk/test/helper_methods.rb
 lib/kronk/xml_parser.rb
 lib/kronk/yaml_parser.rb
 script/kronk_completion
+test/mocks/200_gzip.txt
+test/mocks/200_inflate.txt
 test/mocks/200_response.json
 test/mocks/200_response.plist
 test/mocks/200_response.txt

data/README.rdoc

@@ -116,13 +116,15 @@ Disabling cookies altogether may be done as so:
 Setting URI-specific config options - useful if you always need to send
 headers or use one-off configs. Each URI option key is dropped in a regexp
 to match against the given URIs so this also works for local files.
-See Kronk::Request.retrieve and Kronk::Response#selective_data
+See Kronk::Request.new, Kronk::Response.new and Kronk::Response#data
 for all options supported:
 
   uri_options:
     example.com:
-      parser:      XMLParser
-      http_method: POST
+      parser:         XMLParser
+      allow_encoding: gzip;q=1.0
+      force_gzip:     true
+      http_method:    POST
 
       follow_redirects: true
 

data/Rakefile

@@ -25,10 +25,9 @@ Hoe.spec 'kronk' do
   self.extra_deps << ['json',      '~>1.5']
   self.extra_deps << ['cookiejar', '~>0.3.0']
 
-  self.extra_dev_deps << ['plist',           '~>3.1.0']
-  self.extra_dev_deps << ['nokogiri',        '~>1.4']
-  self.extra_dev_deps << ['mocha',           '~>0.9.12']
-  self.extra_dev_deps << ['em-http-request', '~>1.0.0']
+  self.extra_dev_deps << ['plist',    '~>3.1.0']
+  self.extra_dev_deps << ['nokogiri', '~>1.4']
+  self.extra_dev_deps << ['mocha',    '~>0.9.12']
 end
 
 

data/TODO.rdoc

@@ -1,19 +1,35 @@
 = TODO
 
-* QPS for player.
+== Maybe Later
 
-* Support for response streaming.
-
-* Support for X-Url-\d and x-alt-location-\d redirects.
+* Animate Suite player cursor when waiting for input.
 
-* Support for gzip.
+* Consider getting off of net/http.
 
-* Player input IO timeout.
+* Consider allowing Output-specific cmd options.
 
 * Investigate Kronk console.
 
+== Not Viable
+
+* Use persistent connection pools.
+
 == Done
 
+* GNU-Plot support.
+
+* Parsed cookie diffing.
+
+* Refactor player Output to inherit Player.
+
+* Revisit how QueueRunner handles SIGINT.
+
+* QPS option for player.
+
+* Support for gzip.
+
+* Support for response streaming.
+
 * Investigate the use of EM for QueueRunner.
 
 * Refactor Kronk::Player into a Player and a QueueRunner.

data/lib/kronk.rb

@@ -8,21 +8,22 @@ require 'stringio'
 require 'base64'
 
 require 'net/https'
+require 'zlib'
 require 'optparse'
 require 'yaml'
 
 class Kronk
 
   # This gem's version.
-  VERSION = '1.7.8'
+  VERSION = '1.8.0'
 
   require 'kronk/constants'
   require 'kronk/queue_runner'
   require 'kronk/player'
-  require 'kronk/player/output'
   require 'kronk/player/suite'
   require 'kronk/player/stream'
   require 'kronk/player/benchmark'
+  require 'kronk/player/tsv'
   require 'kronk/player/request_parser'
   require 'kronk/player/input_reader'
   require 'kronk/cmd'
@@ -35,8 +36,10 @@ class Kronk
   require 'kronk/diff/color_format'
   require 'kronk/diff/output'
   require 'kronk/diff'
-  require 'kronk/response'
+  require 'kronk/http'
+  require 'kronk/buffered_io'
   require 'kronk/request'
+  require 'kronk/response'
   require 'kronk/plist_parser'
   require 'kronk/xml_parser'
   require 'kronk/yaml_parser'
@@ -306,6 +309,9 @@ class Kronk
           str2 = res2.stringify
          end
 
+    t1.abort_on_exception = true
+    t2.abort_on_exception = true
+
     t1.join
     t2.join
 
@@ -324,18 +330,18 @@ class Kronk
   def request uri
     options = Kronk.config[:no_uri_options] ? @options : options_for_uri(uri)
 
-    if IO === uri || StringIO === uri
+    if IO === uri || StringIO === uri || BufferedIO === uri
       Cmd.verbose "Reading IO #{uri}"
-      resp = Response.new uri
+      resp = Response.new uri, options
 
     elsif File.file? uri.to_s
       Cmd.verbose "Reading file:  #{uri}\n"
-      resp = Response.read_file uri
+      resp = Response.read_file uri, options
 
     else
       req = Request.new uri, options
       Cmd.verbose "Retrieving URL:  #{req.uri}\n"
-      resp = req.retrieve
+      resp = req.retrieve options
       Kronk.history << uri
     end
 

data/lib/kronk/buffered_io.rb

@@ -0,0 +1,26 @@
+class Kronk
+
+  ##
+  # Wrapper for Net::BufferedIO
+
+  class BufferedIO < Net::BufferedIO
+
+    attr_accessor :raw_output
+    attr_accessor :response
+
+    def initialize io
+      super
+      @raw_output = nil
+      @response   = nil
+    end
+
+
+    private
+
+    def rbuf_consume len
+      str = super
+      @raw_output << str if @raw_output
+      str
+    end
+  end
+end

data/lib/kronk/cmd.rb

@@ -6,7 +6,7 @@ class Kronk
   class Cmd
 
     RESCUABLE = [
-      Kronk::Exception, Timeout::Error,
+      Kronk::Error, Timeout::Error,
       SocketError, SystemCallError, URI::InvalidURIError
     ]
 
@@ -152,7 +152,7 @@ Parse and run diffs against data from live and cached http responses.
         end
 
 
-        opt.on('--config STR', String,
+        opt.on('--config FILE', String,
                'Load the given Kronk config file') do |value|
           Kronk.load_config value
         end
@@ -170,7 +170,7 @@ Parse and run diffs against data from live and cached http responses.
 
 
         opt.on('--format STR', String,
-               'Use a custom diff formatter') do |value|
+               'Use a custom diff formatter class') do |value|
           Kronk.config[:diff_format] = value
         end
 
@@ -180,6 +180,11 @@ Parse and run diffs against data from live and cached http responses.
         end
 
 
+        opt.on('--gzip', 'Force decode body with gZip') do
+          options[:force_gzip] = true
+        end
+
+
         opt.on('-i', '--include [HEADER1,HEADER2]', Array,
                'Include all or given headers in response') do |value|
           options[:show_headers] ||= []
@@ -215,6 +220,11 @@ Parse and run diffs against data from live and cached http responses.
         end
 
 
+        opt.on('--inflate', 'Force decode body with Zlib Inflate') do
+          options[:force_inflate] = true
+        end
+
+
         opt.on('--irb', 'Start an IRB console with the response') do
           options[:irb] = true
         end
@@ -246,24 +256,24 @@ Parse and run diffs against data from live and cached http responses.
         end
 
 
-        opt.on('-R', '--raw', 'Run diff on the raw data returned') do
+        opt.on('-R', '--raw', 'Don\'t parse the response') do
           options[:raw] = true
         end
 
 
         opt.on('-r', '--require LIB1,LIB2', Array,
-               'Require a library or gem') do |value|
+               'Load a file or gem before execution') do |value|
           options[:requires] ||= []
           options[:requires].concat value
         end
 
 
-        opt.on('--ruby', 'Use legacy Ruby renderer') do
+        opt.on('--ruby', 'Output Ruby instead of JSON') do
           Kronk.config[:render_lang] = 'ruby'
         end
 
 
-        opt.on('--struct', 'Run diff on the data structure') do
+        opt.on('--struct', 'Return data types instead of values') do
           options[:struct] = true
         end
 
@@ -279,7 +289,7 @@ Parse and run diffs against data from live and cached http responses.
         STR
 
         opt.on('-c', '--concurrency NUM', Integer,
-               'Number of concurrent requests to make; default: 1') do |num|
+               'Number of simultaneous connections; default: 1') do |num|
           options[:player][:concurrency] = num
         end
 
@@ -292,29 +302,41 @@ Parse and run diffs against data from live and cached http responses.
 
         opt.on('-o', '--replay-out [FORMAT]',
                'Output format used by --replay; default: stream') do |output|
-          options[:player][:output] = output || :stream
+          options[:player][:type] = output || :stream
         end
 
 
         opt.on('-p', '--replay [FILE]',
-                'Replay the given file or STDIN against URIs') do |file|
+               'Replay the given file or STDIN against URIs') do |file|
           options[:player][:io]   = File.open(file, "r") if file
           options[:player][:io] ||= $stdin if !$stdin.tty?
-          options[:player][:output] ||= :suite
         end
 
 
-        opt.on('--benchmark [FILE]', 'Same as -p [FILE] -o benchmark') do |file|
+        opt.on('--qps NUM', Integer,
+               'Number of queries per second to make; overrides -c') do |num|
+          options[:player][:qps] = num
+        end
+
+
+        opt.on('--benchmark [FILE]',
+               'Print benchmark data; same as -p [FILE] -o benchmark') do |file|
           options[:player][:io]   = File.open(file, "r") if file
-          options[:player][:io] ||= $stdin if !$stdin.tty?
-          options[:player][:output] = :benchmark
+          options[:player][:type] = :benchmark
         end
 
 
-        opt.on('--stream [FILE]', 'Same as -p [FILE] -o stream') do |file|
+        opt.on('--stream [FILE]',
+               'Print response stream; same as -p [FILE] -o stream') do |file|
           options[:player][:io]   = File.open(file, "r") if file
-          options[:player][:io] ||= $stdin if !$stdin.tty?
-          options[:player][:output] = :stream
+          options[:player][:type] = :stream
+        end
+
+
+        opt.on('--tsv [FILE]',
+               'Print TSV metrics; same as -p [FILE] -o tsv') do |file|
+          options[:player][:io]   = File.open(file, "r") if file
+          options[:player][:type] = :tsv
         end
 
 
@@ -328,6 +350,12 @@ Parse and run diffs against data from live and cached http responses.
         end
 
 
+        opt.on('--compressed',
+               'Request compressed response (using deflate or gzip)') do
+          options[:accept_encoding] = %w{gzip;q=1.0 deflate;q=0.6}
+        end
+
+
         opt.on('-d', '--data STR', String,
                'Post data with the request') do |value|
           options[:data] = value
@@ -356,6 +384,13 @@ Parse and run diffs against data from live and cached http responses.
         end
 
 
+        opt.on('--location-trusted [NUM]', Integer,
+               'Follow location and send auth to other hosts') do |value|
+          options[:trust_location]   = true
+          options[:follow_redirects] = value || true
+        end
+
+
         opt.on('--no-cookies', 'Don\'t use cookies for this session') do
           options[:no_cookies] = true
         end
@@ -373,7 +408,7 @@ Parse and run diffs against data from live and cached http responses.
         end
 
 
-        opt.on('-t', '--timeout INT', Integer,
+        opt.on('-t', '--timeout NUM', Float,
                'Timeout for http connection in seconds') do |value|
           Kronk.config[:timeout] = value
         end
@@ -398,7 +433,7 @@ Parse and run diffs against data from live and cached http responses.
 
 
         opt.on('-X', '--request STR', String,
-               'The request method to use') do |value|
+               'The HTTP request method to use') do |value|
           options[:http_method] = value
         end
 
@@ -414,16 +449,15 @@ Parse and run diffs against data from live and cached http responses.
       opts.parse! argv
 
       unless options[:player].empty?
-        options[:player] = Player.new options[:player]
-        set_player_backend Kronk.config[:async]
+        options[:player][:io] ||= $stdin if !$stdin.tty?
+        player_type      = options[:player][:type] || :suite
+        options[:player] = Player.new_type player_type, options[:player]
       else
         options.delete :player
       end
 
       if !$stdin.tty? && !(options[:player] && options[:player].input.io)
-        io = $stdin
-        io = StringIO.new $stdin.read
-        options[:uris] << io
+        options[:uris] << BufferedIO.new($stdin)
       end
 
       options[:uris].concat argv
@@ -616,26 +650,6 @@ Parse and run diffs against data from live and cached http responses.
     end
 
 
-    ##
-    # Set Player async state.
-
-    def self.set_player_backend async=false
-      return Kronk::Player.async = false unless
-        async == true || async.to_s == 'auto'
-
-      begin
-        require 'kronk/async'
-        Kronk::Player.async = true
-
-      rescue LoadError
-        Kronk::Player.async = false
-
-        raise Kronk::Exception, "Async mode requires the em-http-request gem" if
-          async == true
-      end
-    end
-
-
     ##
     # Assign at_exit and trap :INT behavior.