websocket-driver 0.7.1 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b7a3b9878d6efb8ad25a608fd06548f4be94454406894588e15f856f4451746
-  data.tar.gz: a5f98cbda60d85887857b75a967ad8d33a41e549781739374865e05a76304e7b
+  metadata.gz: 8d2fd69bbe4e45d93002f9896c0fe6a0a355c1a5f1220010513f1e440ff340c4
+  data.tar.gz: 05f36822ac52992558db10f11ed326dbabeea6db93f029f6a98b79000350c659
 SHA512:
-  metadata.gz: fca692d01fb40ad07be65a0050923e03084841e995d53b3580bd84265b74c1a3411b8c4f16f0e319a2a9acb7811e48ad13bc43bc81023d308fb7ea385e150d0d
-  data.tar.gz: 48e438dea20c9dd8a90224ec32d3d16da1b04f145070e15d9bac741ad39717f04a246631df0475c266f28e495001f41d14f2534c118243075f8abc0921868524
+  metadata.gz: '0279eab6292a9d4245781a6ccf66e76932257c34e83602dfda8d385e254c8da2f48fdd545780cda8e1824b45604c4be348e1259a1bdc97e3bcaa25783c3665aa'
+  data.tar.gz: 16809f7d90999be91d2713e7ad8e2bee2f313eeeabb9823b85c35d5763a766aae65c58a9299154718100735cf5db4db45aa5c270eb1e52fabd00ceb40d876064

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+### 0.7.2 / 2020-05-22
+
+- Emit `ping` and `pong` events from the `Server` driver
+- Handle draft-76 handshakes correctly if the request's body is a frozen string
+
 ### 0.7.1 / 2019-06-10
 
 - Catch any exceptions produced while generating a handshake response and send a
@@ -5,6 +10,7 @@
 - Pick the RFC-6455 protocol version if the request contains any of the headers
   used by that version
 - Handle errors encountered while handling malformed draft-76 requests
+- Change license from MIT to Apache 2.0
 
 ### 0.7.0 / 2017-09-11
 

data/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright 2010-2019 James Coglan
+Copyright 2010-2020 James Coglan
 
 Licensed under the Apache License, Version 2.0 (the "License"); you may not use
 this file except in compliance with the License. You may obtain a copy of the

data/README.md

@@ -274,33 +274,33 @@ Note that most of these methods are commands: if they produce data that should
 be sent over the socket, they will give this to you by calling
 `socket.write(string)`.
 
-#### `driver.on :open, -> (event) { }`
+#### `driver.on :open, -> (event) {}`
 
 Adds a callback block to execute when the socket becomes open.
 
-#### `driver.on :message, -> (event) { }`
+#### `driver.on :message, -> (event) {}`
 
 Adds a callback block to execute when a message is received. `event` will have a
 `data` attribute containing either a string in the case of a text message or an
 array of integers in the case of a binary message.
 
-#### `driver.on :error, -> (event) { }`
+#### `driver.on :error, -> (event) {}`
 
 Adds a callback to execute when a protocol error occurs due to the other peer
 sending an invalid byte sequence. `event` will have a `message` attribute
 describing the error.
 
-#### `driver.on :close, -> (event) { }`
+#### `driver.on :close, -> (event) {}`
 
 Adds a callback block to execute when the socket becomes closed. The `event`
 object has `code` and `reason` attributes.
 
-#### `driver.on :ping, -> (event) { }`
+#### `driver.on :ping, -> (event) {}`
 
 Adds a callback block to execute when a ping is received. You do not need to
 handle this by sending a pong frame yourself; the driver handles this for you.
 
-#### `driver.on :pong, -> (event) { }`
+#### `driver.on :pong, -> (event) {}`
 
 Adds a callback block to execute when a pong is received. If this was in
 response to a ping you sent, you can also handle this event via the

data/lib/websocket/driver.rb

@@ -215,7 +215,7 @@ module WebSocket
     def self.validate_options(options, valid_keys)
       options.keys.each do |key|
         unless valid_keys.include?(key)
-          raise ConfigurationError, "Unrecognized option: #{key.inspect}"
+          raise ConfigurationError, "Unrecognized option: #{ key.inspect }"
         end
       end
     end

data/lib/websocket/driver/client.rb

@@ -20,10 +20,10 @@ module WebSocket
 
         uri = URI.parse(@socket.url)
         unless VALID_SCHEMES.include?(uri.scheme)
