protocol-websocket 0.7.0 → 0.7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4dc50db69013fc02249f6ea8286ae21d3393e254981613508368d42681af0fce
-  data.tar.gz: 3fa1dc744a1313043f8e8fc90bf76052a0de01876c14012d66682b7c0a623ca6
+  metadata.gz: 0d2733227a287e2dfb58f393566e6afea44470aba32c7a8eda8bd9a8f25c2d72
+  data.tar.gz: bdd0966fcc837f1314cf2b88e55699f2de57e6d6af36ecbe3bcdf0c12350935a
 SHA512:
-  metadata.gz: aec5858ecf25bfc29428a06fa870f0d26a8634d911f8b6ccb5626b7c7cda29ffb2944bde656d577e99182ea1bb08fcc3b5fd39cdc8b3c301f240d75ad20f2cb8
-  data.tar.gz: 191fffcabad7d80c766c4a50b243e6d67d0ba2b3b6b76bad312c3bf81b4481538a30414d029ac6dae2354276c97720b3651cd02665221e1986059b92047b4a2e
+  metadata.gz: a3fdd8546a648fa96663aafe278499e3a19266d1dfd9d2c68cd6d330f24c8af7d31ee94fd88c632a4bddec85dd56456980bf5a27d02197548279e069eae3d515
+  data.tar.gz: 2b4faa47644b9811dab2d856831176b282c83df85863fad5db5a7b28055b123230ac89ae2e29eb3529843fec12d80ec11f26b2894ca85a2f243eef2d09bf10fb

data/lib/protocol/websocket/connection.rb

@@ -24,12 +24,8 @@ require 'securerandom'
 module Protocol
 	module WebSocket
 		class Connection
-			# @option mask [String] 4-byte mask to be used for frames generated by this connection.
+			# @parameter mask [String] 4-byte mask to be used for frames generated by this connection.
 			def initialize(framer, mask: nil)
-				if mask == true
-					mask = SecureRandom.bytes(4)
-				end
-				
 				@framer = framer
 				@mask = mask
 				
@@ -82,6 +78,8 @@ module Protocol
 			
 			def write_frame(frame)
 				@framer.write_frame(frame)
+				
+				return frame
 			end
 			
 			def receive_text(frame)
@@ -142,10 +140,10 @@ module Protocol
 				end
 			end
 			
-			def send_ping(data = nil)
+			def send_ping(data = "")
 				if @state != :closed
 					frame = PingFrame.new(mask: @mask)
-					frame.pack(data) if data
+					frame.pack(data)
 					
 					write_frame(frame)
 				else
@@ -161,22 +159,29 @@ module Protocol
 			
 			def receive_ping(frame)
 				if @state != :closed
-					write_frame(frame.reply)
+					write_frame(frame.reply(mask: @mask))
 				else
 					raise ProtocolError, "Cannot receive ping in state #{@state}"
 				end
 			end
 			
+			def receive_pong(frame)
+				# Ignore.
+			end
+			
 			def receive_frame(frame)
 				warn "Unhandled frame #{frame.inspect}"
 			end
 			
 			# @param buffer [String] a unicode or binary string.
 			def write(buffer)
+				# https://tools.ietf.org/html/rfc6455#section-5.6
+				
+				# Text: The "Payload data" is text data encoded as UTF-8
 				if buffer.encoding == Encoding::UTF_8
 					send_text(buffer)
 				else
-					send_data(buffer)
+					send_binary(buffer)
 				end
 			end
 			

data/lib/protocol/websocket/frame.rb

@@ -27,8 +27,13 @@ module Protocol
 			
 			OPCODE = 0
 			
-			# @param length [Integer] the length of the payload, or nil if the header has not been read yet.
+			# @parameter length [Integer] The length of the payload, or nil if the header has not been read yet.
+			# @parameter mask [Boolean | String] An optional 4-byte string which is used to mask the payload.
 			def initialize(finished = true, payload = nil, opcode: self.class::OPCODE, mask: false)
+				if mask == true
+					mask = SecureRandom.bytes(4)
+				end
+				
 				@finished = finished
 				@opcode = opcode
 				@mask = mask
@@ -109,7 +114,7 @@ module Protocol
 			end
 			
 			def unpack
-				if @mask
+				if @mask and !@payload.empty?
 					data = String.new.b
 					
 					for i in 0...@payload.bytesize do
@@ -147,7 +152,7 @@ module Protocol
 					buffer = stream.read(2) or raise EOFError, "Could not read length!"
 					length = buffer.unpack('n').first
 				elsif length == 127
