kronk 1.7.6 → 1.7.7

data/History.rdoc

@@ -1,3 +1,11 @@
+=== 1.7.7 / 2011-11-08
+
+* Enhancements:
+
+  * Support for YAML parsing.
+
+  * Stream chunk size now expressed as hexa-decimals.
+
 === 1.7.6 / 2011-10-28
 
 * Bugfixes:

data/Manifest.txt

@@ -36,6 +36,7 @@ lib/kronk/test.rb
 lib/kronk/test/assertions.rb
 lib/kronk/test/helper_methods.rb
 lib/kronk/xml_parser.rb
+lib/kronk/yaml_parser.rb
 script/kronk_completion
 test/mocks/200_response.json
 test/mocks/200_response.plist

data/TODO.rdoc

@@ -1,5 +1,15 @@
 = TODO
 
+* QPS for player.
+
+* Support for response streaming.
+
+* Support for X-Url-\d and x-alt-location-\d redirects.
+
+* Support for gzip.
+
+* Player input IO timeout.
+
 * Investigate Kronk console.
 
 == Done

data/lib/kronk.rb

@@ -14,7 +14,7 @@ require 'yaml'
 class Kronk
 
   # This gem's version.
-  VERSION = '1.7.6'
+  VERSION = '1.7.7'
 
   require 'kronk/constants'
   require 'kronk/queue_runner'
@@ -39,6 +39,7 @@ class Kronk
   require 'kronk/request'
   require 'kronk/plist_parser'
   require 'kronk/xml_parser'
+  require 'kronk/yaml_parser'
 
 
   ##

data/lib/kronk/constants.rb

@@ -34,10 +34,12 @@ class Kronk
 
   # Default Content-Type header to parser mapping.
   DEFAULT_CONTENT_TYPES = {
-    'js'      => 'JSON',
-    'json'    => 'JSON',
-    'plist'   => 'PlistParser',
-    'xml'     => 'XMLParser'
+    'js'    => 'JSON',
+    'json'  => 'JSON',
+    'plist' => 'PlistParser',
+    'xml'   => 'XMLParser',
+    'yaml'  => 'YamlParser',
+    'yml'   => 'YamlParser'
   }
 
 

data/lib/kronk/player/stream.rb

@@ -3,7 +3,7 @@ class Kronk
   ##
   # Outputs Player results as a stream of Kronk outputs
   # in chunked form, each chunk being one response and the number
-  # of octets being expressed in plain decimal form.
+  # of octets being expressed in hexadecimal form.
   #
   #   out   = Player::StreamOutput.new
   #
@@ -13,11 +13,11 @@ class Kronk
   #   kronk = Kronk.new
   #   kronk.request io1
   #   out.result kronk
-  #   #=> "23\r\nthis is the first chunk\r\n"
+  #   #=> "17\r\nthis is the first chunk\r\n"
   #
   #   kronk.request io2
   #   out.result kronk
-  #   #=> "16\r\nthis is the rest\r\n"
+  #   #=> "10\r\nthis is the rest\r\n"
   #
   # Note: This output class will not render errors.
 
@@ -34,7 +34,7 @@ class Kronk
 
       return unless output
 
-      output = "#{output.length}\r\n#{output}\r\n"
+      output = "#{"%X" % output.length}\r\n#{output}\r\n"
 
       mutex.synchronize do
         $stdout << output
@@ -45,6 +45,7 @@ class Kronk
 
 
     def completed
+      $stdout << "0\r\n\r\n"
       $stdout.flush
       true
     end

data/lib/kronk/plist_parser.rb

@@ -1,19 +1,19 @@
 class Kronk
 
   ##
-  # Simple plist wrapper to add :parse method.
+  # Simple plist wrapper to support Kronk's parser interface.
 
   class PlistParser
 
     ##
-    # Alias for Plist.parse_xml
+    # Wrapper for Plist.parse_xml
 
     def self.parse plist
       require 'plist'
       Plist.parse_xml(plist) || raise(ParserError, "invalid Plist")
 
     rescue RuntimeError
