httpi 4.0.1 → 4.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70c75f8e865f40f9218b34d091ab64aad2656467fff356ac18e2530b70dc52d7
-  data.tar.gz: fb86901d88b603911f98d1dbcad0132a0c3f6c28ce3d7b1640ce5b84f7524659
+  metadata.gz: bb83de56d8f0e1b609e317db0a889b669290c6888b2ef4a41efe682bcd092ec3
+  data.tar.gz: a2ec713acb8c51714850de1490c2b247d10fdd0ada7227fbd89ec4cdfb3c7963
 SHA512:
-  metadata.gz: 4eddf2bd30c64892ec8bc478e5774382030a829b58450a7e0b2266ebdba4f7b01ead27315253c56ba454addc9c7a6112b77f553684e35d143e06397c51de5389
-  data.tar.gz: 5b497936201359ed9b45df8486875bb6be8706fedeeed5ec7d7b43a0c15555cff46e3a7fc48a50b1970a76e2dae202eef591ccf74325caf8d5faf77a09f46789
+  metadata.gz: bd35a2d65bc74884715d763c2790aa0567355c84337f17459fc6d0956b2f019fc6c82dba220bd3fd707b1e1837dcf6b264395ef109251196211d700b76e9f66e
+  data.tar.gz: f965bcc58b97d692f295408058bbf2ee3cf70d7b19221cc892aa4bdd250aa177bedc1303efc172c1e953ec7c44327cb026ca044fbf32144b4bb1bf1c435ebb17

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 * Add your changelog entry here
 
+### 4.0.2 (2024-06-13)
+
+* Don't change http header casing by @pcai in https://github.com/savonrb/httpi/pull/249
+
 ### 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.

data/httpi.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'base64'
   s.add_dependency 'mutex_m'
 
-  s.add_development_dependency 'rubyntlm', '~> 0.3.2'
+  s.add_development_dependency 'rubyntlm', '~> 0.6.4'
   s.add_development_dependency 'rake',     '~> 13.0'
   s.add_development_dependency 'rspec',    '~> 3.5'
   s.add_development_dependency 'mocha',    '~> 0.13'

data/lib/httpi/utils.rb

@@ -3,236 +3,93 @@
 # library for it. 
 module HTTPI
   module Utils
-    # HTTPI::Utils::Headers is a Hash subclass that downcases all keys.
+    # A case-insensitive Hash that preserves the original case of a
+    # header when set.
+    #
     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
+      def self.[](headers)
+        if headers.is_a?(Headers) && !headers.frozen?
+          return headers
         else
-          hash = new
-          loop do
-            break if items.length == 0
-            key = items.shift
-            value = items.shift
-            hash[key] = value
-          end
-          hash
+          return self.new(headers)
         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)
+      def initialize(hash = {})
+        super()
+        @names = {}
+        hash.each { |k, v| self[k] = v }
       end
 
-      def fetch(key, *default, &block)
-        key = downcase_key(key)
+      # on dup/clone, we need to duplicate @names hash
+      def initialize_copy(other)
         super
+        @names = other.names.dup
       end
 
-      def fetch_values(*a)
-        super(*a.map!{|key| downcase_key(key)})
+      # on clear, we need to clear @names hash
+      def clear
+        super
+        @names.clear
       end
 
-      def has_key?(key)
-        super(downcase_key(key))
+      def each
+        super do |k, v|
+          yield(k, v.respond_to?(:to_ary) ? v.to_ary.join("\n") : v)
+        end
       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}
+      def to_hash
+        hash = {}
+        each { |k, v| hash[k] = v }
         hash
       end
 
-      def merge(hash, &block)
-        dup.merge!(hash, &block)
+      def [](k)
+        super(k) || super(@names[k.downcase])
       end
 
-      def reject(&block)
-        hash = dup
-        hash.reject!(&block)
-        hash
+      def []=(k, v)
+        canonical = k.downcase.freeze
+        delete k if @names[canonical] && @names[canonical] != k # .delete is expensive, don't invoke it unless necessary
+        @names[canonical] = k
+        super k, v
       end
 
-      def replace(hash)
-        clear
-        update(hash)
+      def delete(k)
+        canonical = k.downcase
+        result = super @names.delete(canonical)
+        result
       end
 
-      def select(&block)
-        hash = dup
-        hash.select!(&block)
-        hash
+      def include?(k)
+        super || @names.include?(k.downcase)
       end
 
-      def to_proc
-        lambda{|x| self[x]}
-      end
+      alias_method :has_key?, :include?
+      alias_method :member?, :include?
+      alias_method :key?, :include?
 
-      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
+      def merge!(other)
+        other.each { |k, v| self[k] = v }
         self
       end
-      alias merge! update
 
-      def values_at(*keys)
-        keys.map{|key| self[key]}
+      def merge(other)
+        hash = dup
+        hash.merge! other
       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
+      def replace(other)
+        clear
+        other.each { |k, v| self[k] = v }
+        self
       end
 
-      # :nocov:
-      if RUBY_VERSION >= '3.0'
-      # :nocov:
-        def except(*a)
-          super(*a.map!{|key| downcase_key(key)})
+      protected
+        def names
+          @names
         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 = '4.0.1'
+  VERSION = '4.0.2'
 end

data/spec/httpi/adapter/httpclient_spec.rb

@@ -215,8 +215,7 @@ describe HTTPI::Adapter::HTTPClient do
     end
   end
 
-  # TODO: ntlm_openssl3 https://github.com/WinRb/rubyntlm/issues/57
-  xit "supports NTLM authentication" do
+  it "supports NTLM authentication" do
     request = HTTPI::Request.new(@server.url + "ntlm-auth")
 
     request.auth.ntlm("tester", "vReqSoafRe5O")

data/spec/httpi/response_spec.rb

@@ -118,6 +118,10 @@ describe HTTPI::Response do
       it "returns the HTTP response headers" do
         expect(response.headers).to eq HTTPI::Utils::Headers.new.merge({ "Content-Type" => "application/dime" })
       end
+
+      it "preserves casing" do
+        expect(response.headers.keys).to eq ["Content-Type"]
+      end
     end
 
     describe "#body" do

data/spec/integration/net_http_spec.rb

@@ -138,8 +138,7 @@ describe HTTPI::Adapter::NetHTTP do
         to raise_error(HTTPI::NotSupportedError, /does not support HTTP digest authentication/)
     end
 
-    # TODO: ntlm_openssl3 https://github.com/WinRb/rubyntlm/issues/57
-    xit "supports ntlm authentication" do
+    it "supports ntlm authentication" do
       request = HTTPI::Request.new(@server.url + "ntlm-auth")
       request.auth.ntlm("tester", "vReqSoafRe5O")
 
@@ -167,8 +166,7 @@ describe HTTPI::Adapter::NetHTTP do
       HTTPI::Adapter::NetHTTP.any_instance.unstub(:check_net_ntlm_version!)
     end
 
-    # TODO: ntlm_openssl3 https://github.com/WinRb/rubyntlm/issues/57
-    xit "does check ntlm when ntlm authentication is requested" do
+    it "does check ntlm when ntlm authentication is requested" do
       request = HTTPI::Request.new(@server.url + "ntlm-auth")
       request.auth.ntlm("tester", "vReqSoafRe5O")
 
@@ -185,8 +183,7 @@ describe HTTPI::Adapter::NetHTTP do
       HTTPI::Adapter::NetHTTP.any_instance.unstub(:ntlm_version)
     end
 
-    # TODO: ntlm_openssl3 https://github.com/WinRb/rubyntlm/issues/57
-    xit "does not crash when authenticate header is missing (on second request)" do
+    it "does not crash when authenticate header is missing (on second request)" do
       request = HTTPI::Request.new(@server.url + "ntlm-auth")
       request.auth.ntlm("tester", "vReqSoafRe5O")
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: httpi
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 4.0.2
 platform: ruby
 authors:
 - Daniel Harrington
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-16 00:00:00.000000000 Z
+date: 2024-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -79,14 +79,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.2
+        version: 0.6.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.2
+        version: 0.6.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -262,7 +262,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: Common interface for Ruby's HTTP libraries