httpx 0.24.6 → 1.0.0

data/sig/transcoder/utils/deflater.rbs

@@ -0,0 +1,29 @@
+module HTTPX
+  module Transcoder
+    class Deflater
+      extend Forwardable
+
+      @body: BodyReader
+      @buffer: Response::Buffer?
+      @body: _Encoder | StringIO
+      @closed: bool
+
+      attr_reader content_type: String
+
+      def initialize: (_Encoder body) -> void
+
+      def bytesize: () -> (Integer | Float)
+
+      def read: (?int? length, ?string outbuf) -> String?
+
+      def close: () -> void
+
+      def deflate: (String? chunk) -> String?
+
+      private
+
+      def buffer_deflate!: () -> void
+
+    end
+  end
+end

data/sig/transcoder.rbs

@@ -1,7 +1,7 @@
 module HTTPX
-  type bodyIO = _Reader | _Each[[String, untyped]] | _ToS
+  type bodyIO = _Reader | _Each[String] | _ToS
 
-  type body_encoder = Transcoder::_Encoder | _Each[String]
+  type body_encoder = (Transcoder::_Encoder & _ToS) | (Transcoder::_Encoder & _Reader) | (Transcoder::_Encoder & _Each[String])
 
   module Transcoder
     def self?.normalize_keys: [U] (_ToS key, _ToAry[untyped] | _ToHash[_ToS, untyped] | untyped value, ?(^(untyped value) -> bool | nil) cond) { (String, ?untyped) -> U } -> U
@@ -18,10 +18,26 @@ module HTTPX
 
     interface _Encoder
       def bytesize: () -> (Integer | Float)
+
+      def content_type: () -> String
     end
 
     interface _Decoder
       def call: (Response response, *untyped) -> untyped
     end
+
+    interface _Inflater
+      def initialize: (Integer | Float bytesize) -> void
+
+      def call: (String chunk) -> String
+    end
+
+    interface _Deflater
+      def initialize: (Response body) -> void
+
+      def deflate: () -> void
+
+      def call: (StringIO | File buffer, ?chunk_size: Integer) ?{ (String chunk) -> void } -> void
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: httpx
 version: !ruby/object:Gem::Version
-  version: 0.24.6
+  version: 1.0.0
 platform: ruby
 authors:
 - Tiago Cardoso
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-28 00:00:00.000000000 Z
+date: 2023-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http-2-next
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: 1.0.0
 description: A client library for making HTTP requests from Ruby.
 email:
 - cardoso_tiago@hotmail.com
@@ -127,6 +127,7 @@ extra_rdoc_files:
 - doc/release_notes/0_8_1.md
 - doc/release_notes/0_8_2.md
 - doc/release_notes/0_9_0.md
+- doc/release_notes/1_0_0.md
 files:
 - LICENSE.txt
 - README.md
@@ -225,12 +226,14 @@ files:
 - doc/release_notes/0_8_1.md
 - doc/release_notes/0_8_2.md
 - doc/release_notes/0_9_0.md
+- doc/release_notes/1_0_0.md
 - lib/httpx.rb
 - lib/httpx/adapters/datadog.rb
 - lib/httpx/adapters/faraday.rb
 - lib/httpx/adapters/sentry.rb
 - lib/httpx/adapters/webmock.rb
 - lib/httpx/altsvc.rb
+- lib/httpx/base64.rb
 - lib/httpx/buffer.rb
 - lib/httpx/callbacks.rb
 - lib/httpx/chainable.rb
@@ -249,39 +252,32 @@ files:
 - lib/httpx/loggable.rb
 - lib/httpx/options.rb
 - lib/httpx/parser/http1.rb
-- lib/httpx/plugins/authentication.rb
-- lib/httpx/plugins/authentication/basic.rb
-- lib/httpx/plugins/authentication/digest.rb
-- lib/httpx/plugins/authentication/ntlm.rb
-- lib/httpx/plugins/authentication/socks5.rb
+- lib/httpx/plugins/auth.rb
+- lib/httpx/plugins/auth/basic.rb
+- lib/httpx/plugins/auth/digest.rb
+- lib/httpx/plugins/auth/ntlm.rb
+- lib/httpx/plugins/auth/socks5.rb
 - lib/httpx/plugins/aws_sdk_authentication.rb
 - lib/httpx/plugins/aws_sigv4.rb
-- lib/httpx/plugins/basic_authentication.rb
+- lib/httpx/plugins/basic_auth.rb
+- lib/httpx/plugins/brotli.rb
 - lib/httpx/plugins/circuit_breaker.rb
 - lib/httpx/plugins/circuit_breaker/circuit.rb
 - lib/httpx/plugins/circuit_breaker/circuit_store.rb
-- lib/httpx/plugins/compression.rb
-- lib/httpx/plugins/compression/brotli.rb
-- lib/httpx/plugins/compression/deflate.rb
-- lib/httpx/plugins/compression/gzip.rb
 - lib/httpx/plugins/cookies.rb
 - lib/httpx/plugins/cookies/cookie.rb
 - lib/httpx/plugins/cookies/jar.rb
 - lib/httpx/plugins/cookies/set_cookie_parser.rb
-- lib/httpx/plugins/digest_authentication.rb
+- lib/httpx/plugins/digest_auth.rb
 - lib/httpx/plugins/expect.rb
 - lib/httpx/plugins/follow_redirects.rb
 - lib/httpx/plugins/grpc.rb
 - lib/httpx/plugins/grpc/call.rb
+- lib/httpx/plugins/grpc/grpc_encoding.rb
 - lib/httpx/plugins/grpc/message.rb
 - lib/httpx/plugins/h2c.rb
 - lib/httpx/plugins/internal_telemetry.rb
-- lib/httpx/plugins/multipart.rb
-- lib/httpx/plugins/multipart/decoder.rb
-- 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/ntlm_auth.rb
 - lib/httpx/plugins/oauth.rb
 - lib/httpx/plugins/persistent.rb
 - lib/httpx/plugins/proxy.rb
@@ -303,6 +299,7 @@ files:
 - lib/httpx/pool.rb
 - lib/httpx/punycode.rb
 - lib/httpx/request.rb
+- lib/httpx/request/body.rb
 - lib/httpx/resolver.rb
 - lib/httpx/resolver/https.rb
 - lib/httpx/resolver/multi.rb
@@ -310,6 +307,8 @@ files:
 - lib/httpx/resolver/resolver.rb
 - lib/httpx/resolver/system.rb
 - lib/httpx/response.rb
+- lib/httpx/response/body.rb
+- lib/httpx/response/buffer.rb
 - lib/httpx/selector.rb
 - lib/httpx/session.rb
 - lib/httpx/session2.rb
@@ -318,8 +317,17 @@ files:
 - lib/httpx/transcoder.rb
 - lib/httpx/transcoder/body.rb
 - lib/httpx/transcoder/chunker.rb
+- lib/httpx/transcoder/deflate.rb
 - lib/httpx/transcoder/form.rb
+- lib/httpx/transcoder/gzip.rb
 - lib/httpx/transcoder/json.rb
+- lib/httpx/transcoder/multipart.rb
+- lib/httpx/transcoder/multipart/decoder.rb
+- lib/httpx/transcoder/multipart/encoder.rb
+- lib/httpx/transcoder/multipart/mime_type_detector.rb
+- lib/httpx/transcoder/multipart/part.rb
+- lib/httpx/transcoder/utils/body_reader.rb
+- lib/httpx/transcoder/utils/deflater.rb
 - lib/httpx/transcoder/xml.rb
 - lib/httpx/utils.rb
 - lib/httpx/version.rb
@@ -341,29 +349,29 @@ files:
 - sig/loggable.rbs
 - sig/options.rbs
 - sig/parser/http1.rbs
-- sig/plugins/authentication.rbs
-- sig/plugins/authentication/basic.rbs
-- sig/plugins/authentication/digest.rbs
-- sig/plugins/authentication/ntlm.rbs
-- sig/plugins/authentication/socks5.rbs
+- sig/plugins/auth.rbs
+- sig/plugins/auth/basic.rbs
+- sig/plugins/auth/digest.rbs
+- sig/plugins/auth/ntlm.rbs
+- sig/plugins/auth/socks5.rbs
 - sig/plugins/aws_sdk_authentication.rbs
 - sig/plugins/aws_sigv4.rbs
-- sig/plugins/basic_authentication.rbs
+- sig/plugins/basic_auth.rbs
+- sig/plugins/brotli.rbs
 - sig/plugins/circuit_breaker.rbs
 - sig/plugins/compression.rbs
-- sig/plugins/compression/brotli.rbs
-- sig/plugins/compression/deflate.rbs
-- sig/plugins/compression/gzip.rbs
 - sig/plugins/cookies.rbs
 - sig/plugins/cookies/cookie.rbs
 - sig/plugins/cookies/jar.rbs
-- sig/plugins/digest_authentication.rbs
+- sig/plugins/digest_auth.rbs
 - sig/plugins/expect.rbs
 - sig/plugins/follow_redirects.rbs
 - sig/plugins/grpc.rbs
+- sig/plugins/grpc/call.rbs
+- sig/plugins/grpc/grpc_encoding.rbs
+- sig/plugins/grpc/message.rbs
 - sig/plugins/h2c.rbs
-- sig/plugins/multipart.rbs
-- sig/plugins/ntlm_authentication.rbs
+- sig/plugins/ntlm_auth.rbs
 - sig/plugins/oauth.rbs
 - sig/plugins/persistent.rbs
 - sig/plugins/proxy.rbs
@@ -379,6 +387,7 @@ files:
 - sig/plugins/upgrade.rbs
 - sig/pool.rbs
 - sig/request.rbs
+- sig/request/body.rbs
 - sig/resolver.rbs
 - sig/resolver/https.rbs
 - sig/resolver/multi.rbs
@@ -386,14 +395,21 @@ files:
 - sig/resolver/resolver.rbs
 - sig/resolver/system.rbs
 - sig/response.rbs
+- sig/response/body.rbs
+- sig/response/buffer.rbs
 - sig/selector.rbs
 - sig/session.rbs
 - sig/timers.rbs
 - sig/transcoder.rbs
 - sig/transcoder/body.rbs
 - sig/transcoder/chunker.rbs
+- sig/transcoder/deflate.rbs
 - sig/transcoder/form.rbs
+- sig/transcoder/gzip.rbs
 - sig/transcoder/json.rbs
+- sig/transcoder/multipart.rbs
+- sig/transcoder/utils/body_reader.rbs
+- sig/transcoder/utils/deflater.rbs
 - sig/transcoder/xml.rbs
 - sig/utils.rbs
 homepage: https://gitlab.com/os85/httpx
@@ -414,7 +430,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/httpx/plugins/authentication.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module HTTPX
-  module Plugins
-    #
-    # This plugin adds a shim +authentication+ method to the session, which will fill
-    # the HTTP Authorization header.
-    #
-    # https://gitlab.com/os85/httpx/wikis/Authentication#authentication
-    #
-    module Authentication
-      module InstanceMethods
-        def authentication(token)
-          with(headers: { "authorization" => token })
-        end
-
-        def bearer_auth(token)
-          authentication("Bearer #{token}")
-        end
-      end
-    end
-    register_plugin :authentication, Authentication
-  end
-end

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

@@ -1,54 +0,0 @@
-# frozen_string_literal: true
-
-module HTTPX
-  module Plugins
-    module Compression
-      module Brotli
-        class << self
-          def load_dependencies(klass)
-            require "brotli"
-            klass.plugin(:compression)
-          end
-
-          def extra_options(options)
-            options.merge(encodings: options.encodings.merge("br" => self))
-          end
-        end
-
-        module Deflater
-          module_function
-
-          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
-
-        class Inflater
-          def initialize(bytesize)
-            @bytesize = bytesize
-          end
-
-          def inflate(chunk)
-            ::Brotli.inflate(chunk)
-          end
-        end
-
-        module_function
-
-        def deflater
-          Deflater
-        end
-
-        def inflater(bytesize)
-          Inflater.new(bytesize)
-        end
-      end
-    end
-    register_plugin :"compression/brotli", Compression::Brotli
-  end
-end

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

