RubyGems - mechanize - Versions diffs - 2.12.0 → 2.12.1 - Mend

mechanize 2.12.0 → 2.12.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (8) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +5 -0
data/Gemfile +4 -1
data/lib/mechanize/http/agent.rb +31 -0
data/lib/mechanize/test_case.rb +0 -5
data/lib/mechanize/version.rb +1 -1
data/test/test_mechanize_http_agent.rb +44 -1
metadata +2 -2

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 991701dfb3f8c11d731e22733ddb6bd158303ff68b3701d8fdcd780228cbc4be
-  data.tar.gz: 53d0f50ac55ec64c3accc35f69c828477ba2c5efe36921711e8adea1c459da05
+  metadata.gz: 7183879e98b1195380219464368f7761a6ee2b9adb3eb18f47b216e740d840d5
+  data.tar.gz: 9eaf999bb67a5f7f7625b1a77a4466b88a005d947003b67e155398f3af2b0bf5
 SHA512:
-  metadata.gz: edde84f61a68ae2461b621b02e20dc479cab2258f8d005a3a6304f0c18d8829ae9e40c01c4d3f2eef0f24d08cc046035c1432a8b16202095a46f55ed67788fc5
-  data.tar.gz: 2bdbed0e937a610002095df60ad1bb476f5ddfe521b97044a4dd4102558ddf5a890a5a335fd3f6cb89be1403e91461f7db97ec0f924b3d6c21c95bf837834fd6
+  metadata.gz: 3ba304c3a37d0eb98ccbbba83f425a68cb6ad2fb0da5d768a93cc8fd802f691da8fb86d7b6670888a597ca5f3f96ff755d6155197cbd1eef7c8db2442177bd72
+  data.tar.gz: db944be6db0079e9740c8e3aaade533baf990efbd87b6ebdbca034eb81a0adef82838fa50fd301f72d23c463109660a3256d0fae7f0154c8393a97b24ab214a1

data/CHANGELOG.md CHANGED Viewed

@@ -1,5 +1,10 @@
 # Mechanize CHANGELOG
+## 2.12.1 / 2024-08-21
+* Introduce experimental support for handling Zstd-compressed responses (CRuby only). (#652) @adrianodennanni
 ## 2.12.0 / 2024-07-29
 * Introduce experimental support for handling Brotli-compressed responses (CRuby only). (#650) @weshatheleopard

data/Gemfile CHANGED Viewed

@@ -6,4 +6,7 @@ gem "minitest", "~> 5.14"
 gem "rake", "~> 13.0"
 gem "rdoc", "~> 6.3"
 gem "rubocop", "~> 1.12"
-gem "brotli", ">= 0.5" unless RUBY_PLATFORM == "java"
+unless RUBY_PLATFORM == 'java'
+  gem 'brotli', '>= 0.5'
+  gem 'zstd-ruby', '~> 1.5'
+end

data/lib/mechanize/http/agent.rb CHANGED Viewed

@@ -523,6 +523,35 @@ class Mechanize::HTTP::Agent
     body_io.close
   end
+  ##
+  # Decodes a Zstd-encoded +body_io+
+  #
+  # (Experimental, CRuby only) Although Mechanize will never request a zstd-encoded response via
+  # `accept-encoding`, buggy servers may return zstd-encoded responses, or you might need to
+  # inform the zstd keyword on your Accept-Encoding headers. Let's try to handle those cases if
+  # the Zstd gem is loaded.
+  #
+  # If you need to handle Zstd-encoded responses, install the 'zstd-ruby' gem and require it in your
+  # application. If the `Zstd` constant is defined, Mechanize will attempt to use it to inflate
+  # the response.
+  #
+  def content_encoding_zstd(body_io)
+    log.debug('deflate zstd body') if log
+    unless defined?(::Zstd)
+      raise Mechanize::Error, "cannot deflate zstd-encoded response. Please install and require the 'zstd-ruby' gem."
+    end
+    begin
+      return StringIO.new(Zstd.decompress(body_io.read))
+    rescue StandardError
+      log.error("unable to zstd#decompress response") if log
+      raise Mechanize::Error, "error decompressing zstd-encoded response."
+    end
+  ensure
+    body_io.close
+  end
   def disable_keep_alive request
     request['connection'] = 'close' unless @keep_alive
   end
@@ -861,6 +890,8 @@ class Mechanize::HTTP::Agent
                content_encoding_gunzip body_io
              when 'br' then
                content_encoding_brotli body_io
+             when 'zstd' then
+               content_encoding_zstd body_io
              else
                raise Mechanize::Error,
                  "unsupported content-encoding: #{response['Content-Encoding']}"

data/lib/mechanize/test_case.rb CHANGED Viewed

@@ -15,11 +15,6 @@ end
 require 'minitest/autorun'
-begin
-  require 'minitest/pride'
-rescue LoadError
-end
 ##
 # A generic test case for testing mechanize.  Using a subclass of
 # Mechanize::TestCase for your tests will create an isolated mechanize

data/lib/mechanize/version.rb CHANGED Viewed

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 class Mechanize
-  VERSION = "2.12.0"
+  VERSION = "2.12.1"
 end

data/test/test_mechanize_http_agent.rb CHANGED Viewed

@@ -2,7 +2,10 @@
 # frozen_string_literal: true
 require 'mechanize/test_case'
-require "brotli" unless RUBY_PLATFORM == "java"
+unless RUBY_PLATFORM == 'java'
+  require 'brotli'
+  require 'zstd-ruby'
+end
 class TestMechanizeHttpAgent < Mechanize::TestCase
@@ -965,6 +968,46 @@ class TestMechanizeHttpAgent < Mechanize::TestCase
     assert(body_io.closed?)
   end
+  def test_response_content_encoding_zstd_when_zstd_not_loaded
+    skip("only test this on jruby which doesn't have zstd support") unless RUBY_ENGINE == 'jruby'
+    @res.instance_variable_set :@header, 'content-encoding' => %w[zstd]
+    body_io = StringIO.new("content doesn't matter for this test")
+    e = assert_raises(Mechanize::Error) do
+      @agent.response_content_encoding(@res, body_io)
+    end
+    assert_includes(e.message, 'cannot deflate zstd-encoded response')
+    assert(body_io.closed?)
+  end
+  def test_response_content_encoding_zstd
+    skip('jruby does not have zstd support') if RUBY_ENGINE == 'jruby'
+    @res.instance_variable_set :@header, 'content-encoding' => %w[zstd]
+    body_io = StringIO.new(Zstd.compress('this is compressed by zstd'))
+    body = @agent.response_content_encoding(@res, body_io)
+    assert_equal('this is compressed by zstd', body.read)
+    assert(body_io.closed?)
+  end
+  def test_response_content_encoding_zstd_corrupt
+    skip('jruby does not have zstd support') if RUBY_ENGINE == 'jruby'
+    @res.instance_variable_set :@header, 'content-encoding' => %w[zstd]
+    body_io = StringIO.new('not a zstd payload')
+    e = assert_raises(Mechanize::Error) do
+      @agent.response_content_encoding(@res, body_io)
+    end
+    assert_includes(e.message, 'error decompressing zstd-encoded response')
+    assert_kind_of(RuntimeError, e.cause)
+    assert(body_io.closed?)
+  end
   def test_response_content_encoding_gzip_corrupt
     log = StringIO.new
     logger = Logger.new log

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mechanize
 version: !ruby/object:Gem::Version
-  version: 2.12.0
+  version: 2.12.1
 platform: ruby
 authors:
 - Eric Hodel
@@ -12,7 +12,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-29 00:00:00.000000000 Z
+date: 2024-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable