websocket-driver 0.7.3 → 0.7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11392831462e0bee833bdb3ac3f6f09de232e2e8cc7a19799ce0ebb8e7238ea1
-  data.tar.gz: 3b4555cc645e77d0166ff9657dc23c306bf48296e94a1520de703f9ab72120f1
+  metadata.gz: 046c514660d2c0dab2cf42bce8314a17e713909377a5da470beaeadf666ff28e
+  data.tar.gz: 9830c412394044d102dd6f313346721076ef0f97284d6182aeb06862e1f427b2
 SHA512:
-  metadata.gz: 378aaf1b46a663dccd4dbc8ec25e515e9acb7b2c760b7b62c199185e11466d9c2fd6482b17fb51157a03030e0c9065c7f6a6201c61a7f45fc940365cce036626
-  data.tar.gz: 783523c78a09ced14fe3e4be497b7fb5e6f22755d6b2dafa5b9b02ed72427512d7b70185dbff43e1df3a924fa086a28334403d7c02b5bc2762fbb33dcf339e3a
+  metadata.gz: cea4027f342f51a688c8004a92ca29b68af9a9395b5e7f8d2462b8742067862718d23f4be9ca6162f761774490e4cdf33111bb746f9221d5acace6546a749b35
+  data.tar.gz: d124aa6acf1cbfa498b44d02d6aa659c99e97e177441e8cbd43958db38c6cf03d703d26ae73998a09719c0612f538554049d58b58aa8cc8ab5f0bb458e27c988

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+### 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

data/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright 2010-2020 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
 

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,19 +194,19 @@ 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)

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

@@ -9,7 +9,7 @@ module WebSocket
         input  = (@socket.env['rack.input'] || StringIO.new('')).read
         input  = input.dup if input.frozen?
         @stage = -1
-        @body  = input.force_encoding(BINARY)
+        @body  = input.force_encoding(Encoding::BINARY)
 
         @headers.clear
         @headers['Upgrade'] = 'WebSocket'

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
@@ -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
@@ -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/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/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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: websocket-driver
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 0.7.5
 platform: ruby
 authors:
 - James Coglan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-09 00:00:00.000000000 Z
+date: 2021-06-12 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.1.2
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: WebSocket protocol handler with pluggable I/O