http_tools 0.4.1 → 0.4.2

data/README.rdoc

@@ -1,4 +1,4 @@
-= HTTPTools
+= HTTPTools {<img src=https://secure.travis-ci.org/matsadler/http_tools.png>}[http://travis-ci.org/matsadler/http_tools]
 
 HTTPTools is a collection of lower level utilities to aid working with HTTP,
 including a fast-as-possible pure Ruby HTTP parser.
@@ -12,9 +12,9 @@ Written purely in Ruby, with no dependencies outside of the standard library, it
 should run across all Ruby implementations compatible with 1.8 or later, and
 install in environments without a compiler available.
 
-All tests are currently run (and pass) against ruby 1.8.6, 1.8.7, 1.9.2, jruby 1.6.2, rubinius 1.2.4, MacRuby 0.10
+Tests are currently run on travis-ci[http://travis-ci.org/] against Ruby 1.8.6, 1.8.7, 1.9.2, 1.9.3, JRuby, Rubinius, Rubinius 2, and Ruby Enterprise Edition. Additionally tests are run against MacRuby 0.10
 
-Performance tuning is mainly aimed at ruby 1.9, with ruby 1.8 and jruby taken in to consideration. jruby is generally fastest.
+Performance tuning is mainly aimed at Ruby 1.9, with Ruby 1.8 and JRuby taken in to consideration. JRuby is generally fastest.
 
 == HTTPTools::Parser
 

data/bench/parser/request_bench.rb

@@ -29,6 +29,15 @@ Benchmark.bm(41) do |x|
     end
   end
   
+  x.report("HTTPTools::Parser (reset, with env)") do
+    parser = HTTPTools::Parser.new
+    10_000.times do
+       parser << request
+       parser.env
+       parser.reset
+    end
+  end
+  
   begin
     require 'rubygems'
     require 'http/parser'

data/lib/http_tools.rb

@@ -1,3 +1,8 @@
+require_base = File.expand_path('../http_tools', __FILE__)
+require require_base + '/encoding'
+require require_base + '/parser'
+require require_base + '/builder'
+
 module HTTPTools
   STATUS_CODES = {
     :continue => 100,
@@ -9,6 +14,8 @@ module HTTPTools
     :no_content => 204,
     :reset_content => 205,
     :partial_content => 206,
+    :multi_status => 207,
+    :im_used => 226,
     :multiple_choices => 300,
     :moved_permanently => 301,
     :found => 302,
@@ -34,12 +41,19 @@ module HTTPTools
     :unsupported_media_type => 415,
     :requested_range_not_satisfiable => 416,
     :expectation_failed => 417,
+    :im_a_teapot => 418,
+    :unprocessable_entity => 422,
+    :locked => 423,
+    :failed_dependency => 424,
+    :upgrade_required => 426,
     :internal_server_error => 500,
     :not_implemented => 501,
     :bad_gateway => 502,
     :service_unavailable => 503,
     :gateway_timeout => 504,
-    :http_version_not_supported => 505}.freeze
+    :http_version_not_supported => 505,
+    :variant_also_negotiates => 506,
+    :insufficient_storage => 507}.freeze
   
   STATUS_DESCRIPTIONS = {
     100 => "Continue",
@@ -51,6 +65,8 @@ module HTTPTools
     204 => "No Content",
     205 => "Reset Content",
     206 => "Partial Content",
+    207 => "Multi-Status",
+    226 => "IM Used",
     300 => "Multiple Choices",
     301 => "Moved Permanently",
     302 => "Found",
@@ -76,12 +92,19 @@ module HTTPTools
     415 => "Unsupported Media Type",
     416 => "Requested Range Not Satisfiable",
     417 => "Expectation Failed",
+    418 => "I'm a teapot",
+    422 => "Unprocessable Entity",
+    423 => "Locked",
+    424 => "Failed Dependency",
+    426 => "Upgrade Required",
     500 => "Internal Server Error",
     501 => "Not Implemented",
     502 => "Bad Gateway",
     503 => "Service Unavailable",
     504 => "Gateway Timeout",
-    505 => "HTTP Version Not Supported"}.freeze
+    505 => "HTTP Version Not Supported",
+    506 => "Variant Also Negotiates",
+    507 => "Insufficient Storage"}.freeze
   STATUS_DESCRIPTIONS.values.each {|val| val.freeze}
   
   # :stopdoc: hide from rdoc as it makes a mess
@@ -103,10 +126,4 @@ module HTTPTools
   EndOfMessageError = Class.new(ParseError)
   MessageIncompleteError = Class.new(EndOfMessageError)
   EmptyMessageError = Class.new(MessageIncompleteError)
-  
-  require_base = File.dirname(__FILE__) + '/http_tools/'
-  autoload :Encoding, require_base + 'encoding'
-  autoload :Parser, require_base + 'parser'
-  autoload :Builder, require_base + 'builder'
-  
-end
+end

data/lib/http_tools/builder.rb

@@ -43,7 +43,7 @@ module HTTPTools
     def format_headers(headers, buffer="")
       headers.each do |key, value|
         if value.respond_to?(:each_line)
-          value.each_line {|val| buffer << "#{key}: #{val.chomp}\r\n"}
+          value.each_line {|val| val.chomp!; buffer << "#{key}: #{val}\r\n"}
         elsif value.respond_to?(:each)
           value.each {|val| buffer << "#{key}: #{val}\r\n"}
         else

data/lib/http_tools/encoding.rb

@@ -15,7 +15,6 @@ module HTTPTools
     SPACE = " ".freeze
     AMPERSAND = "&".freeze
     EQUALS = "=".freeze
-    CHUNK_FORMAT = "%x\r\n%s\r\n".freeze
     # :startdoc:
     
     module_function
@@ -25,7 +24,7 @@ module HTTPTools
     # URL encode a string, eg "le café" becomes "le+caf%c3%a9"
     # 
     def url_encode(string)
-      string.gsub(/[^a-zA-Z0-9._~-]+/) do |match|
+      string.gsub(/[^a-z0-9._~-]+/i) do |match|
         length = match.respond_to?(:bytesize) ? match.bytesize : match.length
         PERCENT + match.unpack(HEX_BIG_ENDIAN_2_BYTES * length).join(PERCENT)
       end
@@ -36,7 +35,7 @@ module HTTPTools
     # URL decode a string, eg "le+caf%c3%a9" becomes "le café"
     # 
     def url_decode(string)
-      string.tr(PLUS, SPACE).gsub(/(%[0-9a-fA-F]{2})+/) do |match|
+      string.tr(PLUS, SPACE).gsub(/(%[0-9a-f]{2})+/i) do |match|
         r = [match.delete(PERCENT)].pack(HEX_BIG_ENDIAN_REPEATING)
         r.respond_to?(:force_encoding) ? r.force_encoding(string.encoding) : r
       end
@@ -72,15 +71,17 @@ module HTTPTools
     # an array value, eg "lang=en&lang=fr" becomes {"lang" => ["en", "fr"]}
     #
     def www_form_decode(string)
-      string.split(AMPERSAND).inject({}) do |memo, key_value|
+      out = {}
+      string.split(AMPERSAND).each do |key_value|
         key, value = key_value.split(EQUALS)
         key, value = url_decode(key), url_decode(value)
-        if memo.key?(key)
-          memo.merge(key => [*memo[key]].push(value))
+        if out.key?(key)
+          out[key] = [*out[key]].push(value)
         else
-          memo.merge(key => value)
+          out[key] = value
         end
       end
+      out
     end
     
     # :call-seq:
@@ -94,8 +95,8 @@ module HTTPTools
     # passing an empty string or nil will generate the empty chunk.
     # 
     def transfer_encoding_chunked_encode(string)
-      if string && string.length > 0
-        sprintf(CHUNK_FORMAT, string.length, string)
+      if string && (length = string.length) > 0
+        "#{length.to_s(16)}\r\n#{string}\r\n"
       else
         "0\r\n"
       end

data/lib/http_tools/parser.rb

@@ -29,6 +29,7 @@ module HTTPTools
   # 
   class Parser
     # :stopdoc:
+    EMPTY = "".freeze
     COLON = ":".freeze
     KEY_TERMINATOR = ": ".freeze
     CONTENT_LENGTH = "Content-Length".freeze
