mongrel2 0.34.1.pre.357 → 0.35.0

data/History.rdoc

@@ -1,7 +1,13 @@
-== v0.34.1 [2012-12-04] Michael Granger <ged@FaerieMUD.org>
-
-- Ensure the ZMQ context is closed when Handler#run exits.
-
+== v0.35.0 [2012-12-11] Michael Granger <ged@FaerieMUD.org>
+
+- Allow WebSocket frames to be set to reserved opcodes
+- Allow WebSocket opcodes to be set numerically
+- Add a #socket_id method to all WebSocket frame types.
+  * Created a Mongrel2::WebSocket::Methods mixin with the
+    implementation of the method.
+  * Included the new mixin in WebSocket::Frame,
+    WebSocket::ClientHandshake, and WebSocket::ServerHandshake
+- Ensure the ZMQ context is closed when #run exits.
 
 == v0.34.0 [2012-10-17] Michael Granger <ged@FaerieMUD.org>
 

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.34.1'
+	VERSION = '0.35.0'
 
 	# Version-control revision constant
-	REVISION = %q$Revision: 20d86c77d502 $
+	REVISION = %q$Revision: d19a29e2ca5f $
 
 
 	require 'mongrel2/constants'

data/lib/mongrel2/connection.rb

@@ -191,6 +191,7 @@ class Mongrel2::Connection
 		]
 	end
 
+
 	### Returns a string containing a human-readable representation of the Connection,
 	### suitable for debugging.
 	def inspect

data/lib/mongrel2/websocket.rb

@@ -27,6 +27,11 @@ require 'mongrel2/constants'
 #           ...
 #       end
 #   end
+#
+# == References
+#
+# * http://tools.ietf.org/html/rfc6455
+#
 module Mongrel2::WebSocket
 
 	# WebSocket-related header and status constants
@@ -200,9 +205,21 @@ module Mongrel2::WebSocket
 	class HandshakeError < Mongrel2::WebSocket::Error; end
 
 
+	# A mixin containing methods common to WebSocket frame classes.
+	module Methods
+
+		### Get a string identifying the websocket the frame belongs to.
+		def socket_id
+			return [ self.sender_id, self.conn_id ].join( ':' )
+		end
+
+	end # module Methods
+
+
 	# The client (request) handshake for a WebSocket opening handshake.
 	class ClientHandshake < Mongrel2::HTTPRequest
-		include Mongrel2::WebSocket::Constants
+		include Mongrel2::WebSocket::Constants,
+		        Mongrel2::WebSocket::Methods
 
 		# Set this class as the one that will handle WEBSOCKET_HANDSHAKE requests
 		register_request_type( self, :WEBSOCKET_HANDSHAKE )
@@ -228,8 +245,8 @@ module Mongrel2::WebSocket
 		end
 
 
-		### Create a Mongrel2::WebSocket::Handshake that will respond to the same server/connection as
-		### the receiver.
+		### Create a Mongrel2::WebSocket::Handshake that will respond to the same
+		### server/connection as the receiver.
 		def response( protocol=nil )
 			@response = super() unless @response
 			if protocol
@@ -247,7 +264,8 @@ module Mongrel2::WebSocket
 
 	# The server (response) handshake for a WebSocket opening handshake.
 	class ServerHandshake < Mongrel2::HTTPResponse
-		include Mongrel2::WebSocket::Constants
+		include Mongrel2::WebSocket::Constants,
+		        Mongrel2::WebSocket::Methods
 
 		### Create a server handshake frame from the given client +handshake+.
 		def self::from_request( handshake )
@@ -287,7 +305,8 @@ module Mongrel2::WebSocket
 	# WebSocket frame class; this is used for both requests and responses in
 	# WebSocket services.
 	class Frame < Mongrel2::Request
-		include Mongrel2::WebSocket::Constants
+		include Mongrel2::WebSocket::Constants,
+		        Mongrel2::WebSocket::Methods
 
 		# The default frame header flags: FIN + CLOSE
 		DEFAULT_FLAGS = FIN_FLAG | OPCODE[:close]
@@ -409,8 +428,14 @@ module Mongrel2::WebSocket
 		### Set the frame's opcode to +code+, which should be either a numeric opcode or
 		### its equivalent name (i.e., :continuation, :text, :binary, :close, :ping, :pong)
 		def opcode=( code )
-			opcode = OPCODE[ code.to_sym ] or
-				raise ArgumentError, "unknown opcode %p" % [ code ]
+			opcode = nil
+
+			if code.is_a?( Numeric )
+				opcode = Integer( code )
+			else
+				opcode = OPCODE[ code.to_sym ] or
+					raise ArgumentError, "unknown opcode %p" % [ code ]
+			end
 
 			self.flags ^= ( self.flags & OPCODE_BITMASK )
 			self.flags |= opcode
@@ -542,12 +567,7 @@ module Mongrel2::WebSocket
 
 
 		### Create a frame in response to the receiving Frame (i.e., with the same
-		### Mongrel2 connection ID and sender). This automatically sets up the correct
-		### status, Sec-WebSocket-Accept:, Connection, and Upgrade: headers based on the
-		### receiver. If +protocol+ is non-nil, and it matches one of the
-		### values listed in 'Sec-WebSocket-Protocol', it will be set as the
-		### Handshake's Sec-WebSocket-Protocol header. If it is non-nil, but doesn't
-		### match one of the request's values, a Mongrel2::WebSocket::Error is raised.
+		### Mongrel2 connection ID and sender).
 		def response( *flags )
 			unless @response
 				@response = super()
