switch-api 0.6.30__tar.gz → 0.6.31__tar.gz

{switch_api-0.6.30 → switch_api-0.6.31}/HISTORY.md

@@ -1,5 +1,18 @@
 # History
 
+#0.6.31
+
+### Added
+
+In the `pipeline` module:
+
+- Added optional `email`, `ftp`, `upload`, and `webhook` delivery settings to `Automation.deploy_on_timer()`, allowing scheduled data feeds to retain additional delivery methods.
+
+### Changed
+
+- Timer deployment requests include all four delivery settings while retaining `sourceType: Timer`. Omitted settings, `None`, or empty dictionaries clear the corresponding stored configuration; resupply each setting that should remain enabled.
+- Existing positional arguments and driver `settings` retain their meaning.
+
 #0.6.30
 
 ### Added

{switch_api-0.6.30 → switch_api-0.6.31}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: switch_api
-Version: 0.6.30
+Version: 0.6.31
 Summary: A complete package for data ingestion into the Switch Automation Platform.
 Author: Switch Automation Pty Ltd.
 License: MIT License
@@ -58,6 +58,19 @@ pip install switch_api
 
 # History
 
+#0.6.31
+
+### Added
+
+In the `pipeline` module:
+
+- Added optional `email`, `ftp`, `upload`, and `webhook` delivery settings to `Automation.deploy_on_timer()`, allowing scheduled data feeds to retain additional delivery methods.
+
+### Changed
+
+- Timer deployment requests include all four delivery settings while retaining `sourceType: Timer`. Omitted settings, `None`, or empty dictionaries clear the corresponding stored configuration; resupply each setting that should remain enabled.
+- Existing positional arguments and driver `settings` retain their meaning.
+
 #0.6.30
 
 ### Added

{switch_api-0.6.30 → switch_api-0.6.31}/setup.py

