tornadoapi-guard 0.0.1__tar.gz

tornadoapi_guard-0.0.1/.claude/settings.local.json

@@ -0,0 +1,9 @@
+{
+  "permissions": {
+    "allow": [
+      "mcp__File_System__local___directory_tree",
+      "mcp__File_System__local___list_directory_with_sizes",
+      "mcp__File_System__local___read_text_file"
+    ]
+  }
+}

tornadoapi_guard-0.0.1/.env

@@ -0,0 +1,7 @@
+#[pypi]
+#  username = "__token__"
+#  password = "pypi-AgEIcHlwaS5vcmcCJDc4NTkzNjdhLTAxMmUtNDY5Yi1hY2U3LTdjOTUxNmU0NzllYwACFVsxLFsiZmFzdGFwaS1ndWFyZCJdXQACLFsyLFsiZGM2NmZlMjQtOTkxMS00OTY2LTkwYjYtMTcwYTA1MmFmYzczIl1dAAAGIN2LO-IWXJKPqxTFs5gR8MhtbxrXWA1qeeFeSMkVlGgm"
+
+
+
+ACC_TOKEN = "pypi-AgEIcHlwaS5vcmcCJDkzNDg2YTFkLWJhZGItNDMzYi05NjE1LTdiYzVlNTc2YWY1OAACKlszLCI5NGY2Mzg4Ni1kNTA3LTQ3NmQtYmU2ZC1hNmFmMjAyMTQxYjkiXQAABiCUeqJ2ZXW-in3fdqQ7JbADZRlI25GFaDwomTJ7KYutSA"

tornadoapi_guard-0.0.1/.github/FUNDING.yml

@@ -0,0 +1,14 @@
+# These are supported funding model platforms
+
+github: rennf93
+# patreon: # Replace with a single Patreon username
+# open_collective: # Replace with a single Open Collective username
+# ko_fi: # Replace with a single Ko-fi username
+tidelift: pypi/tornadoapi-guard
+# community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+# liberapay: # Replace with a single Liberapay username
+# issuehunt: # Replace with a single IssueHunt username
+# lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
+# polar: # Replace with a single Polar username
+# buy_me_a_coffee: # Replace with a single Buy Me a Coffee username
+custom: ['https://paypal.me/renzof93']

tornadoapi_guard-0.0.1/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,76 @@
+---
+
+name: Bug report
+about: Create a report to help us improve TornadoAPI Guard
+title: '[BUG] '
+labels: bug
+assignees: ''
+---
+
+Bug Description
+===============
+
+A clear and concise description of what the bug is.
+
+___
+
+Steps To Reproduce
+------------------
+
+Steps to reproduce the behavior:
+
+1. Configure TornadoAPI Guard with '...'
+2. Make request to endpoint '....'
+3. See error
+
+___
+
+Expected Behavior
+-----------------
+
+A clear and concise description of what you expected to happen.
+
+___
+
+Actual Behavior
+---------------
+
+What actually happened, including error messages, stack traces, or logs.
+
+___
+
+Environment
+-----------
+
+- TornadoAPI Guard version: [e.g. 0.0.1]
+- Python version: [e.g. 3.11.10]
+- Tornado version: [e.g. 6.5.5]
+- OS: [e.g. Ubuntu 22.04, Windows 11, MacOS 15.4]
+- Other relevant dependencies:
+
+___
+
+Configuration
+-------------
+
+```python
+# Include your TornadoAPI Guard configuration here
+import tornado.web
+from tornadoapi_guard import SecurityConfig
+
+# Your configuration
+security_config = SecurityConfig(
+    # Include your config here
+)
+```
+
+___
+
+Additional Context
+------------------
+
+Add any other context about the problem here. For example:
+
+- Is this happening in production or development?
+- Does it happen consistently or intermittently?
+- Have you tried any workarounds?

tornadoapi_guard-0.0.1/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: TornadoAPI Guard Documentation
+    url: https://rennf93.github.io/tornadoapi-guard/
+    about: Check the documentation for usage information and tutorials
+  - name: Usage Questions
+    url: https://github.com/rennf93/tornadoapi-guard/discussions
+    about: Please ask and answer questions in GitHub Discussions

tornadoapi_guard-0.0.1/.github/ISSUE_TEMPLATE/documentation.md

@@ -0,0 +1,53 @@
+---
+
+name: Documentation
+about: Report issues with the TornadoAPI Guard documentation or suggest improvements
+title: '[DOCS] '
+labels: documentation
+assignees: ''
+---
+
+Documentation Issue
+===================
+
+Describe the issue or improvement needed for the documentation.
+
+___
+
+Current Documentation
+---------------------
+
+Link to the current documentation page or section that needs improvement:
+[Link it here](https://example.com)
+
+___
+
+Suggested Changes
+-----------------
+
+Describe what changes you suggest:
+
+- [ ] Clarify existing content
+- [ ] Add missing information
+- [ ] Fix incorrect information
+- [ ] Improve examples
+- [ ] Fix typos/grammar
+- [ ] Other (please specify)
+
+___
+
+Proposed Text
+-------------
+
+If you have a specific suggestion for new text, please provide it here:
+
+```markdown
+# Your proposed documentation text here
+```
+
+___
+
+Additional Context
+------------------
+
+Any other information or screenshots about the documentation issue.

tornadoapi_guard-0.0.1/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,56 @@
+---
+
+name: Feature request
+about: Suggest an idea for TornadoAPI Guard
+title: '[FEATURE] '
+labels: enhancement
+assignees: ''
+---
+
+Is your feature request related to a problem
+=============================================
+
+A clear and concise description of what the problem is. Ex. I'm always facing issues when [...]
+
+___
+
+Describe the solution you'd like
+---------------------------------
+
+A clear and concise description of what you want to happen. Include any API design ideas or examples of how you'd like to use this feature.
+
+___
+
+Describe alternatives you've considered
+---------------------------------------
+
+A clear and concise description of any alternative solutions or features you've considered.
+
+___
+
+Example Implementation
+----------------------
+
+If possible, provide a pseudocode example of how this feature might be implemented or used:
+
+```python
+# Example code showing how you'd like to use this feature
+import tornado.web
+from tornadoapi_guard import SecurityConfig
+
+# Your feature example here
+security_config = SecurityConfig(
+    new_feature=SomeConfiguration(...)
+)
+```
+
+___
+
+Additional context
+------------------
+
+Add any other context or screenshots about the feature request here:
+
+- How would this benefit the community?
+- Are there similar implementations in other libraries that could be referenced?
+- Would this require changes to existing APIs?

tornadoapi_guard-0.0.1/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,66 @@
+Description
+===========
+
+<!--- Describe your changes in detail -->
+
+___
+
+Related Issue
+-------------
+
+<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
+<!--- Please link to the issue here: -->
+Fixes #
+
+___
+
+Motivation and Context
+----------------------
+
+<!--- Why is this change required? What problem does it solve? -->
+<!--- If adding a new feature, please describe the motivation for it -->
+
+___
+
+Type of change
+--------------
+
+<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to change)
+- [ ] Documentation change
+- [ ] Performance improvement
+- [ ] Code cleanup or refactoring
+
+___
+
+How Has This Been Tested
+-------------------------
+
+<!--- Please describe in detail how you tested your changes. -->
+<!--- Include details of your testing environment, and the tests you ran to -->
+<!--- see how your change affects other areas of the code, etc. -->
+
+___
+
+Screenshots (if appropriate)
+-----------------------------
+
+___
+
+Checklist
+---------
+
+<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
+<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
+
+- [ ] My code follows the code style of this project (Mypy, Ruff)
+- [ ] I have added tests to cover my changes
+- [ ] All new and existing tests passed
+- [ ] My change requires a change to the documentation
+- [ ] I have updated the documentation accordingly
+- [ ] I have checked that my changes don't introduce any new warnings or errors
+- [ ] I have updated the version number if necessary
+- [ ] I have added any new dependencies to the appropriate requirements file

tornadoapi_guard-0.0.1/.github/dependabot.yml

@@ -0,0 +1,17 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    groups:
+      dependencies:
+        patterns:
+          - "*"
+    allow:
+      - dependency-type: "all"

tornadoapi_guard-0.0.1/.github/scripts/bump_version.py

@@ -0,0 +1,146 @@
+"""
+Version bump helper script for tornadoapi-guard.
+
+Updates the version string across all files that reference it:
+- pyproject.toml
+- CHANGELOG.md
+- docs/release-notes.md
+
+Usage:
+    python .github/scripts/bump_version.py <version>
+    make bump-version VERSION=x.y.z
+
+No external dependencies required — stdlib only.
+"""
+
+from __future__ import annotations
+
+import re
+import sys
+from collections.abc import Callable
+from datetime import datetime, timezone
+from pathlib import Path
+
+# Resolve project root relative to this script's location
+PROJECT_ROOT = Path(__file__).resolve().parent.parent.parent
+
+VERSION_PATTERN = re.compile(r"^\d+\.\d+\.\d+$")
+
+
+def parse_semver(version: str) -> tuple[int, ...]:
+    """Parse a semver string into a comparable tuple."""
+    return tuple(int(part) for part in version.split("."))
+
+
+def update_pyproject_toml(version: str) -> bool:
+    """Update version in pyproject.toml."""
+    path = PROJECT_ROOT / "pyproject.toml"
+    content = path.read_text()
+    pattern = re.compile(r'^(version\s*=\s*)"[^"]*"', re.MULTILINE)
+    match = pattern.search(content)
+    if not match:
+        print("  ERROR: Could not find version field in pyproject.toml")
+        return False
+    current = re.search(r'"([^"]*)"', match.group(0))
+    if current and current.group(1) == version:
+        print(f"  pyproject.toml: already set to {version}")
+        return True
+    new_content = pattern.sub(f'{match.group(1)}"{version}"', content)
+    path.write_text(new_content)
+    print(f"  pyproject.toml: updated to {version}")
+    return True
+
+
+def _insert_changelog_scaffold(path: Path, version: str, label: str) -> bool:
+    """Insert a version scaffold block into a changelog file."""
+    content = path.read_text()
+    today = datetime.now(tz=timezone.utc).strftime("%Y-%m-%d")
+    header = f"v{version} ({today})"
+
+    # Check if this version already has an entry
+    if f"v{version} (" in content:
+        print(f"  {label}: v{version} entry already exists")
+        return True
+
+    scaffold = (
+        f"{header}\n"
+        f"-------------------\n"
+        f"\n"
+        f"TITLE (v{version})\n"
+        f"------------\n"
+        f"\n"
+        f"CONTENT\n"
+        f"\n"
+        f"___\n"
+        f"\n"
+    )
+
+    # Find the first existing version entry to insert before it
+    version_header_pattern = re.compile(r"^v\d+\.\d+\.\d+ \(", re.MULTILINE)
+    match = version_header_pattern.search(content)
+    if match:
+        insert_pos = match.start()
+        new_content = content[:insert_pos] + scaffold + content[insert_pos:]
+    else:
+        # No existing entries — append at end
+        new_content = content.rstrip() + "\n\n" + scaffold
+
+    path.write_text(new_content)
+    print(f"  {label}: added v{version} scaffold")
+    return True
+
+
+def update_changelogs(version: str) -> bool:
+    """Update CHANGELOG.md and docs/release-notes.md."""
+    changelog = PROJECT_ROOT / "CHANGELOG.md"
+    release_notes = PROJECT_ROOT / "docs" / "release-notes.md"
+
+    ok = True
+    ok = _insert_changelog_scaffold(changelog, version, "CHANGELOG.md") and ok
+    if release_notes.exists():
+        ok = (
+            _insert_changelog_scaffold(release_notes, version, "docs/release-notes.md")
+            and ok
+        )
+    return ok
+
+
+def main() -> int:
+    if len(sys.argv) != 2:
+        print("Usage: bump_version.py <version>")
+        print("  version must be in X.Y.Z format")
+        return 1
+
+    version = sys.argv[1]
+
+    if not VERSION_PATTERN.match(version):
+        print(f"Error: '{version}' is not a valid version. Expected format: X.Y.Z")
+        return 1
+
+    print(f"Bumping version to {version}...\n")
+
+    updaters: list[tuple[str, Callable[[str], bool]]] = [
+        ("pyproject.toml", update_pyproject_toml),
+        ("changelogs", update_changelogs),
+    ]
+
+    all_ok = True
+    for name, updater in updaters:
+        try:
+            if not updater(version):
+                print(f"\n  FAILED: {name}")
+                all_ok = False
+        except Exception as e:
+            print(f"\n  ERROR updating {name}: {e}")
+            all_ok = False
+
+    print()
+    if all_ok:
+        print("Version bump complete.")
+    else:
+        print("Version bump completed with errors.")
+    return 0 if all_ok else 1
+
+
+if __name__ == "__main__":
+    sys.exit(main())

tornadoapi_guard-0.0.1/.github/workflows/ci.yml

