strelka 0.0.1.pre.265 → 0.0.1.pre.279

data/ChangeLog

@@ -1,5 +1,126 @@
+2012-07-06  Michael Granger  <ged@FaerieMUD.org>
+
+	* .rvm.gems, Rakefile, lib/strelka/app/templating.rb:
+	Set encoding on loaded templates.
+
+	- bump Inversion dependency for encoding support
+	- Use the default_internal encoding or UTF-8 if that isn't set as the
+	encoding of templates loaded by the :templating plugin.
+	[4f7bb0f3a8f7] [tip]
+
+	* Manifest.txt:
+	Add multipart-form support files to the manifest
+	[b3367292cf3f]
+
+	* bin/strelka:
+	Fix the wording of the header from the "start" command in
+	bin/strelka
+	[5d677093466d]
+
+2012-07-03  Michael Granger  <ged@FaerieMUD.org>
+
+	* lib/strelka/paramvalidator.rb, manual/src/starting.page,
+	manual/src/tutorial.page:
+	Documentation/manual updates
+	[75c75043ad29]
+
+2012-07-03  Mahlon E. Smith  <mahlon@martini.nu>
+
+	* manual/src/plugins.page:
+	First round documentation for 'Writing Your Own Strelka Plugin'
+	manual page.
+	[e1c56057be7a]
+
+	* .rvm.gems, Rakefile, manual/src/starting.page:
+	Fix bootstrap missing quote. Update mongrel2 dependency to 0.27.
+	[6ea74939d550]
+
+2012-07-03  Michael Granger  <ged@FaerieMUD.org>
+
+	* bin/strelka:
+	Make the default bin/strelka command "help"
+	[c82aa0ae98c9]
+
+	* README.rdoc:
+	Fix the command-line tool name
+	[b6ae193c24e9]
+
+2012-06-27  Mahlon E. Smith  <mahlon@martini.nu>
+
+	* lib/strelka/mixins.rb, spec/strelka/mixins_spec.rb:
+	Don't deep copy modules/classes.
+	[d6cf8e4ac02f]
+
+2012-06-25  Michael Granger  <ged@FaerieMUD.org>
+
+	* .hgignore, .rvm.gems, .tm_properties, Rakefile, examples/.env,
+	examples/Procfile, examples/apps/upload-demo, examples/config.yml,
+	examples/gen-config.rb, examples/static/examples.html,
+	examples/templates/upload-form.tmpl, examples/templates/upload-
+	success.tmpl, lib/strelka/app.rb, lib/strelka/exceptions.rb,
+	lib/strelka/httprequest.rb, lib/strelka/multipartparser.rb,
+	spec/data/forms/2_images.form, spec/data/forms/singleupload.form,
+	spec/data/forms/testform.form, spec/data/forms/testform_bad.form,
+	spec/data/forms/testform_badheaders.form,
+	spec/data/forms/testform_metadataonly.form,
+	spec/data/forms/testform_msie.form,
+	spec/data/forms/testform_multivalue.form,
+	spec/data/forms/testform_truncated_metadata.form,
+	spec/lib/helpers.rb, spec/strelka/app_spec.rb,
+	spec/strelka/multipartparser_spec.rb:
+	Added support for multipart/form-data entity bodies
+
+	- Add a multipart mime document parser, as well as support for
+	Mongrel2 asynchronous uploads.
+	- Hook up the multipart parser for form data of type 'multipart/form-
+	data'.
+	- Added an example of async upload and multipart/form-data to the
+	examples.
+	- Include the Ruby engine + version in the process name
+	[cfae502bcec1]
+
+	* spec/lib/helpers.rb:
+	Remove extra include from spec helpers
+	[abc12d87868e]
+
+	* .rvm.gems, Rakefile:
+	Bumping Loggability dependency
+	[6039fcf3a3e0]
+
+2012-06-22  Michael Granger  <ged@FaerieMUD.org>
+
+	* lib/strelka/httpresponse/negotiation.rb,
+	spec/strelka/httpresponse/negotiation_spec.rb:
+	Fix the entity body for negotiated responses.
+	[d2c4f8ac4e07]
+
+	* lib/strelka/httpresponse.rb, spec/strelka/httpresponse_spec.rb:
+	Don't append a charset for non text/* content-type headers
+	[4ad96d45bcc2]
+
+2012-06-21  Michael Granger  <ged@FaerieMUD.org>
+
+	* Rakefile:
+	Depend on mongrel2 0.25.0
+	[0f6b09255386]
+
+	* lib/strelka/app/negotiation.rb, lib/strelka/httprequest.rb,
+	lib/strelka/httpresponse.rb,
+	lib/strelka/httpresponse/negotiation.rb,
+	spec/strelka/app/errors_spec.rb,
+	spec/strelka/app/restresources_spec.rb,
+	spec/strelka/app/templating_spec.rb, spec/strelka/app_spec.rb,
+	spec/strelka/httpresponse/negotiation_spec.rb:
+	Mongrel2 stream API fixes
+	[6d267b848e8a]
+
 2012-06-20  Michael Granger  <ged@FaerieMUD.org>
 
+	* lib/strelka/httprequest/session.rb,
+	lib/strelka/httpresponse/session.rb:
+	Remove the session from the request when it's destroyed, too.
+	[e0f2e2a0e4b8]
+
 	* lib/strelka/httprequest/session.rb,
 	lib/strelka/httpresponse/session.rb, lib/strelka/session.rb,
 	lib/strelka/session/default.rb,
@@ -8,7 +129,7 @@
 	spec/strelka/session/default_spec.rb:
 	Fix session expiration for cookie-based persistance
 	* * * Conversion to stream-based Mongrel2 API
-	[7389c2f1e8e3] [tip]
+	[7389c2f1e8e3]
 
 2012-06-20  Mahlon E. Smith  <mahlon@martini.nu>
 

data/Manifest.txt

@@ -16,12 +16,12 @@ contrib/hoetemplate/data/project/templates/layout.tmpl.erb
 contrib/hoetemplate/data/project/templates/top.tmpl.erb
 contrib/hoetemplate/lib/file_name.rb.erb
 contrib/hoetemplate/spec/file_name_spec.rb.erb
-examples/.env
 examples/Procfile
 examples/apps/auth-demo
 examples/apps/auth-demo2
 examples/apps/hello-world
 examples/apps/sessions-demo
+examples/apps/upload-demo
 examples/config.yml
 examples/gen-config.rb
 examples/static/examples.css
@@ -29,6 +29,8 @@ examples/static/examples.html
 examples/templates/auth-form.tmpl
 examples/templates/auth-success.tmpl
 examples/templates/layout.tmpl
+examples/templates/upload-form.tmpl
+examples/templates/upload-success.tmpl
 lib/strelka.rb
 lib/strelka/app.rb
 lib/strelka/app/auth.rb
@@ -57,6 +59,7 @@ lib/strelka/httpresponse.rb
 lib/strelka/httpresponse/negotiation.rb
 lib/strelka/httpresponse/session.rb
 lib/strelka/mixins.rb
+lib/strelka/multipartparser.rb
 lib/strelka/paramvalidator.rb
 lib/strelka/plugins.rb
 lib/strelka/router.rb
@@ -66,6 +69,15 @@ lib/strelka/session.rb
 lib/strelka/session/db.rb
 lib/strelka/session/default.rb
 spec/data/error.tmpl
+spec/data/forms/2_images.form
+spec/data/forms/singleupload.form
+spec/data/forms/testform.form
+spec/data/forms/testform_bad.form
+spec/data/forms/testform_badheaders.form
+spec/data/forms/testform_metadataonly.form
+spec/data/forms/testform_msie.form
+spec/data/forms/testform_multivalue.form
+spec/data/forms/testform_truncated_metadata.form
 spec/data/layout.tmpl
 spec/data/main.tmpl
 spec/lib/constants.rb
@@ -95,6 +107,7 @@ spec/strelka/httpresponse/negotiation_spec.rb
 spec/strelka/httpresponse/session_spec.rb
 spec/strelka/httpresponse_spec.rb
 spec/strelka/mixins_spec.rb
+spec/strelka/multipartparser_spec.rb
 spec/strelka/paramvalidator_spec.rb
 spec/strelka/plugins_spec.rb
 spec/strelka/router/default_spec.rb

data/README.rdoc

@@ -135,7 +135,7 @@ Here's a tentative list of what kinds of stuff we have planned:
 
 You'll be able to package up your applications as Rubygems for easy deployment.
 The Strelka::App class already supports application discovery, but we
-want to hook that up to the 'leash' command line tool so you can install
+want to hook that up to the 'strelka' command line tool so you can install
 and run them with a minimum of manual monkeying around with directories,
 migrations, etc.
 

data/Rakefile

@@ -22,17 +22,17 @@ hoespec = Hoe.spec 'strelka' do
 
 	self.developer 'Michael Granger', 'ged@FaerieMUD.org'
 
-	self.dependency 'trollop',         '~> 1.16'
+	self.dependency 'configurability', '~> 1.2'
+	self.dependency 'foreman',         '~> 0.47'
+	self.dependency 'formvalidator',   '~> 0.1'
 	self.dependency 'highline',        '~> 1.6'
