protocol-websocket 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 076d348e98312526d98d8fc80840b9760cf30496ac4ca83d129ac53e120c10a0
-  data.tar.gz: 142d1fa0b2c8e06a3642cfff30f76f835308b23ca3d6964e1c3ae0870204d5e1
+  metadata.gz: 1c466ba64c434d16b197dacfb48341ab14eca48ba5aefde4cf06df4f10be84fc
+  data.tar.gz: 3d470e57b3c94936ec31adce97e829550344e6345de423f0d3c51915d951d782
 SHA512:
-  metadata.gz: 941eda4ac12acbc31bdd359cae2b2aaffd59f78f328844fcd171f6aca517cc225831ea3726f919448eaef3c7246a630d415988528ef08f4f6a394239b5924aeb
-  data.tar.gz: 9c37cfc67173a3632c344d042682f906b9b9afc2c4cbc35263f9cc48fa0cf4e62ee7348b4ce5a1af7bed2b118d23f477721e2b575f8d91f991806fa53996da7c
+  metadata.gz: 271a7a12c932857ea8887e67d7303a008852cc700e2d3bea0cbf96a6f30c53b8cae442f62877f4ad89c215dfb5bae81c0948da6b3cd5c267304dc368d795e542
+  data.tar.gz: 826444b74fd01885c66389a1c08b8b2cb99617662c3e364453d4d1572fa0237447d70d196fc867bde6231bc11efd6b47c874619bafe1efa800bcc1304a055329

data/lib/protocol/websocket/binary_frame.rb

@@ -19,6 +19,7 @@
 # THE SOFTWARE.
 
 require_relative 'frame'
+require_relative 'message'
 
 module Protocol
 	module WebSocket
@@ -30,7 +31,7 @@ module Protocol
 			end
 			
 			def read_message(buffer)
-				buffer
+				return BinaryMessage.new(buffer)
 			end
 			
 			def apply(connection)

data/lib/protocol/websocket/connection.rb

@@ -131,39 +131,7 @@ module Protocol
 					raise ProtocolError, "Received unexpected continuation!"
 				end
 			end
-			
-			def text_message(buffer, **options)
-				frame = TextFrame.new(mask: @mask)
-				frame.pack(buffer)
-				
-				return frame
-			end
-			
-			def send_text(buffer, **options)
-				write_frame(@writer.text_message(buffer, **options))
-			end
-			
-			def binary_message(buffer, **options)
-				frame = BinaryFrame.new(mask: @mask)
-				frame.pack(buffer)
-				
-				return frame
-			end
-			
-			def send_binary(buffer, **options)
-				write_frame(@writer.binary_message(buffer, **options))
-			end
-			
-			def send_close(code = Error::NO_ERROR, reason = "")
-				frame = CloseFrame.new(mask: @mask)
-				frame.pack(code, reason)
-				
-				self.write_frame(frame)
-				self.flush
-				
-				@state = :closed
-			end
-			
+					
 			def receive_close(frame)
 				@state = :closed
 				
@@ -209,23 +177,59 @@ module Protocol
 				warn "Unhandled frame #{frame.inspect}"
 			end
 			
-			def write_message(buffer, **options)
-				# Text: The "Payload data" is text data encoded as UTF-8
-				if buffer.encoding == Encoding::UTF_8
-					send_text(buffer, **options)
-				else
-					send_binary(buffer, **options)
-				end
+			def pack_text_frame(buffer, **options)
+				frame = TextFrame.new(mask: @mask)
+				frame.pack(buffer)
+				
+				return frame
 			end
 			
-			# @param buffer [String] a unicode or binary string.
-			def write(buffer, **options)
-				# https://tools.ietf.org/html/rfc6455#section-5.6
+			def send_text(buffer, **options)
+				write_frame(@writer.pack_text_frame(buffer, **options))
+			end
+			
+			def pack_binary_frame(buffer, **options)
+				frame = BinaryFrame.new(mask: @mask)
+				frame.pack(buffer)
 				
-				self.write_message(buffer, **options)
+				return frame
 			end
 			
-			# @return [String] a unicode or binary string.
+			def send_binary(buffer, **options)
+				write_frame(@writer.pack_binary_frame(buffer, **options))
+			end
+			
+			def send_close(code = Error::NO_ERROR, reason = "")
+				frame = CloseFrame.new(mask: @mask)
+				frame.pack(code, reason)
+				
+				self.write_frame(frame)
+				self.flush
+				
+				@state = :closed
+			end
+			
+			# Write a message to the connection.
+			# @parameter message [Message] The message to send.
+			def write(message, **options)
+				if message.is_a?(String)
+					if message.encoding == Encoding::UTF_8
+						return send_text(message, **options)
+					else
+						return send_binary(message, **options)
+					end
+				end
+				
+				message.send(self, **options)
+			end
+			
+			# The default implementation for reading a message buffer.
+			def unpack_frames(frames)
+				frames.map(&:unpack).join("")
+			end
+			
+			# Read a message from the connection.
+			# @returns message [Message] The received message.
 			def read(**options)
 				@framer.flush
 				
@@ -234,7 +238,7 @@ module Protocol
 						frames = @frames
 						@frames = []
 						
-						buffer = @reader.read_message(frames, **options)
+						buffer = @reader.unpack_frames(frames, **options)
 						return frames.first.read_message(buffer)
 					end
 				end
@@ -243,10 +247,6 @@ module Protocol
 				
 				raise
 			end
-			
-			def read_message(frames, **options)
-				frames.map(&:unpack).join("")
-			end
 		end
 	end
 end

data/lib/protocol/websocket/extension/compression/constants.rb

@@ -0,0 +1,34 @@
+# Copyright, 2021, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require 'zlib'
+
+module Protocol
+	module WebSocket
+		module Extension
+			module Compression
+				NAME = 'permessage-deflate'
+								
+				# Zlib is not capable of handling < 9 window bits.
+				MINIMUM_WINDOW_BITS = 9
+			end
+		end
+	end
+end

data/lib/protocol/websocket/extension/compression/deflate.rb

@@ -18,24 +18,26 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require 'zlib'
+require_relative 'constants'
 
 module Protocol
 	module WebSocket
 		module Extension
 			module Compression
 				class Deflate
-					def self.client(parent, client_window_bits: 15, client_no_context_takeover: false, **options)
+					# Client writing to server.
+					def self.client(parent, client_max_window_bits: 15, client_no_context_takeover: false, **options)
 						self.new(parent,
-							window_bits: client_window_bits,
+							window_bits: client_max_window_bits,
 							context_takeover: !client_no_context_takeover,
 							**options
 						)
 					end
 					
-					def self.server(parent, server_window_bits: 15, server_no_context_takeover: false, **options)
+					# Server writing to client.
+					def self.server(parent, server_max_window_bits: 15, server_no_context_takeover: false, **options)
 						self.new(parent,
-							window_bits: server_window_bits,
+							window_bits: server_max_window_bits,
 							context_takeover: !server_no_context_takeover,
 							**options
 						)
@@ -46,28 +48,39 @@ module Protocol
 						
 						@deflate = nil
 						
-						@compression_level = level
+						@level = level
 						@memory_level = memory_level
 						@strategy = strategy
 						
+						if window_bits < MINIMUM_WINDOW_BITS
+							window_bits = MINIMUM_WINDOW_BITS
+						end
+						
 						@window_bits = window_bits
 						@context_takeover = context_takeover
 					end
 					
-					def text_message(buffer, compress: true, **options)
+					def inspect
+						"#<#{self.class} window_bits=#{@window_bits} context_takeover=#{@context_takeover}>"
+					end
+					
+					attr :window_bits
+					attr :context_takeover
+					
+					def pack_text_frame(buffer, compress: true, **options)
 						buffer = self.deflate(buffer)
 						
-						frame = @parent.text_message(buffer, **options)
+						frame = @parent.pack_text_frame(buffer, **options)
 						
 						frame.flags |= Frame::RSV1
 						
 						return frame
 					end
 					
-					def binary_message(buffer, compress: false, **options)
-						message = self.deflate(buffer)
+					def pack_binary_frame(buffer, compress: false, **options)
+						buffer = self.deflate(buffer)
 						
-						frame = parent.binary_message(buffer, **options)
+						frame = @parent.pack_binary_frame(buffer, **options)
 						
 						frame.flags |= Frame::RSV1
 						
@@ -77,14 +90,13 @@ module Protocol
 					private
 					
 					def deflate(buffer)
-						Console.logger.info(self, "Deflating #{buffer.size} bytes")
 						deflate = @deflate || Zlib::Deflate.new(@level, -@window_bits, @memory_level, @strategy)
 						
 						if @context_takeover
 							@deflate = deflate
 						end
 						
-						return @deflate.deflate(buffer, Zlib::SYNC_FLUSH)[0...-4]
+						return deflate.deflate(buffer, Zlib::SYNC_FLUSH)[0...-4]
 					end
 				end
 			end

data/lib/protocol/websocket/extension/compression/inflate.rb

@@ -18,26 +18,26 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require 'zlib'
+require_relative 'constants'
 
 module Protocol
 	module WebSocket
 		module Extension
 			module Compression
 				class Inflate
