python-easyverein 0.2.1__tar.gz → 0.2.2__tar.gz

{python_easyverein-0.2.1 → python_easyverein-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-easyverein
-Version: 0.2.1
+Version: 0.2.2
 Summary: Python library to interact with the EasyVerein API
 Author: Daniel Herrmann
 Author-email: daniel.herrmann1@gmail.com

{python_easyverein-0.2.1 → python_easyverein-0.2.2}/easyverein/__init__.py

@@ -2,7 +2,7 @@
 Middleware for FastAPI that supports authenticating users against Keycloak
 """
 
-__version__ = "0.2.1"
+__version__ = "0.2.2"
 
 # Export EasyVerein API directly
 from .api import EasyvereinAPI  # noqa: F401

{python_easyverein-0.2.1 → python_easyverein-0.2.2}/easyverein/core/client.py

@@ -5,10 +5,11 @@ from __future__ import annotations
 
 import logging
 from pathlib import Path
-from typing import TYPE_CHECKING, TypeVar
+from typing import TYPE_CHECKING, Any, TypeVar
 
 import requests
 from pydantic import BaseModel
+from requests.structures import CaseInsensitiveDict
 
 from .exceptions import (
     EasyvereinAPIException,
@@ -76,8 +77,8 @@ class EasyvereinClient:
         return url
 
     def _do_request(  # noqa: PLR0913
-        self, method, url, data=None, headers=None, files=None
-    ):
+        self, method, url, binary=False, data=None, headers=None, files=None
+    ) -> tuple[int, dict[str, Any] | requests.Response | None]:
         """
         Helper method that performs an actual call against the API,
         fetching the most common errors
@@ -130,6 +131,10 @@ class EasyvereinClient:
         if res.content == b"":
             return res.status_code, None
 
+        # If content is supposed to be binary, return the entire response to maintain headers
+        if binary:
+            return res.status_code, res
+
         # Try to parse response as JSON and return it for further processing
         try:
             content = res.json()
@@ -235,6 +240,25 @@ class EasyvereinClient:
 
         return data, total_count
 
+    def fetch_file(self, url: str) -> tuple[bytes, CaseInsensitiveDict[str]]:
+        """
+        Helper method that fetches a file from the API including the authentication header
+
+        Returns the raw bytes object and the entire header for further processing
+        """
+        status_code, res = self._do_request("get", url, binary=True)
+
+        # Check if status code is 200
+        if status_code != 200:
+            self.logger.error(
+                f"Request to download file failed with unexpected status code {status_code}"
+            )
+            raise EasyvereinAPIException(
+                f"Request to download file failed with unexpected status code {status_code}"
+            )
+
+        return res.content, res.headers
+
     def fetch_one(self, url, model: type[T] = None) -> T | None:
         """
         Helper method that fetches a result from an API call

{python_easyverein-0.2.1 → python_easyverein-0.2.2}/easyverein/models/invoice.py

@@ -39,8 +39,7 @@ class Invoice(EasyVereinBase):
     tax: float | None = None
     taxRate: float | None = None
     taxName: str | None = None
-    # TODO: Add reference to ContactDetails once implemented
-    relatedAddress: EasyVereinReference | None = None
+    relatedAddress: ContactDetails | EasyVereinReference | None = None
     path: EasyVereinReference | None = None
     kind: Literal[
         "balance", "donation", "membership", "revenue", "expense", "cancel", "credit"
@@ -129,5 +128,6 @@ class InvoiceFilter(BaseModel):
     search: str | None = None
 
 
+from .contact_details import ContactDetails  # noqa: E402
 from .invoice_item import InvoiceItem  # noqa: E402
 from .member import Member  # noqa: E402

{python_easyverein-0.2.1 → python_easyverein-0.2.2}/easyverein/modules/invoice.py

@@ -2,6 +2,8 @@ import logging
 from pathlib import Path
 from typing import List
 
+from requests.structures import CaseInsensitiveDict
+
 from ..core.client import EasyvereinClient
 from ..core.exceptions import EasyvereinAPIException
 from ..models.invoice import Invoice, InvoiceCreate, InvoiceFilter, InvoiceUpdate
@@ -125,3 +127,46 @@ class InvoiceMixin(
             inv = self.get_by_id(inv.id)
 
         return inv
+
+    def get_attachment(
+        self, invoice: Invoice | int
+    ) -> tuple[bytes, CaseInsensitiveDict[str]]:
+        """
+        This method downloads and returns the invoice attachment if available.
+
+        It accepts either an invoice object or its id. If the invoice is given, and the path attribute is
+        set, it will simply use this path to download and return the file. In all other cases, it first retrieves
+        the invoice object by id and then proceeds to download the file.
+
+        Returns a tuple, where the first element is the file and the second contains the headers of the response
+
+        **Usage**
+
+        ```python
+        invoice = ev_connection.invoice.get_by_id(invoice_id, query="{id,path}")
+
+        attachment, headers = ev_connection.invoice.get_attachment(invoice)
+        ```
+
+        Args:
+            invoice: The invoice object or its id for which the attachment should be retrieved
+        """
+        if isinstance(invoice, Invoice) and invoice.path:
+            self.logger.info(
+                "Invoice already has the path attribute set, using that path."
+            )
+            path = invoice.path
+        else:
+            self.logger.info(
+                "Invoice is either given by id or doesn't contain the path attribute"
+            )
+            invoice_id = invoice.id if isinstance(invoice, Invoice) else invoice
+            fetched_invoice = self.get_by_id(invoice_id, query="{id,path}")
+            path = fetched_invoice.path
+
+        if not path:
+            raise EasyvereinAPIException(
+                "Unable to obtain a valid path for given invoice."
+            )
+
+        return self.c.fetch_file(path)

{python_easyverein-0.2.1 → python_easyverein-0.2.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "python-easyverein"
-version = "0.2.1"
+version = "0.2.2"
 description = "Python library to interact with the EasyVerein API"
 authors = ["Daniel Herrmann <daniel.herrmann1@gmail.com>"]
 readme = "README.md"