async-websocket 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43a7d40f381a9a3874e3fda412627762d30d2354975e94b6550bda29f75fd26d
-  data.tar.gz: 197f5ba2209b7bcc8d2eec2e600265ca1b5e59b264967a64da7f416761b9c6a4
+  metadata.gz: 0d90af5dc72de1e262ea96046aac6d5aea83dd2dba9d7a6f98684da3107d152d
+  data.tar.gz: 9544351dc684062ea0a78b50d15bf9441d18f401fd23fc30eae768a8ef45cd86
 SHA512:
-  metadata.gz: 26a221435af1324568f92f7ab2317c16add07196a8eeca36108d226cfccf79cc5f8ad264c3a22b41cf245725e3bb20c148b37e3d71b644bd8ea4ff1373e149e0
-  data.tar.gz: 982f6ca5dce50b3e230850d298f23cf1410c7c084a503ca52da60b6edcde2efc0f2e9143a500a165de482b72fb32cdfd1b6c71434e44be07b36c6669001195e1
+  metadata.gz: 22130d886d22511b6c9478f5035af01aed0dd00225582857d0bc28b864470f47568e0c38a62afb8a46227285009a227f9f2b222b0b5383c0ccaef455beede1bf
+  data.tar.gz: 3b9517e0cdaec509d72246776784024a171ba371b7284213e6064cb679b762417560556e00a6f76d164e0aa0c9e5272daa4ee076b31796834f468e30011b14a5

data/README.md

@@ -35,7 +35,7 @@ There are [examples](examples/) which include:
 
 require 'async'
 require 'async/io/stream'
-require 'async/http/url_endpoint'
+require 'async/http/endpoint'
 require 'async/websocket/client'
 
 USER = ARGV.pop || "anonymous"
@@ -46,7 +46,7 @@ Async do |task|
 		Async::IO::Generic.new($stdin)
 	)
 	
-	endpoint = Async::HTTP::URLEndpoint.parse(URL)
+	endpoint = Async::HTTP::Endpoint.parse(URL)
 	
 	Async::WebSocket::Client.open(endpoint) do |connection|
 		input_task = task.async do

data/async-websocket.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
 	spec.require_paths = ["lib"]
 	
 	spec.add_dependency "async-io", "~> 1.23"
-	spec.add_dependency "protocol-http1", "~> 0.4"
+	spec.add_dependency "async-http", "~> 0.41"
 	spec.add_dependency "protocol-websocket", "~> 0.5.0"
 	
 	spec.add_development_dependency "async-rspec"

data/examples/chat/client.rb

@@ -2,12 +2,12 @@
 
 require 'async'
 require 'async/io/stream'
-require 'async/http/url_endpoint'
+require 'async/http/endpoint'
 require_relative '../../lib/async/websocket/client'
 
 USER = ARGV.pop || "anonymous"
 URL = ARGV.pop || "http://127.0.0.1:8080"
-ENDPOINT = Async::HTTP::URLEndpoint.parse(URL)
+ENDPOINT = Async::HTTP::Endpoint.parse(URL)
 
 Async do |task|
 	stdin = Async::IO::Stream.new(

data/examples/chat/multi-client.rb

@@ -4,7 +4,7 @@ require 'async'
 require 'async/semaphore'
 require 'async/clock'
 require 'async/io/stream'
-require 'async/http/url_endpoint'
+require 'async/http/endpoint'
 require_relative '../../lib/async/websocket/client'
 
 require 'samovar'
@@ -30,7 +30,7 @@ class Command < Samovar::Command
 	end
 	
 	def call
-		endpoint = Async::HTTP::URLEndpoint.parse(@options[:connect], local_address: self.local_address)
+		endpoint = Async::HTTP::Endpoint.parse(@options[:connect], local_address: self.local_address)
 		count = @options[:count]
 		
 		connections = Async::Queue.new

data/examples/mud/client.rb

@@ -2,7 +2,7 @@
 
 require 'async'
 require 'async/io/stream'
-require 'async/http/url_endpoint'
+require 'async/http/endpoint'
 require 'async/websocket/client'
 
 USER = ARGV.pop || "anonymous"
@@ -13,7 +13,7 @@ Async do |task|
 		Async::IO::Generic.new($stdin)
 	)
 	
-	endpoint = Async::HTTP::URLEndpoint.parse(URL)
+	endpoint = Async::HTTP::Endpoint.parse(URL)
 	
 	Async::WebSocket::Client.open(endpoint) do |connection|
 		task.async do

data/examples/utopia/Gemfile

@@ -1,9 +1,7 @@
 
 source "https://rubygems.org"
 
-gem "utopia", "~> 2.3.0"
-# gem "utopia-gallery"
-# gem "utopia-analytics"
+gem "utopia", "~> 2.9.0"
 
 gem "rake"
 gem "bundler"

data/examples/utopia/pages/server/controller.rb

@@ -1,12 +1,13 @@
 
 prepend Actions
 
