reel 0.5.0 → 0.6.0.pre1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 51c0dc865d430ed8c784c17406b7f949d52425b1
-  data.tar.gz: f995592d1a542714360c99e20aadbc4281dee482
+  metadata.gz: b1a993a695b913f3274786678b7a8080749b5e2b
+  data.tar.gz: fcdccf97f738d01e317292f4f5499f8990d3948a
 SHA512:
-  metadata.gz: c7d803b74e5e2b272fcb8affd947b1a0804e4b394945d680a38ebaf14ec95a7c994128e50ce95d38e656c68db1d655109c7179235fd3702d0c4eca3ced7cf9b8
-  data.tar.gz: 4501a6d27b87a472529d1cbc3708cb950e8299c1aabae7a7565775450ab362f0f25674a417449c771dfa5b2a4cb500435619bf5f53146e875c6d02cbf24027c4
+  metadata.gz: a25fb72f593a8f05bae8272a4e5d3aeec408af15673ec05216b9abcaf2fae06f127e08f88b7cccc2f0c42f86a319e0ae2ae26bf6c22e7599c5da3fb52f4d8c76
+  data.tar.gz: 0707f29757b92d69e6b9c025702fc2da0823e8e19164c8b3a81f5347d4de3f2f71fb4b94f7000eb9c6dc4bb5d9609185b4a7df61e3211b86d789b0175658b16a

data/.rspec

@@ -1,5 +1,4 @@
 --color 
 --format documentation 
 --backtrace
---default_path spec
 --order random

data/.travis.yml

@@ -1,18 +1,17 @@
 rvm:
   - 1.9.3
   - 2.0.0
-  - 2.1.0
+  - 2.1.2
   - ruby-head
   - jruby
   - jruby-head
-  - rbx
+  - rbx-2
 
 matrix:
   allow_failures:
     - rvm: ruby-head
-    - rvm: jruby
     - rvm: jruby-head
-    - rvm: rbx
+    - rvm: rbx-2
 
 notifications:
   irc: "irc.freenode.org#celluloid"

data/CHANGES.md

@@ -1,5 +1,25 @@
+0.6.0 (2015-03-24)
+-----
+* Fix stack level too deep when writing to ChunkStream
+* Use HTTP::Resonse::Status::REASONS table ( HTTP::Response::* deprecated in the HTTP gem )
+* Use Timers 3.0.0 API
+* Case-insensitivity for header field names ( i.e. in case a proxy downcases them )
+* Catch when openssl sometimes fires ECONNRESET, EPIPE, ETIMEDOUT, EHOSTUNREACH and  as an error
+* Unused `optimize` socket modifications taken off all server implementations
+* Fixed 404 error in roundtrip example
+* Fixed "Reel::StateError: already processing a request" when client is killed
+* Numerous updates to rspec.
+* Switched to websocket/driver and improved websocket handling
+* Implement DriverEnvironment to fix websocket example
+* Refactored Server::HTTPS to be more idomatic
+* Fixed jRuby related test failures
+* Fixed "ArgumentError: Data object has already been freed" caused by underlying parser.
+* FINALLY! Support for UNIX Socket servers across all RVM's, as of jRuby 1.7.19
+* Unified Server#run removes need for duplication of #run across all Server implementations.
+* Standardized method of rescuing exceptions unique to each type of Server in unified #run method.
+
 0.5.0 (2014-04-15)
-------------------
+-----
 * Reel::Server(::SSL) renamed to Reel::Server::HTTP and Reel::Server::HTTPS
 * New Reel::Spy API for observing requests and responses from the server
 * Fixes to chunked encoding handling
@@ -8,7 +28,7 @@
 * Ensure response bodies are always closed
 * Support for passing a fixnum status to Connection#respond
 
-0.4.0
+0.4.0 (2013-09-14)
 -----
 * Rack adapter moved to the reel-rack project
 * Pipelining support
@@ -23,7 +43,7 @@
 * Remove Reel::App (unmaintained, sorry)
 * Reel::CODENAME added (0.4.0 is "Garbo")
 
-0.3.0
+0.3.0 (2013-02-01)
 -----
 * Reel::App: Sinatra-like DSL for defining Reel apps using Octarine
 * Chunked upload support
@@ -33,12 +53,12 @@
 * Bugfix: Send CRLF after chunks
 * Bugfix: Increase TCP connection backlog to 1024
 
-0.2.0
+0.2.0 (2012-09-03)
 -----
 * Initial WebSockets support via Reel::WebSocket
 * Experimental Rack adapter by Alberto Fernández-Capel
 * Octarine (Sinatra-like DSL) support by Grant Rodgers
 
-0.1.0
+0.1.0 (2012-07-12)
 -----
 * Initial release

data/Gemfile

@@ -1,8 +1,8 @@
 source 'https://rubygems.org'
 
-gem 'celluloid',    github: 'celluloid/celluloid'
-gem 'celluloid-io', github: 'celluloid/celluloid-io'
-gem 'http',         github: 'tarcieri/http'
+gem 'celluloid'
+gem 'celluloid-io'
+gem 'http'
 
 gem 'jruby-openssl' if defined? JRUBY_VERSION
 gem 'coveralls', require: false

data/Guardfile

@@ -1,24 +1,14 @@
-# A sample Guardfile
-# More info at https://github.com/guard/guard#readme
-
-guard :rspec do
-  watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')  { "spec" }
-
-  # Rails example
-  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
-  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
-  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
-  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
-  watch('config/routes.rb')                           { "spec/routing" }
-  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
-
-  # Capybara features specs
-  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/features/#{m[1]}_spec.rb" }
-
-  # Turnip features and steps
-  watch(%r{^spec/acceptance/(.+)\.feature$})
-  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
 end
-

data/examples/roundtrip.rb

@@ -71,12 +71,22 @@ class WebServer < Reel::Server::HTTP
 
   def on_connection(connection)
     while request = connection.request
-      case request
-      when Reel::Request
-        route_request connection, request
-      when Reel::WebSocket
+      if request.websocket?
         info "Received a WebSocket connection"
-        route_websocket request
+
+        # We're going to hand off this connection to another actor (Writer/Reader)
+        # However, initially Reel::Connections are "attached" to the
+        # Reel::Server::HTTP actor, meaning that the server manages the connection
+        # lifecycle (e.g. error handling) for us.
+        #
+        # If we want to hand this connection off to another actor, we first
+        # need to detach it from the Reel::Server (in this case, Reel::Server::HTTP)
+        connection.detach
+
+        route_websocket request.websocket
+        return
+      else
+        route_request connection, request
       end
     end
   end

data/lib/reel.rb

@@ -14,6 +14,7 @@ require 'reel/response'
 require 'reel/server'
 require 'reel/server/http'
 require 'reel/server/https'
+require 'reel/server/unix' unless defined? JRUBY_VERSION
 
 require 'reel/websocket'
 require 'reel/stream'

data/lib/reel/connection.rb

@@ -56,7 +56,7 @@ module Reel
 
       req = @parser.current_request
       @request_fsm.transition :headers
-      @keepalive = false if req[CONNECTION] == CLOSE || req.version == HTTP_VERSION_1_0
+      @keepalive = false if req.nil? || req[CONNECTION] == CLOSE || req.version == HTTP_VERSION_1_0
       @current_request = req
 
       req
@@ -120,10 +120,12 @@ module Reel
         @parser.reset
         @request_fsm.transition :closed
       end
-    rescue IOError, Errno::ECONNRESET, Errno::EPIPE, RequestError
+    rescue IOError, SystemCallError, RequestError
       # The client disconnected early, or there is no request
       @keepalive = false
       @request_fsm.transition :closed
+      @parser.reset
+      @current_request = nil
     end
 
     # Close the connection

data/lib/reel/request.rb

@@ -112,8 +112,8 @@ module Reel
     # the underlying connection
     def websocket
       @websocket ||= begin
