runspec-gitlab-core 0.1.0__tar.gz → 0.2.0__tar.gz

{runspec_gitlab_core-0.1.0 → runspec_gitlab_core-0.2.0}/CHANGELOG.md

@@ -2,6 +2,23 @@
 
 All notable changes to `runspec-gitlab-core` are documented here.
 
+## [0.2.0]
+
+Reconciled against GitLab's canonical MCP tool set.
+
+- **Renamed** `get_merge_request_changes` → `get_merge_request_diffs` — the
+  canonical name; targets the paginated `/diffs` endpoint instead of the
+  deprecated `/changes`. **Breaking** API change vs 0.1.0.
+- **Added** read helpers: `get_merge_request_commits`, `get_merge_request_notes`,
+  `get_merge_request_pipelines`, `get_merge_request_conflicts`, and
+  `resolve_project_path`.
+- `gitlab_request` gains an `api=False` mode to target `{base_url}{path}` (no
+  `/api/v4` prefix) — used only for the non-public MR conflicts web endpoint.
+- `get_merge_request_conflicts` is **best-effort**: it relays GitLab's
+  non-public web-UI conflicts endpoint (there is no public `/api/v4` one) and
+  returns its JSON verbatim, resolving a numeric project id to its
+  `namespace/path` via `resolve_project_path`.
+
 ## [0.1.0]
 
 Initial release. Pure-Python GitLab REST (v4) read helpers — the importable core

{runspec_gitlab_core-0.1.0 → runspec_gitlab_core-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: runspec-gitlab-core
-Version: 0.1.0
+Version: 0.2.0
 Summary: Pure-Python GitLab REST helpers — the importable core behind runspec-gitlab (no runspec dependency, no runnables)
 Requires-Python: >=3.10
 Requires-Dist: httpx

{runspec_gitlab_core-0.1.0 → runspec_gitlab_core-0.2.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "runspec-gitlab-core"
-version = "0.1.0"
+version = "0.2.0"
 requires-python = ">=3.10"
 description = "Pure-Python GitLab REST helpers — the importable core behind runspec-gitlab (no runspec dependency, no runnables)"
 dependencies = [

{runspec_gitlab_core-0.1.0 → runspec_gitlab_core-0.2.0}/runspec_gitlab_core/__init__.py

@@ -26,11 +26,15 @@ from runspec_gitlab_core.client import (
 from runspec_gitlab_core.issues import get_issue, list_issues
 from runspec_gitlab_core.merge_requests import (
     get_merge_request,
-    get_merge_request_changes,
+    get_merge_request_commits,
+    get_merge_request_conflicts,
+    get_merge_request_diffs,
+    get_merge_request_notes,
+    get_merge_request_pipelines,
     list_merge_requests,
 )
 from runspec_gitlab_core.pipelines import get_job_log, get_pipeline_jobs, list_pipelines
-from runspec_gitlab_core.projects import get_project, search_projects, whoami
+from runspec_gitlab_core.projects import get_project, resolve_project_path, search_projects, whoami
 from runspec_gitlab_core.repository import get_file, list_tree
 
 __all__ = [
@@ -40,6 +44,7 @@ __all__ = [
     "config_from_env",
     "gitlab_request",
     "encode_project",
+    "resolve_project_path",
     "VALID_ENVS",
     "DEFAULT_URL",
     # identity / projects
@@ -52,7 +57,11 @@ __all__ = [
     # merge requests
     "list_merge_requests",
     "get_merge_request",
-    "get_merge_request_changes",
+    "get_merge_request_diffs",
+    "get_merge_request_commits",
+    "get_merge_request_notes",
+    "get_merge_request_pipelines",
+    "get_merge_request_conflicts",
     # pipelines / jobs
     "list_pipelines",
     "get_pipeline_jobs",

{runspec_gitlab_core-0.1.0 → runspec_gitlab_core-0.2.0}/runspec_gitlab_core/client.py

@@ -111,10 +111,16 @@ def gitlab_request(
     config: GitlabConfig,
     params: dict[str, Any] | None = None,
     raw: bool = False,
+    api: bool = True,
     timeout: int = 30,
 ) -> Any:
-    """Make an authenticated request against ``{base_url}/api/v4`` and return the
-    parsed JSON body (or the raw text when ``raw=True`` — used for job traces).
+    """Make an authenticated request and return the parsed JSON body (or the raw
+    text when ``raw=True`` — used for job traces).
+
+    By default the request targets the public REST API at ``{base_url}/api/v4``.
+    Pass ``api=False`` to hit ``{base_url}{path}`` directly — used only for the
+    non-public web endpoints GitLab does not expose under ``/api/v4`` (e.g. the
+    merge-request conflicts endpoint).
 
     ``path`` should start with ``/`` (e.g. ``/projects/1/issues``). ``None`` values
     in ``params`` are dropped and booleans are rendered as ``"true"``/``"false"``.
@@ -133,9 +139,10 @@ def gitlab_request(
                 continue
             clean[key] = "true" if value is True else "false" if value is False else value
 
+    prefix = "/api/v4" if api else ""
     resp = httpx.request(
         method,
-        f"{config.base_url}/api/v4{path}",
+        f"{config.base_url}{prefix}{path}",
         headers=headers,
         params=clean,
         timeout=timeout,

runspec_gitlab_core-0.2.0/runspec_gitlab_core/merge_requests.py

@@ -0,0 +1,127 @@
+"""merge_requests.py — merge-request read operations (GitLab REST v4)."""
+
+from __future__ import annotations
+
+from typing import Any
+
+from runspec_gitlab_core.client import GitlabConfig, gitlab_request
+from runspec_gitlab_core.projects import _project, resolve_project_path
+
+
+def list_merge_requests(
+    config: GitlabConfig,
+    project: str | None = None,
+    state: str | None = None,
+    per_page: int = 20,
+    page: int = 1,
+) -> list[dict[str, Any]]:
+    """List a project's merge requests.
+
+    ``state`` is ``opened``/``closed``/``merged``/``locked``/``all``.
+    """
+    return gitlab_request(
+        "GET",
+        f"/projects/{_project(config, project)}/merge_requests",
+        config=config,
+        params={"state": state, "per_page": per_page, "page": page},
+    )
+
+
+def get_merge_request(config: GitlabConfig, mr_iid: int, project: str | None = None) -> dict[str, Any]:
+    """Fetch a single merge request by its project-scoped internal id (``iid``)."""
+    return gitlab_request(
+        "GET",
+        f"/projects/{_project(config, project)}/merge_requests/{mr_iid}",
+        config=config,
+    )
+
+
+def get_merge_request_diffs(
+    config: GitlabConfig,
+    mr_iid: int,
+    project: str | None = None,
+    per_page: int = 20,
+    page: int = 1,
+) -> list[dict[str, Any]]:
+    """List a merge request's file diffs.
+
+    Mirrors the canonical ``get_merge_request_diffs`` MCP tool — the paginated
+    ``/merge_requests/:iid/diffs`` endpoint, not the deprecated ``/changes``.
+    """
+    return gitlab_request(
+        "GET",
+        f"/projects/{_project(config, project)}/merge_requests/{mr_iid}/diffs",
+        config=config,
+        params={"per_page": per_page, "page": page},
+    )
+
+
+def get_merge_request_commits(
+    config: GitlabConfig,
+    mr_iid: int,
+    project: str | None = None,
+    per_page: int = 20,
+    page: int = 1,
+) -> list[dict[str, Any]]:
+    """List the commits on a merge request (canonical ``get_merge_request_commits``)."""
+    return gitlab_request(
+        "GET",
+        f"/projects/{_project(config, project)}/merge_requests/{mr_iid}/commits",
+        config=config,
+        params={"per_page": per_page, "page": page},
+    )
+
+
+def get_merge_request_notes(
+    config: GitlabConfig,
+    mr_iid: int,
+    project: str | None = None,
+    sort: str | None = None,
+    per_page: int = 20,
+    page: int = 1,
+) -> list[dict[str, Any]]:
+    """List a merge request's notes (comments) — the REST equivalent of the
+    canonical ``get_merge_request_notes`` tool. ``sort`` is ``asc``/``desc``."""
+    return gitlab_request(
+        "GET",
+        f"/projects/{_project(config, project)}/merge_requests/{mr_iid}/notes",
+        config=config,
+        params={"sort": sort, "per_page": per_page, "page": page},
+    )
+
+
+def get_merge_request_pipelines(
+    config: GitlabConfig,
+    mr_iid: int,
+    project: str | None = None,
+    per_page: int = 20,
+    page: int = 1,
+) -> list[dict[str, Any]]:
+    """List the pipelines run for a merge request (canonical ``get_merge_request_pipelines``)."""
+    return gitlab_request(
+        "GET",
+        f"/projects/{_project(config, project)}/merge_requests/{mr_iid}/pipelines",
+        config=config,
+        params={"per_page": per_page, "page": page},
+    )
+
+
+def get_merge_request_conflicts(config: GitlabConfig, mr_iid: int, project: str | None = None) -> Any:
+    """Fetch a merge request's conflict files (the canonical ``get_merge_request_conflicts``).
+
+    **Best-effort — not a public REST API.** GitLab exposes MR conflict *contents*
+    only through its web-UI endpoint (``{base}/{namespace}/{project}/-/merge_requests/
+    :iid/conflicts``), not under ``/api/v4``; the MCP server's own tool calls an
+    internal service in-process. This relays that endpoint's JSON verbatim (files
+    with conflict markers/sections), so its shape is GitLab's, not ours, and may
+    change between versions. Requires a token with read access to the MR (and,
+    per GitLab, push access to the source branch). A non-conflicting or
+    unmergeable MR typically yields a non-2xx surfaced as :class:`GitlabError`.
+    """
+    path = resolve_project_path(config, project)
+    return gitlab_request(
+        "GET",
+        f"/{path}/-/merge_requests/{mr_iid}/conflicts",
+        config=config,
+        api=False,
+    )

{runspec_gitlab_core-0.1.0 → runspec_gitlab_core-0.2.0}/runspec_gitlab_core/projects.py

@@ -16,6 +16,25 @@ def _project(config: GitlabConfig, project: str | None) -> str:
     return encode_project(target)
 
 
+def resolve_project_path(config: GitlabConfig, project: str | None = None) -> str:
+    """Resolve the target project to its ``namespace/path`` form for non-API web
+    endpoints (which need real slashes, not a numeric id or a %2F-encoded path).
+
+    A numeric id is resolved to ``path_with_namespace`` via one API call; a path
+    is returned as-is.
+    """
+    target = project or config.project
+    if not target:
+        raise GitlabError("No project — pass project or set it on the config (GITLAB_PROJECT)")
+    target = str(target)
+    if target.isdigit():
+        path = get_project(config, target).get("path_with_namespace")
+        if not path:
+            raise GitlabError(f"Could not resolve a path for project id {target}")
+        return str(path)
+    return target
+
+
 def whoami(config: GitlabConfig) -> dict[str, Any]:
     """Return the authenticated user (``GET /user``) — a quick token/identity check."""
     return gitlab_request("GET", "/user", config=config)

{runspec_gitlab_core-0.1.0 → runspec_gitlab_core-0.2.0}/tests/test_api.py

@@ -12,7 +12,11 @@ from runspec_gitlab_core import (
     get_file,
     get_issue,
     get_job_log,
-    get_merge_request_changes,
+    get_merge_request_commits,
+    get_merge_request_conflicts,
+    get_merge_request_diffs,
+    get_merge_request_notes,
+    get_merge_request_pipelines,
     list_issues,
     list_pipelines,
     list_tree,
@@ -78,10 +82,56 @@ def test_missing_project_raises(monkeypatch):
         list_issues(cfg)
 
 
-def test_mr_changes_path(monkeypatch):
-    seen = _capture(monkeypatch, httpx.Response(200, json={"changes": []}))
-    get_merge_request_changes(CFG, 12)
-    assert seen["path"] == "/api/v4/projects/grp%2Fapp/merge_requests/12/changes"
+def test_mr_diffs_path(monkeypatch):
+    seen = _capture(monkeypatch, httpx.Response(200, json=[]))
+    get_merge_request_diffs(CFG, 12)
+    assert seen["path"] == "/api/v4/projects/grp%2Fapp/merge_requests/12/diffs"
+
+
+def test_mr_commits_path(monkeypatch):
+    seen = _capture(monkeypatch, httpx.Response(200, json=[]))
+    get_merge_request_commits(CFG, 12)
+    assert seen["path"] == "/api/v4/projects/grp%2Fapp/merge_requests/12/commits"
+
+
+def test_mr_notes_path_and_sort(monkeypatch):
+    seen = _capture(monkeypatch, httpx.Response(200, json=[]))
+    get_merge_request_notes(CFG, 12, sort="desc")
+    assert seen["path"] == "/api/v4/projects/grp%2Fapp/merge_requests/12/notes"
+    assert seen["query"]["sort"] == "desc"
+
+
+def test_mr_pipelines_path(monkeypatch):
+    seen = _capture(monkeypatch, httpx.Response(200, json=[]))
+    get_merge_request_pipelines(CFG, 12)
+    assert seen["path"] == "/api/v4/projects/grp%2Fapp/merge_requests/12/pipelines"
+
+
+def test_mr_conflicts_uses_non_api_web_path(monkeypatch):
+    # CFG.project is a path ("grp/app") — no id resolution, one request, no /api/v4.
+    seen = _capture(monkeypatch, httpx.Response(200, json={"files": []}))
+    result = get_merge_request_conflicts(CFG, 12)
+    assert result == {"files": []}
+    assert seen["path"] == "/grp/app/-/merge_requests/12/conflicts"
+    assert "/api/v4" not in seen["path"]
+
+
+def test_mr_conflicts_resolves_numeric_id_to_path(monkeypatch):
+    calls: list[str] = []
+
+    def handler(request: httpx.Request) -> httpx.Response:
+        path = request.url.raw_path.decode()
+        calls.append(path)
+        if path == "/api/v4/projects/99":
+            return httpx.Response(200, json={"path_with_namespace": "grp/app"})
+        return httpx.Response(200, json={"files": ["x"]})
+
+    mock_request(monkeypatch, handler)
+    cfg = GitlabConfig(base_url="https://gl", token="tok", project="99")
+    result = get_merge_request_conflicts(cfg, 5)
+    assert "/api/v4/projects/99" in calls  # numeric id resolved via the API
+    assert "/grp/app/-/merge_requests/5/conflicts" in calls  # then the web endpoint
+    assert result == {"files": ["x"]}
 
 
 def test_list_pipelines_filters(monkeypatch):

runspec_gitlab_core-0.1.0/runspec_gitlab_core/merge_requests.py

@@ -1,45 +0,0 @@
-"""merge_requests.py — merge-request read operations (GitLab REST v4)."""
-
-from __future__ import annotations
-
-from typing import Any
-
-from runspec_gitlab_core.client import GitlabConfig, gitlab_request
-from runspec_gitlab_core.projects import _project
-
-
-def list_merge_requests(
-    config: GitlabConfig,
-    project: str | None = None,
-    state: str | None = None,
-    per_page: int = 20,
-    page: int = 1,
-) -> list[dict[str, Any]]:
-    """List a project's merge requests.
-
-    ``state`` is ``opened``/``closed``/``merged``/``locked``/``all``.
-    """
-    return gitlab_request(
-        "GET",
-        f"/projects/{_project(config, project)}/merge_requests",
-        config=config,
-        params={"state": state, "per_page": per_page, "page": page},
-    )
-
-
-def get_merge_request(config: GitlabConfig, mr_iid: int, project: str | None = None) -> dict[str, Any]:
-    """Fetch a single merge request by its project-scoped internal id (``iid``)."""
-    return gitlab_request(
-        "GET",
-        f"/projects/{_project(config, project)}/merge_requests/{mr_iid}",
-        config=config,
-    )
-
-
-def get_merge_request_changes(config: GitlabConfig, mr_iid: int, project: str | None = None) -> dict[str, Any]:
-    """Fetch a merge request together with its file changes / diffs."""
-    return gitlab_request(
-        "GET",
-        f"/projects/{_project(config, project)}/merge_requests/{mr_iid}/changes",
-        config=config,
-    )