protocol-websocket 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a0f15089bc637ca5755d75a9cea1f219ad1b4903ad7d267f1faf26021bf050d
-  data.tar.gz: c1e73cce6d131bbb0ef398144c48b08ea6439c46268ff1c12ab1f12679b1c8aa
+  metadata.gz: cbd73109c7ac70b53855864e3f3413473c4b375a46378b128e65c0a77f7c4881
+  data.tar.gz: 13c1bbfdbe82d21a03af3dc93944302a8cd5eec1a06154ccd8bfb44a8b251f73
 SHA512:
-  metadata.gz: 0a2f6af33312ea2d00a13124422344a7dfbd1ba01077ffd8747ba8ab7125626bd6d2a8dfe69b28d29417f790dc247c49e87174bb4a74fe2b87919f27c54721f7
-  data.tar.gz: 52b56ed1c83b0fe0869fffa67a90ea01650020104eef81dce01ee151e911035df6c8b5df4a493fac36f76a6e1a9cd4a744cb046373e8139cd23ff9ebf34409d7
+  metadata.gz: 33deb526b4c97ff9bd8887065dadab6750ee10022748c3cc56b240e0f0e3346fbd86ae92ab2c301de82fdbad539e47e4f2558567465bd193a13cf555fc633866
+  data.tar.gz: 857c58853914db3e6f5ab6924f5ac593cb094f7818553a2400ff1b80af07f2aece6e0ddcc044b39f684b6749a1c427527b5bffc862e8270b3eb012da78d40030

data/lib/protocol/websocket/binary_frame.rb

@@ -0,0 +1,33 @@
+# Copyright, 2019, 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 BinaryFrame < Frame
+			OPCODE = 0x2
+			
+			def apply(connection)
+				connection.receive_binary(self)
+			end
+		end
+	end
+end

data/lib/protocol/websocket/close_frame.rb

@@ -0,0 +1,44 @@
+# Copyright, 2019, 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 CloseFrame < Frame
+			OPCODE = 0x8
+			FORMAT = "na*"
+			
+			def unpack
+				data = super
+				
+				return data.unpack(FORMAT)
+			end
+			
+			def pack(code, reason)
+				super [code, reason].pack(FORMAT)
+			end
+			
+			def apply(connection)
+				connection.receive_close(self)
+			end
+		end
+	end
+end

data/lib/protocol/websocket/connection.rb

@@ -0,0 +1,172 @@
+# Copyright, 2019, 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 'framer'
+
+module Protocol
+	module WebSocket
+		class Connection
+			def initialize(framer)
+				@framer = framer
+				@state = :open
+				@frames = []
+			end
+			
+			attr :framer
+			
+			# Buffered frames which form part of a complete message.
+			attr_accessor :frames
+			
+			def closed?
+				@state == :closed
+			end
+			
+			def close
+				send_close
+				
+				@framer.close
+			end
+			
+			def read_frame
+				return nil if closed?
+				
+				frame = @framer.read_frame
+				
+				yield frame if block_given?
+				
+				frame.apply(self)
+				
+				return frame
+			rescue ProtocolError => error
+				send_close(error.code, error.message)
+				
+				raise
+			rescue
+				send_close(Error::PROTOCOL_ERROR, $!.message)
+				
+				raise
+			end
+			
+			def write_frame(frame)
+				@framer.write_frame(frame)
+			end
+			
+			def receive_text(frame)
+				if @frames.empty?
+					@frames << frame
+				else
+					raise ProtocolError, "Received text, but expecting continuation!"
+				end
+			end
+			
+			def receive_binary(frame)
+				if @frames.empty?
+					@frames << frame
+				else
+					raise ProtocolError, "Received binary, but expecting continuation!"
+				end
+			end
+			
+			def receive_continuation(frame)
+				if @frames.any?
+					@frames << frame
+				else
+					raise ProtocolError, "Received unexpected continuation!"
+				end
+			end
+			
+			def send_text(buffer)
+				frame = TextFrame.new
+				frame.pack buffer
+				
+				write_frame(frame)
+			end
+			
+			def send_binary(buffer)
+				frame = BinaryFrame.new
+				frame.pack buffer
+				
+				write_frame(frame)
+			end
+			
+			def send_close(code = Error::NO_ERROR, message = nil)
+				frame = CloseFrame.new
+				frame.pack(code, message)
+				
+				write_frame(frame)
+				
+				@state = :closed
+			end
+			
+			def receive_close(frame)
+				@state = :closed
+				
+				code, message = frame.unpack
+				
+				if code and code != Error::NO_ERROR
+					raise ClosedError.new message, code
+				end
+			end
+			
+			def send_ping(data)
+				if @state != :closed
+					frame = PingFrame.new
+					frame.pack data
+					
+					write_frame(frame)
+				else
+					raise ProtocolError, "Cannot send ping in state #{@state}"
+				end
+			end
+			
+			def open!
+				@state = :open
+				
+				return self
+			end
+			
+			def receive_ping(frame)
+				if @state != :closed
+					write_frame(frame.reply)
+				else
+					raise ProtocolError, "Cannot receive ping in state #{@state}"
+				end
+			end
+			
+			def receive_frame(frame)
+				warn "Unhandled frame #{frame.inspect}"
+			end
+			
+			# @return [Array<Frame>] sequence of frames, the first being either text or binary, optionally followed by a number of continuation frames.
+			def next_message
+				@framer.flush
+				
+				while read_frame
+					if @frames.last&.finished?
+						frames = @frames
+						@frames = []
+						
+						return frames
+					end
+				end
+			end
+		end
+	end
+end

data/lib/protocol/websocket/continuation_frame.rb

@@ -0,0 +1,33 @@
+# Copyright, 2019, 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 ContinuationFrame < Frame
+			OPCODE = 0x0
+			
+			def apply(connection)
+				connection.receive_continuation(self)
+			end
+		end
+	end
+end

data/lib/protocol/websocket/error.rb

@@ -22,10 +22,42 @@ require 'protocol/http/error'
 
 module Protocol
 	module WebSocket
-		class BadRequest < HTTP::BadRequest
+		# 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.
+			NO_ERROR = 1000
+			
+			# Indicates that an endpoint is "going away", such as a server going down or a browser having navigated away from a page.
+			GOING_AWAY = 1001
+			
+			# Indicates that an endpoint is terminating the connection due to a protocol error.
+			PROTOCOL_ERROR = 1002
+			
+			# Indicates that an endpoint is terminating the connection because it has received a type of data it cannot accept.
+			INVALID_DATA = 1003
+			
+			# There are other status codes but most of them are "implementation specific".
 		end
 		
-		class ProtocolError < HTTP::ProtocolError
+		# 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)
+				
+				@code = code
+			end
+			
+			attr :code
+		end
+		
+		# The connection was closed, maybe unexpectedly.
+		class ClosedError < ProtocolError
+		end
+		
+		# When the frame payload does not match expectations.
+		class FrameSizeError < ProtocolError
 		end
 	end
 end

data/lib/protocol/websocket/frame.rb

@@ -25,47 +25,35 @@ module Protocol
 		class Frame
 			include Comparable
 			
-			# Opcodes
-			CONTINUATION = 0x0
-			TEXT = 0x1
-			BINARY = 0x2
-			CLOSE = 0x8
-			PING = 0x9
-			PONG = 0xA
+			OPCODE = 0
 			
 			# @param length [Integer] the length of the payload, or nil if the header has not been read yet.
-			def initialize(fin = true, opcode = 0, mask = nil, payload = nil)
-				@fin = fin
+			def initialize(finished = true, opcode = self.class::OPCODE, mask = false, payload = nil)
+				@finished = finished
 				@opcode = opcode
 				@mask = mask
 				@length = payload&.bytesize
 				@payload = payload
 			end
 			
-			def self.read(stream)
-				frame = self.new
-				
-				if frame.read(stream)
-					return frame
-				end
-			rescue EOFError
-				return nil
-			end
-			
 			def <=> other
 				to_ary <=> other.to_ary
 			end
 			
 			def to_ary
-				[@fin, @opcode, @mask, @length, @payload]
+				[@finished, @opcode, @mask, @length, @payload]
 			end
 			
 			def control?
 				@opcode & 0x8
 			end
 			
+			def finished?
+				@finished == true
+			end
+			
 			def continued?
-				@fin == false
+				@finished == false
 			end
 			
 			# The generic frame header uses the following binary representation:
@@ -89,7 +77,7 @@ module Protocol
 			# |                     Payload Data continued ...                |
 			# +---------------------------------------------------------------+
 			
-			attr_accessor :fin
+			attr_accessor :finished
 			attr_accessor :opcode
 			attr_accessor :mask
 			attr_accessor :length
@@ -99,54 +87,90 @@ module Protocol
 				@payload
 			end
 			
-			def pack(payload)
-				@payload = payload
-				@length = payload.bytesize
+			def pack(data, mask = @mask)
+				length = data.bytesize
 				
-				if @length.bit_length > 64
-					raise ProtocolError, "Frame length #{@length} bigger than allowed 64-bit field!"
+				if length.bit_length > 63
+					raise ProtocolError, "Frame length #{@length} bigger than allowed maximum!"
+				end
+
+				if @mask = mask
+					@payload = String.new.b
+					
+					for i in 0...data.bytesize do
+						@payload << (data.getbyte(i) ^ mask.getbyte(i % 4))
+					end
+				else
+					@payload = data
+					@length = length
 				end
 			end
 			
-			def read(stream)
-				buffer = stream.read(2) or raise EOFError
-				first, second = buffer.unpack("CC")
+			def unpack
+				if @mask
+					data = String.new.b
+					
+					for i in 0...@payload.bytesize do
+						data << (@payload.getbyte(i) ^ @mask.getbyte(i % 4))
+					end
+					
+					return data
+				else
+					return @payload
+				end
+			end
+			
+			def apply(connection)
+				connection.receive_frame(self)
+			end
+			
+			def self.parse_header(buffer)
+				byte = buffer.unpack("C").first
 				
-				@fin = (first & 0b1000_0000 != 0)
+				finished = (byte & 0b1000_0000 != 0)
 				# rsv = byte & 0b0111_0000
-				@opcode = first & 0b0000_1111
+				opcode = byte & 0b0000_1111
 				
-				@mask = (second & 0b1000_0000 != 0)
-				@length = second & 0b0111_1111
+				return finished, opcode
+			end
+			
+			def self.read(finished, opcode, stream, maximum_frame_size)
+				buffer = stream.read(1) or raise EOFError
+				byte = buffer.unpack("C").first
 				
-				if @length == 126
+				mask = (byte & 0b1000_0000 != 0)
+				length = byte & 0b0111_1111
+				
+				if length == 126
 					buffer = stream.read(2) or raise EOFError
-					@length = buffer.unpack('n').first
-				elsif @length == 127
+					length = buffer.unpack('n').first
+				elsif length == 127
 					buffer = stream.read(4) or raise EOFError
-					@length = buffer.unpack('Q>').first
+					length = buffer.unpack('Q>').first
 				end
 				
-				if @mask
-					@mask = stream.read(4) or raise EOFError
-					@payload = read_mask(@mask, @length, stream)
-				else
-					@mask = nil
-					@payload = stream.read(@length) or raise EOFError
+				if length > maximum_frame_size
+					raise ProtocolError, "Invalid payload length: #{@length} > #{maximum_frame_size}!"
 				end
 				
-				if @payload&.bytesize != @length
-					raise ProtocolError, "Invalid payload size: #{@length} != #{@payload.bytesize}!"
+				if mask
+					mask = stream.read(4) or raise EOFError
+				end
+				
+				payload = stream.read(length) or raise EOFError
+				
+				if payload.bytesize != length
+					raise EOFError, "Incorrect payload length: #{@length} != #{@payload.bytesize}!"
 				end
 				
-				return true
+				return self.new(finished, opcode, mask, payload)
 			end
 			
 			def write(stream)
 				buffer = String.new.b
 				
 				if @payload&.bytesize != @length
-					raise ProtocolError, "Invalid payload size: #{@length} != #{@payload.bytesize}!"
+					raise ProtocolError, "Invalid payload length: #{@length} != #{@payload.bytesize}!"
 				end
 				
 				if @mask and @mask.bytesize != 4
@@ -162,7 +186,7 @@ module Protocol
 				end
 				
 				buffer << [
-					(@fin ? 0b1000_0000 : 0) | @opcode,
+					(@finished ? 0b1000_0000 : 0) | @opcode,
 					(@mask ? 0b1000_0000 : 0) | short_length,
 				].pack('CC')
 				
@@ -172,32 +196,8 @@ module Protocol
 					buffer << [@length].pack('Q>')
 				end
 				
-				if @mask
-					buffer << @mask
-					write_mask(@mask, @payload, buffer)
-					stream.write(buffer)
-				else
-					stream.write(buffer)
-					stream.write(@payload)
-				end
-			end
-			
-			private
-			
-			def read_mask(mask, length, stream)
-				data = stream.read(length) or raise EOFError
-				
-				for i in 0...data.bytesize do
-					data.setbyte(i, data.getbyte(i) ^ mask.getbyte(i % 4))
-				end
-				
-				return data
-			end
-			
-			def write_mask(mask, data, buffer)
-				for i in 0...data.bytesize do
-					buffer << (data.getbyte(i) ^ mask.getbyte(i % 4))
-				end
+				stream.write(buffer)
+				stream.write(@payload)
 			end
 		end
 	end