-          raise URIError, "#{socket.url} is not a valid WebSocket URL"
+          raise URIError, "#{ socket.url } is not a valid WebSocket URL"
         end
 
-        host      = uri.host + (uri.port ? ":#{uri.port}" : '')
+        host      = uri.host + (uri.port ? ":#{ uri.port }" : '')
         path      = (uri.path == '') ? '/' : uri.path
         @pathname = path + (uri.query ? '?' + uri.query : '')
 
@@ -44,7 +44,7 @@ module WebSocket
       end
 
       def version
-        "hybi-#{VERSION}"
+        "hybi-#{ VERSION }"
       end
 
       def proxy(origin, options = {})
@@ -73,19 +73,19 @@ module WebSocket
         parse(@http.body)
       end
 
-    private 
+    private
 
       def handshake_request
         extensions = @extensions.generate_offer
         @headers['Sec-WebSocket-Extensions'] = extensions if extensions
 
-        start   = "GET #{@pathname} HTTP/1.1"
+        start   = "GET #{ @pathname } HTTP/1.1"
         headers = [start, @headers.to_s, '']
         headers.join("\r\n")
       end
 
       def fail_handshake(message)
-        message = "Error during WebSocket handshake: #{message}"
+        message = "Error during WebSocket handshake: #{ message }"
         @ready_state = 3
         emit(:error, ProtocolError.new(message))
         emit(:close, CloseEvent.new(ERRORS[:protocol_error], message))
@@ -96,7 +96,7 @@ module WebSocket
         @headers = Headers.new(@http.headers)
 
         unless @http.code == 101
-          return fail_handshake("Unexpected response code: #{@http.code}")
+          return fail_handshake("Unexpected response code: #{ @http.code }")
         end
 
         upgrade    = @http['Upgrade'] || ''

data/lib/websocket/driver/draft76.rb

@@ -6,9 +6,10 @@ module WebSocket
 
       def initialize(socket, options = {})
         super
-        input  = @socket.env['rack.input']
+        input  = (@socket.env['rack.input'] || StringIO.new('')).read
+        input  = input.dup if input.frozen?
         @stage = -1
-        @body  = (input ? input.read : String.new('')).force_encoding(BINARY)
+        @body  = input.force_encoding(BINARY)
 
         @headers.clear
         @headers['Upgrade'] = 'WebSocket'

data/lib/websocket/driver/headers.rb

@@ -25,7 +25,7 @@ module WebSocket
         return if value.nil?
         key = HTTP.normalize_header(name)
         return unless @sent.add?(key) or ALLOWED_DUPLICATES.include?(key)
-        @lines << "#{name.strip}: #{value.to_s.strip}\r\n"
+        @lines << "#{ name.strip }: #{ value.to_s.strip }\r\n"
       end
 
       def inspect

data/lib/websocket/driver/hybi.rb

@@ -52,7 +52,7 @@ module WebSocket
       MIN_RESERVED_ERROR = 3000
       MAX_RESERVED_ERROR = 4999
 
-      PACK_FORMATS = {2 => 'n', 8 => 'Q>'}
+      PACK_FORMATS = { 2 => 'n', 8 => 'Q>' }
 
       def initialize(socket, options = {})
         super
@@ -78,7 +78,7 @@ module WebSocket
       end
 
       def version
-        "hybi-#{VERSION}"
+        "hybi-#{ VERSION }"
       end
 
       def add_extension(extension)
@@ -228,7 +228,7 @@ module WebSocket
         version = @socket.env['HTTP_SEC_WEBSOCKET_VERSION']
 
         unless version == VERSION
-          raise ProtocolError.new("Unsupported WebSocket version: #{VERSION}")
+          raise ProtocolError.new("Unsupported WebSocket version: #{ VERSION }")
         end
 
         unless sec_key
@@ -281,17 +281,17 @@ module WebSocket
 
         unless @extensions.valid_frame_rsv?(@frame)
           return fail(:protocol_error,
-              "One or more reserved bits are on: reserved1 = #{@frame.rsv1 ? 1 : 0}" +
-              ", reserved2 = #{@frame.rsv2 ? 1 : 0 }" +
-              ", reserved3 = #{@frame.rsv3 ? 1 : 0 }")
+              "One or more reserved bits are on: reserved1 = #{ @frame.rsv1 ? 1 : 0 }" +
+              ", reserved2 = #{ @frame.rsv2 ? 1 : 0 }" +
+              ", reserved3 = #{ @frame.rsv3 ? 1 : 0 }")
         end
 
         unless OPCODES.values.include?(@frame.opcode)
