mongrel2 0.23.0 → 0.24.0

data/ChangeLog

@@ -1,8 +1,66 @@
+2012-05-20  Michael Granger  <ged@FaerieMUD.org>
+
+	* .rvm.gems:
+	Comment out amalgalite rvmrc gem until
+	https://github.com/copiousfreetime/amalgalite/pull/22 is fixed
+	[b872e092ed92] [tip]
+
+2012-05-21  Michael Granger  <ged@FaerieMUD.org>
+
+	* Manifest.txt, examples/.env, examples/async-upload.rb,
+	examples/config.rb, lib/mongrel2/config.rb,
+	lib/mongrel2/httprequest.rb, spec/mongrel2/config_spec.rb:
+	Change Config.settings to a Table, small fixups for async upload.
+	[e2384875455d]
+
+	* .tm_properties, data/mongrel2/bootstrap.html, examples/.env,
+	examples/Procfile, examples/async-upload.rb, examples/config.rb,
+	examples/run, lib/mongrel2/exceptions.rb,
+	lib/mongrel2/httprequest.rb, spec/mongrel2/httprequest_spec.rb:
+	Add support for async uploads
+	[0b20bfda9eea]
+
+2012-05-18  Michael Granger  <ged@FaerieMUD.org>
+
+	* .rvm.gems:
+	Bumping Loggability dependency for inheritance bugfix
+	[0c8cef0e6065]
+
+2012-05-17  Michael Granger  <ged@FaerieMUD.org>
+
+	* .hgtags:
+	Added tag v0.23.0 for changeset 644f1ddbfbd1
+	[82d6cd587b0a]
+
+	* .hgsigs:
+	Added signature for changeset 7d768d6e98ab
+	[644f1ddbfbd1] [v0.23.0]
+
+	* History.rdoc, lib/mongrel2.rb:
+	Bump the minor version, update history.
+	[7d768d6e98ab]
+
+	* lib/mongrel2/connection.rb, lib/mongrel2/handler.rb,
+	spec/mongrel2/handler_spec.rb:
+	Add a convenience method to Mongrel2::Handler for fetching its
+	associated config object.
+	[30af037aa0be]
+
+	* bin/m2sh.rb:
+	Fix typos in m2sh.rb's exception handler
+	[b7c5ca68fe74]
+
+2012-05-10  Michael Granger  <ged@FaerieMUD.org>
+
+	* .rvm.gems, Rakefile:
+	Bumping dependency on Loggability to 0.2.
+	[b98ed24dfb83]
+
 2012-05-07  Michael Granger  <ged@FaerieMUD.org>
 
 	* .hgtags:
 	Added tag v0.22.1 for changeset ab969af3bf2c
-	[142eade04d61] [tip]
+	[142eade04d61]
 
 	* .hgsigs:
 	Added signature for changeset c68ca662121f
@@ -40,7 +98,7 @@
 	spec/mongrel2/logging_spec.rb, spec/mongrel2/mixins_spec.rb,
 	spec/mongrel2_spec.rb:
 	Convert to Loggability for logging.
-	[0da53476f796] [github/master]
+	[0da53476f796]
 
 2012-04-25  Michael Granger  <ged@FaerieMUD.org>
 
@@ -261,7 +319,7 @@
 	.database_initialized?, so add a new .without_sql_logging method for
 	temporarily disabling SQL logging, and wrap that around the methods
 	in quesion.
-	[6b62343b4e5a] [github/master@default]
+	[6b62343b4e5a]
 
 	* .rvm.gems, Rakefile:
 	Add simplecov to dev dependencies

data/History.rdoc

@@ -1,3 +1,10 @@
+== v0.24.0 [2012-05-31] Michael Granger <ged@FaerieMUD.org>
+
+- Fix a bug when duping a Mongrel2::Table with immediate objects as values.
+- Change Config.settings to a Table.
+- Add support for Mongrel2 async uploads.
+
+
 == v0.23.0 [2012-05-17] Michael Granger <ged@FaerieMUD.org>
 
 - Add a convenience method to Mongrel2::Handler for fetching its

data/Manifest.txt

@@ -13,7 +13,10 @@ data/mongrel2/css/master.css
 data/mongrel2/js/websock-test.js
 data/mongrel2/mimetypes.sql
 data/mongrel2/websock-test.html
+examples/.env
+examples/Procfile
 examples/README.txt
+examples/async-upload.rb
 examples/config.rb
 examples/helloworld-handler.rb
 examples/request-dumper.rb

data/data/mongrel2/bootstrap.html

@@ -16,6 +16,8 @@
 	<section>
 		<ol>
 			<li><a href="/hello">Hello World</a> (<a href="/source/helloworld-handler.rb">source</a>) </li>
+			<li><a href="/async-upload">Async Upload Demo</a>
+				(<a href="/source/async-upload.rb">source</a>) </li>
 			<li><a href="/dump">Dump Request</a> (<a href="/source/request-dumper.rb">source</a>) </li>
 			<li><a href="/websock-test.html">Web Socket Test</a></li>
 		</ol>
@@ -23,7 +25,7 @@
 
 	<footer>
 		<p>Copyright © 2011-2012 Michael Granger &lt;<a href="mailto:ged@FaerieMUD.org">ged@FaerieMUD.org</a>&gt;.</p>
-		<p><tt>$Id: bootstrap.html,v fea3cd02d23c 2012/03/07 16:07:50 ged $</tt></p>
+		<p><tt>$Id: bootstrap.html,v 0b20bfda9eea 2012/05/22 00:34:22 ged $</tt></p>
 	</footer>
 </body>
 </html>

data/examples/.env

@@ -0,0 +1 @@
+RUBYOPT=-I../lib

data/examples/Procfile

@@ -0,0 +1,6 @@
+# Foreman Procfile
+mongrel2: ruby ../bin/m2sh.rb -c examples.sqlite start
+helloworld: ruby helloworld-handler.rb
+async_upload: ruby async-upload.rb
+request_dumper: ruby request-dumper.rb
+

data/examples/async-upload.rb

@@ -0,0 +1,110 @@
+#!/usr/bin/env ruby
+
+require 'erb'
+require 'loggability'
+require 'mongrel2/config'
+require 'mongrel2/handler'
+
+# A example of how to allow Mongrel2's async uploads.
+class AsyncUploadHandler < Mongrel2::Handler
+
+	### Load up the ERB template from the DATA section on instantiation.
+	def initialize( * )
+		super
+		@template = self.load_template
+	end
+
+
+	### Load the ERB template from this file's DATA section.
+	def load_template
+		raw = IO.read( __FILE__ ).split( /^__END__$/m, 2 ).last
+		return ERB.new( raw, nil, '<%>' )
+	end
+
+
+	### Mongrel2 async upload callback -- allow uploads to proceed.
+	def handle_upload_start( request )
+		self.log.info "Upload started: %s" % [ request.header.x_mongrel2_upload_start ]
+		return nil # Do nothing
+	end
+
+
+	### Mongrel2 async upload callback -- finish the upload.
+	def handle_upload_done( request )
+		self.log.warn "Upload finished: %s (%0.2fK, %s)" %
+			[ request.uploaded_file, request.content_length, request.content_type ]
+
+		response = request.response
+		response.puts "Upload complete: %s" % [ request.uploaded_file ]
+		response.content_type = 'text/plain'
+
+		return response
+	rescue Mongrel2::UploadError => err
+		self.log.error "%s when finishing an upload: %s" % [ err.class, err.message ]
+		self.log.debug { err.backtrace.join("\n\t") }
+
+		finish_with HTTP::BAD_REQUEST, 'malformed upload headers'
+	end
+
+
+	### Regular request -- show the upload form.
+	def handle( request )
+		# If it's the 'upload started' notification, use that handler method
+		if request.upload_started?
+			return self.handle_upload_start( request )
+
+		# If it's a finished upload, use that handler method
+		elsif request.upload_done?
+			return self.handle_upload_done( request )
+
+		else
+			response = request.response
+
+			settings = Mongrel2::Config.settings
+
+			response.headers.content_type = 'text/html'
+			response.puts( @template.result(binding()) )
+
+			return response
+		end
+	end
+
+end # class HelloWorldHandler
+
+configdb = ARGV.shift || 'examples.sqlite'
+
+# Log to a file instead of STDERR for a bit more speed.
+# Loggability.output_to( 'hello-world.log' )
+Loggability.level = :debug
+
+# Point to the config database, which will cause the handler to use
+# its ID to look up its own socket info.
+Mongrel2::Config.configure( configdb: configdb )
+AsyncUploadHandler.run( 'async-upload' )
+
+__END__
+<!DOCTYPE html>
+<html lang="en">
+<head>
+	<title>Ruby-Mongrel2 Async Upload Demo</title>
+	<meta charset="utf-8">
+</head>
+
+<body>
+
+	<h1>Ruby-Mongrel2 Async Upload Demo</h1>
+
+	<form action="<%= request.headers.uri %>" method="post" accept-charset="utf-8"
+		enctype="multipart/form-data">
+
+		<label for="file">Choose a file</label>
+		<input type="file" name="uploaded-file" value="">
+
+		<p>Upload will be async if it's larger than:
+			<%= settings['limits.content_length'] %> bytes.</p>
+
+		<p><input type="submit" value="Upload &rarr;"></p>
+	</form>
+
+</body>
+</html>

data/examples/config.rb

@@ -1,10 +1,17 @@
 #!/usr/bin/env ruby
 
+require 'pathname'
+require 'tmpdir'
+
 # The Mongrel config used by the examples. Load it with:
 #
 #   m2sh.rb -c examples.sqlite load examples/config.rb
 #
 
+examples_dir = Pathname( __FILE__ ).dirname
+basedir = examples_dir.parent
+upload_dir = Pathname( Dir.tmpdir )
+
 # samples server
 server 'examples' do
 
@@ -14,7 +21,7 @@ server 'examples' do
 	access_log   '/logs/access.log'
 	error_log    '/logs/error.log'
 	chroot       '/var/mongrel2'
-	pid_file     '/run/mongrel2.pid'
+	pid_file     '/var/run/mongrel2.pid'
 
 	bind_addr    '127.0.0.1'
 	port         8113
@@ -22,12 +29,13 @@ server 'examples' do
 	# your main host
 	host 'localhost' do
 
-		route '/', directory( 'data/mongrel2/', 'bootstrap.html', 'text/html' )
-		route '/source', directory( 'examples/', 'README.txt', 'text/plain' )
+		route '/', directory( "#{basedir}/data/mongrel2/", 'bootstrap.html', 'text/html' )
+		route '/source', directory( "#{basedir}/examples/", 'README.txt', 'text/plain' )
 
 		# Handlers
 		dumper = handler( 'tcp://127.0.0.1:9997', 'request-dumper', protocol: 'tnetstring' )
 		route '/hello', handler( 'tcp://127.0.0.1:9999',  'helloworld-handler' )
+		route '/async-upload', handler( 'tcp://127.0.0.1:9950',  'async-upload' )
 		route '/dump', dumper
 		route '/ws', handler( 'tcp://127.0.0.1:9995', 'ws-echo' )
 		route '@js', dumper
@@ -38,4 +46,11 @@ server 'examples' do
 end
 
 setting "zeromq.threads", 1
+setting "limits.content_length", 4096
+setting "upload.temp_store", upload_dir + 'mongrel2.upload.XXXXXX'
+
+mkdir_p 'var/run'
+mkdir_p 'logs'
+mkdir_p '/tmp/mongrel2-uploads'
 
+puts "Upload dir is: #{upload_dir}"

data/examples/run

@@ -1,17 +1,22 @@
 #!/bin/sh
 
-examplesdir=$(dirname $0)
-
-echo "Creating the config database..."
-ruby -rubygems -Ilib $examplesdir/config.rb
+if [ "$(type foreman 2>/dev/null)" == "" ]; then
+	echo "You need Foreman installed to start the examples (gem install foreman)"
+	exit 1
+fi
 
-echo "Starting Mongrel2..."
-m2sh start -db examples.sqlite -host localhost &
+examplesdir=$(dirname $0)
 
-echo "Starting the 'helloworld' handler..."
-ruby -rubygems -Ilib $examplesdir/helloworld-handler.rb &
+echo "Creating/updating the config database..."
+ruby -rubygems -I${examplesdir}/../lib $examplesdir/../bin/m2sh.rb \
+	-c examples.sqlite load $examplesdir/config.rb
 
-echo "Starting the request dumper..."
-ruby -rubygems -Ilib $examplesdir/request-dumper.rb &
+if [ $? != 0 ]; then
+	echo "Oops, problems installing the config DB. Aborting."
+	exit 1
+fi
 
 echo "Okay, now point a browser to http://localhost:8113/."
+cd $examplesdir
+foreman start
+

data/lib/mongrel2.rb

@@ -20,10 +20,10 @@ module Mongrel2
 	abort "\n\n>>> Mongrel2 requires Ruby 1.9.2 or later. <<<\n\n" if RUBY_VERSION < '1.9.2'
 
 	# Library version constant
-	VERSION = '0.23.0'
+	VERSION = '0.24.0'
 
 	# Version-control revision constant
-	REVISION = %q$Revision: 7d768d6e98ab $
+	REVISION = %q$Revision: 3ed1175a2f9e $
 
 
 	require 'mongrel2/constants'

data/lib/mongrel2/config.rb

@@ -27,6 +27,7 @@ end
 
 
 require 'mongrel2' unless defined?( Mongrel2 )
+require 'mongrel2/table'
 
 module Mongrel2
 
@@ -154,11 +155,7 @@ module Mongrel2
 		### Symbols.
 		def self::settings
 			setting_hash = Mongrel2::Config::Setting.to_hash( :key, :value )
-			setting_hash.keys.each do |k|
-				setting_hash[ k.to_sym ] = setting_hash.delete( k )
-			end
-
-			return setting_hash
+			return Mongrel2::Table.new( setting_hash )
 		end
 
 

data/lib/mongrel2/exceptions.rb

@@ -53,6 +53,10 @@ module Mongrel2
 
 	end # class ControlError
 
+	# An exception type raised by Mongrel2::HTTPRequest if an async upload request is
+	# received, but has different Mongrel2 upload headers.
+	class UploadError < Mongrel2::Exception; end
+
 end # module Mongrel2
 
 

data/lib/mongrel2/httprequest.rb

@@ -60,6 +60,15 @@ class Mongrel2::HTTPRequest < Mongrel2::Request
 	end
 
 
+	### Returns the size of the request's entity body, as specified by its
+	### 'Content-Length' header. Note that this may or may not correspond to
+	### the actual byte size of the body.
+	def content_length
+		return 0 unless self.header.member?( :content_length )
+		return Integer( self.header.content_length )
+	end
+
+
 	### Fetch the mimetype of the request's content, as set in its header.
 	def content_type
 		return self.headers.content_type
@@ -91,6 +100,48 @@ class Mongrel2::HTTPRequest < Mongrel2::Request
 	end
 
 