@@ -16,7 +16,7 @@ setup(
     long_description_content_type='text/markdown',
     license='MIT License',
     name="switch_api",
-    version="0.6.30",
+    version="0.6.31",
     packages=find_packages(include=["switch_api", "switch_api.*"]),
     install_requires=['pandas==1.5.3', 'requests', 'azure-storage-blob', 'pandera[io]==0.7.1', 'azure-servicebus',
                       'msal>=1.11.0', 'paho-mqtt==1.6.1', 'uvicorn==0.22.0', 'fastapi==0.98.0', 'pyodbc==4.0.39', 'cachetools==5.5.0', 

{switch_api-0.6.30 → switch_api-0.6.31}/switch_api/__init__.py

@@ -45,4 +45,4 @@ from . import _guide
 # log.addHandler(_ch)
 # https://dev.to/joaomcteixeira/setting-up-python-logging-for-a-library-app-6ml
 
-__version__ = "0.6.30"
+__version__ = "0.6.31"

{switch_api-0.6.30 → switch_api-0.6.31}/switch_api/pipeline/automation.py

@@ -1366,7 +1366,9 @@ class Automation:
                         cron_schedule: str, queue_name: QUEUE_NAME = "task", settings: dict = None,
                         schedule_timezone: SCHEDULE_TIMEZONE = 'Local', timezone_offset_minutes: int = None,
                         data_feed_name: str = None, task_priority: TASK_PRIORITY = 'standard',
-                        task_framework: TASK_FRAMEWORK = 'TaskInsightsEngine'):
+                        task_framework: TASK_FRAMEWORK = 'TaskInsightsEngine',
+                        email: dict = None, ftp: dict = None, upload: dict = None,
+                        webhook: dict = None):
         """Deploy driver to run on timer.
 
         Parameters
@@ -1403,6 +1405,11 @@ class Automation:
             'PythonScriptFramework' for the old task runner engine.
             'TaskInsightsEngine' for the new task running in container apps.
 
+        email, ftp, upload, webhook : dict, optional
+            Independent delivery settings using API camelCase field names; each defaults to None.
+            Timer updates replace all four: None or an empty object clears the corresponding setting.
+            Upload requires a nonempty uploadUrl or ingestUrl; the server generates the actual URLs.
+
         Returns
         -------
         pandas.Dataframe
@@ -1505,6 +1512,10 @@ class Automation:
                 "timezoneOffsetMinutes": timezone_offset_minutes,
                 "scheduleTimezone": schedule_timezone
             },
+            "email": email,
+            "ftp": ftp,
+            "upload": upload,
+            "webhook": webhook,
             "settings": settings
         }
 

{switch_api-0.6.30 → switch_api-0.6.31}/switch_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: switch_api
-Version: 0.6.30
+Version: 0.6.31
 Summary: A complete package for data ingestion into the Switch Automation Platform.
 Author: Switch Automation Pty Ltd.
 License: MIT License
@@ -58,6 +58,19 @@ pip install switch_api
 
 # History
 
+#0.6.31
+
+### Added
+
+In the `pipeline` module:
+
+- Added optional `email`, `ftp`, `upload`, and `webhook` delivery settings to `Automation.deploy_on_timer()`, allowing scheduled data feeds to retain additional delivery methods.
+
+### Changed
+
+- Timer deployment requests include all four delivery settings while retaining `sourceType: Timer`. Omitted settings, `None`, or empty dictionaries clear the corresponding stored configuration; resupply each setting that should remain enabled.
+- Existing positional arguments and driver `settings` retain their meaning.
+
 #0.6.30
 
 ### Added

{switch_api-0.6.30 → switch_api-0.6.31}/switch_api.egg-info/SOURCES.txt

@@ -75,4 +75,5 @@ tests/test_dataset.py
 tests/test_error_handlers.py
 tests/test_initialize.py
 tests/test_integration.py
-tests/test_pipeline.py
+tests/test_pipeline.py
+tests/test_timer_deployment.py

switch_api-0.6.31/tests/test_timer_deployment.py

@@ -0,0 +1,62 @@
+"""Offline payload regression tests for both Timer deployment helpers."""
+import ast
+import itertools
+import json
+import logging
+from pathlib import Path
+from types import SimpleNamespace
+import unittest
+from unittest.mock import Mock
+import uuid
+
+
+class TimerDeploymentTests(unittest.TestCase):
+    def test_delivery_settings(self):
+        root = Path(__file__).resolve().parents[1]
+        for relative, is_api in (
+            ('switch_api/pipeline/automation.py', True),
+            ('switch_guides/switch_guides/pipeline/automation.py', False),
+        ):
+            # Execute the actual helper in isolation from unrelated Azure/task imports.
+            tree = ast.parse((root / relative).read_text(encoding='utf-8'))
+            owner = next(n for n in tree.body if isinstance(n, ast.ClassDef) and n.name == 'Automation') if is_api else tree
+            function = next(n for n in owner.body if isinstance(n, ast.FunctionDef) and n.name == 'deploy_on_timer')
+            function.decorator_list = []
+            function.returns = None
+            for argument in function.args.args:
+                argument.annotation = None
+            requests = SimpleNamespace(post=Mock(return_value=SimpleNamespace(status_code=200, reason='OK', text='', request=SimpleNamespace(url='https://example.invalid'))))
+            namespace = dict(uuid=uuid, logger=logging.getLogger(__name__), requests=requests,
+                             pandas=SimpleNamespace(DataFrame=lambda: None))
+            for name, values in dict(EXPECTED_DELIVERY=('Daily',), SCHEDULE_TIMEZONE=('Local',),
+                                     QUEUE_NAME=('task',), TASK_FRAMEWORK=('TaskInsightsEngine',),
+                                     TASK_PRIORITY=('standard',)).items():
+                namespace[name] = SimpleNamespace(__args__=values)
+            exec(compile(ast.fix_missing_locations(ast.Module(body=[function], type_ignores=[])), relative, 'exec'), namespace)
+            deploy = namespace['deploy_on_timer']
+            inputs = SimpleNamespace(api_base_url='https://example.invalid', bearer_token='test',
+                                     api_headers=SimpleNamespace(default={}), api_projects_endpoint='https://example.invalid/projects',
+                                     api_project_id=str(uuid.uuid4()))
+            task = SimpleNamespace(id=uuid.uuid4(), mapping_entities=['Readings']) if is_api else str(uuid.uuid4())
+            args = (task, inputs, uuid.uuid4(), 'Daily', '0 * * * *')
+            configurations = dict(email={'emailAddressDomain': 'example.invalid'},
+                                  ftp={'ftpUserName': 'test-user', 'ftpPassword': 'test-only'},
+                                  upload={'uploadUrl': 'enabled'},
+                                  webhook={'clientSigningSecret': 'test-only'})
+            for enabled in itertools.product((False, True), repeat=4):
+                optional = {key: value for (key, value), include in zip(configurations.items(), enabled) if include}
+                with self.subTest(helper=relative, enabled=enabled):
+                    deploy(*args, settings={'custom': 'value'}, **optional)
+                    payload = json.loads(json.dumps(requests.post.call_args.kwargs['json']))
+                    self.assertEqual(payload['sourceType'], 'Timer')
+                    self.assertEqual(payload['timer'], dict(cronSchedule='0 * * * *', timezoneOffsetMinutes=0, scheduleTimezone='Local'))
+                    self.assertEqual(payload['settings'], {'custom': 'value'})
+                    for key in configurations:
+                        self.assertEqual(payload[key], optional.get(key))
+            deploy(*args, **dict.fromkeys(configurations, {}))
+            for key in configurations:
+                self.assertEqual(requests.post.call_args.kwargs['json'][key], {})
+
+
+if __name__ == '__main__':
+    unittest.main()