async-http-faraday 0.19.0 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 405bbaf8e19d542be2efd5e6ba29e5dabaa0fedbbad6c392f70b70dac5295f21
-  data.tar.gz: 2ae52a3a031dea0f6c715e7144f9e0ed2872b0e9b2c8a07043ce1be49f8640a5
+  metadata.gz: 61ec5bb845598b4ed1282944e5ecce5ed41fd0abcac72c4bcdaedcf40b707e89
+  data.tar.gz: b16fe2a762a49b3cc20cc5c8f7e674d764ef81f1ab1cd8f95fa41f11e5bc057e
 SHA512:
-  metadata.gz: 8808afa0006650011169d8a9ea52d7029e8e7032d84eceec7e2fa2046b58e66297c3a5b0166ed623b81198161e5a5830309b4db21e30e9174d69f21927bb0a6f
-  data.tar.gz: '064528fe335006b4b00ba6719c119bf583c0cfb20ebdf67d74324d98c74d1c95c3bd9d00359ae1bf80d1fdaca796203526c95473a1d392128eff66b392770dba'
+  metadata.gz: 330032d445badaf1eace0bf580012c573b24a83128c3cb7bd6b479d8710b65558450d892000cbf21aacda704428d28e63dba834f7456c5bc53b7c473f6cd511b
+  data.tar.gz: 584dd4a49d4af9d088a386f8a6130f199396ba6b93ee79af3a9fc15a6ebfcf66f0cddc7d95cfabb1d9d9acc18291e2128b0e003845e7c6241ec1fc7cc3ba2d2a

data/examples/topics.rb

@@ -2,18 +2,18 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2020-2024, by Samuel Williams.
+# Copyright, 2020-2025, by Samuel Williams.
 
 $LOAD_PATH.unshift File.expand_path("../lib", __dir__)
 
-require 'async'
-require 'faraday'
-require 'async/http/faraday'
+require "async"
+require "faraday"
+require "async/http/faraday"
 
 # Async.logger.debug!
 
 module TestAsync
-	URL = 'https://www.google.com/search'
+	URL = "https://www.google.com/search"
 	TOPICS = %W{ruby python lisp javascript cobol}
 	
 	def self.fetch_topics_async

data/lib/async/http/faraday/adapter.rb

@@ -1,25 +1,25 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2018-2024, by Samuel Williams.
+# Copyright, 2018-2025, by Samuel Williams.
 # Copyright, 2018, by Andreas Garnaes.
 # Copyright, 2019, by Denis Talakevich.
 # Copyright, 2019-2020, by Igor Sidorov.
 # Copyright, 2023, by Genki Takiuchi.
 # Copyright, 2023, by Flavio Fernandes.
 # Copyright, 2024, by Jacob Frautschi.
-# Copyright, 2024, by Korbin Hoffman.
+# Copyright, 2025, by Nikolaos Anastopoulos.
 
-require 'faraday'
-require 'faraday/adapter'
+require "faraday"
+require "faraday/adapter"
 
-require 'async/barrier'
-require 'kernel/sync'
+require "async/barrier"
+require "kernel/sync"
 
-require 'async/http/client'
-require 'async/http/proxy'
+require "async/http/client"
+require "async/http/proxy"
 
-require_relative 'clients'
+require_relative "clients"
 
 module Async
 	module HTTP
@@ -50,18 +50,22 @@ module Async
 				end
 			end
 			
+			# Implement the Faraday parallel manager interface, using Async.
 			class ParallelManager
+				# Create a new parallel manager.
 				def initialize(options = {})
 					@options = options
 					@barrier = nil
 				end
 				
+				# @deprecated Please update your Faraday version!
 				def run
 					if $VERBOSE
 						warn "Please update your Faraday version!", uplevel: 2
 					end
 				end
 				
+				# Run the given block asynchronously, using the barrier if available.
 				def async(&block)
 					if @barrier
 						@barrier.async(&block)
@@ -70,6 +74,7 @@ module Async
 					end
 				end
 				
+				# Execute the given block which can perform multiple concurrent requests, waiting for them all to complete.
 				def execute(&block)
 					Sync do
 						@barrier = Async::Barrier.new
@@ -87,6 +92,7 @@ module Async
 			class Adapter < ::Faraday::Adapter
 				self.supports_parallel = true
 				
+				# Create a new parallel manager, which is used to handle multiple concurrent requests.
 				def self.setup_parallel_manager(**options)
 					ParallelManager.new(options)
 				end
