httpbinx 1.7.0__py3-none-any.whl → 1.8.0__py3-none-any.whl

httpbinx/__init__.py

@@ -1,5 +1,5 @@
 from .main import app
 
-__version__ = '1.7.0'
+__version__ = '1.8.0'
 
 app.version = __version__

httpbinx/constants.py

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-# flake8: noqa
 REDIRECT_LOCATION = '/redirect/1'
 
 ACCEPTED_MEDIA_TYPES = [
@@ -27,9 +25,9 @@ ASCII_ART = """
        _...._
      .'  _ _ `.
     | ."` ^ `". _,
-    \_;`"---"`|//
+    \\_;`"---"`|//
       |       ;/
-      \_     _/
+      \\_     _/
         `\"\"\"`
 """
 
@@ -40,7 +38,7 @@ ANGRY_ASCII = """
       :                :
       |                |
       :       __       :
-       \  .-"`  `"-.  /
+       \\  .-"`  `"-.  /
         '.          .'
           '-......-'
      YOU SHOULDN'T BE HERE

httpbinx/helpers.py

@@ -1,21 +1,23 @@
-# -*- coding: utf-8 -*-
 import json
 import random
 import re
+from pathlib import Path
 
 from starlette import status
 from starlette.requests import Request
 from starlette.responses import Response
 from starlette.templating import Jinja2Templates
 
-from httpbinx.constants import ACCEPTED_MEDIA_TYPES
-from httpbinx.constants import ASCII_ART
-from httpbinx.constants import REDIRECT_LOCATION
-from httpbinx.schemas import RequestAttrs
-from httpbinx.schemas import RequestInfo
+from httpbinx.constants import (ACCEPTED_MEDIA_TYPES, ASCII_ART,
+                                REDIRECT_LOCATION)
+from httpbinx.schemas import RequestAttrs, RequestInfo
 
 # init Jinja2
 _templates = Jinja2Templates(directory='templates')
+# image path
+_images_path = Path(__file__).parent / 'static' / 'images'
+# bomb files path
+_bomb_files_path = Path(__file__).parent / 'static' / 'bombs'
 
 
 def get_templates() -> Jinja2Templates:
@@ -23,6 +25,20 @@ def get_templates() -> Jinja2Templates:
     return _templates
 
 
+def get_images_path() -> Path:
+    """Dependency function that returns the path to the images directory"""
+    if not _images_path.exists():
+        raise FileNotFoundError(f'{_images_path} does not exist.')
+    return _images_path
+
+
+def get_bomb_file_path() -> Path:
+    """Dependency function that returns the path to the bomb files directory"""
+    if not _bomb_files_path.exists():
+        raise FileNotFoundError(f'{_bomb_files_path} does not exist.')
+    return _bomb_files_path
+
+
 async def to_request_info(request: Request, **extras) -> RequestInfo:
     """Returns model RequestInfo instance"""
     await request.body()  # Note: Execute `.stream()` only once.

httpbinx/main.py

@@ -1,9 +1,9 @@
-from os import path
+from pathlib import Path
 
 from fastapi import FastAPI
 from fastapi.staticfiles import StaticFiles
 
-from httpbinx.meta import tags_metadata
+from httpbinx.meta import get_tags_metadata
 from httpbinx.routers import router
 
 app = FastAPI(
@@ -12,14 +12,15 @@ app = FastAPI(
                 'written in Python + FastAPI.',
     docs_url='/',  # swagger docs page url
     swagger_ui_parameters={'docExpansion': 'none'},
-    openapi_tags=tags_metadata
+    openapi_tags=get_tags_metadata()
 )
 
+# mount static files
+static_dir = Path(__file__).parent / 'static'
 app.mount(
     '/static',
-    StaticFiles(directory=path.join(path.dirname(__file__), 'static')),
+    StaticFiles(directory=static_dir),
     name='static'
 )
 
-# app.openapi_tags = []
 app.include_router(router=router)

httpbinx/meta.py

@@ -1,45 +1,42 @@
-# -*- coding: utf-8 -*-
-tags_metadata = [
-    {
-        'name': 'HTTP Methods',
-        'description': 'Testing different HTTP verbs',
-    },
-    {
-        'name': 'Auth',
-        'description': 'Auth methods'
-    },
-    {
-        'name': 'Status codes',
-        'description': 'Generates responses with given status code',
-    },
-    {
-        'name': 'Request inspection',
-        'description': 'Inspect the request data'
-    },
-    {
-        'name': 'Response inspection',
-        'description': 'Inspect the response data like caching and headers',
-    },
-    {
-        'name': 'Response formats',
-        'description': 'Returns responses in different data formats',
-    },
-    {
-        'name': 'Dynamic data',
-        'description': 'Generates random and dynamic data'
-    },
-    {
-        'name': 'Cookies',
-        'description': 'Creates, reads and deletes Cookies'
-    },
-    {
-        'name': 'Images',
-        'description': 'Returns different image formats'},
-    {
-        'name': 'Redirects',
-        'description': 'Returns different redirect responses'},
-    {
-        'name': 'Anything',
-        'description': 'Returns anything that is passed to request',
-    }
-]
+"""
+This module defines the metadata for API tags used in the FastAPI application.
+These tags are used to organize and categorize different endpoints in the API documentation.
+"""
+from functools import lru_cache
+from typing import List
+
+from pydantic import BaseModel, Field
+
+
+class Tag(BaseModel):
+    name: str = Field(..., description='The name of the tag')
+    description: str = Field(..., description='A brief description of the tag')
+
+
+class TagsMetadata(BaseModel):
+    tags: List[Tag] = Field(..., description='List of API tags')
+
+
+TAGS_METADATA = TagsMetadata(
+    tags=[
+        Tag(name='HTTP Methods', description='Testing different HTTP verbs'),
+        Tag(name='Auth', description='Auth methods'),
+        Tag(name='Status codes', description='Generates responses with given status code'),
+        Tag(name='Request inspection', description='Inspect the request data'),
+        Tag(name='Response inspection', description='Inspect the response data like caching and headers'),
+        Tag(name='Response formats', description='Returns responses in different data formats'),
+        Tag(name='Dynamic data', description='Generates random and dynamic data'),
+        Tag(name='Cookies', description='Creates, reads and deletes Cookies'),
+        Tag(name='Images', description='Returns different image formats'),
+        Tag(name='Redirects', description='Returns different redirect responses'),
+        Tag(name='Anything', description='Returns anything that is passed to request'),
+    ]
+)
+
+
+@lru_cache
+def get_tags_metadata() -> List[dict]:
+    """
+    Returns the tags metadata in the format expected by FastAPI.
+    """
+    return [tag.model_dump() for tag in TAGS_METADATA.tags]

httpbinx/routers/anything.py

@@ -1,13 +1,25 @@
-# -*- coding: utf-8 -*-
-from fastapi import APIRouter
+from enum import Enum
+from os import path
+
+from fastapi import APIRouter, Path
 from starlette.requests import Request
+from starlette.responses import FileResponse
 
-from httpbinx.helpers import to_request_info
+from httpbinx.helpers import get_bomb_file_path, to_request_info
 from httpbinx.schemas import RequestInfo
 
 router = APIRouter(tags=['Anything'])
 
 
+class BombTypes(str, Enum):
+    """The allowed bomb file compression types are: brotli and gzip."""
+    brotli = 'brotli'
+    gzip = 'gzip'
+
+
+bombs_path: Path = get_bomb_file_path()
+
+
 @router.api_route(
     '/anything',  # TODO path regex
     response_model=RequestInfo,
@@ -17,3 +29,34 @@ router = APIRouter(tags=['Anything'])
 )
 async def anything(request: Request):
     return await to_request_info(request)
+
+
+@router.get(
+    '/bombs/{file}',
+    response_class=FileResponse,
+    summary='Returns a bomb file.',
+    description='**It may cause your client to crash! '
+                'References [I use Zip Bombs to Protect my Server](https://idiallo.com/blog/zipbomb-protection)**',
+    response_description='Return a bomb for compressed files.'
+)
+async def bomb_file(
+        *,
+        file: BombTypes = Path(
+            ...,
+            title='Compression types',
+            description='The allowed bomb file compression types',
+        )
+):
+    if file == BombTypes.gzip:
+        # dd if=/dev/zero bs=1M count=1000 | gzip -c > bomb-1GB.gz
+        return FileResponse(
+            path=path.join(bombs_path, 'bomb-1GB.gz'),
+            headers={'Content-Encoding': 'gzip'},
+        )
+    elif file == BombTypes.brotli:
+        # dd if=/dev/zero bs=1M count=1000 | brotli > bomb-1GB.br
+        return FileResponse(
+            path=path.join(bombs_path, 'bomb-1GB.br'),
+            headers={'Content-Encoding': 'br'},
+        )
+    raise ValueError(f'{file} is not a valid file type.')

httpbinx/routers/images.py

@@ -1,21 +1,20 @@
-# -*- coding: utf-8 -*-
 """Images"""
-from os import path
+from pathlib import Path
 
 from fastapi import APIRouter
 from starlette.requests import Request
 from starlette.responses import FileResponse
 from starlette.status import HTTP_406_NOT_ACCEPTABLE
 
-from httpbinx.helpers import status_code_response
+from httpbinx.helpers import get_images_path, status_code_response
 
 
 class ImageResponse(FileResponse):
     """set response headers Content-Type: image/* """
-    media_type = 'image/*'
+    media_type = 'image/*'  # default
 
 
-images_path = path.join('static', 'images')
+images_path: Path = get_images_path()
 
 router = APIRouter(
     tags=['Images'],
@@ -32,9 +31,6 @@ router = APIRouter(
 )
 async def image(request: Request):
     accept = request.headers.get('accept')
-    if not accept:
-        # Default media type to png
-        return await image_png()
     accept = accept.lower()
     if 'image/webp' in accept:
         return await image_webp()
@@ -42,7 +38,8 @@ async def image(request: Request):
         return await image_svg()
     elif 'image/jpeg' in accept:
         return await image_jpeg()
-    elif 'image/png' in accept or 'image/*' in accept:
+    elif any(x in accept for x in ['image/png', 'image/*', '*/*']):
+        # Default media type to png
         return await image_png()
     else:
         return status_code_response(HTTP_406_NOT_ACCEPTABLE)
@@ -55,7 +52,7 @@ async def image(request: Request):
     response_description='A PNG image.'
 )
 async def image_png():
