async-http-faraday 0.20.0 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c35355716bc9483c9f0dcd3070e31cfa0570e49e20d25f96fa429c06d55fef5f
-  data.tar.gz: 8781699d3bef67478a25bee464f7ccd9bb7cfcf39dae30879f7ad2c09b767e9b
+  metadata.gz: 91b8ac365195312b4906a8dd4f975cebdea675bda9316e97d7c0ed3186fdb9b0
+  data.tar.gz: 526ae0462c42d2be7e5362031a15b68388f6c723278dbcf74c0bde763d16a606
 SHA512:
-  metadata.gz: 785d20de694024d75fd214bdfbf0680d7de1e0cb8fb695434186b51c829b2b04c9c957a6cab120ce64b75b7daa57c9fa26cd19940e22296015183793ec2bbac3
-  data.tar.gz: 4f3cf8059b823e6db1b2be08eb76cd49d8383deb1685e8bafb31796d8c23a0f67672062c6739097a71dd944f48e346c74b9ca1c01a34ebbf0736c39fe049bebc
+  metadata.gz: 5bfad129a4104393375a077cd605aae4955e2adb8497a4a1655438593eb3aed8a56e966e182dc1094759617ecdb722dbe32c19de9e31211526ac705e94ef43d5
+  data.tar.gz: f2a3c8b0f1ad783b9ce4cfdbf57d707c5f27d953c7042504fbeaa2feb0fed18e9f6aea0070d162fb9c8301fd4c4a2b1037726fe6dbc8066be46d4bd5c1cff5fa

data/examples/topics.rb

@@ -2,7 +2,7 @@
 # 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__)
 

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

@@ -1,7 +1,7 @@
 # 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.
@@ -32,11 +32,16 @@ module Async
 				#
 				# @parameter body [Interface(:read)] The input body to wrap.
 				# @parameter block_size [Integer] The size of the blocks to read from the body.
-				def initialize(body, block_size: 4096)
+				# @parameter length [Integer | Nil] The length of the body, if known.
+				def initialize(body, length = nil, block_size: 4096)
 					@body = body
+					@length = length
 					@block_size = block_size
 				end
 				
+				# @attribute [Integer | Nil] The total length of the body, or `nil` if the length is unknown.
+				attr :length
+				
 				# Close the body if possible.
 				def close(error = nil)
 					@body.close if @body.respond_to?(:close)
@@ -111,7 +116,7 @@ module Async
 					SocketError
 				].freeze
 				
-				# Create a Farady compatible adapter.
+				# Create a Faraday compatible adapter.
 				# 
 				# @parameter timeout [Integer] The timeout for requests.
 				# @parameter options [Hash] Additional options to pass to the underlying Async::HTTP::Client.
@@ -119,6 +124,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)
@@ -127,6 +133,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.
@@ -161,27 +173,32 @@ module Async
 				
 				def perform_request(env)
 					with_client(env) do |endpoint, client|
+						if headers = env.request_headers
+							headers = ::Protocol::HTTP::Headers[headers]
+							
+							# Use content-length to inform body length if given, but remove the header since it will be
+							# set for us later anyway, and not doing so could result in a duplicate content-length headers
+							# if capitalization differs
+							content_length = headers.delete("content-length")&.to_i
+						end
+						
 						if body = env.body
 							# We need to ensure the body is wrapped in a Readable object so that it can be read in chunks:
 							# Faraday's body only responds to `#read`.
 							if body.is_a?(::Protocol::HTTP::Body::Readable)
 								# Good to go
 							elsif body.respond_to?(:read)
-								body = BodyReadWrapper.new(body)
+								body = BodyReadWrapper.new(body, content_length)
 							else
 								body = ::Protocol::HTTP::Body::Buffered.wrap(body)
 							end
 						end
 						
-						if headers = env.request_headers
-							headers = ::Protocol::HTTP::Headers[headers]
-						end
-						
 						method = env.method.to_s.upcase
 						
 						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)
@@ -203,17 +220,17 @@ module Async
 					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)
@@ -229,9 +246,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
@@ -241,7 +258,7 @@ module Async
 				
 				def encoded_body(response)
 					body = response.read
-					return +"" if body.nil?
+					return "" if body.nil?
 					content_type = response.headers["content-type"]
 					return body unless content_type
 					params = extract_type_parameters(content_type)

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

@@ -1,7 +1,7 @@
 # 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"

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.20.0"
+			VERSION = "0.22.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/readme.md

@@ -17,6 +17,10 @@ Please see the [project documentation](https://socketry.github.io/async-http-far
 
 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.
@@ -24,15 +28,15 @@ Please see the [project releases](https://socketry.github.io/async-http-faraday/
 
 ### v0.19.0
 
-  - [Support `in_parallel`](https://socketry.github.io/async-http-faraday/releases/index#support-in_parallel)
+  - [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/releases/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/releases/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

@@ -1,5 +1,16 @@
 # 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.
@@ -7,7 +18,7 @@
 
 ## v0.19.0
 
-### Support `in_parallel`
+### Support `in_parallel`.
 
 The adapter now supports the `in_parallel` method, which allows multiple requests to be made concurrently.
 
@@ -45,7 +56,7 @@ end
 
 ## v0.18.0
 
-### Config Block
+### 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`.
 
@@ -63,7 +74,7 @@ end
 
 ## v0.17.0
 
-### Per-thread Client Cache
+### 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.
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: async-http-faraday
 version: !ruby/object:Gem::Version
-  version: 0.20.0
+  version: 0.22.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -45,7 +45,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2025-01-23 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-http
@@ -84,6 +84,7 @@ files:
 - 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
@@ -109,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Provides an adaptor between async-http and faraday.
 test_files: []