@@ -558,7 +578,7 @@ module Mongrel2::WebSocket
 					@response.opcode = :pong
 					IO.copy_stream( self.payload, @response.payload, 4096 )
 				else
-					@response.opcode = self.opcode
+					@response.opcode = self.numeric_opcode
 				end
 
 				# Set flags in the response
@@ -592,7 +612,7 @@ module Mongrel2::WebSocket
 				when :continuation, :text, :binary, :close, :ping, :pong
 					self.opcode = flag
 				when Integer
-					self.log.debug "  setting Integer flags directly: 0b%08b" % [ integer ]
+					self.log.debug "  setting Integer flags directly: 0b%08b" % [ flag ]
 					self.flags |= flag
 				else
 					raise ArgumentError, "Don't know what the %p flag is." % [ flag ]

data/spec/lib/constants.rb

@@ -277,7 +277,7 @@ module Mongrel2::TestConstants # :nodoc:all
 
 		# Freeze all testing constants
 		constants.each do |cname|
-			const_get(cname).freeze
+			const_get(cname).freeze if cname.to_s.start_with?( 'TEST' )
 		end
 	end
 

data/spec/mongrel2/websocket_spec.rb

@@ -112,6 +112,11 @@ describe Mongrel2::WebSocket do
 			}.to raise_error( Mongrel2::WebSocket::HandshakeError, /map_updates/i )
 		end
 
+		it "has a socket identifier" do
+			handshake = @factory.handshake( '/websock', 'echo', 'superecho' )
+			handshake.socket_id.should == "#{handshake.sender_id}:#{handshake.conn_id}"
+		end
+
 	end
 
 
@@ -169,6 +174,45 @@ describe Mongrel2::WebSocket do
 			@factory.pong( '/websock' ).opcode.should == :pong
 		end
 
+		it "knows that its opcode is one of the reserved ones if it's 0x3" do
+			@factory.create( '/websocket', '', 0x3 ).opcode.should == :reserved
+		end
+
+		it "knows that its opcode is one of the reserved ones if it's 0x4" do
+			@factory.create( '/websocket', '', 0x4 ).opcode.should == :reserved
+		end
+
+		it "knows that its opcode is one of the reserved ones if it's 0xB" do
+			@factory.create( '/websocket', '', 0xB ).opcode.should == :reserved
+		end
+
+		it "knows that its opcode is one of the reserved ones if it's 0xD" do
+			@factory.create( '/websocket', '', 0xD ).opcode.should == :reserved
+		end
+
+		it "knows that its opcode is one of the reserved ones if it's 0xF" do
+			@factory.create( '/websocket', '', 0xF ).opcode.should == :reserved
+		end
+
+		it "allows its opcode to be set Symbolically" do
+			frame = @factory.text( '/websocket', 'data' )
+			frame.opcode = :binary
+			frame.numeric_opcode.should == OPCODE[:binary]
+		end
+
+		it "allows its opcode to be set Numerically" do
+			frame = @factory.binary( '/websocket', 'data' )
+			frame.opcode = :text
+			frame.numeric_opcode.should == OPCODE[:text]
+		end
+
+		it "allows its opcode to be set to one of the reserved opcodes Numerically" do
+			frame = @factory.binary( '/websocket', 'data' )
+			frame.opcode = 0xC
+			frame.opcode.should == :reserved
+			frame.numeric_opcode.should == 0xC
+		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
@@ -240,6 +284,21 @@ describe Mongrel2::WebSocket do
 			result.payload.read.should == ''
 		end
 
+		it "allows reserved opcodes to be specified when creating a response" do
+			frame = @factory.text( '/websock', "some bad data" )
+
+			result = frame.response( 0xB )
+
+			result.should be_a( Mongrel2::WebSocket::Frame )
+			result.sender_id.should == frame.sender_id
+			result.conn_id.should == frame.conn_id
+			result.opcode.should == :reserved
+			result.numeric_opcode.should == 0xB
+
+			result.payload.rewind
+			result.payload.read.should == ''
+		end
+
 		it "can be streamed in chunks instead of read all at once" do
 			data = BINARY_DATA * 256
 			binary = @factory.binary( '/websock', data, :fin )
@@ -251,6 +310,11 @@ describe Mongrel2::WebSocket do
 			]
 		end
 
+		it "has a socket identifier" do
+			frame = @factory.text( '/websock', "data" )
+			frame.socket_id.should == "#{frame.sender_id}:#{frame.conn_id}"
+		end
+
 	end
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongrel2
 version: !ruby/object:Gem::Version
-  version: 0.34.1.pre.357
+  version: 0.35.0
   prerelease: 
 platform: ruby
 authors:
@@ -36,7 +36,7 @@ cert_chain:
   YUhDS0xaZFNLai9SSHVUT3QrZ2JsUmV4OEZBaDhOZUEKY21saFhlNDZwWk5K
   Z1dLYnhaYWg4NWpJang5NWhSOHZPSStOQU01aUg5a09xSzEzRHJ4YWNUS1Bo
   cWo1UGp3RgotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg==
-date: 2012-12-04 00:00:00.000000000 Z
+date: 2012-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri