protocol-websocket 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa6f686dc5e613876cef1283788d5be3894e069243e542f046474b332fbf95dd
-  data.tar.gz: ee086548d5f7346510acb18ec2dcb2238f869e5a84e806a21a46ddd341a83a59
+  metadata.gz: 6dbf808fd6d8859dccb3ce6b8e9578ec62fbb9f2530aa1adc809d0143e16141e
+  data.tar.gz: d674db6e338b18db74b8a170aa81980d609a9c4ae235921c4a87a188a333654a
 SHA512:
-  metadata.gz: 818fb24badcacf322da7eb6a5b9f4d33a1825a05dd745e83d92917eccdd663ddc1a1f7d3eaa93bdfe10f2c3af75b6abac991da5f9ee8ee2c9281e02d1f25402e
-  data.tar.gz: '0857e0a599e4b391d265c61efee3555b7d75c6c6b6c0f83ee691e8d413ab971fc47c8d07300ca6815c589f22d12abbdffafc0911bde93eb5670eba120b8478a9'
+  metadata.gz: 3fe42aa9dabd6965081a86b9eae2b9deffcff628ef4081c48ed3b53b33854a1782deffde2cb84a91f9ec1d5acd69dc38b2e36c82390cd0ea55b49eac431a0908
+  data.tar.gz: d60e9344e0f386a158549bc1e8a332a5ef4b3e7adc934ffde273dfed73def85a3fd994f4d58e0bddbcfba42cee2fcb7250aa1b4afe0ba9df29721d9ff5be0285

data/lib/protocol/websocket/connection.rb

@@ -23,14 +23,21 @@ require_relative 'framer'
 module Protocol
 	module WebSocket
 		class Connection
-			def initialize(framer)
+			# @option mask [String] 4-byte mask to be used for frames generated by this connection.
+			def initialize(framer, mask: nil)
 				@framer = framer
+				@mask = mask
+				
 				@state = :open
 				@frames = []
 			end
 			
+			# The framer which is used for reading and writing frames.
 			attr :framer
 			
+			# The (optional) mask which is used when generating frames.
+			attr :mask
+			
 			# Buffered frames which form part of a complete message.
 			attr_accessor :frames
 			
@@ -97,21 +104,21 @@ module Protocol
 			end
 			
 			def send_text(buffer)
-				frame = TextFrame.new
+				frame = TextFrame.new(mask: @mask)
 				frame.pack buffer
 				
 				write_frame(frame)
 			end
 			
 			def send_binary(buffer)
-				frame = BinaryFrame.new
+				frame = BinaryFrame.new(mask: @mask)
 				frame.pack buffer
 				
 				write_frame(frame)
 			end
 			
 			def send_close(code = Error::NO_ERROR, message = nil)
-				frame = CloseFrame.new
+				frame = CloseFrame.new(mask: @mask)
 				frame.pack(code, message)
 				
 				write_frame(frame)
@@ -131,8 +138,8 @@ module Protocol
 			
 			def send_ping(data)
 				if @state != :closed
-					frame = PingFrame.new
-					frame.pack data
+					frame = PingFrame.new(mask: @mask)
+					frame.pack(data)
 					
 					write_frame(frame)
 				else

data/lib/protocol/websocket/frame.rb

@@ -28,7 +28,7 @@ module Protocol
 			OPCODE = 0
 			
 			# @param length [Integer] the length of the payload, or nil if the header has not been read yet.
-			def initialize(finished = true, opcode = self.class::OPCODE, mask = false, payload = nil)
+			def initialize(finished = true, payload = nil, opcode: self.class::OPCODE, mask: false)
 				@finished = finished
 				@opcode = opcode
 				@mask = mask
@@ -83,19 +83,21 @@ module Protocol
 			attr_accessor :length
 			attr_accessor :payload
 			
-			def pack(data, mask = @mask)
+			def pack(data)
 				length = data.bytesize
 				
 				if length.bit_length > 63
 					raise ProtocolError, "Frame length #{@length} bigger than allowed maximum!"
 				end
 
-				if @mask = mask
+				if @mask
 					@payload = String.new.b
 					
 					for i in 0...data.bytesize do
 						@payload << (data.getbyte(i) ^ mask.getbyte(i % 4))
 					end
+					
+					@length = length
 				else
 					@payload = data
 					@length = length
@@ -159,14 +161,14 @@ module Protocol
 					raise EOFError, "Incorrect payload length: #{@length} != #{@payload.bytesize}!"
 				end
 				
-				return self.new(finished, opcode, mask, payload)
+				return self.new(finished, payload, opcode: opcode, mask: mask)
 			end
 			
 			def write(stream)
 				buffer = String.new.b
 				
 				if @payload&.bytesize != @length
-					raise ProtocolError, "Invalid payload length: #{@length} != #{@payload.bytesize}!"
+					raise ProtocolError, "Invalid payload length: #{@length} != #{@payload.bytesize} for #{self}!"
 				end
 				
 				if @mask and @mask.bytesize != 4
@@ -192,6 +194,8 @@ module Protocol
 					buffer << [@length].pack('Q>')
 				end
 				
+				buffer << @mask if @mask
+				
 				stream.write(buffer)
 				stream.write(@payload)
 			end

data/lib/protocol/websocket/ping_frame.rb

@@ -27,7 +27,7 @@ module Protocol
 			OPCODE = 0x9
 			
 			def reply
-				PongFrame.new(true, PongFrame::OPCODE, @mask, @payload)
+				PongFrame.new(true, @payload, mask: @mask)
 			end
 			
 			def apply(connection)

data/lib/protocol/websocket/text_frame.rb

@@ -29,8 +29,8 @@ module Protocol
 				super.force_encoding(Encoding::UTF_8)
 			end
 			
-			def pack(data, mask = @mask)
-				super(data.b, mask = @mask)
+			def pack(data)
+				super(data.b)
 			end
 			
 			def apply(connection)

data/lib/protocol/websocket/version.rb

@@ -20,6 +20,6 @@
 
 module Protocol
 	module WebSocket
-		VERSION = "0.3.2"
+		VERSION = "0.4.0"
 	end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: protocol-websocket
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-10 00:00:00.000000000 Z
+date: 2019-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: protocol-http
@@ -140,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: A low level implementation of the WebSocket protocol.