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 is added to the Gemfile, it will also add "br" to the header.

This gem is tested with Ruby 2.6+ and JRuby 9.3+. Faraday 1 and 2 is supported.

Add this line to your application's Gemfile:

gem 'faraday-gzip'

And then execute:

bundle install

Or install it yourself as:

gem install faraday-gzip

require 'faraday/gzip' # <=== add this line

conn = Faraday.new(...) do |f|
  f.request :gzip # <=== add this line
  #...
end

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 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.

Bug reports and pull requests are welcome on GitHub.

The gem is available as open source under the terms of the MIT License.