@@ -0,0 +1,178 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - master
+    paths:
+      - 'compose.yml'
+      - 'data/**'
+      - 'Dockerfile'
+      - 'examples/**'
+      - 'tornadoapi_guard/**'
+      - 'mypy.ini'
+      - '.pre-commit-config.yaml'
+      - 'pyproject.toml'
+      - 'pytest.ini'
+      - 'setup.py'
+      - 'tests/**'
+  pull_request_target:
+    branches:
+      - master
+    paths:
+      - 'compose.yml'
+      - 'data/**'
+      - 'Dockerfile'
+      - 'examples/**'
+      - 'tornadoapi_guard/**'
+      - 'mypy.ini'
+      - '.pre-commit-config.yaml'
+      - 'pyproject.toml'
+      - 'pytest.ini'
+      - 'setup.py'
+      - 'tests/**'
+  workflow_dispatch:
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
+        with:
+          python-version: '3.10'
+      - run: pip install uv
+      - run: uv sync --extra dev
+      - run: uv run pre-commit run --all-files
+
+  test:
+    runs-on: ubuntu-latest
+
+    services:
+      redis:
+        image: redis
+        ports:
+          - 6379:6379
+        options: >-
+          --health-cmd "redis-cli ping"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+
+    permissions:
+      pull-requests: write
+
+    strategy:
+      matrix:
+        python-version: ['3.10', '3.11', '3.12', '3.13', '3.14']
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v6
+
+      - name: Send Initial Slack Message
+        id: send_initial_slack_ci
+        uses: rennf93/good-comms@master
+        with:
+          SLACK_WEBHOOK: '${{ secrets.SLACK_WEBHOOK }}'
+          SLACK_TOKEN: ${{ secrets.SLACK_TOKEN }}
+          STATUS: 'Started'
+          CHANNEL_ID: '${{ secrets.SLACK_CHANNEL }}'
+          AUTHOR_NAME: 'TornadoAPI Guard - CI & Tests - Py${{ matrix.python-version }}'
+          AUTHOR_LINK: 'https://github.com/rennf93/tornadoapi-guard'
+          AUTHOR_ICON: ':test_tube:'
+          TITLE: 'CI & Tests Started - Py${{ matrix.python-version }}'
+          TITLE_LINK: 'https://github.com/rennf93/tornadoapi-guard/actions'
+          MESSAGE: |
+            .
+            *CI & TESTS TRIGGERED!*
+
+            .
+            Matrix:
+              Python: ${{ matrix.python-version }}
+
+            Docs version:
+              ${{ secrets.DOCS_VERSION }}
+
+            Commit:
+              ${{ github.event.head_commit.message }}
+            .
+          COLOR: warning
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install uv
+        run: |
+          pip install uv
+
+      - name: Install dependencies
+        run: |
+          uv sync --extra dev
+
+      - name: Run tests
+        run: |
+          IPINFO_TOKEN='${{ secrets.IPINFO_TOKEN }}' REDIS_URL='redis://localhost:6379' REDIS_PREFIX='test:tornadoapi_guard:' uv run pytest -v --cov=tornadoapi_guard
+
+      - name: Notify Success on Slack Channel
+        uses: rennf93/good-comms@master
+        with:
+          SLACK_WEBHOOK: '${{ secrets.SLACK_WEBHOOK }}'
+          SLACK_TOKEN: ${{ secrets.SLACK_TOKEN }}
+          STATUS: 'Success'
+          CHANNEL_ID: '${{ secrets.SLACK_CHANNEL }}'
+          AUTHOR_NAME: 'TornadoAPI Guard - CI & Tests - Py${{ matrix.python-version }}'
+          AUTHOR_LINK: 'https://github.com/rennf93/tornadoapi-guard'
+          AUTHOR_ICON: ':gem:'
+          TITLE: 'CI & Tests Successful - Py${{ matrix.python-version }}'
+          TITLE_LINK: 'https://github.com/rennf93/tornadoapi-guard/actions'
+          MESSAGE: |
+            .
+            Matrix:
+              Python: ${{ matrix.python-version }}
+
+            Docs version:
+              ${{ secrets.DOCS_VERSION }}
+
+            Commit message:
+              ${{ github.event.head_commit.message }}
+
+            Commit URL:
+              ${{ github.event.head_commit.url }}
+            .
+          COLOR: good
+          SLACK_THREAD_TS: ${{ steps.send_initial_slack_ci.outputs.SLACK_THREAD_TS }}
+
+      - name: Send Failure Notification to Slack
+        if: failure()
+        uses: rennf93/good-comms@master
+        with:
+          SLACK_WEBHOOK: '${{ secrets.SLACK_WEBHOOK }}'
+          SLACK_TOKEN: ${{ secrets.SLACK_TOKEN }}
+          STATUS: 'Failed'
+          CHANNEL_ID: '${{ secrets.SLACK_CHANNEL }}'
+          AUTHOR_NAME: 'TornadoAPI Guard - CI & Tests - Py${{ matrix.python-version }}'
+          AUTHOR_LINK: 'https://github.com/rennf93/tornadoapi-guard'
+          AUTHOR_ICON: ':skull:'
+          TITLE: 'CI & Tests Failed - Py${{ matrix.python-version }}'
+          TITLE_LINK: 'https://github.com/rennf93/tornadoapi-guard/actions'
+          MESSAGE: |
+            .
+            Matrix:
+              Python: ${{ matrix.python-version }}
+
+            Docs version:
+              ${{ secrets.DOCS_VERSION }}
+
+            CI & Tests failed for commit:
+              ${{ github.event.head_commit.message }}
+
+            Commit URL:
+              ${{ github.event.head_commit.url }}
+
+            Please check the logs for more details.
+            .
+          COLOR: danger
+          SLACK_THREAD_TS: ${{ steps.send_initial_slack_ci.outputs.SLACK_THREAD_TS }}