httpx 0.10.2 → 0.11.0

data/lib/httpx/chainable.rb

@@ -59,7 +59,7 @@ module HTTPX
     private
 
     def default_options
-      @options || Options.new
+      @options || Session.default_options
     end
 
     def branch(options, &blk)

data/lib/httpx/connection/http2.rb

@@ -163,13 +163,13 @@ module HTTPX
     public :reset
 
     def handle_stream(stream, request)
-      stream.on(:close, &method(:on_stream_close).curry[stream, request])
+      stream.on(:close, &method(:on_stream_close).curry(3)[stream, request])
       stream.on(:half_close) do
         log(level: 2) { "#{stream.id}: waiting for response..." }
       end
-      stream.on(:altsvc, &method(:on_altsvc).curry[request.origin])
-      stream.on(:headers, &method(:on_stream_headers).curry[stream, request])
-      stream.on(:data, &method(:on_stream_data).curry[stream, request])
+      stream.on(:altsvc, &method(:on_altsvc).curry(2)[request.origin])
+      stream.on(:headers, &method(:on_stream_headers).curry(3)[stream, request])
+      stream.on(:data, &method(:on_stream_data).curry(3)[stream, request])
     end
 
     def join_headers(stream, request)

data/lib/httpx/domain_name.rb

@@ -139,10 +139,8 @@ module HTTPX
       elsif @hostname.end_with?(othername) && @hostname[-othername.size - 1, 1] == DOT
         # The other is higher
         -1
-      elsif othername.end_with?(@hostname) && othername[-@hostname.size - 1, 1] == DOT
-        # The other is lower
-        1
       else
+        # The other is lower
         1
       end
     end

data/lib/httpx/errors.rb

@@ -24,6 +24,8 @@ module HTTPX
 
   ConnectTimeoutError = Class.new(TimeoutError)
 
+  ResolveTimeoutError = Class.new(TimeoutError)
+
   ResolveError = Class.new(Error)
 
   NativeResolveError = Class.new(ResolveError) do

data/lib/httpx/headers.rb

@@ -119,6 +119,7 @@ module HTTPX
     def to_hash
       Hash[to_a]
     end
+    alias_method :to_h, :to_hash
 
     # the headers store in array of pairs format
     def to_a

data/lib/httpx/io/ssl.rb

@@ -7,16 +7,16 @@ module HTTPX
     TLS_OPTIONS = if OpenSSL::SSL::SSLContext.instance_methods.include?(:alpn_protocols)
       { alpn_protocols: %w[h2 http/1.1] }
     else
-      # :nocov:
       {}
-      # :nocov:
     end
 
     def initialize(_, _, options)
       @ctx = OpenSSL::SSL::SSLContext.new
       ctx_options = TLS_OPTIONS.merge(options.ssl)
+      @tls_hostname = ctx_options.delete(:hostname)
       @ctx.set_params(ctx_options) unless ctx_options.empty?
       super
+      @tls_hostname ||= @hostname
       @state = :negotiated if @keep_open
     end
 
@@ -59,11 +59,11 @@ module HTTPX
 
       unless @io.is_a?(OpenSSL::SSL::SSLSocket)
         @io = OpenSSL::SSL::SSLSocket.new(@io, @ctx)
-        @io.hostname = @hostname
+        @io.hostname = @tls_hostname
         @io.sync_close = true
       end
       @io.connect_nonblock
-      @io.post_connection_check(@hostname) if @ctx.verify_mode != OpenSSL::SSL::VERIFY_NONE
+      @io.post_connection_check(@tls_hostname) if @ctx.verify_mode != OpenSSL::SSL::VERIFY_NONE
       transition(:negotiated)
     rescue ::IO::WaitReadable
       @interests = :r
@@ -71,7 +71,6 @@ module HTTPX
       @interests = :w
     end
 
-    # :nocov:
     if RUBY_VERSION < "2.3"
       def read(_, buffer)
         super
@@ -99,14 +98,11 @@ module HTTPX
         end
       end
     end
-    # :nocov:
 
-    # :nocov:
     def inspect
       id = @io.closed? ? "closed" : @io.to_io.fileno
       "#<SSL(fd: #{id}): #{@ip}:#{@port} state: #{@state}>"
     end
-    # :nocov:
 
     private
 

data/lib/httpx/io/udp.rb

@@ -25,7 +25,7 @@ module HTTPX
       true
     end
 
-    if RUBY_VERSION < "2.2"
+    if RUBY_VERSION < "2.3"
       # :nocov:
       def close
         @io.close

data/lib/httpx/plugins/expect.rb

@@ -10,6 +10,10 @@ module HTTPX
     module Expect
       EXPECT_TIMEOUT = 2
 
+      def self.no_expect_store
+        @no_expect_store ||= []
+      end
+
       def self.extra_options(options)
         Class.new(options.class) do
           def_option(:expect_timeout) do |seconds|
@@ -28,25 +32,46 @@ module HTTPX
         end.new(options).merge(expect_timeout: EXPECT_TIMEOUT)
       end
 
-      module RequestBodyMethods
-        def initialize(*, options)
+      module RequestMethods
+        def initialize(*)
           super
-          return if @body.nil?
+          return if @body.empty?
 
-          threshold = options.expect_threshold_size
-          return if threshold && !unbounded_body? && @body.bytesize < threshold
+          threshold = @options.expect_threshold_size
+          return if threshold && !@body.unbounded_body? && @body.bytesize < threshold
+
+          return if Expect.no_expect_store.include?(origin)
 
           @headers["expect"] = "100-continue"
         end
+
+        def response=(response)
+          if response && response.status == 100 &&
+             !@headers.key?("expect") &&
+             (@state == :body || @state == :done)
+
+            # if we're past this point, this means that we just received a 100-Continue response,
+            # but the request doesn't have the expect flag, and is already flushing (or flushed) the body.
+            #
+            # this means that expect was deactivated for this request too soon, i.e. response took longer.
+            #
+            # so we have to reactivate it again.
+            @headers["expect"] = "100-continue"
+            @informational_status = 100
+            Expect.no_expect_store.delete(origin)
+          end
+          super
+        end
       end
 
       module ConnectionMethods
         def send(request)
-          request.once(:expects) do
+          request.once(:expect) do
             @timers.after(@options.expect_timeout) do
-              if request.state == :expects && !request.expects?
+              if request.state == :expect && !request.expects?
+                Expect.no_expect_store << request.origin
                 request.headers.delete("expect")
-                handle(request)
+                consume
               end
             end
           end

data/lib/httpx/plugins/multipart.rb

@@ -10,53 +10,58 @@ module HTTPX
     # https://gitlab.com/honeyryderchuck/httpx/wikis/Multipart-Uploads
     #
     module Multipart
-      module FormTranscoder
-        module_function
-
-        class Encoder
-          extend Forwardable
-
-          def_delegator :@raw, :content_type
-
-          def_delegator :@raw, :to_s
+      MULTIPART_VALUE_COND = lambda do |value|
+        value.respond_to?(:read) ||
+          (value.respond_to?(:to_hash) &&
+            value.key?(:body) &&
+            (value.key?(:filename) || value.key?(:content_type)))
+      end
 
-          def_delegator :@raw, :read
+      class << self
+        def normalize_keys(key, value, &block)
+          Transcoder.normalize_keys(key, value, MULTIPART_VALUE_COND, &block)
+        end
 
-          def initialize(form)
-            @raw = if multipart?(form)
-              HTTP::FormData::Multipart.new(Hash[form.flat_map { |k, v| Transcoder.enum_for(:normalize_keys, k, v).to_a }])
-            else
-              HTTP::FormData::Urlencoded.new(form, :encoder => Transcoder::Form.method(:encode))
+        def load_dependencies(*)
+          begin
+            unless defined?(HTTP::FormData)
+              # in order not to break legacy code, we'll keep loading http/form_data for them.
+              require "http/form_data"
+              warn "httpx: http/form_data is no longer a requirement to use HTTPX :multipart plugin. See migration instructions under" \
+                "https://honeyryderchuck.gitlab.io/httpx/wiki/Multipart-Uploads.html#notes. \n\n" \
+                "If you'd like to stop seeing this message, require 'http/form_data' yourself."
             end
+          rescue LoadError
           end
+          require "httpx/plugins/multipart/encoder"
+          require "httpx/plugins/multipart/part"
+          require "httpx/plugins/multipart/mime_type_detector"
+        end
 
-          def bytesize
-            @raw.content_length
-          end
+        def configure(*)
+          Transcoder.register("form", FormTranscoder)
+        end
+      end
 
-          private
+      module FormTranscoder
+        module_function
 
-          def multipart?(data)
-            data.any? do |_, v|
-              v.is_a?(HTTP::FormData::Part) ||
-                (v.respond_to?(:to_ary) && v.to_ary.any? { |e| e.is_a?(HTTP::FormData::Part) }) ||
-                (v.respond_to?(:to_hash) && v.to_hash.any? { |_, e| e.is_a?(HTTP::FormData::Part) })
-            end
+        def encode(form)
+          if multipart?(form)
+            Encoder.new(form)
+          else
+            Transcoder::Form::Encoder.new(form)
           end
         end
 
