protocol-websocket 0.13.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c93940911ada80aa95de9bf5a1412dd20248a77855f4b9bd523a06b699294795
-  data.tar.gz: f7fd77275a0d1269e3586e56b08f18f2e10f18c816085e8bea7de95da4d282b0
+  metadata.gz: ec6ec828408c7579273d456c0a9ce582a794757b5c532e228c45eca4779acee1
+  data.tar.gz: 5abe7c8dcb8e1e5cd64e62e06cb0f7585ec0fa8646baf4cecaa6945542cf8b33
 SHA512:
-  metadata.gz: 2d54e303617a6ff069bf7ee5e8cb5539c3217bfa0613e2290203edca66695ad926ff40959c2edf694a82b05485a403ec96bedccf76587ae47e3107ff8ccd49ec
-  data.tar.gz: 8d07512b928d9060af02945caf8cc1680154f220c4f741ee23fc9520f5d8e3f1ae99470aa28d390b9c9611de667eed0e6c58ffb59b705d356b117a51fc3908ee
+  metadata.gz: e5daf9a48e29e811b255516dd777fafbbdf084c8ed681d81ebe2fc67eead205702186b42231abfa032060afc62d439a2e6c8c90d1696eec58be37c40cf52d2a9
+  data.tar.gz: 6dc89a62a3179b9e2d397cac57204a5d73897ada519abba42d3f85ec184c6f74c1c2f26d81b2ef5277c0fa4b17c35cf283019f99e9a01537d32fece66c76db2b

data/lib/protocol/websocket/binary_frame.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2023, by Samuel Williams.
+# Copyright, 2019-2024, by Samuel Williams.
 # Copyright, 2021, by Aurora Nockert.
 
 require_relative 'frame'
@@ -9,17 +9,22 @@ require_relative 'message'
 
 module Protocol
 	module WebSocket
+		# Represents a binary frame that is sent or received by a WebSocket connection.
 		class BinaryFrame < Frame
 			OPCODE = 0x2
 			
+			# @returns [Boolean] if the frame contains data.
 			def data?
 				true
 			end
 			
+			# Decode the binary buffer into a suitable binary message.
+			# @parameter buffer [String] The binary data to unpack.
 			def read_message(buffer)
 				return BinaryMessage.new(buffer)
 			end
 			
+			# Apply this frame to the specified connection.
 			def apply(connection)
 				connection.receive_binary(self)
 			end

data/lib/protocol/websocket/close_frame.rb

@@ -1,17 +1,20 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2023, by Samuel Williams.
+# Copyright, 2019-2024, by Samuel Williams.
 # Copyright, 2021, by Aurora Nockert.
 
 require_relative 'frame'
 
 module Protocol
 	module WebSocket
+		# Represents a close frame that is sent or received by a WebSocket connection.
 		class CloseFrame < Frame
 			OPCODE = 0x8
 			FORMAT = "na*"
 			
+			# Unpack the frame data into a close code and reason.
+			# @returns [Tuple(Integer, String)] The close code and reason.
 			def unpack
 				data = super
 				
@@ -40,7 +43,10 @@ module Protocol
 				end
 			end
 			
+			# Pack a close code and reason into the frame data.
 			# If code is missing, reason is ignored.
+			# @parameter code [Integer | Nil] The close code.
+			# @parameter reason [String | Nil] The close reason.
 			def pack(code = nil, reason = nil)
 				if code
 					if reason and reason.encoding != Encoding::UTF_8
@@ -53,6 +59,7 @@ module Protocol
 				end
 			end
 			
+			# Apply this frame to the specified connection.
 			def apply(connection)
 				connection.receive_close(self)
 			end

data/lib/protocol/websocket/coder/json.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2024, by Samuel Williams.
+
+require 'json'
+
+module Protocol
+	module WebSocket
+		module Coder
+			# A JSON coder that uses the standard JSON library.
+			class JSON
+				def initialize(**options)
+					@options = options
+				end
+				
+				# Parse a JSON buffer into an object.
+				def parse(buffer)
+					::JSON.parse(buffer, **@options)
+				end
+				
+				# Generate a JSON buffer from an object.
+				def generate(object)
+					::JSON.generate(object, **@options)
+				end
+				
+				# The default JSON coder. This coder will symbolize names.
+				DEFAULT = new(symbolize_names: true)
+			end
+		end
+	end
+end

