MambuPy 2.4.0__tar.gz → 2.5.0__tar.gz

{mambupy-2.4.0 → mambupy-2.5.0}/MambuPy/__init__.py

@@ -37,7 +37,7 @@ import sys
 from importlib.abc import MetaPathFinder
 from importlib.util import spec_from_file_location
 
-__version__ = "2.4.0"
+__version__ = "2.5.0"
 """The version of this module."""
 
 

{mambupy-2.4.0/mambupy → mambupy-2.5.0/MambuPy}/api/__init__.py

@@ -20,6 +20,7 @@ Objects using `Mambu REST API <https://api.mambu.com/?python>`_
     MambuPy.api.mambuuser
     MambuPy.api.mambutask
     MambuPy.api.mambucustomfield
+    MambuPy.api.mambuholiday
 
 Entities use the Mixin pattern to acquire functionality.
 """

{mambupy-2.4.0 → mambupy-2.5.0}/MambuPy/api/connector/mambuconnector.py

@@ -138,6 +138,28 @@ class MambuConnectorReader(ABC):
         """
         raise NotImplementedError
 
+    @abstractmethod
+    def mambu_organization_get_holidays(self):
+        """Retrieves the holidays of the organization.
+
+        Both the general holidays and the non-working days of the week.
+        """
+        raise NotImplementedError
+
+    @abstractmethod
+    def mambu_organization_get_non_working_days(self):
+        """Retrieves the non-working days of the week of the organization."""
+        raise NotImplementedError
+
+    @abstractmethod
+    def mambu_organization_get_holiday(self, holidayid):
+        """Retrieves a single general holiday of the organization.
+
+        Args:
+          holidayid (str): the id or encoded key of the holiday
+        """
+        raise NotImplementedError
+
 
 class MambuConnectorWriter(ABC):
     """Interface for Writers.
@@ -326,3 +348,51 @@ class MambuConnectorWriter(ABC):
           notes (str): notes to associate to the transaction adjustment in Mambu
         """
         raise NotImplementedError
+
+    @abstractmethod
+    def mambu_organization_update_holidays(self, holidays):
+        """Updates the holidays of the organization
+
+        Mambu replaces the whole configuration with the one given, so the
+        complete set of holidays and non-working days must be sent, not just
+        the modified ones.
+
+        Args:
+          holidays (dict): holidays of the organization, complying with
+                   Mambu's schema
+        """
+        raise NotImplementedError
+
+    @abstractmethod
+    def mambu_organization_update_non_working_days(self, nonWorkingDays):
+        """Updates the non-working days of the week of the organization
+
+        Mambu replaces the whole set with the days given.
+
+        Args:
+          nonWorkingDays (list of str): days of the week on which the
+                         organization does not operate
+        """
+        raise NotImplementedError
+
+    @abstractmethod
+    def mambu_organization_create_holidays(self, holidays):
+        """Creates general holidays for the organization
+
+        Mambu adds them to the ones already configured, all in a single
+        request.
+
+        Args:
+          holidays (list of dict): the holidays to create, complying with
+                   Mambu's schema
+        """
+        raise NotImplementedError
+
+    @abstractmethod
+    def mambu_organization_delete_holiday(self, holidayid):
+        """Deletes a general holiday of the organization
+
+        Args:
+          holidayid (str): the id of the holiday to be deleted
+        """
+        raise NotImplementedError

{mambupy-2.4.0/mambupy → mambupy-2.5.0/MambuPy}/api/connector/rest.py

@@ -21,6 +21,7 @@ from requests_toolbelt.multipart.encoder import MultipartEncoder
 
 from .mambuconnector import MambuConnector, MambuConnectorReader, MambuConnectorWriter
 from .rest_helpers import _MambuJSONEncoder, _configure_retry_strategy
+from .rest_holidays import MambuConnectorRESTHolidays
 from MambuPy.mambuutil import (
     ALLOWED_UPLOAD_MIMETYPES,
     DETAILSLEVEL,
@@ -85,8 +86,17 @@ class SessionSingleton:
         return self.__session
 
 
-class MambuConnectorREST(MambuConnector, MambuConnectorReader, MambuConnectorWriter):
-    """A connector for Mambu REST API"""
+class MambuConnectorREST(
+    MambuConnectorRESTHolidays,
+    MambuConnector,
+    MambuConnectorReader,
+    MambuConnectorWriter,
+):
+    """A connector for Mambu REST API
+
+    Endpoint mixins come first: their implementations must win over the
+    abstract methods the interfaces declare for them.
+    """
 
     _RETRIES = 5
     _tenant = ""
@@ -240,6 +250,14 @@ url %s, params %s, data %s, headers %s",
 
         return resp.content
 
+    _request = __request
+    """protected alias of the private request method
+
+       Name mangling resolves ``__request`` against the class where it is
+       written, so it is out of reach for an endpoint mixin living in another
+       module. Those mixins call this alias instead.
+    """
+
     def __list_request_args(self, params):
         if not params:
             params = {}

mambupy-2.5.0/MambuPy/api/connector/rest_holidays.py

@@ -0,0 +1,133 @@
+"""Holidays endpoints for the REST connector.
+
+.. autosummary::
+   :nosignatures:
+   :toctree: _autosummary
+"""
+
+
+class MambuConnectorRESTHolidays:
+    """Holidays endpoints of the organization.
+
+    A mixin, not a connector of its own: it builds the URLs and leans on the
+    request machinery of
+    :py:obj:`MambuPy.api.connector.rest.MambuConnectorREST`, the class that
+    mixes it in.
+    """
+
+    def mambu_organization_get_holidays(self):
+        """Retrieves the holidays of the organization.
+
+        Both the general holidays and the non-working days of the week.
+
+        Returns:
+          response content (str json {})
+        """
+        url = "https://{}/api/organization/holidays".format(self._tenant)
+
+        return self._request("GET", url)
+
+    def mambu_organization_update_holidays(self, holidays):
+        """Updates the holidays of the organization
+
+        Mambu replaces the whole configuration with the one given, so the
+        complete set of holidays and non-working days must be sent, not just
+        the modified ones.
+
+        Mambu processes holidays asynchronously: this fails with errorCode
+        3633, ANOTHER_TASK_IN_PROGRESS, while a previous holidays operation
+        is still running. The error is transient and is not retried here.
+
+        Args:
+          holidays (dict): holidays of the organization, complying with
+                   Mambu's schema
+
+        Returns:
+          response content (str json {})
+        """
+        url = "https://{}/api/organization/holidays".format(self._tenant)
+
+        return self._request("PUT", url, data=holidays)
+
+    def mambu_organization_get_non_working_days(self):
+        """Retrieves the non-working days of the week of the organization.
+
+        Returns:
+          response content (str json {})
+        """
+        url = "https://{}/api/organization/holidays/nonworkingdays".format(self._tenant)
+
+        return self._request("GET", url)
+
+    def mambu_organization_update_non_working_days(self, nonWorkingDays):
+        """Updates the non-working days of the week of the organization
+
+        Mambu replaces the whole set with the days given.
+
+        Mambu processes holidays asynchronously: this fails with errorCode
+        3633, ANOTHER_TASK_IN_PROGRESS, while a previous holidays operation
+        is still running. The error is transient and is not retried here.
+
+        Args:
+          nonWorkingDays (list of str): days of the week on which the
+                         organization does not operate
+
+        Returns:
+          response content (str json {})
+        """
+        url = "https://{}/api/organization/holidays/nonworkingdays".format(self._tenant)
+        data = {"nonWorkingDays": nonWorkingDays}
+
+        return self._request("PUT", url, data=data)
+
+    def mambu_organization_create_holidays(self, holidays):
+        """Creates general holidays for the organization
+
+        Mambu adds them to the ones already configured, all in a single
+        request.
+
+        Mambu processes holidays asynchronously: this fails with errorCode
+        3633, ANOTHER_TASK_IN_PROGRESS, while a previous holidays operation
+        is still running. The error is transient and is not retried here.
+
+        Args:
+          holidays (list of dict): the holidays to create, complying with
+                   Mambu's schema
+
+        Returns:
+          response content (str json [])
+        """
+        url = "https://{}/api/organization/holidays/general".format(self._tenant)
+
+        return self._request("POST", url, data=holidays)
+
+    def mambu_organization_get_holiday(self, holidayid):
+        """Retrieves a single general holiday of the organization.
+
+        Args:
+          holidayid (str): the id or encoded key of the holiday
+
+        Returns:
+          response content (str json {})
+        """
+        url = "https://{}/api/organization/holidays/general/{}".format(
+            self._tenant, holidayid
+        )
+
+        return self._request("GET", url)
+
+    def mambu_organization_delete_holiday(self, holidayid):
+        """Deletes a general holiday of the organization
+
+        Mambu processes holidays asynchronously: this fails with errorCode
+        3633, ANOTHER_TASK_IN_PROGRESS, while a previous holidays operation
+        is still running. The error is transient and is not retried here.
+
+        Args:
+          holidayid (str): the id of the holiday to be deleted
+        """
+        url = "https://{}/api/organization/holidays/general/{}".format(
+            self._tenant, holidayid
+        )
+
+        return self._request("DELETE", url)

mambupy-2.5.0/MambuPy/api/mambuholiday.py

@@ -0,0 +1,272 @@
+"""MambuHolidays: the holidays configuration of the organization.
+
+.. autosummary::
+   :nosignatures:
+   :toctree: _autosummary
+"""
+
+import copy
+
+import orjson
+
+from .connector.rest import MambuConnectorREST
+from .mambustruct import MambuStruct
+from .vos import MambuHoliday
+from MambuPy.mambuutil import MambuPyError
+
+
+class MambuHolidays(MambuStruct):
+    """The holidays of the organization.
+
+    Holds the general holidays, a list of
+    :py:obj:`MambuPy.api.vos.MambuHoliday`, and the non-working days of the
+    week: the two halves of Mambu's organization wide holidays configuration.
+
+    This is not a :py:obj:`MambuPy.api.entities.MambuEntity`, because Mambu
+    does not expose the holidays as one: there is a single configuration for
+    the whole organization, with no id to get one by, nothing to list and
+    nothing to search. What it does offer is adding and removing single
+    holidays, given here as methods over the configuration they belong to.
+
+    Getting the configuration is the usual entry point::
+
+      holidays = MambuHolidays.get()
+
+    Operating single holidays doesn't need it, an instance with no data is
+    enough to reach Mambu::
+
+      holiday = MambuHolidays().get_holiday("1")
+
+    Mambu processes holidays asynchronously: a write answers before the change
+    is fully applied, and any holidays operation sent while a previous one is
+    still running is rejected with errorCode 3633, ANOTHER_TASK_IN_PROGRESS.
+    The error is transient, it only means Mambu is still busy, and MambuPy does
+    not retry on its own: whether and when to try again is left to the caller.
+    Seen on a sandbox tenant, where a delete issued right after a create needed
+    around thirty seconds of waiting before it went through.
+    """
+
+    _connector = None
+    """Default connector (REST)"""
+
+    _vos = [("holidays", "MambuHoliday")]
+    """2-tuples of elements and Value Objects"""
+
+    _accepted_non_working_days = [
+        "MONDAY",
+        "TUESDAY",
+        "WEDNESDAY",
+        "THURSDAY",
+        "FRIDAY",
+        "SATURDAY",
+        "SUNDAY",
+    ]
+    """days of the week accepted by Mambu as non-working days"""
+
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
+        if "connector" not in kwargs:
+            self._connector = MambuConnectorREST(**kwargs)
+        else:
+            self._connector = kwargs["connector"]
+
+    def __repr__(self):
+        """Prints class, number of holidays and the non-working days"""
+        try:
+            return self.__class__.__name__ + " - holidays: %s, nonWorkingDays: %s" % (
+                len(self._attrs["holidays"]),
+                self._attrs["nonWorkingDays"],
+            )
+        except Exception:
+            return super().__repr__()
+
+    @staticmethod
+    def _build_holiday(attrs):
+        """Builds a MambuHoliday from the attrs of a Mambu response.
+
+        Args:
+          attrs (dict): the values of a single holiday.
+
+        Returns:
+          instance of :py:obj:`MambuPy.api.vos.MambuHoliday`
+        """
+        holiday = MambuHoliday(**attrs)
+        holiday._tzattrs = copy.deepcopy(attrs)
+        holiday._convertDict2Attrs()
+
+        return holiday
+
+    def _hydrate(self, resp):
+        """Builds the holidays configuration from a Mambu response.
+
+        Args:
+          resp (bytes): a Mambu response holding a holidays configuration.
+        """
+        self._attrs = dict(orjson.loads(resp.decode()))
+        self._tzattrs = dict(orjson.loads(resp.decode()))
+        self._convertDict2Attrs()
+        self._extractVOs()
+
+    @classmethod
+    def get(cls, **kwargs):
+        """get the holidays of the organization.
+
+        Args:
+          kwargs (dict): keyword arguments for this method.
+                         May include a user, pwd and url to connect to Mambu.
+
+        Returns:
+          instance of MambuHolidays with data from Mambu
+        """
+        connector = MambuConnectorREST(**kwargs)
+        instance = cls(connector=connector)
+        instance._hydrate(connector.mambu_organization_get_holidays())
+
+        return instance
+
+    def refresh(self, **kwargs):
+        """get again the holidays of the organization.
+
+        Updates _attrs with responded data, losing any local change.
+        """
+        self._hydrate(self._connector.mambu_organization_get_holidays())
+
+    def update(self, **kwargs):
+        """Request to update the holidays of the organization.
+
+        Mambu replaces the whole configuration with what is sent, so the
+        complete set of holidays and non-working days is written, not just
+        the modified ones: dropping a holiday from the list deletes it.
+
+        kwargs (dict): keyword arguments for this method.
+
+        Raises:
+          `MambuError`: errorCode 3633, ANOTHER_TASK_IN_PROGRESS, if Mambu is
+                        still processing a previous holidays operation. It is
+                        transient, retrying is up to the caller.
+        """
+        self._updateVOs()
+        self._serializeFields()
+        try:
+            resp = self._connector.mambu_organization_update_holidays(
+                copy.deepcopy(self._attrs)
+            )
+        finally:
+            self._convertDict2Attrs()
+            self._extractVOs()
+
+        self._hydrate(resp)
+
+    def get_non_working_days(self, **kwargs):
+        """get the non-working days of the week of the organization.
+
+        Updates nonWorkingDays with responded data.
+
+        Returns:
+          list of str, the days of the week on which the organization does
+          not operate
+        """
+        resp = self._connector.mambu_organization_get_non_working_days()
+        self._attrs["nonWorkingDays"] = orjson.loads(resp.decode())["nonWorkingDays"]
+
+        return self._attrs["nonWorkingDays"]
+
+    def update_non_working_days(self, nonWorkingDays=None, **kwargs):
+        """Request to update the non-working days of the week.
+
+        Mambu replaces the whole set with the days sent.
+
+        Args:
+          nonWorkingDays (list of str): days of the week on which the
+                         organization does not operate. Defaults to the days
+                         currently held by this configuration.
+
+        Raises:
+          `MambuPyError`: if a day is not in _accepted_non_working_days
+          `MambuError`: errorCode 3633, ANOTHER_TASK_IN_PROGRESS, if Mambu is
+                        still processing a previous holidays operation. It is
+                        transient, retrying is up to the caller.
+        """
+        if nonWorkingDays is None:
+            nonWorkingDays = self._attrs.get("nonWorkingDays", [])
+
+        for day in nonWorkingDays:
+            if day not in self._accepted_non_working_days:
+                raise MambuPyError(
+                    "day {} not in allowed _accepted_non_working_days: {}".format(
+                        day, self._accepted_non_working_days
+                    )
+                )
+
+        resp = self._connector.mambu_organization_update_non_working_days(
+            list(nonWorkingDays)
+        )
+        self._attrs["nonWorkingDays"] = orjson.loads(resp.decode())["nonWorkingDays"]
+
+    def get_holiday(self, holidayid, **kwargs):
+        """get a single general holiday, identified by its holidayid.
+
+        Args:
+          holidayid (str): the id or encoded key of the holiday
+
+        Returns:
+          instance of :py:obj:`MambuPy.api.vos.MambuHoliday` with data from
+          Mambu
+        """
+        resp = self._connector.mambu_organization_get_holiday(holidayid)
+
+        return self._build_holiday(dict(orjson.loads(resp.decode())))
+
+    def add_holidays(self, holidays, **kwargs):
+        """Request to add general holidays to the organization.
+
+        Mambu creates them all in a single request, adding them to the ones
+        already configured, unlike `update`, which replaces everything.
+
+        The holidays given are serialized on a copy, so the caller's objects
+        keep their datetimes instead of being turned into strings.
+
+        Args:
+          holidays (list of :py:obj:`MambuPy.api.vos.MambuHoliday`): the
+                   holidays to create.
+
+        Returns:
+          list of :py:obj:`MambuPy.api.vos.MambuHoliday`, the created holidays
+          as Mambu returned them
+
+        Raises:
+          `MambuError`: errorCode 3633, ANOTHER_TASK_IN_PROGRESS, if Mambu is
+                        still processing a previous holidays operation. It is
+                        transient, retrying is up to the caller.
+        """
+        payload = []
+        for holiday in holidays:
+            serialized = copy.deepcopy(holiday)
+            serialized._serializeFields()
+            payload.append(serialized._attrs)
+
+        resp = self._connector.mambu_organization_create_holidays(payload)
+        created = [
+            self._build_holiday(holiday) for holiday in orjson.loads(resp.decode())
+        ]
+
+        self.refresh()
+
+        return created
+
+    def delete_holiday(self, holidayid, **kwargs):
+        """Request to delete a general holiday of the organization.
+
+        Args:
+          holidayid (str): the id of the holiday to be deleted. Mambu does not
+                    accept an encoded key here.
+
+        Raises:
+          `MambuError`: errorCode 3633, ANOTHER_TASK_IN_PROGRESS, if Mambu is
+                        still processing a previous holidays operation. Right
+                        after adding a holiday this is the expected answer for
+                        a while. It is transient, retrying is up to the caller.
+        """
+        self._connector.mambu_organization_delete_holiday(holidayid)
+
+        self.refresh()

{mambupy-2.4.0 → mambupy-2.5.0}/MambuPy/api/vos.py

@@ -54,6 +54,15 @@ class MambuGroupRole(MambuValueObject):
     """Group member role"""
 
 
+class MambuHoliday(MambuValueObject):
+    """Holiday of the organization.
+
+    A day on which the organization does not operate, part of the holidays
+    configuration managed by
+    :py:obj:`MambuPy.api.mambuholiday.MambuHolidays`.
+    """
+
+
 class MambuDisbursementLoanTransactionInput(MambuValueObject):
     """Disbursment Loan Transaction body"""
 

{mambupy-2.4.0 → mambupy-2.5.0}/MambuPy.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: MambuPy
-Version: 2.4.0
+Version: 2.5.0
 Summary: A python library for using Mambu APIs.
 Author-email: "Javier Novoa C." <jstitch@gmail.com>
 License: LICENSE

{mambupy-2.4.0 → mambupy-2.5.0}/MambuPy.egg-info/SOURCES.txt

@@ -19,6 +19,7 @@ MambuPy/api/mambucentre.py
 MambuPy/api/mambuclient.py
 MambuPy/api/mambucustomfield.py
 MambuPy/api/mambugroup.py
+MambuPy/api/mambuholiday.py
 MambuPy/api/mambuloan.py
 MambuPy/api/mambuproduct.py
 MambuPy/api/mamburole.py
@@ -31,6 +32,7 @@ MambuPy/api/connector/__init__.py
 MambuPy/api/connector/mambuconnector.py
 MambuPy/api/connector/rest.py
 MambuPy/api/connector/rest_helpers.py
+MambuPy/api/connector/rest_holidays.py
 MambuPy/orm/__init__.py
 MambuPy/orm/schema_activities.py
 MambuPy/orm/schema_addresses.py
@@ -63,6 +65,7 @@ mambupy/api/mambucentre.py
 mambupy/api/mambuclient.py
 mambupy/api/mambucustomfield.py
 mambupy/api/mambugroup.py
+mambupy/api/mambuholiday.py
 mambupy/api/mambuloan.py
 mambupy/api/mambuproduct.py
 mambupy/api/mamburole.py
@@ -75,6 +78,7 @@ mambupy/api/connector/__init__.py
 mambupy/api/connector/mambuconnector.py
 mambupy/api/connector/rest.py
 mambupy/api/connector/rest_helpers.py
+mambupy/api/connector/rest_holidays.py
 mambupy/orm/__init__.py
 mambupy/orm/schema_activities.py
 mambupy/orm/schema_addresses.py

{mambupy-2.4.0 → mambupy-2.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: MambuPy
-Version: 2.4.0
+Version: 2.5.0
 Summary: A python library for using Mambu APIs.
 Author-email: "Javier Novoa C." <jstitch@gmail.com>
 License: LICENSE

{mambupy-2.4.0 → mambupy-2.5.0}/mambupy/__init__.py

@@ -37,7 +37,7 @@ import sys
 from importlib.abc import MetaPathFinder
 from importlib.util import spec_from_file_location
 
-__version__ = "2.4.0"
+__version__ = "2.5.0"
 """The version of this module."""
 
 

{mambupy-2.4.0/MambuPy → mambupy-2.5.0/mambupy}/api/__init__.py

@@ -20,6 +20,7 @@ Objects using `Mambu REST API <https://api.mambu.com/?python>`_
     MambuPy.api.mambuuser
     MambuPy.api.mambutask
     MambuPy.api.mambucustomfield
+    MambuPy.api.mambuholiday
 
 Entities use the Mixin pattern to acquire functionality.
 """