websocket-driver 0.7.1 → 0.7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b7a3b9878d6efb8ad25a608fd06548f4be94454406894588e15f856f4451746
-  data.tar.gz: a5f98cbda60d85887857b75a967ad8d33a41e549781739374865e05a76304e7b
+  metadata.gz: 046c514660d2c0dab2cf42bce8314a17e713909377a5da470beaeadf666ff28e
+  data.tar.gz: 9830c412394044d102dd6f313346721076ef0f97284d6182aeb06862e1f427b2
 SHA512:
-  metadata.gz: fca692d01fb40ad07be65a0050923e03084841e995d53b3580bd84265b74c1a3411b8c4f16f0e319a2a9acb7811e48ad13bc43bc81023d308fb7ea385e150d0d
-  data.tar.gz: 48e438dea20c9dd8a90224ec32d3d16da1b04f145070e15d9bac741ad39717f04a246631df0475c266f28e495001f41d14f2534c118243075f8abc0921868524
+  metadata.gz: cea4027f342f51a688c8004a92ca29b68af9a9395b5e7f8d2462b8742067862718d23f4be9ca6162f761774490e4cdf33111bb746f9221d5acace6546a749b35
+  data.tar.gz: d124aa6acf1cbfa498b44d02d6aa659c99e97e177441e8cbd43958db38c6cf03d703d26ae73998a09719c0612f538554049d58b58aa8cc8ab5f0bb458e27c988

data/CHANGELOG.md

@@ -1,3 +1,22 @@
+### 0.7.5 / 2021-06-12
+
+- Do not change the encoding of strings passed to `Driver#text`
+
+### 0.7.4 / 2021-05-24
+
+- Optimise conversions between strings and byte arrays and related encoding
+  operations, to reduce amount of allocation and copying
+
+### 0.7.3 / 2020-07-09
+
+- Let the client accept HTTP responses that have an empty reason phrase
+  following the `101` status code
+
+### 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 +24,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-2021 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

@@ -1,4 +1,4 @@
-# websocket-driver [![Build Status](https://travis-ci.org/faye/websocket-driver-ruby.svg)](https://travis-ci.org/faye/websocket-driver-ruby)
+# websocket-driver
 
 This module provides a complete implementation of the WebSocket protocols that
 can be hooked up to any TCP library. It aims to simplify things by decoupling
@@ -150,7 +150,16 @@ module Connection
       if WebSocket::Driver.websocket?(@driver.env)
         @driver.start
       else
-        # handle other HTTP requests
+        # handle other HTTP requests, for example
+        body = '<h1>hello</h1>'
+        response = [
+          'HTTP/1.1 200 OK',
+          'Content-Type: text/plain',
+          "Content-Length: #{body.bytesize}",
+          '',
+          body
+        ]
+        send_data response.join("\r\n")
       end
     end
 
@@ -274,33 +283,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/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/draft75.rb

@@ -56,7 +56,7 @@ module WebSocket
             when 2 then
               if octet == 0xFF
                 @stage = 0
-                emit(:message, MessageEvent.new(Driver.encode(@buffer, UNICODE)))
+                emit(:message, MessageEvent.new(Driver.encode(@buffer, Encoding::UTF_8)))
               else
                 if @length
                   @skipped += 1

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(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/message.rb

@@ -14,7 +14,7 @@ module WebSocket
           @rsv2   = false
           @rsv3   = false
           @opcode = nil
-          @data   = String.new('').force_encoding(BINARY)
+          @data   = String.new('').force_encoding(Encoding::BINARY)
         end
 
         def <<(frame)

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 => 'S>', 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)
@@ -160,14 +160,13 @@ module WebSocket
 
         message = Message.new
         frame   = Frame.new
-        is_text = String === buffer
 
         message.rsv1   = message.rsv2 = message.rsv3 = false
