falcon 0.15.2 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 682a4983771c1015ffd59ff7d241109f598fadfed95db19bfb418e9149d9e4a4
-  data.tar.gz: '081b506a5324694090bfb87020711761b732aff8f860d1dbe4f606a0f405d157'
+  metadata.gz: bf2ce761fe961a8a5a8e6427007be3bbe882ada827c366c89a6c1f6b20803538
+  data.tar.gz: 3bac595cb42bc4c6eee5b3731979ea812426b309d511046c413caac91e612e16
 SHA512:
-  metadata.gz: 32491eb4950dc9667a63fc075242e778cd2bb5725da0eb9fd52d399585a8072d9ab505ab2de4c02521d1098295816875145a0dca990c04e062eb7ddd09de4dfc
-  data.tar.gz: df2a3b8800e5fa83ad8d27f5a0f6e282f7a140b046e0c552a7b308b5ab4ae47fc3ff20a5894ee14f45189867ab8a823554c806f71733c9639d942e984b3a4180
+  metadata.gz: 55a2923c02b53cee2d0cdbc59213f57a7ebbc254ba668e580f57373d36c664df4c81014c5409ed33eba55fc1893c45d15bc6e7cb174b354d0163938043fdf8c2
+  data.tar.gz: 101e5db3f05438da0f1a6e9792dab8ada074bbbd98b7688049ae2bc97c790df8ea7e6a3f7f10d7194cae772c14d2cb2aa8111cf7b5f77b15dd51c18745f40820

data/.travis.yml

@@ -1,6 +1,14 @@
 language: ruby
+sudo: required
+dist: xenial
 cache: bundler
 
+addons:
+  apt:
+    packages:
+    - wrk
+    - apache2-utils
+
 before_script:
   - gem update --system
   - gem install bundler
@@ -10,6 +18,7 @@ matrix:
     - rvm: 2.3
     - rvm: 2.4
     - rvm: 2.5
+    - rvm: 2.6
     - rvm: jruby-head
       env: JRUBY_OPTS="--debug -X+O"
     - rvm: ruby-head

data/README.md

@@ -28,7 +28,13 @@ Or install it yourself as:
 
 ## Usage
 
-You can run `falcon` directly, and it will load the `config.ru` and start serving on port 8080.
+You can run `falcon serve` directly, and it will load the `config.ru` and start serving on port 9292.
+
+### WebSockets
+
+Falcon supports `rack.hijack` for HTTP/1.x connections. You can thus use [async-websocket] in any controller layer to serve WebSocket connections.
+
+[async-websocket]: https://github.com/socketry/async-websocket
 
 ### Integration with Guard
 

data/examples/sinatra/Gemfile.lock

@@ -1,39 +1,42 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    async (1.2.2)
-      nio4r
+    async (1.9.1)
+      nio4r (~> 2.3)
       timers (~> 4.1)
-    async-container (0.2.2)
+    async-container (0.5.0)
       async (~> 1.0)
-    async-http (0.6.0)
-      async (~> 1.1)
-      async-io (~> 1.0)
-    async-io (1.3.0)
-      async (~> 1.0)
-    falcon (0.6.1)
-      async-container (~> 0.1)
-      async-http (~> 0.3)
-      async-io (~> 1.1)
+      async-io (~> 1.4)
+    async-http (0.24.3)
+      async (~> 1.6)
+      async-io (~> 1.12)
+      http-2 (~> 0.9.0)
+    async-io (1.12.1)
+      async (~> 1.3)
+    falcon (0.15.2)
+      async-container (~> 0.5.0)
+      async-http (~> 0.24.0)
+      async-io (~> 1.9)
       rack (>= 1.0)
       samovar (~> 1.3)
     hitimes (1.2.6)
+    http-2 (0.9.1)
     mapping (1.1.1)
     mustermann (1.0.2)
-    nio4r (2.2.0)
-    rack (2.0.4)
-    rack-protection (2.0.1)
+    nio4r (2.3.1)
+    rack (2.0.5)
+    rack-protection (2.0.3)
       rack
     rainbow (2.2.2)
       rake
-    rake (12.3.0)
+    rake (12.3.1)
     samovar (1.8.0)
       mapping (~> 1.0)
       rainbow (~> 2.0)
-    sinatra (2.0.1)
+    sinatra (2.0.3)
       mustermann (~> 1.0)
       rack (~> 2.0)
-      rack-protection (= 2.0.1)
+      rack-protection (= 2.0.3)
       tilt (~> 2.0)
     tilt (2.0.8)
     timers (4.1.2)

