Support for Brotli encoding

This commit adds encoding to the code written by trizen with #164, which
added decoding. It also adds tests.

Also makes sure recommended modules are installed during the Linux
github action build, which we were already doing on Mac.

Closes #163.

Author: simbabque

.github/workflows/build-and-test.yml

@@ -69,6 +69,7 @@ jobs:
           cpm install -g
           --cpanfile cpanfile
           --with-develop
+          --with-recommends
           --with-suggests
           --show-build-log-on-failure
       - name: Run Tests

Changes

@@ -1,6 +1,7 @@
 Revision history for HTTP-Message
 
 {{$NEXT}}
+    - Support for Brotli "br" encoding (GH#163) (trizen and Julien Fiegehenn)
     - Don't test Perl > 5.32 on Windows in GH Actions (GH#174) (Olaf Alders)
 
 6.36      2022-01-05 14:39:42Z

dist.ini

@@ -15,7 +15,9 @@ Encode = 3.01
 Encode::Locale = 1
 Exporter = 5.57
 HTTP::Date = 6
+IO::Compress::Brotli = 0.004001
 IO::Compress::Bzip2 = 2.021
+IO::Uncompress::Brotli = 0.004001
 IO::Uncompress::Bunzip2 = 2.021
 LWP::MediaTypes = 6
 MIME::Base64 = 2.1
@@ -39,6 +41,12 @@ to_relationship = suggests
 copy_to = develop.requires
 module = Clone
 
+[Prereqs::Soften / Brotli]
+to_relationship = recommends
+copy_to = test.recommends
+module = IO::Compress::Brotli
+module = IO::Uncompress::Brotli
+
 [Test::Compile]
 bail_out_on_fail = 1
 xt_mode = 1

lib/HTTP/Message.pm

@@ -503,6 +503,13 @@ sub encode
 		or die "Can't bzip2 content: $IO::Compress::Bzip2::Bzip2Error";
 	    $content = $output;
 	}
+	elsif ($encoding eq "br") {
+		require IO::Compress::Brotli;
+		my $output;
+		eval { $output = IO::Compress::Brotli::bro($content) }
+		or die "Can't brotli content: $@";
+		$content = $output;
+	}
 	elsif ($encoding eq "rot13") {  # for the fun of it
 	    $content =~ tr/A-Za-z/N-ZA-Mn-za-m/;
 	}
@@ -991,7 +998,7 @@ want to process its content as a string.
 Apply the given encodings to the content of the message.  Returns TRUE
 if successful. The "identity" (non-)encoding is always supported; other
 currently supported encodings, subject to availability of required
-additional modules, are "gzip", "deflate", "x-bzip2" and "base64".
+additional modules, are "gzip", "deflate", "x-bzip2", "base64" and "br".
 
 A successful call to this function will set the C<Content-Encoding>
 header.

t/message-brotli.t

@@ -0,0 +1,41 @@
+#! perl -w
+
+use strict;
+use warnings;
+
+use Test::More;
+use Test::Needs 'IO::Compress::Brotli', 'IO::Uncompress::Brotli';
+
+require HTTP::Message;
+
+subtest "decoding" => sub {
+
+    my $m = HTTP::Message->new(
+        [
+            "Content-Type"     => "text/plain",
+            "Content-Encoding" => "br, base64",
+        ],
+        "CwaASGVsbG8gd29ybGQhCgM=\n"
+    );
+    is( $m->decoded_content, "Hello world!\n", "decoded_content() works" );
+    ok( $m->decode, "decode() works" );
+    is( $m->content, "Hello world!\n", "... and content() is correct" );
+};
+
+subtest "encoding" => sub {
+    my $m = HTTP::Message->new(
+        [
+            "Content-Type" => "text/plain",
+        ],
+        "Hello world!"
+    );
+    ok( $m->encode("br"), "set encoding to 'br" );
+    is( $m->header("Content-Encoding"),
+        "br", "... and Content-Encoding is set" );
+    isnt( $m->content, "Hello world!", "... and the content has changed" );
+    is( $m->decoded_content, "Hello world!", "decoded_content() works" );
+    ok( $m->decode, "decode() works" );
+    is( $m->content, "Hello world!", "... and content() is correct" );
+};
+
+done_testing;