mongrel2 0.15.1 → 0.16.0

data/ChangeLog

@@ -1,8 +1,58 @@
+2012-03-07  Michael Granger  <ged@FaerieMUD.org>
+
+	* README.rdoc, data/mongrel2/bootstrap.html,
+	data/mongrel2/css/master.css, data/mongrel2/js/websock-test.js,
+	data/mongrel2/websock-test.html, examples/config.rb, examples/ws-
+	echo.rb, lib/mongrel2/connection.rb, lib/mongrel2/handler.rb,
+	lib/mongrel2/websocket.rb:
+	Finished up WebSocket implementation.
+
+	- Added the class to API docs.
+	- Cleaned up and fixed a couple of bugs in the websocket echo server
+	backend.
+	- Fixed issues with encoding of incoming frame payloads.
+	- Added frame validation methods
+	[fea3cd02d23c] [github/master, tip]
+
+2012-03-05  Michael Granger  <ged@FaerieMUD.org>
+
+	* data/mongrel2/bootstrap.html, data/mongrel2/css/master.css,
+	data/mongrel2/websock-test.html, examples/config.rb, examples/ws-
+	echo.rb, lib/mongrel2.rb, lib/mongrel2/handler.rb,
+	lib/mongrel2/request.rb, lib/mongrel2/testing.rb,
+	lib/mongrel2/websocket.rb, spec/lib/constants.rb,
+	spec/mongrel2/httprequest_spec.rb, spec/mongrel2/request_spec.rb,
+	spec/mongrel2/websocket_spec.rb:
+	Adding WebSocket (RFC6455) support
+	[0db6f3808f5a]
+
+2012-03-02  Michael Granger  <ged@FaerieMUD.org>
+
+	* lib/mongrel2/handler.rb:
+	Log the method for unknown request types
+	[1de6b0f28ee6]
+
+	* examples/config.rb:
+	Remove the null filter from the examples config
+	[bbafaa425b68]
+
+	* .hgtags:
+	Added tag v0.15.1 for changeset 2bb88b311d68
+	[e6e61577d110]
+
+	* .hgsigs:
+	Added signature for changeset e943c9068b73
+	[2bb88b311d68] [v0.15.1]
+
+	* History.rdoc, lib/mongrel2.rb:
+	Bump patch version and update history.
+	[e943c9068b73]
+
 2012-03-01  Michael Granger  <ged@FaerieMUD.org>
 
 	* lib/mongrel2/connection.rb:
 	Fix some comments/debug statements in Connection
-	[16a888bc7999] [github/master, tip]
+	[16a888bc7999]
 
 	* lib/mongrel2/config/host.rb:
 	Make sure host deletes cascade to their routes

data/History.rdoc

@@ -1,3 +1,8 @@
+== v0.16.0 [2012-03-10] Michael Granger <ged@FaerieMUD.org>
+
+- Add WebSocket (RFC6455) support
+
+
 == v0.15.1 [2012-03-02] Michael Granger <ged@FaerieMUD.org>
 
 - Make sure Mongrel2::Config::Host deletes cascade to their routes

data/Manifest.txt

@@ -10,13 +10,16 @@ bin/m2sh.rb
 data/mongrel2/bootstrap.html
 data/mongrel2/config.sql
 data/mongrel2/css/master.css
+data/mongrel2/js/websock-test.js
 data/mongrel2/mimetypes.sql
+data/mongrel2/websock-test.html
 examples/README.txt
 examples/config.rb
 examples/helloworld-handler.rb
 examples/request-dumper.rb
 examples/request-dumper.tmpl
 examples/run
+examples/ws-echo.rb
 lib/mongrel2.rb
 lib/mongrel2/config.rb
 lib/mongrel2/config/directory.rb
@@ -45,6 +48,7 @@ lib/mongrel2/request.rb
 lib/mongrel2/response.rb
 lib/mongrel2/table.rb
 lib/mongrel2/testing.rb
+lib/mongrel2/websocket.rb
 lib/mongrel2/xmlrequest.rb
 spec/lib/constants.rb
 spec/lib/helpers.rb
