reel 0.0.2 → 0.1.0

data/CHANGES.md

@@ -0,0 +1,4 @@
+0.1.0
+-----
+
+* First official release

data/README.md

@@ -15,16 +15,17 @@ applications and provides traditional multithreaded blocking I/O support too.
 Connections to Reel can be either non-blocking and handled entirely within
 the Reel::Server thread, or the same connections can be dispatched to worker
 threads where they will perform ordinary blocking IO. Reel provides no
-built-in thread pool, however you can build one yourself using Celluloid::Pool,
+built-in thread pool, however you can build one yourself using Celluloid.pool,
 or because Celluloid already pools threads to begin with, you can simply use
 an actor per connection.
 
 This gives you the best of both worlds: non-blocking I/O for when you're
 primarily I/O bound, and threads for where you're compute bound.
 
-### Is It Good?
+### Is it any good?
 
-Yes, but it has room for improvement. A "hello world" web server benchmark,
+[Yes](http://news.ycombinator.com/item?id=3067434),
+but it has room for improvement. A "hello world" web server benchmark,
 run on a 2GHz i7 (OS X 10.7.3). All servers used in a single-threaded mode.
 
 Reel performance on various Ruby VMs:

data/lib/reel.rb

@@ -7,7 +7,7 @@ require 'reel/version'
 require 'reel/connection'
 require 'reel/logger'
 require 'reel/request'
-require 'reel/request/parser'
+require 'reel/request_parser'
 require 'reel/response'
 require 'reel/server'
 

data/lib/reel/connection.rb

@@ -1,7 +1,7 @@
 module Reel
   # A connection to the HTTP server
   class Connection
-    class StateError < RuntimeError; end # wrong state for a given request
+    class StateError < RuntimeError; end # wrong state for a given operation
 
     attr_reader :request
 
@@ -12,7 +12,7 @@ module Reel
       @socket = socket
       @keepalive = true
       @parser = Request::Parser.new
-      reset
+      reset_request
 
       @response_state = :header
       @body_remaining = nil
@@ -21,13 +21,19 @@ module Reel
     # Is the connection still active?
     def alive?; @keepalive; end
 
+    # Reset the current request state
+    def reset_request
+      @request_state = :header
+      @request = nil
+      @parser.reset
+    end
+
+    # Read a request object from the connection
     def read_request
       raise StateError, "can't read header" unless @request_state == :header
 
       begin
-        until @parser.headers
-          @parser << @socket.readpartial(BUFFER_SIZE)
-        end
+        @parser << @socket.readpartial(BUFFER_SIZE) until @parser.headers
       rescue IOError, Errno::ECONNRESET, Errno::EPIPE
         @keepalive = false
         @socket.close unless @socket.closed?
@@ -37,8 +43,8 @@ module Reel
       @request_state = :body
 
       headers = {}
-      @parser.headers.each do |header, value|
-        headers[Http.canonicalize_header(header)] = value
+      @parser.headers.each do |field, value|
+        headers[Http.canonicalize_header(field)] = value
       end
 
       if headers['Connection']
@@ -51,6 +57,7 @@ module Reel
       @request = Request.new(@parser.http_method, @parser.url, @parser.http_version, headers, self)
     end
 
+    # Read a chunk from the request
     def readpartial(size = BUFFER_SIZE)
       if @body_remaining and @body_remaining > 0
         chunk = @parser.chunk
@@ -67,11 +74,22 @@ module Reel
       end
     end
 
-    def respond(response, body = nil)
+    # Send a response back to the client
+    # Response can be a symbol indicating the status code or a Reel::Response
+    def respond(response, headers_or_body = {}, body = nil)
+      raise StateError "not in header state" if @response_state != :header
+
+      if headers_or_body.is_a? Hash
+        headers = headers_or_body
+      else
+        headers = {}
+        body = headers_or_body
+      end
+
       if @keepalive
-        headers = {'Connection' => 'Keep-Alive'}
+        headers['Connection'] = 'Keep-Alive'
       else
-        headers = {'Connection' => 'close'}
+        headers['Connection'] = 'close'
       end
 
       case response
@@ -82,12 +100,17 @@ module Reel
       end
 
       response.render(@socket)
+
+      # Enable streaming mode
+      if response.headers['Transfer-Encoding'] == "chunked" and response.body.nil?
+        @response_state = :chunked_body
+      end
     rescue IOError, Errno::ECONNRESET, Errno::EPIPE
       # The client disconnected early
       @keepalive = false
     ensure
       if @keepalive
-        reset
+        reset_request
         @request_state = :header
       else
         @socket.close unless @socket.closed?
@@ -95,10 +118,26 @@ module Reel
       end
     end
 
-    def reset
-      @request_state = :header
-      @request = nil
-      @parser.reset
+    # Write body chunks directly to the connection
+    def write(chunk)
+      raise StateError, "not in chunked body mode" unless @response_state == :chunked_body
+      chunk_header = chunk.bytesize.to_s(16) + Response::CRLF
+      @socket << chunk_header
+      @socket << chunk
+    end
+    alias_method :<<, :write
+
+    # Finish the response and reset the response state to header
+    def finish_response
+      raise StateError, "not in body state" if @response_state != :chunked_body
+      @socket << "0" << Response::CRLF * 2
+      @response_state = :header
+    end
+
+    # Close the connection
+    def close
+      @keepalive = false
+      @socket.close
     end
   end
 end

data/lib/reel/{request/parser.rb → request_parser.rb}

@@ -1,5 +1,4 @@
 module Reel
-  # Parses incoming HTTP requests
   class Request
     class Parser
       attr_reader :headers

data/lib/reel/response.rb

@@ -6,17 +6,26 @@ module Reel
     CRLF = "\r\n"
 
     attr_reader   :status # Status has a special setter to coerce symbol names
-    attr_accessor :reason
+    attr_accessor :reason # Reason can be set explicitly if desired
+    attr_reader   :headers, :body
 
     def initialize(status, body_or_headers = nil, body = nil)
       self.status = status
 
-      if body_or_headers and not body
-        @body = body_or_headers
-        @headers = {}
-      else
+      if body_or_headers.is_a?(Hash)
+        headers = body_or_headers
         @body = body
-        @headers = body_or_headers
+      else
+        headers = {}
+        @body = body_or_headers
+      end
+
+      @headers = {}
+      headers.each do |name, value|
+        name = name.to_s
+        key = name[Http::CANONICAL_HEADER]
+        key ||= canonicalize_header(name)
+        @headers[key] = value.to_s
       end
 
       case @body
@@ -24,8 +33,15 @@ module Reel
         @headers['Content-Length'] ||= @body.bytesize
       when IO
         @headers['Content-Length'] ||= @body.stat.size
+      when Enumerable
+        @headers['Transfer-Encoding'] ||= 'chunked'
+      when NilClass
+      else raise ArgumentError, "can't render #{@body.class} as a response body"
       end
 
+      # Prevent modification through the accessor
+      @headers.freeze
+
       # FIXME: real HTTP versioning
       @version = "HTTP/1.1"
     end
@@ -59,6 +75,14 @@ module Reel
         while data = @body.read(4096)
           socket << data
         end
+      when Enumerable
+        @body.each do |chunk|
+          chunk_header = chunk.bytesize.to_s(16) + CRLF
+          socket << chunk_header
+          socket << chunk
+        end
+
+        socket << "0" << CRLF * 2
       end
     end
 
@@ -76,5 +100,11 @@ module Reel
       response_header << CRLF
     end
     private :render_header
+
+    # Transform to canonical HTTP header capitalization
+    def canonicalize_header(header)
+      header.to_s.split(/[\-_]/).map(&:capitalize).join('-')
+    end
+    private :canonicalize_header
   end
 end

data/lib/reel/version.rb

@@ -1,3 +1,3 @@
 module Reel
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/spec/reel/connection_spec.rb

@@ -52,6 +52,35 @@ describe Reel::Connection do
     end
   end
 
+  it "streams responses when transfer-encoding is chunked" do
+    with_socket_pair do |client, connection|
+      client << ExampleRequest.new.to_s
+      request = connection.read_request
+
+      # Sending transfer_encoding chunked without a body enables streaming mode
+      connection.respond :ok, :transfer_encoding => :chunked
+
+      # This will send individual chunks
+      connection << "Hello"
+      connection << "World"
+      connection.finish_response # Write trailer and reset connection to header mode
+      connection.close
+
+      response = ""
+
+      begin
+        while chunk = client.readpartial(4096)
+          response << chunk
+        end
+      rescue EOFError
+      end
+
+      crlf = "\r\n"
+      fixture = "5#{crlf}Hello5#{crlf}World0#{crlf*2}"
+      response[(response.length - fixture.length)..-1].should eq fixture
+    end
+  end
+
   def with_socket_pair
     host = '127.0.0.1'
     port = 10103
@@ -60,10 +89,12 @@ describe Reel::Connection do
     client = TCPSocket.new(host, port)
     peer   = server.accept
 
-    yield client, Reel::Connection.new(peer)
-
-    server.close
-    client.close
-    peer.close
+    begin
+      yield client, Reel::Connection.new(peer)
+    ensure
+      server.close rescue nil
+      client.close rescue nil
+      peer.close   rescue nil
+    end
   end
 end

data/spec/reel/response_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Reel::Response do
+  it "streams enumerables" do
+    with_socket_pair do |client, connection|
+      client << ExampleRequest.new.to_s
+      request = connection.read_request
+
+      connection.respond Reel::Response.new(:ok, ["Hello", "World"])
+
+      response = client.readpartial(4096)
+      crlf = "\r\n"
+      fixture = "5#{crlf}Hello5#{crlf}World0#{crlf*2}"
+      response[(response.length - fixture.length)..-1].should eq fixture
+    end
+  end
+
+  def with_socket_pair
+    host = '127.0.0.1'
+    port = 10103
+
+    server = TCPServer.new(host, port)
+    client = TCPSocket.new(host, port)
+    peer   = server.accept
+
+    begin
+      yield client, Reel::Connection.new(peer)
+    ensure
+      server.close
+      client.close
+      peer.close
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reel
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-03 00:00:00.000000000 Z
+date: 2012-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: celluloid-io
-  requirement: &70171644061140 !ruby/object:Gem::Requirement
+  requirement: &70093521317700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 0.8.0
   type: :runtime
   prerelease: false
-  version_requirements: *70171644061140
+  version_requirements: *70093521317700
 - !ruby/object:Gem::Dependency
   name: http
-  requirement: &70171644060640 !ruby/object:Gem::Requirement
+  requirement: &70093521316860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 0.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *70171644060640
+  version_requirements: *70093521316860
 - !ruby/object:Gem::Dependency
   name: http_parser.rb
-  requirement: &70171644060180 !ruby/object:Gem::Requirement
+  requirement: &70093521316180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 0.5.3
   type: :runtime
   prerelease: false
-  version_requirements: *70171644060180
+  version_requirements: *70093521316180
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70171644059800 !ruby/object:Gem::Requirement
+  requirement: &70093521315560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70171644059800
+  version_requirements: *70093521315560
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70171644075700 !ruby/object:Gem::Requirement
+  requirement: &70093521314860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70171644075700
+  version_requirements: *70093521314860
 description: A Celluloid::IO-powered HTTP server
 email:
 - tony.arcieri@gmail.com
@@ -77,6 +77,7 @@ files:
 - .gitignore
 - .rspec
 - .travis.yml
+- CHANGES.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -91,7 +92,7 @@ files:
 - lib/reel/connection.rb
 - lib/reel/logger.rb
 - lib/reel/request.rb
-- lib/reel/request/parser.rb
+- lib/reel/request_parser.rb
 - lib/reel/response.rb
 - lib/reel/server.rb
 - lib/reel/version.rb
@@ -99,6 +100,7 @@ files:
 - reel.gemspec
 - spec/fixtures/example.txt
 - spec/reel/connection_spec.rb
+- spec/reel/response_spec.rb
 - spec/reel/server_spec.rb
 - spec/spec_helper.rb
 - tasks/rspec.rake
@@ -129,6 +131,7 @@ summary: A reel good HTTP server
 test_files:
 - spec/fixtures/example.txt
 - spec/reel/connection_spec.rb
+- spec/reel/response_spec.rb
 - spec/reel/server_spec.rb
 - spec/spec_helper.rb
 has_rdoc: