fetch-api 0.3.4 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 872edd7141621bba9ac97f850fd7affb5daf229d3c2db581bf2f5422424fdecf
-  data.tar.gz: 1bcce61d1a762827070efc219024d3520b5c2959ede385bcfc2b3ba5d6897dc3
+  metadata.gz: dbef9662b23db6e0efca2b67264d6450553991b551ec94f1b7099c0b4c2eda55
+  data.tar.gz: 0456d3ff62bcceeaa780ff9cb42c3ff231d667b977ef968e22bb5b2a5578e358
 SHA512:
-  metadata.gz: 4c88efee5d27ab2b0d1765e68d59625fc2b8249f70ced9bcee8467999b7c0f3a59bc43f4289b0e6510b6d31782c16a2e95577dce57294c9281ac6b0c8556cff9
-  data.tar.gz: deb9958e04948dc8e9c809d44517cda3af48497984297478046c0707f28d3daf9dca5fc665b86240bd92c4e77ca9f34b530111c193d9e0e878dfd28397888bc2
+  metadata.gz: 516ebe663dc6f346a8acc56f7a1c8e1a3bc11f3e133f6ca0c10a8544516a6dc8a8e34efd660585de627c595ba66ed17b6df3f3415ec90a439be84e21e50d7343
+  data.tar.gz: 3b0630efe83154f9a71df06aec28b551720a6041e24ce1797626a105eedacc54a96495362e061b391018847cbfd2021e4fd750854b75a546841738f2a58d441c

data/README.md

@@ -102,6 +102,19 @@ res = fetch('http://example.com', **{
 })
 ```
 
+## 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).
+
+These values (in seconds) can be configured as follows:
+
+``` ruby
+Fetch.configure do |config|
+  config.connection_max_idle_time = 10 # default
+  config.keep_alive_timeout       = 2  # default
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/fetch/client.rb

@@ -1,3 +1,4 @@
+require_relative 'connection_pool'
 require_relative 'errors'
 require_relative 'form_data'
 require_relative 'headers'
@@ -6,6 +7,7 @@ require_relative 'url_search_params'
 
 require 'mini_mime'
 require 'net/http'
+require 'net/https'
 require 'singleton'
 require 'uri'
 
@@ -13,12 +15,16 @@ 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)
 
       headers.each do |k, v|
-        req[k] = v
+        req[k.to_s] = v.to_s
       end
 
       case body
@@ -39,16 +45,13 @@ module Fetch
         req.body = body
       end
 
-      http = Net::HTTP.new(uri.hostname, uri.port)
-      http.use_ssl = uri.scheme == 'https'
-
-      res = http.start { _1.request(req) }
+      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)
+          fetch(res['Location'], method:, headers:, body:, redirect:, _redirected: true) # steep:ignore ArgumentTypeMismatch
         when 'error'
           raise RedirectError, "redirected to #{res['Location']}"
         when 'manual'
@@ -65,9 +68,9 @@ module Fetch
 
     def to_response(url, res, redirected)
       Response.new(
-        url:        ,
+        url:        url.to_str,
         status:     res.code.to_i,
-        headers:    Headers.new(res),
+        headers:    Headers.new(res.each),
         body:       res.body,
         redirected:
       )

data/lib/fetch/config.rb

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

data/lib/fetch/connection_pool.rb

@@ -0,0 +1,86 @@
+require_relative '../fetch'
+
+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?
+        end
+      }
+    end
+
+    def with_connection(uri, &block)
+      conn = acquire(uri)
+
+      begin
+        block.call(conn)
+      ensure
+        release uri
+      end
+    end
+
+    private
+
+    def acquire(uri)
+      @mutex.synchronize {
+        entry = @connections[key(uri)]
+
+        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[key(uri)] = Entry.new(connection: http, in_use: true)
+
+            http.start
+          }
+        end
+      }.tap {
+        @sweeper.wakeup
+      }
+    end
+
+    def release(uri)
+      @mutex.synchronize do
+        if entry = @connections[key(uri)]
+          entry.in_use    = false
+          entry.last_used = Time.now
+        end
+      end
+    end
+
+    def sweep
+      @mutex.synchronize do
+        @connections.each do |key, entry|
+          next if entry.in_use
+
+          if entry.last_used + Fetch.config.connection_max_idle_time < Time.now
+            entry.connection.finish
+
+            @connections.delete key
+          end
+        end
+      end
+    end
+
+    def key(uri)
+      "#{Thread.current.object_id}/#{uri.origin}".freeze
+    end
+  end
+end

data/lib/fetch/form_data.rb

@@ -1,7 +1,13 @@
+require 'forwardable'
+
 module Fetch
   class FormData
     include Enumerable
 
+    extend Forwardable
+
+    def_delegators :entries, :each
+
     def self.build(enumerable)
       data = FormData.new
 