data/lib/protocol/websocket/coder.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2024, by Samuel Williams.
+
+require_relative 'coder/json'
+
+module Protocol
+	module WebSocket
+		module Coder
+			# The default coder for WebSocket messages.
+			DEFAULT = JSON::DEFAULT
+		end
+	end
+end

data/lib/protocol/websocket/connection.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2023, by Samuel Williams.
+# Copyright, 2019-2024, by Samuel Williams.
 # Copyright, 2019, by William T. Nelson.
 # Copyright, 2021, by Aurora Nockert.
 
@@ -26,21 +26,26 @@ module Protocol
 				@writer = self
 			end
 			
-			# The framer which is used for reading and writing frames.
+			# @attribute [Framer] The framer which is used for reading and writing frames.
 			attr :framer
 			
-			# The (optional) mask which is used when generating frames.
+			# @attribte [String | Nil] The optional mask which is used when generating frames.
 			attr :mask
 			
-			# The allowed reserved bits:
+			# @attribute [Integer] The allowed reserved bits.
 			attr :reserved
 			
-			# Buffered frames which form part of a complete message.
+			# @attribute [Array(Frame)] Buffered frames which form part of a complete message.
 			attr_accessor :frames
 			
+			# @attribute [Object] The reader which is used to unpack frames into messages.
 			attr_accessor :reader
+			
+			# @attribute [Object] The writer which is used to pack messages into frames.
 			attr_accessor :writer
 			
+			# Reserve a bit in the reserved flags for an extension.
+			# @parameter bit [Integer] The bit to reserve, see {Frame::RESERVED} for more details.
 			def reserve!(bit)
 				if (@reserved & bit).zero?
 					raise ArgumentError, "Unable to use #{bit}!"
@@ -51,10 +56,12 @@ module Protocol
 				return true
 			end
 			
+			# Flush the underlying framer to ensure all buffered data is written to the connection.
 			def flush
 				@framer.flush
 			end
 			
+			# Transition the connection to the open state (the default for new connections).
 			def open!
 				@state = :open
 				
@@ -62,6 +69,7 @@ module Protocol
 			end
 			
 			# If not already closed, transition the connection to the closed state and send a close frame.
+			# Will try to send a close frame with the specified code and reason, but will ignore any errors that occur while sending.
 			def close!(...)
 				unless @state == :closed
 					@state = :closed
@@ -76,17 +84,19 @@ module Protocol
 				return self
 			end
 			
+			# @returns [Boolean] if the connection is in the closed state.
 			def closed?
 				@state == :closed
 			end
 			
-			# Immediately transition the connection to the closed state and close the underlying connection.
+			# Immediately transition the connection to the closed state *and* close the underlying connection.
 			def close(...)
 				close!(...)
 				
 				@framer.close
 			end
 			
+			# Read a frame from the framer, and apply it to the connection.
 			def read_frame
 				return nil if closed?
 				
@@ -109,12 +119,15 @@ module Protocol
 				raise
 			end
 			
+			# Write a frame to the framer.
+			# Note: This does not immediately write the frame to the connection, you must call {#flush} to ensure the frame is written.
 			def write_frame(frame)
 				@framer.write_frame(frame)
 				
 				return frame
 			end
 			
+			# Receive a text frame from the connection.
 			def receive_text(frame)
 				if @frames.empty?
 					@frames << frame
@@ -123,6 +136,7 @@ module Protocol
 				end
 			end
 			
+			# Receive a binary frame for the connection.
 			def receive_binary(frame)
 				if @frames.empty?
 					@frames << frame
@@ -131,6 +145,7 @@ module Protocol
 				end
 			end
 			
+			# Receive a continuation frame for the connection.
 			def receive_continuation(frame)
 				if @frames.any?
 					@frames << frame
