robotframework-requests-log 1.0.0__py3-none-any.whl

RequestsLog.py

@@ -0,0 +1,359 @@
+import json
+import html as html_module
+import uuid
+import shlex
+import time
+
+import requests
+from robot.api import logger
+from robot.api.deco import keyword
+
+METHOD_COLORS = {
+    'GET':     '#10b981',
+    'POST':    '#3b82f6',
+    'PUT':     '#f59e0b',
+    'PATCH':   '#8b5cf6',
+    'DELETE':  '#ef4444',
+    'HEAD':    '#6b7280',
+    'OPTIONS': '#6b7280',
+}
+
+BINARY_CONTENT_TYPES = ('image/', 'audio/', 'video/', 'application/octet-stream', 'application/pdf')
+MAX_BODY_DISPLAY = 50_000
+
+
+class RequestsLog:
+    ROBOT_LIBRARY_SCOPE = 'GLOBAL'
+    ROBOT_LIBRARY_DOC_FORMAT = 'ROBOT'
+    ROBOT_AUTO_KEYWORDS = True
+
+    def __init__(self):
+        self._session = requests.Session()
+
+    # ── Public keywords ────────────────────────────────────────────────────
+
+    @keyword
+    def GET(self, url, params=None, headers=None, timeout=30, verify=True,
+            expected_status=None, msg=None, **kwargs):
+        return self._make_request('GET', url, params=params, headers=headers,
+                                  timeout=timeout, verify=verify,
+                                  expected_status=expected_status, msg=msg, **kwargs)
+
+    @keyword
+    def POST(self, url, data=None, json=None, params=None, headers=None,
+             timeout=30, verify=True, expected_status=None, msg=None, **kwargs):
+        return self._make_request('POST', url, data=data, json=json, params=params,
+                                  headers=headers, timeout=timeout, verify=verify,
+                                  expected_status=expected_status, msg=msg, **kwargs)
+
+    @keyword
+    def PUT(self, url, data=None, json=None, params=None, headers=None,
+            timeout=30, verify=True, expected_status=None, msg=None, **kwargs):
+        return self._make_request('PUT', url, data=data, json=json, params=params,
+                                  headers=headers, timeout=timeout, verify=verify,
+                                  expected_status=expected_status, msg=msg, **kwargs)
+
+    @keyword
+    def PATCH(self, url, data=None, json=None, params=None, headers=None,
+              timeout=30, verify=True, expected_status=None, msg=None, **kwargs):
+        return self._make_request('PATCH', url, data=data, json=json, params=params,
+                                  headers=headers, timeout=timeout, verify=verify,
+                                  expected_status=expected_status, msg=msg, **kwargs)
+
+    @keyword
+    def DELETE(self, url, params=None, headers=None, timeout=30, verify=True,
+               expected_status=None, msg=None, **kwargs):
+        return self._make_request('DELETE', url, params=params, headers=headers,
+                                  timeout=timeout, verify=verify,
+                                  expected_status=expected_status, msg=msg, **kwargs)
+
+    @keyword
+    def HEAD(self, url, params=None, headers=None, timeout=30, verify=True,
+             expected_status=None, msg=None, **kwargs):
+        return self._make_request('HEAD', url, params=params, headers=headers,
+                                  timeout=timeout, verify=verify,
+                                  expected_status=expected_status, msg=msg, **kwargs)
+
+    @keyword
+    def OPTIONS(self, url, params=None, headers=None, timeout=30, verify=True,
+                expected_status=None, msg=None, **kwargs):
+        return self._make_request('OPTIONS', url, params=params, headers=headers,
+                                  timeout=timeout, verify=verify,
+                                  expected_status=expected_status, msg=msg, **kwargs)
+
+    # ── Core request dispatcher ────────────────────────────────────────────
+
+    def _make_request(self, method, url, expected_status=None, msg=None, **kwargs):
+        response = self._session.request(method, url, **kwargs)
+        card_id = uuid.uuid4().hex[:12]
+        self._log_card(response, card_id)
+        self._check_status(response, expected_status, msg)
+        return response
+
+    def _check_status(self, response, expected_status, msg=None):
+        if expected_status is None:
+            response.raise_for_status()
+        elif str(expected_status).lower() in ('any', 'anything'):
+            pass
+        else:
+            actual = response.status_code
+            expected = int(expected_status)
+            if actual != expected:
+                raise AssertionError(
+                    msg or f'Expected status {expected} but got {actual}.'
+                )
+
+    # ── Card logging ───────────────────────────────────────────────────────
+
+    def _log_card(self, response, card_id):
+        req_data = self._extract_request_data(response)
+        resp_data = self._extract_response_data(response)
+        curl_str = self._build_curl_command(response)
+        html_str = self._build_card_html(req_data, resp_data, curl_str, card_id)
+        logger.info(html_str, html=True)
+
+    # ── Data extraction ────────────────────────────────────────────────────
+
+    def _extract_request_data(self, response):
+        req = response.request
+        body_raw = req.body
+        body_display, is_json = self._parse_body(body_raw)
+        return {
+            'method': req.method,
+            'url': req.url,
+            'headers': dict(req.headers),
+            'body_display': body_display,
+            'body_is_json': is_json,
+        }
+
+    def _extract_response_data(self, response):
+        ct = response.headers.get('Content-Type', '')
+        if any(ct.startswith(b) for b in BINARY_CONTENT_TYPES):
+            body_display = f'[binary content, {len(response.content)} bytes]'
+            is_json = False
+        else:
+            try:
+                raw = response.text
+            except Exception:
+                raw = '[could not decode response body]'
+            body_display, is_json = self._parse_body(raw)
+
+        return {
+            'status_code': response.status_code,
+            'reason': response.reason or '',
+            'elapsed_ms': round(response.elapsed.total_seconds() * 1000, 1),
+            'headers': dict(response.headers),
+            'body_display': body_display,
+            'body_is_json': is_json,
+            'content_type': ct,
+        }
+
+    def _parse_body(self, raw):
+        if raw is None:
+            return '', False
+        if isinstance(raw, bytes):
+            try:
+                raw = raw.decode('utf-8')
+            except Exception:
+                return f'[binary, {len(raw)} bytes]', False
+        try:
+            parsed = json.loads(raw)
+            display = json.dumps(parsed, indent=2, ensure_ascii=False)
+            is_json = True
+        except (json.JSONDecodeError, TypeError, ValueError):
+            display = raw
+            is_json = False
+        if len(display) > MAX_BODY_DISPLAY:
+            display = display[:MAX_BODY_DISPLAY] + f'\n... [truncated, {len(display)} chars total]'
+        return display, is_json
+
+    # Headers that curl adds automatically — no need to include in generated command
+    _SKIP_HEADERS = frozenset({
+        'user-agent', 'accept-encoding', 'accept', 'connection', 'content-length',
+    })
+
+    def _build_curl_command(self, response):
+        req = response.request
+        body = None
+        if req.body:
+            body = req.body
+            if isinstance(body, bytes):
+                body = body.decode('utf-8', errors='replace')
+
+        parts = ['curl', '-X', req.method]
+        for k, v in req.headers.items():
+            if k.lower() in self._SKIP_HEADERS:
+                continue
+            safe_v = f'{k}: {v}'.replace("'", "'\\''")
+            parts += ['-H', f"'{safe_v}'"]
+        if body:
+            safe_body = body.replace("'", "'\\''")
+            parts += ['--data-raw', f"'{safe_body}'"]
+        parts.append(f"'{req.url}'")
+        return ' '.join(parts)
+
+    # ── HTML card builder ──────────────────────────────────────────────────
+
+    def _build_card_html(self, req_data, resp_data, curl_str, card_id):
+        outer_style = (
+            'font-family:-apple-system,BlinkMacSystemFont,"Segoe UI",sans-serif;'
+            'border:1px solid #e2e8f0;border-radius:8px;overflow:hidden;'
+            'margin:8px 0;box-shadow:0 1px 4px rgba(0,0,0,0.08);'
+            'max-width:100%;background:#ffffff;'
+        )
+        parts = [f'<div id="card-{card_id}" style="{outer_style}">']
+        parts.append(self._build_card_header(req_data, resp_data))
+        parts.append(self._build_section_headers('REQUEST HEADERS', req_data['headers'], card_id + 'rqh'))
+        parts.append(self._build_section_body('REQUEST BODY', req_data['body_display'], req_data['body_is_json'], card_id + 'rqb', open=True))
+        parts.append(self._build_section_headers('RESPONSE HEADERS', resp_data['headers'], card_id + 'rph'))
+        parts.append(self._build_section_body('RESPONSE BODY', resp_data['body_display'], resp_data['body_is_json'], card_id + 'rpb', open=True))
+        parts.append(self._build_section_curl(curl_str, card_id))
+        parts.append('</div>')
+        return ''.join(parts)
+
+    def _build_card_header(self, req_data, resp_data):
+        method = req_data['method']
+        method_color = METHOD_COLORS.get(method, '#6b7280')
+        status_color = self._status_color(resp_data['status_code'])
+
+        method_badge = (
+            f'<span style="background:{method_color};color:#fff;font-weight:700;'
+            f'font-size:11px;padding:3px 9px;border-radius:4px;'
+            f'letter-spacing:0.5px;font-family:monospace;white-space:nowrap;">'
+            f'{html_module.escape(method)}</span>'
+        )
+        url_span = (
+            f'<span style="font-family:monospace;font-size:13px;color:#1e293b;'
+            f'flex:1;word-break:break-all;min-width:0;">'
+            f'{html_module.escape(req_data["url"])}</span>'
+        )
+        status_badge = (
+            f'<span style="background:{status_color};color:#fff;font-weight:600;'
+            f'font-size:12px;padding:3px 10px;border-radius:4px;white-space:nowrap;">'
+            f'{resp_data["status_code"]} {html_module.escape(resp_data["reason"])}</span>'
+        )
+        timing = (
+            f'<span style="color:#64748b;font-size:12px;white-space:nowrap;">'
+            f'{resp_data["elapsed_ms"]} ms</span>'
+        )
+        header_style = (
+            'display:flex;align-items:center;gap:10px;padding:10px 14px;'
+            'background:#f8fafc;border-bottom:1px solid #e2e8f0;flex-wrap:wrap;'
+        )
+        return f'<div style="{header_style}">{method_badge}{url_span}{status_badge}{timing}</div>'
+
+    def _build_section_headers(self, label, headers_dict, section_id):
+        if not headers_dict:
+            return ''
+        count = len(headers_dict)
+        rows = []
+        for k, v in headers_dict.items():
+            rows.append(
+                f'<tr style="border-bottom:1px solid #f1f5f9;">'
+                f'<td style="padding:5px 14px;color:#64748b;width:35%;vertical-align:top;'
+                f'font-family:monospace;font-size:12px;word-break:break-word;">'
+                f'{html_module.escape(str(k))}</td>'
+                f'<td style="padding:5px 14px;color:#1e293b;word-break:break-all;'
+                f'font-family:monospace;font-size:12px;">'
+                f'{html_module.escape(str(v))}</td>'
+                f'</tr>'
+            )
+        table = (
+            f'<table style="width:100%;border-collapse:collapse;">{"".join(rows)}</table>'
+        )
+        return self._wrap_details(label, f'({count} headers)', table)
+
+    def _build_section_body(self, label, body_display, is_json, section_id, open=False):
+        if not body_display:
+            content_type = '· JSON' if is_json else ''
+            empty = f'<div style="padding:10px 14px;color:#94a3b8;font-size:12px;font-style:italic;">No body</div>'
+            return self._wrap_details(f'{label} {content_type}'.strip(), '', empty, open=open)
+
+        content_type_label = '· JSON' if is_json else ''
+        escaped_body = html_module.escape(body_display)
+        pre_id = section_id + 'pre'
+        pre = (
+            f'<pre id="{pre_id}" style="margin:0;padding:12px 14px;'
+            f'background:#0f172a;color:#e2e8f0;font-size:12px;'
+            f'font-family:\'Cascadia Code\',\'Fira Code\',monospace;'
+            f'overflow-x:auto;overflow-y:auto;white-space:pre-wrap;word-break:break-word;'
+            f'line-height:1.6;max-height:300px;">{escaped_body}</pre>'
+        )
+        script = ''
+        if is_json:
+            script = (
+                '<script>(function(){'
+                f'var p=document.getElementById("{pre_id}");if(!p)return;'
+                'p.innerHTML=p.innerHTML'
+                r'.replace(/(&quot;(?:[^&]|&(?!quot;))*&quot;)(\s*:)/g,'
+                '\'<span style="color:#7dd3fc">$1</span>$2\')'
+                r'.replace(/:\s*(&quot;(?:[^&]|&(?!quot;))*&quot;)/g,'
+                '\': <span style="color:#a3e635">$1</span>\')'
+                r'.replace(/\b(true|false)\b/g,\'<span style="color:#fb923c">$1</span>\')'
+                r'.replace(/\b(null)\b/g,\'<span style="color:#f87171">$1</span>\')'
+                r'.replace(/(?<!["\w])(-?\d+\.?\d*)(?!["\w])/g,\'<span style="color:#c084fc">$1</span>\');'
+                '})();</script>'
+            )
+        return self._wrap_details(f'{label} {content_type_label}'.strip(), '', pre + script, open=open)
+
+    def _build_section_curl(self, curl_str, card_id):
+        curl_pre_id = f'curl-{card_id}'
+        copy_id = f'copybtn-{card_id}'
+        esc_curl = html_module.escape(curl_str)
+
+        script = (
+            f'<script>'
+            f'function copyCurl_{card_id}(){{'
+            f'var pre=document.getElementById("{curl_pre_id}");'
+            f'navigator.clipboard.writeText(pre.textContent).then(function(){{'
+            f'var btn=document.getElementById("{copy_id}");'
+            f'btn.textContent="Copied!";'
+            f'setTimeout(function(){{btn.textContent="Copy";}},1500);'
+            f'}});'
+            f'}}'
+            f'</script>'
+        )
+        content = (
+            f'{script}'
+            f'<div style="position:relative;background:#0f172a;padding:10px 14px;">'
+            f'<button id="{copy_id}" onclick="copyCurl_{card_id}()" '
+            f'style="position:absolute;top:8px;right:12px;background:#334155;color:#94a3b8;'
+            f'border:none;border-radius:4px;padding:3px 10px;font-size:11px;cursor:pointer;">Copy</button>'
+            f'<pre id="{curl_pre_id}" style="margin:0;color:#a3e635;font-size:12px;'
+            f'font-family:monospace;white-space:pre-wrap;word-break:break-all;padding-right:60px;">'
+            f'{esc_curl}</pre>'
+            f'</div>'
+        )
+        return self._wrap_details('CURL', '', content)
+
+    def _wrap_details(self, label, meta, content_html, open=False):
+        summary_style = (
+            'padding:9px 14px;cursor:pointer;font-size:11px;font-weight:600;'
+            'color:#475569;text-transform:uppercase;letter-spacing:0.5px;'
+            'list-style:none;display:flex;align-items:center;gap:6px;'
+            'user-select:none;background:#f8fafc;'
+        )
+        meta_span = (
+            f'<span style="color:#94a3b8;font-weight:400;text-transform:none;margin-left:auto;">'
+            f'{html_module.escape(meta)}</span>'
+        ) if meta else ''
+        open_attr = ' open' if open else ''
+        return (
+            f'<details{open_attr} style="border-top:1px solid #e2e8f0;">'
+            f'<summary style="{summary_style}">'
+            f'{html_module.escape(label)}{meta_span}'
+            f'</summary>'
+            f'{content_html}'
+            f'</details>'
+        )
+
+    def _status_color(self, code):
+        if 200 <= code < 300:
+            return '#10b981'
+        if 300 <= code < 400:
+            return '#3b82f6'
+        if 400 <= code < 500:
+            return '#f59e0b'
+        if code >= 500:
+            return '#ef4444'
+        return '#6b7280'

