tap-belvo 0.3.1__tar.gz → 0.3.2__tar.gz

tap_belvo-0.3.2/.github/workflows/update_openapi.yml

@@ -0,0 +1,33 @@
+name: Update OpenAPI Specification for belvo.com
+
+on:
+  workflow_dispatch:
+  schedule:
+  # Daily at noon
+  - cron: '0 12 * * *'
+
+env:
+  # renovate: datasource=pypi depName=uv
+  UV_VERSION: 0.8.22
+
+jobs:
+  update_openapi_specification:
+    runs-on: ubuntu-24.04
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+    - uses: actions/create-github-app-token@67018539274d69449ef7c02e8e71183d1719ab42 # v2.1.4
+      id: generate-token
+      with:
+        app-id: ${{ vars.APP_ID }}
+        private-key: ${{ secrets.APP_PRIVATE_KEY }}
+    - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+    - uses: astral-sh/setup-uv@b75a909f75acd358c2196fb9a5f1299a9a8868a4 # v6.7.0
+      with:
+        version: ${{ env.UV_VERSION }}
+    - run: uv run --only-group=scripts scripts/update_openapi.py
+    - uses: peter-evans/create-pull-request@271a8d0340265f705b14b6d32b9829c1cb33d45e # v7.0.8
+      with:
+        title: 'chore: Update OpenAPI Specification for belvo.com'
+        token: ${{ steps.generate-token.outputs.token }}

