async-http 0.68.0 → 0.69.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 232e7394f119e448ebf2e16f2064d660ba164c852a23dc6d15c7cd7d3984d4de
-  data.tar.gz: 27bf2b400b9b4bab65cb2fee22ec75ed0ff74210fb61d53a1932ab3d8c6e9615
+  metadata.gz: 9f4a2ceef3a210332512cbe39f7bcac65cecaf23308f151534cfeb955fccb3e1
+  data.tar.gz: a44a6b0f61b2bdbf81b868e1e05bfe7e45855bc92a3efdc266534688d9f84fd8
 SHA512:
-  metadata.gz: ab4cf960886ec3f8efdd0587fef2214213d09aabd8501d8c2fb212da706c78c2df73fe9dff7ce0d882945727fd7dc6635650658a5b84421b07257d94c5a2d435
-  data.tar.gz: 70aea8682c576a672afc7b0f009f03a2ed8fadfe33c5e39e668754d9c6dd3d0e875d40734447d3983d8b11f0b5e92ce275d282766844e2552431476a74837b0f
+  metadata.gz: 22f65ce662e632e0d7836f13c12db69f86305ecae5e88ccf97ace1e0dc3c861e5af4fce7877dd489fec2be48031dfef99b1b697c1c0153df9670f095061465e4
+  data.tar.gz: 9cfb68209dcff74007c239d94176e7a3b9ac76a6667066e55e1d230b54e77663389cb5f81743ca2ac0f40b5f832e2f4720d65fa55c69962f808a9860a1018bd8

data/lib/async/http/endpoint.rb

@@ -4,6 +4,8 @@
 # Copyright, 2019-2024, by Samuel Williams.
 # Copyright, 2021-2022, by Adam Daniels.
 # Copyright, 2024, by Thomas Morgan.
+# Copyright, 2024, by Igor Sidorov.
+# Copyright, 2024, by Hal Brodigan.
 
 require 'io/endpoint'
 require 'io/endpoint/host_endpoint'
@@ -39,7 +41,7 @@ module Async
 				if url.is_a?(Endpoint)
 					return url
 				else
-					Endpoint.parse(url.to_str)
+					Endpoint.parse(url.to_s)
 				end
 			end
 			

data/lib/async/http/internet/instance.rb

@@ -4,13 +4,24 @@
 # Copyright, 2021-2023, by Samuel Williams.
 
 require_relative '../internet'
-require 'thread/local'
+
+::Thread.attr_accessor :async_http_internet_instance
 
 module Async
 	module HTTP
 		class Internet
-			# Provide access to a shared thread-local instance.
-			extend ::Thread::Local
+			# The global instance of the internet.
+			def self.instance
+				::Thread.current.async_http_internet_instance ||= self.new
+			end
+			
+			class << self
+				::Protocol::HTTP::Methods.each do |name, verb|
+					define_method(verb.downcase) do |url, headers = nil, body = nil, &block|
+						self.instance.call(verb, url, headers, body, &block)
+					end
+				end
+			end
 		end
 	end
 end

data/lib/async/http/internet.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2018-2023, by Samuel Williams.
+# Copyright, 2018-2024, by Samuel Williams.
+# Copyright, 2024, by Igor Sidorov.
 
 require_relative 'client'
 require_relative 'endpoint'
@@ -38,7 +39,7 @@ module Async
 			# @parameter url [String] The URL to request, e.g. `https://www.codeotaku.com`.
 			# @parameter headers [Hash | Protocol::HTTP::Headers] The headers to send with the request.
 			# @parameter body [String | Protocol::HTTP::Body] The body to send with the request.
-			def call(method, url, headers = nil, body = nil)
+			def call(method, url, headers = nil, body = nil, &block)
 				endpoint = Endpoint[url]
 				client = self.client_for(endpoint)
 				