-        message.opcode = OPCODES[type || (is_text ? :text : :binary)]
+        message.opcode = OPCODES[type || (String === buffer ? :text : :binary)]
 
-        payload = is_text ? buffer.bytes.to_a : buffer
-        payload = [code].pack(PACK_FORMATS[2]).bytes.to_a + payload if code
-        message.data = payload.pack('C*')
+        payload = Driver.encode(buffer)
+        payload = [code, payload].pack('S>a*') if code
+        message.data = payload
 
         if MESSAGE_OPCODES.include?(message.opcode)
           message = @extensions.process_outgoing_message(message)
@@ -194,33 +193,38 @@ module WebSocket
 
       def send_frame(frame)
         length = frame.length
-        buffer = []
+        values = []
+        format = 'C2'
         masked = frame.masked ? MASK : 0
 
-        buffer[0] = (frame.final ? FIN : 0) |
+        values[0] = (frame.final ? FIN : 0) |
                     (frame.rsv1 ? RSV1 : 0) |
                     (frame.rsv2 ? RSV2 : 0) |
                     (frame.rsv3 ? RSV3 : 0) |
                     frame.opcode
 
         if length <= 125
-          buffer[1] = masked | length
+          values[1] = masked | length
         elsif length <= 65535
-          buffer[1] = masked | 126
-          buffer[2..3] = [length].pack(PACK_FORMATS[2]).bytes.to_a
+          values[1] = masked | 126
+          values[2] = length
+          format << 'S>'
         else
-          buffer[1] = masked | 127
-          buffer[2..9] = [length].pack(PACK_FORMATS[8]).bytes.to_a
+          values[1] = masked | 127
+          values[2] = length
+          format << 'Q>'
         end
 
         if frame.masked
-          buffer.concat(frame.masking_key.bytes.to_a)
-          buffer.concat(Mask.mask(frame.payload, frame.masking_key).bytes.to_a)
+          values << frame.masking_key
+          values << Mask.mask(frame.payload, frame.masking_key)
+          format << 'a4a*'
         else
-          buffer.concat(frame.payload.bytes.to_a)
+          values << frame.payload
+          format << 'a*'
         end
 
-        @socket.write(buffer.pack('C*'))
+        @socket.write(values.pack(format))
       end
 
       def handshake_response
@@ -228,7 +232,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 +285,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 +325,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
@@ -343,7 +347,6 @@ module WebSocket
         opcode   = frame.opcode
         payload  = frame.payload = Mask.mask(buffer, @frame.masking_key)
         bytesize = payload.bytesize
-        bytes    = payload.bytes.to_a
 
         @frame = nil
 
@@ -357,8 +360,8 @@ module WebSocket
             @message << frame
 
           when OPCODES[:close] then
-            code   = (bytesize >= 2) ? payload.unpack(PACK_FORMATS[2]).first : nil
-            reason = (bytesize > 2)  ? Driver.encode(bytes[2..-1] || [], UNICODE) : nil
+            code, reason = payload.unpack('S>a*') if bytesize >= 2
+            reason = Driver.encode(reason || '', Encoding::UTF_8)
 
             unless (bytesize == 0) or
                    (code && code >= MIN_RESERVED_ERROR && code <= MAX_RESERVED_ERROR) or
@@ -366,7 +369,7 @@ module WebSocket
               code = ERRORS[:protocol_error]
             end
 
-            if bytesize > 125 or (bytesize > 2 and reason.nil?)
+            if bytesize > 125 or !reason.valid_encoding?
               code = ERRORS[:protocol_error]
             end
 
@@ -377,7 +380,7 @@ module WebSocket
             emit(:ping, PingEvent.new(payload))
 
           when OPCODES[:pong] then
-            message = Driver.encode(payload, UNICODE)
+            message = Driver.encode(payload, Encoding::UTF_8)
             callback = @ping_callbacks[message]
             @ping_callbacks.delete(message)
             callback.call if callback