@@ -138,7 +153,8 @@ module Protocol
 					raise ProtocolError, "Received unexpected continuation!"
 				end
 			end
-					
+			
+			# Receive a close frame from the connection.
 			def receive_close(frame)
 				code, reason = frame.unpack
 				
@@ -150,6 +166,8 @@ module Protocol
 				end
 			end
 			
+			# Send a ping frame with the specified data.
+			# @parameter data [String] The data to send in the ping frame.
 			def send_ping(data = "")
 				if @state != :closed
 					frame = PingFrame.new(mask: @mask)
@@ -161,6 +179,7 @@ module Protocol
 				end
 			end
 			
+			# Receive a ping frame from the connection.
 			def receive_ping(frame)
 				if @state != :closed
 					write_frame(frame.reply(mask: @mask))
@@ -169,14 +188,19 @@ module Protocol
 				end
 			end
 			
+			# Receive a pong frame from the connection. By default, this method does nothing.
 			def receive_pong(frame)
 				# Ignore.
 			end
 			
+			# Receive a frame that is not a control frame. By default, this method raises a {ProtocolError}.
 			def receive_frame(frame)
 				raise ProtocolError, "Unhandled frame: #{frame}"
 			end
 			
+			# Pack a text frame with the specified buffer. This is used by the {#writer} interface.
+			# @parameter buffer [String] The text to pack into the frame.
+			# @returns [TextFrame] The packed frame.
 			def pack_text_frame(buffer, **options)
 				frame = TextFrame.new(mask: @mask)
 				frame.pack(buffer)
@@ -184,10 +208,15 @@ module Protocol
 				return frame
 			end
 			
+			# Send a text frame with the specified buffer.
+			# @parameter buffer [String] The text to send.
 			def send_text(buffer, **options)
 				write_frame(@writer.pack_text_frame(buffer, **options))
 			end
 			
+			# Pack a binary frame with the specified buffer. This is used by the {#writer} interface.
+			# @parameter buffer [String] The binary data to pack into the frame.
+			# @returns [BinaryFrame] The packed frame.
 			def pack_binary_frame(buffer, **options)
 				frame = BinaryFrame.new(mask: @mask)
 				frame.pack(buffer)
@@ -195,11 +224,15 @@ module Protocol
 				return frame
 			end
 			
+			# Send a binary frame with the specified buffer.
+			# @parameter buffer [String] The binary data to send.
 			def send_binary(buffer, **options)
 				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.
+			# @parameter code [Integer] The close code to send.
+			# @parameter reason [String] The reason for closing the connection.
 			def send_close(code = Error::NO_ERROR, reason = "")
 				frame = CloseFrame.new(mask: @mask)
 				frame.pack(code, reason)
@@ -223,12 +256,15 @@ module Protocol
 				message.send(self, **options)
 			end
 			
-			# The default implementation for reading a message buffer.
+			# The default implementation for reading a message buffer. This is used by the {#reader} interface.
 			def unpack_frames(frames)
 				frames.map(&:unpack).join("")
 			end
 			
-			# Read a message from the connection.
+			# Read a message from the connection. If an error occurs while reading the message, the connection will be closed.
+			#
+			# If the message is fragmented, this method will buffer the frames until a complete message is received.
+			#
 			# @returns message [Message] The received message.
 			def read(**options)
 				@framer.flush

data/lib/protocol/websocket/continuation_frame.rb

@@ -1,15 +1,17 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2023, by Samuel Williams.
+# Copyright, 2019-2024, by Samuel Williams.
 
 require_relative 'frame'
 
 module Protocol
 	module WebSocket
+		# Represents a continuation frame that is sent or received by a WebSocket connection when a message is split into multiple frames.
 		class ContinuationFrame < Frame
 			OPCODE = 0x0
 			
+			# Apply this frame to the specified connection.
 			def apply(connection)
 				connection.receive_continuation(self)
 			end

data/lib/protocol/websocket/error.rb

