kcar 0.1.0 → 0.1.1

data/ChangeLog

@@ -1,110 +1,73 @@
-ChangeLog from git://git.bogomips.org/kcar.git ()
+ChangeLog from git://git.bogomips.org/kcar.git (v0.1.0..v0.1.1)
 
-    commit aca587b1bcf544b0fbaf031edc476e1b155e0263
+    commit 2b264a464707e448275883ac198d7ead7eaeadb9
     Author: Eric Wong <normalperson@yhbt.net>
-    Date:   Wed Apr 28 15:14:36 2010 -0700
+    Date:   Sat Jul 24 23:51:48 2010 +0000
     
-        add TODO
-    
-    commit ee89a72720c8c035eebf2389e09dd28c788551d8
-    Author: Eric Wong <normalperson@yhbt.net>
-    Date:   Wed Apr 28 15:12:19 2010 -0700
-    
-        autoload Kcar::Response, document VERSION constant
+        kcar 0.1.1
         
-        Kcar::Response may not be useful for people that eventually use
-        EventMachine or Rev.
-    
-    commit 8ddf88d1e9917baabc6c485546d1806c3a81cd0e
-    Author: Eric Wong <normalperson@yhbt.net>
-    Date:   Wed Apr 28 15:10:38 2010 -0700
-    
-        kcar/parser: magic comments for binary encoding
+        Our handling of pipelined identity (not chunked) responses
+        did not properly reset our internal buffer, causing HTTP
+        header parsing to fail for the second response as the buffer
+        still contained the last part of the body from the previous
+        response.
         
-        Any regexps or temporary strings should be created with binary
-        encoding as that's how HTTP processing is done.
+        There are also minor documentation updates and cleanups.
     
-    commit 1fdfb4a68591337be2a88dfb4021da6232361825
+    commit 558513bdeaac2bd1feb9df46c3ba09616b1be2bf
     Author: Eric Wong <normalperson@yhbt.net>
-    Date:   Wed Apr 28 15:08:05 2010 -0700
+    Date:   Sat Jul 24 23:43:08 2010 +0000
     
-        Update README with install and usage instructions
-    
-    commit 9d880bb373793f42c29cd77890663d62a1b9c578
-    Author: Eric Wong <normalperson@yhbt.net>
-    Date:   Wed Apr 28 14:33:27 2010 -0700
-    
-        add Kcar::Response#rack to give proper Rack responses
+        response: simplify trailers handling
         
-        We can't unchunk bodies and still say
-        "Transfer-Encoding: chunked", nor can we say we have Trailers
-        without chunked encoding.  So we'll unconditionally disable
-        unchunking and pass the response through as-is
-    
-    commit 2a3a8ac8e64f5f02f87de268c9b2615437d16a96
-    Author: Eric Wong <normalperson@yhbt.net>
-    Date:   Wed Apr 28 13:09:51 2010 -0700
+        Kcar::Parser#extract_trailers never returns a false/nil
+        value, so there's no reason to check for it.
     
-        kcar/response: rdoc public methods
-    
-    commit b75e162e0b9b605a9b3033c3dbc616afcb08b4ad
-    Author: Eric Wong <normalperson@yhbt.net>
-    Date:   Wed Apr 28 12:58:29 2010 -0700
-    
-        Documentation prep for release
-    
-    commit b85f1528667b3aaa699b37dcc362901e1e573b04
+    commit 62621af7c8724f5cc5cc3a6dfcd47eb6654286a5
     Author: Eric Wong <normalperson@yhbt.net>
-    Date:   Wed Apr 28 12:48:18 2010 -0700
+    Date:   Sat Jul 24 23:18:14 2010 +0000
     
-        rename Kcar::Session => Kcar::Response
+        response: fix handling of pipelined identity responses
         
-        It's not a real "session" since it does not have any facilities
-        to write responses.
+        When parsing a stream of multiple responses (when HTTP
+        pipelining is enabled), we did not properly reset our
+        internal buffer, causing failures when parsing the
+        second response.
     
-    commit dd84d98bce03e3da529c4b51d2eba761dda749e8
+    commit 35e3ad8134c39902b502e20d88246be2751767e1
     Author: Eric Wong <normalperson@yhbt.net>
-    Date:   Wed Apr 28 12:42:48 2010 -0700
-    
-        build + release infrastructure
+    Date:   Sat Jul 24 21:38:40 2010 +0000
     
-    commit e32c35bac78a7e7d8d711d360c143c9ebc64eed2
-    Author: Eric Wong <normalperson@yhbt.net>
-    Date:   Tue Apr 27 11:39:06 2010 -0700
-    
-        parser: avoid shadowing "key" variable
+        response: fix unreferenced constant
+        
+        Oops :x
     
-    commit 8bcf07ce90a9813e3859dce97b4a3a07b43c9cea
+    commit 6224ff57ce2b95cd62ab01316dedcc106e6e4e6b
     Author: Eric Wong <normalperson@yhbt.net>
-    Date:   Tue Apr 27 11:33:32 2010 -0700
+    Date:   Sat Jul 24 20:44:03 2010 +0000
     
-        kcar.rl: more comments explaining write_value;
+        update README with Rubinius support
         
-        This function can get intimidating to new users
+        It has likely always worked.
     
-    commit 356435e60da0ffc92b4c7a9eb801255f094b4610
+    commit 856a8a7e061845d5db617cc407c92aabdb4679a0
     Author: Eric Wong <normalperson@yhbt.net>
-    Date:   Mon Apr 26 19:18:10 2010 -0700
+    Date:   Sun May 2 16:38:27 2010 -0700
     
-        ext: additional validations for valid HTTP responses
+        document Kcar::Parser#chunked? method
     
-    commit 31bd370baef622aaa5dd14084f27baf2fabf506c
+    commit 7f1597ea01cac380393fb4d50e458204059beb24
     Author: Eric Wong <normalperson@yhbt.net>
-    Date:   Mon Apr 26 19:09:26 2010 -0700
+    Date:   Sun May 2 16:30:13 2010 -0700
     
-        ext: better document keepalive behavior
+        update README with Gmane and mbox archive info
     
-    commit 6066e9f608460adf46b215a9b6e5f351a87ba4b0
+    commit 6b4bf45c0cab182462ed0c5c0d98fe11e1201b61
     Author: Eric Wong <normalperson@yhbt.net>
-    Date:   Mon Apr 26 19:02:41 2010 -0700
+    Date:   Wed Apr 28 22:26:45 2010 +0000
     
-        ext: remove dead code from Parser#filter_body
+        gemspec: fix authors and homepage info
         
-        We avoid filter_body overhead for things with known
-        content-length.
-    
-    commit f071a6f936ba0b22610b1f7ce68e414403f29996
-    Author: Eric Wong <normalperson@yhbt.net>
-    Date:   Mon Apr 26 18:29:21 2010 -0700
-    
-        initial
+        Oops, URLs should end with a trailing slash since I'm expecting
+        my webserver to load index.html.  Also, it's "kcar hackers",
+        kcar did not write itself!

data/GIT-VERSION-FILE

@@ -1 +1 @@
-GIT_VERSION = 0.1.0
+GIT_VERSION = 0.1.1

data/GIT-VERSION-GEN

@@ -1,7 +1,7 @@
 #!/bin/sh
 
 GVF=GIT-VERSION-FILE
-DEF_VER=v0.1.0.GIT
+DEF_VER=v0.1.1.GIT
 
 LF='
 '

data/GNUmakefile

@@ -54,7 +54,7 @@ NEWS: GIT-VERSION-FILE
 latest: NEWS
 	@awk 'BEGIN{RS="=== ";ORS=""}NR==2{sub(/\n$$/,"");print RS""$$0 }' $<
 
-SINCE =
+SINCE = 0.1.0
 ChangeLog: LOG_VERSION = \
   $(shell git rev-parse -q "$(GIT_VERSION)" >/dev/null 2>&1 && \
           echo $(GIT_VERSION) || git describe)

data/NEWS

@@ -1,3 +1,13 @@
+=== 0.1.1 / 2010-07-25 00:03 UTC
+
+  Our handling of pipelined identity (not chunked) responses
+  did not properly reset our internal buffer, causing HTTP
+  header parsing to fail for the second response as the buffer
+  still contained the last part of the body from the previous
+  response.
+
+  There are also minor documentation updates and cleanups.
+
 === 0.1.0 / 2010-04-28 22:18 UTC
 
   initial

data/README

@@ -19,6 +19,8 @@ A drop-in, Net::HTTP-compatible interface is planned.
 * streaming interface for response bodies allows for incremental
   processing of arbitrarily large responses.
 
+* suppported under Ruby 1.8, 1.9 and Rubinuus
+
 == Problems
 
 * kcar is only lightly tested and is not yet aware of all quirks found in
@@ -84,3 +86,12 @@ don't email the git mailing list or maintainer with kcar patches.
 
 All feedback (bug reports, user/development discussion, patches, pull
 requests) go to the mailing list: mailto:kcar@librelist.com
+
+The mailing list is mirrored to Gmane, all information about the
+group is here:
+
+http://gmane.org/info.php?group=gmane.comp.lang.ruby.kcar.general
+
+Mailing list archives in mbox format may be downloaded here:
+
+http://bogomips.org/kcar/archives/

data/ext/kcar/kcar.c

@@ -1339,6 +1339,13 @@ static VALUE body_bytes_left(VALUE self)
   return Qnil;
 }
 
+/**
+ * Document-method: chunked
+ * call-seq:
+ *    parser.chunked? => true or false
+ *
+ * This is used to detect if a response uses chunked Transfer-Encoding or not.
+ */
 static VALUE chunked(VALUE self)
 {
   struct http_parser *hp = data_get(self);

data/ext/kcar/kcar.rl

@@ -467,6 +467,13 @@ static VALUE body_bytes_left(VALUE self)
   return Qnil;
 }
 