@@ -1,54 +0,0 @@
-# frozen_string_literal: true
-
-module HTTPX
-  module Plugins
-    module Compression
-      module Deflate
-        class << self
-          def load_dependencies(_klass)
-            require "stringio"
-            require "zlib"
-          end
-
-          def configure(klass)
-            klass.plugin(:"compression/gzip")
-          end
-
-          def extra_options(options)
-            options.merge(encodings: options.encodings.merge("deflate" => self))
-          end
-        end
-
-        module Deflater
-          module_function
-
-          def deflate(raw, buffer = "".b, chunk_size: 16_384)
-            deflater = Zlib::Deflate.new
-            while (chunk = raw.read(chunk_size))
-              compressed = deflater.deflate(chunk)
-              buffer << compressed
-              yield compressed if block_given?
-            end
-            last = deflater.finish
-            buffer << last
-            yield last if block_given?
-            buffer
-          ensure
-            deflater.close if deflater
-          end
-        end
-
-        module_function
-
-        def deflater
-          Deflater
-        end
-
-        def inflater(bytesize)
-          GZIP::Inflater.new(bytesize)
-        end
-      end
-    end
-    register_plugin :"compression/deflate", Compression::Deflate
-  end
-end

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

@@ -1,90 +0,0 @@
-# frozen_string_literal: true
-
-require "forwardable"
-
-module HTTPX
-  module Plugins
-    module Compression
-      module GZIP
-        class << self
-          def load_dependencies(*)
-            require "zlib"
-          end
-
-          def extra_options(options)
-            options.merge(encodings: options.encodings.merge("gzip" => self))
-          end
-        end
-
-        class Deflater
-          def initialize
-            @compressed_chunk = "".b
-          end
-
-          def deflate(raw, buffer = "".b, chunk_size: 16_384)
-            gzip = Zlib::GzipWriter.new(self)
-
-            begin
-              while (chunk = raw.read(chunk_size))
-                gzip.write(chunk)
-                gzip.flush
-                compressed = compressed_chunk
-                buffer << compressed
-                yield compressed if block_given?
-              end
-            ensure
-              gzip.close
-            end
-
-            return unless (compressed = compressed_chunk)
-
-            buffer << compressed
-            yield compressed if block_given?
-            buffer
-          end
-
-          private
-
-          def write(chunk)
-            @compressed_chunk << chunk
-          end
-
-          def compressed_chunk
-            @compressed_chunk.dup
-          ensure
-            @compressed_chunk.clear
-          end
-        end
-
-        class Inflater
-          def initialize(bytesize)
-            @inflater = Zlib::Inflate.new(Zlib::MAX_WBITS + 32)
-            @bytesize = bytesize
-            @buffer = nil
-          end
-
-          def inflate(chunk)
-            buffer = @inflater.inflate(chunk)
-            @bytesize -= chunk.bytesize
-            if @bytesize <= 0
-              buffer << @inflater.finish
-              @inflater.close
-            end
-            buffer
-          end
-        end
-
-        module_function
-
-        def deflater
-          Deflater.new
-        end
-
-        def inflater(bytesize)
-          Inflater.new(bytesize)
-        end
-      end
-    end
-    register_plugin :"compression/gzip", Compression::GZIP
-  end
-end

data/lib/httpx/plugins/compression.rb

