async-websocket 0.30.0 → 0.30.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65d7e723e07e05a813e668c1e4a3dfb82213b1b76955d2e1c8d7f8bcd338de8a
-  data.tar.gz: cbfe2bc3be018398c2c5787052cf5e381a10c3d8695a324be386cb7aef20f0df
+  metadata.gz: 1c4076e31bc3e3d39615d420c66bdbca7943a395096b5c6146a6edc7513519ff
+  data.tar.gz: b3126c73147cb578e7bdd155e032c14eb1cc7d482abfa21867d1f82007b65f93
 SHA512:
-  metadata.gz: 9973e91dc44e1a8e072acd3f9c7c8fb999d62f3c0fc9a4e0e4e45558453e3f780838ed30e7a7216094afe059a5eb9831b06e0a36b92ec5ff5126f94eec8b46c5
-  data.tar.gz: bde87b0d45786863bf68c4c6d463fbc102ab2e3a0fa12c7fff9f346f5594858065d72ae6ee3b2bcfeb9289c1432681fb62f2350abc65d52257b62658ab3186bc
+  metadata.gz: 05acd66f5cb9845e47a52a2c9031453c52d210c2c5fdaf913e64c1bf0fc3191c290cd9927b5fe104d716191442241014f1607497fd4dff0b48e125667b97b529
+  data.tar.gz: e065279f0b8e409f570ff2627501a8371b8c1f4a29a6f056c5627de5a9ee13f675ad1a8a90f909a0ecfc1ececcc7bb823c7744030312f1679ad2ffc3a583cb11

checksums.yaml.gz.sig

