http_tools 0.4.4 → 0.4.5

data/README.rdoc

@@ -29,7 +29,7 @@ possible.
 
   parser = HTTPTools::Parser.new
   parser.on(:header) do
-    puts parser.status_code + " " + parser.message
+    puts parser.status_code.to_s + " " + parser.message
     puts parser.header.inspect
   end
   parser.on(:finish) {print parser.body}
@@ -72,7 +72,7 @@ responses. It can be used as a mixin or class methods on HTTPTools::Builder.
 
 (The MIT License)
 
-Copyright (c) 2011 Matthew Sadler
+Copyright (c) 2012, 2011 Matthew Sadler
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/lib/http_tools.rb

@@ -1,3 +1,4 @@
+# encoding: ASCII-8BIT
 require_base = File.expand_path('../http_tools', __FILE__)
 require require_base + '/encoding'
 require require_base + '/parser'
@@ -58,6 +59,7 @@ module HTTPTools
   STATUS_DESCRIPTIONS = {
     100 => "Continue",
     101 => "Switching Protocols",
+    102 => "Processing",
     200 => "OK",
     201 => "Created",
     202 => "Accepted",
@@ -66,6 +68,7 @@ module HTTPTools
     205 => "Reset Content",
     206 => "Partial Content",
     207 => "Multi-Status",
+    208 => "Already Reported",
     226 => "IM Used",
     300 => "Multiple Choices",
     301 => "Moved Permanently",
@@ -73,7 +76,9 @@ module HTTPTools
     303 => "See Other",
     304 => "Not Modified",
     305 => "Use Proxy",
+    306 => "Reserved",
     307 => "Temporary Redirect",
+    308 => "Permanent Redirect",
     400 => "Bad Request",
     401 => "Unauthorized",
     402 => "Payment Required",
@@ -97,6 +102,9 @@ module HTTPTools
     423 => "Locked",
     424 => "Failed Dependency",
     426 => "Upgrade Required",
+    428 => "Precondition Required",
+    429 => "Too Many Requests",
+    431 => "Request Header Fields Too Large",
     500 => "Internal Server Error",
     501 => "Not Implemented",
     502 => "Bad Gateway",
@@ -104,13 +112,16 @@ module HTTPTools
     504 => "Gateway Timeout",
     505 => "HTTP Version Not Supported",
     506 => "Variant Also Negotiates",
-    507 => "Insufficient Storage"}.freeze
+    507 => "Insufficient Storage",
+    508 => "Loop Detected",
+    510 => "Not Extended",
+    511 => "Network Authentication Required"}.freeze
   STATUS_DESCRIPTIONS.values.each {|val| val.freeze}
   
   # :stopdoc: hide from rdoc as it makes a mess
   STATUS_LINES = {}
   STATUS_CODES.each do |name, code|
-    line = "#{code} #{STATUS_DESCRIPTIONS[code]}"
+    line = "#{code} #{STATUS_DESCRIPTIONS[code]}".freeze
     STATUS_LINES[name] = line
     STATUS_LINES[code] = line
   end
@@ -119,7 +130,10 @@ module HTTPTools
   
   METHODS = %W{GET POST HEAD PUT DELETE OPTIONS TRACE CONNECT}.freeze
   
-  NO_BODY = {204 => true, 304 => true} # presence of key tested, not value
+  #--
+  # presence of key tested, not value
+  #++
+  NO_BODY = {204 => true, 205 => true, 304 => true}
   100.upto(199) {|status_code| NO_BODY[status_code] = true}
   NO_BODY.freeze
   

data/lib/http_tools/builder.rb

@@ -1,6 +1,7 @@
+# encoding: ASCII-8BIT
 module HTTPTools
   
-  # HTTPTools::Builder is a provides a simple interface to build HTTP requests &
+  # HTTPTools::Builder a provides a simple interface to build HTTP requests &
   # responses. It can be used as a mixin or class methods on HTTPTools::Builder.
   # 
   module Builder