+	#
+	# :section: Async Upload Support
+	# See http://mongrel2.org/static/book-finalch6.html#x8-810005.5 for details.
+	#
+
+	### The Pathname, relative to Mongrel2's chroot path, of the uploaded entity body.
+	def uploaded_file
+		raise Mongrel2::UploadError, "invalid upload: upload headers don't match" unless
+			self.upload_headers_match?
+		return Pathname( self.headers.x_mongrel2_upload_done )
+	end
+
+
+	### Returns +true+ if this request is an 'asynchronous upload started' notification.
+	def upload_started?
+		return self.headers.member?( :x_mongrel2_upload_start ) &&
+		       !self.headers.member?( :x_mongrel2_upload_done )
+	end
+
+
+	### Returns +true+ if this request is an 'asynchronous upload done' notification.
+	def upload_done?
+		return self.headers.member?( :x_mongrel2_upload_start ) &&
+		       self.headers.member?( :x_mongrel2_upload_done )
+	end
+
+
+	### Returns +true+ if this request is an 'asynchronous upload done' notification
+	### and the two headers match (trivial guard against forgery)
+	def upload_headers_match?
+		return self.upload_done? &&
+		       self.headers.x_mongrel2_upload_start == self.headers.x_mongrel2_upload_done
+	end
+
+
+	### Returns true if this request is an asynchronous upload, and the filename of the
+	### finished request matches the one from the starting notification.
+	def valid_upload?
+		return self.upload_done? && self.upload_headers_match?
+	end
+
+
 	#########
 	protected
 	#########

data/lib/mongrel2/table.rb

@@ -57,28 +57,8 @@ class Mongrel2::Table
 
 
 	### Make sure the inner Hash is unique on duplications.
-	def initialize_dup( * ) # :nodoc:
-		@hash = @hash.dup
-		@hash.each do |k, v|
-			if v.is_a?( Array )
-				@hash[ k ] = v.map( &:dup )
-			else
-				@hash[ k ] = v.dup
-			end
-		end
-	end
-
-
-	### Make sure the inner Hash is unique on clones.
-	def initialize_clone( * ) # :nodoc:
-		@hash = @hash.clone
-		@hash.each do |k, v|
-			if v.is_a?( Array )
-				@hash[ k ] = v.map( &:clone )
-			else
-				@hash[ k ] = v.clone
-			end
-		end
+	def initialize_copy( * ) # :nodoc:
+		@hash = deep_copy( @hash )
 	end
 
 
@@ -237,6 +217,30 @@ class Mongrel2::Table
 	end
 
 
+	### Recursively copying the specified +obj+ and return the result.
+	def deep_copy( obj )
+		# Handle mocks during testing
+		return obj if obj.class.name == 'RSpec::Mocks::Mock'
+
+		return case obj
+				when NilClass, Numeric, TrueClass, FalseClass, Symbol
+						obj
+
+				when Array
+						obj.map {|o| deep_copy(o) }
+
+				when Hash
+						newhash = {}
+						obj.each do |k,v|
+								newhash[ deep_copy(k) ] = deep_copy( v )
+						end
+						newhash
+
+				else
+						obj.clone
+				end
+	end
+
 end # class Mongrel2::Table
 
 # vim: set nosta noet ts=4 sw=4:

data/spec/mongrel2/config_spec.rb

@@ -73,7 +73,7 @@ describe Mongrel2::Config do
 		Mongrel2::Config.init_database
 		Mongrel2::Config::Setting.dataset.truncate
 		Mongrel2::Config::Setting.create( key: 'control_port', value: 'ipc://var/run/control.sock' )
-		Mongrel2::Config.settings.should be_a( Hash )
+		Mongrel2::Config.settings.should respond_to( :[] )
 		Mongrel2::Config.settings.should have( 1 ).member
 		Mongrel2::Config.settings[ :control_port ].should == 'ipc://var/run/control.sock'
 	end

data/spec/mongrel2/httprequest_spec.rb

@@ -89,6 +89,7 @@ describe Mongrel2::HTTPRequest do
 
 		before( :each ) do
 			@req.headers.merge!(
+				'Content-length' => '28113',
 				'Content-type' => 'application/x-pdf',
 				'Content-encoding' => 'gzip'
 			)
@@ -112,6 +113,22 @@ describe Mongrel2::HTTPRequest do
 			@req.content_encoding.should == 'identity'
 		end
 
