faraday-gzip 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60cdb34cbe925160d98dd8256e447ae308a8ef6ffdd6972f4d30d4fc29fd6a56
-  data.tar.gz: ca28bce1ae001e78ab6907f97a99f7816123a6d0332afe297d0cafbcc1725079
+  metadata.gz: c547f7957c575bd7890701209c77e2cde7efb0f4375ccb5d27d279d3683d8864
+  data.tar.gz: f85480f1c243cd5f23f608b5b1086b88236d1859272f8d726f974a4aca6d4522
 SHA512:
-  metadata.gz: d65649549d5012254fe544bf230a089b474e49ba3dc3ffa2271ad78d920a2c95bf7576d5ff41c82e451a61c5a57f6d6484eca0debb3d848801090ff7046ced0c
-  data.tar.gz: 9fe5503f94111791b2c08598d400c72d402a61c13a9c612bd775ccf8a5a8b50656dd249bc3bdb20330439637b575202d7bf1c3700c7d021ee92b7b304005cae4
+  metadata.gz: 673a7119d69404b34f0f781add8234f5740eaa60fd51b50c094fbe74bff4171f5a60bd80d5c45df0190cb534fc30d223a836e7fa67f603318019d64b2bf8c7f2
+  data.tar.gz: c8fc4695719ab535d64e41e10cbea2d6a18656014ffb290959c2e8f2bd1fbe9f3040fcf8bacd68e26f260e1de029e71b997c1584372d45be8e042bd2f923c7a2

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## 3.0.0 (29-Oct-2024)
+
+* **Breaking change**: Drop support for Ruby 2, require 3.0+
+* **Breaking change**: Drop support for Faraday v1. If you need to support Faraday v1, stay on [faraday-gzip version 2](https://github.com/bodrovis/faraday-gzip/tree/v2).
+* Various code tweaks
+* Remove JRuby 9.3 from CI matrix
+
+## 2.0.1 (02-Jan-2024)
+
+* Handle cases when body is `nil` (thanks, @bendangelo)
+
 ## 2.0.0 (21-Jul-2023)
 
 * Use zlib version 3

data/README.md

@@ -2,54 +2,58 @@
 
 ![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)
 
-The `Gzip` middleware for Faraday 1 and 2 adds the necessary `Accept-Encoding` headers and automatically decompresses the response. If the "Accept-Encoding" header wasn't set in the request, this sets it to "gzip,deflate" and appropriately handles the compressed response from the server. This resembles what Ruby does internally in Net::HTTP#get. If [Brotli](https://github.com/miyucy/brotli) is added to the Gemfile, it will also add "br" to the header.
+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.
 
 ## Prerequisites
 
-This gem is tested with Ruby 2.6+ and JRuby 9.3+. Faraday 1 and 2 is supported.
+* 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
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'faraday-gzip'
+gem 'faraday-gzip', '~> 3'
 ```
 
 And then execute:
 
-```shell
+```
 bundle install
 ```
 
 Or install it yourself as:
 
-```shell
+```
 gem install faraday-gzip
 ```
 
 ## Usage
 
+To enable the middleware in your Faraday connection, add it as shown below:
+
 ```ruby
-require 'faraday/gzip' # <=== add this line
+require 'faraday/gzip' # <=== Add this line
 
 conn = Faraday.new(...) do |f|
-  f.request :gzip # <=== add this line
-  #...
+  f.request :gzip # <=== Add this line
+  # Additional configuration...
 end
 ```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies.
-
-Then, run `bin/test` to run the tests.
-
-To install this gem onto your local machine, run `rake build`.
+To contribute or make changes:
 
-To release a new version, make a commit with a message such as "Bumped to 0.0.2" and then run `rake release`.
-See how it works [here](https://bundler.io/guides/creating_gem.html#releasing-the-gem).
+* Clone the repo
+* Run `bundle` to install dependencies
+* Implement your feature
+* Write and run tests using `rspec .`
+* Use rake build to build the gem locally if needed
+* Create a new PR with your changes
 
 ## Contributing
 
@@ -57,4 +61,4 @@ Bug reports and pull requests are welcome on GitHub.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+This gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/faraday/gzip/middleware.rb

@@ -2,15 +2,17 @@
 
 require 'zlib'
 
+# Middleware to automatically decompress response bodies. If the
+# "Accept-Encoding" header wasn't set in the request, this sets it to
+# "gzip,deflate" and appropriately handles the compressed response from the
+# server. This resembles what Ruby 1.9+ does internally in Net::HTTP#get.
+# Based on https://github.com/lostisland/faraday_middleware/blob/main/lib/faraday_middleware/gzip.rb
 module Faraday
+  # Main module
   module Gzip
-    # Middleware to automatically decompress response bodies. If the
-    # "Accept-Encoding" header wasn't set in the request, this sets it to
-    # "gzip,deflate" and appropriately handles the compressed response from the
-    # server. This resembles what Ruby 1.9+ does internally in Net::HTTP#get.
-    # Based on https://github.com/lostisland/faraday_middleware/blob/main/lib/faraday_middleware/gzip.rb
-
+    # Faraday middleware for decompression
     class Middleware < Faraday::Middleware
+      # System method required by Faraday
       def self.optional_dependency(lib = nil)
         lib ? require(lib) : yield
         true
@@ -20,6 +22,8 @@ module Faraday
 
       BROTLI_SUPPORTED = optional_dependency 'brotli'
 
+      # Returns supported encodings, adds brotli if the corresponding
+      # dependency is present
       def self.supported_encodings
         encodings = %w[gzip deflate]
         encodings << 'br' if BROTLI_SUPPORTED
@@ -31,36 +35,42 @@ module Faraday
       CONTENT_LENGTH = 'Content-Length'
       SUPPORTED_ENCODINGS = supported_encodings.join(',').freeze
 
+      # Main method to process the response
       def call(env)
         env[:request_headers][ACCEPT_ENCODING] ||= SUPPORTED_ENCODINGS
+
         @app.call(env).on_complete do |response_env|
-          if response_env[:body].empty?
-            reset_body(response_env) { |body| raw_body(body) }
-          else
-            case response_env[:response_headers][CONTENT_ENCODING]
-            when 'gzip'
-              reset_body(response_env) { |body| uncompress_gzip(body) }
-            when 'deflate'
-              reset_body(response_env) { |body| inflate(body) }
-            when 'br'
-              reset_body(response_env) { |body| brotli_inflate(body) }
-            end
-          end
+          reset_body(response_env, find_processor(response_env))
+        end
+      end
+
+      # 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
       end
 
-      def reset_body(env)
-        env[:body] = yield(env[:body])
+      # 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)
-        env[:response_headers][CONTENT_LENGTH] = env[:body].length
+
+        env[:response_headers][CONTENT_LENGTH] = env[:body].nil? ? 0 : env[:body].length
       end
 
+      # Process gzip
       def uncompress_gzip(body)
         io = StringIO.new(body)
         gzip_reader = Zlib::GzipReader.new(io, encoding: 'ASCII-8BIT')
         gzip_reader.read
       end
 
+      # Process deflate
       def inflate(body)
         # Inflate as a DEFLATE (RFC 1950+RFC 1951) stream
         Zlib::Inflate.inflate(body)
@@ -75,13 +85,30 @@ module Faraday
         end
       end
 
+      # Process brotli
       def brotli_inflate(body)
         Brotli.inflate(body)
       end
 
+      # Do not process anything, leave body as is
       def raw_body(body)
         body
       end
+
+      private
+
+      def empty_body?(response_env)
+        response_env[:body].nil? || response_env[:body].empty?
+      end
+
+      # Method providing the processors
+      def processors
+        {
+          'gzip' => ->(body) { uncompress_gzip(body) },
+          'deflate' => ->(body) { inflate(body) },
+          'br' => ->(body) { brotli_inflate(body) }
+        }
+      end
     end
   end
 end

data/lib/faraday/gzip/version.rb

@@ -2,6 +2,6 @@
 
 module Faraday
   module Gzip
-    VERSION = '2.0.0'
+    VERSION = '3.0.0'
   end
 end

data/spec/faraday/gzip/middleware_spec.rb

@@ -0,0 +1,179 @@
+# frozen_string_literal: true
+
+RSpec.describe Faraday::Gzip::Middleware do
+  require 'brotli' if Faraday::Gzip::Middleware::BROTLI_SUPPORTED
+
+  subject(:middleware) do
+    described_class.new(->(env) { Faraday::Response.new(env) })
+  end
+
+  let(:headers) { {} }
+
+  def process(body, content_type = nil, options = {})
+    env = {
+      body: body, request: options,
+      request_headers: Faraday::Utils::Headers.new,
+      response_headers: Faraday::Utils::Headers.new(headers)
+    }
+    env[:response_headers]['content-type'] = content_type if content_type
+    yield(env) if block_given?
+    middleware.call(env)
+  end
+
+  context 'when request' do
+    it 'sets the Accept-Encoding request header' do
+      env = process('').env
+      encodings = Faraday::Gzip::Middleware::BROTLI_SUPPORTED ? 'gzip,deflate,br' : 'gzip,deflate'
+      expect(env[:request_headers][:accept_encoding]).to eq(encodings)
+    end
+
+    it 'doesnt overwrite existing Accept-Encoding request header' do
+      env = process('') do |e|
+        e[:request_headers][:accept_encoding] = 'zopfli'
+      end.env
+      expect(env[:request_headers][:accept_encoding]).to eq('zopfli')
+    end
+  end
+
+  context 'when response' do
+    let(:uncompressed_body) do
+      '<html><head><title>Rspec</title></head><body>Hello, spec!</body></html>'
+    end
+    let(:empty_body) { '' }
+    let(:gzipped_body) do
+      io = StringIO.new
+      gz = Zlib::GzipWriter.new(io)
+      gz.write(uncompressed_body)
+      gz.close
+      res = io.string
+      res.force_encoding('BINARY')
+      res
+    end
+    let(:deflated_body) do
+      Zlib::Deflate.deflate(uncompressed_body)
+    end
+    let(:raw_deflated_body) do
+      z = Zlib::Deflate.new(Zlib::DEFAULT_COMPRESSION, -Zlib::MAX_WBITS)
+      compressed_body = z.deflate(uncompressed_body, Zlib::FINISH)
+      z.close
+      compressed_body
+    end
+
+    if Faraday::Gzip::Middleware::BROTLI_SUPPORTED
+      let(:brotlied_body) do
+        Brotli.deflate(uncompressed_body)
+      end
+    end
+
+    shared_examples 'compressed response' do
+      it 'uncompresses the body' do
+        expect(process(body).body).to eq(uncompressed_body)
+      end
+
+      it 'sets the Content-Length' do
+        expect(process(body).headers['Content-Length']).to eq(uncompressed_body.length)
+      end
+
+      it 'removes the Content-Encoding' do
+        expect(process(body).headers['Content-Encoding']).to be_nil
+      end
+    end
+
+    context 'when gzipped response' do
+      let(:body) { gzipped_body }
+      let(:headers) { { 'Content-Encoding' => 'gzip', 'Content-Length' => body.length } }
+
+      it_behaves_like 'compressed response'
+    end
+
+    context 'when deflated response' do
+      let(:body) { deflated_body }
+      let(:headers) { { 'Content-Encoding' => 'deflate', 'Content-Length' => body.length } }
+
+      it_behaves_like 'compressed response'
+    end
+
+    context 'when raw deflated response' do
+      let(:body) { raw_deflated_body }
+      let(:headers) { { 'Content-Encoding' => 'deflate', 'Content-Length' => body.length } }
+
+      it_behaves_like 'compressed response'
+    end
+
+    if Faraday::Gzip::Middleware::BROTLI_SUPPORTED
+      context 'when brotlied response' do
+        let(:body) { brotlied_body }
+        let(:headers) { { 'Content-Encoding' => 'br', 'Content-Length' => body.length } }
+
+        it_behaves_like 'compressed response'
+      end
+    end
+
+    context 'when empty response' do
+      let(:body) { empty_body }
+      let(:headers) { { 'Content-Encoding' => 'gzip', 'Content-Length' => body.length } }
+
+      it 'sets the Content-Length' do
+        expect(process(body).headers['Content-Length']).to eq(empty_body.length)
+      end
+
+      it 'removes the Content-Encoding' do
+        expect(process(body).headers['Content-Encoding']).to be_nil
+      end
+    end
+
+    context 'when nil response' do
+      let(:body) { nil }
+      let(:headers) { { 'Content-Encoding' => 'gzip', 'Content-Length' => 0 } }
+
+      it 'sets the Content-Length' do
+        expect(process(body).headers['Content-Length']).to eq(0)
+      end
+
+      it 'removes the Content-Encoding' do
+        expect(process(body).headers['Content-Encoding']).to be_nil
+      end
+    end
+
+    context 'when identity response' do
+      let(:body) { uncompressed_body }
+
+      it 'does not modify the body' do
+        expect(process(body).body).to eq(uncompressed_body)
+      end
+    end
+
+    context 'when unsupported encoding response' do
+      let(:body) { 'unsupported' }
+      let(:headers) { { 'Content-Encoding' => 'unsupported' } }
+
+      it 'does not modify the body' do
+        expect(process(body).body).to eq(body)
+      end
+
+      it 'preserves the Content-Encoding header' do
+        expect(process(body).headers['Content-Encoding']).to eq('unsupported')
+      end
+    end
+
+    context 'when no Content-Encoding header' do
+      let(:body) { uncompressed_body }
+      let(:headers) { {} }
+
+      it 'does not modify the body' do
+        expect(process(body).body).to eq(uncompressed_body)
+      end
+
+      it 'does not add a Content-Encoding header' do
+        expect(process(body).headers['Content-Encoding']).to be_nil
+      end
+    end
+
+    context 'when Content-Length is a string' do
+      let(:body) { gzipped_body }
+      let(:headers) { { 'Content-Encoding' => 'gzip', 'Content-Length' => body.length.to_s } }
+
+      it_behaves_like 'compressed response'
+    end
+  end
+end

data/spec/faraday/gzip/version_spec.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+RSpec.describe 'Faraday::Gzip::VERSION' do
+  subject { Object.const_get(self.class.description) }
+
+  it { is_expected.to match(/^\d+\.\d+\.\d+(\.\w+(\.\d+)?)?$/) }
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'simplecov'
+
+SimpleCov.start do
+  add_filter 'spec/'
+  add_filter '.github/'
+end
+
+require_relative '../lib/faraday/gzip'
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = '.rspec_status'
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  config.order = :random
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faraday-gzip
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Ilya Krukowski
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-21 00:00:00.000000000 Z
+date: 2024-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,14 +16,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: zlib
   requirement: !ruby/object:Gem::Requirement
@@ -142,14 +148,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.11'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.11'
+        version: '3.0'
 description: 'Faraday plugin to automatically set compression headers (GZip, Deflate,
   Brotli) and decompress the response.
 
@@ -166,13 +172,16 @@ files:
 - lib/faraday/gzip.rb
 - lib/faraday/gzip/middleware.rb
 - lib/faraday/gzip/version.rb
+- spec/faraday/gzip/middleware_spec.rb
+- spec/faraday/gzip/version_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/bodrovis/faraday-gzip
 licenses:
 - MIT
 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/2.0.0
+  documentation_uri: http://www.rubydoc.info/gems/faraday-gzip/3.0.0
   homepage_uri: https://github.com/bodrovis/faraday-gzip
   source_code_uri: https://github.com/bodrovis/faraday-gzip
   rubygems_mfa_required: 'true'
@@ -184,7 +193,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '3.0'
   - - "<"
     - !ruby/object:Gem::Version
       version: '4'
@@ -194,7 +203,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.17
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Automatically sets compression headers and decompresses the response