httpx 0.12.0 → 0.14.1

data/lib/httpx/io/unix.rb

@@ -6,34 +6,43 @@ module HTTPX
   class UNIX < TCP
     extend Forwardable
 
-    def_delegator :@uri, :port, :scheme
+    using URIExtensions
 
-    def initialize(uri, addresses, options)
-      @uri = uri
+    attr_reader :path
+
+    alias_method :host, :path
+
+    def initialize(origin, addresses, options)
       @addresses = addresses
+      @hostname = origin.host
       @state = :idle
       @options = Options.new(options)
-      @path = @options.transport_options[:path]
       @fallback_protocol = @options.fallback_protocol
       if @options.io
         @io = case @options.io
               when Hash
-                @options.io[@path]
+                @options.io[origin.authority]
               else
                 @options.io
         end
-        unless @io.nil?
-          @keep_open = true
-          @state = :connected
+        raise Error, "Given IO objects do not match the request authority" unless @io
+
+        @path = @io.path
+        @keep_open = true
+        @state = :connected
+      else
+        if @options.transport_options
+          # :nocov:
+          warn ":#{__method__} is deprecated, use :addresses instead"
+          @path = @options.transport_options[:path]
+          # :nocov:
+        else
+          @path = addresses.first
         end
       end
       @io ||= build_socket
     end
 
-    def hostname
-      @uri.host
-    end
-
     def connect
       return unless closed?
 
@@ -51,6 +60,12 @@ module HTTPX
            ::IO::WaitReadable
     end
 
+    # :nocov:
+    def inspect
+      "#<#{self.class}(path: #{@path}): (state: #{@state})>"
+    end
+    # :nocov:
+
     private
 
     def build_socket

data/lib/httpx/options.rb

@@ -4,13 +4,39 @@ module HTTPX
   class Options
     WINDOW_SIZE = 1 << 14 # 16K
     MAX_BODY_THRESHOLD_SIZE = (1 << 10) * 112 # 112K
+    CONNECT_TIMEOUT = 60
+    OPERATION_TIMEOUT = 60
+    KEEP_ALIVE_TIMEOUT = 20
+
+    DEFAULT_OPTIONS = {
+      :debug => ENV.key?("HTTPX_DEBUG") ? $stderr : nil,
+      :debug_level => (ENV["HTTPX_DEBUG"] || 1).to_i,
+      :ssl => {},
+      :http2_settings => { settings_enable_push: 0 },
+      :fallback_protocol => "http/1.1",
+      :timeout => {
+        connect_timeout: CONNECT_TIMEOUT,
+        operation_timeout: OPERATION_TIMEOUT,
+        keep_alive_timeout: KEEP_ALIVE_TIMEOUT,
+      },
+      :headers => {},
+      :window_size => WINDOW_SIZE,
+      :body_threshold_size => MAX_BODY_THRESHOLD_SIZE,
+      :request_class => Class.new(Request),
+      :response_class => Class.new(Response),
+      :headers_class => Class.new(Headers),
+      :request_body_class => Class.new(Request::Body),
+      :response_body_class => Class.new(Response::Body),
+      :connection_class => Class.new(Connection),
+      :transport => nil,
+      :transport_options => nil,
+      :addresses => nil,
+      :persistent => false,
+      :resolver_class => (ENV["HTTPX_RESOLVER"] || :native).to_sym,
+      :resolver_options => { cache: true },
+    }.freeze
 
     class << self
-      def inherited(klass)
-        super
-        klass.instance_variable_set(:@defined_options, @defined_options.dup)
-      end
-
       def new(options = {})
         # let enhanced options go through
         return options if self == Options && options.class > self
@@ -19,31 +45,30 @@ module HTTPX
         super
       end
 
-      def defined_options
-        @defined_options ||= []
-      end
+      def def_option(name, layout = nil, &interpreter)
+        attr_reader name
 
-      def def_option(name, &interpreter)
-        defined_options << name.to_sym
+        if layout
+          class_eval(<<-OUT, __FILE__, __LINE__ + 1)
+            def #{name}=(value)
+              return if value.nil?
 
-        attr_reader name
+              value = begin
+                #{layout}
+              end
+
+              @#{name} = value
+            end
+          OUT
 
-        if interpreter
+        elsif interpreter
           define_method(:"#{name}=") do |value|
             return if value.nil?
 
             instance_variable_set(:"@#{name}", instance_exec(value, &interpreter))
           end
-
-          define_method(:"with_#{name}") do |value|
-            merge(name => instance_exec(value, &interpreter))
-          end
         else
           attr_writer name
-
-          define_method(:"with_#{name}") do |value|
-            merge(name => value)
-          end
         end
 
         protected :"#{name}="
@@ -51,75 +76,71 @@ module HTTPX
     end
 
     def initialize(options = {})