+	self.dependency 'inversion',       '~> 0.11'
+	self.dependency 'loggability',     '~> 0.4'
+	self.dependency 'mongrel2',        '~> 0.28'
+	self.dependency 'pluginfactory',   '~> 1.0'
 	self.dependency 'sysexits',        '~> 1.0'
-	self.dependency 'formvalidator',   '~> 0.1'
-	self.dependency 'inversion',       '~> 0.10'
-	self.dependency 'mongrel2',        '~> 0.25'
+	self.dependency 'trollop',         '~> 1.16'
 	self.dependency 'uuidtools',       '~> 2.1'
-	self.dependency 'configurability', '~> 1.0'
-	self.dependency 'pluginfactory',   '~> 1.0'
-	self.dependency 'loggability',     '~> 0.3'
-	self.dependency 'foreman',         '~> 0.47'
 
 	self.dependency 'hoe-deveiate',    '~> 0.1', :developer
 	self.dependency 'hoe-manualgen',   '~> 0.3', :developer

data/bin/strelka

@@ -199,7 +199,7 @@ class Strelka::CLICommand
 
 	### Run the command with the specified +command+ and +args+.
 	def run( command, *args )
-		command ||= 'shell'
+		command ||= 'help'
 		cmd_method = nil
 
 		# Set the datadir override if it's given
@@ -291,7 +291,7 @@ class Strelka::CLICommand
 
 		header "Starting the %s app%s" % [
 			appname,
-			gemname == '' ? '' : " the #{gemname} gem"
+			gemname == '' ? '' : " from the #{gemname} gem"
 		]
 		fork do
 			self.log.debug "  in the child."

data/examples/Procfile

@@ -4,5 +4,6 @@ helloworld: ../bin/strelka -D . -l warn -c config.yml start hello-world
 auth: ../bin/strelka -D . -l warn -c config.yml start auth-demo
 auth2: ../bin/strelka -D . -l warn -c config.yml start auth-demo2
 sessions: ../bin/strelka -D . -l debug -c config.yml start sessions-demo
+upload: ../bin/strelka -D . -l debug -c config.yml start upload-demo
 # ws: ../bin/strelka -l info -c config.yml start ws-echo
 

data/examples/apps/upload-demo

@@ -0,0 +1,74 @@
+#!/usr/bin/env ruby
+
+require 'strelka'
+
+# An example of a file upload handler.
+class UploadDemo < Strelka::App
+
+	# The route appid that will configure this app if no appid is specified
+	ID = 'upload-demo'
+
+
+	plugins :templating, :routing, :parameters
+
+	default_type 'text/html'
+
+	layout 'templates/layout.tmpl'
+	templates \
+		form: 'templates/upload-form.tmpl',
+		success: 'templates/upload-success.tmpl'
+
+
+	### Show the form for any GET
+	get do |req|
+		return :form
+	end
+
+
+	### Show the upload for POST requests
+	post do |req|
+		req.params.add( :description, :string )
+		req.params.add( :uploadfile ) do |input|
+			if input.respond_to?( :filename ) && input.respond_to?( :content_type )
+				input
+			else
+				nil
+			end
+		end
+
+		unless req.content_type.start_with?( 'multipart/form-data' )
+			self.log.error "Not a multipart/form-data request?!"
+			finish_with HTTP::BAD_REQUEST,
+				"Expecting a mutlipart/form-data request, got: %p" % [ req.content_type ]
+		end
+
+		unless req.params.okay?
+			self.log.error "Parameter validation error: %s" %
+				[ req.params.error_messages.join(', ') ]
+			finish_with HTTP::BAD_REQUEST,
+				"Form errors: %s" % [ req.params.error_messages.join(', ') ]
+		end
+
+		self.log.debug "Successful upload of file %s." % [ req.params[:uploadfile].filename ]
+
+		tmpl = template :success
+		tmpl.upload = req.params[:uploadfile]
+		tmpl.description = req.params[:description]
+
+		return tmpl
+	end
+
+
+	### Override the upload-started notification to allow spooled (asynchronous)
+	### uploads.
+	def handle_async_upload_start( request )
+		self.log.info "Asynchronous upload notice. Spooling entity body to %p" %
+			[ request.headers.x_mongrel_upload_start ]
+		return nil
+	end
+
+end # class UploadDemo
+
+
+# Run the app
+UploadDemo.run if __FILE__ == $0

data/examples/config.yml

@@ -21,7 +21,7 @@ defaultsession:
 
 templates:
   template_paths:
-    - examples/templates
+    - templates
 
 logging:
   strelka: debug (color)

data/examples/gen-config.rb

@@ -22,7 +22,7 @@ server 'examples' do
 	chroot       '/var/mongrel2'
 	pid_file     '/run/mongrel2.pid'
 
-	bind_addr    '127.0.0.1'
+	bind_addr    '0.0.0.0'
 	port         8113
 
 	host 'localhost' do
@@ -34,6 +34,7 @@ server 'examples' do
 		route '/sessions', handler( 'tcp://127.0.0.1:9905', 'sessions-demo' )
 		route '/auth', handler( 'tcp://127.0.0.1:9910', 'auth-demo' )
 		route '/formauth', handler( 'tcp://127.0.0.1:9915', 'auth-demo2' )
+		route '/upload', handler( 'tcp://127.0.0.1:9925', 'upload-demo' )
 		route '/ws', handler( 'tcp://127.0.0.1:9920', 'ws-echo' )
 
 	end
@@ -42,7 +43,10 @@ end
 
 setting "zeromq.threads", 1
 
-mkdir_p 'var'
+setting 'limits.content_length', 8096
+setting 'upload.temp_store', 'var/uploads/mongrel2.upload.XXXXXX'
+
+mkdir_p 'var/uploads'
 mkdir_p 'run'
 mkdir_p 'logs'
 

data/examples/static/examples.html

@@ -25,6 +25,7 @@
 		<li><a href="/sessions">Sessions Demo</a> - Demo of the <code>:sessions</code> plugin.</li>
 		<li><a href="/auth">Auth Demo</a> - Demo of the <code>:auth</code> plugin.</li>
 		<li><a href="/formauth">Form Auth Demo</a> - Demo of the <code>:auth</code> plugin with the :errors plugin for auth failure management.</li>
+		<li><a href="/upload">Upload Demo</a> - Demo of <tt>multipart/form-data</tt> support, Mongrel2 async upload support for larger files.</li>
 	</ul>
 
 </body>

data/examples/templates/upload-form.tmpl

@@ -0,0 +1,17 @@
+<?import request ?>
+
+<?publish title ?>Upload/Multipart-FormData Demo<?end publish ?>
+
+<form action="[?call request.uri ?]" method="post" accept-charset="utf-8" enctype="multipart/form-data">
+
+	<label for="uploadfile">Upload a file:</label>
+	<input type="file" name="uploadfile" value="" id="uploadfile-input">
+
+	<br />
+
+	<label for="description">Description</label>
+	<input type="text" name="description" value="" id="description-input">
+
+	<p><input type="submit" value="Upload &rarr;"></p>
+</form>
+

data/examples/templates/upload-success.tmpl

@@ -0,0 +1,13 @@
+<?import request ?>
+
+<h2>Upload Successful</h2>
+
+<p>You successfully uploaded a file: <tt><?call upload.filename ?></tt>
+	(<?call "%0.2fK" % upload.content_length / 1024.0 ?> of
+	'<?call upload.content_type ?>' data) with a description of
+	<tt><?escape description ?></tt></p>
+
+<hr />
+
+<?include upload-form.tmpl ?>
+

data/lib/strelka/app.rb

@@ -246,7 +246,7 @@ class Strelka::App < Mongrel2::Handler
 
 	### Run the app -- overriden to set the process name to something interesting.
 	def run
-		procname = "%p %s" % [ self.class, self.conn ]
+		procname = "%s %s: %p %s" % [ RUBY_ENGINE, RUBY_VERSION, self.class, self.conn ]
 		$0 = procname
 
 		super
@@ -289,6 +289,28 @@ class Strelka::App < Mongrel2::Handler
 	end
 
 
+	### Handle uploads larger than the server's configured limit with a 413: Request Entity
+	### Too Large before dropping the connection.
+	def handle_async_upload_start( request )
+		status_info = { :status => HTTP::REQUEST_ENTITY_TOO_LARGE, :message => 'Request too large.' }
+		response = self.prepare_status_response( request, status_info )
+		response.headers.connection = 'close'
+		self.conn.reply( response )
+
+		explanation = "If you wish to handle requests like this, either set your server's "
+		explanation << "'limits.content_length' setting to a higher value than %d, or override " %
+			 [ request.content_length ]
+		explanation << "#handle_async_upload_start."
+
+		self.log.warn "Async upload from %s dropped." % [ request.remote_ip ]
+		self.log.info( explanation )
+
+		self.conn.reply_close( request )
+
+		return nil
+	end
+
+
 	#########
 	protected
 	#########