{tap_belvo-0.3.1 → tap_belvo-0.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tap-belvo
-Version: 0.3.1
+Version: 0.3.2
 Summary: Singer tap for Belvo, built with the Meltano SDK for Singer Taps.
 Project-URL: Documentation, https://github.com/reservoir-data/tap-belvo#readme
 Project-URL: Homepage, https://github.com/reservoir-data/tap-belvo
@@ -18,7 +18,8 @@ Classifier: Programming Language :: Python :: 3.14
 Requires-Python: >=3.11
 Requires-Dist: requests-cache==1.*
 Requires-Dist: requests~=2.32.3
-Requires-Dist: singer-sdk~=0.49.1
+Requires-Dist: singer-sdk~=0.50.0
+Requires-Dist: typing-extensions>=4.15; python_full_version < '3.12'
 Description-Content-Type: text/markdown
 
 # tap-belvo

{tap_belvo-0.3.1 → tap_belvo-0.3.2}/pyproject.toml

@@ -31,7 +31,8 @@ dynamic = [
 dependencies = [
   "requests~=2.32.3",
   "requests-cache==1.*",
-  "singer-sdk~=0.49.1",
+  "singer-sdk~=0.50.0",
+  "typing-extensions>=4.15; python_full_version<'3.12'",
 ]
 urls.Documentation = "https://github.com/reservoir-data/tap-belvo#readme"
 urls.Homepage = "https://github.com/reservoir-data/tap-belvo"
@@ -40,17 +41,22 @@ scripts."tap-belvo" = "tap_belvo.tap:TapBelvo.cli"
 
 [dependency-groups]
 dev = [
+  { include-group = "scripts" },
   { include-group = "testing" },
   { include-group = "typing" },
 ]
+scripts = [
+  "requests>=2.32.5",
+]
 testing = [
-  "deptry>=0.12",
-  "pytest>=7.4",
+  "deptry>=0.23",
+  "pytest>=8",
   "singer-sdk[testing]",
 ]
 typing = [
-  "mypy",
-  "types-requests",
+  "mypy>=1.18",
+  "ty>=0.0.1a21",
+  "types-requests>=2.32.3",
 ]
 
 [tool.hatch.version]
@@ -113,7 +119,10 @@ commands = [ [ "deptry", "." ] ]
 
 [tool.tox.env.typing]
 dependency_groups = [ "testing", "typing" ]
-commands = [ [ "mypy", "--strict", { replace = "posargs", default = [ "tap_belvo", "tests" ], extend = true } ] ]
+commands = [
+  [ "mypy", "--strict", { replace = "posargs", default = [ "tap_belvo", "tests" ], extend = true } ],
+  [ "ty", "check", { replace = "posargs", default = [ "tap_belvo", "tests" ], extend = true } ],
+]
 
 [tool.mypy]
 enable_error_code = [
@@ -128,11 +137,7 @@ warn_unreachable = true
 warn_unused_configs = true
 warn_unused_ignores = true
 
-[[tool.mypy.overrides]]
-ignore_missing_imports = true
-module = [ "backoff.*" ]
-
 [tool.uv]
 prerelease = "allow"
 preview = true
-required-version = ">=0.5.19"
+required-version = ">=0.8"

tap_belvo-0.3.2/scripts/update_openapi.py

@@ -0,0 +1,29 @@
+"""Update the OpenAPI schema from the Belvo API.
+
+Copyright (c) 2025 Edgar Ramírez-Mondragón
+"""  # noqa: INP001
+
+from __future__ import annotations
+
+import json
+import pathlib
+
+import requests
+
+OPENAPI_URL = "https://developers.belvo.com/_spec/apis/BelvoOpenApiSpec.json"
+PATH = "tap_belvo/openapi.json"
+
+
+def main() -> None:
+    """Update the OpenAPI schema from the Belvo API."""
+    with pathlib.Path(PATH).open("w", encoding="utf-8") as file:
+        response = requests.get(OPENAPI_URL, timeout=5)
+        response.raise_for_status()
+        spec = response.json()
+
+        content = json.dumps(spec, indent=2) + "\n"
+        file.write(content)
+
+
+if __name__ == "__main__":
+    main()

tap_belvo-0.3.2/tap_belvo/client.py

@@ -0,0 +1,123 @@
+"""REST client handling, including BelvoStream base class."""
+
+from __future__ import annotations
+
+import sys
+from abc import ABCMeta, abstractmethod
+from copy import deepcopy
+from importlib import resources
+from typing import TYPE_CHECKING, Any
+from urllib.parse import ParseResult, parse_qsl
+
+from requests.auth import HTTPBasicAuth
+from requests_cache import install_cache
+from singer_sdk import OpenAPISchema, RESTStream
+from singer_sdk.pagination import BaseHATEOASPaginator
+
+if sys.version_info >= (3, 12):
+    from typing import override
+else:
+    from typing_extensions import override
+
+if TYPE_CHECKING:
+    from requests import Response
+    from singer_sdk.helpers.types import Context
+
+
+PAGE_SIZE = 1000
+OPENAPI = OpenAPISchema(resources.files("tap_belvo") / "openapi.json")
+
+install_cache("tap_belvo_cache", backend="sqlite", expire_after=3600)
+
+
+def _handle_schema_nullable(schema: dict[str, Any]) -> dict[str, Any]:
+    """Resolve x-nullable properties to standard JSON Schema nullable type.
+
+    Args:
+        schema: A JSON Schema dictionary.
+
+    Returns:
+        A new JSON Schema dictionary with 'x-nullable' resolved to [<type>, "null"].
+    """
+    result = deepcopy(schema)
+
+    if "object" in result["type"]:
+        for prop, prop_schema in result.get("properties", {}).items():
+            prop_type: str | list[str] = prop_schema.get("type", [])
+            types = [prop_type] if isinstance(prop_type, str) else prop_type
+            nullable: bool = prop_schema.get("nullable", False)
+
+            if nullable:
+                prop_schema["type"] = [*types, "null"]
+
+            result["properties"][prop] = _handle_schema_nullable(prop_schema)
+
+    elif "array" in result["type"]:
+        result["items"] = _handle_schema_nullable(result["items"])
+
+    if "enum" in result and None not in result["enum"]:
+        result["enum"].append(None)
+
+    return result
+
+
+class BelvoPaginator(BaseHATEOASPaginator):
+    """Belvo API paginator class."""
+
+    @override
+    def get_next_url(self, response: Response) -> str | None:
+        """Get the next URL from the response."""
+        return response.json().get("next")  # type: ignore[no-any-return]
+
+
+class BelvoStream(RESTStream[ParseResult], metaclass=ABCMeta):
+    """Belvo stream class."""
+
+    records_jsonpath = "$.results[*]"  # Or override `parse_response`.
+
+    @override
+    @property
+    def url_base(self) -> str:
+        return self.config["base_url"]  # type: ignore[no-any-return]
+
+    @override
+    @property
+    def authenticator(self) -> HTTPBasicAuth:
+        return HTTPBasicAuth(self.config["secret_id"], self.config["password"])
+
+    @override
+    def get_new_paginator(self) -> BelvoPaginator:
+        return BelvoPaginator()
+
+    @override
+    def get_url_params(
+        self,
+        context: Context | None,
+        next_page_token: ParseResult | None,
+    ) -> dict[str, Any]:
+        """Get URL query parameters."""
+        params: dict[str, Any] = {
+            "page": 1,
+            "page_size": PAGE_SIZE,
+        }
+
+        if next_page_token:
+            params.update(parse_qsl(next_page_token.query))
+
+        if (
+            self.replication_key  # Only if the stream is running incrementally
+            and (start_date := self.get_starting_timestamp(context))
+        ):
+            params[f"{self.replication_key}__gte"] = start_date.date().isoformat()
+
+        return params
+
+    @override
+    @property
+    def schema(self) -> dict[str, Any]:
+        return _handle_schema_nullable(OPENAPI.fetch_schema(self.openapi_ref))
+
+    @property
+    @abstractmethod
+    def openapi_ref(self) -> str:
+        """OpenAPI component name for this stream."""