@@ -113,6 +119,7 @@ module Async
 					super
 					
 					@timeout = @connection_options.delete(:timeout)
+					@read_timeout = @connection_options.delete(:read_timeout)
 					
 					if clients = @connection_options.delete(:clients)
 						@clients = clients.call(**@connection_options, &@config_block)
@@ -121,6 +128,12 @@ module Async
 					end
 				end
 				
+				# @attribute [Numeric | Nil] The maximum time to send a request and wait for a response.
+				attr :timeout
+				
+				# @attribute [Numeric | Nil] The maximum time to wait for an individual IO operation.
+				attr :read_timeout
+				
 				# Close all clients.
 				def close
 					# The order of operations here is to avoid a race condition between iterating over clients (#close may yield) and creating new clients.
@@ -137,7 +150,7 @@ module Async
 					super
 					
 					# For compatibility with the default adapter:
-					env.url.path = '/' if env.url.path.empty?
+					env.url.path = "/" if env.url.path.empty?
 					
 					if parallel_manager = env.parallel_manager
 						parallel_manager.async do
@@ -175,39 +188,39 @@ module Async
 						
 						request = ::Protocol::HTTP::Request.new(endpoint.scheme, endpoint.authority, method, endpoint.path, nil, headers, body)
 						
-						with_timeout do
+						with_timeout(env.request.timeout || @timeout) do
 							if env.stream_response?
 								response = env.stream_response do |&on_data|
 									response = client.call(request)
 									
+									save_response(env, response.status, nil, response.headers, finished: false)
+									
 									response.each do |chunk|
 										on_data.call(chunk)
 									end
 									
 									response
 								end
-								
-								save_response(env, response.status, nil, response.headers)
 							else
 								response = client.call(request)
-								
-								save_response(env, response.status, encoded_body(response), response.headers)
 							end
+							
+							save_response(env, response.status, encoded_body(response), response.headers)
 						end
 					end
 					
 					return @app.call(env)
-				rescue Errno::ETIMEDOUT, Async::TimeoutError => e
-					raise ::Faraday::TimeoutError, e
-				rescue OpenSSL::SSL::SSLError => e
-					raise ::Faraday::SSLError, e
-				rescue *CONNECTION_EXCEPTIONS => e
-					raise ::Faraday::ConnectionFailed, e
+				rescue Errno::ETIMEDOUT, Async::TimeoutError => error
+					raise ::Faraday::TimeoutError, error
+				rescue OpenSSL::SSL::SSLError => error
+					raise ::Faraday::SSLError, error
+				rescue *CONNECTION_EXCEPTIONS => error
+					raise ::Faraday::ConnectionFailed, error
 				end
 				
 				def with_client(env)
 					Sync do
-						endpoint = Endpoint.new(env.url)
+						endpoint = Endpoint.new(env.url, timeout: @read_timeout)
 						
 						if proxy = env.request.proxy
 							proxy_endpoint = Endpoint.new(proxy.uri)
@@ -223,9 +236,9 @@ module Async
 					end
 				end
 				
-				def with_timeout(task: Async::Task.current)
-					if @timeout
-						task.with_timeout(@timeout, ::Faraday::TimeoutError) do
+				def with_timeout(timeout = @timeout, task: Async::Task.current)
+					if timeout
+						task.with_timeout(timeout, ::Faraday::TimeoutError) do
 							yield
 						end
 					else
@@ -235,11 +248,11 @@ module Async
 				
 				def encoded_body(response)
 					body = response.read
-					return body if body.nil?
-					content_type = response.headers['content-type']
+					return "" if body.nil?
+					content_type = response.headers["content-type"]
 					return body unless content_type
 					params = extract_type_parameters(content_type)
-					if charset = params['charset']
+					if charset = params["charset"]
 						body = body.dup if body.frozen?
 						body.force_encoding(charset)
 					end
@@ -250,10 +263,10 @@ module Async
 				
 				def extract_type_parameters(content_type)
 					result = {}
-					list = content_type.split(';')
+					list = content_type.split(";")
 					list.shift
 					list.each do |param|
-						key, value = *param.split('=', 2)
+						key, value = *param.split("=", 2)
 						result[key.strip] = value.strip
 					end
 					result

data/lib/async/http/faraday/clients.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2024, by Samuel Williams.
+# Copyright, 2024-2025, by Samuel Williams.
 
-require 'faraday'
-require 'faraday/adapter'
-require 'kernel/sync'
+require "faraday"
+require "faraday/adapter"
+require "kernel/sync"
 