@@ -92,7 +93,7 @@ module HTTPTools
       @force_trailer = nil
       @max_chunk_size = nil
       @status_code = nil
-      @header_done = nil
+      @header_complete = nil
       @content_left = nil
       @chunked = nil
       @body = nil
@@ -131,15 +132,15 @@ module HTTPTools
     def env
       return unless @header_complete
       env = PROTOTYPE_ENV.dup
-      env[REQUEST_METHOD] = @request_method
+      env[REQUEST_METHOD] = @request_method.upcase
       env[PATH_INFO] = @path_info
       env[QUERY_STRING] = @query_string
       @header.each do |key, value|
         upper_key = key.tr(LOWERCASE, UPPERCASE)
-        upper_key = HTTP_ + upper_key unless NO_HTTP_.key?(upper_key)
-        env[upper_key] = value
+        upper_key[0,0] = HTTP_ unless NO_HTTP_.key?(upper_key)
+        env[upper_key.freeze] = value
       end
-      host, port = env[HTTP_HOST].split(COLON)
+      host, port = env[HTTP_HOST].split(COLON) if env.key?(HTTP_HOST)
       env[SERVER_NAME] = host
       env[SERVER_PORT] = port || "80"
       @trailer.each {|k, val| env[HTTP_ + k.tr(LOWERCASE, UPPERCASE)] = val}
@@ -207,7 +208,7 @@ module HTTPTools
     # otherwise.
     # 
     def header?
-      @header_done
+      @header_complete
     end
     
     # :call-seq: parser.rest -> string
@@ -241,7 +242,7 @@ module HTTPTools
       @request_uri = nil
       @version = nil
       @status_code = nil
-      @header_done = nil
+      @header_complete = nil
       @header = {}
       @trailer = {}
       @last_key = nil
@@ -290,9 +291,7 @@ module HTTPTools
     alias on add_listener
     
     def inspect # :nodoc:
-      str = to_s
-      str[-1, 0] = " #{posstr} #{state}"
-      str
+      super.sub(/ .*>$/, " #{posstr} #{state}>")
     end
     
     private
@@ -300,7 +299,6 @@ module HTTPTools
       @request_method = @buffer.scan(/[a-z]+ /i)
       if @request_method
         @request_method.chop!
