mongrel2 0.15.1 → 0.16.0

data/spec/lib/constants.rb

@@ -10,7 +10,8 @@ require 'mongrel2' unless defined?( Mongrel2 )
 ### A collection of constants used in testing
 module Mongrel2::TestConstants # :nodoc:all
 
-	include Mongrel2::Constants
+	include Mongrel2::Constants,
+	        Mongrel2::WebSocket::Constants
 
 	unless defined?( TEST_HOST )
 

data/spec/mongrel2/httprequest_spec.rb

@@ -17,6 +17,7 @@ require 'spec/lib/helpers'
 
 require 'mongrel2'
 require 'mongrel2/httprequest'
+require 'mongrel2/httpresponse'
 
 
 #####################################################################

data/spec/mongrel2/request_spec.rb

@@ -113,7 +113,7 @@ describe Mongrel2::Request do
 	describe "framework support" do
 
 		before( :all ) do
-			@oldtypes = Mongrel2::Request.request_types
+			@oldtypes = Mongrel2::Request.request_types.dup
 			@original_default_proc = Mongrel2::Request.request_types.default_proc
 		end
 

data/spec/mongrel2/websocket_spec.rb

@@ -0,0 +1,295 @@
+#!/usr/bin/env ruby
+#encoding: utf-8
+
+BEGIN {
+	require 'pathname'
+	basedir = Pathname.new( __FILE__ ).dirname.parent.parent
+
+	libdir = basedir + "lib"
+
+	$LOAD_PATH.unshift( basedir ) unless $LOAD_PATH.include?( basedir )
+	$LOAD_PATH.unshift( libdir ) unless $LOAD_PATH.include?( libdir )
+}
+
+require 'rspec'
+require 'tnetstring'
+require 'securerandom'
+
+require 'spec/lib/helpers'
+
+require 'mongrel2'
+require 'mongrel2/websocket'
+
+
+#####################################################################
+###	C O N T E X T S
+#####################################################################
+
+describe Mongrel2::WebSocket do
+
+	before( :all ) do
+		setup_logging( :fatal )
+		@factory = Mongrel2::WebSocketFrameFactory.new( route: '/websock' )
+	end
+
+	after( :all ) do
+		reset_logging()
+	end
+
+	# Data for testing payload of binary frames
+	BINARY_DATA =
+		"\a\xBD\xB3\xFE\x87\xEB\xA9\x0En2q\xCE\x85\xAF)\x88w_d\xD6M" +
+		"\x9E\xAF\xCB\x89\x8F\xC8\xA0\x80ZL+\a\x9C\xF7{`\x9E'\xCF\xD9" +
+		"\xE8\xA5\x9C\xF7T\xE2\xDD\xF5\xE9\x14\x1F,?\xD2\nQ\f\x06\x96" +
+		"\x19\xB7\x06\x9F\xCD+*\x01\xC7\x98\xFE\x8A\x81\x04\xFF\xA7.J" +
+		"\xF1\x9F\x9E\xEB$<;\x99>q\xBA\x12\xB3&i\xCCaE}\xAA\x87>ya\x0E" +
+		"\xB0n\xD8lN\xE5\b\x83\xBB\x1D1\xFD\e\x84\xC1\xB4\x99\xC7\xCA" +
+		"\xF8}C\xF2\xC6\x04\xA208\xA1\xCF\xB9\xFF\xF2\x9C~mbi\xBC\xE0" +
+		"\xBE\xFER\xB5B#\xF1Z^\xB6\x80\xD2\x8E=t\xC6\x86`\xFAY\xD9\x01" +
+		"\xBF\xA7\x88\xE1rf?C\xB8XC\xEF\x9F\xB1j,\xC7\xE4\x9E\x86)7\"f0" +
+		"\xA0FH\xFC\x99\xCA\xB3D\x06ar\x9C\xEC\xE9\xAEj:\xFD\x1C\x06H\xF0" +
+		"\xF1w~\xEC\r\x7F\x00\xED\xD88\x81\xF0/\x99\xD7\x9D\xA9C\x06\xEF" +
+		"\x9B\xF3\x17\a\xDB\v{\e\xA3\tKTPV\xB8\xCB\xBB\xC9\x87f\\\xD0\x165"
+	BINARY_DATA.force_encoding( Encoding::ASCII_8BIT )
+
+
+	describe 'Frame' do
+
+		it "is the registered request type for WEBSOCKET requests" do
+			Mongrel2::Request.request_types[:WEBSOCKET].should == Mongrel2::WebSocket::Frame
+		end
+
+		it "knows that its FIN flag is not set if its FLAG header doesn't include that bit" do
+			frame = @factory.text( '/websock', 'Hello!' )
+			frame.flags ^= ( frame.flags & Mongrel2::WebSocket::FIN_FLAG )
+			frame.should_not be_fin()
+		end
+
+		it "knows that its FIN flag is set if its FLAG header includes that bit" do
+			frame = @factory.text( '/websock', 'Hello!', :fin )
+			frame.should be_fin()
+		end
+
+		it "can unset its FIN flag" do
+			frame = @factory.text( '/websock', 'Hello!', :fin )
+			frame.fin = false
+			frame.should_not be_fin()
+		end
+
+		it "can set its FIN flag" do
+			frame = @factory.text( '/websock', 'Hello!' )
+			frame.fin = true
+			frame.should be_fin()
+		end
+
+		it "knows that its opcode is continuation if its opcode is 0x0" do
+			@factory.continuation( '/websock' ).opcode.should == :continuation
+		end
+
+		it "knows that is opcode is 'text' if its opcode is 0x1" do 
+			@factory.text( '/websock', 'Hello!' ).opcode.should == :text
+		end
+
+		it "knows that is opcode is 'binary' if its opcode is 0x2" do 
+			@factory.binary( '/websock', 'Hello!' ).opcode.should == :binary
+		end
+
+		it "knows that is opcode is 'close' if its opcode is 0x8" do 
+			@factory.close( '/websock' ).opcode.should == :close
+		end
+
+		it "knows that is opcode is 'ping' if its opcode is 0x9" do 
+			@factory.ping( '/websock' ).opcode.should == :ping
+		end
+
+		it "knows that is opcode is 'pong' if its opcode is 0xA" do 
+			@factory.pong( '/websock' ).opcode.should == :pong
+		end
+
+		it "knows that its RSV1 flag is set if its FLAG header includes that bit" do
+			@factory.ping( '/websock', 'test', :rsv1 ).should be_rsv1()
+		end
+
+		it "knows that its RSV2 flag is set if its FLAG header includes that bit" do
+			@factory.ping( '/websock', 'test', :rsv2 ).should be_rsv2()
+		end
+
+		it "knows that its RSV3 flag is set if its FLAG header includes that bit" do
+			@factory.ping( '/websock', 'test', :rsv3 ).should be_rsv3()
+		end
+
+		it "knows that one of its RSV flags is set if its FLAG header includes RSV1" do
+			@factory.ping( '/websock', 'test', :rsv1 ).should have_rsv_flags()
+		end
+
+		it "knows that one of its RSV flags is set if its FLAG header includes RSV2" do
+			@factory.ping( '/websock', 'test', :rsv2 ).should have_rsv_flags()
+		end
+
+		it "knows that one of its RSV flags is set if its FLAG header includes RSV3" do
+			@factory.ping( '/websock', 'test', :rsv3 ).should have_rsv_flags()
+		end
+
+		it "knows that no RSV flags are set if its FLAG header doesn't have any RSV bits" do
+			@factory.ping( '/websock', 'test' ).should_not have_rsv_flags()
+		end
+
+		it "can create a response WebSocket::Frame for itself" do
+			frame = @factory.text( '/websock', "Hi, here's a message!", :fin )
+
+			result = frame.response
+
+			result.should be_a( Mongrel2::WebSocket::Frame )
+			result.sender_id.should == frame.sender_id
+			result.conn_id.should == frame.conn_id
+			result.opcode.should == :text
+
+			result.payload.should == ''
+		end
+
+		it "creates PONG responses with the same payload for PING frames" do
+			frame = @factory.ping( '/websock', "WOO" )
+
+			result = frame.response
+
+			result.should be_a( Mongrel2::WebSocket::Frame )
+			result.sender_id.should == frame.sender_id
+			result.conn_id.should == frame.conn_id
+			result.opcode.should == :pong
+
+			result.payload.should == 'WOO'
+		end
+
+		it "allows header flags and/or opcode to be specified when creating a response" do
+			frame = @factory.text( '/websock', "some bad data" )
+
+			result = frame.response( :close, :fin )
+
+			result.should be_a( Mongrel2::WebSocket::Frame )
+			result.sender_id.should == frame.sender_id
+			result.conn_id.should == frame.conn_id
+			result.opcode.should == :close
+			result.should be_fin()
+
+			result.payload.should == ''
+		end
+
+	end
+
+
+	describe "a WebSocket text frame" do
+
+		before( :each ) do
+			@frame = @factory.text( '/websock', 'Damn the torpedoes!', :fin )
+		end
+
+		it "automatically transcodes its payload to UTF8" do
+			text = "Стрелке!".encode( Encoding::KOI8_U )
+			@frame.payload.replace( text )
+
+			@frame.to_s[ 2..-1 ].bytes.to_a.should ==
+				[0xD0, 0xA1, 0xD1, 0x82, 0xD1, 0x80, 0xD0, 0xB5, 0xD0, 0xBB, 0xD0,
+				 0xBA, 0xD0, 0xB5, 0x21]
+		end
+
+	end
+
+
+	describe "a WebSocket binary frame" do
+		before( :each ) do
+			@frame = @factory.binary( '/websock', BINARY_DATA, :fin )
+		end
+
+		it "doesn't try to transcode non-UTF8 data" do
+			@frame.to_s.encoding.should == Encoding::ASCII_8BIT
+		end
+	end
+
+
+	describe "a WebSocket close frame" do
+		before( :each ) do
+			@frame = @factory.close( '/websock' )
+		end
+
+		it "has convenience methods for setting its payload via integer status code" do
+			@frame.set_status( CLOSE_BAD_DATA )
+			@frame.to_s[ 2..-1 ].should == "%d %s" %
+				[ CLOSE_BAD_DATA, CLOSING_STATUS_DESC[CLOSE_BAD_DATA] ]
+		end
+
+	end
+
+
+	describe "WebSocket control frames" do
+		before( :each ) do
+			@frame = @factory.close( '/websock', "1002 Protocol error" )
+		end
+
+
+		it "raises an exception if its payload is bigger than 125 bytes" do
+			@frame.body = "x" * 126
+			expect {
+				@frame.to_s
+			}.to raise_error( Mongrel2::WebSocket::FrameError, /cannot exceed 125 bytes/i )
+		end
+
+		it "raises an exception if it's fragmented" do
+			@frame.fin = false
+			expect {
+				@frame.to_s
+			}.to raise_error( Mongrel2::WebSocket::FrameError, /fragmented/i )
+		end
+
+	end
+
+
+	describe "RFC examples (the applicable ones, anyway)" do
+
+		it "generates a single-frame unmasked text message correctly" do
+			raw_response = @factory.text( '/websock', "Hello", :fin ).to_s
+			raw_response.bytes.to_a.should == [ 0x81, 0x05, 0x48, 0x65, 0x6c, 0x6c, 0x6f ]
+			raw_response.encoding.should == Encoding::BINARY
+		end
+
+		it "generates both parts of a fragmented unmasked text message correctly" do
+			first = @factory.text( '/websock', 'Hel' )
+			last = @factory.continuation( '/websock', 'lo', :fin )
+
+			first.bytes.to_a.should == [ 0x01, 0x03, 0x48, 0x65, 0x6c ]
+			last.bytes.to_a.should == [ 0x80, 0x02, 0x6c, 0x6f ]
+		end
+
+		# The RFC's example is a masked response, but we're never a client, so never
+		# generate masked payloads.
+		it "generates a unmasked Ping request and (un)masked Ping response correctly" do
+			ping = @factory.ping( '/websock', 'Hello' )
+			pong = @factory.pong( '/websock', 'Hello' )
+
+			ping.bytes.to_a.should == [ 0x89, 0x05, 0x48, 0x65, 0x6c, 0x6c, 0x6f ]
+			pong.bytes.to_a.should == [ 0x8a, 0x05, 0x48, 0x65, 0x6c, 0x6c, 0x6f ]
+		end
+
+
+		it "generates a 256-byte binary message in a single unmasked frame" do
+			binary = @factory.binary( '/websock', BINARY_DATA, :fin )
+
+			# 1 + 1 + 2
+			binary.to_s[0,4].bytes.to_a.should == [ 0x82, 0x7E, 0x01, 0x00 ]
+			binary.to_s[4..-1].should == BINARY_DATA
+		end
+
+		it "generates a 64KiB binary message in a single unmasked frame correctly" do
+			data = BINARY_DATA * 256
+
+			binary = @factory.binary( '/websock', data, :fin )
+
+			# 1 + 1 + 8
+			binary.to_s[0,10].bytes.to_a.should ==
+				[ 0x82, 0x7F, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00 ]
+			binary.to_s[10..-1].should == data
+		end
+
+	end
+
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongrel2
 version: !ruby/object:Gem::Version
-  version: 0.15.1
+  version: 0.16.0
   prerelease: 
 platform: ruby
 authors:
@@ -36,11 +36,11 @@ cert_chain:
   YUhDS0xaZFNLai9SSHVUT3QrZ2JsUmV4OEZBaDhOZUEKY21saFhlNDZwWk5K
   Z1dLYnhaYWg4NWpJang5NWhSOHZPSStOQU01aUg5a09xSzEzRHJ4YWNUS1Bo
   cWo1UGp3RgotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg==
-date: 2012-03-02 00:00:00.000000000 Z
+date: 2012-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70344063433420 !ruby/object:Gem::Requirement
+  requirement: &70305464835520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -48,10 +48,10 @@ dependencies:
         version: '1.5'
   type: :runtime
   prerelease: false
-  version_requirements: *70344063433420
+  version_requirements: *70305464835520
 - !ruby/object:Gem::Dependency
   name: sequel
-  requirement: &70344063432920 !ruby/object:Gem::Requirement
+  requirement: &70305464833340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -59,10 +59,10 @@ dependencies:
         version: '3.31'
   type: :runtime
   prerelease: false
-  version_requirements: *70344063432920
+  version_requirements: *70305464833340
 - !ruby/object:Gem::Dependency
   name: amalgalite