-      defaults = {
-        :debug => ENV.key?("HTTPX_DEBUG") ? $stderr : nil,
-        :debug_level => (ENV["HTTPX_DEBUG"] || 1).to_i,
-        :ssl => {},
-        :http2_settings => { settings_enable_push: 0 },
-        :fallback_protocol => "http/1.1",
-        :timeout => Timeout.new,
-        :headers => {},
-        :window_size => WINDOW_SIZE,
-        :body_threshold_size => MAX_BODY_THRESHOLD_SIZE,
-        :request_class => Class.new(Request),
-        :response_class => Class.new(Response),
-        :headers_class => Class.new(Headers),
-        :request_body_class => Class.new(Request::Body),
-        :response_body_class => Class.new(Response::Body),
-        :connection_class => Class.new(Connection),
-        :transport => nil,
-        :transport_options => nil,
-        :persistent => false,
-        :resolver_class => (ENV["HTTPX_RESOLVER"] || :native).to_sym,
-        :resolver_options => { cache: true },
-      }
-
-      defaults.merge!(options)
+      defaults = DEFAULT_OPTIONS.merge(options)
       defaults.each do |(k, v)|
         next if v.nil?
 
-        __send__(:"#{k}=", v)
+        begin
+          __send__(:"#{k}=", v)
+        rescue NoMethodError
+          raise Error, "unknown option: #{k}"
+        end
       end
     end
 
-    def_option(:headers) do |headers|
+    def_option(:origin, <<-OUT)
+      URI(value)
+    OUT
+
+    def_option(:headers, <<-OUT)
       if self.headers
-        self.headers.merge(headers)
+        self.headers.merge(value)
       else
-        Headers.new(headers)
+        Headers.new(value)
       end
-    end
+    OUT
 
-    def_option(:timeout) do |opts|
-      Timeout.new(opts)
-    end
+    def_option(:timeout, <<-OUT)
+      timeouts = Hash[value]
 
-    def_option(:max_concurrent_requests) do |num|
-      raise Error, ":max_concurrent_requests must be positive" unless num.positive?
+      if timeouts.key?(:loop_timeout)
+        warn ":loop_timeout is deprecated, use :operation_timeout instead"
+        timeouts[:operation_timeout] = timeouts.delete(:loop_timeout)
+      end
 
-      num
-    end
+      timeouts
+    OUT
 
-    def_option(:max_requests) do |num|
-      raise Error, ":max_requests must be positive" unless num.positive?
+    def_option(:max_concurrent_requests, <<-OUT)
+      raise Error, ":max_concurrent_requests must be positive" unless value.positive?
 
-      num
-    end
+      value
+    OUT
 
-    def_option(:window_size) do |num|
-      Integer(num)
-    end
+    def_option(:max_requests, <<-OUT)
+      raise Error, ":max_requests must be positive" unless value.positive?
 
-    def_option(:body_threshold_size) do |num|
-      Integer(num)
-    end
+      value
+    OUT
 
-    def_option(:transport) do |tr|
-      transport = tr.to_s
-      raise Error, "#{transport} is an unsupported transport type" unless IO.registry.key?(transport)
+    def_option(:window_size, <<-OUT)
+      Integer(value)
+    OUT
+
+    def_option(:body_threshold_size, <<-OUT)
+      Integer(value)
+    OUT
+
+    def_option(:transport, <<-OUT)
+      transport = value.to_s
+      raise Error, "\#{transport} is an unsupported transport type" unless IO.registry.key?(transport)
 
       transport