-    return ImageResponse(path=path.join(images_path, 'pig_icon.png'))
+    return ImageResponse(path=images_path / 'pig_icon.png')
 
 
 @router.get(
@@ -65,7 +62,7 @@ async def image_png():
     response_description='A JPEG image.'
 )
 async def image_jpeg():
-    return ImageResponse(path=path.join(images_path, 'jackal.jpg'))
+    return ImageResponse(path=images_path / 'jackal.jpg')
 
 
 @router.get(
@@ -75,7 +72,7 @@ async def image_jpeg():
     response_description='A WEBP image.'
 )
 async def image_webp():
-    return ImageResponse(path=path.join(images_path, 'wolf_1.webp'))
+    return ImageResponse(path=images_path / 'wolf_1.webp')
 
 
 @router.get(
@@ -85,4 +82,4 @@ async def image_webp():
     response_description='An SVG image.'
 )
 async def image_svg():
-    return ImageResponse(path=path.join(images_path, 'svg_logo.svg'))
+    return ImageResponse(path=images_path / 'svg_logo.svg')

{httpbinx-1.7.0.dist-info → httpbinx-1.8.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: httpbinx
-Version: 1.7.0
+Version: 1.8.0
 Summary: HTTP Request & Response Service, written in Python + FastAPI.
 Author-Email: Leo <imleowoo@outlook.com>
 Maintainer-Email: Leo <imleowoo@outlook.com>
@@ -54,13 +54,17 @@ Description-Content-Type: text/markdown
 ![![cover](httpbinx/static/images/httpbinx_cover.png)](https://raw.githubusercontent.com/imleowoo/httpbinx/main/httpbinx/static/images/httpbinx_cover.png)
 
 [![thanks](https://img.shields.io/badge/thanks-httpbin-green)](https://github.com/postmanlabs/httpbin)
-![python](https://img.shields.io/badge/python-3.7%20%7C%203.8%20%7C%203.9%20%7C%203.10%20%7C%203.11-blue)
+![python](https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10%20%7C%203.11%20%7C%203.12-blue)
 
 # httpbinx
 
 HTTP Request & Response Service, written in Python + FastAPI.
 
-## Reference project
+## Deployed at:
+
+- **https://httpbinx.wooe.cc**
+
+## Reference Project
 
 A  [Kenneth Reitz](http://kennethreitz.org/bitcoin) Project. See https://github.com/postmanlabs/httpbin
 

{httpbinx-1.7.0.dist-info → httpbinx-1.8.0.dist-info}/RECORD

@@ -1,21 +1,21 @@
-httpbinx-1.7.0.dist-info/METADATA,sha256=lq16eYKPDfvYVcUQjmKsbJGAxVZ-Oz9yLTew3P9OAww,3730
-httpbinx-1.7.0.dist-info/WHEEL,sha256=thaaA2w1JzcGC48WYufAs8nrYZjJm8LqNfnXFOFyCC4,90
-httpbinx-1.7.0.dist-info/entry_points.txt,sha256=sRkqxXJlZzL_lyEEQOecT_wue4JP64lYhpLwrPCZ-lI,66
-httpbinx-1.7.0.dist-info/licenses/LICENSE,sha256=t6oZPzEcm1CsBu9sB_8JYTc5rSOUhyQUee5qvAg4o-A,1060
-httpbinx/__init__.py,sha256=r5PcxwlTsHcKSegPCbofDdMLXduzUb47_kzegLrOm5w,72
+httpbinx-1.8.0.dist-info/METADATA,sha256=4ssX6hl1ANVFBLDBariGV7nvlc_q-Q55p9wWnZc7QVY,3780
+httpbinx-1.8.0.dist-info/WHEEL,sha256=tSfRZzRHthuv7vxpI4aehrdN9scLjk-dCJkPLzkHxGg,90
+httpbinx-1.8.0.dist-info/entry_points.txt,sha256=sRkqxXJlZzL_lyEEQOecT_wue4JP64lYhpLwrPCZ-lI,66
+httpbinx-1.8.0.dist-info/licenses/LICENSE,sha256=t6oZPzEcm1CsBu9sB_8JYTc5rSOUhyQUee5qvAg4o-A,1060
+httpbinx/__init__.py,sha256=BtFN03iQf37ecI8AikkuZ6MbBZuBEEcONvB73NCN2Hg,72
 httpbinx/cli.py,sha256=bMPWV5HbOzqNJr3HBqFsZkaFqLI5YJneQQpAzF66mOg,1417
-httpbinx/constants.py,sha256=aJay1yI313fLxfFXgBPLE6p_UABlHq1KGEcdO7Nf2FQ,906
+httpbinx/constants.py,sha256=kXeT_Yzl_-4SJT_a7RxU5dfXBTe4-b1Zg8TBF-8AGbs,870
 httpbinx/examples/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-httpbinx/helpers.py,sha256=-fJyFbToQ0QwRY5UZ3Bkx7Ui_nj_bk8Wd4qKRtYGIsg,3787
-httpbinx/main.py,sha256=OmXi1FgApFBxNISDv4m5DU2hKAPu7kGEjZcQ5AxdAJE,614
-httpbinx/meta.py,sha256=gqWHplgb0SiUFVmZ8-gbOrZA468R-y9uDCQjqeQSHN8,1185
+httpbinx/helpers.py,sha256=VVwjLpEKxi_awEPqbgb8tfWnhJEHSQFTsthE0pBKgp4,4373
+httpbinx/main.py,sha256=kq8pcewugwiInkB8Cf0MvyAKJaK9uoMEeBHB5_xaprk,639
+httpbinx/meta.py,sha256=h6scAO050bHFiy7UG2Q8MsyJsAHWMsZAFmZntdUwTAs,1699
 httpbinx/routers/__init__.py,sha256=xwbZGA3-sV07HCPAly8o5uUJGbdKH3pBHUakXEjvRK4,1409
-httpbinx/routers/anything.py,sha256=KtNMHx4aEGQS6fc21YdHszorm1_gPIfpYuCkImgQFCA,564
+httpbinx/routers/anything.py,sha256=_FK1D9xEONlVIF_rvlqe_tBSsmG7ba8K_m-kGFotWWg,1923
 httpbinx/routers/auth.py,sha256=nGZA1aQtrS2B74vM2NORHSWMXf5q25JC2J63hAO2_Us,717
 httpbinx/routers/cookies.py,sha256=TB3ADXXg0kgZX5nE1QlrVk1mKXjdFAMJ7iMfd8kfMBc,2341
 httpbinx/routers/dynamicdata.py,sha256=Cas2JWkQnCaKNuE0Vw84h4YKcfl8PlsvAy6kYdvw_f4,6790
 httpbinx/routers/httpmethods.py,sha256=X9YPADi9D6FQnybJWyXc5BTDErgFZ5Xa4OIy7OKAifQ,1531
-httpbinx/routers/images.py,sha256=JBZ08Ez2gmXiGfA-jNXN3SaQzvQMmFkRrX9E0f_k3fk,2261
+httpbinx/routers/images.py,sha256=d38pKQMinCbnipaBmE0gBlYar8Kog0ZOQEaaLregLZ8,2185
 httpbinx/routers/inspection/__init__.py,sha256=OMPci9p6uK9L6uFKQKbIqOn-r5MndCWSqlw-bJsUE3E,166
 httpbinx/routers/inspection/request.py,sha256=8b5HEuX2ED-YjMB5S0h-2xZDAmyo4ru9RX2S1tCwaqs,1224
 httpbinx/routers/inspection/response.py,sha256=yJ46k1O80WO8hq4gF09KHrsQJeP7Cn0aj6AAphfyyAY,2863
@@ -24,6 +24,8 @@ httpbinx/routers/responseformats.py,sha256=sqRLzSFjUmN5B9urbMVR7X_AydqvuT1pvHGIX
 httpbinx/routers/statuscodes.py,sha256=Iu0dcGsXLv34otIrH6WrWm_vOHt-9zAnblojM-d_qV0,1740
 httpbinx/schemas.py,sha256=QxBcsd4Go1azLPWF8E_uLyUVcnzI7Rwny-woDPvAzp0,4029
 httpbinx/static/UTF-8-demo.txt,sha256=rtAgU6uoYvQ0w7ij9JbkKdw6c3q-RchO1bAmrVzhksw,14058
+httpbinx/static/bombs/bomb-1GB.br,sha256=pRVe549TQ4bzSP231INlng3sL_cGaDY6FQdaF7XtYKY,828
+httpbinx/static/bombs/bomb-1GB.gz,sha256=9k1T0WSAGsXMi3e7kH-v_U8bZHMF3sgb4jOYroJ4ymY,1019197
 httpbinx/static/favicon.png,sha256=EsETjrMhmZy6X3LgRmOr_nu6dMWYGPGQ4XH3ESebrco,1291
 httpbinx/static/images/httbinx_logo.png,sha256=wqrQoDwsMvFgXtXeHfmtTqFrnsTA94N_esLo-5yfF58,3893
 httpbinx/static/images/httpbinx_cover.png,sha256=S8UtWBtwrfOUJTxyB1KsF9BFIh2UaRI3MEaZYemgLdU,2257
@@ -34,5 +36,4 @@ httpbinx/static/images/wolf_1.webp,sha256=Vnz6-U668nnOpOsLwFxGVQIftO4ASspSwJZwnT
 httpbinx/templates/moby.html,sha256=o519fgNb4vga6kx6ARW3MYpV7xrRJFzmyrOZwUmrYw8,3962
 httpbinx/templates/sample.xml,sha256=K12JbH36KNaAaBLkfyOhsUeXc-GfLHluHffGY3l2-V0,550
 httpbinx/templates/trackingscripts.html,sha256=3E-Lg6NpBpF74H3srJuswtHfD87gNEsuVxsjm9cqIYM,625
-httpbinx/utils.py,sha256=kMVB5ORarUJj6MdySbb8utCbgyM2WbitSmiDYBAFnSs,464
-httpbinx-1.7.0.dist-info/RECORD,,
+httpbinx-1.8.0.dist-info/RECORD,,

{httpbinx-1.7.0.dist-info → httpbinx-1.8.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: pdm-backend (2.4.3)
+Generator: pdm-backend (2.4.4)
 Root-Is-Purelib: true
 Tag: py3-none-any

httpbinx/utils.py

@@ -1,15 +0,0 @@
-# -*- coding: utf-8 -*-
-from functools import lru_cache
-from os import path
-
-
-@lru_cache(maxsize=128)
-def get_templates_abspath(subdir: str = None) -> str:
-    """Return templates' folder abspath
-    TODO use Jinja2Templates
-    """
-    # os.path.join(os.getcwd(), 'httpbin', 'templates')
-    templates_abspath = path.join(path.dirname(__file__), 'templates')
-    if subdir is None:
-        return templates_abspath
-    return path.join(templates_abspath, subdir)