-        def encode(form)
-          Encoder.new(form)
+        def multipart?(data)
+          data.any? do |_, v|
+            MULTIPART_VALUE_COND.call(v) ||
+              (v.respond_to?(:to_ary) && v.to_ary.any?(&MULTIPART_VALUE_COND)) ||
+              (v.respond_to?(:to_hash) && v.to_hash.any? { |_, e| MULTIPART_VALUE_COND.call(e) })
+          end
         end
       end
-
-      def self.load_dependencies(*)
-        require "http/form_data"
-      end
-
-      def self.configure(*)
-        Transcoder.register("form", FormTranscoder)
-      end
     end
     register_plugin :multipart, Multipart
   end

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

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+module HTTPX::Plugins
+  module Multipart
+    class Encoder
+      attr_reader :bytesize
+
+      def initialize(form)
+        @boundary = ("-" * 21) << SecureRandom.hex(21)
+        @part_index = 0
+        @buffer = "".b
+
+        @form = form
+        @parts = to_parts(form)
+      end
+
+      def content_type
+        "multipart/form-data; boundary=#{@boundary}"
+      end
+
+      def read(length = nil, outbuf = nil)
+        data   = outbuf.clear.force_encoding(Encoding::BINARY) if outbuf
+        data ||= "".b
+
+        read_chunks(data, length)
+
+        data unless length && data.empty?
+      end
+
+      def rewind
+        form = @form.each_with_object([]) do |(key, val), aux|
+          v = case val
+              when File
+                val = val.reopen(val.path, File::RDONLY) if val.closed?
+                val.rewind
+                val
+              else
+                v
+          end
+          aux << [key, v]
+        end
+        @form = form
+        @parts = to_parts(form)
+      end
+
+      private
+
+      def to_parts(form)
+        @bytesize = 0
+        params = form.each_with_object([]) do |(key, val), aux|
+          Multipart.normalize_keys(key, val) do |k, v|
+            next if v.nil?
+
+            value, content_type, filename = Part.call(v)
+
+            header = header_part(k, content_type, filename)
+            @bytesize += header.size
+            aux << header
+
+            @bytesize += value.size
+            aux << value
+
+            delimiter = StringIO.new("\r\n")
+            @bytesize += delimiter.size
+            aux << delimiter
+          end
+        end
+        final_delimiter = StringIO.new("--#{@boundary}--\r\n")
+        @bytesize += final_delimiter.size
+        params << final_delimiter
+
+        params
+      end
+
+      def header_part(key, content_type, filename)
+        header = "--#{@boundary}\r\n".b
+        header << "Content-Disposition: form-data; name=#{key.inspect}".b
+        header << "; filename=#{filename.inspect}" if filename
+        header << "\r\nContent-Type: #{content_type}\r\n\r\n"
+        StringIO.new(header)
+      end
+
+      def read_chunks(buffer, length = nil)
+        while @part_index < @parts.size
+          chunk = read_from_part(length)
+
+          next unless chunk
+
+          buffer << chunk.force_encoding(Encoding::BINARY)
+
+          next unless length
+
+          length -= chunk.bytesize
+
+          break if length.zero?
+        end
+      end
+
+      # if there's a current part to read from, tries to read a chunk.
+      def read_from_part(max_length = nil)
+        part = @parts[@part_index]
+
+        chunk = part.read(max_length, @buffer)
+
+        return chunk if chunk && !chunk.empty?
+
+        part.close if part.respond_to?(:close)
+
+        @part_index += 1
+
+        nil
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module HTTPX
+  module Plugins::Multipart
+    module MimeTypeDetector
+      module_function
+
+      DEFAULT_MIMETYPE = "application/octet-stream"
+
+      # inspired by https://github.com/shrinerb/shrine/blob/master/lib/shrine/plugins/determine_mime_type.rb
+      if defined?(MIME::Types)
+
+        def call(_file, filename)
+          mime = MIME::Types.of(filename).first
+          mime.content_type if mime
+        end
+
+      elsif defined?(MimeMagic)
+
+        def call(file, *)
+          mime = MimeMagic.by_magic(file)
+          mime.type if mime
+        end
+
+      elsif system("which file", out: File::NULL)
+        require "open3"
+
+        def call(file, *)
+          return if file.eof? # file command returns "application/x-empty" for empty files
+
+          Open3.popen3(*%w[file --mime-type --brief -]) do |stdin, stdout, stderr, thread|
+            begin
+              ::IO.copy_stream(file, stdin.binmode)
+            rescue Errno::EPIPE
+            end
+            file.rewind
+            stdin.close
+
+            status = thread.value
+
+            # call to file command failed
+            if status.nil? || !status.success?
+              $stderr.print(stderr.read)
+            else
+
+              output = stdout.read.strip
+
+              if output.include?("cannot open")
+                $stderr.print(output)
+              else
+                output
+              end
+            end
+          end
+        end
+
+      else
+
+        def call(*); end
+
+      end
+    end
+  end
+end