websocket-driver 0.7.7 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f871879972966e5137b9e1d791df17db7e6186e35bbf326e156682c7cc092410
-  data.tar.gz: a96b99173f63da1fe2769af05e78a40a51137f7e48cac2ec01d88bb883724c0f
+  metadata.gz: c1f212eb47e19ec359d90624302280cfc94d6fbc9d4bf9a419574fa8531c7d38
+  data.tar.gz: a35ae8ecae5b94d297141eb9bc0f29647614034cc961bc8c4e26a7876aa40a4b
 SHA512:
-  metadata.gz: 41df0469a3e829b6a13ddbbacdd39f81d80f433a14248f0748dc8831848de7c5c4db65539fdc5905d91fdd7fd2bcfaae08048f1ee6652603e79ced492230bab6
-  data.tar.gz: 1920877851a371d6d5493c94bd413fff3ce7f918166506aaa0a3b1a6fcae3961e1da06c315d0fd1bfc94a6c2bd0798f77f6e42429b86ccd9e25c6ad8dcedfa80
+  metadata.gz: 0dd79a8fd32a6380ef832549c1139b1f425f0fe49b33adb32338ce39d5ad9d1d558ce1f33f89c3fefa8464b65a0b9d9664e509e200c55979add09b0cd872e55d
+  data.tar.gz: 87684980b91fb5d6cf1ae8866ab51cd60809fbbba4d90032585c8596797333e8e0e995f1b98cb7269e917de2c501ee524d0c2ff72917457092fa292e51e7e0a9

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+### 0.8.0 / 2025-05-25
+
+- Emit binary message as a string with `Encoding::BINARY` instead of an array
+- Add the option `:binary_data_format` to force the previous behaviour
+
 ### 0.7.7 / 2025-01-04
 
 - Add `base64` gem to the dependencies to support Ruby 3.4

data/README.md

@@ -275,6 +275,10 @@ keys:
 - `:protocols` - an array of strings representing acceptable subprotocols for
   use over the socket. The driver will negotiate one of these to use via the
   `Sec-WebSocket-Protocol` header if supported by the other peer.
+- `:binary_data_format` - in older versions of this library, binary messages
+  were represented as arrays of bytes, whereas they're now represented as
+  strings with `Encoding::BINARY` for performance reasons. Set this option to
+  `:array` to restore the old behaviour.
 
 All drivers respond to the following API methods, but some of them are no-ops
 depending on whether the client supports the behaviour.
@@ -290,8 +294,8 @@ Adds a callback block to execute when the socket becomes open.
 #### `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.
+`data` attribute whose value is a string with the encoding `Encoding::UTF_8` for
+text message, and `Encoding::BINARY` for binary message.
 
 #### `driver.on :error, -> (event) {}`
 
@@ -346,11 +350,12 @@ Sends a text message over the socket. If the socket handshake is not yet
 complete, the message will be queued until it is. Returns `true` if the message
 was sent or queued, and `false` if the socket can no longer send messages.
 
-#### `driver.binary(array)`
+#### `driver.binary(buffer)`
 
-Takes an array of byte-sized integers and sends them as a binary message. Will
-queue and return `true` or `false` the same way as the `text` method. It will
-also return `false` if the driver does not support binary messages.
+Takes either a string with encoding `Encoding::BINARY`, or an array of
+byte-sized integers, and sends it as a binary message. Will queue and return
+`true` or `false` the same way as the `text` method. It will also return `false`
+if the driver does not support binary messages.
 
 #### `driver.ping(string = '', &callback)`
 

data/lib/websocket/driver/hybi.rb

@@ -163,11 +163,13 @@ module WebSocket
         message = Message.new
         frame   = Frame.new
 
-        message.rsv1   = message.rsv2 = message.rsv3 = false
-        message.opcode = OPCODES[type || (String === buffer ? :text : :binary)]
+        is_binary = (Array === buffer or buffer.encoding == Encoding::BINARY)
+        payload   = Driver.encode(buffer, is_binary ? nil : Encoding::UTF_8)
+        payload   = [code, payload].pack('S>a*') if code
+        type    ||= is_binary ? :binary : :text
 
-        payload = Driver.encode(buffer)
-        payload = [code, payload].pack('S>a*') if code
+        message.rsv1 = message.rsv2 = message.rsv3 = false
+        message.opcode = OPCODES[type]
         message.data = payload
 
         if MESSAGE_OPCODES.include?(message.opcode)
@@ -403,7 +405,11 @@ module WebSocket
             payload = Driver.encode(payload, Encoding::UTF_8)
             payload = nil unless payload.valid_encoding?
           when OPCODES[:binary]
-            payload = payload.bytes.to_a
+            if @binary_data_format == :array
+              payload = payload.bytes.to_a
+            else
+              payload = Driver.encode(payload, Encoding::BINARY)
+            end
         end
 
         if payload

data/lib/websocket/driver.rb

@@ -71,7 +71,7 @@ module WebSocket
 
     def initialize(socket, options = {})
       super()
-      Driver.validate_options(options, [:max_length, :masking, :require_masking, :protocols])
+      Driver.validate_options(options, [:max_length, :masking, :require_masking, :protocols, :binary_data_format])
 
       @socket      = socket
       @reader      = StreamReader.new
@@ -80,6 +80,8 @@ module WebSocket
       @headers     = Headers.new
       @queue       = []
       @ready_state = 0
+
+      @binary_data_format = options[:binary_data_format] || :string
     end
 
     def state
@@ -197,17 +199,18 @@ module WebSocket
 
     def self.encode(data, encoding = nil)
       if Array === data
+        data = data.pack('C*')
         encoding ||= Encoding::BINARY
-        return data.pack('C*').force_encoding(encoding)
       end
 
-      encoding ||= Encoding::UTF_8
-
-      return data if data.encoding == encoding
-      return data.encode(encoding) unless data.encoding == Encoding::BINARY
+      return data if encoding.nil? or data.encoding == encoding
 
-      data = data.dup if data.frozen?
-      data.force_encoding(encoding)
+      if data.encoding == Encoding::BINARY
+        data = data.dup if data.frozen?
+        data.force_encoding(encoding)
+      else
+        data.encode(encoding)
+      end
     end
 
     def self.host_header(uri)
@@ -224,6 +227,12 @@ module WebSocket
           raise ConfigurationError, "Unrecognized option: #{ key.inspect }"
         end
       end
+
+      if options[:binary_data_format]
+        unless [:array, :string].include?(options[:binary_data_format])
+          raise ConfigurationError, "Invalid :binary_data_format: #{options[:binary_data_format].inspect}"
+        end
+      end
     end
 
     def self.websocket?(env)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: websocket-driver
 version: !ruby/object:Gem::Version
-  version: 0.7.7
+  version: 0.8.0
 platform: ruby
 authors:
 - James Coglan
 bindir: bin
 cert_chain: []
-date: 2025-01-04 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -127,7 +127,8 @@ files:
 homepage: https://github.com/faye/websocket-driver-ruby
 licenses:
 - Apache-2.0
-metadata: {}
+metadata:
+  changelog_uri: https://github.com/faye/websocket-driver-ruby/blob/main/CHANGELOG.md
 rdoc_options:
 - "--main"
 - README.md
@@ -146,7 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.7
 specification_version: 4
 summary: WebSocket protocol handler with pluggable I/O
 test_files: []