ynab-cli 0.3.0__py3-none-any.whl

ynab_cli/adapters/ynab/models/transactions_import_response_data.py

@@ -0,0 +1,59 @@
+from collections.abc import Mapping
+from typing import Any, TypeVar, cast
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+T = TypeVar("T", bound="TransactionsImportResponseData")
+
+
+@_attrs_define
+class TransactionsImportResponseData:
+    """
+    Attributes:
+        transaction_ids (list[str]): The list of transaction ids that were imported.
+    """
+
+    transaction_ids: list[str]
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        transaction_ids = self.transaction_ids
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "transaction_ids": transaction_ids,
+            }
+        )
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        d = dict(src_dict)
+        transaction_ids = cast(list[str], d.pop("transaction_ids"))
+
+        transactions_import_response_data = cls(
+            transaction_ids=transaction_ids,
+        )
+
+        transactions_import_response_data.additional_properties = d
+        return transactions_import_response_data
+
+    @property
+    def additional_keys(self) -> list[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

ynab_cli/adapters/ynab/models/transactions_response.py

@@ -0,0 +1,65 @@
+from collections.abc import Mapping
+from typing import TYPE_CHECKING, Any, TypeVar
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+if TYPE_CHECKING:
+    from ynab_cli.adapters.ynab.models.transactions_response_data import TransactionsResponseData
+
+
+T = TypeVar("T", bound="TransactionsResponse")
+
+
+@_attrs_define
+class TransactionsResponse:
+    """
+    Attributes:
+        data (TransactionsResponseData):
+    """
+
+    data: "TransactionsResponseData"
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        data = self.data.to_dict()
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "data": data,
+            }
+        )
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        from ynab_cli.adapters.ynab.models.transactions_response_data import TransactionsResponseData
+
+        d = dict(src_dict)
+        data = TransactionsResponseData.from_dict(d.pop("data"))
+
+        transactions_response = cls(
+            data=data,
+        )
+
+        transactions_response.additional_properties = d
+        return transactions_response
+
+    @property
+    def additional_keys(self) -> list[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

ynab_cli/adapters/ynab/models/transactions_response_data.py

@@ -0,0 +1,81 @@
+from collections.abc import Mapping
+from typing import TYPE_CHECKING, Any, TypeVar
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+if TYPE_CHECKING:
+    from ynab_cli.adapters.ynab.models.transaction_detail import TransactionDetail
+
+
+T = TypeVar("T", bound="TransactionsResponseData")
+
+
+@_attrs_define
+class TransactionsResponseData:
+    """
+    Attributes:
+        transactions (list['TransactionDetail']):
+        server_knowledge (int): The knowledge of the server
+    """
+
+    transactions: list["TransactionDetail"]
+    server_knowledge: int
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        transactions = []
+        for transactions_item_data in self.transactions:
+            transactions_item = transactions_item_data.to_dict()
+            transactions.append(transactions_item)
+
+        server_knowledge = self.server_knowledge
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "transactions": transactions,
+                "server_knowledge": server_knowledge,
+            }
+        )
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        from ynab_cli.adapters.ynab.models.transaction_detail import TransactionDetail
+
+        d = dict(src_dict)
+        transactions = []
+        _transactions = d.pop("transactions")
+        for transactions_item_data in _transactions:
+            transactions_item = TransactionDetail.from_dict(transactions_item_data)
+
+            transactions.append(transactions_item)
+
+        server_knowledge = d.pop("server_knowledge")
+
+        transactions_response_data = cls(
+            transactions=transactions,
+            server_knowledge=server_knowledge,
+        )
+
+        transactions_response_data.additional_properties = d
+        return transactions_response_data
+
+    @property
+    def additional_keys(self) -> list[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

ynab_cli/adapters/ynab/models/user.py

@@ -0,0 +1,60 @@
+from collections.abc import Mapping
+from typing import Any, TypeVar
+from uuid import UUID
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+T = TypeVar("T", bound="User")
+
+
+@_attrs_define
+class User:
+    """
+    Attributes:
+        id (UUID):
+    """
+
+    id: UUID
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        id = str(self.id)
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "id": id,
+            }
+        )
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        d = dict(src_dict)
+        id = UUID(d.pop("id"))
+
+        user = cls(
+            id=id,
+        )
+
+        user.additional_properties = d
+        return user
+
+    @property
+    def additional_keys(self) -> list[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

ynab_cli/adapters/ynab/models/user_response.py

@@ -0,0 +1,65 @@
+from collections.abc import Mapping
+from typing import TYPE_CHECKING, Any, TypeVar
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+if TYPE_CHECKING:
+    from ynab_cli.adapters.ynab.models.user_response_data import UserResponseData
+
+
+T = TypeVar("T", bound="UserResponse")
+
+
+@_attrs_define
+class UserResponse:
+    """
+    Attributes:
+        data (UserResponseData):
+    """
+
+    data: "UserResponseData"
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        data = self.data.to_dict()
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "data": data,
+            }
+        )
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        from ynab_cli.adapters.ynab.models.user_response_data import UserResponseData
+
+        d = dict(src_dict)
+        data = UserResponseData.from_dict(d.pop("data"))
+
+        user_response = cls(
+            data=data,
+        )
+
+        user_response.additional_properties = d
+        return user_response
+
+    @property
+    def additional_keys(self) -> list[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

ynab_cli/adapters/ynab/models/user_response_data.py

@@ -0,0 +1,65 @@
+from collections.abc import Mapping
+from typing import TYPE_CHECKING, Any, TypeVar
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+if TYPE_CHECKING:
+    from ynab_cli.adapters.ynab.models.user import User
+
+
+T = TypeVar("T", bound="UserResponseData")
+
+
+@_attrs_define
+class UserResponseData:
+    """
+    Attributes:
+        user (User):
+    """
+
+    user: "User"
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        user = self.user.to_dict()
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "user": user,
+            }
+        )
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        from ynab_cli.adapters.ynab.models.user import User
+
+        d = dict(src_dict)
+        user = User.from_dict(d.pop("user"))
+
+        user_response_data = cls(
+            user=user,
+        )
+
+        user_response_data.additional_properties = d
+        return user_response_data
+
+    @property
+    def additional_keys(self) -> list[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

ynab_cli/adapters/ynab/types.py

@@ -0,0 +1,46 @@
+"""Contains some shared types for properties"""
+
+from collections.abc import MutableMapping
+from http import HTTPStatus
+from typing import BinaryIO, Generic, Literal, TypeVar
+
+from attrs import define
+
+
+class Unset:
+    def __bool__(self) -> Literal[False]:
+        return False
+
+
+UNSET: Unset = Unset()
+
+FileJsonType = tuple[str | None, BinaryIO, str | None]
+
+
+@define
+class File:
+    """Contains information for file uploads"""
+
+    payload: BinaryIO
+    file_name: str | None = None
+    mime_type: str | None = None
+
+    def to_tuple(self) -> FileJsonType:
+        """Return a tuple representation that httpx will accept for multipart/form-data"""
+        return self.file_name, self.payload, self.mime_type
+
+
+T = TypeVar("T")
+
+
+@define
+class Response(Generic[T]):
+    """A response from an endpoint"""
+
+    status_code: HTTPStatus
+    content: bytes
+    headers: MutableMapping[str, str]
+    parsed: T | None
+
+
+__all__ = ["UNSET", "File", "FileJsonType", "Response", "Unset"]

ynab_cli/adapters/ynab/util.py

@@ -0,0 +1,78 @@
+from collections.abc import Callable, Coroutine
+from typing import Any, ParamSpec, TypeVar
+
+from ynab_cli.adapters.ynab import AuthenticatedClient
+from ynab_cli.domain.ports.io import IO
+
+from .models import ErrorDetail, ErrorResponse
+from .types import Response
+
+P = ParamSpec("P")
+R = TypeVar("R")
+
+
+class ApiError(Exception):
+    """Raised by API functions when the response status is not 200 OK and Client.raise_on_unexpected_status is True"""
+
+    def __init__(self, status_code: int, error_detail: ErrorDetail | None = None):
+        self.status_code = status_code
+        self.error_detail = error_detail
+
+        super().__init__(f"Unexpected status code: {status_code}")
+
+
+def get_parsed_response_data(response: Response[ErrorResponse | R]) -> R | None:
+    parsed = response.parsed
+
+    if isinstance(parsed, ErrorResponse):
+        error_detail = parsed.error
+        raise ApiError(status_code=response.status_code, error_detail=error_detail)
+
+    if response.status_code >= 400:
+        error_detail = ErrorDetail(
+            id=str(response.status_code.value),
+            name="unknown_error",
+            detail="An unknown error occurred",
+        )
+        raise ApiError(status_code=response.status_code, error_detail=error_detail)
+
+    return parsed
+
+
+async def run_asyncio_detailed(
+    io: IO,
+    asyncio_detailed: Callable[P, Coroutine[Any, Any, Response[ErrorResponse | R]]],
+    *args: P.args,
+    **kwargs: P.kwargs,
+) -> R | None:
+    try:
+        client = kwargs["client"] if "client" in kwargs and isinstance(kwargs["client"], AuthenticatedClient) else None
+
+        response = await asyncio_detailed(*args, **kwargs)
+        parsed_data = get_parsed_response_data(response)
+    except ApiError as e:
+        if e.status_code == 429 and client is not None:
+            new_access_token = await io.prompt(
+                prompt="API rate limit exceeded. Enter a new access token", password=True
+            )
+            client.token = new_access_token
+            response = await asyncio_detailed(*args, **kwargs)
+            parsed_data = get_parsed_response_data(response)
+        else:
+            raise e
+
+    return parsed_data
+
+
+async def get_asyncio_detailed(
+    io: IO,
+    asyncio_detailed: Callable[P, Coroutine[Any, Any, Response[ErrorResponse | R]]],
+    *args: P.args,
+    **kwargs: P.kwargs,
+) -> R:
+    response = await run_asyncio_detailed(io, asyncio_detailed, *args, **kwargs)
+    if response is None:
+        raise ApiError(
+            status_code=500, error_detail=ErrorDetail(id="500", name="internal_error", detail="No response data")
+        )
+    return response

ynab_cli/domain/constants.py

@@ -0,0 +1,3 @@
+YNAB_API_URL = "https://api.ynab.com/v1"
+
+UNUSED_PREFIX = "[UNUSED]"

ynab_cli/domain/models/rules.py

@@ -0,0 +1,37 @@
+from typing import Any
+
+from attrs import define as _attrs_define
+
+from ynab_cli.adapters.ynab import models
+
+
+@_attrs_define
+class TransactionRule:
+    # List of rules that follow the rule-engine format for a transaction.
+    #   See: https://zerosteiner.github.io/rule-engine/
+    # The rules are given a TransactionDetail object
+    #   See: https://api.ynab.com/v1#/Transactions/getTransactions
+    rules: list[str]
+
+    # The JSON SaveTransactionWithIdOrImportId to apply to the transaction if the rules are matched.
+    # The id/import_id will be provided. Just fill in what you want to update.
+    #   See: https://api.ynab.com/v1#/Transactions/updateTransactions
+    patch: models.SaveTransactionWithIdOrImportId | None = None
+
+
+@_attrs_define
+class TransactionRules:
+    transaction_rules: list[TransactionRule]
+
+    @classmethod
+    def from_dict(cls, data: dict[str, Any]) -> "TransactionRules":
+        transaction_rules = []
+        for rule in data.get("transaction_rules", []):
+            rules = [str(r) for r in rule.get("rules", [])]
+            patch = None
+            if "patch" in rule:
+                patch = models.SaveTransactionWithIdOrImportId.from_dict(rule["patch"])
+
+            transaction_rules.append(TransactionRule(rules=rules, patch=patch))
+
+        return cls(transaction_rules=transaction_rules)

ynab_cli/domain/ports/__init__.py

@@ -0,0 +1,5 @@
+from ynab_cli.domain.ports.io import IO
+
+__all__ = [
+    "IO",
+]

ynab_cli/domain/ports/io.py

@@ -0,0 +1,63 @@
+from getpass import getpass
+from typing import Protocol
+
+from typing_extensions import override
+
+
+class Progress(Protocol):
+    async def update(
+        self, *, total: float | None = None, completed: float | None = None, advance: float | None = None
+    ) -> None: ...
+
+
+class IO(Protocol):
+    progress: Progress
+
+    async def prompt(self, prompt: str, password: bool = False) -> str: ...
+
+    async def print(self, message: str) -> None: ...
+
+
+class StdProgress(Progress):
+    def __init__(self, io: "StdIO") -> None:
+        self._io = io
+        self._total: float | None = None
+        self._completed: float | None = None
+
+    @override
+    async def update(
+        self, *, total: float | None = None, completed: float | None = None, advance: float | None = None
+    ) -> None:
+        if total is not None:
+            self._total = total
+        if completed is not None:
+            self._completed = completed
+        if advance is not None:
+            if self._completed is None:
+                self._completed = 0
+            self._completed += advance
+
+        if self._total is not None and self._completed is not None:
+            await self._io.print(f"Progress: {self._completed}/{self._total}")
+        elif self._total is not None:
+            await self._io.print(f"Progress: {self._total} to go")
+        elif self._completed is not None:
+            await self._io.print(f"Progress: {self._completed} completed")
+        else:
+            await self._io.print("No progress information available")
+
+
+class StdIO(IO):
+    def __init__(self) -> None:
+        self.progress = StdProgress(self)
+
+    @override
+    async def prompt(self, prompt: str, password: bool = False) -> str:
+        if password:
+            return getpass(prompt)
+        else:
+            return input(prompt)
+
+    @override
+    async def print(self, message: str) -> None:
+        print(message)

ynab_cli/domain/settings.py

@@ -0,0 +1,16 @@
+from attrs import define as _attrs_define
+from attrs import field
+
+
+@_attrs_define
+class YnabSettings:
+    access_token: str = ""
+    budget_id: str = ""
+
+
+@_attrs_define
+class Settings:
+    dry_run: bool = False
+    debug: bool = False
+
+    ynab: YnabSettings = field(factory=YnabSettings)