@@ -19,7 +25,7 @@ module Fetch
     attr_reader :entries
 
     def append(key, value)
-      @entries.push [key.to_s, value]
+      @entries.push [key.to_s, File === value ? value : value.to_s]
     end
 
     def delete(key)
@@ -50,9 +56,5 @@ module Fetch
     def values
       @entries.map(&:last)
     end
-
-    def each(&block)
-      @entries.each(&block)
-    end
   end
 end

data/lib/fetch/headers.rb

@@ -1,7 +1,13 @@
+require 'forwardable'
+
 module Fetch
   class Headers
     include Enumerable
 
+    extend Forwardable
+
+    def_delegators :entries, :each
+
     def initialize(init = [])
       @data = {}
 
@@ -11,7 +17,7 @@ module Fetch
     end
 
     def append(key, value)
-      (@data[key.to_s.downcase] ||= []) << value
+      (@data[key.to_s.downcase] ||= []) << value.to_s
     end
 
     def delete(key)
@@ -41,9 +47,5 @@ module Fetch
     def values
       @data.values.map { _1.join(', ') }
     end
-
-    def each(&block)
-      entries.each(&block)
-    end
   end
 end

data/lib/fetch/response.rb

@@ -2,7 +2,17 @@ require 'json'
 require 'rack/utils'
 
 module Fetch
-  Response = Data.define(:url, :status, :headers, :body, :redirected) {
+  class Response
+    def initialize(url:, status:, headers:, body:, redirected:)
+      @url        = url
+      @status     = status
+      @headers    = headers
+      @body       = body
+      @redirected = redirected
+    end
+
+    attr_reader :url, :status, :headers, :body, :redirected
+
     def ok
       status.between?(200, 299)
     end
@@ -12,7 +22,9 @@ module Fetch
     end
 
     def json(...)
+      return nil unless body
+
       JSON.parse(body, ...)
     end
-  }
+  end
 end

data/lib/fetch/url_search_params.rb

@@ -1,9 +1,14 @@
+require 'forwardable'
 require 'uri'
 
 module Fetch
   class URLSearchParams
     include Enumerable
 
+    extend Forwardable
+
+    def_delegators :entries, :each
+
     def initialize(options = [])
       @entries = []
 
@@ -22,7 +27,7 @@ module Fetch
     attr_reader :entries
 
     def append(key, value)
-      @entries.push [key.to_s, value]
+      @entries.push [key.to_s, value.to_s]
     end
 
     def delete(key)
@@ -61,9 +66,5 @@ module Fetch
     def values
       @entries.map(&:last)
     end
-
-    def each(&block)
-      @entries.each(&block)
-    end
   end
 end

data/lib/fetch/version.rb

@@ -1,3 +1,3 @@
 module Fetch
-  VERSION = '0.3.4'
+  VERSION = '0.4.0'
 end

data/lib/fetch.rb

@@ -0,0 +1,16 @@
+require_relative 'fetch/config'
+
+module Fetch
+  singleton_class.attr_accessor :config
+
+  self.config = Config.new
+
+  def self.configure(&block)
+    block.call(config)
+  end
+
+  configure do |config|
+    config.connection_max_idle_time = 10
+    config.keep_alive_timeout       = 2
+  end
+end

data/sig/fetch/api.rbs

@@ -0,0 +1,11 @@
+module Fetch
+  class API
+    def self?.fetch: (
+      string,
+      ?method: String | Symbol,
+      ?headers: _Each[[_ToS, _ToS]],
+      ?body: (String | FormData | URLSearchParams)?,
+      ?redirect: 'follow' | 'error' | 'manual' | :follow | :error | :manual,
+    ) -> Response
+  end
+end

data/sig/fetch/client.rbs

@@ -0,0 +1,19 @@
+module Fetch
+  class Client
+    include Singleton
+
+    def fetch: (
+      string,
+      ?method: String | Symbol,
+      ?headers: _Each[[_ToS, _ToS]],
+      ?body: (String | FormData | URLSearchParams)?,
+      ?redirect: 'follow' | 'error' | 'manual' | :follow | :error | :manual,
+      ?_redirected: bool
+    ) -> Response
+
+    private
+
+    def initialize: () -> void
+    def to_response: (string, Net::HTTPResponse, bool) -> Response
+  end
+end

data/sig/fetch/config.rbs

@@ -0,0 +1,6 @@
+module Fetch
+  class Config
+    attr_accessor connection_max_idle_time: Integer
+    attr_accessor keep_alive_timeout: Integer
+  end
+end

data/sig/fetch/connection_pool.rbs

@@ -0,0 +1,21 @@
+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 sweep: () -> void
+    def key: (URI::HTTP) -> String
+  end
+end

data/sig/fetch/errors.rbs

@@ -0,0 +1,7 @@
+module Fetch
+  class Error < StandardError
+  end
+
+  class RedirectError < Error
+  end
+end

data/sig/fetch/form_data.rbs

@@ -0,0 +1,24 @@
+module Fetch
+  class FormData
+    include Enumerable[[String, String | File]]
+
+    extend Forwardable
+
+    attr_reader entries: Array[[String, String | File]]
+
+    def self.build: (_Each[[_ToS, _ToS | File]]) -> FormData
+
+    def initialize: () -> void
+    def append: (_ToS, _ToS | File) -> void
+    def delete: (_ToS) -> void
+    def get: (_ToS) -> (String | File)?
+    def get_all: (_ToS) -> Array[String | File]
+    def has: (_ToS) -> bool
+    def keys: -> Array[String]
+    def set: (_ToS, _ToS | File) -> void
+    def values: () -> Array[String | File]
+
+    def each: () { ([String, String | File]) -> void } -> Array[[String, String | File]]
+            | () -> Enumerator[[String, String | File], Array[[String, String | File]]]
+  end
+end

data/sig/fetch/headers.rbs

@@ -0,0 +1,20 @@
+module Fetch
+  class Headers
+    include Enumerable[[String, String]]
+
+    extend Forwardable
+
+    def initialize: (_Each[[_ToS, _ToS]]) -> void
+    def append: (_ToS, _ToS) -> void
+    def delete: (_ToS) -> void
+    def entries: () -> Array[[String, String]]
+    def get: (_ToS) -> String?
+    def has: (_ToS) -> bool
+    def keys: -> Array[String]
+    def set: (_ToS, _ToS) -> void
+    def values: () -> Array[String]
+
+    def each: () { ([String, String]) -> void } -> Array[[String, String]]
+            | () -> Enumerator[[String, String], Array[[String, String]]]
+  end
+end

data/sig/fetch/response.rbs

@@ -0,0 +1,14 @@
+module Fetch
+  class Response
+    attr_reader url: String
+    attr_reader status: Integer
+    attr_reader headers: Headers
+    attr_reader body: String?
+    attr_reader redirected: bool
+
+    def initialize: (url: String, status: Integer, headers: Headers, body: String?, redirected: bool) -> void
+    def ok: () -> bool
+    def status_text: () -> String
+    def json: (json_options) -> untyped
+  end
+end

data/sig/fetch/url_search_params.rbs

@@ -0,0 +1,24 @@
+module Fetch
+  class URLSearchParams
+    include Enumerable[[String, String]]
+
+    extend Forwardable
+
+    attr_reader entries: Array[[String, String]]
+
+    def self.build: (_Each[[_ToS, _ToS]]) -> FormData
+
+    def initialize: (String | _Each[[_ToS, _ToS]]) -> void
+    def append: (_ToS, _ToS) -> void
+    def delete: (_ToS) -> void
+    def get: (_ToS) -> String?
+    def get_all: (_ToS) -> Array[String]
+    def has: (_ToS) -> bool
+    def keys: -> Array[String]
+    def set: (_ToS, _ToS) -> void
+    def values: () -> Array[String]
+
+    def each: () { ([String, String]) -> void } -> Array[[String, String]]
+            | () -> Enumerator[[String, String], Array[[String, String]]]
+  end
+end

data/sig/fetch.rbs

@@ -1,4 +1,7 @@
 module Fetch
   VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+
+  attr_accessor self.config: Config
+
+  def self.configure: () { (Config) -> void } -> void
 end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: fetch-api
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.4.0
 platform: ruby
 authors:
 - Keita Urashima
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-07 00:00:00.000000000 Z
+date: 2024-07-08 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: forwardable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mini_mime
   requirement: !ruby/object:Gem::Requirement
@@ -90,8 +118,11 @@ files:
 - LICENSE.txt
 - README.md
 - lib/fetch-api.rb
+- lib/fetch.rb
 - lib/fetch/api.rb
 - lib/fetch/client.rb
+- lib/fetch/config.rb
+- lib/fetch/connection_pool.rb
 - lib/fetch/errors.rb
 - lib/fetch/form_data.rb
 - lib/fetch/headers.rb
@@ -99,6 +130,15 @@ files:
 - lib/fetch/url_search_params.rb
 - lib/fetch/version.rb
 - sig/fetch.rbs
+- sig/fetch/api.rbs
+- sig/fetch/client.rbs
+- sig/fetch/config.rbs
+- sig/fetch/connection_pool.rbs
+- sig/fetch/errors.rbs
+- sig/fetch/form_data.rbs
+- sig/fetch/headers.rbs
+- sig/fetch/response.rbs
+- sig/fetch/url_search_params.rbs
 homepage: https://github.com/ursm/fetch-api
 licenses:
 - MIT
@@ -113,7 +153,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.2.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="