faraday-gzip 3.0.4 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5183c6f188272ea7e213adf03bb2d637c348e9f273b1b8829255f135a95b8c92
-  data.tar.gz: ce73797d7aa191ef07c376af0193ea704a653237146affec2806031194d064c7
+  metadata.gz: aca2ddf08f8675bc1c6c9e466a6d593a34c52f02a3a32f4068427ca39aad7263
+  data.tar.gz: 96a6b9a912363c4849287acae53f8b3394ada2b943a677958f09c36fccbdd30e
 SHA512:
-  metadata.gz: 8f9add78a8ff2c274ef021ae4e8ebfc1f525847ba4d05ca6ccf52cba1bc9f9d891e4627a354fdbf724393cb420e1225c33521d55f15f0c292490c8466e6ba202
-  data.tar.gz: 2edf0cd82a52d2bf33d9024ed3363b4735dc7a7645f847bf1aca250947d14663d696d2bc64bb10fc83019a677a2b701d933766ed1afcc7f76d554a30b4e6c5f9
+  metadata.gz: 6c37c4a0ece9fb5eb4c23856c62dd2d1a0ac640e7f7401b621de518188e9f6cc822abba179ad99d7566e107c4267c2177977fef2c47b507c541a6fc60afab643
+  data.tar.gz: 9bb4a964ea2a41d2760847873551474d2bd91b4598ff0ce9700e096e423ff489f59fc4eca73d00f726a8ec7694642b3cc7d4f654c3bf1cd555c0693e0d2d0fd5

data/CHANGELOG.md

@@ -1,8 +1,26 @@
 # Changelog
 
+## 3.2.0 (12-Oct-2026)
+
+- Moved development dependencies to `Gemfile` and improved SimpleCov compatibility across Ruby versions.
+- Simplified response decompression logic.
+- Prevented partial decompression when unsupported content encodings are present.
+- Preserved response headers for empty, non-string, and partial (`206`) responses.
+- Added support for concatenated gzip streams.
+- Added regression tests for encoding chains, partial responses, and concatenated gzip streams.
+- Fixed test helpers to properly initialize HTTP response environments.
+
+## 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
+* Require `StringIO` that might not always be readily available
 
 ## 3.0.3 (25-Feb-2025)
 

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

@@ -13,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
@@ -31,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
@@ -47,32 +49,31 @@ 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
+        encodings = parse_content_encoding(
+          response_env[:response_headers][CONTENT_ENCODING]
+        )
+        return nil if skip_decompression?(response_env, encodings)
+
+        chain = processor_chain(encodings)
+        return nil if chain.empty?
+
+        ->(body) { chain.reduce(body) { |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 = processor.call(env[:body])
 
-        env[:response_headers][CONTENT_LENGTH] = env[:body].nil? ? 0 : env[:body].length
+        env[:body] = body
+        env[:response_headers][CONTENT_LENGTH] = body.bytesize
+        env[:response_headers].delete(CONTENT_ENCODING)
       end
 
       # Process gzip
       def uncompress_gzip(body)
-        io = StringIO.new(body)
-        gzip_reader = Zlib::GzipReader.new(io, encoding: 'ASCII-8BIT')
-        begin
-          gzip_reader.read
-        ensure
-          gzip_reader.close
-        end
+        Zlib::GzipReader.zcat(StringIO.new(body))
       end
 
       # Process deflate
@@ -95,23 +96,40 @@ module Faraday
         Brotli.inflate(body)
       end
 
-      # Do not process anything, leave body as is
-      def raw_body(body)
-        body
+      private
+
+      def skip_decompression?(env, encodings)
+        body = env[:body]
+
+        return true unless body.is_a?(String) && !body.empty?
+        return true if env[:status] == 206
+
+        encodings.empty? || encodings.include?(IDENTITY)
       end
 
-      private
+      def parse_content_encoding(value)
+        return [] if value.nil?
+
+        value.to_s
+             .split(',')
+             .map { |v| v.strip.downcase }
+             .reject(&:empty?)
+      end
+
+      # Decode in reverse order of application:
+      # "gzip, br"  => br -> gzip
+      # If the encoding is unknown, do not touch the content
+      def processor_chain(encodings)
+        return [] unless encodings.all? { |enc| processors[enc] }
 
-      def empty_body?(response_env)
-        response_env[:body].nil? || response_env[:body].empty?
+        encodings.reverse.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.4'
+    VERSION = '3.2.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: faraday-gzip
 version: !ruby/object:Gem::Version
-  version: 3.0.4
+  version: 3.2.0
 platform: ruby
 authors:
 - Ilya Krukowski
@@ -43,104 +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
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.22'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.22'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.32'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.32'
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
 description: 'Faraday plugin to automatically set compression headers (GZip, Deflate,
   Brotli) and decompress the response.
 
@@ -163,7 +65,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.4
+  documentation_uri: https://www.rubydoc.info/gems/faraday-gzip/3.2.0
   source_code_uri: https://github.com/bodrovis/faraday-gzip
   rubygems_mfa_required: 'true'
 rdoc_options: []
@@ -180,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 4.0.22
 specification_version: 4
 summary: Automatically sets compression headers and decompresses the response
 test_files: []