Upgrade api version to v2 (#136)

* Upgrade api version to v2

* Bump tap version

Author: prijendev

CHANGELOG.md

@@ -1,7 +1,14 @@
 # Changelog
 
+## 4.6.0
+  * Update the access_check to use the v2 `/branches` endpoint instead of the v1 `/settings/organization` endpoint. [#132](https://github.com/singer-io/tap-mambu/pull/132)
+  * Replace the v1 `/settings/organization` endpoint with `/setup/organization` to retrieve timezone information.
+  * Add support for the `timezone` new config property
+    * The `/setup/organization` endpoint requires admin permissions. If admin credentials are not provided, the timezone config value will be used as a fallback.
+
 ## 4.5.0
   * Write `timezone` fetched via API in the config. [#135](https://github.com/singer-io/tap-mambu/pull/135)
+  * Revert changes of [#133](https://github.com/singer-io/tap-mambu/pull/133)
 
 ## 4.4.1
   * Replace /users with /branches endpoint [#133](https://github.com/singer-io/tap-mambu/pull/133)

README.md

@@ -255,12 +255,15 @@ This tap:
         "user_agent": "tap-mambu <api_user_email@your_company.com>",
         "page_size": "500",
         "apikey_audit": "AUDIT_TRAIL_APIKEY",
-        "window_size": 7
+        "window_size": 7,
+        "timezone": "US/Pacific"
     }
     ```
 
     Note: The `window_size` parameter defaults to 1 day, which may cause slowdowns in historical sync for streams utilizing multi-threaded implementation. Conversely, using a larger `window_size` could lead to potential `out-of-memory` issues. It is advisable to select an optimal `window_size` based on the `start_date` and volume of data to mitigate these concerns.
 
+    The `timezone` represents your organization's local timezone. To find the [timezone](https://support.mambu.com/docs/organization-contact-currency-and-timezone) information, go to the main menu and go to Administration > General Setup > Organization Details > Time Zone
+  
     Optionally, also create a `state.json` file. `currently_syncing` is an optional attribute used for identifying the last object to be synced in case the job is interrupted mid-stream. The next run would begin where the last job left off.
 
     ```json

setup.py

@@ -3,7 +3,7 @@
 from setuptools import setup, find_packages
 
 setup(name='tap-mambu',
-      version='4.5.0',
+      version='4.6.0',
       description='Singer.io tap for extracting data from the Mambu 2.0 API',
       author='jeff.huth@bytecode.io',
       classifiers=['Programming Language :: Python :: 3 :: Only'],

tap_mambu/__init__.py

@@ -47,7 +47,6 @@ def main():
         elif parsed_args.catalog:
             sync_all_streams(client=client,
                              config=parsed_args.config,
-                             config_path=parsed_args.config_path,
                              catalog=parsed_args.catalog,
                              state=state)
 

tap_mambu/helpers/client.py

@@ -168,10 +168,10 @@ def check_access(self):
         headers = {}
         # Endpoint: simple API call to return a single record (org settings) to test access
         # https://support.mambu.com/docs/organisational-settings-api#get-organisational-settings
-        endpoint = 'settings/organization'
+        endpoint = 'branches'
         url = '{}/{}'.format(self.base_url, endpoint)
         headers['User-Agent'] = self.__user_agent
-        headers['Accept'] = 'application/vnd.mambu.v1+json'
+        headers['Accept'] = 'application/vnd.mambu.v2+json'
         if use_apikey:
             # Api Key API Consumer Authentication: https://support.mambu.com/docs/api-consumers
             self.__session.headers['apikey'] = self.__apikey

tap_mambu/helpers/datetime_utils.py

@@ -1,8 +1,12 @@
+import singer
 from pytz import timezone
 from datetime import datetime
 from tap_mambu import MambuClient
+from tap_mambu.helpers.client import MambuForbiddenError
 import dateutil.parser
 
+LOGGER = singer.get_logger()
+
 
 _timezone = None
 _datetime_formats = [
@@ -22,11 +26,18 @@
 ]
 
 
-def get_timezone_info(client: MambuClient):
+def get_timezone_info(client: MambuClient, config_timezone: str = None):
     global _timezone
-    response = client.request(method="GET", path="settings/organization", version="v1")
-    _timezone = timezone(response.get("timeZoneID"))
-    return str(_timezone)
+    try:
+        response = client.request(method="GET", path="setup/organization", version="v2")
+        _timezone = timezone(response.get("timeZoneID"))
+    except MambuForbiddenError:
+        if config_timezone:
+            LOGGER.warning("Could not get timezone information from Mambu endpoint, using config timezone")
+            _timezone = timezone(config_timezone)
+        else:
+            raise RuntimeError("Unable to retrieve timezone information from the Mambu endpoint. Please provide administrator credentials or configure valid timezone in the UI(e.g., US/Pacific)." \
+                " Refer this for more details: https://support.mambu.com/docs/organization-contact-currency-and-timezone")
 
 def localize(dttm: datetime) -> datetime:
     if _timezone is None:

tap_mambu/sync.py

@@ -30,22 +30,12 @@ def sync_endpoint(client, catalog, state,
 
     return processor.process_streams_from_generators()
 
-def _write_config(config, config_path, _timezone):
-    with open(config_path, encoding='utf-8') as file:
-        config = json.load(file)
 
-    config['timezone'] = _timezone
-    with open(config_path, 'w', encoding='utf-8') as file:
-        json.dump(config, file, indent=2)
-
-    LOGGER.info("timezone has been updated in config")
-
-def sync_all_streams(client, config, config_path, catalog, state):
+def sync_all_streams(client, config, catalog, state):
     from .tap_generators.child_generator import ChildGenerator
     from .tap_processors.child_processor import ChildProcessor
 
-    _timezone = get_timezone_info(client)
-    _write_config(config, config_path, _timezone)
+    get_timezone_info(client, config_timezone=config.get("timezone"))
 
     selected_streams = get_selected_streams(catalog)
     LOGGER.info('selected_streams: {}'.format(selected_streams))

tests/base.py

@@ -250,6 +250,7 @@ def get_properties(self, original_properties=True):
             'username': os.environ['TAP_MAMBU_USERNAME'],
             'subdomain': os.environ['TAP_MAMBU_SUBDOMAIN'],
             'page_size': '90',
+            'timezone': 'US/Pacific',
             'window_size': 30
         }
 

tests/unittests/test_client.py

@@ -53,8 +53,8 @@ def test_client_check_access_api_key(mock_requests_session_get):
     assert client.base_url == base_url
     assert client.page_size == DEFAULT_PAGE_SIZE
 
-    mock_requests_session_get.assert_called_once_with(url=f'{base_url}/settings/organization',
-                                                      headers={'Accept': 'application/vnd.mambu.v1+json',
+    mock_requests_session_get.assert_called_once_with(url=f'{base_url}/branches',
+                                                      headers={'Accept': 'application/vnd.mambu.v2+json',
                                                                'User-Agent': 'MambuTap-User_Agent_Test'})
 
 
@@ -77,8 +77,8 @@ def test_client_check_access_user_pass(mock_requests_session_get):
     assert client.base_url == base_url
     assert client.page_size == 100
 
-    mock_requests_session_get.assert_called_once_with(url=f'{base_url}/settings/organization',
-                                                      headers={'Accept': 'application/vnd.mambu.v1+json',
+    mock_requests_session_get.assert_called_once_with(url=f'{base_url}/branches',
+                                                      headers={'Accept': 'application/vnd.mambu.v2+json',
                                                                'User-Agent': 'MambuTap'})