kronk 1.8.7 → 1.9.0

data/lib/kronk/response.rb

@@ -10,6 +10,7 @@ class Kronk
 
 
     ENCODING_MATCHER = /(^|;\s?)charset=(.*?)\s*(;|$)/
+    DEFAULT_ENCODING = "ASCII-8BIT"
 
     ##
     # Read http response from a file and return a Kronk::Response instance.
@@ -25,7 +26,7 @@ class Kronk
 
 
     attr_reader :code, :io, :cookies, :headers
-    attr_accessor :read, :request, :stringify_opts, :time
+    attr_accessor :read, :request, :stringify_opts, :time, :conn_time
 
     ##
     # Create a new Response object from a String or IO.
@@ -129,6 +130,7 @@ class Kronk
 
       begin
         read_body do |chunk|
+          chunk = chunk.dup
           chunk = unzip chunk if gzip?
 
           try_force_encoding chunk
@@ -169,10 +171,10 @@ class Kronk
 
 
     ##
-    # Size of the raw body in bytes.
+    # Current size of the http body in bytes.
 
     def bytes
-      (headers["content-length"] || self.raw_body.bytes.count).to_i
+      self.raw_body.bytes.count
     end
 
 
@@ -232,6 +234,29 @@ class Kronk
     end
 
 
+    ##
+    # The extension or file type corresponding to the body,
+    # based on the Content-Type. Defaults to 'txt' if none can be determined
+    # or Content-Type is text/plain.
+    #   application/json    => 'json'
+    #   text/html           => 'html'
+    #   application/foo+xml => 'xml'
+
+    def ext
+      file_ext =
+        if headers['content-type']
+          types = MIME::Types[headers['content-type'].sub(%r{/\w+\+}, '/')]
+          types[0].extensions[0] unless types.empty?
+
+        elsif uri
+          File.extname(uri.path)[1..-1]
+        end
+
+      file_ext = "txt" if !file_ext || file_ext.strip.empty?
+      file_ext
+    end
+
+
     ##
     # Cookie header accessor.
 
@@ -264,10 +289,9 @@ class Kronk
 
     def encoding
       return @encoding if @encoding
-      @encoding = "utf-8" unless headers["content-type"]
-      c_type = headers["content-type"] =~ ENCODING_MATCHER
+      c_type = headers["content-type"].to_s =~ ENCODING_MATCHER
       @encoding = $2 if c_type
-      @encoding ||= "ASCII-8BIT"
+      @encoding ||= DEFAULT_ENCODING
       @encoding = Encoding.find(@encoding) if defined?(Encoding)
       @encoding
     end
@@ -309,8 +333,9 @@ class Kronk
     # Ruby inspect.
 
     def inspect
-      content_type = headers['content-type'] || "text/html"
-      "#<#{self.class}:#{@code} #{content_type} #{total_bytes}bytes>"
+      content_type = headers['content-type'] || "text/plain"
+      "#<#{self.class}:#{@code} #{content_type} \
+#{total_bytes}/#{expected_bytes}bytes>"
     end
 
 
@@ -329,8 +354,8 @@ class Kronk
     # Check if connection should stay alive.
 
     def keep_alive?
-      @headers['connection'].to_s.include?('keep-alive') ||
-      @headers['proxy-connection'].to_s.include?('keep-alive')
+      @headers['connection'].to_s.include?('Keep-Alive') ||
+      @headers['proxy-connection'].to_s.include?('Keep-Alive')
     end
 
     alias connection_keep_alive? keep_alive?
@@ -406,7 +431,7 @@ class Kronk
     # The parser to use on the body.
 
     def parser
-      @parser ||= Kronk.parser_for headers["content-type"]
+      @parser ||= Kronk.parser_for self.ext
     end
 
 
@@ -434,7 +459,7 @@ class Kronk
     # Returns the body portion of the raw http response.
 
     def raw_body
-      headless? ? raw : raw.split("\r\n\r\n", 2)[1]
+      headless? ? @raw.to_s : @body.to_s
     end
 
 
@@ -554,12 +579,13 @@ class Kronk
     # :only_data:: String/Array - Extracts the data from given data paths
     #
     # Example:
-    #   response.data :transform => [:delete, ["foo/0", "bar/1"]]
+    #   response.data :transform => [[:delete, ["foo/0", "bar/1"]]]
     #   response.data do |trans|
     #     trans.delete "foo/0", "bar/1"
     #   end
     #
-    # See Path::Transaction for supported transform actions.
+    # See Path::Transaction for supported transform actions in the
+    # {ruby-path gem}[http://github.com/yaksnrainbows/ruby-path].
 
     def data opts={}
       data = nil
@@ -672,6 +698,16 @@ class Kronk
     # Number of bytes of the response including the header.
 
     def total_bytes
+      return raw.bytes.count if @read
+      return raw_header.bytes.count unless body_permitted?
+      raw_header.to_s.bytes.count + bytes + 2
+    end
+
+
+    ##
+    # Expected number of bytes to read from the server, including the header.
+
+    def expected_bytes
       return raw.bytes.count if @read
       return raw_header.bytes.count unless body_permitted?
       raw_header.to_s.bytes.count + (content_length || range_length).to_i + 2
@@ -738,13 +774,14 @@ class Kronk
 
         buff_io.rewind
 
-        ext = File === buff_io.io ?
-                File.extname(buff_io.io.path)[1..-1] : "html"
+        ctype = ["text/plain"]
+        ctype = MIME::Types.of(buff_io.io.path).concat ctype if
+          File === buff_io.io
 
         encoding = buff_io.io.respond_to?(:external_encoding) ?
-                    buff_io.io.external_encoding : "UTF-8"
+                    buff_io.io.external_encoding : DEFAULT_ENCODING
         @headers = {
-          'content-type' => "text/#{ext}; charset=#{encoding}",
+          'content-type' => "#{ctype[0]}; charset=#{encoding}",
         }
 
         @headless = true

data/test/mocks/200_response.plist

@@ -1,7 +1,7 @@
 HTTP/1.1 200 OK
 Server: nginx/0.6.39
 Date: Fri, 03 Dec 2010 21:49:00 GMT
-Content-Type: application/x-plist; charset=utf-8
+Content-Type: application/foobar+x-plist; charset=utf-8
 Connection: keep-alive
 Keep-Alive: timeout=20
 Status: 200 OK

data/test/test_cmd.rb

@@ -321,11 +321,11 @@ class TestCmd < Test::Unit::TestCase
     opts = Kronk::Cmd.parse_args %w{uri -p mock_file}
     assert_equal mock_file, opts[:player].input.io
 
-    opts = Kronk::Cmd.parse_args %w{uri --benchmark mock_file}
+    opts = Kronk::Cmd.parse_args %w{uri --benchmark -p mock_file}
     assert_equal mock_file, opts[:player].input.io
     assert_equal Kronk::Player::Benchmark, opts[:player].class
 
-    opts = Kronk::Cmd.parse_args %w{uri --stream mock_file}
+    opts = Kronk::Cmd.parse_args %w{uri --stream -p mock_file}
     assert_equal mock_file, opts[:player].input.io
     assert_equal Kronk::Player::Stream, opts[:player].class
   end
@@ -366,7 +366,8 @@ class TestCmd < Test::Unit::TestCase
 
   def test_parse_args_http_options
     opts = Kronk::Cmd.parse_args %w{uri -A foo -L --no-cookies -? bar
-            --suff /tail -X PUT -x example.com:2000 --form foo=bar}
+            --suff /tail -X PUT -x example.com:2000 --form foo=bar
+            --form-upload file=test/mocks/200_response.json}
 
     assert_equal "foo",     opts[:user_agent]
     assert_equal true,      opts[:follow_redirects]
@@ -375,6 +376,7 @@ class TestCmd < Test::Unit::TestCase
     assert_equal "/tail",   opts[:uri_suffix]
     assert_equal "PUT",     opts[:http_method]
     assert_equal "foo=bar", opts[:form]
+    assert_equal "file=test/mocks/200_response.json", opts[:form_upload]
     assert_equal({:host => "example.com", :port => "2000"}, opts[:proxy])
 
     opts = Kronk::Cmd.parse_args %w{uri -L 3}

data/test/test_helper.rb

@@ -160,33 +160,43 @@ ensure
 end
 
 
-def expect_request req_method, url, options={}
+def expect_request req_method, url, opts={}
   uri  = URI.parse url
 
-  resp = Kronk::Response.new(options[:returns] || mock_200_response)
-  resp.stubs(:code).returns(options[:status] || '200')
+  resp = Kronk::Response.new(opts[:returns] || mock_200_response)
+  resp.stubs(:code).returns(opts[:status] || '200')
   resp.stubs(:to_hash).returns Hash.new
 
   http   = mock 'http'
   req    = mock 'req'
 
-  data   = options[:data]
+  data   = opts[:data]
   data &&= Hash === data ? Kronk::Request.build_query(data) : data.to_s
 
-  headers = options[:headers] || Hash.new
+  req.stubs(:body).returns(data)
+  req.stubs(:body_stream).returns(StringIO.new(data.to_s))
+
+  req.stubs(:[]).with('Content-Length').returns(data)
+  req.stubs(:[]=)
+
+  headers = opts[:headers] || Hash.new
   headers['User-Agent'] ||= Kronk::DEFAULT_USER_AGENT
+  headers['Connection'] ||= 'Keep-Alive'
 
-  req.expects(:start).yields(http).returns resp
+  http.expects(:started?).returns false
+  http.expects(:start)
   req.expects(:body=).with(data)
 
   Kronk::Request::VanillaRequest.expects(:new).
     with(req_method.to_s.upcase, uri.request_uri, headers).returns req
 
-  Kronk::HTTP.expects(:new).with(uri.host, uri.port).returns req
+  proxy = opts[:proxy] || {}
+
+  Kronk::HTTP.expects(:new).
+    with(uri.host, uri.port, {:proxy => proxy, :ssl => !!opts[:ssl]}).
+    returns http
 
-  http.expects(:request).
-    with(req, nil, has_entry(:request => instance_of(Kronk::Request))).
-    returns resp
+  http.expects(:request).with(req, nil, {}).returns resp
 
   yield http, req, resp if block_given?
 

data/test/test_multipart.rb

@@ -0,0 +1,144 @@
+require 'test/test_helper'
+
+class TestMultipart < Test::Unit::TestCase
+
+  def setup
+    @multi = Kronk::Multipart.new "foobar"
+  end
+
+
+  def test_initialize
+    assert_equal "foobar", @multi.boundary
+  end
+
+
+  def test_add
+    @multi.add "foo", "bar"
+    expected = [{'content-disposition' => 'form-data; name="foo"'}, "bar"]
+    assert_equal expected, @multi.parts.last
+  end
+
+
+  def test_add_headers
+    @multi.add "foo", "bar", "X-Header" => "blah"
+    expected = [{'content-disposition' => 'form-data; name="foo"',
+      "X-Header" => "blah"}, "bar"]
+    assert_equal expected, @multi.parts.last
+  end
+
+
+  def test_add_file
+    file = File.open("test/mocks/200_response.json", "rb")
+    @multi.add "foo", file
+
+    expected = [{
+      "content-disposition"       =>
+        'form-data; name="foo"; filename="200_response.json"',
+      "Content-Type"              => "application/json",
+      "Content-Transfer-Encoding" => "binary"
+    }, file]
+
+    assert_equal expected, @multi.parts.last
+  end
+
+
+  def test_add_io
+    prd, pwr = IO.pipe
+    @multi.add "foo", prd
+
+    expected = [{
+      "content-disposition"       => 'form-data; name="foo"',
+      "Content-Type"              => "application/octet-stream",
+      "Content-Transfer-Encoding" => "binary"
+    }, prd]
+
+    assert_equal expected, @multi.parts.last
+  end
+
+
+  def test_add_escaped_name
+    @multi.add "foo:10", "bar"
+    expected = [{'content-disposition' => 'form-data; name="foo:10"'}, "bar"]
+    assert_equal expected, @multi.parts.last
+  end
+
+
+  def test_to_io
+    @multi.add "key1", "bar"
+    @multi.add "key2", "some value"
+    @multi.add "key3", "other thing"
+
+    io = @multi.to_io
+    assert_equal Kronk::MultipartIO, io.class
+    assert_equal 1, io.parts.length
+    assert_equal StringIO, io.parts.first.class
+
+    expected = <<-STR
+--foobar\r
+content-disposition: form-data; name="key1"\r
+\r
+bar\r
+--foobar\r
+content-disposition: form-data; name="key2"\r
+\r
+some value\r
+--foobar\r
+content-disposition: form-data; name="key3"\r
+\r
+other thing\r
+--foobar--
+STR
+    assert_equal expected.strip, io.read
+  end
+
+
+  def test_to_io_with_file
+    file = File.open("test/mocks/200_response.json", "rb")
+    @multi.add "key1", "bar"
+    @multi.add "key2", "some value"
+    @multi.add "my_file", file
+
+    io = @multi.to_io
+    assert_equal 3, io.parts.length
+    assert_equal StringIO, io.parts.first.class
+    assert_equal file, io.parts[1]
+    assert_equal StringIO, io.parts.last.class
+
+    file_content = File.read("test/mocks/200_response.json")
+
+    head = <<-STR
+--foobar\r
+content-disposition: form-data; name="key1"\r
+\r
+bar\r
+--foobar\r
+content-disposition: form-data; name="key2"\r
+\r
+some value\r
+--foobar\r
+content-disposition: form-data; name="my_file"; filename="200_response.json"\r
+    STR
+
+    ctype_line = "Content-Type: application/json\r\n"
+    ctran_line = "Content-Transfer-Encoding: binary\r\n"
+    tail       = "\r\n#{file_content}\r\n--foobar--"
+
+    output = io.read head.bytes.count
+    assert_equal head, output
+
+    output = ""
+    output << io.read(1) while output[-1..-1] != "\n"
+
+    comp1, comp2 = output.length == ctype_line.length ?
+      [ctype_line, ctran_line] : [ctran_line, ctype_line]
+
+    assert_equal comp1, output
+
+    output = ""
+    output << io.read(1) while output[-1..-1] != "\n"
+
+    assert_equal comp2, output
+
+    assert_equal tail, io.read
+  end
+end

