http-checker 1.4.0__tar.gz

http_checker-1.4.0/PKG-INFO

@@ -0,0 +1,28 @@
+Metadata-Version: 2.4
+Name: http-checker
+Version: 1.4.0
+Summary: A simple CLI tool to check the status of URLs.
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests<3.0,>=2.28
+Requires-Dist: click<9.0,>=8.0
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-mock; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: bandit; extra == "dev"
+Requires-Dist: types-requests; extra == "dev"
+Dynamic: license-file
+
+## Implementaion
+
+[x] Project files (code files)
+[x] Add simple GHA workflow and make sure it runs completion
+[x] Add linting (ruff) and format checks (black)
+[] Add typing and security checks
+[] Add test automation
+[] Build our Python project
+[] Publish the project to bet TestPyPi and PyPi when a new tag is pushed

http_checker-1.4.0/README.md

@@ -0,0 +1,9 @@
+## Implementaion
+
+[x] Project files (code files)
+[x] Add simple GHA workflow and make sure it runs completion
+[x] Add linting (ruff) and format checks (black)
+[] Add typing and security checks
+[] Add test automation
+[] Build our Python project
+[] Publish the project to bet TestPyPi and PyPi when a new tag is pushed

http_checker-1.4.0/pyproject.toml

@@ -0,0 +1,77 @@
+[build-system]
+requires = ["setuptools>=77.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "http-checker"
+version = "1.4.0"
+description = "A simple CLI tool to check the status of URLs."
+readme = "README.md"
+requires-python = ">=3.9"
+dependencies = [
+  "requests>=2.28,<3.0",
+  "click>=8.0,<9.0"
+]
+
+[project.optional-dependencies]
+dev = [
+  "pytest",
+  "pytest-mock",
+  "ruff",
+  "black",
+  "mypy",
+  "bandit",
+  "types-requests"
+]
+
+[project.scripts]
+check-urls = "http_checker.cli:main"
+
+[tool.ruff]
+line-length = 65
+
+[tool.black]
+line-length = 65
+
+[tool.mypy]
+warn_return_any = true
+warn_unused_configs = true
+ignore_missing_imports = true
+
+[tool.bandit]
+exclude_dirs = [".venv", "__pycache__", "build", "dist"]
+skips = ["B101"]
+
+[tool.pytest.ini_options]
+addopts = "-rA -s -v"
+
+[tool.semantic_release]
+version_toml = ["pyproject.toml:project.version"]
+build_command = "pip install build && python -m build"
+dist_path = "dist/"
+upload_to_pypi = false
+upload_to_release = true
+commit_message = "chore(release): {version} [skip ci]"
+
+[tool.semanctic_release.branches.master]
+match = "master"
+prerelease = false
+
+[tool.semantic_release.changelog.default_templates]
+changelog_file = "CHANGELOG.md"
+
+[tools.semanctic_release.commit_parser_options]
+allowed_tags = [
+    "build",
+    "chore",
+    "ci",
+    "docs",
+    "feat",
+    "fix",
+    "perf",
+    "style",
+    "reafactor",
+    "test"
+]
+minor_tags = ["feat"]
+patch_tags = ["fix", "perf"]

http_checker-1.4.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

http_checker-1.4.0/src/http_checker/checker.py

@@ -0,0 +1,57 @@
+import logging
+import requests
+from typing import Collection
+
+logger = logging.getLogger(__name__)
+
+
+def check_urls(
+    urls: Collection[str], timeout: int = 5
+) -> dict[str, str]:
+    """
+    Checks a list of URLs and returns their status.
+
+    Args:
+        urls: A list of URL strings to check.
+        timeout: Maximum time in seconds to wait for each request. Defaults to 5.
+
+    Returns:
+        A dictionary mapping each URL to its status string.
+    """
+
+    logger.info(
+        f"Starting check for {len(urls)} URLs with a timeout of {timeout}"
+    )
+    results: dict[str, str] = {}
+
+    for url in urls:
+        status = "UNKNOWN"
+
+        try:
+            logger.debug(f"Checking URL: {url}")
+            response = requests.get(url, timeout=timeout)
+
+            if response.ok:
+                status = f"{response.status_code} OK"
+            else:
+                status = (
+                    f"{response.status_code} {response.reason}"
+                )
+        except requests.exceptions.Timeout:
+            status = "TIMEOUT"
+            logger.warning(f"Request to {url} timed out.")
+        except requests.exceptions.ConnectionError:
+            status = "CONNECTION_ERROR"
+            logger.warning(f"Connection error for {url}.")
+        except requests.exceptions.RequestException as e:
+            status = f"REQUEST_ERROR: {type(e).__name__}"
+            logger.error(
+                f"An unexpected request error occured for {url}: {e}",
+                exc_info=True,
+            )
+
+        results[url] = status
+        logger.debug(f"Checked: {url:<40} -> {status}")
+
+    logger.info("URL check finished.")
+    return results

http_checker-1.4.0/src/http_checker/cli.py

@@ -0,0 +1,54 @@
+import logging
+import click
+from .checker import check_urls
+from typing import Collection
+
+logging.basicConfig(
+    level=logging.INFO,
+    format="[%(asctime)s] %(levelname)-8s %(name)s: %(message)s",
+    datefmt="%Y-%m-%d %H:%M:%S",
+)
+
+logger = logging.getLogger(__name__)
+
+
+@click.command()
+@click.argument("urls", nargs=-1)
+@click.option(
+    "--timeout",
+    default=5,
+    help="Timeout for each URL check in seconds.",
+)
+@click.option(
+    "--verbose",
+    "-v",
+    is_flag=True,
+    help="Enable verbose logging.",
+)
+def main(urls: Collection[str], timeout: int, verbose: bool):
+
+    if verbose:
+        logging.getLogger().setLevel(logging.DEBUG)
+        logger.debug("Verbose logging enabled.")
+
+    logger.debug(f"Received urls: {urls}")
+    logger.debug(f"Received timeout: {timeout}")
+    logger.debug(f"Received verbose flag: {verbose}")
+
+    if not urls:
+        logger.warning(
+            "No URLs provided. Please provide at least one URL to check."
+        )
+        click.echo("Usage: check-urls <URL1> <URL2> ...")
+        return
+
+    logger.info(f"Starting check for {len(urls)} URLs.")
+    results = check_urls(urls, timeout)
+
+    click.echo("\n --- Results ----")
+    for url, status in results.items():
+        if "OK" in status:
+            fg_color = "green"
+        else:
+            fg_color = "red"
+        click.secho(f"{url:<40} -> {status}", fg=fg_color)

http_checker-1.4.0/src/http_checker.egg-info/PKG-INFO

@@ -0,0 +1,28 @@
+Metadata-Version: 2.4
+Name: http-checker
+Version: 1.4.0
+Summary: A simple CLI tool to check the status of URLs.
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests<3.0,>=2.28
+Requires-Dist: click<9.0,>=8.0
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-mock; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: bandit; extra == "dev"
+Requires-Dist: types-requests; extra == "dev"
+Dynamic: license-file
+
+## Implementaion
+
+[x] Project files (code files)
+[x] Add simple GHA workflow and make sure it runs completion
+[x] Add linting (ruff) and format checks (black)
+[] Add typing and security checks
+[] Add test automation
+[] Build our Python project
+[] Publish the project to bet TestPyPi and PyPi when a new tag is pushed

http_checker-1.4.0/src/http_checker.egg-info/SOURCES.txt

@@ -0,0 +1,14 @@
+LICENSE
+README.md
+pyproject.toml
+src/http_checker/__init__.py
+src/http_checker/checker.py
+src/http_checker/cli.py
+src/http_checker.egg-info/PKG-INFO
+src/http_checker.egg-info/SOURCES.txt
+src/http_checker.egg-info/dependency_links.txt
+src/http_checker.egg-info/entry_points.txt
+src/http_checker.egg-info/requires.txt
+src/http_checker.egg-info/top_level.txt
+tests/test_checker.py
+tests/test_cli.py

http_checker-1.4.0/src/http_checker.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

http_checker-1.4.0/src/http_checker.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+check-urls = http_checker.cli:main

http_checker-1.4.0/src/http_checker.egg-info/requires.txt

@@ -0,0 +1,11 @@
+requests<3.0,>=2.28
+click<9.0,>=8.0
+
+[dev]
+pytest
+pytest-mock
+ruff
+black
+mypy
+bandit
+types-requests

http_checker-1.4.0/src/http_checker.egg-info/top_level.txt

@@ -0,0 +1 @@
+http_checker

http_checker-1.4.0/tests/test_checker.py

@@ -0,0 +1,144 @@
+import pytest
+import requests
+from pytest_mock import MockerFixture
+
+from http_checker.checker import check_urls
+
+
+def test_check_urls_success(mocker):
+    mock_requests_get = mocker.patch(
+        "http_checker.checker.requests.get"
+    )
+
+    mock_response = mocker.MagicMock(spec=requests.Response)
+    mock_response.status_code = 200
+    mock_response.reason = "OK"
+    mock_response.ok = True
+    mock_requests_get.return_value = mock_response
+
+    urls = ["https://www.example.com"]
+    results = check_urls(urls, timeout=5)
+
+    mock_requests_get.asser_called_once_with(urls[0], timeout=5)
+    assert results[urls[0]] == "200 OK"
+
+
+def test_check_urls_client_error(mocker: MockerFixture):
+    mock_requests_get = mocker.patch(
+        "http_checker.checker.requests.get"
+    )
+
+    mock_response = mocker.MagicMock(spec=requests.Response)
+    mock_response.status_code = 404
+    mock_response.reason = "Not Found"
+    mock_response.ok = False
+    mock_requests_get.return_value = mock_response
+
+    urls = ["https://www.example.com"]
+    results = check_urls(urls, timeout=5)
+
+    mock_requests_get.assert_called_once_with(urls[0], timeout=5)
+    assert results[urls[0]] == "404 Not Found"
+
+
+@pytest.mark.parametrize(
+    "error_exception, expected_status",
+    [
+        (requests.exceptions.Timeout, "TIMEOUT"),
+        (
+            requests.exceptions.ConnectionError,
+            "CONNECTION_ERROR",
+        ),
+        (
+            requests.exceptions.RequestException,
+            "REQUEST_ERROR: RequestException",
+        ),
+    ],
+)
+def test_check_urls_exceptions(
+    mocker: MockerFixture,
+    error_exception: type[requests.exceptions.RequestException],
+    expected_status: str,
+):
+    mock_requests_get = mocker.patch(
+        "http_checker.checker.requests.get"
+    )
+
+    mock_requests_get.side_effect = error_exception(
+        f"Simulated {expected_status}"
+    )
+
+    urls = ["https://www.problem.com"]
+    results = check_urls(urls, timeout=5)
+
+    mock_requests_get.asser_called_once_with(urls[0], timeout=5)
+    assert results[urls[0]] == expected_status
+
+
+def test_check_urls_with_multiple_urls(mocker: MockerFixture):
+
+    mock_requests_get = mocker.patch(
+        "http_checker.checker.requests.get"
+    )
+
+    # First call
+    mock_response_ok = mocker.MagicMock(spec=requests.Response)
+    mock_response_ok.status_code = 200
+    mock_response_ok.reason = "OK"
+    mock_response_ok.ok = True
+
+    # Second call
+    timeout_exception = requests.exceptions.Timeout(
+        "Simulated timeout"
+    )
+
+    # Third call
+    mock_response_fail = mocker.MagicMock(spec=requests.Response)
+    mock_response_fail.status_code = 500
+    mock_response_fail.reason = "Server Error"
+    mock_response_fail.ok = False
+
+    mock_requests_get.side_effect = [
+        mock_response_ok,
+        timeout_exception,
+        mock_response_fail,
+    ]
+
+    urls = [
+        "https://www.success.com",
+        "https://timeout.com",
+        "https://servererror.com",
+    ]
+    results = check_urls(urls, timeout=5)
+
+    assert len(results) == 3
+    assert mock_requests_get.call_count == 3
+    assert results["https://www.success.com"] == "200 OK"
+    assert results["https://timeout.com"] == "TIMEOUT"
+    assert (
+        results["https://servererror.com"] == "500 Server Error"
+    )
+
+
+def test_check_urls_empty():
+
+    result = check_urls([])
+    assert result == {}
+
+
+def test_check_urls_custom_timeout(mocker):
+    mock_requests_get = mocker.patch(
+        "http_checker.checker.requests.get"
+    )
+
+    mock_response = mocker.MagicMock(spec=requests.Response)
+    mock_response.status_code = 200
+    mock_response.reason = "OK"
+    mock_response.ok = True
+    mock_requests_get.return_value = mock_response
+
+    urls = ["https://www.example.com"]
+    results = check_urls(urls, timeout=10)
+
+    mock_requests_get.asser_called_once_with(urls[0], timeout=10)
+    assert results[urls[0]] == "200 OK"

http_checker-1.4.0/tests/test_cli.py

@@ -0,0 +1,28 @@
+from click.testing import CliRunner
+from pytest_mock import MockerFixture
+
+from http_checker.cli import main
+
+
+def test_no_urls():
+    runner = CliRunner()
+    result = runner.invoke(main, [])
+
+    assert result.exit_code == 0
+    assert "Usage: check-urls" in result.output
+
+
+def test_main_single_url_success(mocker: MockerFixture):
+    url = "https://www.example.com"
+    mock_check = mocker.patch("http_checker.cli.check_urls")
+    mock_check.return_value = {url: "200 OK"}
+
+    runner = CliRunner()
+    result = runner.invoke(main, [url])
+
+    assert result.exit_code == 0
+    mock_check.assert_called_once_with((url,), 5)
+
+    assert "--- Results ---" in result.output
+    assert url in result.output
+    assert "--- Results ---" in result.output