getred 0.1.4__tar.gz → 0.1.6__tar.gz

getred-0.1.6/AGENTS.md

@@ -0,0 +1,31 @@
+# Repository Guidelines
+
+## Project Structure & Module Organization
+- `src/getred/`: Python package (CLI + fetch/parse/save pipeline)
+  - `cli.py` (Click entrypoint), `fetcher.py` (httpx client), `parser.py`, `models.py`, `utils.py`
+- `tests/`: pytest suite and fixtures (`tests/conftest.py`)
+- `pyproject.toml`: packaging (hatchling), dependencies, and pytest config
+- `.github/workflows/`: CI (PR tests, version bump check, publish)
+
+## Build, Test, and Development Commands
+- Create a venv: `python -m venv .venv && source .venv/bin/activate`
+- Install (editable + tests): `python -m pip install -U pip && python -m pip install -e ".[test]"`
+- Run locally: `getred "<thread_url>"` or `python -m getred "<thread_url>"`
+- Run tests: `pytest`
+- Build artifacts (sdist/wheel): `python -m pip install build && python -m build`
+
+## Coding Style & Naming Conventions
+- Python 3.12+ (CI uses 3.12); keep code compatible with the declared minimum.
+- 4-space indentation, PEP 8, and small focused functions.
+- Naming: `snake_case` (functions/vars), `PascalCase` (classes), `UPPER_SNAKE_CASE` (constants).
+- Prefer `pathlib.Path` for file paths and keep dependencies minimal (edit `pyproject.toml`).
+
+## Testing Guidelines
+- Use pytest; keep tests in `tests/` and name files `test_*.py`.
+- Prefer deterministic tests: avoid live Reddit calls (mock httpx or use fixtures).
+- Add/adjust tests alongside behavior changes (parser edge-cases, URL validation, output shape).
+
+## Commit & Pull Request Guidelines
+- Commit messages follow a Conventional Commits-style prefix used in this repo: `feat: ...`, `fix: ...`, `docs: ...`, `chore: ...`, `cicd: ...`.
+- PRs should include: what changed, why, how to test (`pytest`), and any user-facing CLI/output changes.
+- Versioning: PRs to `master` must bump `version = "..."` in `pyproject.toml` (CI enforces this); keep other version strings (e.g. `src/getred/__init__.py#__version__`) consistent when releasing.

{getred-0.1.4 → getred-0.1.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: getred
-Version: 0.1.4
+Version: 0.1.6
 Summary: A CLI tool to fetch Reddit threads and save them as structured JSON
 Project-URL: Homepage, https://github.com/mgelei/getred
 Project-URL: Issues, https://github.com/mgelei/getred/issues

{getred-0.1.4 → getred-0.1.6}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "getred"
-version = "0.1.4"
+version = "0.1.6"
 description = "A CLI tool to fetch Reddit threads and save them as structured JSON"
 readme = "README.md"
 requires-python = ">=3.8"

getred-0.1.6/src/getred/fetcher.py

@@ -0,0 +1,71 @@
+"""HTTP client for fetching Reddit data."""
+
+from __future__ import annotations
+
+from typing import Any, Dict, Optional
+from urllib.parse import urlsplit, urlunsplit
+
+import httpx
+
+
+class RedditFetcher:
+    """Fetches Reddit thread data using the public JSON API."""
+
+    USER_AGENT = "getred/0.1.0 (Reddit Thread Fetcher CLI)"
+    TIMEOUT = 30.0
+
+    def __init__(self, transport: Optional[httpx.BaseTransport] = None):
+        """Initialize the fetcher with custom headers."""
+        self.headers = {
+            "User-Agent": self.USER_AGENT
+        }
+        self._transport = transport
+
+    @staticmethod
+    def _build_json_url(url: str) -> str:
+        """
+        Construct a Reddit .json endpoint URL from a thread URL.
+
+        - Preserves query parameters
+        - Avoids double-appending .json
+        - Drops fragments
+        """
+        parts = urlsplit(url)
+
+        path = parts.path or "/"
+        if not path.endswith(".json"):
+            path = path + ".json"
+
+        return urlunsplit((parts.scheme, parts.netloc, path, parts.query, ""))
+
+    def fetch_thread(self, url: str) -> Dict[str, Any]:
+        """
+        Fetch a Reddit thread as JSON.
+
+        Args:
+            url: Reddit thread URL (will be converted to JSON endpoint)
+
+        Returns:
+            Dict containing Reddit API response
+
+        Raises:
+            httpx.HTTPError: If request fails
+        """
+        json_url = self._build_json_url(url)
+
+        with httpx.Client(
+            headers=self.headers,
+            timeout=self.TIMEOUT,
+            follow_redirects=True,
+            transport=self._transport,
+        ) as client:
+            response = client.get(json_url)
+            response.raise_for_status()
+            try:
+                return response.json()
+            except ValueError as e:
+                content_type = response.headers.get("Content-Type", "<missing>")
+                raise ValueError(
+                    f"Non-JSON response from Reddit endpoint "
+                    f"(url={response.url!s}, status={response.status_code}, content_type={content_type})"
+                ) from e

{getred-0.1.4 → getred-0.1.6}/src/getred/utils.py

@@ -16,7 +16,7 @@ def validate_reddit_url(url: str) -> bool:
     Returns:
         True if valid Reddit thread URL, False otherwise
     """
-    pattern = r'^https?://(www\.)?reddit\.com/r/[^/]+/comments/[^/]+/'
+    pattern = r'^https?://(www\.)?reddit\.com/r/[^/]+/comments/[^/]+(?:[/?#]|$)'
     return bool(re.match(pattern, url))
 
 

getred-0.1.6/tests/test_fetcher.py

@@ -0,0 +1,115 @@
+"""Tests for RedditFetcher URL handling and redirect safety."""
+
+import httpx
+import pytest
+
+from getred.fetcher import RedditFetcher
+
+
+def test_fetch_thread_preserves_query_params():
+    seen_urls: list[str] = []
+
+    def handler(request: httpx.Request) -> httpx.Response:
+        seen_urls.append(str(request.url))
+        return httpx.Response(200, json=[{"ok": True}], request=request)
+
+    fetcher = RedditFetcher(transport=httpx.MockTransport(handler))
+
+    url = "https://www.reddit.com/r/python/comments/abc123/cool_title/?sort=top"
+    data = fetcher.fetch_thread(url)
+
+    assert data == [{"ok": True}]
+    assert seen_urls == [
+        "https://www.reddit.com/r/python/comments/abc123/cool_title/.json?sort=top"
+    ]
+
+
+def test_fetch_thread_does_not_double_append_json():
+    seen_urls: list[str] = []
+
+    def handler(request: httpx.Request) -> httpx.Response:
+        seen_urls.append(str(request.url))
+        return httpx.Response(200, json={"ok": True}, request=request)
+
+    fetcher = RedditFetcher(transport=httpx.MockTransport(handler))
+
+    url = "https://www.reddit.com/r/python/comments/abc123/cool_title/.json?sort=top"
+    data = fetcher.fetch_thread(url)
+
+    assert data == {"ok": True}
+    assert seen_urls == [url]
+
+
+@pytest.mark.parametrize(
+    ("input_url", "expected_json_url"),
+    [
+        (
+            "https://www.reddit.com/r/python/comments/abc123/cool_title/",
+            "https://www.reddit.com/r/python/comments/abc123/cool_title/.json",
+        ),
+        (
+            "https://www.reddit.com/r/python/comments/abc123/cool_title",
+            "https://www.reddit.com/r/python/comments/abc123/cool_title.json",
+        ),
+    ],
+)
+def test_fetch_thread_trailing_slash_variants(input_url: str, expected_json_url: str):
+    seen_urls: list[str] = []
+
+    def handler(request: httpx.Request) -> httpx.Response:
+        seen_urls.append(str(request.url))
+        return httpx.Response(200, json={"ok": True}, request=request)
+
+    fetcher = RedditFetcher(transport=httpx.MockTransport(handler))
+    assert fetcher.fetch_thread(input_url) == {"ok": True}
+    assert seen_urls == [expected_json_url]
+
+
+def test_fetch_thread_follows_redirects():
+    seen_urls: list[str] = []
+
+    redirected_to = (
+        "https://www.reddit.com/r/python/comments/abc123/cool_title/.json?sort=top"
+    )
+
+    def handler(request: httpx.Request) -> httpx.Response:
+        seen_urls.append(str(request.url))
+        if len(seen_urls) == 1:
+            return httpx.Response(
+                302,
+                headers={"Location": redirected_to},
+                request=request,
+            )
+        return httpx.Response(200, json={"ok": True}, request=request)
+
+    fetcher = RedditFetcher(transport=httpx.MockTransport(handler))
+
+    url = "https://reddit.com/r/python/comments/abc123/cool_title/?sort=top"
+    data = fetcher.fetch_thread(url)
+
+    assert data == {"ok": True}
+    assert seen_urls == [
+        "https://reddit.com/r/python/comments/abc123/cool_title/.json?sort=top",
+        redirected_to,
+    ]
+
+
+def test_fetch_thread_non_json_body_raises_clear_error():
+    def handler(request: httpx.Request) -> httpx.Response:
+        return httpx.Response(
+            200,
+            headers={"Content-Type": "text/html"},
+            content=b"<html>not json</html>",
+            request=request,
+        )
+
+    fetcher = RedditFetcher(transport=httpx.MockTransport(handler))
+
+    url = "https://www.reddit.com/r/python/comments/abc123/cool_title/"
+    with pytest.raises(ValueError) as excinfo:
+        fetcher.fetch_thread(url)
+
+    message = str(excinfo.value)
+    assert "Non-JSON response" in message
+    assert "content_type=text/html" in message
+

{getred-0.1.4 → getred-0.1.6}/tests/test_utils.py

@@ -14,6 +14,7 @@ class TestValidateRedditUrl:
             "https://www.reddit.com/r/python/comments/abc123/cool_title/",
             "http://reddit.com/r/AskReddit/comments/xyz789/interesting_question/",
             "https://reddit.com/r/programming/comments/test123/test/extra/path/",
+            "https://reddit.com/r/python/comments/abc123/cool_title",
         ]
         for url in valid_urls:
             assert validate_reddit_url(url), f"Expected {url} to be valid"

getred-0.1.4/src/getred/fetcher.py

@@ -1,38 +0,0 @@
-"""HTTP client for fetching Reddit data."""
-
-import httpx
-from typing import Dict, Any
-
-
-class RedditFetcher:
-    """Fetches Reddit thread data using the public JSON API."""
-
-    USER_AGENT = "getred/0.1.0 (Reddit Thread Fetcher CLI)"
-    TIMEOUT = 30.0
-
-    def __init__(self):
-        """Initialize the fetcher with custom headers."""
-        self.headers = {
-            "User-Agent": self.USER_AGENT
-        }
-
-    def fetch_thread(self, url: str) -> Dict[str, Any]:
-        """
-        Fetch a Reddit thread as JSON.
-
-        Args:
-            url: Reddit thread URL (will be converted to JSON endpoint)
-
-        Returns:
-            Dict containing Reddit API response
-
-        Raises:
-            httpx.HTTPError: If request fails
-        """
-        # Ensure URL ends with .json
-        json_url = url.rstrip('/') + '.json'
-
-        with httpx.Client(headers=self.headers, timeout=self.TIMEOUT) as client:
-            response = client.get(json_url)
-            response.raise_for_status()
-            return response.json()