+		it "provides a convenience method for fetching the request's Content-length header" do
+			@req.content_length.should == 28113
+		end
+
+		it "returns 0 as the content_length if the request doesn't have a Content-length header" do
+			@req.headers.delete( :content_length )
+			@req.content_length.should == 0
+		end
+
+		it "raises an exception if the Content-length header contains something other than an integer" do
+			@req.headers.content_length = 'Lots'
+			expect {
+				@req.content_length
+			}.to raise_error( ArgumentError, /invalid value for integer/i )
+		end
+
 		it "provides a convenience method for fetching the requestor's IP address" do
 			@req.headers.merge!(
 				'X-Forwarded-For' => '127.0.0.1'
@@ -126,6 +143,46 @@ describe Mongrel2::HTTPRequest do
 			@req.remote_ip.to_s.should == '127.0.0.1'
 		end
 
+		it "knows if it's an 'async upload started' notification" do
+			@req.headers.x_mongrel2_upload_start = '/tmp/mongrel2.upload.20120503-54578-rs3l2g'
+			@req.should be_upload_started()
+			@req.should_not be_upload_done()
+		end
+
+		it "knows if it's an 'async upload done' notification" do
+			@req.headers.x_mongrel2_upload_start = '/tmp/mongrel2.upload.20120503-54578-rs3l2g'
+			@req.headers.x_mongrel2_upload_done = '/tmp/mongrel2.upload.20120503-54578-rs3l2g'
+			@req.should_not be_upload_started()
+			@req.should be_upload_done()
+			@req.should be_valid_upload()
+		end
+
+		it "knows if it's not a valid 'async upload done' notification" do
+			@req.headers.x_mongrel2_upload_start = '/tmp/mongrel2.upload.20120503-54578-rs3l2g'
+			@req.headers.x_mongrel2_upload_done = '/etc/passwd'
+			@req.should_not be_upload_started()
+			@req.should be_upload_done()
+			@req.should_not be_valid_upload()
+		end
+
+		it "raises an exception if the uploaded file fetched with mismatched headers" do
+			@req.headers.x_mongrel2_upload_start = '/tmp/mongrel2.upload.20120503-54578-rs3l2g'
+			@req.headers.x_mongrel2_upload_done = '/etc/passwd'
+
+			expect {
+				@req.uploaded_file
+			}.to raise_error( Mongrel2::UploadError, /upload headers/i )
+		end
+
+		it "can return a Pathname object for the uploaded file if it's valid" do
+			@req.headers.x_mongrel2_upload_start = '/tmp/mongrel2.upload.20120503-54578-rs3l2g'
+			@req.headers.x_mongrel2_upload_done = '/tmp/mongrel2.upload.20120503-54578-rs3l2g'
+
+			@req.should be_valid_upload()
+			@req.uploaded_file.should be_a( Pathname )
+			@req.uploaded_file.to_s.should == '/tmp/mongrel2.upload.20120503-54578-rs3l2g'
+		end
+
 	end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongrel2
 version: !ruby/object:Gem::Version
-  version: 0.23.0
+  version: 0.24.0
   prerelease: 
 platform: ruby
 authors:
@@ -36,7 +36,7 @@ cert_chain:
   YUhDS0xaZFNLai9SSHVUT3QrZ2JsUmV4OEZBaDhOZUEKY21saFhlNDZwWk5K
   Z1dLYnhaYWg4NWpJang5NWhSOHZPSStOQU01aUg5a09xSzEzRHJ4YWNUS1Bo
   cWo1UGp3RgotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg==
-date: 2012-05-17 00:00:00.000000000 Z
+date: 2012-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -333,7 +333,10 @@ files:
 - data/mongrel2/js/websock-test.js
 - data/mongrel2/mimetypes.sql
 - data/mongrel2/websock-test.html
+- examples/.env
+- examples/Procfile
 - examples/README.txt
+- examples/async-upload.rb
 - examples/config.rb
 - examples/helloworld-handler.rb
 - examples/request-dumper.rb