-        @request_method.upcase!
         uri
       elsif @buffer.check(/HTTP\//i)
         response_http_version
@@ -319,7 +317,7 @@ module HTTPTools
         @path_info = @request_uri.dup
         @path_info.slice!(/^([a-z0-9+.-]*:\/\/)?[^\/]+/i)
         @query_string = @path_info.slice!(/\?[a-z0-9;\/?:@&=+$,%_.!~*')(-]*/i)
-        @query_string ? @query_string.slice!(0) : @query_string = ""
+        @query_string ? @query_string[0] = EMPTY : @query_string = ""
         request_http_version
       elsif @buffer.check(/[a-z0-9;\/?:@&=+$,%_.!~*')(#-]+\Z/i)
         :uri
@@ -332,7 +330,6 @@ module HTTPTools
       @version = @buffer.scan(/ HTTP\/[0-9]+\.[0-9x]+\r\n/i)
       if @version
         @version.strip!
-        @version.upcase!
         key_or_newline
       elsif @buffer.skip(/\r\n/i)
         key_or_newline
@@ -348,7 +345,6 @@ module HTTPTools
       @version = @buffer.scan(/HTTP\/[0-9]+\.[0-9x]+ /i)
       if @version
         @version.chop!
-        @version.upcase!
         status
       elsif @buffer.eos? ||
         @buffer.check(/H(T(T(P(\/(\d+(\.(\d+\r?)?)?)?)?)?)?)?\Z/i)
@@ -417,7 +413,7 @@ module HTTPTools
         if @header.key?(@last_key)
           @header[@last_key] << "\n#{value}"
         else
-          @header[@last_key] = value
+          @header[@last_key.freeze] = value
         end
         if CONTENT_LENGTH.casecmp(@last_key) == 0
           @content_left = value.to_i
@@ -433,7 +429,6 @@ module HTTPTools
     end
     
     def start_body
-      @header_done = true
       if @request_method && !(@content_left || @chunked) ||
         NO_BODY.key?(@status_code) || @force_no_body
         end_of_message
@@ -541,7 +536,7 @@ module HTTPTools
         if @trailer.key?(@last_key)
           @trailer[@last_key] << "\n#{value}"
         else
-          @trailer[@last_key] = value
+          @trailer[@last_key.freeze] = value
         end
         trailer_key_or_newline
       elsif @buffer.eos? || @buffer.check(/[^\x00\n\x7f]+\Z/i)

data/profile/parser/request_profile.rb

@@ -1,12 +1,20 @@
 base = File.expand_path(File.dirname(__FILE__) + '/../../lib')
 require base + '/http_tools'
 require 'rubygems'
-require 'ruby-prof'
 
 request = "GET / HTTP/1.1\r\nHost: example.com\r\nUser-Agent: Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_5_8; en-gb) AppleWebKit/533.16 (KHTML, like Gecko) Version/5.0 Safari/533.16\r\nAccept: application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5\r\nAccept-Language: en-gb\r\nAccept-Encoding: gzip, deflate\r\nConnection: keep-alive\r\n\r\n"
 parser = HTTPTools::Parser.new
 
-result = RubyProf.profile do
-  parser << request
-end
-RubyProf::FlatPrinter.new(result).print(STDOUT, 0)
+# require 'ruby-prof'
+# result = RubyProf.profile do
+#   parser << request
+# end
+# RubyProf::FlatPrinter.new(result).print(STDOUT, 0)
+
+require 'perftools'
+PerfTools::CpuProfiler.start("/tmp/http_tools_parser_request_profile") do
+  100_000.times do
+    parser << request
+    parser.reset
+  end
+end

data/test/cover.rb

@@ -1,9 +1,7 @@
-#!/opt/local/bin/ruby1.9 -w
-
 require 'coverage' # >= ruby 1.9 only
 
 at_exit do
-  testing = Dir["../lib/**/*.rb"].map(&File.method(:expand_path))
+  testing = Dir[File.expand_path("../../lib/**/*.rb", __FILE__)]
   
   results = Coverage.result.select {|key, value| testing.include?(key)}
   
@@ -15,9 +13,11 @@ at_exit do
   results.each do |key, value|
     next unless value.include?(0)
     puts key
+    puts " line calls code"
     puts
     File.readlines(key).zip(value).each_with_index do |(line, val), i|
-      print "%3i %3s  %s" % [(i + 1), val, line]
+      print val == 0 ? "> " : "  "
+      print "%3i %5s %s" % [(i + 1), val, line]
     end
     puts
     puts
@@ -25,4 +25,4 @@ at_exit do
 end
 
 Coverage.start
-Dir["**/*_test.rb"].each {|test| require test}
+Dir[File.expand_path("../**/*_test.rb", __FILE__)].each {|test| require test}

data/test/parser/request_test.rb

@@ -314,7 +314,7 @@ class ParserRequestTest < Test::Unit::TestCase
     
     parser << "GET / HTTP/1.x\r\n\r\n"
     
-    assert_equal("HTTP/1.X", version)
+    assert_equal("HTTP/1.x", version)
   end
   
   def test_finish_without_body_trigger
@@ -455,7 +455,7 @@ class ParserRequestTest < Test::Unit::TestCase
     
     parser << "get / HTTP/1.1\r\n\r\n"
     
-    assert_equal("GET", result)
+    assert_equal("get", result)
   end
   
   def test_lowercase_http
@@ -466,7 +466,7 @@ class ParserRequestTest < Test::Unit::TestCase
     
     parser << "GET / http/1.1\r\n\r\n"
     
-    assert_equal("HTTP/1.1", version)
+    assert_equal("http/1.1", version)
   end
   
   def test_invalid_version
@@ -692,10 +692,32 @@ class ParserRequestTest < Test::Unit::TestCase
     assert_equal(nil, env["rack.input"])
   end
   
+  def test_env_lowercase_method
+    parser = HTTPTools::Parser.new
+    
+    parser << "get /test?q=foo HTTP/1.1\r\n"
+    parser << "Host: www.example.com\r\n\r\n"
+    
+    assert_equal("GET", parser.env["REQUEST_METHOD"])
+  end
+  
+  def test_env_no_host
+    parser = HTTPTools::Parser.new
+    
+    parser << "GET /test?q=foo HTTP/1.1\r\n\r\n"
+    
+    assert_nothing_raised(NoMethodError) do
+      parser.env
+    end
+    assert_equal(nil, parser.env["HTTP_HOST"])
+    assert_equal(nil, parser.env["SERVER_NAME"])
+    assert_equal("80", parser.env["SERVER_PORT"])
+  end
+  
   def test_inspect
     parser = HTTPTools::Parser.new
     
-    assert(/#<HTTPTools::Parser:[a-fx0-9]+ line 1, char 1 start>/ === parser.inspect, "Inspect should return useful information")
+    assert_match(/#<HTTPTools::Parser:0x[a-f0-9]+ line 1, char 1 start>/, parser.inspect)
   end
   
 end

data/test/parser/response_test.rb

@@ -24,7 +24,7 @@ class ParserResponseTest < Test::Unit::TestCase
     
     parser << "HTTP/1.x 200 OK\r\n\r\n"
     
-    assert_equal("HTTP/1.X", version)
+    assert_equal("HTTP/1.x", version)
   end
   
   def test_ok
@@ -882,7 +882,6 @@ class ParserResponseTest < Test::Unit::TestCase
     parser.add_listener(:header) do
       code = parser.status_code
       message = parser.message
-      headers = parser.header
     end
     parser.add_listener(:stream) {|chunk| body << chunk}
     parser.add_listener(:finish) {remainder = parser.rest}
@@ -905,7 +904,6 @@ class ParserResponseTest < Test::Unit::TestCase
     parser.add_listener(:header) do
       code = parser.status_code
       message = parser.message
-      headers = parser.header
     end
     parser.add_listener(:stream) {|chunk| body << chunk}
     parser.add_listener(:finish) {remainder = parser.rest}
@@ -928,7 +926,6 @@ class ParserResponseTest < Test::Unit::TestCase
     parser.add_listener(:header) do
       code = parser.status_code
       message = parser.message
-      headers = parser.header
     end
     parser.add_listener(:stream) {|chunk| body << chunk}
     parser.add_listener(:finish) {remainder = parser.rest}

data/test/runner.rb

@@ -1,10 +1 @@
-puts
-if defined? RUBY_DESCRIPTION
-  puts RUBY_DESCRIPTION
-elsif defined? RUBY_ENGINE
-  puts "#{RUBY_ENGINE} #{RUBY_VERSION} (#{RELEASE_DATE} patchlevel #{RUBY_PATCHLEVEL}) [#{RUBY_PLATFORM}]"
-else
-  puts "ruby #{RUBY_VERSION} (#{RELEASE_DATE} patchlevel #{RUBY_PATCHLEVEL}) [#{RUBY_PLATFORM}]"
-end
-
-Dir["**/*_test.rb"].each {|test| require File.expand_path(test)}
+Dir[File.expand_path("../**/*_test.rb", __FILE__)].each {|test| require test}

metadata

@@ -1,33 +1,24 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: http_tools
-version: !ruby/object:Gem::Version 
-  hash: 13
-  prerelease: false
-  segments: 
-  - 0
-  - 4
-  - 1
-  version: 0.4.1
+version: !ruby/object:Gem::Version
+  version: 0.4.2
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Matthew Sadler
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-06-27 00:00:00 +01:00
-default_executable: 
+date: 2011-09-25 00:00:00.000000000 Z
 dependencies: []
-
-description: A fast-as-possible pure Ruby HTTP parser plus associated lower level utilities to aid working with HTTP and the web.
+description: A fast-as-possible pure Ruby HTTP parser plus associated lower level
+  utilities to aid working with HTTP and the web.
 email: mat@sourcetagsandcodes.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.rdoc
-files: 
+files:
 - lib/http_tools/builder.rb
 - lib/http_tools/encoding.rb
 - lib/http_tools/parser.rb
@@ -53,42 +44,32 @@ files:
 - example/websocket_client.rb
 - example/websocket_server.rb
 - README.rdoc
-has_rdoc: true
 homepage: http://github.com/matsadler/http_tools
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --main
 - README.rdoc
 - --charset
 - utf-8
-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 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-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 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Pure Ruby HTTP parser and friends
 test_files: []
-