httpi 3.0.2 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd06f829b3d33418dfe3ef465949f504f6acde0e9f5988edea9615e700bb8f23
-  data.tar.gz: '00197cf31c50d34768c76325d42cc8dc325774ffe5a2ecaf6feb33f7d22c382c'
+  metadata.gz: 70c75f8e865f40f9218b34d091ab64aad2656467fff356ac18e2530b70dc52d7
+  data.tar.gz: fb86901d88b603911f98d1dbcad0132a0c3f6c28ce3d7b1640ce5b84f7524659
 SHA512:
-  metadata.gz: 81a2a86d8a7784711c0a72995a21262c7bcdfb17d9127a06a9573c50f7eaffde7e544c07b332e905da3fb1b177d867d34c2b59a75f0605182a6d278db9eda4a6
-  data.tar.gz: e59a0468efe743db6a4b4d7eff007714cb739e928396b7ff8797896a346e7808a2635185ccf1a9eb53db64d149626782a4f3dc530f3e9644c21923ce6a4a0f3d
+  metadata.gz: 4eddf2bd30c64892ec8bc478e5774382030a829b58450a7e0b2266ebdba4f7b01ead27315253c56ba454addc9c7a6112b77f553684e35d143e06397c51de5389
+  data.tar.gz: 5b497936201359ed9b45df8486875bb6be8706fedeeed5ec7d7b43a0c15555cff46e3a7fc48a50b1970a76e2dae202eef591ccf74325caf8d5faf77a09f46789

data/.github/workflows/development.yml

@@ -34,7 +34,7 @@ jobs:
             experimental: true
     
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     
     - name: Install dependencies
       run: sudo apt-get install libcurl4-openssl-dev

data/CHANGELOG.md

@@ -1,10 +1,23 @@
 ### Unreleased
 
