httpdbg 0.13.3__tar.gz → 0.13.4__tar.gz

{httpdbg-0.13.3 → httpdbg-0.13.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: httpdbg
-Version: 0.13.3
+Version: 0.13.4
 Summary: A very simple tool to debug HTTP(S) client requests
 Author-email: cle-b <cle@tictac.pm>
 License: Apache-2.0

{httpdbg-0.13.3 → httpdbg-0.13.4}/httpdbg/__init__.py

@@ -3,6 +3,6 @@ from httpdbg.hooks.all import httpdbg
 from httpdbg.records import HTTPRecords
 
 
-VERSION = "0.13.3"
+VERSION = "0.13.4"
 
 __all__ = ["httpdbg", "HTTPRecords"]

httpdbg-0.13.4/httpdbg/preview.py

@@ -0,0 +1,53 @@
+# -*- coding: utf-8 -*-
+from typing import Tuple, Dict, Union
+
+
+def parse_content_type(content_type: str) -> Tuple[str, Dict[str, str]]:
+    s = content_type.split(";")
+    media_type = s[0]
+    directives = {}
+    for directive in s[1:]:
+        sp = directive.split("=")
+        if len(sp) == 2:
+            directives[sp[0].strip()] = sp[1].strip()
+    return media_type, directives
+
+
+def generate_preview(
+    raw_data: bytes, content_type: str, content_encoding: str
+) -> Dict[str, Union[str, bool]]:
+    body: Dict[str, Union[str, bool]] = {}
+
+    body["content_type"] = content_type
+
+    if content_encoding.lower() == "br":
+        try:
+            import brotli  # type: ignore
+
+            raw_data = brotli.decompress(raw_data)
+        except Exception:
+            # if there is no brotli library available to decompress the data we keep the compressed data
+            pass
+    elif content_encoding.lower() == "gzip":
+        try:
+            import zlib
+
+            raw_data = zlib.decompressobj(16 + zlib.MAX_WBITS).decompress(raw_data)
+        except Exception:
+            pass
+        # TODO deflate
+
+    if "image/" in content_type.lower():
+        body["image"] = True
+    else:
+        if isinstance(raw_data, str):
+            body["text"] = raw_data
+        elif isinstance(raw_data, bytes):
+            try:
+                body["text"] = raw_data.decode(
+                    parse_content_type(content_type)[1].get("charset", "utf-8")
+                )
+            except Exception:
+                pass
+
+    return body

{httpdbg-0.13.3 → httpdbg-0.13.4}/httpdbg/webapp/static/render.js

@@ -127,6 +127,12 @@ function fill_content(request_id, name) {
 
     if (request.body && request.body.text) {
         request.body.raw_text = "global.requests['" + request_id + "'].data.request.body.text";
+
+        const parsed_text = parse_raw_text(request.body.text, request.body.content_type);
+        if (parsed_text) {
+            request.body.parsed = parsed_text;
+        }
+
         if (request.body.parsed) {
             request.body.parsed_text = "global.requests['" + request_id + "'].data.request.body.parsed";
         }
@@ -140,6 +146,12 @@ function fill_content(request_id, name) {
 
     if (response.body && response.body.text) {
         response.body.raw_text = "global.requests['" + request_id + "'].data.response.body.text";
+
+        const parsed_text = parse_raw_text(response.body.text, response.body.content_type);
+        if (parsed_text) {
+            response.body.parsed = parsed_text;
+        }
+
         if (response.body.parsed) {
             response.body.parsed_text = "global.requests['" + request_id + "'].data.response.body.parsed";
         }
@@ -314,7 +326,7 @@ function select_next_request() {
 
     if (request == undefined) {
         // maybe there are some requests under another initiator
-        var next_initiator = document.querySelector(".active-row").parentElement.nextElementSibling;        
+        var next_initiator = document.querySelector(".active-row").parentElement.nextElementSibling;
 
         if (next_initiator != undefined) {
             request = next_initiator.querySelector(".request");
@@ -324,4 +336,34 @@ function select_next_request() {
     if (request != undefined) {
         request.click();
     }
+}
+
+function parse_raw_text(raw_text, content_type) {
+    var parsed_text="";
+
+    if (content_type.toLowerCase().includes("json")) {
+        try {
+            parsed_text = JSON.stringify(JSON.parse(raw_text), null, "    ");
+        } catch {
+            return;
+        }
+    } else if (content_type.toLowerCase().includes("x-www-form-urlencoded")) {
+        try {
+            var params = new URLSearchParams(raw_text);
+
+            for (const key of params.keys()) {
+                params.getAll(key).forEach((value) => {
+                    try {
+                        parsed_text += key + ": " + JSON.stringify(JSON.parse(value), null, "    ") + "\n";
+                    } catch {
+                        parsed_text += key + ": " + value + "\n";
+                    }
+                });
+            }
+        } catch {
+            return;
+        }
+    }
+
+    return parsed_text;
 }

{httpdbg-0.13.3 → httpdbg-0.13.4}/httpdbg.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: httpdbg
-Version: 0.13.3
+Version: 0.13.4
 Summary: A very simple tool to debug HTTP(S) client requests
 Author-email: cle-b <cle@tictac.pm>
 License: Apache-2.0

httpdbg-0.13.4/tests/test_preview.py

@@ -0,0 +1,56 @@
+# -*- coding: utf-8 -*-
+import pytest
+
+from httpdbg.preview import generate_preview
+
+
+@pytest.mark.preview
+def test_preview_unknown_type_text():
+    body = generate_preview("a text", "unknown/type", "")
+    assert body == {"text": "a text", "content_type": "unknown/type"}
+
+
+@pytest.mark.preview
+def test_preview_unknown_type_bytes():
+    body = generate_preview(b"a text", "unknown/type", "")
+    assert body == {"text": "a text", "content_type": "unknown/type"}
+
+
+@pytest.mark.preview
+@pytest.mark.parametrize("content_type", ["text/json", "application/json", "text", ""])
+def test_preview_text(content_type):
+    raw_data = '{"a": "1", "b": {"c": 2} }'
+    body = generate_preview(raw_data, content_type, "")
+
+    assert body == {
+        "text": raw_data,
+        "content_type": content_type,
+    }
+
+
+@pytest.mark.preview
+def test_preview_image():
+    body = generate_preview(None, "image/png", "")
+
+    assert body == {
+        "image": True,
+        "content_type": "image/png",
+    }
+
+
+def test_preview_application_no_content_type_text():
+    body = generate_preview("just text", "", "")
+
+    assert body == {
+        "text": "just text",
+        "content_type": "",
+    }
+
+
+def test_preview_application_no_content_type_bytes():
+    body = generate_preview("just éà bytes".encode("utf-8"), "", "")
+
+    assert body == {
+        "text": "just éà bytes",
+        "content_type": "",
+    }

httpdbg-0.13.3/httpdbg/preview.py

@@ -1,88 +0,0 @@
-# -*- coding: utf-8 -*-
-import json
-import urllib
-from typing import Tuple, Dict, Union
-from xml.dom import minidom
-
-
-def parse_content_type(content_type: str) -> Tuple[str, Dict[str, str]]:
-    s = content_type.split(";")
-    media_type = s[0]
-    directives = {}
-    for directive in s[1:]:
-        sp = directive.split("=")
-        if len(sp) == 2:
-            directives[sp[0].strip()] = sp[1].strip()
-    return media_type, directives
-
-
-def generate_preview(
-    raw_data: bytes, content_type: str, content_encoding: str
-) -> Dict[str, Union[str, bool]]:
-    body: Dict[str, Union[str, bool]] = {}
-
-    if content_encoding.lower() == "br":
-        try:
-            import brotli  # type: ignore
-
-            raw_data = brotli.decompress(raw_data)
-        except Exception:
-            # if there is no brotli library available to decompress the data we keep the compressed data
-            pass
-    elif content_encoding.lower() == "gzip":
-        try:
-            import zlib
-
-            raw_data = zlib.decompressobj(16 + zlib.MAX_WBITS).decompress(raw_data)
-        except Exception:
-            pass
-        # TODO deflate
-
-    if "image/" in content_type.lower():
-        body["image"] = True
-    else:
-        if isinstance(raw_data, str):
-            body["text"] = raw_data
-        elif isinstance(raw_data, bytes):
-            try:
-                body["text"] = raw_data.decode(
-                    parse_content_type(content_type)[1].get("charset", "utf-8")
-                )
-            except Exception:
-                pass
-
-        if body.get("text"):
-            if isinstance(body["text"], str):
-                # json
-                try:
-                    body["parsed"] = json.dumps(
-                        json.loads(body["text"]), sort_keys=True, indent=4
-                    )
-                except Exception:
-                    # xml, ...
-                    try:
-                        lines = minidom.parseString(body["text"]).toprettyxml(
-                            indent="   "
-                        )
-                        body["parsed"] = "\n".join(
-                            [line for line in lines.split("\n") if line.strip() != ""]
-                        )
-                    except Exception:
-                        # query string
-                        try:
-                            if (
-                                parse_content_type(content_type)[0]
-                                == "application/x-www-form-urlencoded"
-                            ):
-                                qs = []
-                                for key, value in urllib.parse.parse_qsl(
-                                    body["text"], strict_parsing=True
-                                ):
-                                    if value:
-                                        qs.append(f"{key}={value}")
-                                if qs:
-                                    body["parsed"] = "\n\n".join(qs)
-                        except Exception:
-                            pass
-
-    return body

httpdbg-0.13.3/tests/test_preview.py

@@ -1,96 +0,0 @@
-# -*- coding: utf-8 -*-
-import pytest
-
-from httpdbg.preview import generate_preview
-
-
-@pytest.mark.preview
-def test_preview_unknown_type_text():
-    body = generate_preview("a text", "unknown/type", "")
-    assert body == {"text": "a text"}
-
-
-@pytest.mark.preview
-def test_preview_unknown_type_bytes():
-    body = generate_preview(b"a text", "unknown/type", "")
-    assert body == {"text": "a text"}
-
-
-@pytest.mark.preview
-@pytest.mark.parametrize(
-    "content_type",
-    ["text/html", "application/xhtml+xml", "application/xml", "text", ""],
-)
-def test_preview_xml(content_type):
-    raw_data = "<html><head><title>:-)</title></head><body>empty</body></html>"
-    body = generate_preview(raw_data, content_type, "")
-    parsed = '<?xml version="1.0" ?>\n<html>\n   <head>\n      <title>:-)</title>\n   </head>\n   <body>empty</body>\n</html>'
-
-    assert body == {
-        "text": raw_data,
-        "parsed": parsed,
-    }
-
-
-@pytest.mark.preview
-@pytest.mark.parametrize("content_type", ["text/json", "application/json", "text", ""])
-def test_preview_json(content_type):
-    raw_data = '{"a": "1", "b": {"c": 2} }'
-    body = generate_preview(raw_data, "application/json", "")
-    parsed = '{\n    "a": "1",\n    "b": {\n        "c": 2\n    }\n}'
-
-    assert body == {
-        "text": raw_data,
-        "parsed": parsed,
-    }
-
-
-@pytest.mark.preview
-def test_preview_query_string():
-    raw_data = "a=1&b=2&c=%7B%27er%27%3A+43434%7D"
-    body = generate_preview(
-        raw_data,
-        "application/x-www-form-urlencoded",
-        "",
-    )
-    parsed = "a=1\n\nb=2\n\nc={'er': 43434}"
-
-    assert body == {
-        "text": raw_data,
-        "parsed": parsed,
-    }
-
-
-@pytest.mark.preview
-def test_preview_query_string_not_urlencoded_mimetype():
-    raw_data = "a=1&b=2&c=%7B%27er%27%3A+43434%7D"
-    body = generate_preview(raw_data, "test/plain", "")
-
-    assert body == {
-        "text": raw_data,
-    }
-
-
-@pytest.mark.preview
-def test_preview_image():
-    body = generate_preview(None, "image/png", "")
-
-    assert body == {
-        "image": True,
-    }
-
-
-def test_preview_application_no_content_type_text():
-    body = generate_preview("just text", "", "")
-
-    assert body == {
-        "text": "just text",
-    }
-
-
-def test_preview_application_no_content_type_bytes():
-    body = generate_preview("just éà bytes".encode("utf-8"), "", "")
-
-    assert body == {
-        "text": "just éà bytes",
-    }