data/lib/protocol/websocket/framer.rb

@@ -20,11 +20,31 @@
 
 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'
+
 module Protocol
 	module WebSocket
+		# HTTP/2 frame type mapping as defined by the spec
+		FRAMES = {
+			0x0 => ContinuationFrame,
+			0x1 => TextFrame,
+			0x2 => BinaryFrame,
+			0x8 => CloseFrame,
+			0x9 => PingFrame,
+			0xA => PongFrame,
+		}.freeze
+		
+		MAXIMUM_ALLOWED_FRAME_SIZE = 2**63
+		
 		class Framer
-			def initialize(stream)
+			def initialize(stream, frames = FRAMES)
 				@stream = stream
+				@frames = frames
 			end
 			
 			def close
@@ -35,20 +55,28 @@ module Protocol
 				@stream.flush
 			end
 			
-			def read_frame
-				Frame.read(@stream)
-			end
-			
-			def read_message
+			def read_frame(maximum_frame_size = MAXIMUM_ALLOWED_FRAME_SIZE)
+				# Read the header:
+				finished, opcode = read_header
 				
-			end
-			
-			def write_message(opcode, payload)
+				# Read the frame:
+				klass = @frames[opcode] || Frame
+				frame = klass.read(finished, opcode, @stream, maximum_frame_size)
+				
+				return frame
 			end
 			
 			def write_frame(frame)
 				frame.write(@stream)
 			end
+			
+			def read_header
+				if buffer = @stream.read(1)
+					return Frame.parse_header(buffer)
+				end
+				
+				raise EOFError, "Could not read frame header!"
+			end
 		end
 	end
 end

data/lib/protocol/websocket/ping_frame.rb

@@ -0,0 +1,38 @@
+# Copyright, 2019, 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'
+require_relative 'pong_frame'
+
+module Protocol
+	module WebSocket
+		class PingFrame < Frame
+			OPCODE = 0x9
+			
+			def reply
+				PongFrame.new(true, PongFrame::OPCODE, @mask, @payload)
+			end
+			
+			def apply(connection)
+				connection.receive_ping(self)
+			end
+		end
+	end
+end

data/lib/protocol/websocket/pong_frame.rb

@@ -0,0 +1,33 @@
+# Copyright, 2019, 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 PongFrame < Frame
+			OPCODE = 0xA
+			
+			def apply(connection)
+				connection.receive_pong(self)
+			end
+		end
+	end
+end

data/lib/protocol/websocket/text_frame.rb

@@ -0,0 +1,41 @@
+# Copyright, 2019, 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 TextFrame < Frame
+			OPCODE = 0x1
+			
+			def unpack
+				super.force_encoding(Encoding::UTF_8)
+			end
+			
+			def pack(data, mask = @mask)
+				super(data.b, mask = @mask)
+			end
+			
+			def apply(connection)
+				connection.receive_text(self)
+			end
+		end
+	end
+end

data/lib/protocol/websocket/version.rb

@@ -20,6 +20,6 @@
 
 module Protocol
 	module WebSocket
-		VERSION = "0.1.0"
+		VERSION = "0.2.0"
 	end
 end

data/protocol-websocket.gemspec

@@ -18,7 +18,8 @@ Gem::Specification.new do |spec|
 	spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
 	spec.require_paths = ["lib"]
 	
-	spec.add_dependency "protocol-http"
+	spec.add_dependency "protocol-http", "~> 0.2"
+	spec.add_dependency "protocol-http1", "~> 0.2"
 	
 	spec.add_development_dependency "covered"
 	spec.add_development_dependency "bundler"

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: protocol-websocket
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-08 00:00:00.000000000 Z
+date: 2019-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: protocol-http
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: protocol-http1
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: covered
   requirement: !ruby/object:Gem::Requirement
@@ -94,10 +108,17 @@ files:
 - README.md
 - Rakefile
 - lib/protocol/websocket.rb
+- lib/protocol/websocket/binary_frame.rb
+- lib/protocol/websocket/close_frame.rb
+- lib/protocol/websocket/connection.rb
+- lib/protocol/websocket/continuation_frame.rb
 - lib/protocol/websocket/digest.rb
 - lib/protocol/websocket/error.rb
 - lib/protocol/websocket/frame.rb
 - lib/protocol/websocket/framer.rb
+- lib/protocol/websocket/ping_frame.rb
+- lib/protocol/websocket/pong_frame.rb
+- lib/protocol/websocket/text_frame.rb
 - lib/protocol/websocket/version.rb
 - protocol-websocket.gemspec
 homepage: https://github.com/socketry/protocol-websocket