-          return fail(:protocol_error, "Unrecognized frame opcode: #{@frame.opcode}")
+          return fail(:protocol_error, "Unrecognized frame opcode: #{ @frame.opcode }")
         end
 
         unless MESSAGE_OPCODES.include?(@frame.opcode) or @frame.final
-          return fail(:protocol_error, "Received fragmented control frame: opcode = #{@frame.opcode}")
+          return fail(:protocol_error, "Received fragmented control frame: opcode = #{ @frame.opcode }")
         end
 
         if @message and OPENING_OPCODES.include?(@frame.opcode)
@@ -321,7 +321,7 @@ module WebSocket
         @stage = @frame.masked ? 3 : 4
 
         unless MESSAGE_OPCODES.include?(@frame.opcode) or @frame.length <= 125
-          return fail(:protocol_error, "Received control frame having too long payload: #{@frame.length}")
+          return fail(:protocol_error, "Received control frame having too long payload: #{ @frame.length }")
         end
 
         return unless check_frame_length

data/lib/websocket/driver/proxy.rb

@@ -4,7 +4,7 @@ module WebSocket
     class Proxy
       include EventEmitter
 
-      PORTS = {'ws' => 80, 'wss' => 443}
+      PORTS = { 'ws' => 80, 'wss' => 443 }
 
       attr_reader :status, :headers
 
@@ -20,7 +20,7 @@ module WebSocket
         @state   = 0
 
         @headers = Headers.new
-        @headers['Host'] = @origin.host + (@origin.port ? ":#{@origin.port}" : '')
+        @headers['Host'] = @origin.host + (@origin.port ? ":#{ @origin.port }" : '')
         @headers['Connection'] = 'keep-alive'
         @headers['Proxy-Connection'] = 'keep-alive'
 
@@ -41,7 +41,7 @@ module WebSocket
         @state = 1
 
         port    = @origin.port || PORTS[@origin.scheme]
-        start   = "CONNECT #{@origin.host}:#{port} HTTP/1.1"
+        start   = "CONNECT #{ @origin.host }:#{ port } HTTP/1.1"
         headers = [start, @headers.to_s, '']
 
         @socket.write(headers.join("\r\n"))
@@ -58,7 +58,7 @@ module WebSocket
         if @status == 200
           emit(:connect, ConnectEvent.new)
         else
-          message = "Can't establish a connection to the server at #{@socket.url}"
+          message = "Can't establish a connection to the server at #{ @socket.url }"
           emit(:error, ProtocolError.new(message))
         end
       end

data/lib/websocket/driver/server.rb

@@ -2,7 +2,7 @@ module WebSocket
   class Driver
 
     class Server < Driver
-      EVENTS = %w[open message error close]
+      EVENTS = %w[open message error close ping pong]
 
       def initialize(socket, options = {})
         super
@@ -17,9 +17,9 @@ module WebSocket
       def url
         return nil unless e = env
 
-        url  = "ws://#{e['HTTP_HOST']}"
+        url  = "ws://#{ e['HTTP_HOST'] }"
         url << e['PATH_INFO']
-        url << "?#{e['QUERY_STRING']}" unless e['QUERY_STRING'] == ''
+        url << "?#{ e['QUERY_STRING'] }" unless e['QUERY_STRING'] == ''
         url
       end
 

data/lib/websocket/http/request.rb

@@ -30,11 +30,11 @@ module WebSocket
         super
         @headers.each do |name, value|
           rack_name = name.upcase.gsub(/-/, '_')
-          rack_name = "HTTP_#{rack_name}" unless RESERVED_HEADERS.include?(name)
+          rack_name = "HTTP_#{ rack_name }" unless RESERVED_HEADERS.include?(name)
           @env[rack_name] = value
         end
         if host = @env['HTTP_HOST']
-          uri = URI.parse("http://#{host}")
+          uri = URI.parse("http://#{ host }")
           @env['SERVER_NAME'] = uri.host
           @env['SERVER_PORT'] = uri.port.to_s
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: websocket-driver
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.7.2
 platform: ruby
 authors:
 - James Coglan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-10 00:00:00.000000000 Z
+date: 2020-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: websocket-extensions
@@ -135,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: WebSocket protocol handler with pluggable I/O