faraday-gzip 3.0.3 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 801efea11d6b5a0e1f2d82c802cb6e0eea73bf542f7b9a793ff2288cefcc6c7f
-  data.tar.gz: d6d5f77de67e0223cdbf225cdb52e121d548a7202bd91bc4acfd50b9b0ef7e25
+  metadata.gz: 838c02901688f672d7a94781a50997dc0dd82d9ea8f00addafc7e610cbf2c230
+  data.tar.gz: 6719045f1cccd8e339e0f97aea37b221bf61152c679248d2428ae92ea96a7a7c
 SHA512:
-  metadata.gz: 715ab8b38d3050eacbbe21ac8f7444390e31d4807bd9908c6671ced6511c36b849ab11ec806140f2730d131b39dd8b90f7e08d03f69c4b2851a0df366020a78a
-  data.tar.gz: dd479efd565f0b80e371ee7f5b1883614c52f7d55a78b8e5df92a80cb5a5d940e1f8049bc0dddff5d97a56e6935b554d106fa223700f35536d3dfc3b876effa4
+  metadata.gz: d096aedb098363e777d5d818f8d050ed1c87df5edb032c26cd761976ed052baa92d01333665b2f72daffbdc0cea75606f3eeef8f0616140088cba5281a640ea1
+  data.tar.gz: 50adf03a07cc7968e26b44f276ddbdf6c087c86f33bcff589ba368b5ed557e043e9fc21500bb9f6999e5e7148e52bf4fabec42ae7b8c322807207dd7bbf45307

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 3.1.0 (05-Jan-2026)
+
+* Improve handling of edge cases and malformed `Content-Encoding` headers
+* Support multiple encodings and respect `identity` responses
+* Avoid modifying streaming and non-string response bodies
+* Normalize response headers after decompression
+* Update and expand test coverage, test with Ruby 4.0
+
+## 3.0.4 (06-Apr-2025)
+
+* Require `StringIO` that might not always be readily available
+
 ## 3.0.3 (25-Feb-2025)
 
 * Minor code fixes, make some methods more solid

data/README.md

@@ -3,12 +3,14 @@
 ![CI](https://github.com/bodrovis/faraday-gzip/actions/workflows/ci.yaml/badge.svg)
 [![Gem](https://img.shields.io/gem/v/faraday-gzip.svg?style=flat-square)](https://rubygems.org/gems/faraday-gzip)
 ![Gem Total Downloads](https://img.shields.io/gem/dt/faraday-gzip)
+[![Maintainability](https://qlty.sh/gh/bodrovis/projects/faraday-gzip/maintainability.svg)](https://qlty.sh/gh/bodrovis/projects/faraday-gzip)
+[![Code Coverage](https://qlty.sh/gh/bodrovis/projects/faraday-gzip/coverage.svg)](https://qlty.sh/gh/bodrovis/projects/faraday-gzip)
 
-The `Gzip` middleware for Faraday 1 and 2 adds the necessary `Accept-Encoding` headers and automatically decompresses the response. If the "Accept-Encoding" header isn't set in the request, it defaults to `gzip,deflate` and appropriately handles the server's compressed response. This functionality resembles what Ruby does internally in `Net::HTTP#get`. If [Brotli](https://github.com/miyucy/brotli) is included in your Gemfile, the middleware also adds `br` to the header for Brotli support.
+The `Gzip` middleware for Faraday 1 and 2 adds appropriate `Accept-Encoding` request headers and automatically decompresses supported response bodies (`gzip`, `deflate`, and optionally `br`). If the `Accept-Encoding` header is not explicitly set, it defaults to `gzip,deflate` and includes `br` when [Brotli](https://github.com/miyucy/brotli) support is available. The middleware safely handles multiple and malformed `Content-Encoding` headers, and avoids modifying unsupported or streaming response bodies. This behavior is similar in spirit to Ruby's internal handling in `Net::HTTP#get`, while remaining conservative to preserve compatibility with Faraday adapters.
 
 ## Prerequisites
 
-* faraday-gzip v3 supports only Faraday v2 and is tested with Ruby 3.0+ and JRuby 9.4
+* faraday-gzip v3 supports only Faraday v2 and is tested with Ruby 3.0+ and JRuby 9.4+
 * [faraday-gzip v2](https://github.com/bodrovis/faraday-gzip/tree/v2) supports Faraday v1 and v2 and is tested with Ruby 2.7+ and JRuby 9.4.
 
 ## Installation

data/lib/faraday/gzip/middleware.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'zlib'
+require 'stringio'
 
 # Middleware to automatically decompress response bodies. If the
 # "Accept-Encoding" header wasn't set in the request, this sets it to
@@ -12,6 +13,11 @@ module Faraday
   module Gzip
     # Faraday middleware for decompression
     class Middleware < Faraday::Middleware
+      ACCEPT_ENCODING  = 'Accept-Encoding'
+      CONTENT_ENCODING = 'Content-Encoding'
+      CONTENT_LENGTH   = 'Content-Length'
+      IDENTITY         = 'identity'
+
       # System method required by Faraday
       def self.optional_dependency(lib = nil)
         lib ? require(lib) : yield
@@ -30,9 +36,6 @@ module Faraday
         encodings
       end
 
-      ACCEPT_ENCODING = 'Accept-Encoding'
-      CONTENT_ENCODING = 'Content-Encoding'
-      CONTENT_LENGTH = 'Content-Length'
       SUPPORTED_ENCODINGS = supported_encodings.join(',').freeze
 
       # Main method to process the response
@@ -46,21 +49,40 @@ module Faraday
 
       # Finds a proper processor
       def find_processor(response_env)
-        if empty_body?(response_env)
-          ->(body) { raw_body(body) }
-        else
-          processors[response_env[:response_headers][CONTENT_ENCODING]]
-        end
+        body = response_env[:body]
+
+        encodings = parse_content_encoding(
+          response_env[:response_headers][CONTENT_ENCODING]
+        )
+        return nil if encodings.empty? || encodings.include?(IDENTITY)
+
+        # If body is nil/empty, we still want to normalize headers:
+        # Content-Encoding is meaningless without an encoded body.
+        return ->(b) { b } if body_nil_or_empty?(body)
+
+        chain = processor_chain(encodings)
+        return nil if chain.empty?
+
+        ->(b) { chain.reduce(b) { |acc, fn| fn.call(acc) } }
       end
 
       # Calls the proper processor to decompress body
       def reset_body(env, processor)
         return if processor.nil?
 
-        env[:body] = processor.call(env[:body])
-        env[:response_headers].delete(CONTENT_ENCODING)
+        body    = env[:body]
+        headers = env[:response_headers]
+
+        # Don't touch streaming / IO-like bodies.
+        return unless body.is_a?(String) || body_nil_or_empty?(body)
 
-        env[:response_headers][CONTENT_LENGTH] = env[:body].nil? ? 0 : env[:body].length
+        if body.is_a?(String)
+          env[:body] = processor.call(body)
+          headers[CONTENT_LENGTH] = env[:body].bytesize
+        end
+
+        # Normalize encoding header even for nil/empty body.
+        headers.delete(CONTENT_ENCODING)
       end
 
       # Process gzip
@@ -94,23 +116,38 @@ module Faraday
         Brotli.inflate(body)
       end
 
-      # Do not process anything, leave body as is
-      def raw_body(body)
-        body
+      private
+
+      def body_nil_or_empty?(body)
+        return true if body.nil?
+        return body.empty? if body.respond_to?(:empty?)
+        # rubocop:disable Style/ZeroLengthPredicate
+        return body.size.zero? if body.respond_to?(:size)
+        # rubocop:enable Style/ZeroLengthPredicate
+
+        false
       end
 
-      private
+      def parse_content_encoding(value)
+        return [] if value.nil?
+
+        value.to_s
+             .split(',')
+             .map { |v| v.strip.downcase }
+             .reject(&:empty?)
+      end
 
-      def empty_body?(response_env)
-        response_env[:body].nil? || response_env[:body].empty?
+      # Decode in reverse order of application:
+      # "gzip, br"  => br -> gzip
+      def processor_chain(encodings)
+        encodings.reverse.filter_map { |enc| processors[enc] }
       end
 
-      # Method providing the processors
       def processors
         @processors ||= {
           'gzip' => ->(body) { uncompress_gzip(body) },
           'deflate' => ->(body) { inflate(body) },
-          'br' => ->(body) { brotli_inflate(body) }
+          'br' => (BROTLI_SUPPORTED ? ->(body) { brotli_inflate(body) } : nil)
         }
       end
     end

data/lib/faraday/gzip/version.rb

@@ -2,6 +2,6 @@
 
 module Faraday
   module Gzip
-    VERSION = '3.0.3'
+    VERSION = '3.1.0'
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: faraday-gzip
 version: !ruby/object:Gem::Version
-  version: 3.0.3
+  version: 3.1.0
 platform: ruby
 authors:
 - Ilya Krukowski
 bindir: bin
 cert_chain: []
-date: 2025-02-25 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -43,20 +43,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -105,42 +91,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.32'
+        version: '1.82'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.32'
+        version: '1.82'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.26'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.26'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.8'
 description: 'Faraday plugin to automatically set compression headers (GZip, Deflate,
   Brotli) and decompress the response.
 
@@ -163,7 +149,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/bodrovis/faraday-gzip/issues
   changelog_uri: https://github.com/bodrovis/faraday-gzip/blob/master/CHANGELOG.md
-  documentation_uri: http://www.rubydoc.info/gems/faraday-gzip/3.0.3
+  documentation_uri: http://www.rubydoc.info/gems/faraday-gzip/3.1.0
   source_code_uri: https://github.com/bodrovis/faraday-gzip
   rubygems_mfa_required: 'true'
 rdoc_options: []
@@ -180,7 +166,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.5
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Automatically sets compression headers and decompresses the response
 test_files: []