httpx 0.14.0 → 0.14.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: abbeaccc55115244f08e7b39aaad174a34dd2e7aeb10b32cdc0563fbefe1b953
-  data.tar.gz: a39fc4e5644b21c1265840011e969c36904756573584cba0f805d568a549ec94
+  metadata.gz: 16f2f2bc0c8dfff4c7a92bc573f25e717a703f06fa8f336bde41bd60ad86ad87
+  data.tar.gz: 313f1fe9ec2c3d5a04f838c36d6ceee6982c60e3b4d6646644428f0c5c6d1d74
 SHA512:
-  metadata.gz: 82fa475dcd9ef05ebe90f0b3c742c17c33185410a70eb5af730fce393681b7f9f346decf78349614f77b76257550c0e3056e61f3b5d6cd5efdba0149eff235f6
-  data.tar.gz: 64ceb596415b440c99c9df31569fa0ee2f7c94e51787d5e0d84141f1ade0be92e23e2d7011a361c1366b43c4f159525599367009bd4021c358537f11c4605cac
+  metadata.gz: 6780278b2b12254fe0f1a884a78d7e102e965d2d5f93b7431a2239e5b2d5e8c25e6e122715af89b03e786ba752b265d53d94d1f3a66cac7fe2a26299ff25491d
+  data.tar.gz: e85a43e840647f60a721481e112c8b8672f3f478d4bacdae6337c52beca5e3a198e2e9f0206592ecb111dfd0b5be33addf2f2e930255750ed89f145631f8d66c

data/doc/release_notes/0_14_1.md

@@ -0,0 +1,7 @@
+# 0.14.1
+
+
+## Bugfixes
+
+* fixed: HTTP/2-specific headers were being reused on insecure redirects, thereby creating an invalid request (#128);
+* fixed: multipart request parts weren't using explicity set `:content_type`, instead using file mime type or "text/plain";

data/doc/release_notes/0_14_2.md

@@ -0,0 +1,6 @@
+# 0.14.2
+
+
+## Bugfixes
+
+* fixed: multipart request parts weren't using explicity set `:filename`.

data/doc/release_notes/0_14_3.md

@@ -0,0 +1,5 @@
+# 0.14.3
+
+## Bugfixes
+
+* fixed: HTTP/1 "connection: close" header was "leaking" into subsequent redirect follow, including HTTP/2 requests which would fail due to the invalid header.

data/doc/release_notes/0_14_4.md

@@ -0,0 +1,5 @@
+# 0.14.4
+
+## Bugfixes
+
+* The HTTP/1 handler was miscalculating the last request for a given connection, and potentially freezing it.

data/doc/release_notes/0_14_5.md

@@ -0,0 +1,11 @@
+# 0.14.5
+
+## Bugfixes
+
+* After a connection had been initiated, sending multiple concurrent requests (ex: `open_httpx.request(req1, req2, req3)`) could freeze; this happened when the first request would fill the write buffer (like a file upload request), and the subsequent requests would never be buffered afterwards; this was fixed by making pending requests flushing a part of a connection's consumption loop.
+* Fixing v0.14.1's fixed bug again; The HTTP/1 "Connection: close" header was not being set in the last possible request on a connection, due to ann off-by-one error on connection bookkeeping;
+* HTTP/1 connections didn't respect a server-set max nunmber of requests after a reconnect; Fixed by making this accounting part of the reset process;
+
+## Chore
+
+* Added regression test suite, which reproduce reported bugs before the fix (backported all 0.14.x releases here)

data/lib/httpx/connection.rb

@@ -360,6 +360,8 @@ module HTTPX
             write_drained = false
           end unless interests == :r
 
+          send_pending if @state == :open
+
           # return if socket is drained
           next unless (interests != :r || read_drained) &&
                       (interests != :w || write_drained)

data/lib/httpx/connection/http1.rb

@@ -40,6 +40,7 @@ module HTTPX
     def reset
       @max_requests = @options.max_requests || MAX_REQUESTS
       @parser.reset!
+      @handshake_completed = false
     end
 
     def close
@@ -80,7 +81,6 @@ module HTTPX
         break if idx >= concurrent_requests_limit
         next if request.state == :done
 
-        request.headers["connection"] ||= request.options.persistent || idx < requests_limit - 1 ? "keep-alive" : "close"
         handle(request)
       end
     end
@@ -254,12 +254,24 @@ module HTTPX
     end
 
     def set_protocol_headers(request)
-      request.headers["host"] ||= request.authority
-      request.headers["connection"] ||= request.options.persistent ? "keep-alive" : "close"
       if !request.headers.key?("content-length") &&
          request.body.bytesize == Float::INFINITY
         request.chunk!
       end
+
+      requests_limit = [@max_requests, @requests.size].min
+
+      connection = if request != @requests[requests_limit - 1] &&
+                      request.options.persistent && @max_requests != 1
+        "keep-alive"
+      else
+        "close"
+      end
+
+      {
+        "host" => (request.headers["host"] || request.authority),
+        "connection" => connection,
+      }
     end
 
     def headline_uri(request)
@@ -282,8 +294,8 @@ module HTTPX
     def join_headers(request)
       @buffer << "#{request.verb.to_s.upcase} #{headline_uri(request)} HTTP/#{@version.join(".")}" << CRLF
       log(color: :yellow) { "<- HEADLINE: #{@buffer.to_s.chomp.inspect}" }
-      set_protocol_headers(request)
-      join_headers2(request.headers)
+      extra_headers = set_protocol_headers(request)
+      join_headers2(request.headers.each(extra_headers))
       log { "<- " }
       @buffer << CRLF
     end

data/lib/httpx/connection/http2.rb

@@ -192,18 +192,20 @@ module HTTPX
     end
 
     def set_protocol_headers(request)
-      request.headers[":scheme"]    = request.scheme
-      request.headers[":method"]    = request.verb.to_s.upcase
-      request.headers[":path"]      = headline_uri(request)
-      request.headers[":authority"] = request.authority
+      {
+        ":scheme" => request.scheme,
+        ":method" => request.verb.to_s.upcase,
+        ":path" => headline_uri(request),
+        ":authority" => request.authority,
+      }
     end
 
     def join_headers(stream, request)
-      set_protocol_headers(request)
+      extra_headers = set_protocol_headers(request)
       log(level: 1, color: :yellow) do
-        request.headers.each.map { |k, v| "#{stream.id}: -> HEADER: #{k}: #{v}" }.join("\n")
+        request.headers.merge(extra_headers).each.map { |k, v| "#{stream.id}: -> HEADER: #{k}: #{v}" }.join("\n")
       end
-      stream.headers(request.headers.each, end_stream: request.empty?)
+      stream.headers(request.headers.each(extra_headers), end_stream: request.empty?)
     end
 
     def join_trailers(stream, request)

data/lib/httpx/headers.rb

@@ -103,12 +103,16 @@ module HTTPX
     # returns the enumerable headers store in pairs of header field + the values in
     # the comma-separated string format
     #
-    def each
-      return enum_for(__method__) { @headers.size } unless block_given?
+    def each(extra_headers = nil)
+      return enum_for(__method__, extra_headers) { @headers.size } unless block_given?
 
       @headers.each do |field, value|
         yield(field, value.join(", ")) unless value.empty?
       end
+
+      extra_headers.each do |field, value|
+        yield(field, value) unless value.empty?
+      end if extra_headers
     end
 
     def ==(other)

data/lib/httpx/idna.rb

@@ -0,0 +1,15 @@
+module HTTPX
+  module IDNA
+    module_function
+
+    begin
+      require "idn"
+
+      def convert(non_ascii_hostname); end
+    rescue LoadError
+      def convert(non_ascii_hostname)
+        DomainName.new(non_ascii_hostname).hostname
+      end
+    end
+  end
+end

data/lib/httpx/plugins/multipart/part.rb

@@ -26,7 +26,7 @@ module HTTPX
           content_type ||= MimeTypeDetector.call(value, filename) || "application/octet-stream"
           [value, content_type, filename]
         else
-          [StringIO.new(value.to_s), "text/plain"]
+          [StringIO.new(value.to_s), content_type || "text/plain", filename]
         end
       end
     end

data/lib/httpx/plugins/ntlm_authentication.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module HTTPX
+  module Plugins
+    #
+    # https://gitlab.com/honeyryderchuck/httpx/wikis/Authentication#ntlm-authentication
+    #
+    module NTLMAuthentication
+      NTLMParams = Struct.new(:user, :domain, :password)
+
+      class << self
+        def load_dependencies(_klass)
+          require "base64"
+          require "ntlm"
+        end
+
+        def configure(klass)
+          klass.plugin(:authentication)
+        end
+
+        def extra_options(options)
+          Class.new(options.class) do
+            def_option(:ntlm, <<-OUT)
+              raise Error, ":ntlm must be a #{NTLMParams}" unless value.is_a?(#{NTLMParams})
+
+              value
+            OUT
+          end.new(options).merge(max_concurrent_requests: 1)
+        end
+      end
+
+      module InstanceMethods
+        def ntlm_authentication(user, password, domain = nil)
+          with(ntlm: NTLMParams.new(user, domain, password))
+        end
+
+        alias_method :ntlm_auth, :ntlm_authentication
+
+        def request(*args, **options)
+          requests = build_requests(*args, options)
+          request = requests.first
+          ntlm = request.options.ntlm
+
+          return super(*requests, **options) unless ntlm
+
+          request.headers["authorization"] = "NTLM #{NTLM.negotiate(domain: ntlm.domain).to_base64}"
+          probe_response = wrap { send_requests(*request, options).first }
+
+          return probe_response unless probe_response.status == 401 && probe_response.headers.key?("www-authenticate") &&
+                                       (challenge = probe_response.headers["www-authenticate"][/NTLM (.*)/, 1])
+
+          challenge = Base64.decode64(challenge)
+          ntlm_challenge = NTLM.authenticate(challenge, ntlm.user, ntlm.domain, ntlm.password).to_base64
+
+          request.transition(:idle)
+
+          request.headers["authorization"] = "NTLM #{ntlm_challenge}"
+          super(request, **options)
+        end
+      end
+    end
+    register_plugin :ntlm_authentication, NTLMAuthentication
+  end
+end

data/lib/httpx/plugins/proxy/http.rb

@@ -82,11 +82,12 @@ module HTTPX
           end
 
           def set_protocol_headers(request)
-            super
+            extra_headers = super
+
             proxy_params = @options.proxy
-            request.headers["proxy-authorization"] = "Basic #{proxy_params.token_authentication}" if proxy_params.authenticated?
-            request.headers["proxy-connection"] = request.headers["connection"]
-            request.headers.delete("connection")
+            extra_headers["proxy-authorization"] = "Basic #{proxy_params.token_authentication}" if proxy_params.authenticated?
+            extra_headers["proxy-connection"] = extra_headers.delete("connection") if extra_headers.key?("connection")
+            extra_headers
           end
         end
 

data/lib/httpx/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HTTPX
-  VERSION = "0.14.0"
+  VERSION = "0.14.5"
 end

data/sig/connection/http1.rbs

@@ -52,7 +52,7 @@ module HTTPX
 
     def disable_pipelining: () -> void
 
-    def set_protocol_headers: (Request) -> void
+    def set_protocol_headers: (Request) -> _Each[headers_key, String]
 
     def headline_uri: (Request) -> String
 
@@ -62,7 +62,7 @@ module HTTPX
 
     def join_trailers: (Request request) -> void
 
-    def join_headers2: (Headers headers) -> void
+    def join_headers2: (_Each[headers_key, String] headers) -> void
 
     def join_body: (Request request) -> void
 

data/sig/connection/http2.rbs

@@ -43,7 +43,7 @@ module HTTPX
 
     def headline_uri: (Request) -> String
 
-    def set_protocol_headers: (Request) -> void
+    def set_protocol_headers: (Request) -> _Each[headers_key, String]
 
     def handle: (Request request, HTTP2Next::Stream stream) -> void
 

data/sig/headers.rbs

@@ -14,8 +14,8 @@ module HTTPX
     def add: (headers_key field, string value) -> void
     def delete: (headers_key field) -> void
 
-    def each: () { (headers_key, String) -> void } -> void
-            | () -> Enumerable[[headers_key, String], void]
+    def each: (?_Each[headers_key, String]? extra_headers) { (headers_key, String) -> void } -> void
+            | (?_Each[headers_key, String]? extra_headers) -> Enumerable[[headers_key, String], void]
 
     def get: (headers_key field) -> Array[String]
     def key?: (headers_key downcased_key) -> bool

data/sig/plugins/multipart.rbs

@@ -33,7 +33,7 @@ module HTTPX
       end
 
       module Part
-        def self?.call: (multipart_nested_value) -> ([_Reader, String, String?] | [_Reader, String])
+        def self?.call: (multipart_nested_value) -> ([_Reader, String, String?])
       end
 
       module MimeTypeDetector

data/sig/plugins/ntlm_authentication.rbs

@@ -0,0 +1,27 @@
+module HTTPX
+  module Plugins
+    module NTLMAuthentication
+
+      interface _NTLMOptions
+        def ntlm: () -> NTLMParams?
+        def ntlm=: (NTLMParams) -> NTLMParams
+      end
+ 
+      def self.extra_options: (Options) -> (Options & _NTLMOptions)
+
+      def self.load_dependencies: (*untyped) -> void
+
+      module InstanceMethods
+        def ntlm_authentication: (string user, string password, ?string? domain) -> instance
+      end
+
+      class NTLMParams
+        attr_reader user: String
+        attr_reader password: String
+        attr_reader domain: String?
+      end
+    end
+
+    type sessionNTLMAuthentication = Plugins::sessionAuthentication & Plugins::NTLMAuthentication::InstanceMethods
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: httpx
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.14.5
 platform: ruby
 authors:
 - Tiago Cardoso
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-22 00:00:00.000000000 Z
+date: 2021-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http-2-next
@@ -47,10 +47,13 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.md
 - doc/release_notes/0_0_1.md
+- doc/release_notes/0_14_5.md
 - doc/release_notes/0_1_0.md
 - doc/release_notes/0_0_5.md
+- doc/release_notes/0_14_1.md
 - doc/release_notes/0_0_4.md
 - doc/release_notes/0_14_0.md
+- doc/release_notes/0_14_4.md
 - doc/release_notes/0_6_5.md
 - doc/release_notes/0_13_0.md
 - doc/release_notes/0_6_1.md
@@ -80,10 +83,12 @@ extra_rdoc_files:
 - doc/release_notes/0_11_1.md
 - doc/release_notes/0_8_0.md
 - doc/release_notes/0_3_0.md
+- doc/release_notes/0_14_3.md
 - doc/release_notes/0_2_1.md
 - doc/release_notes/0_0_3.md
 - doc/release_notes/0_0_2.md
 - doc/release_notes/0_3_1.md
+- doc/release_notes/0_14_2.md
 - doc/release_notes/0_2_0.md
 files:
 - LICENSE.txt
@@ -105,6 +110,11 @@ files:
 - doc/release_notes/0_13_1.md
 - doc/release_notes/0_13_2.md
 - doc/release_notes/0_14_0.md
+- doc/release_notes/0_14_1.md
+- doc/release_notes/0_14_2.md
+- doc/release_notes/0_14_3.md
+- doc/release_notes/0_14_4.md
+- doc/release_notes/0_14_5.md
 - doc/release_notes/0_1_0.md
 - doc/release_notes/0_2_0.md
 - doc/release_notes/0_2_1.md
@@ -142,6 +152,7 @@ files:
 - lib/httpx/errors.rb
 - lib/httpx/extensions.rb
 - lib/httpx/headers.rb
+- lib/httpx/idna.rb
 - lib/httpx/io.rb
 - lib/httpx/io/ssl.rb
 - lib/httpx/io/tcp.rb
@@ -178,6 +189,7 @@ files:
 - lib/httpx/plugins/multipart/encoder.rb
 - lib/httpx/plugins/multipart/mime_type_detector.rb
 - lib/httpx/plugins/multipart/part.rb
+- lib/httpx/plugins/ntlm_authentication.rb
 - lib/httpx/plugins/persistent.rb
 - lib/httpx/plugins/proxy.rb
 - lib/httpx/plugins/proxy/http.rb
@@ -237,6 +249,7 @@ files:
 - sig/plugins/follow_redirects.rbs
 - sig/plugins/h2c.rbs
 - sig/plugins/multipart.rbs
+- sig/plugins/ntlm_authentication.rbs
 - sig/plugins/persistent.rbs
 - sig/plugins/proxy.rbs
 - sig/plugins/proxy/http.rbs
@@ -272,7 +285,7 @@ metadata:
   changelog_uri: https://honeyryderchuck.gitlab.io/httpx/#release-notes
   documentation_uri: https://honeyryderchuck.gitlab.io/httpx/rdoc/
   source_code_uri: https://gitlab.com/honeyryderchuck/httpx
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -287,8 +300,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key:
+rubygems_version: 3.0.3
+signing_key: 
 specification_version: 4
 summary: HTTPX, to the future, and beyond
 test_files: []