@@ -1,3 +1,3 @@
-g��d_�
��5��M�Ώk�%mx$ؙ_!�[|�=�yBC0��פ!�}���ֶ`�F+;��Q�M���P����xLa�GL�+}]
K��g�6TkDWՊ����,v��~�f��J{&�}2c/��#�HJOO�R0�A�3��S��u���x
-9�Z�����*
-3��OB�I:qL�n���1s�
+]i�$-�O'��-f����8�IU�{�� ;�o�D�yH���&��O��<	en
�/ݴ�a%��d��F"�|>�ੑ�b�v8t�9��+Γ�Ə��Ԡ��ل�\q���d������ETF\K�‡�|߁��:*y�.7y����w�Ȗq:tt3�`*g�u� HM~��A!](m-�]Zl��xD`D�{%���	�����s��	]��+9���g��F���T[��\3�������i�(ș
+�u���;�	�(�+���¿���Z�sup��K��id�?_�k�
+�������GO���1��jǢh����͞Ԉt�_V��n]�*��x���.V��Dz�k���0^�W-�>���U´��KM��c����GZr����

data/context/getting-started.md

@@ -0,0 +1,91 @@
+# Getting Started
+
+This guide shows you how to implement a basic client and server.
+
+## Installation
+
+Add the gem to your project:
+
+~~~ bash
+$ bundle add async-websocket
+~~~
+
+## Overview Video
+
+<content:youtube-video id="aHop4Yyjs_o" />
+
+## Client Implementation
+
+~~~ ruby
+#!/usr/bin/env ruby
+
+require 'async'
+require 'async/http/endpoint'
+require 'async/websocket/client'
+
+USER = ARGV.pop || "anonymous"
+URL = ARGV.pop || "http://localhost:7070"
+
+Async do |task|
+	endpoint = Async::HTTP::Endpoint.parse(URL)
+	
+	Async::WebSocket::Client.connect(endpoint) do |connection|
+		input_task = task.async do
+			while line = $stdin.gets
+				connection.write({user: USER, text: line})
+				connection.flush
+			end
+		end
+		
+		# Generate a text message by geneating a JSON payload from a hash:
+		connection.write(Protocol::WebSocket::TextMessage.generate({
+			user: USER,
+			status: "connected",
+		}))
+		
+		while message = connection.read
+			puts message.inspect
+		end
+	ensure
+		input_task&.stop
+	end
+end
+~~~
+
+### Force HTTP/1 Connection
+
+This forces the endpoint to connect using `HTTP/1.1`.
+
+~~~ ruby
+endpoint = Async::HTTP::Endpoint.parse("https://remote-server.com", alpn_protocols: Async::HTTP::Protocol::HTTP11.names)
+
+Async::WebSocket::Client.connect(endpoint) do ...
+~~~
+
+You may want to use this if the server advertises `HTTP/2` but doesn't support `HTTP/2` for WebSocket connections.
+
+## Server Side with Rack & Falcon
+
+~~~ ruby
+#!/usr/bin/env -S falcon serve --bind http://localhost:7070 --count 1 -c
+
+require 'async/websocket/adapters/rack'
+require 'set'
+
+$connections = Set.new
+
+run lambda {|env|
+	Async::WebSocket::Adapters::Rack.open(env, protocols: ['ws']) do |connection|
+		$connections << connection
+		
+		while message = connection.read
+			$connections.each do |connection|
+				connection.write(message)
+				connection.flush
+			end
+		end
+	ensure
+		$connections.delete(connection)
+	end or [200, {}, ["Hello World"]]
+}
+~~~

data/context/index.yaml

@@ -0,0 +1,15 @@
+# Automatically generated context index for Utopia::Project guides.
+# Do not edit then files in this directory directly, instead edit the guides and then run `bake utopia:project:agent:context:update`.
+---
+description: An async websocket library on top of protocol-websocket.
+metadata:
+  documentation_uri: https://socketry.github.io/async-websocket/
+  funding_uri: https://github.com/sponsors/ioquatix
+  source_code_uri: https://github.com/socketry/async-websocket.git
+files:
+- path: getting-started.md
+  title: Getting Started
+  description: This guide shows you how to implement a basic client and server.
+- path: rails-integration.md
+  title: Rails Integration
+  description: This guide explains how to use `async-websocket` with Rails.

data/context/rails-integration.md

@@ -0,0 +1,121 @@
+# Rails Integration
+
+This guide explains how to use `async-websocket` with Rails.
+
+## Project Setup
+
+Firstly, we will create a new project for the purpose of this guide:
+
+~~~ bash
+$ rails new websockets
+--- snip ---
+~~~
+
+Then, we need to add the `Async::WebSocket` gem:
+
+~~~ bash
+$ bundle add async-websocket
+~~~
+
+## Adding the WebSocket Controller
+
+Firstly, generate the controller with a single method:
+
+~~~ bash
+$ rails generate controller home index
+~~~
+
+Then edit your controller implementation:
+
+~~~ ruby
+require 'async/websocket/adapters/rails'
+
+class HomeController < ApplicationController
+	# WebSocket clients may not send CSRF tokens, so we need to disable this check.
+	skip_before_action :verify_authenticity_token, only: [:index]
+	
+	def index
+		self.response = Async::WebSocket::Adapters::Rails.open(request) do |connection|
+			message = Protocol::WebSocket::TextMessage.generate({message: "Hello World"})
+			connection.write(message)
+		end
+	end
+end
+~~~
+
+### Testing
+
+You can quickly test that the above controller is working. First, start the Rails server:
+
+~~~ bash
+$ rails s
+=> Booting Puma
+=> Rails 7.2.0.beta2 application starting in development 
+=> Run `bin/rails server --help` for more startup options
+~~~
+
+Then you can connect to the server using a WebSocket client:
+
+~~~ bash
+$ websocat ws://localhost:3000/home/index
+{"message":"Hello World"}
+~~~
+
+### Using Falcon
+
+The default Rails server (Puma) is not suitable for handling a large number of connected WebSocket clients, as it has a limited number of threads (typically between 8 and 16). Each WebSocket connection will require a thread, so the server will quickly run out of threads and be unable to accept new connections. To solve this problem, we can use [Falcon](https://github.com/socketry/falcon) instead, which uses a fiber-per-request architecture and can handle a large number of connections.
+
+We need to remove Puma and add Falcon::
+
+~~~ bash
+$ bundle remove puma
+$ bundle add falcon
+~~~
+
+Now when you start the server you should see something like this:
+
+~~~ bash
+$ rails s
+=> Booting Falcon v0.47.7
+=> Rails 7.2.0.beta2 application starting in development http://localhost:3000
+=> Run `bin/rails server --help` for more startup options
+~~~
+
+
+### Using HTTP/2
+
+Falcon supports HTTP/2, which can be used to improve the performance of WebSocket connections. HTTP/1.1 requires a separate TCP connection for each WebSocket connection, while HTTP/2 can handle multiple requessts and WebSocket connections over a single TCP connection. To use HTTP/2, you'd typically use `https`, which allows the client browser to use application layer protocol negotiation (ALPN) to negotiate the use of HTTP/2.
+
+HTTP/2 WebSockets are a bit different from HTTP/1.1 WebSockets. In HTTP/1, the client sends a `GET` request with the `upgrade:` header. In HTTP/2, the client sends a `CONNECT` request with the `:protocol` pseud-header. The Rails routes must be adjusted to accept both methods:
+
+~~~ ruby
+Rails.application.routes.draw do
+	# Previously it was this:
+	# get "home/index"
+	match "home/index", to: "home#index", via: [:get, :connect]
+end
+~~~
+
+Once this is done, you need to bind falcon to an `https` endpoint:
+
+~~~ bash
+$ falcon serve --bind "https://localhost:3000"
+~~~
+
+It's a bit more tricky to test this, but you can do so with the following Ruby code:
+
+~~~ ruby
+require 'async/http/endpoint'
+require 'async/websocket/client'
+
+endpoint = Async::HTTP::Endpoint.parse("https://localhost:3000/home/index")
+
+Async::WebSocket::Client.connect(endpoint) do |connection|
+	puts connection.framer.connection.class
+	# Async::HTTP::Protocol::HTTP2::Client
+	
+	while message = connection.read
+		puts message.inspect
+	end
+end
+~~~

data/lib/async/websocket/adapters/http.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2024, by Samuel Williams.
+# Copyright, 2021-2026, by Samuel Williams.
 # Copyright, 2021, by Aurora Nockert.
 
 require_relative "../connection"
@@ -16,7 +16,7 @@ module Async
 				include ::Protocol::WebSocket::Headers
 				
 				def self.websocket?(request)
-					Array(request.protocol).any? { |e| e.casecmp?(PROTOCOL) }
+					Array(request.protocol).any?{|e| e.casecmp?(PROTOCOL)}
 				end
 				
 				def self.open(request, headers: [], protocols: [], handler: Connection, extensions: ::Protocol::WebSocket::Extensions::Server.default, **options, &block)

data/lib/async/websocket/client.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2015-2024, by Samuel Williams.
+# Copyright, 2015-2026, by Samuel Williams.
 # Copyright, 2019, by Bryan Powell.
 # Copyright, 2019, by Janko Marohnić.
 # Copyright, 2023, by Thomas Morgan.
@@ -62,7 +62,6 @@ module Async
 					
 					begin
 						yield connection
-						
 					ensure
 						connection&.close
 						client&.close

data/lib/async/websocket/version.rb

@@ -5,6 +5,6 @@
 
 module Async
 	module WebSocket
-		VERSION = "0.30.0"
+		VERSION = "0.30.1"
 	end
 end

data/license.md

@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright, 2015-2024, by Samuel Williams.  
+Copyright, 2015-2026, by Samuel Williams.  
 Copyright, 2019, by Bryan Powell.  
 Copyright, 2019, by Simon Crocker.  
 Copyright, 2019, by Michel Boaventura.  

data/readme.md

@@ -12,6 +12,58 @@ Please see the [project documentation](https://socketry.github.io/async-websocke
 
   - [Rails Integration](https://socketry.github.io/async-websocket/guides/rails-integration/index) - This guide explains how to use `async-websocket` with Rails.
 
+## Releases
+
+Please see the [project releases](https://socketry.github.io/async-websocket/releases/index) for all releases.
+
+### v0.30.1
+
+### v0.30.0
+
+  - Improved error handling.
+  - Modernized the gem and refreshed dependencies.
+
+### v0.29.1
+
+  - Improved `connection&.close` handling.
+
+### v0.29.0
+
+  - Added nonce processing to HTTP/2 WebSockets for HTTP/1 proxy compatibility.
+
+### v0.28.0
+
+  - Added `ConnectionError` with access to the failed response.
+
+### v0.27.0
+
+  - Updated the Rails integration guide summary.
+  - Modernized the gem and refreshed dependencies.
+
+### v0.26.2
+
+  - Compared requested WebSocket protocols case-insensitively.
+  - Updated the Binance, chat, MUD, and Rack examples.
+  - Improved documentation, including the Rails integration guide.
+  - Removed obsolete Polygon.io and Utopia examples.
+
+### v0.26.1
+
+  - Removed the direct dependency on `async-io`.
+  - Updated the `sus-fixtures-async-http` dependency.
+
+### v0.26.0
+
+  - Improved validation of WebSocket requests.
+  - Ensured HTTP/2 requests include the `:scheme` pseudo-header.
+  - Improved HTTP/1 stream checks.
+  - Fixed arguments passed to 404 responses.
+  - Updated documentation and links.
+
+### v0.25.1
+
+  - Updated the minimum `protocol-websocket` version.
+
 ## Contributing
 
 We welcome contributions to this project.
@@ -22,6 +74,22 @@ We welcome contributions to this project.
 4.  Push to the branch (`git push origin my-new-feature`).
 5.  Create new Pull Request.
 
+### Running Tests
+
+To run the test suite:
+
+``` shell
+bundle exec sus
+```
+
+### Making Releases
+
+To make a new release:
+
+``` shell
+bundle exec bake gem:release:patch # or minor or major
+```
+
 ### Developer Certificate of Origin
 
 In order to protect users of this project, we require all contributors to comply with the [Developer Certificate of Origin](https://developercertificate.org/). This ensures that all contributions are properly licensed and attributed.

data/releases.md

@@ -0,0 +1,249 @@
+# Releases
+
+## v0.30.1
+
+## v0.30.0
+
+  - Improved error handling.
+  - Modernized the gem and refreshed dependencies.
+
+## v0.29.1
+
+  - Improved `connection&.close` handling.
+
+## v0.29.0
+
+  - Added nonce processing to HTTP/2 WebSockets for HTTP/1 proxy compatibility.
+
+## v0.28.0
+
+  - Added `ConnectionError` with access to the failed response.
+
+## v0.27.0
+
+  - Updated the Rails integration guide summary.
+  - Modernized the gem and refreshed dependencies.
+
+## v0.26.2
+
+  - Compared requested WebSocket protocols case-insensitively.
+  - Updated the Binance, chat, MUD, and Rack examples.
+  - Improved documentation, including the Rails integration guide.
+  - Removed obsolete Polygon.io and Utopia examples.
+
+## v0.26.1
+
+  - Removed the direct dependency on `async-io`.
+  - Updated the `sus-fixtures-async-http` dependency.
+
+## v0.26.0
+
+  - Improved validation of WebSocket requests.
+  - Ensured HTTP/2 requests include the `:scheme` pseudo-header.
+  - Improved HTTP/1 stream checks.
+  - Fixed arguments passed to 404 responses.
+  - Updated documentation and links.
+
+## v0.25.1
+
+  - Updated the minimum `protocol-websocket` version.
+
+## v0.25.0
+
+  - Allowed arguments to be passed through to `#close`.
+  - Improved close behavior.
+
+## v0.24.0
+
+  - Used standard response handling for Rails.
+
+## v0.23.1
+
+  - Relaxed the dependency on `protocol-websocket`.
+
+## v0.23.0
+
+  - Ensured clients are closed when their connections are closed.
+  - Fixed the `Server` implementation.
+  - Removed an unused `@response` instance variable.
+  - Improved coverage for `Client`, `Connection`, `Response`, and dangling connection handling.
+  - Added early Rails documentation.
+
+## v0.22.1
+
+  - Added a missing `protocol/rack/adapter` require.
+  - Updated the chat example for the message-based protocol interface.
+  - Migrated tests to `sus`.
+  - Updated examples for Rack 3 and high-connection-count usage.
+
+## v0.22.0
+
+  - Removed default JSON parsing.
+  - Updated the connection interface to use message-based `read` and `write`.
+
+## v0.21.0
+
+  - Added support for WebSocket extensions.
+
+## v0.20.0
+
+  - Made protocol handling Falcon-agnostic.
+
+## v0.19.2
+
+  - Removed an unused require.
+  - Modernized the gem.
+
+## v0.19.1
+
+  - Made protocol upgrades case-insensitive.
+  - Used bound endpoints in server tests to avoid race conditions.
+  - Added an example using `wscat`.
+  - Adopted `bake-gem` for release management.
+
+## v0.19.0
+
+  - Added an `http` adapter.
+  - Added a Binance HTTP/1 client example.
+  - Fixed client handling in `Client#connect`.
+  - Updated logging to use `Console.logger`.
+
+## v0.18.0
+
+  - Added a Rails adapter.
+
+## v0.17.0
+
+  - Added support for reconnecting after server disconnection.
+  - Updated keyword argument handling.
+  - Updated Utopia examples and dependencies.
+
+## v0.16.0
+
+  - Always applied masking to client connections.
+  - Passed `endpoint.authority` through to `#connect`.
+  - Added a Polygon.io client example.
+  - Fixed `GC.count` logging.
+
+## v0.15.0
+
+  - Improved connection handling and releasing connections back to the pool.
+  - Ensured Rack response headers are returned as a hash.
+  - Added static documentation.
+  - Modernized the gem and improved documentation.
+
+## v0.14.0
+
+  - Reduced memory usage in high-connection-count examples.
+  - Avoided repeated `getaddrinfo` calls per connection.
+  - Added explicit connection management.
+  - Added documentation for `Client.open` and `Client.connect`.
+  - Improved HTTP/1 forcing, Rack, MUD, and Utopia examples.
+  - Added profiling support.
+  - Switched release tooling toward `bake-bundler`.
+
+## v0.13.1
+
+  - Fixed HTTP/2 client output body handling.
+  - Added HTTP/2 WebSocket support to the chat example.
+  - Added message read/write coverage.
+
+## v0.13.0
+
+  - Passed all options through to `connect`.
+
+## v0.12.2
+
+  - Updated examples and documentation to use `Adapters::Rack`.
+  - Removed debug logging.
+  - Refreshed dependencies.
+
+## v0.12.1
+
+  - Closed and flushed connections automatically when users did not close them explicitly.
+
+## v0.12.0
+
+  - Added links to relevant RFCs and documented HTTP/2 support.
+  - Removed an unused response field.
+
+## v0.11.1
+
+  - Fixed examples.
+
+## v0.11.0
+
+  - Started support for both HTTP/1 and HTTP/2 WebSockets.
+  - Renamed `URLEndpoint` to `Endpoint`.
+  - Preferred `endpoint` terminology over `server_address`.
+  - Moved protocol constants into the protocol gem.
+  - Fixed client specs.
+
+## v0.10.0
+
+  - Improved upgrade and masking handling.
+  - Allowed user-provided connection handlers.
+  - Refactored connection IO to use `Connection#read` and `Connection#write`.
+  - Added a simple MUD example.
+  - Removed the broken Utopia example.
+
+## v0.9.0
+
+  - Switched to `protocol-websocket`.
+  - Added protocol negotiation and frame validation.
+  - Exposed the underlying socket.
+  - Improved client/server examples and EOF handling.
+  - Removed redundant headers.
+
+## v0.8.0
+
+  - Added support for `sec-websocket-protocol` options.
+  - Added support for passing protocols and normalized client/server option handling.
+
+## v0.7.0
+
+  - Set headers on WebSocket driver clients.
+  - Added more README examples.
+  - Preferred `Async do` in examples.
+
+## v0.6.1
+
+  - Avoided closing connections from `Connection`; client and server lifecycle now close them explicitly.
+
+## v0.6.0
+
+  - Improved handling of hijacked IO.
+
+## v0.5.0
+
+  - Added a simple web-based chat app.
+  - Added partial support for Rack hijacking changes.
+  - Preferred `#readpartial` for input loops.
+  - Used the stream block size for reads.
+
+## v0.4.1
+
+  - Handled `Errno::ECONNRESET`.
+
+## v0.4.0
+
+  - Updated examples and documentation.
+  - Improved peer handling from call results.
+
+## v0.3.0
+
+  - Added example chat client and server.
+  - Reworked legacy code and fixed specs.
+
+## v0.2.0
+
+  - Renamed the gem to `async-websocket`.
+  - Tidied legacy socket lifetime management.
+  - Converted connection handling to sequential logic.
+  - Improved data stream handling.
+  - Handled EOF.
+
+## v0.1.0
+
+  - Added the initial synchronous WebSocket implementation.
+  - Added specs and fixed early implementation issues.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: async-websocket
 version: !ruby/object:Gem::Version
-  version: 0.30.0
+  version: 0.30.1
 platform: ruby
 authors:
 - Samuel Williams
@@ -17,7 +17,6 @@ authors:
 - Michel Boaventura
 - Peter Runich
 - Ryu Sato
-autorequire:
 bindir: bin
 cert_chain:
 - |
@@ -49,7 +48,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-09-11 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-http
@@ -107,12 +106,13 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.17'
-description:
-email:
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- context/getting-started.md
+- context/index.yaml
+- context/rails-integration.md
 - lib/async/websocket.rb
 - lib/async/websocket/adapters/http.rb
 - lib/async/websocket/adapters/rack.rb
@@ -130,6 +130,7 @@ files:
 - lib/async/websocket/version.rb
 - license.md
 - readme.md
+- releases.md
 homepage: https://github.com/socketry/async-websocket
 licenses:
 - MIT
@@ -137,7 +138,6 @@ metadata:
   documentation_uri: https://socketry.github.io/async-websocket/
   funding_uri: https://github.com/sponsors/ioquatix
   source_code_uri: https://github.com/socketry/async-websocket.git
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -145,15 +145,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 4.0.10
 specification_version: 4
 summary: An async websocket library on top of protocol-websocket.
 test_files: []