mechanize 2.11.0 → 2.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4c0419c6395467b67e04d02f6fad693555635888226463874b23836dd481f74
-  data.tar.gz: e9787a25ee371a1f9c5918c49cab30c89d6fb375ca1e6fffc7b444bc5dc5f7e1
+  metadata.gz: 7183879e98b1195380219464368f7761a6ee2b9adb3eb18f47b216e740d840d5
+  data.tar.gz: 9eaf999bb67a5f7f7625b1a77a4466b88a005d947003b67e155398f3af2b0bf5
 SHA512:
-  metadata.gz: 23436f8664e13b44f71d5abb2b7b29a0a309e76880503c6ac68c19e1258d3e0dd73919f4b407f0dcfb3fe04dfeea0a350c0fcc967c2fee13085a69aa71992084
-  data.tar.gz: 9869c25e459212cbff34f11e0cadcc985fff6e97bfad5012c091a9c594dd9a58ba2bc4afb7fed50c089cbe943a3adb9528968e80df01803869709508aaf9d218
+  metadata.gz: 3ba304c3a37d0eb98ccbbba83f425a68cb6ad2fb0da5d768a93cc8fd802f691da8fb86d7b6670888a597ca5f3f96ff755d6155197cbd1eef7c8db2442177bd72
+  data.tar.gz: db944be6db0079e9740c8e3aaade533baf990efbd87b6ebdbca034eb81a0adef82838fa50fd301f72d23c463109660a3256d0fae7f0154c8393a97b24ab214a1

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # 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
+
+
 ## 2.11.0 / 2024-07-18
 
 * The `accept-charset` header is no longer sent. In early versions of Mechanize, circa 2007, this was a common header but now no modern browser sends it, and servers are instructed to ignore it. See #646 for an example of a server that is confused by its presence. (#647) @flavorjones

data/Gemfile

@@ -1,3 +1,12 @@
 source "https://rubygems.org"
 
 gemspec
+
+gem "minitest", "~> 5.14"
+gem "rake", "~> 13.0"
+gem "rdoc", "~> 6.3"
+gem "rubocop", "~> 1.12"
+unless RUBY_PLATFORM == 'java'
+  gem 'brotli', '>= 0.5'
+  gem 'zstd-ruby', '~> 1.5'
+end

data/lib/mechanize/http/agent.rb

@@ -495,6 +495,63 @@ class Mechanize::HTTP::Agent
     body_io.close
   end
 
+  ##
+  # Decodes a Brotli-encoded +body_io+
+  #
+  # (Experimental, CRuby only) Although Mechanize will never request a Brotli-encoded response via
+  # `accept-encoding`, buggy servers may return brotli-encoded responses anyway. Let's try to handle
+  # that case if the Brotli gem is loaded.
+  #
+  # If you need to handle Brotli-encoded responses, install the 'brotli' gem and require it in your
+  # application. If the `Brotli` constant is defined, Mechanize will attempt to use it to inflate
+  # the response.
+  #
+  def content_encoding_brotli(body_io)
+    log.debug('deflate brotli body') if log
+
+    unless defined?(::Brotli)
+      raise Mechanize::Error, "cannot deflate brotli-encoded response. Please install and require the 'brotli' gem."
+    end
+
+    begin
+      return StringIO.new(Brotli.inflate(body_io.read))
+    rescue Brotli::Error
+      log.error("unable to brotli-inflate response") if log
+      raise Mechanize::Error, "error inflating brotli-encoded response."
+    end
+  ensure
+    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
@@ -831,6 +888,10 @@ class Mechanize::HTTP::Agent
                content_encoding_inflate body_io
              when 'gzip', 'x-gzip' then
                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

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

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

data/mechanize.gemspec

@@ -71,9 +71,4 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency("rubyntlm", ">= 0.6.3", "~> 0.6")
   spec.add_runtime_dependency("base64") # removed from bundled gems in 3.4, and needed by rubyntlm (which doesn't declare this dependency)
   spec.add_runtime_dependency("nkf") # removed from bundled gems in 3.4
-
-  spec.add_development_dependency("minitest", "~> 5.14")
-  spec.add_development_dependency("rake", "~> 13.0")
-  spec.add_development_dependency("rdoc", "~> 6.3")
-  spec.add_development_dependency("rubocop", "~> 1.12")
 end

data/test/test_mechanize_http_agent.rb

@@ -2,6 +2,10 @@
 # frozen_string_literal: true
 
 require 'mechanize/test_case'
+unless RUBY_PLATFORM == 'java'
+  require 'brotli'
+  require 'zstd-ruby'
+end
 
 class TestMechanizeHttpAgent < Mechanize::TestCase
 
@@ -924,6 +928,86 @@ class TestMechanizeHttpAgent < Mechanize::TestCase
     assert_equal 'part', body.read
   end
 
+  def test_response_content_encoding_brotli_when_brotli_not_loaded
+    skip("only test this on jruby which doesn't have brotli support") unless RUBY_ENGINE == 'jruby'
+
+    @res.instance_variable_set :@header, 'content-encoding' => %w[br]
+    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 brotli-encoded response")
+
+    assert(body_io.closed?)
+  end
+
+  def test_response_content_encoding_brotli
+    skip("jruby does not have brotli support") if RUBY_ENGINE == 'jruby'
+
+    @res.instance_variable_set :@header, 'content-encoding' => %w[br]
+    body_io = StringIO.new(Brotli.deflate("this is compressed by brotli"))
+
+    body = @agent.response_content_encoding(@res, body_io)
+
+    assert_equal("this is compressed by brotli", body.read)
+    assert(body_io.closed?)
+  end
+
+  def test_response_content_encoding_brotli_corrupt
+    skip("jruby does not have brotli support") if RUBY_ENGINE == 'jruby'
+
+    @res.instance_variable_set :@header, 'content-encoding' => %w[br]
+    body_io = StringIO.new("not a brotli payload")
+
+    e = assert_raises(Mechanize::Error) do
+      @agent.response_content_encoding(@res, body_io)
+    end
+    assert_includes(e.message, "error inflating brotli-encoded response")
+    assert_kind_of(Brotli::Error, e.cause)
+    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

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mechanize
 version: !ruby/object:Gem::Version
-  version: 2.11.0
+  version: 2.12.1
 platform: ruby
 authors:
 - Eric Hodel
@@ -12,7 +12,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-18 00:00:00.000000000 Z
+date: 2024-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -218,62 +218,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.14'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.14'
-- !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: rdoc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.3'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.12'
 description: |-
   The Mechanize library is used for automating interaction with websites.
   Mechanize automatically stores and sends cookies, follows redirects,