fetch-api 0.4.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbef9662b23db6e0efca2b67264d6450553991b551ec94f1b7099c0b4c2eda55
-  data.tar.gz: 0456d3ff62bcceeaa780ff9cb42c3ff231d667b977ef968e22bb5b2a5578e358
+  metadata.gz: 4217a0ddb4ec43da71a630ba5de24d9a6a02af0f5cf2b39286702c1cc512c699
+  data.tar.gz: 05abc4f266fab3577c2223de54957b8c6a84e7b3ccc24df428f40e771c1e311d
 SHA512:
-  metadata.gz: 516ebe663dc6f346a8acc56f7a1c8e1a3bc11f3e133f6ca0c10a8544516a6dc8a8e34efd660585de627c595ba66ed17b6df3f3415ec90a439be84e21e50d7343
-  data.tar.gz: 3b0630efe83154f9a71df06aec28b551720a6041e24ce1797626a105eedacc54a96495362e061b391018847cbfd2021e4fd750854b75a546841738f2a58d441c
+  metadata.gz: c7caa0c96f93f03ae799a121fc7f25410f401c9c192a7546f97627c760cb638627b79d01b0911ed8a4f2ebaacdaa619e86e84a2b88443a721f066a4a9fd4c1d9
+  data.tar.gz: 826e3c4ff75b7b3c3f0886949a6fe141cdd360fd31da86b42b08aabde98b0a608ac6f51561b65819b65622a1a2f344f5e6784505bafb990d0aad300ac8f378b6

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      = 10 # default
+  config.keep_alive_timeout = 2  # default
 end
 ```
 

data/lib/fetch/client.rb

@@ -15,10 +15,6 @@ module Fetch
   class Client
     include Singleton
 
-    def initialize
-      @pool = ConnectionPool.new
-    end
-
     def fetch(resource, method: :get, headers: [], body: nil, redirect: :follow, _redirected: false)
       uri = URI.parse(resource)
       req = Net::HTTP.const_get(method.capitalize).new(uri)
@@ -45,13 +41,17 @@ module Fetch
         req.body = body
       end
 
-      res = @pool.with_connection(uri) { _1.request(req) }
+      # @type var uri: URI::HTTP
+      res = pool.with_connection(uri) { _1.request(req) }
 
       case res
       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) # steep:ignore ArgumentTypeMismatch
         when 'error'
           raise RedirectError, "redirected to #{res['Location']}"
         when 'manual'
@@ -66,6 +66,14 @@ module Fetch
 
     private
 
+    def pool
+      if pool = Thread.current.thread_variable_get(:fetch_connection_pool)
+        pool
+      else
+        Thread.current.thread_variable_set(:fetch_connection_pool, ConnectionPool.new)
+      end
+    end
+
     def to_response(url, res, redirected)
       Response.new(
         url:        url.to_str,

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

@@ -13,7 +13,6 @@ module Fetch
       @sweeper = Thread.new {
         loop do
           sleep 1
-
           sweep
 
           Thread.stop if @connections.empty?
@@ -35,20 +34,23 @@ module Fetch
 
     def acquire(uri)
       @mutex.synchronize {
-        entry = @connections[key(uri)]
+        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
+          # @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
 
-            @connections[key(uri)] = Entry.new(connection: http, in_use: true)
-
             http.start
+
+            @connections[uri.origin] = Entry.new(connection: http, in_use: true)
           }
         end
       }.tap {
@@ -58,7 +60,7 @@ module Fetch
 
     def release(uri)
       @mutex.synchronize do
-        if entry = @connections[key(uri)]
+        if entry = @connections[uri.origin]
           entry.in_use    = false
           entry.last_used = Time.now
         end
@@ -67,20 +69,16 @@ module Fetch
 
     def sweep
       @mutex.synchronize do
-        @connections.each do |key, entry|
+        @connections.each do |origin, entry|
           next if entry.in_use
 
-          if entry.last_used + Fetch.config.connection_max_idle_time < Time.now
+          if entry.last_used + Fetch.config.max_idle_time < Time.now
             entry.connection.finish
 
-            @connections.delete key
+            @connections.delete origin
           end
         end
       end
     end
-
-    def key(uri)
-      "#{Thread.current.object_id}/#{uri.origin}".freeze
-    end
   end
 end

data/lib/fetch/version.rb

@@ -1,3 +1,3 @@
 module Fetch
-  VERSION = '0.4.0'
+  VERSION = '0.4.2'
 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      = 10
+    config.keep_alive_timeout = 2
   end
 end

data/sig/fetch/client.rbs

@@ -14,6 +14,7 @@ module Fetch
     private
 
     def initialize: () -> void
+    def pool: () -> ConnectionPool
     def to_response: (string, Net::HTTPResponse, bool) -> Response
   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

@@ -16,6 +16,5 @@ module Fetch
     def acquire: (URI::HTTP) -> Net::HTTP
     def release: (URI::HTTP) -> void
     def sweep: () -> void
-    def key: (URI::HTTP) -> String
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fetch-api
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.2
 platform: ruby
 authors:
 - Keita Urashima