httpx 0.24.5 → 1.0.0

data/lib/httpx/plugins/grpc/grpc_encoding.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module HTTPX
+  module Transcoder
+    module GRPCEncoding
+      class Deflater
+        extend Forwardable
+
+        attr_reader :content_type
+
+        def initialize(body, compressed:)
+          @content_type = body.content_type
+          @body = BodyReader.new(body)
+          @compressed = compressed
+        end
+
+        def bytesize
+          return @body.bytesize if @body.respond_to?(:bytesize)
+
+          Float::INFINITY
+        end
+
+        def read(length = nil, outbuf = nil)
+          buf = @body.read(length, outbuf)
+
+          return unless buf
+
+          compressed_flag = @compressed ? 1 : 0
+
+          buf = outbuf if outbuf
+
+          buf.prepend([compressed_flag, buf.bytesize].pack("CL>"))
+          buf
+        end
+      end
+
+      class Inflater
+        def initialize(response)
+          @encodings = response.headers.get("grpc-encoding")
+          @response = response
+        end
+
+        def call(message, &blk)
+          data = "".b
+
+          until message.empty?
+            compressed, size = message.unpack("CL>")
+
+            encoded_data = message.byteslice(5..size + 5 - 1)
+
+            if compressed == 1
+              @encodings.reverse_each do |encoding|
+                decoder = @response.body.class.initialize_inflater_by_encoding(encoding, @response, bytesize: encoded_data.bytesize)
+                encoded_data = decoder.call(encoded_data)
+
+                blk.call(encoded_data) if blk
+
+                data << encoded_data
+              end
+            else
+              blk.call(encoded_data) if blk
+
+              data << encoded_data
+            end
+
+            message = message.byteslice((size + 5)..-1)
+          end
+
+          data
+        end
+      end
+
+      def self.encode(*args, **kwargs)
+        Deflater.new(*args, **kwargs)
+      end
+
+      def self.decode(response)
+        Inflater.new(response)
+      end
+    end
+  end
+end

data/lib/httpx/plugins/grpc/message.rb

@@ -12,57 +12,25 @@ module HTTPX
         # decodes a unary grpc response
         def unary(response)
           verify_status(response)
-          decode(response.to_s, encodings: response.headers.get("grpc-encoding"), encoders: response.encoders)
+
+          decoder = Transcoder::GRPCEncoding.decode(response)
+
+          decoder.call(response.to_s)
         end
 
         # lazy decodes a grpc stream response
         def stream(response, &block)
           return enum_for(__method__, response) unless block
 
+          decoder = Transcoder::GRPCEncoding.decode(response)
+
           response.each do |frame|
-            decode(frame, encodings: response.headers.get("grpc-encoding"), encoders: response.encoders, &block)
+            decoder.call(frame, &block)
           end
 
           verify_status(response)
         end
 
-        # encodes a single grpc message
-        def encode(bytes, deflater:)
-          if deflater
-            compressed_flag = 1
-            bytes = deflater.deflate(StringIO.new(bytes))
-          else
-            compressed_flag = 0
-          end
-
-          "".b << [compressed_flag, bytes.bytesize].pack("CL>") << bytes.to_s
-        end
-
-        # decodes a single grpc message
-        def decode(message, encodings:, encoders:)
-          until message.empty?
-
-            compressed, size = message.unpack("CL>")
-
-            data = message.byteslice(5..size + 5 - 1)
-            if compressed == 1
-              encodings.reverse_each do |algo|
-                next unless encoders.key?(algo)
-
-                inflater = encoders[algo].inflater(size)
-                data = inflater.inflate(data)
-                size = data.bytesize
-              end
-            end
-
-            return data unless block_given?
-
-            yield data
-
-            message = message.byteslice((size + 5)..-1)
-          end
-        end
-
         def cancel(request)
           request.emit(:refuse, :client_cancellation)
         end

data/lib/httpx/plugins/grpc.rb

@@ -49,20 +49,19 @@ module HTTPX
       class << self
         def load_dependencies(*)
           require "stringio"
+          require "httpx/plugins/grpc/grpc_encoding"
           require "httpx/plugins/grpc/message"
           require "httpx/plugins/grpc/call"
         end
 
         def configure(klass)
           klass.plugin(:persistent)