@@ -47,7 +48,15 @@ module Async
 				
 				request = ::Protocol::HTTP::Request.new(endpoint.scheme, endpoint.authority, method, endpoint.path, nil, headers, body)
 				
-				return client.call(request)
+				response = client.call(request)
+				
+				return response unless block_given?
+				
+				begin
+					yield response
+				ensure
+					response.close
+				end
 			end
 			
 			def close
@@ -59,8 +68,8 @@ module Async
 			end
 			
 			::Protocol::HTTP::Methods.each do |name, verb|
-				define_method(verb.downcase) do |url, headers = nil, body = nil|
-					self.call(verb, url, headers, body)
+				define_method(verb.downcase) do |url, headers = nil, body = nil, &block|
+					self.call(verb, url, headers, body, &block)
 				end
 			end
 			

data/lib/async/http/mock/endpoint.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: 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 '../protocol'
+
+require 'async/queue'
+
+module Async
+	module HTTP
+		module Mock
+			# This is an endpoint which bridges a client with a local server.
+			class Endpoint
+				def initialize(protocol = Protocol::HTTP2, scheme = "http", authority = "localhost", queue: Queue.new)
+					@protocol = protocol
+					@scheme = scheme
+					@authority = authority
+					
+					@queue = queue
+				end
+				
+				attr :protocol
+				attr :scheme
+				attr :authority
+				
+				# Processing incoming connections
+				# @yield [::HTTP::Protocol::Request] the requests as they come in.
+				def run(parent: Task.current, &block)
+					while peer = @queue.dequeue
+						server = @protocol.server(peer)
+						
+						parent.async do
+							server.each(&block)
+						end
+					end
+				end
+				
+				def connect
+					local, remote = ::Socket.pair(Socket::AF_UNIX, Socket::SOCK_STREAM)
+					
+					@queue.enqueue(remote)
+					
+					return local
+				end
+				
+				def wrap(endpoint)
+					self.class.new(@protocol, endpoint.scheme, endpoint.authority, queue: @queue)
+				end
+			end
+		end
+	end
+end

data/lib/async/http/mock.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: 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 'mock/endpoint'

data/lib/async/http/protocol/http.rb

@@ -2,6 +2,7 @@
 
 # Released under the MIT License.
 # Copyright, 2024, by Thomas Morgan.
+# Copyright, 2024, by Samuel Williams.
 
 require_relative 'http1'
 require_relative 'http2'

data/lib/async/http/version.rb

@@ -5,6 +5,6 @@
 
 module Async
 	module HTTP
-		VERSION = "0.68.0"
+		VERSION = "0.69.0"
 	end
 end

data/lib/async/http.rb

@@ -8,4 +8,6 @@ require_relative 'http/version'
 require_relative 'http/client'
 require_relative 'http/server'
 
+require_relative 'http/internet'
+
 require_relative 'http/endpoint'

data/license.md

@@ -7,7 +7,7 @@ Copyright, 2019, by Denis Talakevich.
 Copyright, 2019-2020, by Brian Morearty.  
 Copyright, 2019, by Cyril Roelandt.  
 Copyright, 2020, by Stefan Wrobel.  
-Copyright, 2020, by Igor Sidorov.  
+Copyright, 2020-2024, by Igor Sidorov.  
 Copyright, 2020, by Bruno Sutic.  
 Copyright, 2020, by Sam Shadwell.  
 Copyright, 2020, by Orgad Shaneh.  
@@ -21,6 +21,7 @@ Copyright, 2023-2024, by Thomas Morgan.
 Copyright, 2023, by dependabot[bot].  
 Copyright, 2023, by Josh Huber.  
 Copyright, 2024, by Anton Zhuravsky.  
+Copyright, 2024, by Hal Brodigan.  
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/readme.md

@@ -4,358 +4,13 @@ An asynchronous client and server implementation of HTTP/1.0, HTTP/1.1 and HTTP/
 
 [![Development Status](https://github.com/socketry/async-http/workflows/Test/badge.svg)](https://github.com/socketry/async-http/actions?workflow=Test)
 
-## Installation
-
-Add this line to your application's Gemfile:
-
-``` ruby
-gem 'async-http'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install async-http
-
 ## Usage
 
-Please see the [project documentation](https://socketry.github.io/async-http/) or serve it locally using `bake utopia:project:serve`.
-
-### Post JSON data
-
-Here is an example showing how to post a data structure as JSON to a remote resource:
-
-``` ruby
-#!/usr/bin/env ruby
-
-require 'json'
-require 'async'
-require 'async/http/internet'
-
-data = {'life' => 42}
-
-Async do
-	# Make a new internet:
-	internet = Async::HTTP::Internet.new
-	
-	# Prepare the request:
-	headers = [['accept', 'application/json']]
-	body = [JSON.dump(data)]
-	
-	# Issues a POST request:
-	response = internet.post("https://httpbin.org/anything", headers, body)
-	
-	# Save the response body to a local file:
-	pp JSON.parse(response.read)
-ensure
-	# The internet is closed for business:
-	internet.close
-end
-```
-
-Consider using [async-rest](https://github.com/socketry/async-rest) instead.
-
-### Multiple Requests
-
-To issue multiple requests concurrently, you should use a barrier, e.g.
-
-``` ruby
-#!/usr/bin/env ruby
-
-require 'async'
-require 'async/barrier'
-require 'async/http/internet'
-
-TOPICS = ["ruby", "python", "rust"]
-
-Async do
-	internet = Async::HTTP::Internet.new
-	barrier = Async::Barrier.new
-	
-	# Spawn an asynchronous task for each topic:
-	TOPICS.each do |topic|
-		barrier.async do
-			response = internet.get "https://www.google.com/search?q=#{topic}"
-			puts "Found #{topic}: #{response.read.scan(topic).size} times."
-		end
-	end
-	
-	# Ensure we wait for all requests to complete before continuing:
-	barrier.wait
-ensure
-	internet&.close
-end
-```
-
-#### Limiting Requests
-
-If you need to limit the number of simultaneous requests, use a semaphore.
-
-``` ruby
-#!/usr/bin/env ruby
-
-require 'async'
-require 'async/barrier'
-require 'async/semaphore'
-require 'async/http/internet'
-
-TOPICS = ["ruby", "python", "rust"]
-
-Async do
-	internet = Async::HTTP::Internet.new
-	barrier = Async::Barrier.new
-	semaphore = Async::Semaphore.new(2, parent: barrier)
-	
-	# Spawn an asynchronous task for each topic:
-	TOPICS.each do |topic|
-		semaphore.async do
-			response = internet.get "https://www.google.com/search?q=#{topic}"
-			puts "Found #{topic}: #{response.read.scan(topic).size} times."
-		end
-	end
-	
-	# Ensure we wait for all requests to complete before continuing:
-	barrier.wait
-ensure
-	internet&.close
-end
-```
-
-### Persistent Connections
-
-To keep connections alive, install the `thread-local` gem,
-require `async/http/internet/instance`, and use the `instance`, e.g.
-
-``` ruby
-#!/usr/bin/env ruby
-
-require 'async'
-require 'async/http/internet/instance'
-
-Async do
-  internet = Async::HTTP::Internet.instance
-	response = internet.get "https://www.google.com/search?q=test"
-	puts "Found #{response.read.size} results."
-end
-```
-
-### Downloading a File
-
-Here is an example showing how to download a file and save it to a local path:
-
-``` ruby
-#!/usr/bin/env ruby
-
-require 'async'
-require 'async/http/internet'
-
-Async do
-	# Make a new internet:
-	internet = Async::HTTP::Internet.new
-	
-	# Issues a GET request to Google:
-	response = internet.get("https://www.google.com/search?q=kittens")
-	
-	# Save the response body to a local file:
-	response.save("/tmp/search.html")
-ensure
-	# The internet is closed for business:
-	internet.close
-end
-```
-
-### Basic Client/Server
-
-Here is a basic example of a client/server running in the same reactor:
-
-``` ruby
-#!/usr/bin/env ruby
-
-require 'async'
-require 'async/http/server'
-require 'async/http/client'
-require 'async/http/endpoint'
-require 'async/http/protocol/response'
-
-endpoint = Async::HTTP::Endpoint.parse('http://127.0.0.1:9294')
-
-app = lambda do |request|
-	Protocol::HTTP::Response[200, {}, ["Hello World"]]
-end
-
-server = Async::HTTP::Server.new(app, endpoint)
-client = Async::HTTP::Client.new(endpoint)
-	
-Async do |task|
-	server_task = task.async do
-		server.run
-	end
-	
-	response = client.get("/")
-	
-	puts response.status
-	puts response.read
-	
-	server_task.stop
-end
-```
-
-### Advanced Verification
-
-You can hook into SSL certificate verification to improve server verification.
-
-``` ruby
-require 'async'
-require 'async/http'
-
-# These are generated from the certificate chain that the server presented.
-trusted_fingerprints = {
-	"dac9024f54d8f6df94935fb1732638ca6ad77c13" => true,
-	"e6a3b45b062d509b3382282d196efe97d5956ccb" => true,
-	"07d63f4c05a03f1c306f9941b8ebf57598719ea2" => true,
-	"e8d994f44ff20dc78dbff4e59d7da93900572bbf" => true,
-}
-
-Async do
-	endpoint = Async::HTTP::Endpoint.parse("https://www.codeotaku.com/index")
-	
-	# This is a quick hack/POC:
-	ssl_context = endpoint.ssl_context
-	
-	ssl_context.verify_callback = proc do |verified, store_context|
-		certificate = store_context.current_cert
-		fingerprint = OpenSSL::Digest::SHA1.new(certificate.to_der).to_s
-		
-		if trusted_fingerprints.include? fingerprint
-			true
-		else
-			Console.logger.warn("Untrusted Certificate Fingerprint"){fingerprint}
-			false
-		end
-	end
-	
-	endpoint = endpoint.with(ssl_context: ssl_context)
-	
-	client = Async::HTTP::Client.new(endpoint)
-	
-	response = client.get(endpoint.path)
-	
-	pp response.status, response.headers.fields, response.read
-end
-```
-
-### Timeouts
-
-Here's a basic example with a timeout:
-
-``` ruby
-#!/usr/bin/env ruby
-
-require 'async/http/internet'
-
-Async do |task|
-	internet = Async::HTTP::Internet.new
-	
-	# Request will timeout after 2 seconds
-	task.with_timeout(2) do
-		response = internet.get "https://httpbin.org/delay/10"
-	end
-rescue Async::TimeoutError
-	puts "The request timed out"
-ensure
-	internet&.close
-end
-```
-
-## Performance
-
-On a 4-core 8-thread i7, running `ab` which uses discrete (non-keep-alive) connections:
-
-    $ ab -c 8 -t 10 http://127.0.0.1:9294/
-    This is ApacheBench, Version 2.3 <$Revision: 1757674 $>
-    Copyright 1996 Adam Twiss, Zeus Technology Ltd, http://www.zeustech.net/
-    Licensed to The Apache Software Foundation, http://www.apache.org/
-    
-    Benchmarking 127.0.0.1 (be patient)
-    Completed 5000 requests
-    Completed 10000 requests
-    Completed 15000 requests
-    Completed 20000 requests
-    Completed 25000 requests
-    Completed 30000 requests
-    Completed 35000 requests
-    Completed 40000 requests
-    Completed 45000 requests
-    Completed 50000 requests
-    Finished 50000 requests
-    
-    
-    Server Software:        
-    Server Hostname:        127.0.0.1
-    Server Port:            9294
-    
-    Document Path:          /
-    Document Length:        13 bytes
-    
-    Concurrency Level:      8
-    Time taken for tests:   1.869 seconds
-    Complete requests:      50000
-    Failed requests:        0
-    Total transferred:      2450000 bytes
-    HTML transferred:       650000 bytes
-    Requests per second:    26755.55 [#/sec] (mean)
-    Time per request:       0.299 [ms] (mean)
-    Time per request:       0.037 [ms] (mean, across all concurrent requests)
-    Transfer rate:          1280.29 [Kbytes/sec] received
-    
-    Connection Times (ms)
-                  min  mean[+/-sd] median   max
-    Connect:        0    0   0.0      0       0
-    Processing:     0    0   0.2      0       6
-    Waiting:        0    0   0.2      0       6
-    Total:          0    0   0.2      0       6
-    
-    Percentage of the requests served within a certain time (ms)
-      50%      0
-      66%      0
-      75%      0
-      80%      0
-      90%      0
-      95%      1
-      98%      1
-      99%      1
-     100%      6 (longest request)
-
-On a 4-core 8-thread i7, running `wrk`, which uses 8 keep-alive connections:
-
-    $ wrk -c 8 -d 10 -t 8 http://127.0.0.1:9294/
-    Running 10s test @ http://127.0.0.1:9294/
-      8 threads and 8 connections
-      Thread Stats   Avg      Stdev     Max   +/- Stdev
-        Latency   217.69us    0.99ms  23.21ms   97.39%
-        Req/Sec    12.18k     1.58k   17.67k    83.21%
-      974480 requests in 10.10s, 60.41MB read
-    Requests/sec:  96485.00
-    Transfer/sec:      5.98MB
-
-According to these results, the cost of handling connections is quite high, while general throughput seems pretty decent.
-
-## Semantic Model
-
-### Scheme
-
-HTTP/1 has an implicit scheme determined by the kind of connection made to the server (either `http` or `https`), while HTTP/2 models this explicitly and the client indicates this in the request using the `:scheme` pseudo-header (typically `https`). To normalize this, `Async::HTTP::Client` and `Async::HTTP::Server` have a default scheme which is used if none is supplied.
-
-### Version
-
-HTTP/1 has an explicit version while HTTP/2 does not expose the version in any way.
+Please see the [project documentation](https://socketry.github.io/async-http/) for more details.
 
-### Reason
+  - [Getting Started](https://socketry.github.io/async-http/guides/getting-started/index) - This guide explains how to get started with `Async::HTTP`.
 
-HTTP/1 responses contain a reason field which is largely irrelevant. HTTP/2 does not support this field.
+  - [Testing](https://socketry.github.io/async-http/guides/testing/index) - This guide explains how to use `Async::HTTP` clients and servers in your tests.
 
 ## Contributing
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: async-http
 version: !ruby/object:Gem::Version
-  version: 0.68.0
+  version: 0.69.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -10,11 +10,12 @@ authors:
 - Janko Marohnić
 - Thomas Morgan
 - Adam Daniels
+- Igor Sidorov
 - Anton Zhuravsky
 - Cyril Roelandt
 - Denis Talakevich
+- Hal Brodigan
 - Ian Ker-Seymer
-- Igor Sidorov
 - Josh Huber
 - Marco Concetto Rudilosso
 - Olle Jonsson
@@ -57,7 +58,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-06-23 00:00:00.000000000 Z
+date: 2024-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -190,6 +191,8 @@ files:
 - lib/async/http/endpoint.rb
 - lib/async/http/internet.rb
 - lib/async/http/internet/instance.rb
+- lib/async/http/mock.rb
+- lib/async/http/mock/endpoint.rb
 - lib/async/http/protocol.rb
 - lib/async/http/protocol/http.rb
 - lib/async/http/protocol/http1.rb