fluidattacks_gitlab_sdk 3.0.3__tar.gz → 5.0.0__tar.gz

{fluidattacks_gitlab_sdk-3.0.3 → fluidattacks_gitlab_sdk-5.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fluidattacks_gitlab_sdk
-Version: 3.0.3
+Version: 5.0.0
 Summary: gitlab SDK
 Author-email: Product Team <development@fluidattacks.com>
 Requires-Python: >=3.11

{fluidattacks_gitlab_sdk-3.0.3 → fluidattacks_gitlab_sdk-5.0.0}/fluidattacks_gitlab_sdk/__init__.py

@@ -11,7 +11,7 @@ from ._logger import (
     set_logger,
 )
 
-__version__ = "3.0.3"
+__version__ = "5.0.0"
 
 Unsafe.compute(set_logger(__name__, __version__))
 LOG = logging.getLogger(__name__)

{fluidattacks_gitlab_sdk-3.0.3 → fluidattacks_gitlab_sdk-5.0.0}/fluidattacks_gitlab_sdk/mr_approvals/_decode.py

@@ -9,6 +9,15 @@ from fluidattacks_gitlab_sdk.mr_approvals.core import Approver, MrApprovals
 from fluidattacks_gitlab_sdk.users.decode import decode_user_obj
 
 
+def _decode_approver(entry: JsonObj) -> ResultE[Approver]:
+    return smash.smash_result_2(
+        JsonUnfolder.require(entry, "user", Unfolder.to_json).bind(decode_user_obj),
+        JsonUnfolder.optional(entry, "approved_at", DecodeUtils.to_opt_date_time).map(
+            lambda m: m.bind(lambda x: x),
+        ),
+    ).map(lambda v: Approver(v[0], v[1]))
+
+
 def decode_mr_approvals(raw: JsonObj) -> ResultE[MrApprovals]:
     return smash.smash_result_2(
         JsonUnfolder.require(raw, "approved", DecodeUtils.to_bool),
@@ -17,12 +26,7 @@ def decode_mr_approvals(raw: JsonObj) -> ResultE[MrApprovals]:
             "approved_by",
             lambda v: Unfolder.to_list_of(
                 v,
-                lambda x: (
-                    Unfolder.to_json(x)
-                    .bind(lambda user_obj: JsonUnfolder.require(user_obj, "user", Unfolder.to_json))
-                    .bind(decode_user_obj)
-                    .map(Approver)
-                ),
+                lambda x: Unfolder.to_json(x).bind(_decode_approver),
             ).map(tuple),
         ),
     ).map(lambda v: MrApprovals(v[0], v[1]))

{fluidattacks_gitlab_sdk-3.0.3 → fluidattacks_gitlab_sdk-5.0.0}/fluidattacks_gitlab_sdk/mr_approvals/core.py

@@ -3,7 +3,8 @@ from __future__ import annotations
 from collections.abc import Callable
 from dataclasses import dataclass
 
-from fa_purity import Cmd, FrozenList, ResultE
+from fa_purity import Cmd, FrozenList, Maybe, ResultE
+from fa_purity.date_time import DatetimeUTC
 
 from fluidattacks_gitlab_sdk.ids import MrFullId, MrInternalId, ProjectId
 from fluidattacks_gitlab_sdk.users import UserObj
@@ -12,6 +13,7 @@ from fluidattacks_gitlab_sdk.users import UserObj
 @dataclass(frozen=True)
 class Approver:
     user: UserObj
+    approved_at: Maybe[DatetimeUTC]
 
 
 @dataclass(frozen=True)

fluidattacks_gitlab_sdk-5.0.0/fluidattacks_gitlab_sdk/mr_notes/__init__.py

@@ -0,0 +1,4 @@
+from ._client import MrNotesFactory
+from ._core import MrNote, NotesClient
+
+__all__ = ["MrNote", "MrNotesFactory", "NotesClient"]

fluidattacks_gitlab_sdk-5.0.0/fluidattacks_gitlab_sdk/mr_notes/_client.py

@@ -0,0 +1,113 @@
+from __future__ import (
+    annotations,
+)
+
+import inspect
+from dataclasses import dataclass
+
+from fa_purity import (
+    Cmd,
+    FrozenList,
+    Maybe,
+    ResultE,
+    Stream,
+    cast_exception,
+)
+from fa_purity._core.utils import raise_exception
+from fa_purity.json import Primitive, UnfoldedFactory
+from fluidattacks_etl_utils.bug import Bug
+from fluidattacks_etl_utils.decode import int_to_str
+from fluidattacks_etl_utils.paginate import cursor_pagination
+
+from fluidattacks_gitlab_sdk._decoders import assert_multiple
+from fluidattacks_gitlab_sdk._http_client import (
+    ClientFactory,
+    Credentials,
+    HttpJsonClient,
+    RelativeEndpoint,
+)
+from fluidattacks_gitlab_sdk.ids import MrInternalId, ProjectId
+
+from ._core import MrNote, NotesClient
+from ._decode import decode_mr_notes
+
+_NOTES_PER_PAGE = 100
+
+
+def _get_notes_page(
+    client: HttpJsonClient,
+    project: ProjectId,
+    mr_id: MrInternalId,
+    page: int,
+) -> Cmd[ResultE[tuple[FrozenList[MrNote], Maybe[int]]]]:
+    endpoint = RelativeEndpoint.new(
+        "projects",
+        int_to_str(project.project_id.value),
+        "merge_requests",
+        int_to_str(mr_id.internal.value),
+        "notes",
+    )
+    params: dict[str, Primitive] = {
+        "order_by": "created_at",
+        "sort": "asc",
+        "page": int_to_str(page),
+        "per_page": _NOTES_PER_PAGE,
+    }
+    return client.get(
+        endpoint,
+        UnfoldedFactory.from_dict(params),
+    ).map(
+        lambda r: (
+            r.alt(
+                lambda e: cast_exception(
+                    Bug.new(
+                        "_get_notes_page",
+                        inspect.currentframe(),
+                        e,
+                        (),
+                    ),
+                ),
+            )
+            .bind(assert_multiple)
+            .bind(decode_mr_notes)
+            .map(
+                lambda notes: (
+                    notes,
+                    Maybe.empty() if len(notes) < _NOTES_PER_PAGE else Maybe.some(page + 1),
+                ),
+            )
+        ),
+    )
+
+
+def _get_page(
+    client: HttpJsonClient,
+    project: ProjectId,
+    mr_id: MrInternalId,
+    maybe_page: Maybe[int],
+) -> Cmd[tuple[FrozenList[MrNote], Maybe[int]]]:
+    page = maybe_page.value_or(1)
+    return _get_notes_page(client, project, mr_id, page).map(
+        lambda r: r.alt(raise_exception).to_union(),
+    )
+
+
+def _get_mr_notes(
+    client: HttpJsonClient,
+    project: ProjectId,
+    mr_id: MrInternalId,
+) -> Stream[FrozenList[MrNote]]:
+    return cursor_pagination(
+        lambda maybe_page: _get_page(client, project, mr_id, maybe_page),
+    )
+
+
+def _from_client(client: HttpJsonClient) -> NotesClient:
+    return NotesClient(lambda p, i: _get_mr_notes(client, p, i))
+
+
+@dataclass(frozen=True)
+class MrNotesFactory:
+    @staticmethod
+    def new(creds: Credentials) -> NotesClient:
+        return _from_client(ClientFactory.new(creds))

fluidattacks_gitlab_sdk-5.0.0/fluidattacks_gitlab_sdk/mr_notes/_core.py

@@ -0,0 +1,23 @@
+from __future__ import annotations
+
+from collections.abc import Callable
+from dataclasses import dataclass
+
+from fa_purity import FrozenList, Stream
+from fa_purity.date_time import DatetimeUTC
+
+from fluidattacks_gitlab_sdk.ids import MrInternalId, ProjectId
+from fluidattacks_gitlab_sdk.users import UserObj
+
+
+@dataclass(frozen=True)
+class MrNote:
+    body: str
+    author: UserObj
+    created_at: DatetimeUTC
+    system: bool
+
+
+@dataclass
+class NotesClient:
+    get_mr_notes: Callable[[ProjectId, MrInternalId], Stream[FrozenList[MrNote]]]

fluidattacks_gitlab_sdk-5.0.0/fluidattacks_gitlab_sdk/mr_notes/_decode.py

@@ -0,0 +1,24 @@
+from fa_purity import FrozenList, PureIterFactory, Result, ResultE, ResultTransform
+from fa_purity.json import JsonObj, JsonUnfolder, Unfolder
+from fluidattacks_etl_utils import smash
+from fluidattacks_etl_utils.decode import DecodeUtils
+
+from fluidattacks_gitlab_sdk.mr_notes._core import MrNote
+from fluidattacks_gitlab_sdk.users.decode import decode_user_obj
+
+
+def decode_mr_note(raw: JsonObj) -> ResultE[MrNote]:
+    return smash.smash_result_4(
+        JsonUnfolder.require(raw, "body", DecodeUtils.to_str),
+        JsonUnfolder.require(raw, "author", lambda v: Unfolder.to_json(v).bind(decode_user_obj)),
+        JsonUnfolder.require(raw, "created_at", DecodeUtils.to_date_time),
+        JsonUnfolder.require(raw, "system", DecodeUtils.to_bool),
+    ).map(lambda t: MrNote(*t))
+
+
+def decode_mr_notes(raw: FrozenList[JsonObj]) -> ResultE[FrozenList[MrNote]]:
+    if not raw:
+        return Result.success(FrozenList[MrNote](()), Exception)
+    return ResultTransform.all_ok(
+        PureIterFactory.from_list(raw).map(decode_mr_note).to_list(),
+    )

{fluidattacks_gitlab_sdk-3.0.3 → fluidattacks_gitlab_sdk-5.0.0}/pyproject.toml

@@ -34,7 +34,7 @@ dev = [
 
 [tool.uv]
 exclude-newer = "7 days"
-exclude-newer-package = { fluidattacks-core = "2099-01-01", fluid-blends = "2099-01-01" }
+exclude-newer-package = { fluidattacks-core = "2099-01-02T00:00:00Z", fluid-blends = "2099-01-02T00:00:00Z" , fluidattacks-utils-logger = "2099-01-02T00:00:00Z" }
 override-dependencies = [
     "cryptography==48.0.1"
 ]

{fluidattacks_gitlab_sdk-3.0.3 → fluidattacks_gitlab_sdk-5.0.0}/tests/arch/arch.py

@@ -26,7 +26,7 @@ def _module(path: str) -> FullPathModule | NoReturn:
 
 _dag: Dict[str, tuple[tuple[str, ...] | str, ...]] = {
     "fluidattacks_gitlab_sdk": (
-        ("merge_requests", "members", "issues", "milestones", "mr_approvals", "jobs"),
+        ("merge_requests", "members", "issues", "milestones", "mr_approvals", "mr_notes", "jobs"),
         "users",
         "_handlers",
         ("_http_client", "_gql_client", "_decoders"),
@@ -74,6 +74,11 @@ _dag: Dict[str, tuple[tuple[str, ...] | str, ...]] = {
         "_decode",
         "core",
     ),
+    "fluidattacks_gitlab_sdk.mr_notes": (
+        "_client",
+        "_decode",
+        "_core",
+    ),
     "fluidattacks_gitlab_sdk.jobs": ("_client", "_decode", "core"),
 }
 

{fluidattacks_gitlab_sdk-3.0.3 → fluidattacks_gitlab_sdk-5.0.0}/tests/mr_approvals/data.json

@@ -23,7 +23,8 @@
                 "locked": false,
                 "avatar_url": "https://secure.gravatar.com/avatar/2928a4bece9cd58167f81bd00ce77a48546cfc36556731cec749ea6125?s=80&d=identicon",
                 "web_url": "https://gitlab.com/useratfluid"
-            }
+            },
+            "approved_at": "2025-05-27T10:15:30.500Z"
         },
         {
             "user": {
@@ -35,7 +36,8 @@
                 "locked": false,
                 "avatar_url": "https://secure.gravatar.com/avatar/749adaea75210e02e7554347f5d6e6b65c8ff746a4fa26ef2d?s=80&d=identicon",
                 "web_url": "https://gitlab.com/project_20741933_bot_7328383692d79816c341e690"
-            }
+            },
+            "approved_at": null
         }
     ],
     "suggested_approvers": [

{fluidattacks_gitlab_sdk-3.0.3 → fluidattacks_gitlab_sdk-5.0.0}/tests/mr_approvals/decoder_test.py

@@ -1,6 +1,8 @@
+from datetime import UTC, datetime
 from pathlib import Path
 
 from fa_purity import FrozenList, Maybe, Unsafe
+from fa_purity.date_time import DatetimeUTC
 from fa_purity.json import JsonValueFactory, Unfolder
 from fluidattacks_etl_utils.natural import NaturalOperations
 
@@ -17,6 +19,10 @@ from fluidattacks_gitlab_sdk.mr_approvals.core import Approver, MrApprovals
 from fluidattacks_gitlab_sdk.users.core import User, UserName, UserObj
 
 
+def _assert_utc(date_time: datetime) -> DatetimeUTC:
+    return DatetimeUTC.assert_utc(date_time).alt(Unsafe.raise_exception).to_union()
+
+
 def test_decode() -> None:
     mr_ids = MrFullId(
         MrGlobalId(NaturalOperations.absolute(345678912)),
@@ -33,6 +39,7 @@ def test_decode() -> None:
                 UserName("User Fluid"),
                 Maybe.some(""),
             ),
+            Maybe.some(_assert_utc(datetime(2025, 5, 27, 10, 15, 30, 500000, tzinfo=UTC))),
         ),
         Approver(
             UserObj(
@@ -41,6 +48,7 @@ def test_decode() -> None:
                 UserName("****"),
                 Maybe.empty(),
             ),
+            Maybe.empty(),
         ),
     )
     mr_approvers = MrApprovals(

fluidattacks_gitlab_sdk-5.0.0/tests/mr_notes/data.json

@@ -0,0 +1,62 @@
+[
+    {
+        "id": 2712345601,
+        "type": null,
+        "body": "required: [major-version] change the major version to publish the new indicators package",
+        "author": {
+            "id": 12345678,
+            "username": "dmurciaatfluid",
+            "public_email": "",
+            "name": "Daniel Murcia",
+            "state": "active",
+            "locked": false,
+            "avatar_url": "https://secure.gravatar.com/avatar/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa?s=80&d=identicon",
+            "web_url": "https://gitlab.com/dmurciaatfluid"
+        },
+        "created_at": "2026-07-08T12:31:03.134Z",
+        "updated_at": "2026-07-08T12:31:03.134Z",
+        "system": false,
+        "noteable_id": 345678912,
+        "noteable_type": "MergeRequest"
+    },
+    {
+        "id": 2712345602,
+        "type": null,
+        "body": "<img src=\"https://res.cloudinary.com/fluid-attacks/image/upload/v1727795769/airs/logo/logo_icon.png\" width=\"24\" alt=\"Fluid Attacks\" /> **Fluid Attacks** completed security analysis\n\n**Nice job!** No vulnerabilities found",
+        "author": {
+            "id": 34547217,
+            "username": "project_20741933_bot_8385943dd3fb82db18695bfce6854920",
+            "public_email": null,
+            "name": "****",
+            "state": "active",
+            "locked": false,
+            "avatar_url": "https://secure.gravatar.com/avatar/bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb?s=80&d=identicon",
+            "web_url": "https://gitlab.com/project_20741933_bot_8385943dd3fb82db18695bfce6854920"
+        },
+        "created_at": "2026-07-08T12:19:27.612Z",
+        "updated_at": "2026-07-08T12:19:27.612Z",
+        "system": false,
+        "noteable_id": 345678912,
+        "noteable_type": "MergeRequest"
+    },
+    {
+        "id": 2712345603,
+        "type": "ApprovalSystemNote",
+        "body": "approved this merge request",
+        "author": {
+            "id": 12345678,
+            "username": "dmurciaatfluid",
+            "public_email": "",
+            "name": "Daniel Murcia",
+            "state": "active",
+            "locked": false,
+            "avatar_url": "https://secure.gravatar.com/avatar/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa?s=80&d=identicon",
+            "web_url": "https://gitlab.com/dmurciaatfluid"
+        },
+        "created_at": "2026-07-08T13:38:56.341Z",
+        "updated_at": "2026-07-08T13:38:56.341Z",
+        "system": true,
+        "noteable_id": 345678912,
+        "noteable_type": "MergeRequest"
+    }
+]

fluidattacks_gitlab_sdk-5.0.0/tests/mr_notes/decoder_test.py

@@ -0,0 +1,65 @@
+from datetime import UTC, datetime
+from pathlib import Path
+
+from fa_purity import FrozenList, Maybe, Unsafe
+from fa_purity.date_time import DatetimeUTC
+from fa_purity.json import JsonValueFactory, Unfolder
+from fluidattacks_etl_utils.natural import NaturalOperations
+
+from fluidattacks_gitlab_sdk.ids import UserId
+from fluidattacks_gitlab_sdk.mr_notes import MrNote
+from fluidattacks_gitlab_sdk.mr_notes._decode import decode_mr_notes
+from fluidattacks_gitlab_sdk.users.core import User, UserName, UserObj
+
+
+def _assert_utc(date_time: datetime) -> DatetimeUTC:
+    return DatetimeUTC.assert_utc(date_time).alt(Unsafe.raise_exception).to_union()
+
+
+def test_decode() -> None:
+    human_author = UserObj(
+        UserId(NaturalOperations.absolute(12345678)),
+        User("dmurciaatfluid"),
+        UserName("Daniel Murcia"),
+        Maybe.some(""),
+    )
+    bot_author = UserObj(
+        UserId(NaturalOperations.absolute(34547217)),
+        User("project_20741933_bot_8385943dd3fb82db18695bfce6854920"),
+        UserName("****"),
+        Maybe.empty(),
+    )
+    expected: FrozenList[MrNote] = (
+        MrNote(
+            "required: [major-version] change the major version to publish "
+            "the new indicators package",
+            human_author,
+            _assert_utc(datetime(2026, 7, 8, 12, 31, 3, 134000, tzinfo=UTC)),
+            system=False,
+        ),
+        MrNote(
+            '<img src="https://res.cloudinary.com/fluid-attacks/image/upload/v1727795769/airs/logo'
+            '/logo_icon.png" width="24" alt="Fluid Attacks" /> **Fluid Attacks** completed securit'
+            "y analysis\n\n**Nice job!** No vulnerabilities found",
+            bot_author,
+            _assert_utc(datetime(2026, 7, 8, 12, 19, 27, 612000, tzinfo=UTC)),
+            system=False,
+        ),
+        MrNote(
+            "approved this merge request",
+            human_author,
+            _assert_utc(datetime(2026, 7, 8, 13, 38, 56, 341000, tzinfo=UTC)),
+            system=True,
+        ),
+    )
+
+    raw_data_path = Path(__file__).parent / "data.json"
+    json_value = JsonValueFactory.load(raw_data_path.open(encoding="utf-8"))
+    raw_notes = (
+        json_value.bind(lambda v: Unfolder.to_list_of(v, Unfolder.to_json))
+        .alt(Unsafe.raise_exception)
+        .to_union()
+    )
+
+    decoded_notes = decode_mr_notes(raw_notes).alt(Unsafe.raise_exception).to_union()
+    assert decoded_notes == expected