-* Improvement: [#237](https://github.com/savonrb/httpi/pull/237) Implemented `adapter_client_setup`.
+* Add your changelog entry here
+
+### 4.0.1 (2024-02-16)
+
+HTTPI is officially in maintenance mode. Our emphasis will now be on bugs, security fixes, and compatibility with the wider ecosystem. See [this issue](https://github.com/savonrb/httpi/issues/238) for details.
+
+* Adds support for rack 3.0.
+* POTENTIAL BREAKING CHANGE: `HTTPI::Request#headers` and `HTTPI::Response#headers` now return `HTTPI::Utils::Headers` instead of `Rack::Utils::HeaderHash`. This change will prevent HTTPI from breaking or changing its public API whenever rack rearranges its classes. If you were relying on the `Rack::Utils::HeaderHash` implementation, you will need to update your code to use `HTTPI::Utils::Headers` instead.
+
+### 4.0.0 (yanked)
+
+Yanked due to a bug when used with rack 2.
 
 ### 3.0.2 (2024-02-10)
 
+* Improvement: [#237](https://github.com/savonrb/httpi/pull/237) Implemented `adapter_client_setup`.
 * Add support for ruby 3.1, 3.2, 3.3. Drop support for ruby 2.7 and below.
+* Pin to rack version < 3, HTTPI is not tested with rack 3 yet.
 
 ### 3.0.1 (2021-12-17)
 

data/Gemfile

@@ -15,7 +15,7 @@ gem 'net-http-persistent', '~> 4.0',    :require => false
 gem 'http',                             :require => false
 
 # adapter extensions
-gem 'rack', '< 3'
+gem 'rack'
 gem 'socksify'
 
 # coverage

data/README.md

@@ -1,6 +1,6 @@
 # HTTPI
 
-A common interface for Ruby's HTTP libraries.
+A common interface for Ruby's HTTP libraries. This project is now in maintenance mode. For new projects, we recommend [faraday](https://github.com/lostisland/faraday).
 
 [Documentation](https://www.rubydoc.info/gems/httpi)
 
@@ -14,7 +14,7 @@ HTTPI is available through [Rubygems](https://rubygems.org/gems/httpi) and can b
 
 or add it to your Gemfile like this:
 
-    gem 'httpi', '~> 3.0.0'
+    gem 'httpi', '~> 4.0.0'
 
 ## Usage example
 
@@ -36,6 +36,17 @@ HTTPI.adapter = :httpclient
 
 # and execute arbitary requests
 HTTPI.request(:custom, request)
+
+# add a client setup block that will be called before each request
+HTTPI.adapter = :httpclient
+HTTPI.adapter_client_setup = proc do |x|
+  x.ssl_config.set_default_paths
+  x.force_basic_auth = true
+end
+# ...
+HTTPI.get(request) do |x|
+  x.force_basic_auth = false
+end
 ```
 
 ### SOCKS Proxy Support

data/UPDATING.md

@@ -5,3 +5,7 @@
 BREAKING CHANGE: the [#255](https://github.com/savonrb/httpi/pull/225) made the gem socksify and rack gems optional dependencies.
 
 In order to restore the old behavior, see the README section "SOCKS Proxy Support" and "Rack Mock Adapter".
+
+## From 3.x to 4.x
+
+POTENTIAL BREAKING CHANGE: `HTTPI::Request#headers` and `HTTPI::Response#headers` now return `HTTPI::Utils::Headers` instead of `Rack::Utils::HeaderHash`. This change will prevent HTTPI from breaking or changing its public API whenever rack rearranges its classes. If you were relying on the `Rack::Utils::HeaderHash` implementation, you will need to update your code to use `HTTPI::Utils::Headers` instead.

data/httpi.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |s|
 
   s.license = 'MIT'
 
-  s.add_dependency 'rack', '< 3'
+  s.add_dependency 'rack', '>= 2.0', '< 3.1'
   s.add_dependency 'nkf'
   s.add_dependency 'base64'
   s.add_dependency 'mutex_m'
@@ -30,7 +30,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rake',     '~> 13.0'
   s.add_development_dependency 'rspec',    '~> 3.5'
   s.add_development_dependency 'mocha',    '~> 0.13'
-  s.add_development_dependency 'puma',     '~> 5.0'
+  s.add_development_dependency 'puma',     '~> 6.0'
   s.add_development_dependency 'webmock'
 
   s.metadata["rubygems_mfa_required"] = "true"

data/lib/httpi/request.rb

@@ -64,12 +64,12 @@ module HTTPI
 
     # Returns a Hash of HTTP headers. Defaults to return an empty Hash.
     def headers
-      @headers ||= Rack::Utils::HeaderHash.new
+      @headers ||= HTTPI::Utils::Headers.new
     end
 
     # Sets the Hash of HTTP headers.
     def headers=(headers)
-      @headers = Rack::Utils::HeaderHash.new(headers)
+      @headers = HTTPI::Utils::Headers.new.merge(headers)
     end
 
     # Adds a header information to accept gzipped content.

data/lib/httpi/response.rb

@@ -20,7 +20,7 @@ module HTTPI
     # Initializer expects an HTTP response +code+, +headers+ and +body+.
     def initialize(code, headers, body)
       self.code = code.to_i
-      self.headers = Rack::Utils::HeaderHash.new(headers)
+      self.headers = HTTPI::Utils::Headers.new.merge(headers)
       self.raw_body = body
     end
 

data/lib/httpi/utils.rb

@@ -0,0 +1,238 @@
+# mostly verbatim from: https://github.com/rack/rack/blob/main/lib/rack/headers.rb
+# Because this is part of httpi's public API, its better not to load an external 
+# library for it. 
+module HTTPI
+  module Utils
+    # HTTPI::Utils::Headers is a Hash subclass that downcases all keys.
+    class Headers < Hash
+      KNOWN_HEADERS = {}
+      %w(
+        Accept-CH
+        Accept-Patch
+        Accept-Ranges
+        Access-Control-Allow-Credentials
+        Access-Control-Allow-Headers
+        Access-Control-Allow-Methods
+        Access-Control-Allow-Origin
+        Access-Control-Expose-Headers
+        Access-Control-Max-Age
+        Age
+        Allow
+        Alt-Svc
+        Cache-Control
+        Connection
+        Content-Disposition
+        Content-Encoding
+        Content-Language
+        Content-Length
+        Content-Location
+        Content-MD5
+        Content-Range
+        Content-Security-Policy
+        Content-Security-Policy-Report-Only
+        Content-Type
+        Date
+        Delta-Base
+        ETag
+        Expect-CT
+        Expires
+        Feature-Policy
+        IM
+        Last-Modified
+        Link
+        Location
+        NEL
+        P3P
+        Permissions-Policy
+        Pragma
+        Preference-Applied
+        Proxy-Authenticate
+        Public-Key-Pins
+        Referrer-Policy
+        Refresh
+        Report-To
+        Retry-After
+        Server
+        Set-Cookie
+        Status
+        Strict-Transport-Security
+        Timing-Allow-Origin
+        Tk
+        Trailer
+        Transfer-Encoding
+        Upgrade
+        Vary
+        Via
+        WWW-Authenticate
+        Warning
+        X-Cascade
+        X-Content-Duration
+        X-Content-Security-Policy
+        X-Content-Type-Options
+        X-Correlation-ID
+        X-Correlation-Id
+        X-Download-Options
+        X-Frame-Options
+        X-Permitted-Cross-Domain-Policies
+        X-Powered-By
+        X-Redirect-By
+        X-Request-ID
+        X-Request-Id
+        X-Runtime
+        X-UA-Compatible
+        X-WebKit-CS
+        X-XSS-Protection
+      ).each do |str|
+        downcased = str.downcase.freeze
+        KNOWN_HEADERS[str] = KNOWN_HEADERS[downcased] = downcased
+      end
+
+      def self.[](*items)
+        if items.length % 2 != 0
+          if items.length == 1 && items.first.is_a?(Hash)
+            new.merge!(items.first)
+          else
+            raise ArgumentError, "odd number of arguments for Utils::Headers"
+          end
+        else
+          hash = new
+          loop do
+            break if items.length == 0
+            key = items.shift
+            value = items.shift
+            hash[key] = value
+          end
+          hash
+        end
+      end
+
+      def [](key)
+        super(downcase_key(key))
+      end
+
+      def []=(key, value)
+        super(KNOWN_HEADERS[key] || key.downcase.freeze, value)
+      end
+      alias store []=
+
+      def assoc(key)
+        super(downcase_key(key))
+      end
+
+      def compare_by_identity
+        raise TypeError, "Utils::Headers cannot compare by identity, use regular Hash"
+      end
+
+      def delete(key)
+        super(downcase_key(key))
+      end
+
+      def dig(key, *a)
+        super(downcase_key(key), *a)
+      end
+
+      def fetch(key, *default, &block)
+        key = downcase_key(key)
+        super
+      end
+
+      def fetch_values(*a)
+        super(*a.map!{|key| downcase_key(key)})
+      end
+
+      def has_key?(key)
+        super(downcase_key(key))
+      end
+      alias include? has_key?
+      alias key? has_key?
+      alias member? has_key?
+
+      def invert
+        hash = self.class.new
+        each{|key, value| hash[value] = key}
+        hash
+      end
+
+      def merge(hash, &block)
+        dup.merge!(hash, &block)
+      end
+
+      def reject(&block)
+        hash = dup
+        hash.reject!(&block)
+        hash
+      end
+
+      def replace(hash)
+        clear
+        update(hash)
+      end
+
+      def select(&block)
+        hash = dup
+        hash.select!(&block)
+        hash
+      end
+
+      def to_proc
+        lambda{|x| self[x]}
+      end
+
+      def transform_values(&block)
+        dup.transform_values!(&block)
+      end
+
+      def update(hash, &block)
+        hash.each do |key, value|
+          self[key] = if block_given? && include?(key)
+            block.call(key, self[key], value)
+          else
+            value
+          end
+        end
+        self
+      end
+      alias merge! update
+
+      def values_at(*keys)
+        keys.map{|key| self[key]}
+      end
+
+      # :nocov:
+      if RUBY_VERSION >= '2.5'
+      # :nocov:
+        def slice(*a)
+          h = self.class.new
+          a.each{|k| h[k] = self[k] if has_key?(k)}
+          h
+        end
+
+        def transform_keys(&block)
+          dup.transform_keys!(&block)
+        end
+
+        def transform_keys!
+          hash = self.class.new
+          each do |k, v|
+            hash[yield k] = v
+          end
+          replace(hash)
+        end
+      end
+
+      # :nocov:
+      if RUBY_VERSION >= '3.0'
+      # :nocov:
+        def except(*a)
+          super(*a.map!{|key| downcase_key(key)})
+        end
+      end
+
+      private
+
+      def downcase_key(key)
+        key.is_a?(String) ? KNOWN_HEADERS[key] || key.downcase : key
+      end
+    end
+  end
+end

data/lib/httpi/version.rb

@@ -1,3 +1,3 @@
 module HTTPI
-  VERSION = '3.0.2'
+  VERSION = '4.0.1'
 end

data/lib/httpi.rb

@@ -3,6 +3,7 @@ require "httpi/version"
 require "httpi/logger"
 require "httpi/request"
 require "httpi/query_builder"
+require "httpi/utils"
 
 require "httpi/adapter/httpclient"
 require "httpi/adapter/curb"

data/spec/httpi/request_spec.rb

@@ -92,11 +92,11 @@ describe HTTPI::Request do
         after { HTTPI.query_builder = :flat }
 
         it "lets you specify query parameter as Hash" do
-          expect(request.url.to_s).to eq("http://example.com?q[]=nested&q[]=query")
+          expect(request.url.to_s).to eq("http://example.com?q%5B%5D=nested&q%5B%5D=query")
         end
 
         it "getter return String for query parameter as Hash" do
-          expect(request.query).to eq("q[]=nested&q[]=query")
+          expect(request.query).to eq("q%5B%5D=nested&q%5B%5D=query")
         end
       end
     end
@@ -149,7 +149,7 @@ describe HTTPI::Request do
   describe "#headers" do
     it "lets you specify a Hash of HTTP request headers" do
       request.headers = { "Accept-Encoding" => "gzip" }
-      expect(request.headers).to eq({ "Accept-Encoding" => "gzip" })
+      expect(request.headers).to eq HTTPI::Utils::Headers.new.merge({ "Accept-Encoding" => "gzip" })
     end
 
     it "defaults to return an empty Hash" do
@@ -235,7 +235,7 @@ describe HTTPI::Request do
         end
         it "request body using a Hash with Array" do
           request.body = {:foo => :bar, :baz => [:foo, :tst]}
-          expect(request.body.split("&")).to match_array(["foo=bar", "baz[]=foo", "baz[]=tst"])
+          expect(request.body.split("&")).to match_array(["foo=bar", "baz%5B%5D=foo", "baz%5B%5D=tst"])
         end
       end
     end

data/spec/httpi/response_spec.rb

@@ -88,7 +88,7 @@ describe HTTPI::Response do
 
     describe "#headers" do
       it "returns the HTTP response headers" do
-        expect(response.headers).to eq({ "Content-Encoding" => "gzip" })
+        expect(response.headers).to eq HTTPI::Utils::Headers.new.merge({ "Content-Encoding" => "gzip" })
       end
     end
 
@@ -116,7 +116,7 @@ describe HTTPI::Response do
 
     describe "#headers" do
       it "returns the HTTP response headers" do
-        expect(response.headers).to eq({ "Content-Type" => "application/dime" })
+        expect(response.headers).to eq HTTPI::Utils::Headers.new.merge({ "Content-Type" => "application/dime" })
       end
     end
 

data/spec/integration/support/server.rb

@@ -57,7 +57,7 @@ class IntegrationServer
   private
 
   def events
-    Puma::Events.new($stdout, $stderr)
+    Puma::Events.new
   end
 
   def add_tcp_listener

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: httpi
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 4.0.1
 platform: ruby
 authors:
 - Daniel Harrington
@@ -9,22 +9,28 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-11 00:00:00.000000000 Z
+date: 2024-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: nkf
   requirement: !ruby/object:Gem::Requirement
@@ -129,14 +135,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -188,6 +194,7 @@ files:
 - lib/httpi/query_builder.rb
 - lib/httpi/request.rb
 - lib/httpi/response.rb
+- lib/httpi/utils.rb
 - lib/httpi/version.rb
 - spec/fixtures/attachment.gif
 - spec/fixtures/client_cert.pem