fetch-api 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4217a0ddb4ec43da71a630ba5de24d9a6a02af0f5cf2b39286702c1cc512c699
-  data.tar.gz: 05abc4f266fab3577c2223de54957b8c6a84e7b3ccc24df428f40e771c1e311d
+  metadata.gz: 1f3850dbddc3e46b5c6e59efdde4538c5c94e0464e94fb3ddd615e93d48a4e4f
+  data.tar.gz: 5783d23d208526c9f009f6ad15317a136ad22ddbb58d403cad655e7c6909034a
 SHA512:
-  metadata.gz: c7caa0c96f93f03ae799a121fc7f25410f401c9c192a7546f97627c760cb638627b79d01b0911ed8a4f2ebaacdaa619e86e84a2b88443a721f066a4a9fd4c1d9
-  data.tar.gz: 826e3c4ff75b7b3c3f0886949a6fe141cdd360fd31da86b42b08aabde98b0a608ac6f51561b65819b65622a1a2f344f5e6784505bafb990d0aad300ac8f378b6
+  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      = 10 # default
-  config.keep_alive_timeout = 2  # 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) # steep:ignore ArgumentTypeMismatch
+          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

@@ -4,76 +4,69 @@ require 'thread'
 
 module Fetch
   class ConnectionPool
-    Entry = Struct.new(:connection, :in_use, :last_used, keyword_init: true)
-
     def initialize
       @connections = {}
       @mutex       = Mutex.new
 
       @sweeper = Thread.new {
         loop do
-          sleep 1
           sweep
 
-          Thread.stop if @connections.empty?
+          if @connections.empty?
+            Thread.stop
+          else
+            sleep 1
+          end
         end
       }
     end
 
     def with_connection(uri, &block)
-      conn = acquire(uri)
+      conn = checkout(uri)
 
       begin
         block.call(conn)
       ensure
-        release uri
+        checkin uri, conn
       end
     end
 
     private
 
-    def acquire(uri)
-      @mutex.synchronize {
-        entry = @connections[uri.origin]
-
-        if entry
-          entry.in_use = true
+    def checkout(uri)
+      if entry = @mutex.synchronize { @connections.delete(uri.origin) }
+        entry.first
+      else
+        # @type var host: String
+        host = uri.host
 
-          entry.connection
-        else
-          # @type var host: String
-          host = uri.host
+        Net::HTTP.new(host, uri.port).tap {|http|
+          http.use_ssl = uri.scheme == 'https'
 
-          Net::HTTP.new(host, uri.port).tap {|http|
-            http.use_ssl            = uri.scheme == 'https'
-            http.keep_alive_timeout = Fetch.config.keep_alive_timeout
+          Fetch.config.on_connection_create.call http, uri
 
-            http.start
-
-            @connections[uri.origin] = Entry.new(connection: http, in_use: true)
-          }
-        end
-      }.tap {
-        @sweeper.wakeup
-      }
+          http.start
+        }
+      end
     end
 
-    def release(uri)
+    def checkin(uri, conn)
       @mutex.synchronize do
-        if entry = @connections[uri.origin]
-          entry.in_use    = false
-          entry.last_used = Time.now
-        end
+        @connections[uri.origin] = [conn, Time.now]
       end
+
+      @sweeper.wakeup
     end
 
     def sweep
       @mutex.synchronize do
-        @connections.each do |origin, entry|
-          next if entry.in_use
-
-          if entry.last_used + Fetch.config.max_idle_time < Time.now
-            entry.connection.finish
+        @connections.each do |origin, (conn, last_used)|
+          if last_used + Fetch.config.connection_max_idle_time < Time.now
+            begin
+              conn.finish
+            rescue IOError
+              # do nothing
+            end
 
             @connections.delete origin
           end

data/lib/fetch/version.rb

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

data/lib/fetch.rb

@@ -10,7 +10,7 @@ module Fetch
   end
 
   configure do |config|
-    config.max_idle_time      = 10
-    config.keep_alive_timeout = 2
+    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

data/sig/fetch/connection_pool.rbs

@@ -1,20 +1,12 @@
 module Fetch
   class ConnectionPool
-    class Entry
-      attr_accessor connection: Net::HTTP
-      attr_accessor in_use: bool
-      attr_accessor last_used: Time
-
-      def initialize: (connection: Net::HTTP, in_use: bool, ?last_used: Time) -> void
-    end
-
     def initialize: () -> void
     def with_connection: [T] (URI::HTTP) { (Net::HTTP) -> T } -> T
 
     private
 
-    def acquire: (URI::HTTP) -> Net::HTTP
-    def release: (URI::HTTP) -> void
+    def checkout: (URI::HTTP) -> Net::HTTP
+    def checkin: (URI::HTTP, Net::HTTP) -> void
     def sweep: () -> void
   end
 end

data/sig/fetch/version.rbs

@@ -0,0 +1,3 @@
+module Fetch
+  VERSION: String
+end

data/sig/fetch.rbs

@@ -1,6 +1,4 @@
 module Fetch
-  VERSION: String
-
   attr_accessor self.config: Config
 
   def self.configure: () { (Config) -> void } -> void

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fetch-api
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Keita Urashima
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-08 00:00:00.000000000 Z
+date: 2024-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: forwardable
@@ -139,6 +139,7 @@ files:
 - sig/fetch/headers.rbs
 - sig/fetch/response.rbs
 - sig/fetch/url_search_params.rbs
+- sig/fetch/version.rbs
 homepage: https://github.com/ursm/fetch-api
 licenses:
 - MIT
@@ -160,7 +161,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.14
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Something like the Fetch API for Ruby