protocol-websocket 0.17.0 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c565e42a63322140910616237842446c9faf392325569500454cff2bcfe500d
-  data.tar.gz: db2129c90eb70609ef3b14f62c5a8f261cca9d4e5796be21c15ed24f545f3a19
+  metadata.gz: a0ce7a7a66a43bf2fd5ec0af4a6050feb443adb076b75b2d3037cccbd9012fa4
+  data.tar.gz: c672fa5bca423ca23f0b9d608d6a6e89058eaca979d939ad4e01c606b51175ed
 SHA512:
-  metadata.gz: 68c058f51adbcadb882cfd139bc88a0dbdb0d1024d3c7cc62794796e83ab730340b72289f505f5fcd1d213cda0901f4b16aaee42c899c25ffca57e3baa057078
-  data.tar.gz: 80121ca724e4f275a88479d4778aa35070b0ddc62660ad4acda47247a1ed7461137a5227e65ea8c3569120a0bf98ff0c0a24b33039d4cf67602b825c2289891a
+  metadata.gz: 598365c3df8b46fb6e79668a8d8bb452eb1e973f04f31c16346a391884448bda2d2869a6affcb2a3513a5b2dc6fab66e110f7eaebfe2593f9a50eb0bc624eb46
+  data.tar.gz: 4fadd3a84c98f07fbbae57a766178f85d1042500c8403e944992a3f118180c8d9952e5997c963cd26c5e843bf0e45802f2da1372a94288989ce5e1578eca0aba

data/lib/protocol/websocket/binary_frame.rb

@@ -4,8 +4,8 @@
 # Copyright, 2019-2024, by Samuel Williams.
 # Copyright, 2021, by Aurora Nockert.
 
-require_relative 'frame'
-require_relative 'message'
+require_relative "frame"
+require_relative "message"
 
 module Protocol
 	module WebSocket

data/lib/protocol/websocket/close_frame.rb

@@ -4,7 +4,7 @@
 # Copyright, 2019-2024, by Samuel Williams.
 # Copyright, 2021, by Aurora Nockert.
 
-require_relative 'frame'
+require_relative "frame"
 
 module Protocol
 	module WebSocket

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

@@ -3,7 +3,7 @@
 # Released under the MIT License.
 # Copyright, 2024, by Samuel Williams.
 
-require 'json'
+require "json"
 
 module Protocol
 	module WebSocket

data/lib/protocol/websocket/coder.rb

@@ -3,7 +3,7 @@
 # Released under the MIT License.
 # Copyright, 2024, by Samuel Williams.
 
-require_relative 'coder/json'
+require_relative "coder/json"
 
 module Protocol
 	module WebSocket

data/lib/protocol/websocket/connection.rb

@@ -5,8 +5,7 @@
 # Copyright, 2019, by William T. Nelson.
 # Copyright, 2021, by Aurora Nockert.
 
-require_relative 'framer'
-require 'securerandom'
+require_relative "framer"
 
 module Protocol
 	module WebSocket
@@ -267,7 +266,7 @@ module Protocol
 			def write(message, **options)
 				case message
 				when String
-				# This is a compatibility shim for the previous implementation. We may want to eventually deprecate this use case... or maybe it's convenient enough to leave it around.
+					# This is a compatibility shim for the previous implementation. We may want to eventually deprecate this use case... or maybe it's convenient enough to leave it around.
 					if message.encoding == Encoding::UTF_8
 						return send_text(message, **options)
 					else

data/lib/protocol/websocket/continuation_frame.rb

@@ -3,7 +3,7 @@
 # Released under the MIT License.
 # Copyright, 2019-2024, by Samuel Williams.
 
-require_relative 'frame'
+require_relative "frame"
 
 module Protocol
 	module WebSocket

data/lib/protocol/websocket/error.rb

@@ -3,7 +3,7 @@
 # Released under the MIT License.
 # Copyright, 2019-2024, by Samuel Williams.
 
-require 'protocol/http/error'
+require "protocol/http/error"
 
 module Protocol
 	module WebSocket

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

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2022-2023, by Samuel Williams.
+# Copyright, 2022-2024, by Samuel Williams.
 
-require 'zlib'
+require "zlib"
 
 module Protocol
 	module WebSocket
 		module Extension
 			module Compression
-				NAME = 'permessage-deflate'
+				NAME = "permessage-deflate"
 								
 				# Zlib is not capable of handling < 9 window bits.
 				MINIMUM_WINDOW_BITS = 9

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

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2022-2023, by Samuel Williams.
+# Copyright, 2022-2024, by Samuel Williams.
 
-require_relative 'constants'
+require_relative "constants"
 
 module Protocol
 	module WebSocket

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

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2022-2023, by Samuel Williams.
+# Copyright, 2022-2024, by Samuel Williams.
 
-require_relative 'constants'
+require_relative "constants"
 
 module Protocol
 	module WebSocket
@@ -26,7 +26,7 @@ module Protocol
 						)
 					end
 					
-					TRAILER = [0x00, 0x00, 0xff, 0xff].pack('C*')
+					TRAILER = [0x00, 0x00, 0xff, 0xff].pack("C*")
 					
 					def initialize(parent, context_takeover: true, window_bits: 15)
 						@parent = parent

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

@@ -3,9 +3,9 @@
 # Released under the MIT License.
 # Copyright, 2022-2024, by Samuel Williams.
 
-require_relative 'compression/constants'
-require_relative 'compression/inflate'
-require_relative 'compression/deflate'
+require_relative "compression/constants"
+require_relative "compression/inflate"
+require_relative "compression/deflate"
 
 module Protocol
 	module WebSocket
@@ -22,13 +22,13 @@ module Protocol
 					when 8..15
 						header << "client_max_window_bits=#{client_max_window_bits}"
 					when true
-						header << 'client_max_window_bits'
+						header << "client_max_window_bits"
 					else
 						raise ArgumentError, "Invalid local maximum window bits!"
 					end
 					
 					if client_no_context_takeover
-						header << 'client_no_context_takeover'
+						header << "client_no_context_takeover"
 					end
 					
 					case server_max_window_bits
@@ -41,7 +41,7 @@ module Protocol
 					end
 					
 					if server_no_context_takeover
-						header << 'server_no_context_takeover'
+						header << "server_no_context_takeover"
 					end
 					
 					return header

data/lib/protocol/websocket/extensions.rb

@@ -3,8 +3,8 @@
 # Released under the MIT License.
 # Copyright, 2022-2024, by Samuel Williams.
 
-require_relative 'extension/compression'
-require_relative 'headers'
+require_relative "extension/compression"
+require_relative "headers"
 
 module Protocol
 	module WebSocket
@@ -16,7 +16,7 @@ module Protocol
 					name, *arguments = header.split(/\s*;\s*/)
 					
 					arguments = arguments.map do |argument|
-						argument.split('=', 2)
+						argument.split("=", 2)
 					end
 					
 					yield name, arguments

data/lib/protocol/websocket/frame.rb

@@ -5,7 +5,7 @@
 # Copyright, 2019, by Soumya.
 # Copyright, 2021, by Aurora Nockert.
 
-require_relative 'error'
+require_relative "error"
 
 module Protocol
 	module WebSocket
@@ -178,10 +178,10 @@ module Protocol
 				
 				if length == 126
 					buffer = stream.read(2) or raise EOFError, "Could not read length!"
-					length = buffer.unpack('n').first
+					length = buffer.unpack("n").first
 				elsif length == 127
 					buffer = stream.read(8) or raise EOFError, "Could not read length!"
-					length = buffer.unpack('Q>').first
+					length = buffer.unpack("Q>").first
 				end
 				
 				if length > maximum_frame_size
@@ -223,12 +223,12 @@ module Protocol
 				buffer << [
 					(@finished ? 0b1000_0000 : 0) | (@flags << 4) | @opcode,
 					(@mask ? 0b1000_0000 : 0) | short_length,
-				].pack('CC')
+				].pack("CC")
 				
 				if short_length == 126
-					buffer << [@length].pack('n')
+					buffer << [@length].pack("n")
 				elsif short_length == 127
-					buffer << [@length].pack('Q>')
+					buffer << [@length].pack("Q>")
 				end
 				
 				buffer << @mask if @mask

data/lib/protocol/websocket/framer.rb

@@ -3,14 +3,14 @@
 # Released under the MIT License.
 # Copyright, 2019-2024, by Samuel Williams.
 
-require_relative 'frame'
+require_relative "frame"
 
-require_relative 'continuation_frame'
-require_relative 'text_frame'
-require_relative 'binary_frame'
-require_relative 'close_frame'
-require_relative 'ping_frame'
-require_relative 'pong_frame'
+require_relative "continuation_frame"
+require_relative "text_frame"
+require_relative "binary_frame"
+require_relative "close_frame"
+require_relative "ping_frame"
+require_relative "pong_frame"
 
 module Protocol
 	module WebSocket

data/lib/protocol/websocket/headers.rb

@@ -1,27 +1,27 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2023, by Samuel Williams.
+# Copyright, 2019-2024, by Samuel Williams.
 
-require 'digest/sha1'
-require 'securerandom'
+require "digest/sha1"
+require "securerandom"
 
 module Protocol
 	module WebSocket
 		module Headers
 			# The protocol string used for the `upgrade:` header (HTTP/1) and `:protocol` pseudo-header (HTTP/2).
-			PROTOCOL = "websocket".freeze
+			PROTOCOL = "websocket"
 			
 			# The WebSocket protocol header, used for application level protocol negotiation.
-			SEC_WEBSOCKET_PROTOCOL = 'sec-websocket-protocol'.freeze
+			SEC_WEBSOCKET_PROTOCOL = "sec-websocket-protocol"
 			
 			# The WebSocket version header. Used for negotiating binary protocol version.
-			SEC_WEBSOCKET_VERSION = 'sec-websocket-version'.freeze
+			SEC_WEBSOCKET_VERSION = "sec-websocket-version"
 			
-			SEC_WEBSOCKET_KEY = 'sec-websocket-key'.freeze
-			SEC_WEBSOCKET_ACCEPT = 'sec-websocket-accept'.freeze
+			SEC_WEBSOCKET_KEY = "sec-websocket-key"
+			SEC_WEBSOCKET_ACCEPT = "sec-websocket-accept"
 			
-			SEC_WEBSOCKET_EXTENSIONS = 'sec-websocket-extensions'.freeze
+			SEC_WEBSOCKET_EXTENSIONS = "sec-websocket-extensions"
 			
 			module Nounce
 				GUID = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11"

data/lib/protocol/websocket/message.rb

@@ -3,8 +3,8 @@
 # Released under the MIT License.
 # Copyright, 2022-2024, by Samuel Williams.
 
-require_relative 'frame'
-require_relative 'coder'
+require_relative "frame"
+require_relative "coder"
 
 module Protocol
 	module WebSocket
@@ -12,7 +12,7 @@ module Protocol
 		class Message
 			# Create a new message from a buffer.
 			# @attribute buffer [String] The message buffer.
-			def initialize(buffer)
+			def initialize(buffer = "")
 				@buffer = buffer
 			end
 			
@@ -72,5 +72,12 @@ module Protocol
 				connection.send_binary(@buffer, **options)
 			end
 		end
+		
+		# Represents a ping message that can be sent over a WebSocket connection.
+		class PingMessage < Message
+			def send(connection)
+				connection.send_ping(@buffer)
+			end
+		end
 	end
 end

data/lib/protocol/websocket/ping_frame.rb

@@ -3,8 +3,8 @@
 # Released under the MIT License.
 # Copyright, 2019-2024, by Samuel Williams.
 
-require_relative 'frame'
-require_relative 'pong_frame'
+require_relative "frame"
+require_relative "pong_frame"
 
 module Protocol
 	module WebSocket

data/lib/protocol/websocket/pong_frame.rb

@@ -3,7 +3,7 @@
 # Released under the MIT License.
 # Copyright, 2019-2024, by Samuel Williams.
 
-require_relative 'frame'
+require_relative "frame"
 
 module Protocol
 	module WebSocket

data/lib/protocol/websocket/text_frame.rb

@@ -4,8 +4,8 @@
 # Copyright, 2019-2024, by Samuel Williams.
 # Copyright, 2021, by Aurora Nockert.
 
-require_relative 'frame'
-require_relative 'message'
+require_relative "frame"
+require_relative "message"
 
 module Protocol
 	module WebSocket

data/lib/protocol/websocket/version.rb

@@ -5,6 +5,6 @@
 
 module Protocol
 	module WebSocket
-		VERSION = "0.17.0"
+		VERSION = "0.19.0"
 	end
 end

data/lib/protocol/websocket.rb

@@ -3,7 +3,7 @@
 # Released under the MIT License.
 # Copyright, 2019-2024, by Samuel Williams.
 
-require_relative 'websocket/version'
-require_relative 'websocket/framer'
-require_relative 'websocket/connection'
-require_relative 'websocket/message'
+require_relative "websocket/version"
+require_relative "websocket/framer"
+require_relative "websocket/connection"
+require_relative "websocket/message"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: protocol-websocket
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.19.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -41,7 +41,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-09-11 00:00:00.000000000 Z
+date: 2024-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: protocol-http
@@ -79,7 +79,6 @@ files:
 - lib/protocol/websocket/frame.rb
 - lib/protocol/websocket/framer.rb
 - lib/protocol/websocket/headers.rb
-- lib/protocol/websocket/json_message.rb
 - lib/protocol/websocket/message.rb
 - lib/protocol/websocket/ping_frame.rb
 - lib/protocol/websocket/pong_frame.rb

data/lib/protocol/websocket/json_message.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-# Released under the MIT License.
-# 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)
-				message
-			end
-			
-			def self.generate(object)
-				self.new(JSON.generate(object))
-			end
-		end
-	end
-end