-          klass.plugin(:compression)
           klass.plugin(:stream)
         end
 
         def extra_options(options)
           options.merge(
             fallback_protocol: "h2",
-            http2_settings: { wait_for_handshake: false },
             grpc_rpcs: {}.freeze,
             grpc_compression: false,
             grpc_deadline: DEADLINE
@@ -108,9 +107,18 @@ module HTTPX
           @trailing_metadata = Hash[trailers]
           super
         end
+      end
+
+      module RequestBodyMethods
+        def initialize(headers, _)
+          super
 
-        def encoders
-          @options.encodings
+          if (compression = headers["grpc-encoding"])
+            deflater_body = self.class.initialize_deflater_body(@body, compression)
+            @body = Transcoder::GRPCEncoding.encode(deflater_body || @body, compressed: !deflater_body.nil?)
+          else
+            @body = Transcoder::GRPCEncoding.encode(@body, compressed: false)
+          end
         end
       end
 
@@ -233,7 +241,7 @@ module HTTPX
           uri.path = rpc_method
 
           headers = HEADERS.merge(
-            "grpc-accept-encoding" => ["identity", *@options.encodings.keys]
+            "grpc-accept-encoding" => ["identity", *@options.supported_compression_formats]
           )
           unless deadline == Float::INFINITY
             # convert to milliseconds
@@ -244,27 +252,13 @@ module HTTPX
           headers = headers.merge(metadata) if metadata
 
           # prepare compressor
-          deflater = nil
           compression = @options.grpc_compression == true ? "gzip" : @options.grpc_compression
 
-          if compression
-            headers["grpc-encoding"] = compression
-            deflater = @options.encodings[compression].deflater if @options.encodings.key?(compression)
-          end
+          headers["grpc-encoding"] = compression if compression
 
           headers.merge!(@options.call_credentials.call) if @options.call_credentials
 
-          body = if input.respond_to?(:each)
-            Enumerator.new do |y|
-              input.each do |message|
-                y << Message.encode(message, deflater: deflater)
-              end
-            end
-          else
-            Message.encode(input, deflater: deflater)
-          end
-
-          build_request("POST", uri, headers: headers, body: body)
+          build_request("POST", uri, headers: headers, body: input)
         end
       end
     end

data/lib/httpx/plugins/h2c.rb

@@ -13,7 +13,6 @@ module HTTPX
 
       class << self
         def load_dependencies(klass)
-          require "base64"
           klass.plugin(:upgrade)
         end
 

data/lib/httpx/plugins/{ntlm_authentication.rb → ntlm_auth.rb}

@@ -3,12 +3,12 @@
 module HTTPX
   module Plugins
     #
-    # https://gitlab.com/os85/httpx/wikis/Authentication#ntlm-authentication
+    # https://gitlab.com/os85/httpx/wikis/Authorization#ntlm-auth
     #
     module NTLMAuth
       class << self
         def load_dependencies(_klass)
-          require_relative "authentication/ntlm"
+          require_relative "auth/ntlm"
         end
 
         def extra_options(options)
@@ -25,11 +25,11 @@ module HTTPX
       end
 
       module InstanceMethods
-        def ntlm_authentication(user, password, domain = nil)
+        def ntlm_auth(user, password, domain = nil)
           with(ntlm: Authentication::Ntlm.new(user, password, domain: domain))
         end
 
-        alias_method :ntlm_auth, :ntlm_authentication
+        private
 
         def send_requests(*requests)
           requests.flat_map do |request|
@@ -55,6 +55,6 @@ module HTTPX
         end
       end
     end
-    register_plugin :ntlm_authentication, NTLMAuth
+    register_plugin :ntlm_auth, NTLMAuth
   end
 end

data/lib/httpx/plugins/oauth.rb

@@ -8,7 +8,7 @@ module HTTPX
     module OAuth
       class << self
         def load_dependencies(_klass)
-          require_relative "authentication/basic"
+          require_relative "auth/basic"
         end
       end
 
@@ -106,7 +106,7 @@ module HTTPX
       end
 
       module InstanceMethods
-        def oauth_authentication(**args)
+        def oauth_auth(**args)
           with(oauth_session: OAuthSession.new(**args))
         end
 

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "base64"
-
 module HTTPX
   module Plugins
     module Proxy

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

@@ -92,10 +92,6 @@ module HTTPX
             @options = Options.new(options)
           end
 
-          def timeout
-            @options.timeout[:operation_timeout]
-          end
-
           def close; end
 
           def consume(*); end

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

@@ -20,7 +20,7 @@ module HTTPX
 
         class << self
           def load_dependencies(*)
-            require_relative "../authentication/socks5"
+            require_relative "../auth/socks5"
           end
 
           def extra_options(options)
@@ -144,10 +144,6 @@ module HTTPX
             @options = Options.new(options)
           end
 
-          def timeout
-            @options.timeout[:operation_timeout]
-          end
-
           def close; end
 
           def consume(*); end

data/lib/httpx/plugins/proxy.rb

@@ -28,35 +28,6 @@ module HTTPX
         def extra_options(options)
           options.merge(supported_proxy_protocols: [])
         end
-
-        if URI::Generic.methods.include?(:use_proxy?)
-          def use_proxy?(*args)
-            URI::Generic.use_proxy?(*args)
-          end
-        else
-          # https://github.com/ruby/uri/blob/ae07f956a4bea00b4f54a75bd40b8fa918103eed/lib/uri/generic.rb
-          def use_proxy?(hostname, addr, port, no_proxy)
-            hostname = hostname.downcase
-            dothostname = ".#{hostname}"
-            no_proxy.scan(/([^:,\s]+)(?::(\d+))?/) do |p_host, p_port|
-              if !p_port || port == p_port.to_i
-                if p_host.start_with?(".")
-                  return false if hostname.end_with?(p_host.downcase)
-                else
-                  return false if dothostname.end_with?(".#{p_host.downcase}")
-                end
-                if addr
-                  begin
-                    return false if IPAddr.new(p_host).include?(addr)
-                  rescue IPAddr::InvalidAddressError
-                    next
-                  end
-                end
-              end
-            end
-            true
-          end
-        end
       end
 
       class Parameters
@@ -82,7 +53,7 @@ module HTTPX
 
           auth_scheme = scheme.to_s.capitalize
 
-          require_relative "authentication/#{scheme}" unless defined?(Authentication) && Authentication.const_defined?(auth_scheme, false)
+          require_relative "auth/#{scheme}" unless defined?(Authentication) && Authentication.const_defined?(auth_scheme, false)
 
           @authenticator = Authentication.const_get(auth_scheme).new(@username, @password, **extra)
         end
@@ -162,8 +133,8 @@ module HTTPX
               no_proxy = proxy[:no_proxy]
               no_proxy = no_proxy.join(",") if no_proxy.is_a?(Array)
 
-              return super(request, connections, options.merge(proxy: nil)) unless Proxy.use_proxy?(uri.host, next_proxy.host,
-                                                                                                    next_proxy.port, no_proxy)
+              return super(request, connections, options.merge(proxy: nil)) unless URI::Generic.use_proxy?(uri.host, next_proxy.host,
+                                                                                                           next_proxy.port, no_proxy)
             end
 
             proxy.merge(uri: next_proxy)

data/lib/httpx/plugins/retries.rb

@@ -88,13 +88,12 @@ module HTTPX
              request.retries.positive? &&
              __repeatable_request?(request, options) &&
              (
-               # rubocop:disable Style/MultilineTernaryOperator
-               options.retry_on ?
-               options.retry_on.call(response) :
                (
                  response.is_a?(ErrorResponse) && __retryable_error?(response.error)
+               ) ||
+               (
+                 options.retry_on && options.retry_on.call(response)
                )
-               # rubocop:enable Style/MultilineTernaryOperator
              )
             __try_partial_retry(request, response)
             log { "failed to get response, #{request.retries} tries to go..." }

data/lib/httpx/plugins/stream.rb

@@ -94,6 +94,10 @@ module HTTPX
     # https://gitlab.com/honeyryderchuck/httpx/wikis/Stream
     #
     module Stream
+      def self.extra_options(options)
+        options.merge(timeout: { read_timeout: Float::INFINITY, operation_timeout: 60 })
+      end
+
       module InstanceMethods
         def request(*args, stream: false, **options)
           return super(*args, **options) unless stream
@@ -139,12 +143,6 @@ module HTTPX
           super
         end
       end
-
-      def self.const_missing(const_name)
-        super unless const_name == :StreamResponse
-        warn "DEPRECATION WARNING: the class #{self}::StreamResponse is deprecated. Use HTTPX::StreamResponse instead."
-        HTTPX::StreamResponse
-      end
     end
     register_plugin :stream, Stream
   end