-require 'async/http/client'
-require 'async/http/proxy'
+require "async/http/client"
+require "async/http/proxy"
 
 module Async
 	module HTTP

data/lib/async/http/faraday/default.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2020-2024, by Samuel Williams.
+# Copyright, 2020-2025, by Samuel Williams.
 
-require_relative 'adapter'
+require_relative "register"
 
 # Set the default adapter to use Async::HTTP.
 ::Faraday.default_adapter = :async_http

data/lib/async/http/faraday/register.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2025, by Samuel Williams.
+
+require_relative "adapter"
+
+Faraday::Adapter.register_middleware :async_http => Async::HTTP::Faraday::Adapter

data/lib/async/http/faraday/version.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2018-2024, by Samuel Williams.
+# Copyright, 2018-2025, by Samuel Williams.
 
 module Async
 	module HTTP
 		module Faraday
-			VERSION = "0.19.0"
+			VERSION = "0.21.0"
 		end
 	end
 end

data/lib/async/http/faraday.rb

@@ -1,12 +1,10 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2018-2024, by Samuel Williams.
+# Copyright, 2018-2025, by Samuel Williams.
 
 require_relative "faraday/version"
-require_relative "faraday/adapter"
-
-Faraday::Adapter.register_middleware :async_http => Async::HTTP::Faraday::Adapter
+require_relative "faraday/register"
 
 # @namespace
 module Async

data/license.md

@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright, 2018-2024, by Samuel Williams.  
+Copyright, 2018-2025, by Samuel Williams.  
 Copyright, 2018, by Andreas Garnaes.  
 Copyright, 2019, by Denis Talakevich.  
 Copyright, 2019-2020, by Igor Sidorov.  
@@ -9,7 +9,7 @@ Copyright, 2020, by Benoit Daloze.
 Copyright, 2023, by Genki Takiuchi.  
 Copyright, 2023, by Flavio Fernandes.  
 Copyright, 2024, by Jacob Frautschi.  
-Copyright, 2024, by Korbin Hoffman.  
+Copyright, 2025, by Nikolaos Anastopoulos.  
 
 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

@@ -15,15 +15,28 @@ Please see the [project documentation](https://socketry.github.io/async-http-far
 
 ## Releases
 
-Please see the [project changes](https://socketry.github.io/async-http-faraday//changes/index) for all releases.
+Please see the [project releases](https://socketry.github.io/async-http-faraday/releases/index) for all releases.
+
+### v0.21.0
+
+  - [Improved support for `timeout` and `read_timeout`.](https://socketry.github.io/async-http-faraday/releases/index#improved-support-for-timeout-and-read_timeout.)
+
+### v0.20.0
+
+  - Implement the new response streaming interface, which provides the initial response status code and headers before streaming the response body.
+  - An empty response now sets the response body to an empty string rather than `nil` as required by the Faraday specification.
+
+### v0.19.0
+
+  - [Support `in_parallel`.](https://socketry.github.io/async-http-faraday/releases/index#support-in_parallel.)
 
 ### v0.18.0
 
-  - [Config Block](https://socketry.github.io/async-http-faraday/changes/index#config-block)
+  - [Support for `config_block` returning a middleware wrapper.](https://socketry.github.io/async-http-faraday/releases/index#support-for-config_block-returning-a-middleware-wrapper.)
 
 ### v0.17.0
 
-  - [Per-thread Client Cache](https://socketry.github.io/async-http-faraday/changes/index#per-thread-client-cache)
+  - [Introduced a per-thread `Client` cache.](https://socketry.github.io/async-http-faraday/releases/index#introduced-a-per-thread-client-cache.)
 
 ## Contributing
 

data/releases.md

@@ -0,0 +1,94 @@
+# Releases
+
+## v0.21.0
+
+### Improved support for `timeout` and `read_timeout`.
+
+Previously, only a per-connection `timeout` was supported, but now:
+
+1.  `timeout` can be set per request too.
+2.  `read_timeout` can be set per adapter and is assigned to `IO#timeout` if available.
+
+This improves compatibility with existing code that uses `timeout` and `read_timeout`.
+
+## v0.20.0
+
+  - Implement the new response streaming interface, which provides the initial response status code and headers before streaming the response body.
+  - An empty response now sets the response body to an empty string rather than `nil` as required by the Faraday specification.
+
+## v0.19.0
+
+### Support `in_parallel`.
+
+The adapter now supports the `in_parallel` method, which allows multiple requests to be made concurrently.
+
+``` ruby
+adapter = Faraday.new(bound_url) do |builder|
+	builder.adapter :async_http
+end
+
+response1 = response2 = response3 = nil
+
+adapter.in_parallel do
+	response1 = adapter.get("/index")
+	response2 = adapter.get("/index")
+	response3 = adapter.get("/index")
+end
+
+puts response1.body # => "Hello World"
+puts response2.body # => "Hello World"
+puts response3.body # => "Hello World"
+```
+
+This is primarily for compatibility with existing code. If you are designing a new library, you should just use `Async` directly:
+
+``` ruby
+Async do
+	response1 = Async{adapter.get("/index")}
+	response2 = Async{adapter.get("/index")}
+	response3 = Async{adapter.get("/index")}
+	
+	puts response1.wait.body # => "Hello World"
+	puts response2.wait.body # => "Hello World"
+	puts response3.wait.body # => "Hello World"
+end
+```
+
+## v0.18.0
+
+### Support for `config_block` returning a middleware wrapper.
+
+The `config_block` provided to the adapter must now return `nil`, `client` or a middleware wrapper around `client`.
+
+``` ruby
+Faraday.new do |builder|
+	builder.adapter :async_http do |client|
+		# Option 1 (same as returning `nil`), use client as is:
+		client # Use `client` as is.
+		
+		# Option 2, wrap client in a middleware:
+		Async::HTTP::Middleware::LocationRedirector.new(client)
+	end
+end
+```
+
+## v0.17.0
+
+### Introduced a per-thread `Client` cache.
+
+The default adapter now uses a per-thread client cache internally, to improve compatibility with existing code that shares a single `Faraday::Connection` instance across multiple threads.
+
+``` ruby
+adapter = Faraday.new do |builder|
+	builder.adapter :async_http
+end
+
+3.times do
+	Thread.new do
+		Async do
+			# Each thread has it's own client cache.
+			adapter.get('http://example.com')
+		end
+	end
+end
+```

metadata

@@ -1,20 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: async-http-faraday
 version: !ruby/object:Gem::Version
-  version: 0.19.0
+  version: 0.21.0
 platform: ruby
 authors:
 - Samuel Williams
 - Igor Sidorov
 - Andreas Garnaes
 - Genki Takiuchi
+- Nikolaos Anastopoulos
 - Olle Jonsson
 - Benoit Daloze
 - Denis Talakevich
 - Flavio Fernandes
 - Jacob Frautschi
-- Korbin Hoffman
-autorequire:
 bindir: bin
 cert_chain:
 - |
@@ -46,7 +45,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-08-22 00:00:00.000000000 Z
+date: 2025-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-http
@@ -76,21 +75,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
-email:
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- changes.md
 - examples/topics.rb
 - lib/async/http/faraday.rb
 - lib/async/http/faraday/adapter.rb
 - lib/async/http/faraday/clients.rb
 - lib/async/http/faraday/default.rb
+- lib/async/http/faraday/register.rb
 - lib/async/http/faraday/version.rb
 - license.md
 - readme.md
+- releases.md
 homepage: https://github.com/socketry/async-http-faraday
 licenses:
 - MIT
@@ -98,7 +96,6 @@ metadata:
   documentation_uri: https://socketry.github.io/async-http-faraday/
   funding_uri: https://github.com/sponsors/ioquatix
   source_code_uri: https://github.com/socketry/async-http.git
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -113,8 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Provides an adaptor between async-http and faraday.
 test_files: []

data/changes.md

@@ -1,38 +0,0 @@
-# v0.18.0
-
-## Config Block
-
-The `config_block` provided to the adapter must now return `nil`, `client` or a middleware wrapper around `client`.
-
-```ruby
-Faraday.new do |builder|
-	builder.adapter :async_http do |client|
-		# Option 1 (same as returning `nil`), use client as is:
-		client # Use `client` as is.
-		
-		# Option 2, wrap client in a middleware:
-		Async::HTTP::Middleware::LocationRedirector.new(client)
-	end
-end
-```
-
-# v0.17.0
-
-## Per-thread Client Cache
-
-The default adapter now uses a per-thread client cache internally, to improve compatibility with existing code that shares a single `Faraday::Connection` instance across multiple threads.
-
-```ruby
-adapter = Faraday.new do |builder|
-	builder.adapter :async_http
-end
-
-3.times do
-	Thread.new do
-		Async do
-			# Each thread has it's own client cache.
-			adapter.get('http://example.com')
-		end
-	end
-end
-```