fetch-api 0.4.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb43f07388e02a5f1ec3ccf700a634962896b68e8de60c402aacfe078499dc06
-  data.tar.gz: 228e63fa8ba87bdb73f4ed82dd92af70724bb5e3c0a10c2be1849bba3752b846
+  metadata.gz: 1f3850dbddc3e46b5c6e59efdde4538c5c94e0464e94fb3ddd615e93d48a4e4f
+  data.tar.gz: 5783d23d208526c9f009f6ad15317a136ad22ddbb58d403cad655e7c6909034a
 SHA512:
-  metadata.gz: 99785c3983dbf1e311e3e845ad92a41791af9089b1ecf349973e5a3a14159b1ec855b07c16f46980248b1f8375d3761fd6696cebde999763053a178117257510
-  data.tar.gz: 6c969cd4edfc77256e960cab56d7fe9db4a345f754e811e278b18d27900c393625ead267a566abb4334e743270b181ac9921fdfdc51f45f715da8f8701ed28cb
+  metadata.gz: 77c50b51b5e084f405e26a6222bc388e1b2843f3f856db2f4f242fe64491ec31b8dd2f00532ff7099ab915b44bcf21f5edca3ca66bb5d9a0218f0f00c26100a3
+  data.tar.gz: bd4668f688f2a9cf06bab9eec7f471a61b8e5bd3c2d0408521f46b6b2b61e2054cf7057f71ebaf53028d20b8363f9e01586fa75bfec8d5ef7c1ad3b9e49a3d9c

data/README.md

@@ -110,8 +110,22 @@ These values can be configured as follows (in seconds):
 
 ``` ruby
 Fetch.configure do |config|
-  config.max_idle_time      = 30 # default
-  config.keep_alive_timeout = 15 # default
+  config.connection_max_idle_time = 30 # default
+end
+```
+
+### Customizing connection
+
+If the lambda is set to `Fetch.config.on_connection_create`, it is called before the connection is initiated. The arguments are a Net::HTTP instance and a URI object. Note that `Net::HTTP#use_ssl` is automatically set according to the URL schema.
+
+``` ruby
+Fetch.configure do |config|
+  config.on_connection_create = -> (conn, uri) {
+    if uri.host == 'example.com'
+      conn.open_timeout = 5
+      conn.read_timeout = 5
+    end
+  }
 end
 ```
 

data/lib/fetch/api.rb

@@ -4,8 +4,8 @@ module Fetch
   module API
     module_function
 
-    def fetch(...)
-      Client.instance.fetch(...)
+    def fetch(resource, method: :get, headers: [], body: nil, redirect: :follow)
+      Client.instance.fetch(resource, method:, headers:, body:, redirect:)
     end
   end
 end

data/lib/fetch/client.rb

@@ -15,7 +15,7 @@ module Fetch
   class Client
     include Singleton
 
-    def fetch(resource, method: :get, headers: [], body: nil, redirect: :follow, _redirected: false)
+    def fetch(resource, method:, headers:, body:, redirect:, redirected: false)
       uri = URI.parse(resource)
       req = Net::HTTP.const_get(method.capitalize).new(uri)
 
@@ -51,16 +51,16 @@ module Fetch
           # @type var location: String
           location = res['Location']
 
-          fetch(location, method:, headers:, body:, redirect:, _redirected: true)
+          fetch(location, method:, headers:, body:, redirect:, redirected: true)
         when 'error'
           raise RedirectError, "redirected to #{res['Location']}"
         when 'manual'
-          to_response(resource, res, _redirected)
+          to_response(resource, res, redirected)
         else
           raise ArgumentError, "invalid redirect option: #{redirect.inspect}"
         end
       else
-        to_response(resource, res, _redirected)
+        to_response(resource, res, redirected)
       end
     end
 

data/lib/fetch/config.rb

@@ -1,3 +1,3 @@
 module Fetch
-  Config = Struct.new(:max_idle_time, :keep_alive_timeout)
+  Config = Struct.new(:connection_max_idle_time, :on_connection_create)
 end

data/lib/fetch/connection_pool.rb

@@ -41,8 +41,10 @@ module Fetch
         host = uri.host
 
         Net::HTTP.new(host, uri.port).tap {|http|
-          http.use_ssl            = uri.scheme == 'https'
-          http.keep_alive_timeout = Fetch.config.keep_alive_timeout
+          http.use_ssl = uri.scheme == 'https'
+
+          Fetch.config.on_connection_create.call http, uri
+
           http.start
         }
       end
@@ -59,7 +61,7 @@ module Fetch
     def sweep
       @mutex.synchronize do
         @connections.each do |origin, (conn, last_used)|
-          if last_used + Fetch.config.max_idle_time < Time.now
+          if last_used + Fetch.config.connection_max_idle_time < Time.now
             begin
               conn.finish
             rescue IOError

data/lib/fetch/version.rb

@@ -1,3 +1,3 @@
 module Fetch
-  VERSION = '0.4.3'
+  VERSION = '0.5.0'
 end

data/lib/fetch.rb

@@ -10,7 +10,7 @@ module Fetch
   end
 
   configure do |config|
-    config.max_idle_time      = 30
-    config.keep_alive_timeout = 15
+    config.connection_max_idle_time = 30
+    config.on_connection_create     = -> (*) {}
   end
 end

data/sig/fetch/client.rbs

@@ -4,11 +4,11 @@ module Fetch
 
     def fetch: (
       string,
-      ?method: String | Symbol,
-      ?headers: _Each[[_ToS, _ToS]],
-      ?body: (String | FormData | URLSearchParams)?,
-      ?redirect: 'follow' | 'error' | 'manual' | :follow | :error | :manual,
-      ?_redirected: bool
+      method: String | Symbol,
+      headers: _Each[[_ToS, _ToS]],
+      body: (String | FormData | URLSearchParams)?,
+      redirect: 'follow' | 'error' | 'manual' | :follow | :error | :manual,
+      ?redirected: bool
     ) -> Response
 
     private

data/sig/fetch/config.rbs

@@ -1,6 +1,6 @@
 module Fetch
   class Config
-    attr_accessor max_idle_time: Integer
-    attr_accessor keep_alive_timeout: Integer
+    attr_accessor connection_max_idle_time: Integer
+    attr_accessor on_connection_create: ^(Net::HTTP, URI::HTTP) -> void
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fetch-api
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.0
 platform: ruby
 authors:
 - Keita Urashima
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-10 00:00:00.000000000 Z
+date: 2024-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: forwardable