data/test/test_multipart_io.rb

@@ -0,0 +1,92 @@
+require 'test/test_helper'
+
+class TestMultipartIo < Test::Unit::TestCase
+
+  def setup
+    strio = StringIO.new "thing"
+    @io   = Kronk::MultipartIO.new "foo", "bar", strio
+
+    @pipe_rd, @pipe_wr = IO.pipe
+    @pipe_wr.write "thing"
+    @pipe_wr.close
+    @pio  = Kronk::MultipartIO.new "foo", @pipe_rd, "bar"
+
+    @file = File.open 'test/mocks/200_response.json', "r"
+    @fio  = Kronk::MultipartIO.new "foo", @file, "bar"
+  end
+
+
+  def teardown
+    @file.close
+  end
+
+
+  def test_initialize
+    assert_equal StringIO, @io.parts[0].class
+    assert_equal "foo", @io.parts[0].read
+    assert_equal StringIO, @io.parts[1].class
+    assert_equal "bar", @io.parts[1].read
+    assert_equal StringIO, @io.parts[2].class
+    assert_equal "thing", @io.parts[2].read
+  end
+
+
+  def test_size
+    assert_equal 11, @io.size
+    assert_nil @pio.size
+    assert_equal((@file.size + 6), @fio.size)
+  end
+
+
+  def test_read_all_strings
+    assert_equal "foobarthing", @io.read_all
+    assert_nil @io.read 1
+    assert_equal "", @io.read
+  end
+
+
+  def test_read_all_file
+    assert_equal "foo#{File.read "test/mocks/200_response.json"}bar",
+                 @fio.read_all
+    assert_nil @fio.read 1
+    assert_equal "", @fio.read
+  end
+
+
+  def test_read_all_io
+    assert_equal "foothingbar",
+                 @pio.read_all
+    assert_nil @pio.read 1
+    assert_equal "", @pio.read
+  end
+
+
+  def test_read_all_after_read_partial
+    assert_equal "foo", @pio.read(3)
+    assert_equal "thingbar", @pio.read
+  end
+
+
+  def test_eof
+    assert !@pio.eof?, "EOF should NOT be reached"
+    @pio.read 5
+
+    assert !@pio.eof?, "EOF should NOT be reached"
+    @pio.read_all
+
+    assert @pio.eof?, "EOF should be reached"
+  end
+
+
+  def test_close
+    @pio.parts.each do |io|
+      assert !io.closed?, "#{io.inspect} should NOT be closed"
+    end
+
+    @pio.close
+
+    @pio.parts.each do |io|
+      assert io.closed?, "#{io.inspect} should be closed"
+    end
+  end
+end