-      raise(ParserError, "unparsable Plist")
+      raise ParserError, "unparsable Plist"
 
     rescue LoadError => e
       raise unless e.message =~ /-- plist/

data/lib/kronk/response.rb

@@ -37,12 +37,9 @@ class Kronk
     end
 
 
-    attr_accessor :body, :bytes, :byterate, :code, :headers,
-                  :raw, :stringify_opts, :request, :uri
+    attr_accessor :body, :code,
+                  :raw, :request, :stringify_opts, :time, :uri
 
-    attr_reader :encoding, :parser, :time
-
-    alias to_hash headers
     alias to_s raw
 
     ##
@@ -58,36 +55,23 @@ class Kronk
         @_res, debug_io = request_from_io(io)
       end
 
-      @headers  = @_res.to_hash.dup
-      @headers.keys.each{|h| @headers[h] = @headers[h].join(", ")}
+      @headers = @encoding = @parser = nil
 
-      @encoding = "utf-8" unless @headers["content-type"]
-      c_type = @headers["content-type"] =~ ENCODING_MATCHER
-      @encoding = $2 if c_type
-      @encoding ||= "ASCII-8BIT"
-      @encoding = Encoding.find(@encoding) if defined?(Encoding)
+      @time = 0
 
       raw_req, raw_resp, bytes = read_raw_from debug_io
       @raw = try_force_encoding raw_resp
 
       @request = request || raw_req && Request.parse(try_force_encoding raw_req)
 
-      @time   = 0
-
       @body   = try_force_encoding(@_res.body) if @_res.body
       @body ||= @raw.split("\r\n\r\n",2)[1]
 
-      @bytes = (@headers["content-length"] || @body.bytes.count).to_i
-
       @code = @_res.code
 
-      @parser = Kronk.parser_for @headers["content-type"]
-
       @uri = @request.uri if @request && @request.uri
       @uri = URI.parse io.path if File === io
 
-      @byterate = 0
-
       @stringify_opts = {}
     end
 
@@ -108,6 +92,24 @@ class Kronk
     end
 
 
+    ##
+    # If time was set, returns bytes-per-second for the whole response,
+    # including headers.
+
+    def byterate
+      return 0 unless @raw && @time.to_f > 0
+      @byterate = self.total_bytes / @time.to_f
+    end
+
+
+    ##
+    # Size of the body in bytes.
+
+    def bytes
+      (headers["content-length"] || @body.bytes.count).to_i
+    end
+
+
     ##
     # Cookie header accessor.
 
@@ -117,7 +119,22 @@ class Kronk
 
 
     ##
-    # Force the encoding of the raw response and body
+    # Return the Ruby-1.9 encoding of the body, or String representation
+    # for Ruby-1.8.
+
+    def encoding
+      return @encoding if @encoding
+      @encoding = "utf-8" unless headers["content-type"]
+      c_type = headers["content-type"] =~ ENCODING_MATCHER
+      @encoding = $2 if c_type
+      @encoding ||= "ASCII-8BIT"
+      @encoding = Encoding.find(@encoding) if defined?(Encoding)
+      @encoding
+    end
+
+
+    ##
+    # Force the encoding of the raw response and body.
 
     def force_encoding new_encoding
       new_encoding = Encoding.find new_encoding unless Encoding === new_encoding
@@ -128,6 +145,19 @@ class Kronk
     end
 
 
+    ##
+    # Accessor for downcased headers.
+
+    def headers
+      return @headers if @headers
+      @headers = @_res.to_hash.dup
+      @headers.keys.each{|h| @headers[h] = @headers[h].join(", ")}
+      @headers
+    end
+
+    alias to_hash headers
+
+
     ##
     # If there was an error parsing the input as a standard http response,
     # the input is assumed to be a body and HeadlessResponse is used.
@@ -150,27 +180,30 @@ class Kronk
     # If no parser is given will look for the default parser based on
     # the Content-Type, or will return the cached parsed body if available.
 
-    def parsed_body parser=nil
+    def parsed_body new_parser=nil
       @parsed_body ||= nil
 
-      return @parsed_body if @parsed_body && !parser
+      return @parsed_body if @parsed_body && !new_parser
 
-      parser ||= @parser
+      new_parser ||= parser
 
       begin
-        parser = Kronk.parser_for(parser) || Kronk.find_const(parser)
+        new_parser = Kronk.parser_for(new_parser) ||
+                     Kronk.find_const(new_parser)
       rescue NameError
-        raise InvalidParser, "No such parser: #{parser}"
-      end if String === parser
+        raise InvalidParser, "No such parser: #{new_parser}"
+      end if String === new_parser
 
       raise MissingParser,
-        "No parser for Content-Type: #{@_res['Content-Type']}" unless parser
+        "No parser for Content-Type: #{@_res['Content-Type']}" unless new_parser
 
       begin
-        @parsed_body = parser.parse(self.body) or raise RuntimeError
+        @parsed_body = new_parser.parse(self.body) or raise RuntimeError
 
       rescue RuntimeError, ::Exception => e
-        msg = ParserError === e ? e.message : "#{parser} failed parsing body"
+        msg = ParserError === e ?
+                e.message : "#{new_parser} failed parsing body"
+
         msg << " returned by #{@uri}" if @uri
         raise ParserError, msg
       end
@@ -181,7 +214,7 @@ class Kronk
     # Returns the parsed header hash.
 
     def parsed_header include_headers=true
-      headers = @headers.dup
+      out_headers = headers.dup
 
       case include_headers
       when nil, false
@@ -191,18 +224,26 @@ class Kronk
         include_headers = [*include_headers].map{|h| h.to_s.downcase}
 
         headers.each do |key, value|
-          headers.delete key unless
+          out_headers.delete key unless
             include_headers.include? key.to_s.downcase
         end
 
-        headers
+        out_headers
 
       when true
-        headers
+        out_headers
       end
     end
 
 
+    ##
+    # The parser to use on the body.
+
+    def parser
+      @parser ||= Kronk.parser_for headers["content-type"]
+    end
+
+
     ##
     # Assign the parser.
 
@@ -342,7 +383,7 @@ class Kronk
     def stringify options={}, &block
       options = options.empty? ? @stringify_opts : merge_stringify_opts(options)
 
-      if !options[:raw] && (options[:parser] || @parser || options[:no_body])
+      if !options[:raw] && (options[:parser] || parser || options[:no_body])
         data = selective_data options, &block
         DataString.new data, options
       else
@@ -387,16 +428,6 @@ class Kronk
     end
 
 
-    ##
-    # Assign how long the request took in seconds.
-
-    def time= new_time
-      @time = new_time
-      @byterate = self.total_bytes / @time.to_f if @raw && @time > 0
-      @time
-    end
-
-
     ##
     # Number of bytes of the response including the header.
 
@@ -487,7 +518,7 @@ class Kronk
     # Returns the string given with the new encoding.
 
     def try_force_encoding str
-      str.force_encoding @encoding if str.respond_to? :force_encoding
+      str.force_encoding encoding if str.respond_to? :force_encoding
       str
     end
   end

data/lib/kronk/yaml_parser.rb

@@ -0,0 +1,18 @@
+class Kronk
+
+  ##
+  # Simple yaml wrapper to support Kronk's parser interface.
+
+  class YamlParser
+
+    ##
+    # Wrapper for YAML.load
+
+    def self.parse yaml
+      YAML.load(yaml) || raise(ParserError, "unparsable YAML")
+
+    rescue ArgumentError
+      raise ParserError, "unparsable YAML"
+    end
+  end
+end

data/test/test_kronk.rb

@@ -9,7 +9,9 @@ class TestKronk < Test::Unit::TestCase
         'js'      => 'JSON',
         'json'    => 'JSON',
         'plist'   => 'PlistParser',
-        'xml'     => 'XMLParser'
+        'xml'     => 'XMLParser',
+        'yaml'    => 'YamlParser',
+        'yml'     => 'YamlParser'
       },
       :context      => nil,
       :cache_file   => Kronk::DEFAULT_CACHE_FILE,