-  requirement: &70344063448860 !ruby/object:Gem::Requirement
+  requirement: &70305464831960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -70,10 +70,10 @@ dependencies:
         version: '1.1'
   type: :runtime
   prerelease: false
-  version_requirements: *70344063448860
+  version_requirements: *70305464831960
 - !ruby/object:Gem::Dependency
   name: tnetstring
-  requirement: &70344063448440 !ruby/object:Gem::Requirement
+  requirement: &70305464844480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -81,10 +81,10 @@ dependencies:
         version: '0.3'
   type: :runtime
   prerelease: false
-  version_requirements: *70344063448440
+  version_requirements: *70305464844480
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
-  requirement: &70344063448020 !ruby/object:Gem::Requirement
+  requirement: &70305464842260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -92,10 +92,10 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70344063448020
+  version_requirements: *70305464842260
 - !ruby/object:Gem::Dependency
   name: trollop
-  requirement: &70344063447600 !ruby/object:Gem::Requirement
+  requirement: &70305464839740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -103,10 +103,10 @@ dependencies:
         version: '1.16'
   type: :runtime
   prerelease: false
-  version_requirements: *70344063447600
+  version_requirements: *70305464839740
 - !ruby/object:Gem::Dependency
   name: sysexits
-  requirement: &70344063447180 !ruby/object:Gem::Requirement
+  requirement: &70305464852820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -114,10 +114,10 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70344063447180
+  version_requirements: *70305464852820
 - !ruby/object:Gem::Dependency
   name: zmq
