protocol-websocket 0.11.1 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17a6b7e17274fe574b07bc2ad242cbe383671f7f05c84fd784ec474fbde5e28a
-  data.tar.gz: f1098660970a0cf6069d5037dd736b52b18b7da51727c9968a96970ecd1015b0
+  metadata.gz: 336e62c38fbb57000bf3183e14f750224706504cd8777bbc7d09505f71a0d65e
+  data.tar.gz: 2bb63e4bab32ba833f90e5f2857ae198a4f0b9aa66404044ac192e9bcc04c726
 SHA512:
-  metadata.gz: 1720e16bd8d32258b7583d9cde912229d64af57428ad3bb8644832c5b6f4e5c1588a798c9368a9638c5801f320e9b8489094d40ca5ffe45634b6d582d3f12170
-  data.tar.gz: 17ac4461055d2de24188f365a85e5fb80c907ab041fc62bdc2f376e24bec1178f950ef8ff4388d39c6c144e056e63d8fc8e28ab53dcd537a4f92af73c02a5dd2
+  metadata.gz: eba17e42ae64f93fd5d427245b916fb25c6c09971db2d15969d6b8e29aaea22fb1ab39d52aff19fb46157003bf5c277b0aab1194f00a3fc04532fb1bfa1ab3ca
+  data.tar.gz: e228e38de1c954c9c7c506bc73c94194eea02bb51ee5d0baaae61b98820f831a409970c00a74846a70d0a7642ea807d7e6c09734c388d9634379f0e1bef659cc

data/lib/protocol/websocket/connection.rb

@@ -61,8 +61,17 @@ module Protocol
 				return self
 			end
 			
+			# If not already closed, transition the connection to the closed state and send a close frame.
 			def close!(...)
-				@state = :closed
+				unless @state == :closed
+					@state = :closed
+					
+					begin
+						send_close(...)
+					rescue
+						# Ignore errors.
+					end
+				end
 				
 				return self
 			end
@@ -71,16 +80,9 @@ module Protocol
 				@state == :closed
 			end
 			
+			# Immediately transition the connection to the closed state and close the underlying connection.
 			def close(...)
-				unless @state == :closed
-					close!
-					
-					begin
-						send_close(...)
-					rescue
-						# Ignore.
-					end
-				end
+				close!(...)
 				
 				@framer.close
 			end
@@ -101,11 +103,9 @@ module Protocol
 				return frame
 			rescue ProtocolError => error
 				close(error.code, error.message)
-				
 				raise
-			rescue
-				close(Error::PROTOCOL_ERROR, $!.message)
-				
+			rescue => error
+				close(Error::PROTOCOL_ERROR, error.message)
 				raise
 			end
 			
@@ -142,11 +142,8 @@ module Protocol
 			def receive_close(frame)
 				code, reason = frame.unpack
 				
-				# If we're already closed, then we don't need to send a close frame. Otherwise, according to the RFC, we should echo the close frame. However, it's possible it will fail to send if the connection is already closed.
-				unless @state == :closed
-					close!
-					send_close(code, reason)
-				end
+				# On receiving a close frame, we must enter the closed state:
+				close!(code, reason)
 				
 				if code and code != Error::NO_ERROR
 					raise ClosedError.new reason, code
@@ -202,6 +199,7 @@ module Protocol
 				write_frame(@writer.pack_binary_frame(buffer, **options))
 			end
 			
+			# Send a control frame with data containing a specified control sequence to begin the closing handshake. Does not close the connection, until the remote end responds with a close frame.
 			def send_close(code = Error::NO_ERROR, reason = "")
 				frame = CloseFrame.new(mask: @mask)
 				frame.pack(code, reason)
@@ -246,7 +244,6 @@ module Protocol
 				end
 			rescue ProtocolError => error
 				close(error.code, error.message)
-				
 				raise
 			end
 		end

data/lib/protocol/websocket/frame.rb

@@ -86,6 +86,30 @@ module Protocol
 			attr_accessor :length
 			attr_accessor :payload
 			
+			if IO.const_defined?(:Buffer) && IO::Buffer.respond_to?(:for) && IO::Buffer.method_defined?(:xor!)
+				private def mask_xor(data, mask)
+					buffer = data.dup
+					mask_buffer = IO::Buffer.for(mask)
+					
+					IO::Buffer.for(buffer) do |buffer|
+						buffer.xor!(mask_buffer)
+					end
+					
+					return buffer
+				end
+			else
+				warn "IO::Buffer not available, falling back to slow implementation of mask_xor!"
+				private def mask_xor(data, mask)
+					result = String.new(encoding: Encoding::BINARY)
+						
+					for i in 0...data.bytesize do
+						result << (data.getbyte(i) ^ mask.getbyte(i % 4))
+					end
+					
+					return result
+				end
+			end
+			
 			def pack(data = "")
 				length = data.bytesize
 				
@@ -94,12 +118,7 @@ module Protocol
 				end
 				
 				if @mask
-					@payload = String.new(encoding: Encoding::BINARY)
-					
-					for i in 0...data.bytesize do
-						@payload << (data.getbyte(i) ^ mask.getbyte(i % 4))
-					end
-					
+					@payload = mask_xor(data, mask)
 					@length = length
 				else
 					@payload = data
@@ -111,13 +130,7 @@ module Protocol
 			
 			def unpack
 				if @mask and !@payload.empty?
-					data = String.new(encoding: Encoding::BINARY)
-					
-					for i in 0...@payload.bytesize do
-						data << (@payload.getbyte(i) ^ @mask.getbyte(i % 4))
-					end
-					
-					return data
+					return mask_xor(@payload, @mask)
 				else
 					return @payload
 				end

data/lib/protocol/websocket/version.rb

@@ -5,6 +5,6 @@
 
 module Protocol
 	module WebSocket
-		VERSION = "0.11.1"
+		VERSION = "0.12.0"
 	end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: protocol-websocket
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: 0.12.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -41,7 +41,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2023-06-01 00:00:00.000000000 Z
+date: 2023-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: protocol-http
@@ -154,14 +154,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.6
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.7
+rubygems_version: 3.5.0.dev
 signing_key:
 specification_version: 4
 summary: A low level implementation of the WebSocket protocol.