@@ -1,165 +0,0 @@
-# frozen_string_literal: true
-
-module HTTPX
-  module Plugins
-    #
-    # This plugin adds compression support. Namely it:
-    #
-    # * Compresses the request body when passed a supported "Content-Encoding" mime-type;
-    # * Decompresses the response body from a supported "Content-Encoding" mime-type;
-    #
-    # It supports both *gzip* and *deflate*.
-    #
-    # https://gitlab.com/os85/httpx/wikis/Compression
-    #
-    module Compression
-      class << self
-        def configure(klass)
-          klass.plugin(:"compression/gzip")
-          klass.plugin(:"compression/deflate")
-        end
-
-        def extra_options(options)
-          options.merge(encodings: {})
-        end
-      end
-
-      module OptionsMethods
-        def option_compression_threshold_size(value)
-          bytes = Integer(value)
-          raise TypeError, ":compression_threshold_size must be positive" unless bytes.positive?
-
-          bytes
-        end
-
-        def option_encodings(value)
-          raise TypeError, ":encodings must be an Hash" unless value.is_a?(Hash)
-
-          value
-        end
-      end
-
-      module RequestMethods
-        def initialize(*)
-          super
-          # forego compression in the Range cases
-          if @headers.key?("range")
-            @headers.delete("accept-encoding")
-          else
-            @headers["accept-encoding"] ||= @options.encodings.keys
-          end
-        end
-      end
-
-      module RequestBodyMethods
-        def initialize(*, options)
-          super
-          return if @body.nil?
-
-          threshold = options.compression_threshold_size
-          return if threshold && !unbounded_body? && @body.bytesize < threshold
-
-          @headers.get("content-encoding").each do |encoding|
-            next if encoding == "identity"
-
-            next unless options.encodings.key?(encoding)
-
-            @body = Encoder.new(@body, options.encodings[encoding].deflater)
-          end
-          @headers["content-length"] = @body.bytesize unless unbounded_body?
-        end
-      end
-
-      module ResponseBodyMethods
-        using ArrayExtensions::FilterMap
-
-        attr_reader :encodings
-
-        def initialize(*)
-          @encodings = []
-
-          super
-
-          return unless @headers.key?("content-encoding")
-
-          # remove encodings that we are able to decode
-          @headers["content-encoding"] = @headers.get("content-encoding") - @encodings
-
-          compressed_length = if @headers.key?("content-length")
-            @headers["content-length"].to_i
-          else
-            Float::INFINITY
-          end
-
-          @_inflaters = @headers.get("content-encoding").filter_map do |encoding|
-            next if encoding == "identity"
-
-            next unless @options.encodings.key?(encoding)
-
-            inflater = @options.encodings[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
-
-            @encodings << encoding
-            inflater
-          end
-
-          # this can happen if the only declared encoding is "identity"
-          remove_instance_variable(:@_inflaters) if @_inflaters.empty?
-        end
-
-        def write(chunk)
-          return super unless defined?(@_inflaters) && !chunk.empty?
-
-          chunk = decompress(chunk)
-          super(chunk)
-        end
-
-        private
-
-        def decompress(buffer)
-          @_inflaters.reverse_each do |inflater|
-            buffer = inflater.inflate(buffer)
-          end
-          buffer
-        end
-      end
-
-      class Encoder
-        attr_reader :content_type
-
-        def initialize(body, deflater)
-          @content_type = body.content_type
-          @body = body.respond_to?(:read) ? body : StringIO.new(body.to_s)
-          @buffer = StringIO.new("".b, File::RDWR)
-          @deflater = deflater
-        end
-
-        def each(&blk)
-          return enum_for(__method__) unless blk
-
-          return deflate(&blk) if @buffer.size.zero? # rubocop:disable Style/ZeroLengthPredicate
-
-          @buffer.rewind
-          @buffer.each(&blk)
-        end
-
-        def bytesize
-          deflate
-          @buffer.size
-        end
-
-        private
-
-        def deflate(&blk)
-          return unless @buffer.size.zero? # rubocop:disable Style/ZeroLengthPredicate
-
-          @body.rewind
-          @deflater.deflate(@body, @buffer, chunk_size: 16_384, &blk)
-        end
-      end
-    end
-    register_plugin :compression, Compression
-  end
-end