-					def self.client(parent, client_window_bits: 15, client_no_context_takeover: false, **options)
+					# Client reading from server.
+					def self.client(parent, server_max_window_bits: 15, server_no_context_takeover: false, **options)
 						self.new(parent,
-							window_bits: client_window_bits,
-							context_takeover: !client_no_context_takeover,
-							**options
+							window_bits: server_max_window_bits,
+							context_takeover: !server_no_context_takeover,
 						)
 					end
 					
-					def self.server(parent, server_window_bits: 15, server_no_context_takeover: false, **options)
+					# Server reading from client.
+					def self.server(parent, client_max_window_bits: 15, client_no_context_takeover: false, **options)
 						self.new(parent,
-							window_bits: server_window_bits,
-							context_takeover: !server_no_context_takeover,
-							**options
+							window_bits: client_max_window_bits,
+							context_takeover: !client_no_context_takeover,
 						)
 					end
 					
@@ -48,12 +48,19 @@ module Protocol
 						
 						@inflate = nil
 						
+						if window_bits < MINIMUM_WINDOW_BITS
+							window_bits = MINIMUM_WINDOW_BITS
+						end
+						
 						@window_bits = window_bits
 						@context_takeover = context_takeover
 					end
 					
-					def read_message(frames, **options)
-						buffer = @parent.read_message(frames, **options)
+					attr :window_bits
+					attr :context_takeover
+					
+					def unpack_frames(frames, **options)
+						buffer = @parent.unpack_frames(frames, **options)
 						
 						frame = frames.first
 						
@@ -69,7 +76,6 @@ module Protocol
 					private
 					
 					def inflate(buffer)
-						Console.logger.info(self, "Inflating #{buffer.bytesize} bytes")
 						inflate = @inflate || Zlib::Inflate.new(-@window_bits)
 						
 						if @context_takeover

data/lib/protocol/websocket/extension/compression.rb

@@ -18,7 +18,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require 'zlib'
+require_relative 'compression/constants'
 require_relative 'compression/inflate'
 require_relative 'compression/deflate'
 
@@ -26,17 +26,15 @@ module Protocol
 	module WebSocket
 		module Extension
 			module Compression
-				NAME = 'permessage-deflate'
-				
 				# Client offer to server, construct a list of requested compression parameters suitable for the `Sec-WebSocket-Extensions` header.
 				# @returns [Array(String)] a list of compression parameters suitable to send to the server.
-				def self.offer(client_window_bits: true, server_window_bits: true, client_no_context_takeover: false, server_no_context_takeover: false)
+				def self.offer(client_max_window_bits: true, server_max_window_bits: true, client_no_context_takeover: false, server_no_context_takeover: false)
 					
 					header = [NAME]
 					
-					case client_window_bits
+					case client_max_window_bits
 					when 8..15
-						header << "client_max_window_bits=#{client_window_bits}"
+						header << "client_max_window_bits=#{client_max_window_bits}"
 					when true
 						header << 'client_max_window_bits'
 					else
@@ -47,9 +45,9 @@ module Protocol
 						header << 'client_no_context_takeover'
 					end
 					
-					case server_window_bits
+					case server_max_window_bits
 					when 8..15
-						header << "server_max_window_bits=#{server_window_bits}"
+						header << "server_max_window_bits=#{server_max_window_bits}"
 					when true
 						# Default (unspecified) to the server maximum window bits.
 					else
@@ -72,22 +70,28 @@ module Protocol
 					arguments.each do |key, value|
 						case key
 						when "server_no_context_takeover"
-							options[:server_no_context_takeover] = false
+							options[:server_no_context_takeover] = true
 							header << key
 						when "client_no_context_takeover"
-							options[:client_no_context_takeover] = false
+							options[:client_no_context_takeover] = true
 							header << key
 						when "server_max_window_bits"
-							options[:server_max_window_bits] = Integer(value || 15)
+							value = Integer(value || 15)
+							value = MINIMUM_WINDOW_BITS if value < MINIMUM_WINDOW_BITS
+							options[:server_max_window_bits] = value
+							header << "server_max_window_bits=#{value}"
 						when "client_max_window_bits"
-							options[:client_max_window_bits] = Integer(value || 15)
+							value = Integer(value || 15)
+							value = MINIMUM_WINDOW_BITS if value < MINIMUM_WINDOW_BITS
+							options[:client_max_window_bits] = value
+							header << "client_max_window_bits=#{value}"
 						else
 							raise ArgumentError, "Unknown option #{key}!"
 						end
 					end
 					
 					# The header which represents the final accepted/negotiated configuration.
-					return header
+					return header, options
 				end
 				
 				# @parameter options [Hash] a hash of options which are accepted by the server.
@@ -105,9 +109,9 @@ module Protocol
 					arguments.each do |key, value|
 						case key
 						when "server_no_context_takeover"
-							options[:server_no_context_takeover] = false
+							options[:server_no_context_takeover] = true
 						when "client_no_context_takeover"
-							options[:client_no_context_takeover] = false
+							options[:client_no_context_takeover] = true
 						when "server_max_window_bits"
 							options[:server_max_window_bits] = Integer(value || 15)
 						when "client_max_window_bits"
@@ -116,6 +120,8 @@ module Protocol
 							raise ArgumentError, "Unknown option #{key}!"
 						end
 					end
+					
+					return options
 				end
 				
 				# @parameter options [Hash] a hash of options which are accepted by the client.

data/lib/protocol/websocket/extensions.rb

@@ -75,7 +75,7 @@ module Protocol
 						if extension = named.delete(name)
 							klass, options = extension
 							
-							klass.accept(arguments, **options)
+							options = klass.accept(arguments, **options)
 							
 							@accepted << [klass, options]
 						end
@@ -84,7 +84,7 @@ module Protocol
 				
 				def apply(connection)
 					@accepted.each do |(klass, options)|
-						klass.server(connection, **options)
+						klass.client(connection, **options)
 					end
 				end
 			end
@@ -121,7 +121,9 @@ module Protocol
 						if extension = named[name]
 							klass, options = extension
 							
-							if header = klass.negotiate(arguments, **options)
+							if result = klass.negotiate(arguments, **options)
+								header, options = result
+								
 								# The extension is accepted and no further offers will be considered:
 								named.delete(name)
 								

data/lib/protocol/websocket/message.rb

@@ -0,0 +1,61 @@
+# Copyright, 2022, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require_relative 'frame'
+
+module Protocol
+	module WebSocket
+		class Message
+			def initialize(buffer)
+				@buffer = buffer
+			end
+			
+			attr :buffer
+			
+			def size
+				@buffer.bytesize
+			end
+			
+			def == other
+				@buffer == other
+			end
+			
+			def to_str
+				@buffer
+			end
+			
+			def encoding
+				@buffer.encoding
+			end
+		end
+		
+		class TextMessage < Message
+			def send(connection, **options)
+				connection.send_text(@buffer, **options)
+			end
+		end
+		
+		class BinaryMessage < Message
+			def send(connection, **options)
+				connection.send_binary(@buffer, **options)
+			end
+		end
+	end
+end

data/lib/protocol/websocket/text_frame.rb

@@ -19,6 +19,7 @@
 # THE SOFTWARE.
 
 require_relative 'frame'
+require_relative 'message'
 
 module Protocol
 	module WebSocket
@@ -39,7 +40,7 @@ module Protocol
 					raise ProtocolError, "invalid UTF-8 in text frame!"
 				end
 				
-				buffer
+				return TextMessage.new(buffer)
 			end
 			
 			# Apply this frame to the specified connection.

data/lib/protocol/websocket/version.rb

@@ -20,6 +20,6 @@
 
 module Protocol
 	module WebSocket
-		VERSION = "0.8.0"
+		VERSION = "0.9.0"
 	end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: protocol-websocket
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -41,7 +41,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2022-08-20 00:00:00.000000000 Z
+date: 2022-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: protocol-http
@@ -100,25 +100,27 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: sus
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 0.9.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 0.9.1
 description:
 email:
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/.DS_Store
+- lib/protocol/.DS_Store
 - lib/protocol/websocket.rb
 - lib/protocol/websocket/binary_frame.rb
 - lib/protocol/websocket/close_frame.rb
@@ -126,6 +128,7 @@ files:
 - lib/protocol/websocket/continuation_frame.rb
 - lib/protocol/websocket/error.rb
 - lib/protocol/websocket/extension/compression.rb
+- lib/protocol/websocket/extension/compression/constants.rb
 - lib/protocol/websocket/extension/compression/deflate.rb
 - lib/protocol/websocket/extension/compression/inflate.rb
 - lib/protocol/websocket/extensions.md
@@ -133,6 +136,7 @@ files:
 - lib/protocol/websocket/frame.rb
 - lib/protocol/websocket/framer.rb
 - lib/protocol/websocket/headers.rb
+- lib/protocol/websocket/message.rb
 - lib/protocol/websocket/ping_frame.rb
 - lib/protocol/websocket/pong_frame.rb
 - lib/protocol/websocket/text_frame.rb