@@ -1,12 +1,13 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2023, by Samuel Williams.
+# Copyright, 2019-2024, by Samuel Williams.
 
 require 'protocol/http/error'
 
 module Protocol
 	module WebSocket
+		# Represents an error that occurred during the WebSocket protocol negotiation or communication.
 		# Status codes as defined by <https://tools.ietf.org/html/rfc6455#section-7.4.1>.
 		class Error < HTTP::Error
 			# Indicates a normal closure, meaning that the purpose for which the connection was established has been fulfilled.
@@ -24,9 +25,7 @@ module Protocol
 			# There are other status codes but most of them are "implementation specific".
 		end
 		
-		# Raised by stream or connection handlers, results in GOAWAY frame
-		# which signals termination of the current connection. You *cannot*
-		# recover from this exception, or any exceptions subclassed from it.
+		# Raised by stream or connection handlers, results in GOAWAY frame which signals termination of the current connection. You *cannot* recover from this exception, or any exceptions subclassed from it.
 		class ProtocolError < Error
 			def initialize(message, code = PROTOCOL_ERROR)
 				super(message)
@@ -34,6 +33,7 @@ module Protocol
 				@code = code
 			end
 			
+			# @attribute [Integer] The status code associated with the error.
 			attr :code
 		end
 		

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2022-2023, by Samuel Williams.
+# Copyright, 2022-2024, by Samuel Williams.
 
 require_relative 'compression/constants'
 require_relative 'compression/inflate'
@@ -10,6 +10,7 @@ require_relative 'compression/deflate'
 module Protocol
 	module WebSocket
 		module Extension
+			# Provides support for the permessage-deflate extension.
 			module Compression
 				# 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.

data/lib/protocol/websocket/extensions.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2022-2023, by Samuel Williams.
+# Copyright, 2022-2024, by Samuel Williams.
 
 require_relative 'extension/compression'
 require_relative 'headers'
@@ -65,6 +65,8 @@ module Protocol
 							@accepted << [klass, options]
 						end
 					end
+					
+					return @accepted
 				end
 				
 				def apply(connection)
@@ -112,14 +114,14 @@ module Protocol
 								# The extension is accepted and no further offers will be considered:
 								named.delete(name)
 								
-								yield header
+								yield header if block_given?
 								
 								@accepted << [klass, options]
 							end
 						end
 					end
 					
-					return headers
+					return @accepted
 				end
 				
 				def apply(connection)

data/lib/protocol/websocket/frame.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2023, by Samuel Williams.
+# Copyright, 2019-2024, by Samuel Williams.
 # Copyright, 2019, by Soumya.
 # Copyright, 2021, by Aurora Nockert.
 
@@ -50,6 +50,7 @@ module Protocol
 				@opcode & 0x8 != 0
 			end
 			
+			# @returns [Boolean] if the frame contains data.
 			def data?
 				false
 			end

data/lib/protocol/websocket/framer.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2023, by Samuel Williams.
+# Copyright, 2019-2024, by Samuel Williams.
 
 require_relative 'frame'
 
@@ -34,16 +34,18 @@ module Protocol
 				@frames = frames
 			end
 			
+			# Close the underlying stream.
 			def close
 				@stream.close
 			end
 			
+			# Flush the underlying stream.
 			def flush
 				@stream.flush
 			end
 			
 			# Read a frame from the underlying stream.
-			# @returns [Frame] 
+			# @returns [Frame] the frame read from the stream.
 			def read_frame(maximum_frame_size = MAXIMUM_ALLOWED_FRAME_SIZE)
 				# Read the header:
 				finished, flags, opcode = read_header
@@ -55,10 +57,12 @@ module Protocol
 				return frame
 			end
 			
+			# Write a frame to the underlying stream.
 			def write_frame(frame)
 				frame.write(@stream)
 			end
 			
+			# Read the header of the frame.
 			def read_header
 				if buffer = @stream.read(1) and buffer.bytesize == 1
 					return Frame.parse_header(buffer)

data/lib/protocol/websocket/json_message.rb

