fluidattacks_refiner_sdk 0.1.1__tar.gz

fluidattacks_refiner_sdk-0.1.1/.envrc

@@ -0,0 +1 @@
+use_flake ".#python311.devShell"

fluidattacks_refiner_sdk-0.1.1/PKG-INFO

@@ -0,0 +1,11 @@
+Metadata-Version: 2.4
+Name: fluidattacks_refiner_sdk
+Version: 0.1.1
+Summary: refiner SDK
+Author-email: Product Team <development@fluidattacks.com>
+Requires-Python: >=3.11
+Requires-Dist: click >=8.3.0, <9.0.0
+Requires-Dist: fluidattacks-etl-utils >=5.0.0, <6.0.0
+Requires-Dist: fa-purity >=2.5.2, <3.0.0
+Requires-Dist: pure-requests >=3.0.0, <4.0.0
+Requires-Dist: python-dateutil >=2.8.0, <3.0.0

fluidattacks_refiner_sdk-0.1.1/build/default.nix

@@ -0,0 +1,11 @@
+{ src }:
+{
+  inherit src;
+  root_path = "observes/sdk/refiner";
+  module_name = "fluidattacks_refiner_sdk";
+  pypi_token = {
+    role = "prod_observes";
+    secrets_file = "./observes/secrets/pypi.yaml";
+    var_name = "REFINER_SDK_TOKEN";
+  };
+}

fluidattacks_refiner_sdk-0.1.1/build/filter.nix

@@ -0,0 +1,12 @@
+path_filter: src:
+path_filter {
+  root = src;
+  include = [
+    "fluidattacks_refiner_sdk"
+    "tests"
+    "pyproject.toml"
+    "mypy.ini"
+    "ruff.toml"
+    "uv.lock"
+  ];
+}

fluidattacks_refiner_sdk-0.1.1/flake.lock

@@ -0,0 +1,303 @@
+{
+  "nodes": {
+    "flake-parts": {
+      "inputs": {
+        "nixpkgs-lib": "nixpkgs-lib"
+      },
+      "locked": {
+        "lastModified": 1762810396,
+        "narHash": "sha256-dxFVgQPG+R72dkhXTtqUm7KpxElw3u6E+YlQ2WaDgt8=",
+        "owner": "hercules-ci",
+        "repo": "flake-parts",
+        "rev": "0bdadb1b265fb4143a75bd1ec7d8c915898a9923",
+        "type": "github"
+      },
+      "original": {
+        "owner": "hercules-ci",
+        "repo": "flake-parts",
+        "type": "github"
+      }
+    },
+    "nix_filter": {
+      "locked": {
+        "lastModified": 1757882181,
+        "narHash": "sha256-+cCxYIh2UNalTz364p+QYmWHs0P+6wDhiWR4jDIKQIU=",
+        "owner": "numtide",
+        "repo": "nix-filter",
+        "rev": "59c44d1909c72441144b93cf0f054be7fe764de5",
+        "type": "github"
+      },
+      "original": {
+        "owner": "numtide",
+        "repo": "nix-filter",
+        "type": "github"
+      }
+    },
+    "nixpkgs": {
+      "locked": {
+        "lastModified": 1758690382,
+        "narHash": "sha256-NY3kSorgqE5LMm1LqNwGne3ZLMF2/ILgLpFr1fS4X3o=",
+        "owner": "nixos",
+        "repo": "nixpkgs",
+        "rev": "e643668fd71b949c53f8626614b21ff71a07379d",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nixos",
+        "ref": "nixos-unstable",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "nixpkgs-lib": {
+      "locked": {
+        "lastModified": 1761765539,
+        "narHash": "sha256-b0yj6kfvO8ApcSE+QmA6mUfu8IYG6/uU28OFn4PaC8M=",
+        "owner": "nix-community",
+        "repo": "nixpkgs.lib",
+        "rev": "719359f4562934ae99f5443f20aa06c2ffff91fc",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nix-community",
+        "repo": "nixpkgs.lib",
+        "type": "github"
+      }
+    },
+    "nixpkgs_2": {
+      "locked": {
+        "lastModified": 1758690382,
+        "narHash": "sha256-NY3kSorgqE5LMm1LqNwGne3ZLMF2/ILgLpFr1fS4X3o=",
+        "owner": "nixos",
+        "repo": "nixpkgs",
+        "rev": "e643668fd71b949c53f8626614b21ff71a07379d",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nixos",
+        "ref": "nixos-unstable",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "nixpkgs_3": {
+      "locked": {
+        "lastModified": 1761373498,
+        "narHash": "sha256-Q/uhWNvd7V7k1H1ZPMy/vkx3F8C13ZcdrKjO7Jv7v0c=",
+        "owner": "nixos",
+        "repo": "nixpkgs",
+        "rev": "6a08e6bb4e46ff7fcbb53d409b253f6bad8a28ce",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nixos",
+        "ref": "nixos-unstable",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "nixpkgs_flake": {
+      "locked": {
+        "lastModified": 1778253243,
+        "narHash": "sha256-KkH2QvU6iRLDTGGEwH5jnMqHWj4zMTuHxi1S1zdr01w=",
+        "owner": "nixos",
+        "repo": "nixpkgs",
+        "rev": "4fcda7103530b23c5ca44286344912082aad4220",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nixos",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "pyproject-build-systems": {
+      "inputs": {
+        "nixpkgs": "nixpkgs",
+        "pyproject-nix": "pyproject-nix",
+        "uv2nix": "uv2nix"
+      },
+      "locked": {
+        "lastModified": 1761781027,
+        "narHash": "sha256-YDvxPAm2WnxrznRqWwHLjryBGG5Ey1ATEJXrON+TWt8=",
+        "owner": "pyproject-nix",
+        "repo": "build-system-pkgs",
+        "rev": "795a980d25301e5133eca37adae37283ec3c8e66",
+        "type": "github"
+      },
+      "original": {
+        "owner": "pyproject-nix",
+        "repo": "build-system-pkgs",
+        "type": "github"
+      }
+    },
+    "pyproject-nix": {
+      "inputs": {
+        "nixpkgs": [
+          "python_builder",
+          "pyproject-build-systems",
+          "nixpkgs"
+        ]
+      },
+      "locked": {
+        "lastModified": 1758265079,
+        "narHash": "sha256-amLaLNwKSZPShQHzfgmc/9o76dU8xzN0743dWgvYlr8=",
+        "owner": "nix-community",
+        "repo": "pyproject.nix",
+        "rev": "02e9418fd4af638447dca4b17b1280da95527fc9",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nix-community",
+        "repo": "pyproject.nix",
+        "type": "github"
+      }
+    },
+    "pyproject-nix_2": {
+      "inputs": {
+        "nixpkgs": "nixpkgs_2"
+      },
+      "locked": {
+        "lastModified": 1762427963,
+        "narHash": "sha256-CkPlAbIQ87wmjy5qHibfzk4DmMGBNqFer+lLfXjpP5M=",
+        "owner": "pyproject-nix",
+        "repo": "pyproject.nix",
+        "rev": "4540ea004e04fcd12dd2738d51383d10f956f7b9",
+        "type": "github"
+      },
+      "original": {
+        "owner": "pyproject-nix",
+        "repo": "pyproject.nix",
+        "type": "github"
+      }
+    },
+    "pyproject-nix_3": {
+      "inputs": {
+        "nixpkgs": [
+          "python_builder",
+          "uv2nix",
+          "nixpkgs"
+        ]
+      },
+      "locked": {
+        "lastModified": 1760402624,
+        "narHash": "sha256-jF6UKLs2uGc2rtved8Vrt58oTWjTQoAssuYs/0578Z4=",
+        "owner": "pyproject-nix",
+        "repo": "pyproject.nix",
+        "rev": "84c4ea102127c77058ea1ed7be7300261fafc7d2",
+        "type": "github"
+      },
+      "original": {
+        "owner": "pyproject-nix",
+        "repo": "pyproject.nix",
+        "type": "github"
+      }
+    },
+    "python_builder": {
+      "inputs": {
+        "nix_filter": "nix_filter",
+        "nixpkgs_flake": "nixpkgs_flake",
+        "pyproject-build-systems": "pyproject-build-systems",
+        "pyproject-nix": "pyproject-nix_2",
+        "shell-helpers": "shell-helpers",
+        "uv2nix": "uv2nix_2"
+      },
+      "locked": {
+        "dir": "common/utils/python-builder",
+        "lastModified": 1778851848,
+        "narHash": "sha256-Ef+Jos1QRv3uMXYxsp1nDAmzAtumgZGjeqWguQ4ZWSI=",
+        "ref": "refs/heads/trunk",
+        "rev": "9a2a5bc035aed66eb5630c64ec23b6345da6601d",
+        "shallow": true,
+        "type": "git",
+        "url": "ssh://git@gitlab.com/fluidattacks/universe"
+      },
+      "original": {
+        "dir": "common/utils/python-builder",
+        "rev": "9a2a5bc035aed66eb5630c64ec23b6345da6601d",
+        "shallow": true,
+        "type": "git",
+        "url": "ssh://git@gitlab.com/fluidattacks/universe"
+      }
+    },
+    "root": {
+      "inputs": {
+        "python_builder": "python_builder"
+      }
+    },
+    "shell-helpers": {
+      "inputs": {
+        "flake-parts": "flake-parts",
+        "nixpkgs": [
+          "python_builder",
+          "nixpkgs_flake"
+        ]
+      },
+      "locked": {
+        "dir": "common/utils/shell-helpers",
+        "lastModified": 1762806066,
+        "narHash": "sha256-Wz99Fl7SpPU1NkTHJ36XOo6DjOEAMXCw3ThRABOS2Hs=",
+        "ref": "refs/heads/trunk",
+        "rev": "d73cfdc7ae9e7f547e22a4481d4c2ccce38b26a8",
+        "shallow": true,
+        "type": "git",
+        "url": "ssh://git@gitlab.com/fluidattacks/universe"
+      },
+      "original": {
+        "dir": "common/utils/shell-helpers",
+        "rev": "d73cfdc7ae9e7f547e22a4481d4c2ccce38b26a8",
+        "shallow": true,
+        "type": "git",
+        "url": "ssh://git@gitlab.com/fluidattacks/universe"
+      }
+    },
+    "uv2nix": {
+      "inputs": {
+        "nixpkgs": [
+          "python_builder",
+          "pyproject-build-systems",
+          "nixpkgs"
+        ],
+        "pyproject-nix": [
+          "python_builder",
+          "pyproject-build-systems",
+          "pyproject-nix"
+        ]
+      },
+      "locked": {
+        "lastModified": 1758933732,
+        "narHash": "sha256-HAmm1GBS1myZCFuog0DC2ZLaynvZtiUI2Crmo+cdQI0=",
+        "owner": "pyproject-nix",
+        "repo": "uv2nix",
+        "rev": "273ce18f913d8559e0d04f820d724308966d7c4d",
+        "type": "github"
+      },
+      "original": {
+        "owner": "pyproject-nix",
+        "repo": "uv2nix",
+        "type": "github"
+      }
+    },
+    "uv2nix_2": {
+      "inputs": {
+        "nixpkgs": "nixpkgs_3",
+        "pyproject-nix": "pyproject-nix_3"
+      },
+      "locked": {
+        "lastModified": 1761872265,
+        "narHash": "sha256-i25GRgp2vUOebY70L3NTAgkd+Pr1hnn5xM3qHxH0ONU=",
+        "owner": "pyproject-nix",
+        "repo": "uv2nix",
+        "rev": "74dfb62871be152ad3673b143b0cc56105a4f3c5",
+        "type": "github"
+      },
+      "original": {
+        "owner": "pyproject-nix",
+        "repo": "uv2nix",
+        "type": "github"
+      }
+    }
+  },
+  "root": "root",
+  "version": 7
+}

fluidattacks_refiner_sdk-0.1.1/flake.nix

@@ -0,0 +1,28 @@
+{
+  description = "Refiner fluid SDK";
+
+  inputs = {
+    python_builder = {
+      url = "git+ssh://git@gitlab.com/fluidattacks/universe?shallow=1&rev=9a2a5bc035aed66eb5630c64ec23b6345da6601d&dir=common/utils/python-builder";
+    };
+  };
+
+  outputs =
+    { self, ... }@inputs:
+    let
+      build_args =
+        {
+          system,
+          python_version,
+          nixpkgs,
+          builders,
+          scripts,
+        }:
+        import ./build {
+          src = import ./build/filter.nix nixpkgs.nix-filter self;
+        };
+    in
+    {
+      packages = inputs.python_builder.outputs.build build_args;
+    };
+}

fluidattacks_refiner_sdk-0.1.1/fluidattacks_refiner_sdk/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.1.1"

fluidattacks_refiner_sdk-0.1.1/fluidattacks_refiner_sdk/auth/__init__.py

@@ -0,0 +1,7 @@
+from ._core import (
+    Credentials,
+)
+
+__all__ = [
+    "Credentials",
+]

fluidattacks_refiner_sdk-0.1.1/fluidattacks_refiner_sdk/auth/_core.py

@@ -0,0 +1,9 @@
+from dataclasses import (
+    dataclass,
+    field,
+)
+
+
+@dataclass(frozen=True)
+class Credentials:
+    api_key: str = field(repr=False)

fluidattacks_refiner_sdk-0.1.1/fluidattacks_refiner_sdk/client/__init__.py

@@ -0,0 +1,33 @@
+from logging import (
+    Logger,
+)
+
+from fluidattacks_refiner_sdk.auth import (
+    Credentials,
+)
+from fluidattacks_refiner_sdk.client._get_contacts import (
+    get_contacts,
+)
+from fluidattacks_refiner_sdk.client._get_forms import (
+    get_forms,
+)
+from fluidattacks_refiner_sdk.client._get_reporting import (
+    get_nps_metrics,
+)
+from fluidattacks_refiner_sdk.client._get_responses import (
+    get_responses,
+)
+from fluidattacks_refiner_sdk.core import (
+    ApiClient,
+)
+
+__all__ = ["new_api_client"]
+
+
+def new_api_client(log: Logger, creds: Credentials) -> ApiClient:
+    return ApiClient(
+        get_forms=get_forms(log, creds),
+        get_responses=lambda form_id: get_responses(log, creds, form_id),
+        get_contacts=get_contacts(log, creds),
+        get_nps_metrics=get_nps_metrics(log, creds),
+    )

fluidattacks_refiner_sdk-0.1.1/fluidattacks_refiner_sdk/client/_common.py

@@ -0,0 +1,123 @@
+import inspect
+import logging
+from collections.abc import (
+    Callable,
+)
+from dataclasses import (
+    dataclass,
+)
+from typing import (
+    Generic,
+    TypeVar,
+)
+
+from fa_purity import (
+    Cmd,
+    FrozenList,
+    Maybe,
+    Result,
+    ResultE,
+    cast_exception,
+)
+from fa_purity.json import (
+    JsonObj,
+    JsonPrimitiveUnfolder,
+    JsonUnfolder,
+    Unfolder,
+)
+from fluidattacks_etl_utils.bug import (
+    Bug,
+)
+from pure_requests.response import handle_status
+from pure_requests.retry import HandledErrorFactory, cmd_if_fail, retry_cmd, sleep_cmd
+from requests import HTTPError, RequestException, Response
+
+_T = TypeVar("_T")
+LOG = logging.getLogger(__name__)
+_HTTP_5XX_START = 500
+_HTTP_5XX_END = 600
+
+
+@dataclass(frozen=True)
+class DataPage(Generic[_T]):
+    items: FrozenList[_T]
+    next_cursor: Maybe[str]
+
+
+def decode_items(
+    raw: JsonObj,
+    decode: Callable[[JsonObj], ResultE[_T]],
+) -> ResultE[FrozenList[_T]]:
+    return JsonUnfolder.require(
+        raw,
+        "items",
+        lambda v: Unfolder.to_list_of(v, lambda j: Unfolder.to_json(j).bind(decode)),
+    ).alt(
+        lambda e: Bug[Exception].new(
+            "decode_items",
+            inspect.currentframe(),
+            e,
+            (JsonUnfolder.dumps(raw),),
+        ),
+    )
+
+
+def decode_next_cursor(raw: JsonObj) -> ResultE[Maybe[str]]:
+    return JsonUnfolder.require(
+        raw,
+        "pagination",
+        lambda v: Unfolder.to_json(v).bind(
+            lambda pag: JsonUnfolder.optional(
+                pag,
+                "next_page_cursor",
+                lambda vv: Unfolder.to_primitive(vv).bind(JsonPrimitiveUnfolder.to_str),
+            ),
+        ),
+    )
+
+
+def decode_page(
+    raw: JsonObj,
+    decode: Callable[[JsonObj], ResultE[_T]],
+) -> ResultE[DataPage[_T]]:
+    items = decode_items(raw, decode)
+    cursor = decode_next_cursor(raw)
+    return items.bind(lambda i: cursor.map(lambda c: DataPage(i, c))).alt(
+        lambda e: Bug[Exception].new(
+            "decode_page",
+            inspect.currentframe(),
+            e,
+            (JsonUnfolder.dumps(raw),),
+        ),
+    )
+
+
+def with_retry_handler(
+    raw_page: Cmd[Result[Response, RequestException]],
+    retries: int,
+) -> Cmd[ResultE[Response]]:
+    error_factory: HandledErrorFactory[HTTPError, Exception] = HandledErrorFactory()
+    handled_get_page = raw_page.map(
+        lambda r: (
+            r.alt(cast_exception)
+            .alt(error_factory.unhandled)
+            .bind(
+                lambda r: handle_status(r).alt(
+                    lambda e: (
+                        error_factory.handled(e)
+                        if e.errno and e.errno >= _HTTP_5XX_START and e.errno < _HTTP_5XX_END
+                        else error_factory.unhandled(cast_exception(e))
+                    ),
+                ),
+            )
+        ),
+    )
+    return retry_cmd(
+        handled_get_page,
+        lambda i, r: cmd_if_fail(
+            r,
+            Cmd[None].wrap_impure(lambda: LOG.info("Error handled i.e. %s", r))
+            + sleep_cmd(10 + 60 * (i - 1)),
+        ),
+        retries,
+    )