@@ -21,8 +22,8 @@ module HTTPTools
     #   Builder.response(:ok, "Set-Cookie" => ["a=b", "c=d"])
     #   Builder.response(:ok, "Set-Cookie" => "a=b\nc=d")
     # 
-    def response(status, headers={})
-      "HTTP/1.1 #{STATUS_LINES[status]}\r\n#{format_headers(headers)}\r\n"
+    def response(code, headers={})
+      "HTTP/1.1 #{STATUS_LINES[code] || code}\r\n#{format_headers(headers)}\r\n"
     end
     
     # :call-seq: Builder.request(method, host, path="/", headers={}) -> string

data/lib/http_tools/encoding.rb

@@ -1,3 +1,4 @@
+# encoding: ASCII-8BIT
 require 'strscan'
 
 module HTTPTools
@@ -21,7 +22,7 @@ module HTTPTools
     
     # :call-seq: Encoding.url_encode(string) -> encoded_string
     # 
-    # URL encode a string, eg "le café" becomes "le+caf%c3%a9"
+    # URL encode a string, e.g. "le café" becomes "le+caf%c3%a9"
     # 
     def url_encode(string)
       string.gsub(/[^a-z0-9._~-]+/i) do |match|
@@ -32,23 +33,22 @@ module HTTPTools
     
     # :call-seq: Encoding.url_decode(encoded_string) -> string
     # 
-    # URL decode a string, eg "le+caf%c3%a9" becomes "le café"
+    # URL decode a string, e.g. "le+caf%c3%a9" becomes "le café"
     # 
     def url_decode(string)
       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
+        [match.delete(PERCENT)].pack(HEX_BIG_ENDIAN_REPEATING)
       end
     end
     
     # :call-seq: Encoding.www_form_encode(hash) -> string
     # 
     # Takes a Hash and converts it to a String as if it was a HTML form being
-    # submitted, eg
+    # submitted, e.g.
     # {"query" => "fish", "lang" => "en"} becomes "query=fish&lang=en"
     # 
     # To get multiple key value pairs with the same key use an array as the
-    # value, eg
+    # value, e.g.
     # {"lang" => ["en", "fr"]} become "lang=en&lang=fr"
     # 
     def www_form_encode(hash)
@@ -65,10 +65,10 @@ module HTTPTools
     # 
     # Takes a String resulting from a HTML form being submitted, and converts it
     # to a hash,
-    # eg "lang=en&query=fish" becomes {"lang" => "en", "query" => "fish"}
+    # e.g. "lang=en&query=fish" becomes {"lang" => "en", "query" => "fish"}
     # 
     # Multiple key value pairs with the same key will become a single key with
-    # an array value, eg "lang=en&lang=fr" becomes {"lang" => ["en", "fr"]}
+    # an array value, e.g. "lang=en&lang=fr" becomes {"lang" => ["en", "fr"]}
     #
     def www_form_decode(string)
       out = {}
@@ -88,10 +88,10 @@ module HTTPTools
     # Encoding.transfer_encoding_chunked_encode(string) -> encoded_string
     # 
     # Returns string as a 'chunked' transfer encoding encoded string, suitable
-    # for a streaming response from a HTTP server, eg
-    # "foo" becomes "3\r\nfoo\r\n"
+    # for a streaming response from a HTTP server, e.g.
+    # "foo" becomes "3\\r\\nfoo\\r\\n"
     #
-    # chunked responses should be terminted with a empty chunk, eg "0\r\n",
+    # chunked responses should be terminted with a empty chunk, e.g. "0\\r\\n",
     # passing an empty string or nil will generate the empty chunk.
     # 
     def transfer_encoding_chunked_encode(string)
@@ -107,14 +107,12 @@ module HTTPTools
     # 
     # Decoding a complete chunked response will return an array containing
     # the decoded response and nil.
-    # Example:
     #   encoded_string = "3\r\nfoo\r\n3\r\nbar\r\n0\r\n"
     #   Encoding.transfer_encoding_chunked_decode(encoded_string)
     #   #=> ["foobar", nil]
     # 
     # Decoding a partial response will return an array of the response decoded
     # so far, and the remainder of the encoded string.
-    # Example
     #   encoded_string = "3\r\nfoo\r\n3\r\nba"
     #   Encoding.transfer_encoding_chunked_decode(encoded_string)
     #   #=> ["foo", "3\r\nba"]
@@ -126,7 +124,7 @@ module HTTPTools
     #   #=> ["foobar", ""]
     # 
     # If nothing can be decoded the first element in the array will be nil and
-    # the second the remainder
+    # the second the remainder.
     #   encoded_string = "3\r\nfo"
     #   Encoding.transfer_encoding_chunked_decode(encoded_string)
     #   #=> [nil, "3\r\nfo"]

data/lib/http_tools/parser.rb

@@ -1,3 +1,4 @@
+# encoding: ASCII-8BIT
 require 'strscan'
 require 'stringio'
 
@@ -6,14 +7,14 @@ module HTTPTools
   # HTTPTools::Parser is a pure Ruby HTTP request & response parser with an
   # evented API.
   # 
-  # The HTTP message can be fed in to the parser piece by piece as it comes over
-  # the wire, and the parser will call its callbacks as it works it's way
+  # The HTTP message can be fed into the parser piece by piece as it comes over
+  # the wire, and the parser will call its callbacks as it works its way
   # through the message.
   # 
   # Example:
   #   parser = HTTPTools::Parser.new
   #   parser.on(:header) do
-  #     puts parser.status_code + " " + parser.message
+  #     puts parser.status_code.to_s + " " + parser.message
   #     puts parser.header.inspect
   #   end
   #   parser.on(:finish) {print parser.body}
@@ -60,7 +61,7 @@ module HTTPTools
     HTTP_ = "HTTP_".freeze
     LOWERCASE = "a-z-".freeze
     UPPERCASE = "A-Z_".freeze
-    NO_HTTP_ = {"CONTENT_LENGTH" => true, "CONTENT_TYPE" => true}
+    NO_HTTP_ = {"CONTENT_LENGTH" => true, "CONTENT_TYPE" => true}.freeze
     # :startdoc:
     EVENTS = %W{header stream trailer finish error}.map {|e| e.freeze}.freeze
     
@@ -108,7 +109,7 @@ module HTTPTools
     # :call-seq: parser.concat(data) -> parser
     # parser << data -> parser
     # 
-    # Feed data in to the parser and trigger callbacks.
+    # Feed data into the parser and trigger callbacks.
     # 
     # Will raise HTTPTools::ParseError on error, unless a callback has been set
     # for the :error event, in which case the callback will recieve the error
@@ -127,10 +128,10 @@ module HTTPTools
     # before headers are complete.
     #
     # "SERVER_NAME" and "SERVER_PORT" are only supplied if they can be
-    # determined from the request (eg, they are present in the "Host" header).
+    # determined from the request (e.g., they are present in the "Host" header).
     # 
     # "rack.input" is only supplied if #env is called after parsing the request
-    # has finsished, and no listener is set for the `stream` event
+    # has finsished, and no listener is set for the +stream+ event
     # 
     # If not supplied, you must ensure "SERVER_NAME", "SERVER_PORT", and
     # "rack.input" are present to make the environment hash fully Rack compliant
@@ -236,7 +237,7 @@ module HTTPTools
     # :call-seq: parser.reset -> parser
     # 
     # Reset the parser so it can be used to process a new request.
-    # Callbacks/delegates will not be removed.
+    # Callbacks will not be removed.
     # 
     def reset
       @state = :start
@@ -272,23 +273,22 @@ module HTTPTools
     # Adding a second callback for an event will overwite the existing callback.
     # 
     # Events:
-    # [header]     Called when headers are complete
+    # [header]  Called when headers are complete
     # 
-    # [stream]     Supplied with one argument, the last chunk of body data fed
-    #              in to the parser as a String, e.g. "<h1>Hello". If no
-    #              listener is set for this event the body can be retrieved with
-    #              #body
+    # [stream]  Supplied with one argument, the last chunk of body data fed in
+    #           to the parser as a String, e.g. "<h1>Hello". If no listener is
+    #           set for this event the body can be retrieved with #body
     # 
-    # [trailer]    Called on the completion of the trailer, if present
+    # [trailer] Called on the completion of the trailer, if present
     # 
-    # [finish]     Called on completion of the entire message. Any unconsumed
-    #              data (such as the start of the next message with keepalive)
-    #              can be retrieved with #rest
+    # [finish]  Called on completion of the entire message. Any unconsumed data
+    #           (such as the start of the next message with keepalive) can be
+    #           retrieved with #rest
     # 
-    # [error]      Supplied with one argument, an error encountered while
-    #              parsing as a HTTPTools::ParseError. If a listener isn't
-    #              registered for this event, an exception will be raised when
-    #              an error is encountered
+    # [error]   Supplied with one argument, an error encountered while parsing
+    #           as a HTTPTools::ParseError. If a listener isn't registered for
+    #           this event, an exception will be raised when an error is
+    #           encountered
     # 
     def add_listener(event, proc=nil, &block)
       instance_variable_set(:"@#{event}_callback", proc || block)

data/profile/parser/request_profile.rb

@@ -1,12 +1,23 @@
 base = File.expand_path(File.dirname(__FILE__) + '/../../lib')
 require base + '/http_tools'
 require 'rubygems'
-require 'ruby-prof'
+# 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
+# result = RubyProf.profile do
+#   parser << request
+# end
+# RubyProf::FlatPrinter.new(result).print(STDOUT, 0)
+
+
+# pprof.rb --pdf /tmp/request_profile > /tmp/request_profile.pdf
+
+require "perftools"
+PerfTools::CpuProfiler.start("/tmp/request_profile") do
+  # 100_000.times do
+    parser << request
+    # parser.reset
+  # end
 end
-RubyProf::FlatPrinter.new(result).print(STDOUT, 0)

data/test/builder/request_test.rb

@@ -1,3 +1,4 @@
+# encoding: ASCII-8BIT
 base = File.expand_path(File.dirname(__FILE__) + '/../../lib')
 require base + '/http_tools'
 require 'test/unit'

data/test/builder/response_test.rb

@@ -1,9 +1,15 @@
+# encoding: ASCII-8BIT
 base = File.expand_path(File.dirname(__FILE__) + '/../../lib')
 require base + '/http_tools'
 require 'test/unit'
 
 class BuilderResponseTest < Test::Unit::TestCase
   
+  def ruby_one_nine_or_greater?
+    ruby_version = RUBY_VERSION.split(".").map {|d| d.to_i}
+    ruby_version[0] > 1 || (ruby_version[0] == 1 && ruby_version[1] >= 9)
+  end
+  
   def test_status_ok
     result = HTTPTools::Builder.response(:ok)
     
@@ -22,11 +28,22 @@ class BuilderResponseTest < Test::Unit::TestCase
     assert_equal("HTTP/1.1 500 Internal Server Error\r\n\r\n", result)
   end
   
+  def test_status_unrecognised
+    result = HTTPTools::Builder.response(600)
+    
+    assert_equal("HTTP/1.1 600\r\n\r\n", result)
+  end
+  
   def test_headers
     result = HTTPTools::Builder.response(:ok, "Content-Type" => "text/html", "Content-Length" => 1024)
     
     expected = "HTTP/1.1 200 OK\r\nContent-Type: text/html\r\nContent-Length: 1024\r\n\r\n"
-    assert_equal(expected, result)
+    if ruby_one_nine_or_greater?
+      assert_equal(expected, result)
+    else
+      other_possible_order = "HTTP/1.1 200 OK\r\nContent-Length: 1024\r\nContent-Type: text/html\r\n\r\n"
+      assert([expected, other_possible_order].include?(result))
+    end
   end
   
   def test_newline_separated_multi_value_headers

data/test/encoding/transfer_encoding_chunked_test.rb

@@ -1,3 +1,4 @@
+# encoding: ASCII-8BIT
 base = File.expand_path(File.dirname(__FILE__) + '/../../lib')
 require base + '/http_tools'
 require 'test/unit'

data/test/encoding/url_encoding_test.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# encoding: ASCII-8BIT
 base = File.expand_path(File.dirname(__FILE__) + '/../../lib')
 require base + '/http_tools'
 require 'test/unit'
@@ -32,7 +32,12 @@ class URLEncodingTest < Test::Unit::TestCase
   def test_decode_latin_capital_letter_a_with_grave
     result = HTTPTools::Encoding.url_decode("%C3%80")
     
-    assert_equal("À", result)
+    if defined?(RUBY_ENGINE) && RUBY_ENGINE == "macruby"
+      # work around macruby not respecting the coding comment
+      assert_equal("À".force_encoding("ASCII-8BIT"), result)
+    else
+      assert_equal("À", result)
+    end
   end
   
 end

data/test/encoding/www_form_test.rb

@@ -1,3 +1,4 @@
+# encoding: ASCII-8BIT
 base = File.expand_path(File.dirname(__FILE__) + '/../../lib')
 require base + '/http_tools'
 require 'test/unit'

data/test/parser/request_test.rb

@@ -1,3 +1,4 @@
+# encoding: ASCII-8BIT
 base = File.expand_path(File.dirname(__FILE__) + '/../../lib')
 require base + '/http_tools'
 require 'test/unit'
@@ -172,6 +173,22 @@ GET /foo#ba
     MESSAGE
   end
   
+  def test_path_with_space
+    parser = HTTPTools::Parser.new
+    
+    error = assert_raise(HTTPTools::ParseError) do
+      parser << "GET /foo bar HTTP/1.1\r\n"
+    end
+    
+    return unless "".respond_to?(:lines)
+    assert_equal(<<-MESSAGE.chomp, error.message)
+Invalid version specifier at line 1, char 10
+
+GET /foo bar HTTP/1.1\\r\\n
+         ^
+    MESSAGE
+  end
+  
   def test_with_header
     parser = HTTPTools::Parser.new
     method = nil

data/test/parser/response_test.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# encoding: ASCII-8BIT
 base = File.expand_path(File.dirname(__FILE__) + '/../../lib')
 require base + '/http_tools'
 require 'test/unit'
@@ -98,10 +98,14 @@ class ParserResponseTest < Test::Unit::TestCase
       code, message = parser.status_code, parser.message
     end
     
-    parser << "HTTP/1.1 403 Accès interdit\r\n\r\n"
+    parser << "HTTP/1.1 403 Acc\xC3\xA8s interdit\r\n\r\n"
     
     assert_equal(403, code)
-    assert_equal("Accès interdit", message)
+    expected_message = "Acc\xC3\xA8s interdit"
+    if expected_message.respond_to?(:force_encoding)
+      expected_message.force_encoding(message.encoding)
+    end
+    assert_equal(expected_message, message)
     assert(!parser.finished?, "parser should not be finished")
   end
   

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: http_tools
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 5
   prerelease: 
   segments: 
   - 0
   - 4
-  - 4
-  version: 0.4.4
+  - 5
+  version: 0.4.5
 platform: ruby
 authors: 
 - Matthew Sadler
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-20 00:00:00 +00:00
+date: 2013-02-05 00:00:00 +00:00
 default_executable: 
 dependencies: []