Support brotli compressed payloads (Content-Encoding: br)

CHANGELOG.rst

@@ -10,6 +10,14 @@ This project adheres to `Semantic Versioning <http://semver.org/>`_
 Unreleased
 ~~~~~~~~~~
 
+Added
+-----
+- Decompression of `brotli`_ compressed payloads (``Content-Encoding: br``).
+
+.. _brotli: https://tools.ietf.org/html/rfc7932
+
+Removed
+-------
 - The deprecated constants
   ``httpolice.ERROR``, ``httpolice.COMMENT``, ``httpolice.DEBUG``
   have been removed. Use ``httpolice.Severity`` instead.

doc/install.rst

@@ -12,11 +12,10 @@ __ https://pypi.python.org/pypi/HTTPolice
 
 If you’re not familiar with pip,
 you may need to install it `manually`__ or `from your OS distribution`__.
-You may also need development files and tools for `lxml`__ dependencies.
+You may also need development files and tools to compile dependencies.
 
 __ https://pip.pypa.io/en/stable/installing/
 __ https://packaging.python.org/en/latest/install_requirements_linux/
-__ http://lxml.de/installation.html
 
 `PyPy`__ (the 2.7 variant) is also supported,
 but you may experience problems with older PyPy versions (5.3.1 should be OK).
@@ -29,8 +28,7 @@ On Debian/Ubuntu
 
 ::
 
-  $ sudo apt-get install python-dev libxml2-dev libxslt1-dev zlib1g-dev
-  $ sudo apt-get install python-pip
+  $ sudo apt-get install python-pip python-dev libxml2-dev libxslt1-dev zlib1g-dev libffi-dev
 
 Then, to install the HTTPolice command-line tool into ``~/.local/bin``::
 
@@ -62,6 +60,10 @@ __ https://pypi.python.org/pypi/lxml/3.6.0
 __ https://pypi.python.org/pypi/lxml/3.6.1
 __ https://www.python.org/downloads/windows/
 
+The same applies to `brotlipy`__.
+
+__ https://pypi.python.org/pypi/brotlipy
+
 Then you can install HTTPolice itself::
 
   C:\>Python27\Scripts\pip install HTTPolice

httpolice/codings.py

@@ -6,10 +6,16 @@
 import io
 import zlib
 
+import brotli
+
 
 def decode_gzip(data):
     return gzip.GzipFile(fileobj=io.BytesIO(data)).read()
 
 
 def decode_deflate(data):
     return zlib.decompress(data)
+
+
+def decode_brotli(data):
+    return brotli.decompress(data)

httpolice/message.py

@@ -14,7 +14,7 @@
 import six
 
 from httpolice.blackboard import Blackboard, derived_property
-from httpolice.codings import decode_deflate, decode_gzip
+from httpolice.codings import decode_brotli, decode_deflate, decode_gzip
 from httpolice.header import HeadersView
 from httpolice.known import cc, h, header, media, media_type, tc, upgrade, warn
 from httpolice.structure import (FieldName, HeaderEntry, HTTPVersion,
@@ -73,15 +73,13 @@ def decoded_body(self):
         codings = self.headers.content_encoding.value[:]
         while codings and okay(r) and r:
             coding = codings.pop()
-            if coding in [cc.gzip, cc.x_gzip]:
+            decoder = {cc.gzip: decode_gzip,
+                       cc.x_gzip: decode_gzip,
+                       cc.deflate: decode_deflate,
+                       cc.br: decode_brotli}.get(coding)
+            if decoder is not None:
                 try:
-                    r = decode_gzip(r)
-                except Exception as e:
-                    self.complain(1037, coding=coding, error=e)
-                    r = Unavailable
-            elif coding == cc.deflate:
-                try:
-                    r = decode_deflate(r)
+                    r = decoder(r)
                 except Exception as e:
                     self.complain(1037, coding=coding, error=e)
                     r = Unavailable

setup.py

@@ -33,6 +33,7 @@
         'bitstring >= 3.1.4',
         'dominate >= 2.2.0',
         'defusedxml >= 0.4.1',
+        'brotlipy >= 0.5.1',
     ],
     extras_require={
         ':python_version == "2.7"': [

test/combined_data/1037_3

@@ -0,0 +1,15 @@
+1037
+
+======== BEGIN INBOUND STREAM ========
+GET / HTTP/1.1
+Host: example.com
+User-Agent: demo
+
+======== BEGIN OUTBOUND STREAM ========
+HTTP/1.1 200 OK
+Date: Thu, 31 Dec 2015 18:26:56 GMT
+Content-Type: text/plain
+Content-Length: 14
+Content-Encoding: br
+
+Hello world!

test/test_structure.py

@@ -197,3 +197,8 @@ def test_alt_svc():
             MultiDict([(u'foo', u'bar')])
         ),
     ]
+
+
+def test_decode_brotli():
+    [exch1] = load_from_file('content_encoding_br')
+    assert exch1.responses[0].decoded_body.startswith(b'Lorem ipsum dolor')