@@ -1,32 +1,23 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2022-2023, by Samuel Williams.
-
-require 'json'
+# Copyright, 2022-2024, by Samuel Williams.
 
 require_relative 'message'
 
+warn "Protocol::WebSocket::JSONMessage is deprecated. Use Protocol::WebSocket::TextMessage instead."
+
 module Protocol
 	module WebSocket
+		# @deprecated Use {TextMessage} instead.
 		class JSONMessage < TextMessage
 			def self.wrap(message)
-				if message.is_a?(TextMessage)
-					self.new(message.buffer)
-				end
+				message
 			end
 			
 			def self.generate(object)
 				self.new(JSON.generate(object))
 			end
-			
-			def parse(symbolize_names: true, **options)
-				JSON.parse(@buffer, symbolize_names: symbolize_names, **options)
-			end
-			
-			def to_h
-				parse.to_h
-			end
 		end
 	end
 end

data/lib/protocol/websocket/message.rb

@@ -1,43 +1,71 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2022-2023, by Samuel Williams.
+# Copyright, 2022-2024, by Samuel Williams.
 
 require_relative 'frame'
+require_relative 'coder'
 
 module Protocol
 	module WebSocket
+		# Represents a message that can be sent or received over a WebSocket connection.
 		class Message
+			# Create a new message from a buffer.
+			# @attribute buffer [String] The message buffer.
 			def initialize(buffer)
 				@buffer = buffer
 			end
 			
+			# @attribute [String] The message buffer.
 			attr :buffer
 			
+			# @returns [Integer] The size of the message buffer.
 			def size
 				@buffer.bytesize
 			end
 			
-			# This can be helpful for writing tests.
+			# Compare this message to another message or buffer.
 			def == other
 				@buffer == other.to_str
 			end
 			
+			# A message is implicitly convertible to it's buffer.
 			def to_str
 				@buffer
 			end
 			
+			# The encoding of the message buffer.
+			# @returns [Encoding]
 			def encoding
 				@buffer.encoding
 			end
+			
+			# Generate a message from a value using the given coder.
+			# @property value [Object] The value to encode.
+			# @property coder [Coder] The coder to use. Defaults to JSON.
+			def self.generate(value, coder = Coder::DEFAULT)
+				new(coder.generate(value))
+			end
+			
+			# Parse the message buffer using the given coder. Defaults to JSON.
+			def parse(coder = Coder::DEFAULT)
+				coder.parse(@buffer)
+			end
+			
+			# Convert the message buffer to a hash using the given coder. Defaults to JSON.
+			def to_h(...)
+				parse(...).to_h
+			end
 		end
 		
+		# Represents a text message that can be sent or received over a WebSocket connection.
 		class TextMessage < Message
 			def send(connection, **options)
 				connection.send_text(@buffer, **options)
 			end
 		end
 		
+		# Represents a binary message that can be sent or received over a WebSocket connection.
 		class BinaryMessage < Message
 			def send(connection, **options)
 				connection.send_binary(@buffer, **options)

data/lib/protocol/websocket/ping_frame.rb

@@ -1,13 +1,14 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2023, by Samuel Williams.
+# Copyright, 2019-2024, by Samuel Williams.
 
 require_relative 'frame'
 require_relative 'pong_frame'
 
 module Protocol
 	module WebSocket
+		# Represents a ping frame that is sent or received by a WebSocket connection.
 		class PingFrame < Frame
 			OPCODE = 0x9
 			

data/lib/protocol/websocket/pong_frame.rb

@@ -1,12 +1,13 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2023, by Samuel Williams.
+# Copyright, 2019-2024, by Samuel Williams.
 
 require_relative 'frame'
 
 module Protocol
 	module WebSocket
+		# Represents a pong frame that is sent or received by a WebSocket connection.
 		class PongFrame < Frame
 			OPCODE = 0xA
 			

data/lib/protocol/websocket/text_frame.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2023, by Samuel Williams.
+# Copyright, 2019-2024, by Samuel Williams.
 # Copyright, 2021, by Aurora Nockert.
 
 require_relative 'frame'
@@ -9,10 +9,11 @@ require_relative 'message'
 
 module Protocol
 	module WebSocket
-		# Implements the text frame for sending and receiving text.
+		# Represents a text frame that is sent or received by a WebSocket connection.
 		class TextFrame < Frame
 			OPCODE = 0x1
 			
+			# @returns [Boolean] if the frame contains data.
 			def data?
 				true
 			end

data/lib/protocol/websocket/version.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2023, by Samuel Williams.
+# Copyright, 2019-2024, by Samuel Williams.
 
 module Protocol
 	module WebSocket
-		VERSION = "0.13.0"
+		VERSION = "0.15.0"
 	end
 end

data/lib/protocol/websocket.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2023, by Samuel Williams.
+# Copyright, 2019-2024, by Samuel Williams.
 
 require_relative 'websocket/version'
 require_relative 'websocket/framer'
 require_relative 'websocket/connection'
+require_relative 'websocket/message'

data/readme.md

@@ -6,7 +6,11 @@ Provides a low-level implementation of the WebSocket protocol according to [RFC6
 
 ## Usage
 
-Please see the [project documentation](https://socketry.github.io/protocol-websocket).
+Please see the [project documentation](https://socketry.github.io/protocol-websocket/) for more details.
+
+  - [Getting Started](https://socketry.github.io/protocol-websocket/guides/getting-started/index) - This guide explains how to use `protocol-websocket` for implementing a websocket client and server.
+
+  - [Extensions](https://socketry.github.io/protocol-websocket/guides/extensions/index) - This guide explains how to use `protocol-websocket` for implementing a websocket client and server using extensions.
 
 ## Contributing
 
@@ -20,8 +24,8 @@ We welcome contributions to this project.
 
 ### Developer Certificate of Origin
 
-This project uses the [Developer Certificate of Origin](https://developercertificate.org/). All contributors to this project must agree to this document to have their contributions accepted.
+In order to protect users of this project, we require all contributors to comply with the [Developer Certificate of Origin](https://developercertificate.org/). This ensures that all contributions are properly licensed and attributed.
 
-### Contributor Covenant
+### Community Guidelines
 
-This project is governed by the [Contributor Covenant](https://www.contributor-covenant.org/). All contributors and participants agree to abide by its terms.
+This project is best served by a collaborative and respectful environment. Treat each other professionally, respect differing viewpoints, and engage constructively. Harassment, discrimination, or harmful behavior is not tolerated. Communicate clearly, listen actively, and support one another. If any issues arise, please inform the project maintainers.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: protocol-websocket
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -41,7 +41,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-05-17 00:00:00.000000000 Z
+date: 2024-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: protocol-http
@@ -66,6 +66,8 @@ files:
 - lib/protocol/websocket.rb
 - lib/protocol/websocket/binary_frame.rb
 - lib/protocol/websocket/close_frame.rb
+- lib/protocol/websocket/coder.rb
+- lib/protocol/websocket/coder/json.rb
 - lib/protocol/websocket/connection.rb
 - lib/protocol/websocket/continuation_frame.rb
 - lib/protocol/websocket/error.rb
@@ -73,7 +75,6 @@ files:
 - 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
 - lib/protocol/websocket/extensions.rb
 - lib/protocol/websocket/frame.rb
 - lib/protocol/websocket/framer.rb
@@ -107,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: A low level implementation of the WebSocket protocol.

data/lib/protocol/websocket/extensions.md

@@ -1,13 +0,0 @@
-# Extensions
-
-WebSockets have a mechanism for implementing extensions. The only published extension is for per-message compression. It operates on complete messages rather than individual frames.
-
-## Setup
-
-Clients need to define a set of extensions they want to support. The server then receives this via the `Sec-WebSocket-Extensions` header which includes a list of:
-
-	Name, Options
-
-The server processes this and returns a subset of accepted `(Name, Options)`. It also instantiates the extensions and applies them to the server connection object.
-
-The client receives a list of accepted `(Name, Options)` and instantiates the extensions and applies them to the client connection object.