-        raise StateError, "can't upgrade this request to a websocket" unless websocket?
-        WebSocket.new(@request_info, @connection.hijack_socket)
+        raise StateError, "can't upgrade this request to a websocket" unless websocket?  
+        WebSocket.new(self, @connection)
       end
     end
 

data/lib/reel/request/body.rb

@@ -29,6 +29,10 @@ module Reel
         end
       end
 
+      def empty?
+        to_str.empty?
+      end
+
       # Eagerly consume the entire body as a string
       def to_str
         return @contents if @contents

data/lib/reel/request/info.rb

@@ -1,13 +1,18 @@
 module Reel
   class Request
     class Info
+
+      CASE_INSENSITVE_HASH = Hash.new do |hash, key|
+        hash[hash.keys.find {|k| k =~ /#{key}/i}] if key
+      end
+
       attr_reader :http_method, :url, :http_version, :headers
 
       def initialize(http_method, url, http_version, headers)
         @http_method  = http_method
         @url          = url
         @http_version = http_version
-        @headers      = headers
+        @headers      = CASE_INSENSITVE_HASH.merge headers
       end
 
       UPGRADE   = 'Upgrade'.freeze
@@ -18,4 +23,4 @@ module Reel
       end
     end
   end
-end
+end

data/lib/reel/request/parser.rb

@@ -43,7 +43,11 @@ module Reel
 
       def readpartial(size = @buffer_size)
         bytes = @socket.readpartial(size)
-        @parser << bytes
+        begin
+          @parser << bytes
+        rescue ArgumentError
+          raise Errno::EPIPE
+        end
       end
 
       #

data/lib/reel/response.rb

@@ -7,8 +7,8 @@ module Reel
     CHUNKED            = 'chunked'.freeze
 
     # Use status code tables from the HTTP gem
-    STATUS_CODES          = HTTP::Response::STATUS_CODES
-    SYMBOL_TO_STATUS_CODE = HTTP::Response::SYMBOL_TO_STATUS_CODE
+    STATUS_CODES          = HTTP::Response::Status::REASONS
+    SYMBOL_TO_STATUS_CODE = Hash[STATUS_CODES.map { |k, v| [v.downcase.gsub(/\s|-/, '_').to_sym, k] }].freeze
 
     attr_reader   :status # Status has a special setter to coerce symbol names
     attr_accessor :reason # Reason can be set explicitly if desired

data/lib/reel/response/writer.rb

@@ -12,7 +12,7 @@ module Reel
         chunk_header = chunk.bytesize.to_s(16)
         @socket << chunk_header + CRLF
         @socket << chunk + CRLF
-      rescue IOError, Errno::EPIPE, Errno::ECONNRESET => ex
+      rescue IOError, SystemCallError => ex
         raise Reel::SocketError, ex.to_s
       end
 

data/lib/reel/server.rb

@@ -2,14 +2,14 @@ module Reel
   # Base class for Reel servers.
   #
   # This class is a Celluloid::IO actor which provides a barebones server
-  # which does not open a socket itself, it just begin handling connections once
-  # initialized with a specific kind of protocol-based server.
+  # which does not open a socket itself, it just begin handling connections
+  # once initialized with a specific kind of protocol-based server.
 
   # For specific protocol support, use:
 
   # Reel::Server::HTTP
   # Reel::Server::HTTPS
-  # Coming soon: Reel::Server::UNIX
+  # Reel::Server::UNIX ( not on jRuby yet )
 
   class Server
     include Celluloid::IO
@@ -25,6 +25,15 @@ module Reel
       @callback = callback
       @server   = server
 
+      @options[:rescue] ||= []
+      @options[:rescue] += [
+        Errno::ECONNRESET,
+        Errno::EPIPE,
+        Errno::EINPROGRESS,
+        Errno::ETIMEDOUT,
+        Errno::EHOSTUNREACH
+      ]
+
       @server.listen(options.fetch(:backlog, DEFAULT_BACKLOG))
 
       async.run
@@ -35,13 +44,15 @@ module Reel
     end
 
     def run
-      loop { async.handle_connection @server.accept }
-    end
-
-    def optimize(socket)
-      if socket.is_a? TCPSocket
-        socket.setsockopt(Socket::IPPROTO_TCP, :TCP_NODELAY, 1)
-      end
+      loop {
+        begin
+          socket = @server.accept
+        rescue *@options[:rescue] => ex
+          Logger.warn "Error accepting socket: #{ex.class}: #{ex.to_s}"
+          next
+        end
+        async.handle_connection socket
+      }
     end
 
     def handle_connection(socket)

data/lib/reel/server/http.rb

@@ -10,7 +10,7 @@ module Reel
       #
       # @return [Reel::Server::HTTP] Reel HTTP server actor
       def initialize(host, port, options={}, &callback)
-        optimize server = Celluloid::IO::TCPServer.new(host, port)
+        server = Celluloid::IO::TCPServer.new(host, port)
         options.merge!(host: host, port: port)
         super(server, options, &callback)
       end

data/lib/reel/server/https.rb

@@ -27,37 +27,25 @@ module Reel
 
         # if verify_mode isn't explicitly set, verify peers if we've
         # been provided CA information that would enable us to do so
-        ssl_context.verify_mode = case
-        when options.include?(:verify_mode)
+        ssl_context.verify_mode = if options.include?(:verify_mode)
           options[:verify_mode]
-        when options.include?(:ca_file)
+        elsif options.include?(:ca_file)
           OpenSSL::SSL::VERIFY_PEER
-        when options.include?(:ca_path)
+        elsif options.include?(:ca_path)
           OpenSSL::SSL::VERIFY_PEER
         else
           OpenSSL::SSL::VERIFY_NONE
         end
 
-        optimize @tcpserver = Celluloid::IO::TCPServer.new(host, port)
+        @tcpserver = Celluloid::IO::TCPServer.new(host, port)
 
         server = Celluloid::IO::SSLServer.new(@tcpserver, ssl_context)
         options.merge!(host: host, port: port)
 
+        options[:rescue] = [ OpenSSL::SSL::SSLError ]
+        
         super(server, options, &callback)
       end
-
-      def run
-        loop do
-          begin
-            socket = @server.accept
-          rescue OpenSSL::SSL::SSLError => ex
-            Logger.warn "Error accepting SSLSocket: #{ex.class}: #{ex.to_s}"
-            retry
-          end
-
-          async.handle_connection socket
-        end
-      end
     end
   end
 end

data/lib/reel/server/unix.rb

@@ -0,0 +1,18 @@
+module Reel
+  class Server
+    class UNIX < Server
+
+      # Create a new Reel HTTPS server
+      #
+      # @option options [String] socket path to bind to
+      # @option options [Fixnum] backlog of requests to accept
+      #
+      # @return [Reel::Server::UNIX] Reel UNIX server actor
+      def initialize(socket_path, options={}, &callback)
+        server = Celluloid::IO::UNIXServer.new(socket_path)
+        options[:socket_path] = socket_path
+        super(server, options, &callback)
+      end
+    end
+  end
+end

data/lib/reel/spy.rb

@@ -6,6 +6,7 @@ module Reel
     extend Forwardable
 
     def_delegators :@socket, :closed?
+    def_delegators :@socket, :addr, :peeraddr, :setsockopt, :getsockname
 
     def initialize(socket, logger = STDOUT)
       @socket, @logger = socket, logger
@@ -68,4 +69,4 @@ module Reel
       def gold(str);  colorize(33, str); end
     end
   end
-end
+end

data/lib/reel/stream.rb

@@ -64,8 +64,8 @@ module Reel
   class ChunkStream < Stream
     def write(chunk)
       chunk_header = chunk.bytesize.to_s(16)
-      write chunk_header + Response::Writer::CRLF
-      write chunk + Response::Writer::CRLF
+      super chunk_header + Response::Writer::CRLF
+      super chunk + Response::Writer::CRLF
       self
     end
     alias :<< :write