-  requirement: &70344063446760 !ruby/object:Gem::Requirement
+  requirement: &70305464851800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -125,10 +125,10 @@ dependencies:
         version: 2.1.4
   type: :runtime
   prerelease: false
-  version_requirements: *70344063446760
+  version_requirements: *70305464851800
 - !ruby/object:Gem::Dependency
   name: hoe-mercurial
-  requirement: &70344063446340 !ruby/object:Gem::Requirement
+  requirement: &70305464850060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -136,10 +136,10 @@ dependencies:
         version: 1.3.1
   type: :development
   prerelease: false
-  version_requirements: *70344063446340
+  version_requirements: *70305464850060
 - !ruby/object:Gem::Dependency
   name: hoe-highline
-  requirement: &70344063445860 !ruby/object:Gem::Requirement
+  requirement: &70305464859060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -147,10 +147,10 @@ dependencies:
         version: 0.0.1
   type: :development
   prerelease: false
-  version_requirements: *70344063445860
+  version_requirements: *70305464859060
 - !ruby/object:Gem::Dependency
   name: configurability
-  requirement: &70344063445400 !ruby/object:Gem::Requirement
+  requirement: &70305464855380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -158,10 +158,10 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *70344063445400
+  version_requirements: *70305464855380
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70344063444980 !ruby/object:Gem::Requirement
+  requirement: &70305464868220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -169,10 +169,10 @@ dependencies:
         version: '2.8'
   type: :development
   prerelease: false
-  version_requirements: *70344063444980
+  version_requirements: *70305464868220
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70344063444560 !ruby/object:Gem::Requirement
+  requirement: &70305464871220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -180,10 +180,10 @@ dependencies:
         version: '3.10'
   type: :development
   prerelease: false
-  version_requirements: *70344063444560
+  version_requirements: *70305464871220
 - !ruby/object:Gem::Dependency
   name: hoe
-  requirement: &70344063444080 !ruby/object:Gem::Requirement
+  requirement: &70305464910100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -191,22 +191,19 @@ dependencies:
         version: '2.13'
   type: :development
   prerelease: false
-  version_requirements: *70344063444080
-description: ! "Ruby-Mongrel2 is a complete Ruby (1.9-only) connector for \nMongrel2[http://mongrel2.org/].\n\nThis
-  library includes configuration-database ORM classes, a Ruby\nimplementation of the
-  'm2sh' tool, a configuration DSL for generating config\ndatabases in pure Ruby,
-  a Control port interface object, and handler classes \nfor creating applications
-  or higher-level frameworks.\n\nIt differs from the original Mongrel2 Ruby library
-  (m2r), and the\nmongrel2-rack library in several ways:\n\n* It uses the C extension
-  for 0MQ (zmq) instead of the FFI one. If you\n  strongly prefer the FFI library,
-  both of the other Mongrel2 libraries use\n  it, so you'll want to stick to one of
-  them.\n\n* It doesn't come with a Rack handler, or Rails examples, or anything fancy.
-  I\n  intend to build my own webby framework bits around Mongrel2, and I thought\n
-  \ maybe someone else might want to as well. If you don't, well again, there\n  are
-  two other libraries for you.\n\n* It includes configuration stuff. I want to make
-  tools that use the Mongrel2\n  config database, so I wrote config classes. Sequel::Model
-  made it\n  stupid-easy. There's also a DSL for generating a config database, too,\n
-  \ mostly because I found it an interesting exercise, and I like the way it\n  looks."
+  version_requirements: *70305464910100
+description: ! '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
+
+  for creating applications or higher-level frameworks.'
 email:
 - ged@FaerieMUD.org
 executables:
@@ -231,13 +228,16 @@ files:
 - 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
@@ -266,6 +266,7 @@ files:
 - 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
@@ -293,6 +294,7 @@ files:
 - spec/mongrel2/request_spec.rb
 - spec/mongrel2/response_spec.rb
 - spec/mongrel2/table_spec.rb
+- spec/mongrel2/websocket_spec.rb
 - spec/mongrel2_spec.rb
 homepage: http://deveiate.org/projects/Ruby-Mongrel2/
 licenses:
@@ -320,5 +322,5 @@ rubyforge_project: mongrel2
 rubygems_version: 1.8.16
 signing_key: 
 specification_version: 3
-summary: Ruby-Mongrel2 is a complete Ruby (1.9-only) connector for  Mongrel2[http://mongrel2.org/]
+summary: Ruby-Mongrel2 is a complete Ruby (1.9-only) connector for Mongrel2[http://mongrel2.org/]
 test_files: []