data/falcon.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
 	spec.require_paths = ["lib"]
 
 	spec.add_dependency("async-io", "~> 1.9")
-	spec.add_dependency("async-http", "~> 0.24.0")
+	spec.add_dependency("async-http", "~> 0.27.0")
 	spec.add_dependency("async-container", "~> 0.5.0")
 	
 	spec.add_dependency("rack", ">= 1.0")
@@ -25,6 +25,7 @@ Gem::Specification.new do |spec|
 	spec.add_dependency('samovar', "~> 1.3")
 	
 	spec.add_development_dependency "async-rspec", "~> 1.2"
+	spec.add_development_dependency "async-websocket"
 	
 	spec.add_development_dependency "bundler", "~> 1.3"
 	spec.add_development_dependency "rspec", "~> 3.6"

data/lib/falcon/adapters/input.rb

@@ -19,36 +19,50 @@
 # THE SOFTWARE.
 
 require 'async/http/body'
+require 'async/http/body/rewindable'
 
 module Falcon
 	module Adapters
+		# The input stream is an IO-like object which contains the raw HTTP POST data. When applicable, its external encoding must be “ASCII-8BIT” and it must be opened in binary mode, for Ruby 1.9 compatibility. The input stream must respond to gets, each, read and rewind.
 		class Input
 			def initialize(body)
 				@body = body
-				@chunks = []
 				
-				@index = 0
+				# The current buffer, which is extended by calling `#fill_buffer`.
 				@buffer = Async::IO::BinaryString.new
 				@finished = @body.nil?
 			end
 			
+			attr :body
+			
+			# each must be called without arguments and only yield Strings.
 			def each(&block)
 				return to_enum unless block_given?
 				
-				while chunk = read_next
+				while chunk = gets
 					yield chunk
 				end
-				
-				@closed = true
 			end
 			
+			# rewind must be called without arguments. It rewinds the input stream back to the beginning. It must not raise Errno::ESPIPE: that is, it may not be a pipe or a socket. Therefore, handler developers must buffer the input data into some rewindable object if the underlying input stream is not rewindable.
 			def rewind
-				@index = 0
-				@finished = false
-				@buffer.clear
+				if @body
+					# If the body is not rewindable, this will fail.
+					@body.rewind
+					@buffer.clear
+					@finished = false
+				end
+			end
+			
+			def respond_to?(name, *)
+				if name == :rewind
+					@body.respond_to?(:rewind)
+				else
+					super
+				end
 			end
 			
-			# Read some data from the underlying body. Similar to `IO#read`.
+			# read behaves like IO#read. Its signature is read([length, [buffer]]). If given, length must be a non-negative Integer (>= 0) or nil, and buffer must be a String and may not be nil. If length is given and not nil, then this method reads at most length bytes from the input stream. If length is not given or nil, then this method reads all data until EOF. When EOF is reached, this method returns nil if length is given and not nil, or “” if length is not given or is nil. If buffer is given, then the read data will be placed into buffer instead of a newly created String object.
 			# @param length [Integer] the amount of data to read
 			# @param buffer [String] the buffer which will receive the data
 			# @return a buffer containing the data
@@ -88,10 +102,19 @@ module Falcon
 				@finished and @buffer.empty?
 			end
 			
+			# gets must be called without arguments and return a string, or nil on EOF.
+			# @return [String, nil] The next chunk from the body.
 			def gets
-				read
+				if @buffer.empty?
+					return read_next
+				else
+					buffer = @buffer.dup
+					@buffer.clear
+					return buffer
+				end
 			end
 			
+			# close must never be called on the input stream. huh?
 			def close
 				@body.finish
 			end
@@ -101,21 +124,12 @@ module Falcon
 			def read_next
 				return nil if @finished
 				
-				chunk = nil
-				
-				if @index < @chunks.count
-					chunk = @chunks[@index]
-					@index += 1
+				if chunk = @body.read
+					return chunk
 				else
-					if chunk = @body.read
-						@chunks << chunk
-						@index += 1
-					end
+					@finished = true
+					return nil
 				end
-				
-				@finished = true if chunk.nil?
-				
-				return chunk
 			end
 			
 			def fill_buffer(length)

data/lib/falcon/adapters/output.rb

@@ -0,0 +1,66 @@
+# Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require 'async/http/body/readable'
+require 'async/http/body/file'
+
+module Falcon
+	module Adapters
+		class Output < Async::HTTP::Body::Readable
+			CONTENT_LENGTH = 'content-length'.freeze
+			
+			# Wraps an array into a buffered body.
+			def self.wrap(headers, body)
+				if body.is_a?(Async::HTTP::Body::Readable)
+					return body
+				# This needs more testing:
+				elsif body.respond_to?(:to_path)
+					return Async::HTTP::Body::File.open(body.to_path)
+				else
+					return self.new(headers, body)
+				end
+			end
+			
+			def initialize(headers, body)
+				# We don't trust the user to provide the right length to the transport.
+				@length = headers.delete(CONTENT_LENGTH)
+				
+				@body = body
+				@chunks = body.to_enum(:each)
+			end
+			
+			attr :length
+			
+			def empty?
+				@length == 0
+			end
+			
+			def read
+				@chunks.next
+			rescue StopIteration
+				nil
+			end
+			
+			def inspect
+				"\#<#{self.class} length=#{@length.inspect} body=#{@body.class}>"
+			end
+		end
+	end
+end

data/lib/falcon/adapters/rack.rb

@@ -19,8 +19,8 @@
 # THE SOFTWARE.
 
 require_relative 'input'
+require_relative 'response'
 
-require 'async/http/body/buffered'
 require 'async/logger'
 
 module Falcon
@@ -31,7 +31,7 @@ module Falcon
 				@logger = logger
 			end
 			
-			def call(request, peer: nil, address: nil)
+			def call(request)
 				request_path, query_string = request.path.split('?', 2)
 				server_name, server_port = (request.authority || '').split(':', 2)
 				
@@ -78,27 +78,36 @@ module Falcon
 					env["HTTP_#{key.upcase.tr('-', '_')}"] = value
 				end
 				
-				if peer
+				if remote_address = request.remote_address
+					env['REMOTE_ADDR'] = remote_address.ip_address if remote_address.ip?
+				end
+				
+				if request.hijack?
 					env['rack.hijack?'] = true
-					env['rack.hijack'] = lambda do
-						env['rack.hijack_io'] = peer
-					end
 					
-					if remote_address = peer.remote_address
-						env['REMOTE_ADDR'] = remote_address.ip_address if remote_address.ip?
+					env['rack.hijack'] = lambda do
+						env['rack.hijack_io'] = request.hijack
 					end
+				else
+					env['rack.hijack?'] = false
 				end
 				
 				status, headers, body = @app.call(env)
 				
+				# if hijack = headers.delete('rack.hijack')
+				# 	body = Async::HTTP::Body::Writable.new
+				# 
+				# 	Task.current.async do
+				# 		hijack.call(body)
+				# 	end
+				# 	return nil
+				# end
+				
 				if env['rack.hijack_io']
-					throw :hijack
-				else
-					# We normalize headers to be lower case.
-					headers = headers.map{|key, value| [key.downcase, value]}.to_h
-					
-					return Async::HTTP::Response[status, headers, Async::HTTP::Body::Buffered.wrap(body)]
+					return nil
 				end
+				
+				return Response.new(status, headers, body)
 			rescue => exception
 				@logger.error "#{exception.class}: #{exception.message}\n\t#{$!.backtrace.join("\n\t")}"
 				

data/lib/falcon/adapters/response.rb

@@ -0,0 +1,34 @@
+# Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require_relative 'output'
+
+module Falcon
+	module Adapters
+		class Response < Async::HTTP::Response
+			def initialize(status, headers, body)
+				# We normalize headers to be lower case:
+				headers = headers.map{|key, value| [key.downcase, value]}.to_h
+				
+				super(nil, status, nil, headers, Output.wrap(headers, body))
+			end
+		end
+	end
+end

data/lib/falcon/adapters/rewindable.rb

@@ -0,0 +1,63 @@
+# Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require 'async/http/body/rewindable'
+
+module Falcon
+	module Adapters
+		# Content type driven input buffering.
+		class Rewindable < Async::HTTP::Middleware
+			BUFFERED_MEDIA_TYPES = %r{
+				application/x-www-form-urlencoded|
+				multipart/form-data|
+				multipart/related|
+				multipart/mixed
+			}x
+			
+			POST = 'POST'.freeze
+			
+			def initialize(app)
+				super(app)
+			end
+			
+			def needs_rewind?(request)
+				content_type = request.headers['content-type']
+				
+				if request.method == POST and content_type.nil?
+					return true
+				end
+				
+				if BUFFERED_MEDIA_TYPES =~ content_type
+					return true
+				end
+				
+				return false
+			end
+			
+			def call(request)
+				if body = request.body and needs_rewind?(request)
+					request.body = Async::HTTP::Body::Rewindable.new(body)
+				end
+				
+				response = super
+			end
+		end
+	end
+end

data/lib/falcon/command/serve.rb