robotframework_requests_log-1.0.0.dist-info/METADATA

@@ -0,0 +1,94 @@
+Metadata-Version: 2.4
+Name: robotframework-requests-log
+Version: 1.0.0
+Summary: Robot Framework library for beautiful API request/response HTML log cards
+License: MIT
+Project-URL: Homepage, https://github.com/heynirinx/request-log-rf
+Project-URL: Repository, https://github.com/heynirinx/request-log-rf
+Keywords: robotframework,testing,api,http,logging,requests
+Classifier: Programming Language :: Python :: 3
+Classifier: Framework :: Robot Framework
+Classifier: Framework :: Robot Framework :: Library
+Classifier: Topic :: Software Development :: Testing
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: robotframework>=5.0
+Requires-Dist: requests>=2.20
+Dynamic: license-file
+
+# robotframework-requests-log
+
+A [Robot Framework](https://robotframework.org/) library that logs HTTP API requests and responses as beautiful interactive HTML cards — with color-coded method badges, status indicators, JSON syntax highlighting, and one-click curl commands.
+
+## Features
+
+- All HTTP methods: `GET`, `POST`, `PUT`, `PATCH`, `DELETE`, `HEAD`, `OPTIONS`
+- Color-coded method badges and status code indicators
+- JSON syntax highlighting in request/response bodies
+- Collapsible request/response headers
+- Auto-generated curl command with copy button
+- Binary content detection (images, PDFs, audio, video)
+- Body truncation at 50KB with total size shown
+
+## Installation
+
+```bash
+pip install robotframework-requests-log
+```
+
+## Usage
+
+```robot
+*** Settings ***
+Library    RequestsLog
+
+*** Test Cases ***
+Test GET Request
+    ${response}=    GET    https://jsonplaceholder.typicode.com/todos/1
+    Log    ${response.status_code}
+
+Test POST Request
+    ${body}=    Create Dictionary    title=foo    body=bar    userId=${1}
+    ${response}=    POST    https://jsonplaceholder.typicode.com/posts
+    ...    json=${body}
+    ...    expected_status=201
+```
+
+## Keywords
+
+| Keyword | Description |
+|---------|-------------|
+| `GET` | Send an HTTP GET request |
+| `POST` | Send an HTTP POST request |
+| `PUT` | Send an HTTP PUT request |
+| `PATCH` | Send an HTTP PATCH request |
+| `DELETE` | Send an HTTP DELETE request |
+| `HEAD` | Send an HTTP HEAD request |
+| `OPTIONS` | Send an HTTP OPTIONS request |
+
+### Common Parameters
+
+| Parameter | Description | Default |
+|-----------|-------------|---------|
+| `url` | Target URL | required |
+| `headers` | Additional headers (dict) | `None` |
+| `json` | JSON body (dict) | `None` |
+| `data` | Raw body | `None` |
+| `params` | URL query parameters (dict) | `None` |
+| `expected_status` | Assert response status code | `None` |
+| `timeout` | Request timeout in seconds | `30` |
+| `verify` | SSL certificate verification | `True` |
+| `msg` | Custom error message on failure | `None` |
+
+## Requirements
+
+- Python >= 3.8
+- Robot Framework >= 5.0
+- requests >= 2.20
+
+## License
+
+MIT

robotframework_requests_log-1.0.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+RequestsLog.py,sha256=z8Jld8Jx8txlaOjCHl8MJggfrA5kZrT4IsPWK2jTPOI,16743
+robotframework_requests_log-1.0.0.dist-info/licenses/LICENSE,sha256=Oow6bpC39ifxx3shl_UD96yrItZjq1MbcBlXPxarGvs,1066
+robotframework_requests_log-1.0.0.dist-info/METADATA,sha256=5xlP-9xj__psVh3dzv3yqr0QaQ2x6QWvNkyc2potgMk,3052
+robotframework_requests_log-1.0.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+robotframework_requests_log-1.0.0.dist-info/top_level.txt,sha256=0o75q6TNyjMJdH0fIut0nVNvhZkMkZfyAFnGk2qRnsg,12
+robotframework_requests_log-1.0.0.dist-info/RECORD,,

robotframework_requests_log-1.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

robotframework_requests_log-1.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 heynirinx
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

robotframework_requests_log-1.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+RequestsLog