fetch-api 0.4.1 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff43ec8ec36d621acb463b7327146e89df97446714df7747626276bb51ff4c18
-  data.tar.gz: de99e42e871912c41df6a5afabb1200f662d5aeba7b6659a4483434c8ddca3c7
+  metadata.gz: eb43f07388e02a5f1ec3ccf700a634962896b68e8de60c402aacfe078499dc06
+  data.tar.gz: 228e63fa8ba87bdb73f4ed82dd92af70724bb5e3c0a10c2be1849bba3752b846
 SHA512:
-  metadata.gz: 7b56ad7b6ac2788343928c4686f48de71e1dc57491e9e13efa5cc479f4f7f57af9d4efad3e7a79cf75fd287d683bb21ec053b69de0c66cdd39a0aef571f86c7b
-  data.tar.gz: 8895b9835e6637a9d4cd845708e2a133b2f6239baab1729478f16ae9f25ea3df927d678c41ebfbcc26cb3482a43c5fb616779df89a21a8a1aa634f0e18ebe392
+  metadata.gz: 99785c3983dbf1e311e3e845ad92a41791af9089b1ecf349973e5a3a14159b1ec855b07c16f46980248b1f8375d3761fd6696cebde999763053a178117257510
+  data.tar.gz: 6c969cd4edfc77256e960cab56d7fe9db4a345f754e811e278b18d27900c393625ead267a566abb4334e743270b181ac9921fdfdc51f45f715da8f8701ed28cb

data/README.md

@@ -1,8 +1,8 @@
-# Fetch API for Ruby
+# Fetch::API
 
 Ruby's Net::HTTP is very powerful, but has a complicated API. OpenURI is easy to use, but has limited functionality. Third-party HTTP clients each have different APIs, and it can sometimes be difficult to learn how to use them.
 
-There is one HTTP client that we can all use. It is the browser's Fetch API. This is an HTTP client for Ruby that can be used in a way that is similar to the Fetch API.
+There is one HTTP client that we can all use. It is the browser's Fetch API. Fetch::API is an HTTP client for Ruby that can be used in a way that is similar to the Fetch API.
 
 This is not intended to be a complete copy of the Fetch API. For example, responses are returned synchronously rather than asynchronously, as that is more familiar behavior for Ruby programmers. It is only "like" the Fetch API.
 
@@ -102,16 +102,16 @@ res = fetch('http://example.com', **{
 })
 ```
 
-## Connection pooling
+### Connection pooling
 
-Fetch API automatically pools and reuses connections to the same origin. Connections are closed after a certain amount of time has passed since the last use, and a new connection is used the next time. Different connections are returned for different threads (in other words, Fetch API is thread-safe).
+Fetch::API automatically pools and reuses connections to the same origin. Connections are closed after a certain amount of time has passed since the last use, and a new connection is used the next time. Different connections are returned for different threads (in other words, Fetch::API is thread-safe).
 
-These values (in seconds) can be configured as follows:
+These values can be configured as follows (in seconds):
 
 ``` ruby
 Fetch.configure do |config|
-  config.connection_max_idle_time = 10 # default
-  config.keep_alive_timeout       = 2  # default
+  config.max_idle_time      = 30 # default
+  config.keep_alive_timeout = 15 # default
 end
 ```
 

data/lib/fetch/client.rb

@@ -48,7 +48,10 @@ module Fetch
       when Net::HTTPRedirection
         case redirect.to_s
         when 'follow'
-          fetch(res['Location'], method:, headers:, body:, redirect:, _redirected: true) # steep:ignore ArgumentTypeMismatch
+          # @type var location: String
+          location = res['Location']
+
+          fetch(location, method:, headers:, body:, redirect:, _redirected: true)
         when 'error'
           raise RedirectError, "redirected to #{res['Location']}"
         when 'manual'
@@ -67,7 +70,7 @@ module Fetch
       if pool = Thread.current.thread_variable_get(:fetch_connection_pool)
         pool
       else
-        Thread.current.thread_variable_set :fetch_connection_pool, ConnectionPool.new
+        Thread.current.thread_variable_set(:fetch_connection_pool, ConnectionPool.new)
       end
     end
 

data/lib/fetch/config.rb

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

data/lib/fetch/connection_pool.rb

@@ -4,74 +4,67 @@ 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
-
-          entry.connection
-        else
-          Net::HTTP.new(uri.host, uri.port).tap {|http| # steep:ignore ArgumentTypeMismatch
-            http.use_ssl            = uri.scheme == 'https'
-            http.keep_alive_timeout = Fetch.config.keep_alive_timeout
-
-            @connections[uri.origin] = Entry.new(connection: http, in_use: true)
-
-            http.start
-          }
-        end
-      }.tap {
-        @sweeper.wakeup
-      }
+    def checkout(uri)
+      if entry = @mutex.synchronize { @connections.delete(uri.origin) }
+        entry.first
+      else
+        # @type var host: String
+        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.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.connection_max_idle_time < Time.now
-            entry.connection.finish
+        @connections.each do |origin, (conn, last_used)|
+          if last_used + Fetch.config.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.1'
+  VERSION = '0.4.3'
 end

data/lib/fetch.rb

@@ -10,7 +10,7 @@ module Fetch
   end
 
   configure do |config|
-    config.connection_max_idle_time = 10
-    config.keep_alive_timeout       = 2
+    config.max_idle_time      = 30
+    config.keep_alive_timeout = 15
   end
 end

data/sig/fetch/config.rbs

@@ -1,6 +1,6 @@
 module Fetch
   class Config
-    attr_accessor connection_max_idle_time: Integer
+    attr_accessor max_idle_time: Integer
     attr_accessor keep_alive_timeout: Integer
   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.1
+  version: 0.4.3
 platform: ruby
 authors:
 - Keita Urashima
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-08 00:00:00.000000000 Z
+date: 2024-07-10 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