@@ -68,7 +70,9 @@ class TestKronk < Test::Unit::TestCase
           'js'    => "JsEngine",
           'json'  => "JSON",
           'plist' => "PlistParser",
-          'xml'   => "XMLParser"
+          'xml'   => 'XMLParser',
+          'yaml'  => 'YamlParser',
+          'yml'   => 'YamlParser'
         },
         :context     => 3,
         :default_host => "http://localhost:3000",

metadata

@@ -1,107 +1,109 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: kronk
-version: !ruby/object:Gem::Version
-  version: 1.7.6
+version: !ruby/object:Gem::Version 
   prerelease: 
+  version: 1.7.7
 platform: ruby
-authors:
+authors: 
 - Jeremie Castagna
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-29 00:00:00.000000000Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2011-11-08 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: json
-  requirement: &2168882440 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.5'
+      - !ruby/object:Gem::Version 
+        version: "1.5"
   type: :runtime
-  prerelease: false
-  version_requirements: *2168882440
-- !ruby/object:Gem::Dependency
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: cookiejar
-  requirement: &2168881680 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
         version: 0.3.0
   type: :runtime
-  prerelease: false
-  version_requirements: *2168881680
-- !ruby/object:Gem::Dependency
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
   name: plist
-  requirement: &2168880700 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
         version: 3.1.0
   type: :development
-  prerelease: false
-  version_requirements: *2168880700
-- !ruby/object:Gem::Dependency
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
   name: nokogiri
-  requirement: &2168879840 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.4'
+      - !ruby/object:Gem::Version 
+        version: "1.4"
   type: :development
-  prerelease: false
-  version_requirements: *2168879840
-- !ruby/object:Gem::Dependency
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
   name: mocha
-  requirement: &2168878580 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
         version: 0.9.12
   type: :development
-  prerelease: false
-  version_requirements: *2168878580
-- !ruby/object:Gem::Dependency
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
   name: em-http-request
-  requirement: &2168877780 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
         version: 1.0.0
   type: :development
-  prerelease: false
-  version_requirements: *2168877780
-- !ruby/object:Gem::Dependency
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
   name: hoe
-  requirement: &2168876780 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.11'
+      - !ruby/object:Gem::Version 
+        version: "2.12"
   type: :development
-  prerelease: false
-  version_requirements: *2168876780
-description: ! 'Kronk runs diffs against data from live and cached http responses.
-
-  Kronk was made possible by the sponsoring of AT&T Interactive.'
-email:
+  version_requirements: *id007
+description: |-
+  Kronk runs diffs against data from live and cached http responses.
+  Kronk was made possible by the sponsoring of AT&T Interactive.
+email: 
 - yaksnrainbows@gmail.com
-executables:
+executables: 
 - kronk
 extensions: []
-extra_rdoc_files:
+
+extra_rdoc_files: 
 - Manifest.txt
 - History.rdoc
 - README.rdoc
 - TODO.rdoc
-files:
+files: 
 - .autotest
 - History.rdoc
 - Manifest.txt
@@ -140,6 +142,7 @@ files:
 - lib/kronk/test/assertions.rb
 - lib/kronk/test/helper_methods.rb
 - lib/kronk/xml_parser.rb
+- lib/kronk/yaml_parser.rb
 - script/kronk_completion
 - test/mocks/200_response.json
 - test/mocks/200_response.plist
@@ -171,34 +174,33 @@ files:
 - .gemtest
 homepage: https://github.com/yaksnrainbows/kronk
 licenses: []
+
 post_install_message: 
-rdoc_options:
+rdoc_options: 
 - --main
 - README.rdoc
-require_paths:
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
-      - 0
-      hash: -2280556396485806807
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
 requirements: []
+
 rubyforge_project: kronk
-rubygems_version: 1.8.10
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Kronk runs diffs against data from live and cached http responses
-test_files:
+test_files: 
 - test/test_assertions.rb
 - test/test_cmd.rb
 - test/test_core_ext.rb