-    end
+    OUT
+
+    def_option(:addresses, <<-OUT)
+      Array(value)
+    OUT
 
     %w[
       params form json body ssl http2_settings
@@ -153,6 +174,8 @@ module HTTPX
 
       h1 = to_hash
 
+      return self if h1 == h2
+
       merged = h1.merge(h2) do |k, v1, v2|
         case k
         when :headers, :ssl, :http2_settings, :timeout
@@ -166,10 +189,10 @@ module HTTPX
     end
 
     def to_hash
-      hash_pairs = self.class
-                       .defined_options
-                       .flat_map { |opt_name| [opt_name, send(opt_name)] }
-      Hash[*hash_pairs]
+      hash_pairs = instance_variables.map do |ivar|
+        [ivar[1..-1].to_sym, instance_variable_get(ivar)]
+      end
+      Hash[hash_pairs]
     end
 
     def initialize_dup(other)

data/lib/httpx/plugins/aws_sdk_authentication.rb

@@ -32,9 +32,8 @@ module HTTPX
       class << self
         attr_reader :credentials, :region
 
-        def load_dependencies(klass)
+        def load_dependencies(_klass)
           require "aws-sdk-core"
-          klass.plugin(:aws_sigv4)
 
           client = Class.new(Seahorse::Client::Base) do
             @identifier = :httpx
@@ -50,6 +49,10 @@ module HTTPX
           @region = client.config[:region]
         end
 
+        def configure(klass)
+          klass.plugin(:aws_sigv4)
+        end
+
         def extra_options(options)
           options.merge(max_concurrent_requests: 1)
         end

data/lib/httpx/plugins/aws_sigv4.rb

@@ -143,13 +143,14 @@ module HTTPX
       class << self
         def extra_options(options)
           Class.new(options.class) do
-            def_option(:sigv4_signer) do |signer|
-              signer.is_a?(Signer) ? signer : Signer.new(signer)
-            end
-          end.new.merge(options)
+            def_option(:sigv4_signer, <<-OUT)
+              value.is_a?(#{Signer}) ? value : #{Signer}.new(value)
+            OUT
+          end.new(options)
         end
 
         def load_dependencies(klass)
+          require "digest/sha2"
           require "openssl"
           klass.plugin(:expect)
           klass.plugin(:compression)

data/lib/httpx/plugins/basic_authentication.rb

@@ -8,9 +8,14 @@ module HTTPX
     # https://gitlab.com/honeyryderchuck/httpx/wikis/Authentication#basic-authentication
     #
     module BasicAuthentication
-      def self.load_dependencies(klass)
-        require "base64"
-        klass.plugin(:authentication)
+      class << self
+        def load_dependencies(_klass)
+          require "base64"
+        end
+
+        def configure(klass)
+          klass.plugin(:authentication)
+        end
       end
 
       module InstanceMethods

data/lib/httpx/plugins/compression.rb

@@ -13,23 +13,31 @@ module HTTPX
     # https://gitlab.com/honeyryderchuck/httpx/wikis/Compression
     #
     module Compression
-      extend Registry
-
       class << self
-        def load_dependencies(klass)
+        def configure(klass)
           klass.plugin(:"compression/gzip")
           klass.plugin(:"compression/deflate")
         end
 
         def extra_options(options)
+          encodings = Module.new do
+            extend Registry
+          end
+
           Class.new(options.class) do
-            def_option(:compression_threshold_size) do |bytes|
-              bytes = Integer(bytes)
+            def_option(:compression_threshold_size, <<-OUT)
+              bytes = Integer(value)
               raise Error, ":expect_threshold_size must be positive" unless bytes.positive?
 
               bytes
-            end
-          end.new(options).merge(headers: { "accept-encoding" => Compression.registry.keys })
+            OUT
+
+            def_option(:encodings, <<-OUT)
+              raise Error, ":encodings must be a registry" unless value.respond_to?(:registry)
+
+              value
+            OUT
+          end.new(options).merge(encodings: encodings)
         end
       end
 
@@ -37,7 +45,11 @@ module HTTPX
         def initialize(*)
           super
           # forego compression in the Range cases
-          @headers.delete("accept-encoding") if @headers.key?("range")
+          if @headers.key?("range")
+            @headers.delete("accept-encoding")
+          else
+            @headers["accept-encoding"] ||= @options.encodings.registry.keys
+          end
         end
       end
 
@@ -52,16 +64,16 @@ module HTTPX
           @headers.get("content-encoding").each do |encoding|
             next if encoding == "identity"
 
-            @body = Encoder.new(@body, Compression.registry(encoding).deflater)
+            @body = Encoder.new(@body, options.encodings.registry(encoding).deflater)
           end
-          @headers["content-length"] = @body.bytesize unless chunked?
+          @headers["content-length"] = @body.bytesize unless unbounded_body?
         end
       end
 
       module ResponseBodyMethods
         attr_reader :encodings
 
-        def initialize(*, **)
+        def initialize(*)
           @encodings = []
 
           super
@@ -80,7 +92,7 @@ module HTTPX
           @_inflaters = @headers.get("content-encoding").map do |encoding|
             next if encoding == "identity"
 
-            inflater = Compression.registry(encoding).inflater(compressed_length)
+            inflater = @options.encodings.registry(encoding).inflater(compressed_length)
             # do not uncompress if there is no decoder available. In fact, we can't reliably
             # continue decompressing beyond that, so ignore.
             break unless inflater

data/lib/httpx/plugins/compression/brotli.rb

@@ -4,24 +4,27 @@ module HTTPX
   module Plugins
     module Compression
       module Brotli
-        def self.load_dependencies(klass)
-          klass.plugin(:compression)
-          require "brotli"
-        end
+        class << self
+          def load_dependencies(_klass)
+            require "brotli"
+          end
 
-        def self.configure(*)
-          Compression.register "br", self
+          def configure(klass)
+            klass.plugin(:compression)
+            klass.default_options.encodings.register "br", self
+          end
         end
 
         module Deflater
           module_function
 
-          def deflate(raw, buffer, chunk_size:)
+          def deflate(raw, buffer = "".b, chunk_size: 16_384)
             while (chunk = raw.read(chunk_size))
               compressed = ::Brotli.deflate(chunk)
               buffer << compressed
               yield compressed if block_given?
             end
+            buffer
           end
         end