lvi-api-client 0.2.0__tar.gz → 0.2.1__tar.gz

{lvi_api_client-0.2.0 → lvi_api_client-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lvi-api-client
-Version: 0.2.0
+Version: 0.2.1
 Summary: LogicVein API Client Library
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown

lvi_api_client-0.2.1/VERSION

@@ -0,0 +1 @@
+0.2.1

{lvi_api_client-0.2.0 → lvi_api_client-0.2.1}/src/logicvein/lvi_api_client.py

@@ -2907,8 +2907,14 @@ class LogicVeinAPIClient:
         time_zone: str = "Etc/GMT",
         paused: bool = False,
         filter_name: str = "",
+        trigger_id: Optional[int] = None,
     ) -> Optional[Dict[str, Any]]:
-        """Schedule a trigger for an existing job.
+        """Schedule a trigger for an existing job, or change one it has.
+
+        Without ``trigger_id`` this always adds a trigger, even one identical to
+        a trigger the job already has, so each repeat adds another schedule. Use
+        :meth:`get_job_triggers` to check first. With ``trigger_id`` it updates
+        that trigger in place, and every field is set from these arguments.
 
         For a one-time run, pass an ISO datetime string as ``cron_expression``
         (e.g. ``"2026-03-17T09:00"``).  Standard cron syntax works for recurring
@@ -2918,29 +2924,65 @@ class LogicVeinAPIClient:
             job_id (int): ID of the job to schedule (returned by :meth:`save_job`).
             trigger_name (str): Display name for the trigger.
             cron_expression (str): ISO datetime (one-time) or cron expression (recurring).
-            time_zone (str): Timezone name (e.g. ``"America/Halifax"``).  Default ``"UTC"``.
+            time_zone (str): Timezone name (e.g. ``"America/Halifax"``).  Default ``"Etc/GMT"``.
             paused (bool): Whether to create the trigger in a paused state.
             filter_name (str): Optional filter name; pass empty string for none.
+            trigger_id (Optional[int]): ID of the trigger to update, or None to add one.
 
         Returns:
             Dict[str, Any]: The saved trigger record (contains ``triggerId``,
             ``nextExpectedFireTime``, etc.), or None on failure.
         """
-        response = self.call(
-            "Scheduler.saveTrigger",
-            triggerData={
-                "triggerName": trigger_name,
-                "paused": paused,
-                "cronExpression": cron_expression,
-                "timeZone": time_zone,
-                "filterName": filter_name,
-                "jobId": job_id,
-            },
-        )
+        trigger_data: Dict[str, Any] = {
+            "triggerName": trigger_name,
+            "paused": paused,
+            "cronExpression": cron_expression,
+            "timeZone": time_zone,
+            "filterName": filter_name,
+            "jobId": job_id,
+        }
+        if trigger_id is not None:
+            trigger_data["triggerId"] = trigger_id
+        response = self.call("Scheduler.saveTrigger", triggerData=trigger_data)
         if response and isinstance(response, dict) and "result" in response:
             return response["result"]
         return None
 
+    def get_job_triggers(self, job_id: int) -> List[Dict[str, Any]]:
+        """Get the triggers of a job.
+
+        Args:
+            job_id (int): ID of the job. An unknown job has no triggers.
+
+        Returns:
+            List[Dict[str, Any]]: The trigger records (``triggerId``, ``jobId``,
+            ``triggerName``, ``cronExpression``, ``timeZone``, ``paused``,
+            ``filterName``, ``nextExpectedFireTime``, ``accessLimited``). The list
+            is empty only when the server says the job has none.
+
+        Raises:
+            ValueError: If the server's answer is not a list. Callers check this list
+                before adding a trigger, so a failed read must not look like no triggers.
+        """
+        response = self.call("Scheduler.getTriggersOfJob", jobId=job_id)
+        triggers = response.get("result") if isinstance(response, dict) else None
+        if not isinstance(triggers, list):
+            raise ValueError(f"Scheduler.getTriggersOfJob did not return a list for job {job_id}")
+        return triggers
+
+    def delete_trigger(self, trigger_id: int) -> bool:
+        """Delete a trigger.
+
+        Args:
+            trigger_id (int): ID of the trigger to delete.
+
+        Returns:
+            bool: The server's answer. It answers True for a trigger that is
+            already gone, so this does not show that one existed.
+        """
+        response = self.call("Scheduler.deleteTrigger", triggerId=trigger_id)
+        return bool(response and isinstance(response, dict) and response.get("result"))
+
     def create_command_runner_job(
         self,
         device_ip: str,

{lvi_api_client-0.2.0 → lvi_api_client-0.2.1}/src/lvi_api_client.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lvi-api-client
-Version: 0.2.0
+Version: 0.2.1
 Summary: LogicVein API Client Library
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown

{lvi_api_client-0.2.0 → lvi_api_client-0.2.1}/tests/test_server_request_shapes.py

@@ -281,6 +281,54 @@ XML = (
 SAVED = {"Compliance.saveRuleSet": {"ruleSetId": 5, "ruleSetName": "rs1"}}
 
 
+class TestTriggers:
+    TRIGGER = {
+        "triggerName": "t1",
+        "paused": True,
+        "cronExpression": "0 2 * * *",
+        "timeZone": "Etc/GMT",
+        "filterName": "",
+        "jobId": 7,
+    }
+
+    def save(self, connect, **extra):
+        client, server = connect({"Scheduler.saveTrigger": {"triggerId": 3}})
+        saved = client.save_trigger(job_id=7, trigger_name="t1", cron_expression="0 2 * * *", paused=True, **extra)
+        return saved, server.sent("Scheduler.saveTrigger")
+
+    def test_a_save_without_an_id_sends_none_so_the_server_adds_one(self, connect):
+        saved, sent = self.save(connect)
+        assert saved == {"triggerId": 3}
+        assert sent == {"triggerData": self.TRIGGER}
+
+    def test_a_save_with_an_id_sends_it_so_the_server_updates_that_trigger(self, connect):
+        _, sent = self.save(connect, trigger_id=3)
+        assert sent == {"triggerData": {**self.TRIGGER, "triggerId": 3}}
+
+    def test_triggers_of_a_job_are_read_by_job_id(self, connect):
+        rows = [{"triggerId": 3, "triggerName": "t1"}]
+        client, server = connect({"Scheduler.getTriggersOfJob": rows})
+        assert client.get_job_triggers(7) == rows
+        assert server.sent("Scheduler.getTriggersOfJob") == {"jobId": 7}
+
+    def test_a_job_with_no_triggers_gives_an_empty_list(self, connect):
+        client, _ = connect({"Scheduler.getTriggersOfJob": []})
+        assert client.get_job_triggers(7) == []
+
+    @pytest.mark.parametrize("answer", [None, {"result": None}, {}, "<html>error</html>"])
+    def test_an_answer_that_is_not_a_list_raises_rather_than_reading_as_no_triggers(self, connect, answer):
+        client, _ = connect()
+        with patch.object(client, "call", return_value=answer):
+            with pytest.raises(ValueError):
+                client.get_job_triggers(7)
+
+    @pytest.mark.parametrize("answer", [True, False])
+    def test_a_delete_is_by_trigger_id_and_returns_the_answer(self, connect, answer):
+        client, server = connect({"Scheduler.deleteTrigger": answer})
+        assert client.delete_trigger(3) is answer
+        assert server.sent("Scheduler.deleteTrigger") == {"triggerId": 3}
+
+
 class TestCreateRuleSet:
     def test_an_agreeing_document_is_sent_unchanged(self, connect):
         client, server = connect(SAVED)

lvi_api_client-0.2.0/VERSION

@@ -1 +0,0 @@
-0.2.0