websocket-driver 0.7.6-java → 0.8.0-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9234ae31d300336b8d2faee422f5fe665b1874066b18429c32f3e473ad178903
-  data.tar.gz: d66d556cd9fdcdf3d2392deb9e6c0f41c672c9b10436e9024e0db17a5a083e77
+  metadata.gz: d80d130ef14404b970ec6a87d025d02b10c7be7caa4359cd6c69cd272835366b
+  data.tar.gz: 2baea5897642cf2fb7849467c3bbfcfc56719e67878c7141b1942a107ebb4389
 SHA512:
-  metadata.gz: 9f6b174444c6ee089a9abb11d30480b098d7071914804f76349ceb31e941c8652843878afd794b7e419e20a83c3ab7c8f4af01e44c84865c852cec449287fc91
-  data.tar.gz: c1665d4a0c60ad42a20324918abeed7de14301b4ca6a72ba022211a128865a77e25831fc67714f023fac864812dc18f4fc298656d6e54e8ea8e59ba624531757
+  metadata.gz: ae63f5fb7bd77c6cace3e104188cfdecd5c14ee695dfae034e0e9b671de4acde5199112d73ab04e019b9fdf94f322f06f99990a0b25c6c2772b254e93b093bb1
+  data.tar.gz: 6f2223f6719ae08a3672656fe97a2263dfb0bfc8e206c1fe58f59627562fce257b49a51b71ee330effe03b9b627b84157839d47a312c8725a3d5d6ca1a250961

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+### 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
+
 ### 0.7.6 / 2023-07-25
 
 - Fix handling of default ports in `Host` headers on Ruby 3.1+

data/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright 2010-2023 James Coglan
+Copyright 2010-2025 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

@@ -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,86 +1,98 @@
 --- !ruby/object:Gem::Specification
 name: websocket-driver
 version: !ruby/object:Gem::Version
-  version: 0.7.6
+  version: 0.8.0
 platform: java
 authors:
 - James Coglan
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-25 00:00:00.000000000 Z
+date: 2025-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  name: base64
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.0
-  name: websocket-extensions
+        version: '0'
+  type: :runtime
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: websocket-extensions
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.1.0
 - !ruby/object:Gem::Dependency
+  name: eventmachine
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  name: eventmachine
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
+  name: permessage_deflate
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  name: permessage_deflate
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
+  name: rake-compiler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  name: rake-compiler
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  name: rspec
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
 email: jcoglan@gmail.com
 executables: []
 extensions: []
@@ -115,8 +127,8 @@ files:
 homepage: https://github.com/faye/websocket-driver-ruby
 licenses:
 - Apache-2.0
-metadata: {}
-post_install_message:
+metadata:
+  changelog_uri: https://github.com/faye/websocket-driver-ruby/blob/main/CHANGELOG.md
 rdoc_options:
 - "--main"
 - README.md
@@ -135,8 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.25
-signing_key:
+rubygems_version: 3.6.3
 specification_version: 4
 summary: WebSocket protocol handler with pluggable I/O
 test_files: []