-					buffer = stream.read(4) or raise EOFError, "Could not read length!"
+					buffer = stream.read(8) or raise EOFError, "Could not read length!"
 					length = buffer.unpack('Q>').first
 				end
 				

data/lib/protocol/websocket/ping_frame.rb

@@ -26,8 +26,8 @@ module Protocol
 		class PingFrame < Frame
 			OPCODE = 0x9
 			
-			def reply
-				PongFrame.new(true, @payload, mask: @mask)
+			def reply(**options)
+				PongFrame.new(true, self.unpack, **options)
 			end
 			
 			def apply(connection)

data/lib/protocol/websocket/version.rb

@@ -20,6 +20,6 @@
 
 module Protocol
 	module WebSocket
-		VERSION = "0.7.0"
+		VERSION = "0.7.5"
 	end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: protocol-websocket
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.5
 platform: ruby
 authors:
 - Samuel Williams
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-06-22 00:00:00.000000000 Z
+date: 2020-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: protocol-http
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.2'
 - !ruby/object:Gem::Dependency
-  name: covered
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: covered
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -66,20 +66,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -94,19 +80,12 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: 
+description:
 email:
-- samuel.williams@oriontransfer.co.nz
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- Gemfile
-- README.md
-- Rakefile
 - lib/protocol/websocket.rb
 - lib/protocol/websocket/binary_frame.rb
 - lib/protocol/websocket/close_frame.rb
@@ -120,12 +99,11 @@ files:
 - 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
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -133,15 +111,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: A low level implementation of the WebSocket protocol.
 test_files: []

data/.gitignore

@@ -1,13 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status
-Gemfile.lock
-.covered.db

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---warnings
---require spec_helper

data/.travis.yml

@@ -1,19 +0,0 @@
-language: ruby
-dist: xenial
-cache: bundler
-
-matrix:
-  include:
-    - rvm: 2.4
-    - rvm: 2.5
-    - rvm: 2.6
-    - rvm: 2.6
-      env: COVERAGE=PartialSummary,Coveralls
-    - rvm: truffleruby
-    - rvm: jruby-head
-      env: JRUBY_OPTS="--debug -X+O"
-    - rvm: ruby-head
-  allow_failures:
-    - rvm: truffleruby
-    - rvm: ruby-head
-    - rvm: jruby-head

data/Gemfile

@@ -1,4 +0,0 @@
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in protocol-websocket.gemspec
-gemspec

data/README.md

@@ -1,64 +0,0 @@
-# Protocol::WebSocket
-
-Provides a low-level implementation of the WebSocket protocol according to [RFC6455](https://tools.ietf.org/html/rfc6455). It only implements the latest stable version (13).
-
-[![Build Status](https://travis-ci.com/socketry/protocol-websocket.svg?branch=master)](http://travis-ci.com/socketry/protocol-websocket)
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'protocol-websocket'
-```
-
-And then execute:
-
-	$ bundle
-
-Or install it yourself as:
-
-	$ gem install protocol-websocket
-
-## Usage
-
-Here is a basic WebSocket client:
-
-```ruby
-stream = # connect to remote system
-framer = Protocol::WebSocket::Framer.new(stream)
-
-frame = framer.read_frame
-```
-
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
-
-## License
-
-Released under the MIT license.
-
-Copyright, 2019, by [Samuel G. D. Williams](http://www.codeotaku.com/samuel-williams).  
-
-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.

data/Rakefile

@@ -1,6 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec

data/protocol-websocket.gemspec

@@ -1,28 +0,0 @@
-
-require_relative "lib/protocol/websocket/version"
-
-Gem::Specification.new do |spec|
-	spec.name          = "protocol-websocket"
-	spec.version       = Protocol::WebSocket::VERSION
-	spec.authors       = ["Samuel Williams"]
-	spec.email         = ["samuel.williams@oriontransfer.co.nz"]
-	
-	spec.summary       = "A low level implementation of the WebSocket protocol."
-	spec.homepage      = "https://github.com/socketry/protocol-websocket"
-	spec.license       = "MIT"
-	
-	spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-		`git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-	end
-	
-	spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-	spec.require_paths = ["lib"]
-	
-	spec.add_dependency "protocol-http", "~> 0.2"
-	spec.add_dependency "protocol-http1", "~> 0.2"
-	
-	spec.add_development_dependency "covered"
-	spec.add_development_dependency "bundler"
-	spec.add_development_dependency "rake", "~> 10.0"
-	spec.add_development_dependency "rspec", "~> 3.0"
-end