@@ -43,7 +43,7 @@ module Falcon
 				
 				option '-b/--bind <address>', "Bind to the given hostname/address", default: "tcp://localhost:9292"
 				
-				option '--forked | --threaded', "Select a specific concurrency model", key: :container, default: :threaded
+				option '--forked | --threaded', "Select a specific concurrency model", key: :container, default: :forked
 			end
 			
 			def container_class
@@ -60,10 +60,14 @@ module Falcon
 			def load_app(verbose)
 				app, options = Rack::Builder.parse_file(@options[:config])
 				
-				# We adapt the rack app to Async::HTTP::Middleware
+				# We adapt the rack app to `Async::HTTP::Middleware`:
 				app = Adapters::Rack.new(app)
 				
-				app =  Async::HTTP::ContentEncoding.new(app)
+				# We buffer the input body but only for specific kinds of requests:
+				app = Adapters::Rewindable.new(app)
+				
+				# We compress response bodies according to what the client expects:
+				app = Async::HTTP::ContentEncoding.new(app)
 				
 				if verbose
 					app = Verbose.new(app)

data/lib/falcon/proxy.rb

@@ -22,7 +22,7 @@ require 'async/http/client'
 
 module Falcon
 	module BadRequest
-		def self.call(request, *)
+		def self.call(request)
 			return Async::HTTP::Response[400, {}, []]
 		end
 		
@@ -82,11 +82,11 @@ module Falcon
 			headers.slice!(HOP_HEADERS)
 		end
 		
-		def call(request, peer: nil, **options)
+		def call(request)
 			if endpoint = lookup(request)
 				@count += 1
 				
-				if peer and address = peer.remote_address and address.ip?
+				if address = request.remote_address
 					request.headers.add(X_FORWARDED_FOR, address.ip_address)
 				end
 				

data/lib/falcon/server.rb

@@ -21,16 +21,8 @@
 require 'async/http/server'
 require 'async/http/content_encoding'
 
+require_relative 'adapters/rewindable'
+
 module Falcon
-	class Server < Async::HTTP::Server
-		def initialize(app, *args)
-			super(*args)
-			
-			@app = app
-		end
-		
-		def handle_request(request, peer, address)
-			@app.call(request, peer: peer, address: address)
-		end
-	end
+	Server = Async::HTTP::Server
 end

data/lib/falcon/verbose.rb

@@ -29,17 +29,18 @@ module Falcon
 			@logger = logger
 		end
 		
-		def annotate(request, peer: nil, address: nil)
+		def annotate(request)
 			task = Async::Task.current
+			address = request.remote_address
 			
 			@logger.debug(request.authority) {"#{request.method} #{request.path} #{request.version} from #{address.inspect}"}
-			@logger.debug(request.authority) {request.headers.inspect}
+			# @logger.debug(request.authority) {request.headers.inspect}
 			
 			task.annotate("#{request.method} #{request.path} from #{address.inspect}")
 		end
 		
-		def call(request, **options)
-			annotate(request, **options)
+		def call(request)
+			annotate(request)
 			
 			statistics = Async::HTTP::Statistics.start
 			

data/lib/falcon/version.rb

@@ -19,5 +19,5 @@
 # THE SOFTWARE.
 
 module Falcon
-	VERSION = "0.15.2"
+	VERSION = "0.16.0"
 end

data/lib/rack/handler/falcon.rb

@@ -18,7 +18,10 @@ module Rack
 			def self.run(app, **options)
 				endpoint = endpoint_for(**options)
 				
-				server = ::Falcon::Server.new(::Falcon::Adapters::Rack.new(app), endpoint)
+				app = ::Falcon::Adapters::Rack.new(app)
+				app = ::Falcon::Adapters::Rewindable.new(app)
+				
+				server = ::Falcon::Server.new(app, endpoint)
 				
 				Async::Reactor.run do
 					server.run

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: falcon
 version: !ruby/object:Gem::Version
-  version: 0.15.2
+  version: 0.16.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-08 00:00:00.000000000 Z
+date: 2018-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-io
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.24.0
+        version: 0.27.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.24.0
+        version: 0.27.0
 - !ruby/object:Gem::Dependency
   name: async-container
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: async-websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -159,7 +173,10 @@ files:
 - falcon.gemspec
 - lib/falcon.rb
 - lib/falcon/adapters/input.rb
+- lib/falcon/adapters/output.rb
 - lib/falcon/adapters/rack.rb
+- lib/falcon/adapters/response.rb
+- lib/falcon/adapters/rewindable.rb
 - lib/falcon/command.rb
 - lib/falcon/command/serve.rb
 - lib/falcon/hosts.rb