insightfactory-cli 1.0.1.dev6__tar.gz → 1.0.1.dev9__tar.gz

{insightfactory_cli-1.0.1.dev6 → insightfactory_cli-1.0.1.dev9}/CLAUDE.md

@@ -9,6 +9,7 @@ the `if-cli` executable. It uses Python 3.10+, uv, pytest, ruff, and ty.
 uv sync
 uv run pytest
 uv run ruff check .
+uv run ruff format --check .
 uv run ty check
 ```
 

{insightfactory_cli-1.0.1.dev6 → insightfactory_cli-1.0.1.dev9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: insightfactory-cli
-Version: 1.0.1.dev6
+Version: 1.0.1.dev9
 Summary: Profile-based authentication CLI for the InsightFactory Interfaces API
 Project-URL: Homepage, https://github.com/insightfactory-ai/insightfactory-cli
 Project-URL: Repository, https://github.com/insightfactory-ai/insightfactory-cli
@@ -102,6 +102,12 @@ prefixes.
 Override the config directory with `INSIGHTFACTORY_CONFIG_DIR` (useful in tests
 and CI). The default is `~/.insightfactory`.
 
+The request method goes in `-X`; `if-cli api` takes exactly one positional
+argument and reads it as the path. A `curl`-shaped `if-cli api GET /api/schedules`
+therefore parses `GET` as the path — write `if-cli api -X GET /api/schedules`
+instead. The CLI names the misplaced verb rather than reporting a problem with
+`/api/schedules`.
+
 On Git Bash (MSYS2) on Windows, path conversion rewrites a leading-slash
 argument such as `/api/agent-projects` into a Windows path. Prefix the command
 with `MSYS_NO_PATHCONV=1`:

{insightfactory_cli-1.0.1.dev6 → insightfactory_cli-1.0.1.dev9}/README.md

@@ -86,6 +86,12 @@ prefixes.
 Override the config directory with `INSIGHTFACTORY_CONFIG_DIR` (useful in tests
 and CI). The default is `~/.insightfactory`.
 
+The request method goes in `-X`; `if-cli api` takes exactly one positional
+argument and reads it as the path. A `curl`-shaped `if-cli api GET /api/schedules`
+therefore parses `GET` as the path — write `if-cli api -X GET /api/schedules`
+instead. The CLI names the misplaced verb rather than reporting a problem with
+`/api/schedules`.
+
 On Git Bash (MSYS2) on Windows, path conversion rewrites a leading-slash
 argument such as `/api/agent-projects` into a Windows path. Prefix the command
 with `MSYS_NO_PATHCONV=1`:

{insightfactory_cli-1.0.1.dev6 → insightfactory_cli-1.0.1.dev9}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "insightfactory-cli"
-version = "1.0.1.dev6"
+version = "1.0.1.dev9"
 description = "Profile-based authentication CLI for the InsightFactory Interfaces API"
 readme = "README.md"
 requires-python = ">=3.10"

{insightfactory_cli-1.0.1.dev6 → insightfactory_cli-1.0.1.dev9}/src/if_cli/commands/api.py

@@ -61,6 +61,27 @@ def describe_route(document: dict[str, Any], method: str, path: str) -> dict[str
     return operation if isinstance(operation, dict) else None
 
 
+def _is_absolute_http_url(api_path: str) -> bool:
+    parsed = parse_url(api_path)
+    return parsed.scheme in {"http", "https"} and bool(parsed.hostname)
+
+
+def _die_on_misplaced_http_method(api_path: str, positionals: list[str]) -> None:
+    """Explain a `curl`-shaped `if-cli api GET /path`, where the verb is read as the path.
+
+    Recognition spans every verb a user might reach for, not just the ones -X accepts:
+    naming the misplaced verb is more useful than a path error even for TRACE, which
+    -X then rejects on its own terms.
+    """
+    method = api_path.lower()
+    if method not in HTTP_METHODS:
+        return
+    targets = [value for value in positionals[1:] if value.startswith("/") or _is_absolute_http_url(value)]
+    target = targets[0] if targets else "/api/path"
+    suggestion = f"if-cli api -X {method.upper()} {target}"
+    die(f"'{api_path}' looks like an HTTP method, not a path — did you mean: {suggestion} ?")
+
+
 def _die_on_msys_mangled_path(api_path: str) -> None:
     if not WINDOWS_DRIVE_PATH.search(api_path):
         return
@@ -73,11 +94,6 @@ def _die_on_msys_mangled_path(api_path: str) -> None:
     )
 
 
-def _is_absolute_http_url(api_path: str) -> bool:
-    parsed = parse_url(api_path)
-    return parsed.scheme in {"http", "https"} and bool(parsed.hostname)
-
-
 def resolve_api_url(host: str, api_path: str) -> ParseResult:
     if not api_path.startswith("/") and not _is_absolute_http_url(api_path):
         _die_on_msys_mangled_path(api_path)
@@ -145,6 +161,7 @@ def api_command(argv: list[str]) -> None:
     api_path = positionals[0] if positionals else None
     if not api_path:
         die(API_USAGE)
+    _die_on_misplaced_http_method(api_path, positionals)
 
     if values["method"] is not None:
         method = values["method"].upper()

{insightfactory_cli-1.0.1.dev6 → insightfactory_cli-1.0.1.dev9}/tests/test_api.py

@@ -37,6 +37,46 @@ def test_api_rejects_unsupported_request_methods_with_a_cli_error():
     assert "unsupported request method 'TRACE'" in result.stderr
 
 
+def test_api_names_a_misplaced_http_method_instead_of_blaming_the_path():
+    result = run_cli(["api", "GET", "/api/schedules"])
+    assert result.returncode == 1
+    assert "'GET' looks like an HTTP method, not a path" in result.stderr
+    assert "did you mean: if-cli api -X GET /api/schedules ?" in result.stderr
+    assert "API path must begin with" not in result.stderr
+
+
+def test_api_detects_a_misplaced_http_method_in_any_case_and_position():
+    lowercase = run_cli(["api", "put", "/api/orchestration/run"])
+    assert lowercase.returncode == 1
+    assert "'put' looks like an HTTP method, not a path" in lowercase.stderr
+    assert "did you mean: if-cli api -X PUT /api/orchestration/run ?" in lowercase.stderr
+
+    before_profile = run_cli(["api", "DELETE", "/api/schedules/1", "-p", "example-dev"])
+    assert before_profile.returncode == 1
+    assert "did you mean: if-cli api -X DELETE /api/schedules/1 ?" in before_profile.stderr
+
+
+def test_api_keeps_a_same_origin_absolute_url_in_the_correction():
+    result = run_cli(["api", "GET", "https://factory.example/api/schedules"])
+    assert result.returncode == 1
+    assert "did you mean: if-cli api -X GET https://factory.example/api/schedules ?" in result.stderr
+
+
+def test_api_names_a_misplaced_verb_that_x_would_not_accept():
+    result = run_cli(["api", "TRACE", "/api/schedules"])
+    assert result.returncode == 1
+    assert "'TRACE' looks like an HTTP method, not a path" in result.stderr
+    assert "did you mean: if-cli api -X TRACE /api/schedules ?" in result.stderr
+    assert "API path must begin with" not in result.stderr
+
+
+def test_api_suggests_a_placeholder_path_when_only_a_method_was_supplied():
+    result = run_cli(["api", "POST"])
+    assert result.returncode == 1
+    assert "'POST' looks like an HTTP method, not a path" in result.stderr
+    assert "did you mean: if-cli api -X POST /api/path ?" in result.stderr
+
+
 def test_discovers_and_sorts_all_openapi_operations():
     assert discover_routes(OPENAPI) == [
         "DELETE  /api/agent-projects/{id}  Delete an agent project",