-require 'async/websocket/server'
+require 'async/websocket/server/rack'
+require 'set'
 
-$connections = []
+$connections = Set.new
 
 on 'connect' do |request|
-	respond? Async::WebSocket::Server::Rack.open(request.env) do |connection|
+	response = Async::WebSocket::Server::Rack.open(request.env) do |connection|
 		$connections << connection
 		
 		while message = connection.read
@@ -15,5 +16,11 @@ on 'connect' do |request|
 				connection.write(message)
 			end
 		end
+	ensure
+		$connections.delete(connection)
 	end
+	
+	Async.logger.info(self, request, response)
+	
+	respond?(response)
 end

data/examples/utopia/spec/website_spec.rb

@@ -4,7 +4,7 @@ require_relative 'website_context'
 require 'falcon/server'
 require 'falcon/adapters/rack'
 
-require 'async/http/url_endpoint'
+require 'async/http/endpoint'
 require 'async/websocket/client'
 
 # Learn about best practice specs from http://betterspecs.org
@@ -22,7 +22,7 @@ RSpec.describe "my website" do
 	context "websockets" do
 		include_context Async::RSpec::Reactor
 		
-		let(:endpoint) {Async::HTTP::URLEndpoint.parse("http://localhost:9282")}
+		let(:endpoint) {Async::HTTP::Endpoint.parse("http://localhost:9282")}
 		let(:server) {Falcon::Server.new(Falcon::Adapters::Rack.new(app), endpoint)}
 		
 		let(:hello_message) do

data/lib/async/websocket.rb

@@ -21,5 +21,3 @@
 require_relative 'websocket/version'
 require_relative 'websocket/server'
 require_relative 'websocket/client'
-
-require 'async/io'

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

@@ -0,0 +1,62 @@
+# frozen_string_literals: true
+#
+# Copyright, 2019, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require_relative '../connection'
+
+module Async
+	module WebSocket
+		module Adapters
+			module Rack
+				include ::Protocol::WebSocket::Headers
+				
+				def self.websocket?(env)
+					request = env['async.http.request'] and Array(request.protocol).include?(PROTOCOL)
+				end
+				
+				def self.open(env, headers: [], protocols: [], handler: Connection, **options, &block)
+					if request = env['async.http.request'] and Array(request.protocol).include?(PROTOCOL)
+						# Select websocket sub-protocol:
+						if requested_protocol = request.headers[SEC_WEBSOCKET_PROTOCOL]
+							protocol = (requested_protocol & protocols).first
+						end
+						
+						response = Response.for(request, headers, protocol: protocol, **options) do |stream|
+							framer = Protocol::WebSocket::Framer.new(stream)
+							
+							yield handler.call(framer, protocol)
+						end
+						
+						headers = response.headers
+						
+						if protocol = response.protocol
+							headers = Protocol::HTTP::Headers::Merged.new(headers, [
+								['rack.protocol', protocol]
+							])
+						end
+						
+						return [response.status, headers, response.body]
+					end
+				end
+			end
+		end
+	end
+end

data/lib/async/websocket/client.rb

@@ -20,99 +20,64 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require 'protocol/http1/connection'
-require 'protocol/websocket/digest'
+require_relative 'request'
 
-require 'securerandom'
+require 'protocol/websocket/headers'
 
-require_relative 'connection'
-require_relative 'error'
+require 'protocol/http/middleware'
 
 module Async
 	module WebSocket
 		# This is a basic synchronous websocket client:
-		class Client
-			def self.open(endpoint, **options, &block)
-				# endpoint = Async::HTTP::URLEndpoint.parse(url)
-				client = self.new(endpoint, **options)
-				
-				return client unless block_given?
-				
-				client.get(endpoint.path, &block)
-			end
+		class Client < ::Protocol::HTTP::Middleware
+			include ::Protocol::WebSocket::Headers
 			
-			# @option protocols [Array] a list of supported sub-protocols to negotiate with the server.
-			def initialize(endpoint, headers: [], protocols: [], version: 13, key: SecureRandom.base64(16), connect: Connection)
-				@endpoint = endpoint
-				@version = version
-				@headers = headers
+			def self.open(endpoint, *args, &block)
+				client = self.new(HTTP::Client.new(endpoint, *args), mask: endpoint.secure?)
 				
-				@protocols = protocols
-				@key = key
+				return client unless block_given?
 				
-				@connect = connect
-			end
-			
-			def mask
-				# Mask is only required on insecure connections, because of bad proxy implementations.
-				unless @endpoint.secure?
-					SecureRandom.bytes(4)
+				begin
+					yield client
+				ensure
+					client.close
 				end
 			end
 			
-			attr :headers
-			
-			def connect
-				stream = IO::Stream.new(@endpoint.connect)
-				
-				return ::Protocol::HTTP1::Connection.new(stream, false)
-			end
-			
-			def request_headers
-				headers = [
-					['sec-websocket-key', @key],
-					['sec-websocket-version', @version]
-				] + @headers.to_a
-				
-				if @protocols.any?
-					headers << ['sec-websocket-protocol', @protocols.join(',')]
+			def self.connect(endpoint, *args, protocols: [], **options, &block)
+				self.open(endpoint, *args, **options) do |client|
+					connection = client.connect(endpoint.path, protocols: protocols)
+					
+					return connection unless block_given?
+					
+					begin
+						yield connection
+					ensure
+						connection.close
+					end
 				end
-				
-				return headers
-			end
-			
-			def get(path = '/', &block)
-				self.call('GET', path, &block)
 			end
 			
-			HTTP_VERSION = 'HTTP/1.0'.freeze
-			
-			def make_connection(stream, headers)
-				protocol = headers['sec-websocket-protocol']&.first
-				
-				framer = Protocol::WebSocket::Framer.new(stream)
+			def initialize(delegate, **options)
+				super(delegate)
 				
-				return @connect.call(framer, protocol, mask: self.mask)
+				@options = options
 			end
 			
-			def call(method, path)
-				client = connect
-				client.upgrade!("websocket")
+			def connect(path, headers: [], handler: Connection, **options)
+				request = Request.new(nil, nil, path, headers, **options)
 				
-				client.write_request(@endpoint.authority, method, @endpoint.path, HTTP_VERSION, self.request_headers)
-				stream = client.write_upgrade_body
+				response = self.call(request)
 				
-				version, status, reason, headers, body = client.read_response(method)
+				unless response.stream?
+					raise ProtocolError, "Failed to negotiate connection: #{response.status}"
+				end
 				
-				raise ProtocolError, "Expected status 101, got #{status}!" unless status == 101
+				protocol = response.headers[SEC_WEBSOCKET_PROTOCOL]&.first
+				framer = Protocol::WebSocket::Framer.new(response.stream)
 				
-				accept_digest = headers['sec-websocket-accept'].first
-				if accept_digest.nil? or accept_digest != ::Protocol::WebSocket.accept_digest(@key)
-					raise ProtocolError, "Invalid accept header, got #{accept_digest.inspect}!"
-				end
+				connection = handler.call(framer, protocol, **@options)
 				
-				connection = make_connection(stream, headers)
-					
 				return connection unless block_given?
 				
 				begin

data/lib/async/websocket/connect_request.rb

@@ -0,0 +1,89 @@
+# frozen_string_literals: true
+#
+# Copyright, 2015, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require 'protocol/http/request'
+require 'protocol/http/headers'
+require 'protocol/websocket/headers'
+
+module Async
+	module WebSocket
+		# This is required for HTTP/1.x to upgrade the connection to the WebSocket protocol.
+		# See https://tools.ietf.org/html/rfc8441 for more details.
+		class ConnectRequest < ::Protocol::HTTP::Request
+			include ::Protocol::WebSocket::Headers
+			
+			class Wrapper
+				def initialize(body, response)
+					@body = body
+					@response = response
+					@stream = nil
+				end
+				
+				def stream?
+					@response.success?
+				end
+				
+				def status
+					@response.status
+				end
+				
+				def headers
+					@response.headers
+				end
+				
+				def body?
+					true
+				end
+				
+				attr_accessor :body
+				
+				def protocol
+					@response.protocol
+				end
+				
+				def stream
+					@stream ||= Async::HTTP::Body::Stream.new(@response.body, @body)
+				end
+			end
+			
+			def initialize(request, protocols: [], version: 13)
+				body = Async::HTTP::Body::Writable.new
+				
+				headers = []
+				
+				headers << [SEC_WEBSOCKET_VERSION, version]
+				
+				if protocols.any?
+					headers << [SEC_WEBSOCKET_PROTOCOL, protocols.join(',')]
+				end
+				
+				merged_headers = ::Protocol::HTTP::Headers::Merged.new(request.headers, headers)
+				
+				super(request.scheme, request.authority, ::Protocol::HTTP::Methods::CONNECT, request.path, nil, merged_headers, body, PROTOCOL)
+			end
+			
+			def call(connection)
+				Wrapper.new(@body, super)
+			end
+		end
+	end
+end

data/lib/async/websocket/connect_response.rb

@@ -0,0 +1,44 @@
+# frozen_string_literals: true
+#
+# Copyright, 2015, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require 'protocol/http/response'
+require 'async/http/body/hijack'
+
+module Async
+	module WebSocket
+		# The response from the server back to the client for negotiating HTTP/2 WebSockets.
+		class ConnectResponse < ::Protocol::HTTP::Response
+			include ::Protocol::WebSocket::Headers
+			
+			def initialize(request, headers = nil, protocol: nil, &block)
+				headers = Protocol::HTTP::Headers::Merged.new(headers)
+				
+				if protocol
+					headers << [[SEC_WEBSOCKET_PROTOCOL, protocol]]
+				end
+				
+				body = Async::HTTP::Body::Hijack.wrap(request, &block)
+				super(request.version, 200, nil, headers, body)
+			end
+		end
+	end
+end