@@ -72,4 +76,5 @@ spec/mongrel2/mixins_spec.rb
 spec/mongrel2/request_spec.rb
 spec/mongrel2/response_spec.rb
 spec/mongrel2/table_spec.rb
+spec/mongrel2/websocket_spec.rb
 spec/mongrel2_spec.rb

data/README.rdoc

@@ -4,25 +4,28 @@
 
 == Description
 
-Ruby-Mongrel2 is a complete Ruby (1.9-only) connector for 
+Ruby-Mongrel2 is a complete Ruby (1.9-only) connector for
 Mongrel2[http://mongrel2.org/].
 
 This library includes configuration-database ORM classes, a Ruby
 implementation of the 'm2sh' tool, a configuration DSL for generating config
-databases in pure Ruby, a Control port interface object, and handler classes 
+databases in pure Ruby, a Control port interface object, and handler classes
 for creating applications or higher-level frameworks.
 
-It differs from the original Mongrel2 Ruby library (m2r), and the
-mongrel2-rack library in several ways:
+
+=== Other Implementations
+
+There are two other Mongrel2 Ruby libraries, +m2r+ and the +mongrel2-rack+
+library. This implementation differs from them in several ways:
 
 * It uses the C extension for 0MQ (zmq) instead of the FFI one. If you
   strongly prefer the FFI library, both of the other Mongrel2 libraries use
   it, so you'll want to stick to one of them.
 
-* It doesn't come with a Rack handler, or Rails examples, or anything fancy. I
-  intend to build my own webby framework bits around Mongrel2, and I thought
-  maybe someone else might want to as well. If you don't, well again, there
-  are two other libraries for you.
+* It doesn't come with a Rack handler, or Rails examples, or anything too
+  fancy. I intend to build my own webby framework bits around Mongrel2, and
+  I thought maybe someone else might want to as well. If you don't, well
+  again, there are two other libraries for you.
 
 * It includes configuration stuff. I want to make tools that use the Mongrel2
   config database, so I wrote config classes. Sequel::Model made it
@@ -36,7 +39,8 @@ mongrel2-rack library in several ways:
     gem install mongrel2
 
 
-This library uses Jeremy Hinegardner's 'amalgalite' library for the config ORM classes, but it will also fall back to using the sqlite3 library instead:
+This library uses Jeremy Hinegardner's 'amalgalite' library for the config ORM
+classes, but it will also fall back to using the sqlite3 library instead:
 
     # Loading the sqlite3 library explicitly
     $ rspec -rsqlite3 -cfp spec
@@ -95,6 +99,7 @@ Mongrel2 sends:
 * Mongrel2::HTTPRequest
 * Mongrel2::JSONRequest
 * Mongrel2::XMLRequest
+* Mongrel2::WebSocket::Frame
 
 These are all {overridable}[rdoc-ref:Mongrel2::Request.register_request_type]
 if you should want a more-specialized class for one of them.

data/bin/m2sh.rb

@@ -527,6 +527,7 @@ class Mongrel2::M2SHCommand
 
 		header "Reloading '%s'" % [ server.name ]
 		control.reload
+		control.close
 		message "done."
 	end
 	help :reload, "Reload the specified server's configuration"
@@ -540,6 +541,7 @@ class Mongrel2::M2SHCommand
 
 		header "Stopping '%s' gracefully." % [ server.name ]
 		control.stop
+		control.close
 		message "done."
 	end
 	help :stop, "Stop the specified server gracefully"

data/data/mongrel2/bootstrap.html

@@ -1,27 +1,29 @@
 <!DOCTYPE html>
 <html>
-	<head>
-		<title>Ruby-Mongrel2 Examples</title>
-		<link rel="stylesheet" href="/css/master.css" type="text/css" media="screen"
-			title="no title" charset="utf-8" />
-	</head>
-	<body>
-		<header>
-			<hgroup>
-				<h1>Ruby-Mongrel2 Examples</h1>
-			</hgroup>
-		</header>
+<head>
+	<title>Ruby-Mongrel2 Examples</title>
+	<link rel="stylesheet" href="/css/master.css" type="text/css" media="screen"
+		title="no title" charset="utf-8" />
+	<meta charset="utf-8" />
+</head>
+<body>
+	<header>
+		<hgroup>
+			<h1>Ruby-Mongrel2 Examples</h1>
+		</hgroup>
+	</header>
 
-		<section>
-			<ol>
-				<li><a href="/hello">Hello World</a> (<a href="/source/helloworld-handler.rb">source</a>) </li>
-				<li><a href="/dump">Dump Request</a> (<a href="/source/request-dumper.rb">source</a>) </li>
-			</ol>
-		</section>
+	<section>
+		<ol>
+			<li><a href="/hello">Hello World</a> (<a href="/source/helloworld-handler.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>
+	</section>
 
-		<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 e50e20d73e34 2012/02/27 17:27:33 ged $</tt></p>
-		</footer>
-	</body>
+	<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>
+	</footer>
+</body>
 </html>

data/data/mongrel2/css/master.css

@@ -1,4 +1,5 @@
-/* @override http://pelimer.pg.laika.com:8113/css/master.css */
+/* @override http://pelimer.pg.laika.com:8113/css/master.css
+	http://localhost:8113/css/master.css */
 
 /*
  * Mongrel2 Examples Stylesheet
@@ -46,3 +47,31 @@ tbody th {
 	vertical-align: top;
 	white-space: pre;
 }
+
+
+/*
+ * WebSocket tester styles
+ */
+
+.websocket-test form {
+	margin: 2em 0;
+	padding: 2em;
+	border-radius: 0.5em;
+	background: rgba( 50,50,50, 0.5 );
+}
+
+.websocket-test form.socket-connected {
+	background: rgba( 0,150,0, 0.25 );
+}
+
+.websocket-test form input {
+	font-size: 1.4em;
+	width: 300px;
+	border: 1px solid #aaa;
+	background: #ddd;
+}
+
+.websocket-test form.socket-connected input {
+	background: #eee;
+}
+

data/data/mongrel2/js/websock-test.js

@@ -0,0 +1,108 @@
+/**
+ * Ruby-Mongrel2 Websocket Demo
+ * $Id$
+ *
+ * Author:
+ * - Michael Granger <ged@FaerieMUD.org>
+ *
+ */
+
+var ws = null;
+
+function writeToLog( msg ) {
+	$('#log').append( "<li>" + msg + "</li>\n");
+}
+
+function writeErrorLog( msg ) {
+	$('#log').append( "<li class=\"error\">" + msg + "</li>\n");
+}
+
+function onOpen( e ) {
+	console.debug( "WebSocket open." );
+	writeToLog( "Connected." );
+
+	$('form').addClass( 'socket-connected' );
+	$('#connect').unbind( 'click' ).attr( 'disabled', 'disabled' );
+	$('#disconnect').click( doDisconnect ).removeAttr('disabled');
+	$('#echo-body').removeAttr('disabled');
+	$('#send').click( doSend ).removeAttr('disabled');
+}
+
+function onClose( e ) {
+	console.debug( "WebSocket closed." );
+	writeToLog( "Disconnected." );
+
+	$('form').removeClass( 'socket-connected' );
+	$('#connect').click( doConnect ).removeAttr('disabled');
+	$('#disconnect,#echo-body,#send').unbind( 'click' ).attr( 'disabled', 'disabled' );
+}
+
+function onMessage( e ) {
+	console.debug( "WebSocket message: %s.", e.data );
+	writeToLog( "Response: <code>" + e.data + "</code>" );
+}
+
+function onError( e ) {
+	console.error( "WebSocket error: %o", e );
+	writeErrorLog( "WebSocket Error: " + e.data )
+}
+
+function doConnect( e ) {
+	console.debug( "Connecting WebSocket." );
+	writeToLog( "Connecting." );
+	var ws_uri = $('meta[name=socket-uri]').attr( 'content' );
+	ws_uri = 'ws://' + window.location.host + ws_uri;
+
+	console.debug( "  Socket URI is: %s", ws_uri );
+
+	ws = new WebSocket( ws_uri, 'echo' );
+
+	ws.onopen    = onOpen;
+	ws.onclose   = onClose;
+	ws.onmessage = onMessage;
+	ws.onerror   = onError;
+}
+
+function doDisconnect( e ) {
+	console.debug( "Closing WebSocket." );
+	writeToLog( "Disconnecting." );
+	ws.close();
+}
+
+function doSend( e ) {
+	e.preventDefault();
+	e.stopPropagation();
+
+	var data = $('#echo-body').val();
+	$('#echo-body').val('');
+
+	console.debug( "Sending message: %s.", data );
+	writeToLog( "Sent: <code>" + data + "</code>." );
+
+	ws.send( data );
+}
+
+$(document).ready( function() {
+	log = $('#log');
+
+	if (window.MozWebSocket) {
+        console.debug( 'Using MozWebSocket' );
+        window.WebSocket = window.MozWebSocket;
+    } else if (!window.WebSocket) {
+        console.error( "This browser doesn't support WebSocket. ;_;" );
+        return;
+    }
+
+	// Check for recent implementations of the WebSocket API
+	if ( typeof WebSocket.CONNECTING == 'undefined' ) {
+		console.error( "WebSocket implementation is too old." );
+		writeErrorLog( "WebSocket implementation too old. Sorry, you'll need a newer browser." );
+		return;
+	}
+
+	$('#connect').click( doConnect );
+	$('#disconnect,#echo-body,#send').attr( 'disabled', 'disabled' );
+
+	writeToLog( "Ready." );
+});
+

data/data/mongrel2/websock-test.html

@@ -0,0 +1,33 @@
+<!DOCTYPE html>
+<html>
+<head>
+	<script type="text/javascript" src="http://code.jquery.com/jquery.min.js"></script>
+	<script type="text/javascript" src="/js/websock-test.js"></script>
+
+	<link rel="stylesheet" href="/css/master.css" type="text/css" media="screen"
+		title="no title" charset="utf-8" />
+
+	<meta name="socket-uri" content="/ws" />
+	<meta charset="utf-8" />
+
+</head>
+<body class="websocket-test">
+	<h1>WebSockets Echo Test</h1>
+
+	<form action="#" method="get" accept-charset="utf-8">
+		<label for="echo-body">Echo message:</label>
+		<input type="text" name="echo-body" value="" id="echo-body" disabled="disabled" />
+		<button id="send" disabled="disabled">Send</button>
+	</form>
+
+	<section id="connection-controls">
+		<button id="connect">Connect</button>
+		<button id="disconnect">Disconnect</button>
+	</section>
+
+	<section id="log-box">
+		<h2>Log:</h2>
+		<ul id="log"></ul>
+	</section>
+</body>
+</html>

data/examples/config.rb

@@ -6,35 +6,35 @@
 #
 
 # samples server
-server '34D8E57C-3E91-4F24-9BBE-0B53C1827CB4' do
+server 'examples' do
 
-	name         'main'
-	default_host 'www.example.com'
+	name         'Examples'
+	default_host 'localhost'
 
 	access_log   '/logs/access.log'
 	error_log    '/logs/error.log'
 	chroot       '/var/mongrel2'
 	pid_file     '/run/mongrel2.pid'
 
-	bind_addr    '0.0.0.0'
+	bind_addr    '127.0.0.1'
 	port         8113
 
 	# your main host
-	host 'www.example.com' do
+	host 'localhost' do
 
 		route '/', directory( 'data/mongrel2/', 'bootstrap.html', 'text/html' )
 		route '/source', directory( '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 '/dump', handler( 'tcp://127.0.0.1:9997', 'request-dumper' )
+		route '/dump', dumper
+		route '/ws', handler( 'tcp://127.0.0.1:9995', 'ws-echo' )
+		route '@js', dumper
+		route '<xml', dumper
 
 	end
 
-	filter '/usr/local/lib/mongrel2/filters/null.so',
-		extensions: ["*.html", "*.txt"],
-		min_size: 1000
-
 end
 
 setting "zeromq.threads", 1