+/**
+ * Document-method: chunked
+ * call-seq:
+ *    parser.chunked? => true or false
+ *
+ * This is used to detect if a response uses chunked Transfer-Encoding or not.
+ */
 static VALUE chunked(VALUE self)
 {
   struct http_parser *hp = data_get(self);

data/kcar.gemspec

@@ -7,8 +7,8 @@ Gem::Specification.new do |s|
   s.name = %q{kcar}
   s.version = ENV["VERSION"]
 
-  s.homepage = 'http://bogomips.org/kcar'
-  s.authors = ["kcar"]
+  s.homepage = 'http://bogomips.org/kcar/'
+  s.authors = ["kcar hackers"]
   s.date = Time.now.utc.strftime('%Y-%m-%d')
   s.description = description
   s.email = %q{kcar@librelist.com}

data/lib/kcar/response.rb

@@ -107,9 +107,8 @@ class Response < Struct.new(:sock, :hdr, :unchunk, :buf, :parser)
     # since Rack does not provide a way to explicitly send trailers
     # in the response, we'll just yield a stringified version to our
     # server and pretend it's part of the body.
-    if trailers = parser.extract_trailers(hdr)
-      yield(trailers.map! { |k,v| "#{k}: #{v}\r\n" }.join("") << "\r\n")
-    end
+    trailers = parser.extract_trailers(hdr)
+    yield(trailers.map! { |k,v| "#{k}: #{v}\r\n" }.join("") << CRLF)
   end
 
   def each_until_eof(&block)
@@ -140,9 +139,13 @@ class Response < Struct.new(:sock, :hdr, :unchunk, :buf, :parser)
         len -= dst.size
         yield dst
       end
-      while len > 0
-        len -= sock.readpartial(len > READ_SIZE ? CHUNK_SIZE : len, dst).size
-        yield dst
+
+      if len > 0
+        begin
+          len -= sock.readpartial(len > READ_SIZE ? READ_SIZE : len, dst).size
+          yield dst
+        end while len > 0
+        dst.respond_to?(:clear) ? dst.clear : self.buf = ''
       end
     end
   end

data/lib/kcar.rb

@@ -1,8 +1,8 @@
 # -*- encoding: binary -*-
 module Kcar
 
-  # current version, currently 0.1.0
-  VERSION = '0.1.0'
+  # current version, currently 0.1.1
+  VERSION = '0.1.1'
 
   autoload :Response, 'kcar/response'
 end

data/test/test_response.rb

@@ -3,12 +3,75 @@ require 'test/unit'
 require 'pp'
 require 'socket'
 require 'kcar'
+require 'digest/sha1'
 
 class TestSession < Test::Unit::TestCase
   def setup
     @s, @c = UNIXSocket.pair
   end
 
+  def test_http_small_pipelined_identity
+    resp = "HTTP/1.1 200 OK\r\nContent-Length: 12\r\n\r\nhello world\n" \
+           "HTTP/1.1 200 OK\r\nContent-Length: 14\r\n\r\ngoodbye world\n"
+    pid = fork do
+      @s << resp
+      @s.close
+    end
+    @s.close
+    @response = Kcar::Response.new(@c)
+    status, headers, body = @response.rack
+    assert_equal status, "200 OK"
+    assert_equal({'Content-Length'=>'12'},headers)
+    tmp = []
+    assert_nothing_raised { body.each { |chunk| tmp << chunk.dup } }
+    assert_equal [ "hello world\n" ], tmp
+    body.close
+    assert ! @c.closed?
+
+    status, headers, body = @response.rack
+    assert_equal status, "200 OK"
+    assert_equal({'Content-Length'=>'14'},headers)
+    tmp = []
+    assert_nothing_raised { body.each { |chunk| tmp << chunk.dup } }
+    assert_equal [ "goodbye world\n" ], tmp
+
+    _, status = Process.waitpid2(pid)
+    assert status.success?
+    body.close
+  end
+
+  def test_http_big_pipelined_identity
+    nr = 1024 * 512
+    width = 80
+    length = nr * width
+    template = "%0#{width - 1}x\n"
+    expect = Digest::SHA1.new
+    nr.times { |i| expect << sprintf(template, i) }
+    pid = fork do
+      @s.sync = false
+      @s << "HTTP/1.1 200 OK\r\nContent-Length: #{length}\r\n\r\n"
+      nr.times { |i| @s.printf(template, i) }
+      @s << "HTTP/1.1 200 OK\r\nContent-Length: #{length}\r\n\r\n"
+      nr.times { |i| @s.printf(template, i) }
+      @s.close
+    end
+    @s.close
+    @response = Kcar::Response.new(@c)
+
+    2.times do |i|
+      status, headers, body = @response.rack
+      assert_equal status, "200 OK"
+      assert_equal({'Content-Length'=>length.to_s}, headers)
+      sha1 = Digest::SHA1.new
+      assert_nothing_raised { body.each { |chunk| sha1 << chunk } }
+      assert_equal expect, sha1, "#{expect.hexdigest} != #{sha1.hexdigest}"
+      body.close
+      assert ! @c.closed?
+    end
+    _, status = Process.waitpid2(pid)
+    assert status.success?
+  end
+
   def test_http_one_zero
     pid = fork do
       @s << "HTTP/1.0 200 OK\r\n\r\nHI"

metadata

@@ -1,15 +1,21 @@
 --- !ruby/object:Gem::Specification 
 name: kcar
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  hash: 25
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
-- kcar
+- kcar hackers
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-04-28 00:00:00 +00:00
+date: 2010-07-25 00:00:00 +00:00
 default_executable: 
 dependencies: []
 
@@ -61,7 +67,7 @@ files:
 - test/test_parser.rb
 - test/test_response.rb
 has_rdoc: true
-homepage: http://bogomips.org/kcar
+homepage: http://bogomips.org/kcar/
 licenses: []
 
 post_install_message: 
@@ -73,21 +79,27 @@ require_paths:
 - lib
 - ext
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: rainbows
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: bytestream to Rack response converter