Support HTTP upgrade

Author: 1st1

README.md

@@ -23,6 +23,7 @@ class HttpRequestParser:
         protocol -- a Python object with the following methods
         (all optional):
 
+          - on_message_begin()
           - on_header(name: bytes, value: bytes)
           - on_headers_complete()
           - on_body(body: bytes)
@@ -42,6 +43,10 @@ class HttpRequestParser:
 
         Will eventually trigger callbacks on the ``protocol``
         object.
+
+        On HTTP upgrade, this method will raise an
+        ``HttpParserUpgrade`` exception, with its sole argument
+        set to the offset of the non-HTTP data in ``data``.
         """
 
     def get_method(self) -> str:

httptools/parser/errors.py

@@ -2,7 +2,8 @@
            'HttpParserCallbackError',
            'HttpParserInvalidStatusError',
            'HttpParserInvalidMethodError',
-           'HttpParserInvalidURLError')
+           'HttpParserInvalidURLError',
+           'HttpParserUpgrade')
 
 
 class HttpParserError(Exception):
@@ -23,3 +24,7 @@ class HttpParserInvalidMethodError(HttpParserError):
 
 class HttpParserInvalidURLError(HttpParserError):
     pass
+
+
+class HttpParserUpgrade(Exception):
+    pass

httptools/parser/parser.pyx

@@ -9,7 +9,8 @@ from .errors import (HttpParserError,
                      HttpParserCallbackError,
                      HttpParserInvalidStatusError,
                      HttpParserInvalidMethodError,
-                     HttpParserInvalidURLError)
+                     HttpParserInvalidURLError,
+                     HttpParserUpgrade)
 
 cimport cython
 from . cimport cparser
@@ -156,6 +157,9 @@ cdef class HttpParser:
 
         PyBuffer_Release(&self.py_buf)
 
+        if self._cparser.upgrade:
+            raise HttpParserUpgrade(nb)
+
         # TODO: Handle parser->upgrade
 
         if self._cparser.http_errno != cparser.HPE_OK:

tests/test_parser.py

@@ -46,6 +46,18 @@
 b\r\n+\xce\xcfM\xb5MI,I\x04\x00\r\n0\r\n\r\n'''
 
 
+UPGRADE_REQUEST1 = b'''GET /demo HTTP/1.1
+Host: example.com
+Connection: Upgrade
+Sec-WebSocket-Key2: 12998 5 Y3 1  .P00
+Sec-WebSocket-Protocol: sample
+Upgrade: WebSocket
+Sec-WebSocket-Key1: 4 @1  46546xW%0l 1 5
+Origin: http://example.com
+
+Hot diggity dogg'''
+
+
 class TestResponseParser(unittest.TestCase):
 
     def test_parser_response_1(self):
@@ -199,6 +211,32 @@ def test_parser_request_chunked_3(self):
 
         self.assertTrue(m.on_message_complete.called)
 
+    def test_parser_request_upgrade_1(self):
+        m = mock.Mock()
+
+        headers = {}
+        m.on_header.side_effect = headers.__setitem__
+
+        p = httptools.HttpRequestParser(m)
+
+        try:
+            p.feed_data(UPGRADE_REQUEST1)
+        except httptools.HttpParserUpgrade as ex:
+            offset = ex.args[0]
+        else:
+            self.fail('HttpParserUpgrade was not raised')
+
+        self.assertEqual(UPGRADE_REQUEST1[offset:], b'Hot diggity dogg')
+
+        self.assertEqual(headers, {
+            b'Sec-WebSocket-Key2': b'12998 5 Y3 1  .P00',
+            b'Sec-WebSocket-Key1': b'4 @1  46546xW%0l 1 5',
+            b'Connection': b'Upgrade',
+            b'Origin': b'http://example.com',
+            b'Sec-WebSocket-Protocol': b'sample',
+            b'Host': b'example.com',
+            b'Upgrade': b'WebSocket'})
+
     def test_parser_request_2(self):
         p = httptools.HttpRequestParser(None)
         with self.assertRaises(httptools.HttpParserInvalidMethodError):