@@ -395,7 +398,8 @@ module WebSocket
 
         case message.opcode
           when OPCODES[:text] then
-            payload = Driver.encode(payload, UNICODE)
+            payload = Driver.encode(payload, Encoding::UTF_8)
+            payload = nil unless payload.valid_encoding?
           when OPCODES[:binary]
             payload = payload.bytes.to_a
         end

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/driver/stream_reader.rb

@@ -6,13 +6,13 @@ module WebSocket
       MINIMUM_AUTOMATIC_PRUNE_OFFSET = 128
 
       def initialize
-        @buffer = String.new('').force_encoding(BINARY)
+        @buffer = String.new('').force_encoding(Encoding::BINARY)
         @offset = 0
       end
 
       def put(chunk)
         return unless chunk and chunk.bytesize > 0
-        @buffer << chunk.force_encoding(BINARY)
+        @buffer << chunk.force_encoding(Encoding::BINARY)
       end
 
       # Read bytes from the data:
@@ -42,7 +42,7 @@ module WebSocket
         buffer_size = @buffer.bytesize
 
         if @offset > buffer_size
-          @buffer = String.new('').force_encoding(BINARY)
+          @buffer = String.new('').force_encoding(Encoding::BINARY)
         else
           @buffer = @buffer.byteslice(@offset, buffer_size - @offset)
         end

data/lib/websocket/driver.rb

@@ -44,9 +44,6 @@ module WebSocket
     MAX_LENGTH = 0x3ffffff
     STATES     = [:connecting, :open, :closing, :closed]
 
-    BINARY  = 'ASCII-8BIT'
-    UNICODE = 'UTF-8'
-
     ConnectEvent = Struct.new(nil)
     OpenEvent    = Struct.new(nil)
     MessageEvent = Struct.new(:data)
@@ -118,7 +115,7 @@ module WebSocket
     end
 
     def text(message)
-      message = message.encode(UNICODE) unless message.encoding.name == UNICODE
+      message = Driver.encode(message, Encoding::UTF_8)
       frame(message, :text)
     end
 
@@ -197,25 +194,25 @@ module WebSocket
       end
     end
 
-    def self.encode(string, encoding = nil)
-      case string
-        when Array then
-          string = string.pack('C*')
-          encoding ||= BINARY
-        when String then
-          encoding ||= UNICODE
-      end
-      unless string.encoding.name == encoding
-        string = string.dup if string.frozen?
-        string.force_encoding(encoding)
+    def self.encode(data, encoding = nil)
+      if Array === data
+        encoding ||= Encoding::BINARY
+        return data.pack('C*').force_encoding(encoding)
       end
-      string.valid_encoding? ? string : nil
+
+      encoding ||= Encoding::UTF_8
+
+      return data if data.encoding == encoding
+      return data.encode(encoding) unless data.encoding == Encoding::BINARY
+
+      data = data.dup if data.frozen?
+      data.force_encoding(encoding)
     end
 
     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/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

data/lib/websocket/http/response.rb

@@ -4,7 +4,7 @@ module WebSocket
     class Response
       include Headers
 
-      STATUS_LINE = /^(HTTP\/[0-9]+\.[0-9]+) ([0-9]{3}) ([\x20-\x7e]+)$/
+      STATUS_LINE = /^(HTTP\/[0-9]+\.[0-9]+) ([0-9]{3}) ([\x20-\x7e]*)$/
 
       attr_reader :code
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: websocket-driver
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.7.5
 platform: ruby
 authors:
 - James Coglan
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-06-10 00:00:00.000000000 Z
+date: 2021-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: websocket-extensions
@@ -80,7 +80,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email: jcoglan@gmail.com
 executables: []
 extensions:
@@ -116,7 +116,7 @@ homepage: https://github.com/faye/websocket-driver-ruby
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--main"
 - README.md
@@ -135,8 +135,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: WebSocket protocol handler with pluggable I/O
 test_files: []