chartremotely 0.2.3__tar.gz → 0.2.4__tar.gz

{chartremotely-0.2.3 → chartremotely-0.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: chartremotely
-Version: 0.2.3
+Version: 0.2.4
 Summary: Remote control of desktop charting applications on macOS
 Author: Lonnie VanZandt
 License: 
@@ -313,6 +313,22 @@ certificate to keep alive. Pairing alone does not start it: a display that is
 paired but has no `relay` running reports `connected: false` and silently
 ignores everything sent to it.
 
+## Voice
+
+"Hey Siri, ChartRemotely" asks three questions:
+
+1. **Which company?** — a spoken name or a spelled ticker.
+2. **What scale?** — a time frame mnemonic (below), or "as is".
+3. **Where?** — which display, by the name it was paired under. Say this
+   Mac's own name to stay here.
+
+The Shortcut talks to one Mac — the one that made it. When "Where?" names
+another of your displays, that Mac hands the command to the operator, which
+finds the display among yours by name only (case, spaces, hyphens,
+underscores and dots do not count: "Mac mini" is "mac-mini") and relays it.
+The reply you hear is the other display's. An unknown name is answered with
+the names you do have.
+
 ## Running it as a service
 
 `chartremotely setup` installs both transports as launchd agents

{chartremotely-0.2.3 → chartremotely-0.2.4}/README.md

@@ -89,6 +89,22 @@ certificate to keep alive. Pairing alone does not start it: a display that is
 paired but has no `relay` running reports `connected: false` and silently
 ignores everything sent to it.
 
+## Voice
+
+"Hey Siri, ChartRemotely" asks three questions:
+
+1. **Which company?** — a spoken name or a spelled ticker.
+2. **What scale?** — a time frame mnemonic (below), or "as is".
+3. **Where?** — which display, by the name it was paired under. Say this
+   Mac's own name to stay here.
+
+The Shortcut talks to one Mac — the one that made it. When "Where?" names
+another of your displays, that Mac hands the command to the operator, which
+finds the display among yours by name only (case, spaces, hyphens,
+underscores and dots do not count: "Mac mini" is "mac-mini") and relays it.
+The reply you hear is the other display's. An unknown name is answered with
+the names you do have.
+
 ## Running it as a service
 
 `chartremotely setup` installs both transports as launchd agents

{chartremotely-0.2.3 → chartremotely-0.2.4}/chartremotely/assets/shortcut-template.plist

@@ -1039,6 +1039,21 @@
 				<integer>2</integer>
 			</dict>
 		</dict>
+		<dict>
+			<key>WFWorkflowActionIdentifier</key>
+			<string>is.workflow.actions.ask</string>
+			<key>WFWorkflowActionParameters</key>
+			<dict>
+				<key>CustomOutputName</key>
+				<string>Where</string>
+				<key>UUID</key>
+				<string>6F0B7C51-2D4E-4A8B-9C3F-0E5D8A1B7C42</string>
+				<key>WFAskActionPrompt</key>
+				<string>Where?</string>
+				<key>WFInputType</key>
+				<string>Text</string>
+			</dict>
+		</dict>
 		<dict>
 			<key>WFWorkflowActionIdentifier</key>
 			<string>is.workflow.actions.downloadurl</string>
@@ -1160,6 +1175,42 @@
 									<string>WFTextTokenString</string>
 								</dict>
 							</dict>
+							<dict>
+								<key>WFItemType</key>
+								<integer>0</integer>
+								<key>WFKey</key>
+								<dict>
+									<key>Value</key>
+									<dict>
+										<key>string</key>
+										<string>where</string>
+									</dict>
+									<key>WFSerializationType</key>
+									<string>WFTextTokenString</string>
+								</dict>
+								<key>WFValue</key>
+								<dict>
+									<key>Value</key>
+									<dict>
+										<key>attachmentsByRange</key>
+										<dict>
+											<key>{0, 1}</key>
+											<dict>
+												<key>OutputName</key>
+												<string>Where</string>
+												<key>OutputUUID</key>
+												<string>6F0B7C51-2D4E-4A8B-9C3F-0E5D8A1B7C42</string>
+												<key>Type</key>
+												<string>ActionOutput</string>
+											</dict>
+										</dict>
+										<key>string</key>
+										<string></string>
+									</dict>
+									<key>WFSerializationType</key>
+									<string>WFTextTokenString</string>
+								</dict>
+							</dict>
 						</array>
 					</dict>
 					<key>WFSerializationType</key>

{chartremotely-0.2.3 → chartremotely-0.2.4}/chartremotely/config.py

@@ -34,6 +34,8 @@ DEFAULTS: dict = {
     "operator_url": None,
     "agent_id": None,
     "agent_secret": None,
+    # This display's name at the operator, for "Where?" in the Shortcut.
+    "display_label": None,
     "token": None,
     "port": 8899,
 }

chartremotely-0.2.4/chartremotely/forward.py

@@ -0,0 +1,90 @@
+"""Send a spoken command on to another of the owner's displays.
+
+The Shortcut asks "Where?" and passes the dictated answer through verbatim.
+Empty, or this Mac's own name, means this Mac. Any other name goes to the
+operator's ``/agent/forward``, which looks it up among the SAME owner's
+displays by name only and relays the command there; the target's reply is
+what gets spoken. No inference here and none at the operator: the name is
+compared ignoring case, spaces, hyphens, underscores and dots, and that is all.
+
+Stdlib only, like the relay, so it imports where the macOS drivers do not.
+"""
+
+from __future__ import annotations
+
+import json
+import re
+import urllib.error
+import urllib.request
+
+from . import config
+
+ERR = "ERR "
+#: Longer than the operator's own wait on the target, so its 504 arrives first.
+TIMEOUT = 35.0
+
+_NAME_NOISE = re.compile(r"[\s\-_.]+")
+
+
+def display_key(name: str) -> str:
+    """A display name as it is matched. The operator's ``display_key``, exactly."""
+    return _NAME_NOISE.sub("", name or "").lower()
+
+
+def is_here(where: str, cfg: dict) -> bool:
+    """Whether ``where`` means this Mac: empty, its display name, or its agent_id."""
+    wanted = (where or "").strip()
+    if not wanted:
+        return True
+    label = cfg.get("display_label") or ""
+    return wanted == cfg.get("agent_id") or bool(label) and display_key(wanted) == display_key(label)
+
+
+def _post(url: str, payload: dict) -> tuple[int, dict]:
+    """POST JSON; the status and the JSON body, for error statuses too."""
+    request = urllib.request.Request(
+        url, data=json.dumps(payload).encode(), method="POST",
+        headers={"Content-Type": "application/json"})
+    try:
+        with urllib.request.urlopen(request, timeout=TIMEOUT) as response:
+            status, raw = response.status, response.read()
+    except urllib.error.HTTPError as exc:
+        status, raw = exc.code, exc.read()
+    try:
+        body = json.loads(raw.decode("utf-8", "replace") or "{}")
+    except ValueError:
+        body = {}
+    return status, body if isinstance(body, dict) else {}
+
+
+def route(command: str, where: str, cfg: dict | None = None) -> str | None:
+    """The reply of the display named ``where``, or None when that display is this Mac.
+
+    Never raises: every failure is a short ``ERR`` sentence to be spoken.
+    """
+    cfg = cfg or config.load()
+    if is_here(where, cfg):
+        return None
+    base = (cfg.get("operator_url") or "").rstrip("/")
+    agent_id, secret = cfg.get("agent_id"), cfg.get("agent_secret")
+    if not (base and agent_id and secret):
+        return ERR + "This Mac is not paired, so it can only drive its own chart."
+    wanted = where.strip()
+    try:
+        status, body = _post(f"{base}/agent/forward",
+                             {"agent_id": agent_id, "secret": secret,
+                              "display": wanted, "cmd": command})
+    except (urllib.error.URLError, TimeoutError, OSError):
+        return ERR + "I could not reach the operator."
+    if status == 200 and body.get("self"):
+        # Told its own name: remember it, so next time needs no round trip.
+        if body.get("display"):
+            config.update(display_label=str(body["display"]))
+        return None
+    if status == 200:
+        return str(body.get("reply") or "")
+    if status == 404:
+        names = [str(n) for n in body.get("displays") or []]
+        yours = f" Yours: {', '.join(names)}." if names else ""
+        return ERR + f'No display named "{wanted}".{yours}'
+    return ERR + str(body.get("error") or f"the operator answered {status}")

{chartremotely-0.2.3 → chartremotely-0.2.4}/chartremotely/server.py

@@ -17,7 +17,7 @@ import secrets
 import urllib.parse
 from http.server import BaseHTTPRequestHandler, HTTPServer
 
-from . import config, push
+from . import config, forward, push
 from .vocab import answer
 
 
@@ -42,13 +42,16 @@ class Handler(BaseHTTPRequestHandler):
             return self._reply(403, "ERR forbidden")
         length = int(self.headers.get("Content-Length") or 0)
         raw = self.rfile.read(length).decode("utf-8", "replace").strip()
+        where = ""
         # Shortcuts posts JSON most cleanly; curl and scripts post raw text.
         if raw.startswith("{"):
             try:
-                raw = str(json.loads(raw).get("cmd") or "").strip()
-            except ValueError:
+                body = json.loads(raw)
+                raw = str(body.get("cmd") or "").strip()
+                where = str(body.get("where") or "").strip()
+            except (ValueError, AttributeError):
                 return self._reply(400, "ERR bad JSON")
-        self._answer(raw)
+        self._answer(raw, where)
 
     def do_GET(self) -> None:
         parsed = urllib.parse.urlparse(self.path)
@@ -57,10 +60,19 @@ class Handler(BaseHTTPRequestHandler):
         query = urllib.parse.parse_qs(parsed.query)
         if not self._authorised((query.get("t") or [None])[0]):
             return self._reply(403, "ERR forbidden")
-        self._answer((query.get("cmd") or [""])[0].strip())
+        self._answer((query.get("cmd") or [""])[0].strip(),
+                     (query.get("where") or [""])[0].strip())
 
-    def _answer(self, request: str) -> None:
-        """Reply first; only then schedule the picture of a changed chart."""
+    def _answer(self, request: str, where: str = "") -> None:
+        """Reply first; only then schedule the picture of a changed chart.
+
+        ``where`` names the display the command is for, as dictated. Another
+        display's command is forwarded and its reply spoken; that display
+        pushes its own picture, so none is scheduled here.
+        """
+        elsewhere = forward.route(request, where) if where and request else None
+        if elsewhere is not None:
+            return self._reply(200, elsewhere)
         result = answer(request)
         self._reply(200, result.reply)
         push.after_reply(request, result.reply, result.symbol)

{chartremotely-0.2.3 → chartremotely-0.2.4}/chartremotely/setup.py

@@ -157,6 +157,8 @@ def run(ask: Ask = input, say: Say = print, operator_url: str = OPERATOR_URL) ->
         label = ask("Name this display (e.g. Desk, Office wall): ").strip() or "display"
         pair(client, base, npub, proof, label)
         del proof
+        # Kept so "Where? <this Mac's name>" runs here without asking the operator.
+        config.update(display_label=label)
         say(f"Paired as “{label}”.")
 
     # 3. Tailscale.

{chartremotely-0.2.3 → chartremotely-0.2.4}/chartremotely.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: chartremotely
-Version: 0.2.3
+Version: 0.2.4
 Summary: Remote control of desktop charting applications on macOS
 Author: Lonnie VanZandt
 License: 
@@ -313,6 +313,22 @@ certificate to keep alive. Pairing alone does not start it: a display that is
 paired but has no `relay` running reports `connected: false` and silently
 ignores everything sent to it.
 
+## Voice
+
+"Hey Siri, ChartRemotely" asks three questions:
+
+1. **Which company?** — a spoken name or a spelled ticker.
+2. **What scale?** — a time frame mnemonic (below), or "as is".
+3. **Where?** — which display, by the name it was paired under. Say this
+   Mac's own name to stay here.
+
+The Shortcut talks to one Mac — the one that made it. When "Where?" names
+another of your displays, that Mac hands the command to the operator, which
+finds the display among yours by name only (case, spaces, hyphens,
+underscores and dots do not count: "Mac mini" is "mac-mini") and relays it.
+The reply you hear is the other display's. An unknown name is answered with
+the names you do have.
+
 ## Running it as a service
 
 `chartremotely setup` installs both transports as launchd agents

{chartremotely-0.2.3 → chartremotely-0.2.4}/chartremotely.egg-info/SOURCES.txt

@@ -7,6 +7,7 @@ chartremotely/ax.py
 chartremotely/cli.py
 chartremotely/config.py
 chartremotely/doctor.py
+chartremotely/forward.py
 chartremotely/guilock.py
 chartremotely/keystore.py
 chartremotely/layout.py
@@ -34,6 +35,7 @@ chartremotely.egg-info/entry_points.txt
 chartremotely.egg-info/requires.txt
 chartremotely.egg-info/top_level.txt
 chartremotely/assets/shortcut-template.plist
+tests/test_forward.py
 tests/test_push.py
 tests/test_relay.py
 tests/test_resolve.py

{chartremotely-0.2.3 → chartremotely-0.2.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "chartremotely"
-version = "0.2.3"
+version = "0.2.4"
 description = "Remote control of desktop charting applications on macOS"
 readme = "README.md"
 requires-python = ">=3.12"

chartremotely-0.2.4/tests/test_forward.py

@@ -0,0 +1,155 @@
+"""Where?: this Mac, or another of the owner's displays through the operator.
+
+The operator is a stub HTTP server and vocab is a stand-in, so this runs on
+Linux without the macOS drivers.
+"""
+
+import importlib
+import json
+import plistlib
+import sys
+import threading
+import types
+import urllib.request
+from http.server import BaseHTTPRequestHandler, HTTPServer
+from typing import ClassVar
+
+import pytest
+
+from chartremotely import config, forward, shortcut
+from chartremotely.answer import Answer
+
+
+class StubOperator(BaseHTTPRequestHandler):
+    """``/agent/forward`` answering with whatever a test queues."""
+
+    answer: ClassVar[tuple[int, dict]] = (200, {})
+    seen: ClassVar[list] = []
+
+    def do_POST(self):
+        body = json.loads(self.rfile.read(int(self.headers.get("Content-Length") or 0)))
+        type(self).seen.append((self.path, body))
+        status, payload = type(self).answer
+        raw = json.dumps(payload).encode()
+        self.send_response(status)
+        self.send_header("Content-Type", "application/json")
+        self.send_header("Content-Length", str(len(raw)))
+        self.end_headers()
+        self.wfile.write(raw)
+
+    def log_message(self, *args):
+        pass
+
+
+@pytest.fixture
+def operator(monkeypatch, tmp_path):
+    monkeypatch.setattr(config, "CONFIG_DIR", tmp_path)
+    monkeypatch.setattr(config, "CONFIG_PATH", tmp_path / "config.json")
+    StubOperator.seen = []
+    StubOperator.answer = (200, {"display": "Mac Mini", "reply": "Showing PLTR at daily. Good luck."})
+    server = HTTPServer(("127.0.0.1", 0), StubOperator)
+    threading.Thread(target=server.serve_forever, daemon=True).start()
+    base = f"http://127.0.0.1:{server.server_address[1]}"
+    config.update(operator_url=base, agent_id="a1", agent_secret="s1", display_label="Desk")
+    yield base
+    server.shutdown()
+
+
+@pytest.fixture
+def listener(operator, monkeypatch):
+    """The Shortcut's listener, with a stand-in vocab. Returns (post, ran, pictures)."""
+    ran, pictures = [], []
+    fake_vocab = types.ModuleType("chartremotely.vocab")
+    fake_vocab.answer = lambda cmd: ran.append(cmd) or Answer("Showing PLTR at daily. Good luck.", "PLTR")
+    monkeypatch.setitem(sys.modules, "chartremotely.vocab", fake_vocab)
+    monkeypatch.delitem(sys.modules, "chartremotely.server", raising=False)
+    server = importlib.import_module("chartremotely.server")   # bound to the stand-in vocab
+    from chartremotely import push
+    monkeypatch.setattr(push, "after_reply", lambda *a: pictures.append(a))
+    server.Handler.token = "T0KEN"
+    http = HTTPServer(("127.0.0.1", 0), server.Handler)
+    threading.Thread(target=http.serve_forever, daemon=True).start()
+
+    def post(body):
+        request = urllib.request.Request(
+            f"http://127.0.0.1:{http.server_address[1]}/chart", data=json.dumps(body).encode(),
+            method="POST", headers={"Content-Type": "application/json", "X-Token": "T0KEN"})
+        with urllib.request.urlopen(request, timeout=10) as response:
+            return response.read().decode().strip()
+
+    yield post, ran, pictures
+    http.shutdown()
+
+
+# -- the listener ----------------------------------------------------------------
+
+def test_no_where_runs_here_exactly_as_before(listener):
+    post, ran, pictures = listener
+    assert post({"cmd": "set PLTR | daily"}) == "Showing PLTR at daily. Good luck."
+    assert ran == ["set PLTR | daily"] and len(pictures) == 1
+    assert StubOperator.seen == []
+
+
+@pytest.mark.parametrize("said", ["Desk", "desk", " DESK ", "a1"])
+def test_this_macs_own_name_runs_here(listener, said):
+    post, ran, _ = listener
+    post({"cmd": "set PLTR | daily", "where": said})
+    assert ran == ["set PLTR | daily"] and StubOperator.seen == []
+
+
+def test_another_name_is_forwarded_verbatim_and_its_reply_spoken(listener):
+    post, ran, pictures = listener
+    assert post({"cmd": "set PLTR | daily", "where": "mac-mini"}) == "Showing PLTR at daily. Good luck."
+    assert StubOperator.seen == [("/agent/forward", {
+        "agent_id": "a1", "secret": "s1", "display": "mac-mini", "cmd": "set PLTR | daily"})]
+    assert ran == [] and pictures == [], "the target runs it and pushes its own picture"
+
+
+def test_an_unknown_name_is_spoken_back_with_the_owners_names(listener):
+    post, _, _ = listener
+    StubOperator.answer = (404, {"error": "no display named 'kitchen'", "displays": ["Desk", "Mac Mini"]})
+    assert post({"cmd": "read", "where": "kitchen"}) == 'ERR No display named "kitchen". Yours: Desk, Mac Mini.'
+
+
+# -- forward.route -----------------------------------------------------------------
+
+def test_the_operator_saying_self_runs_here_and_remembers_the_name(operator):
+    config.update(display_label=None)
+    StubOperator.answer = (200, {"self": True, "display": "Desk"})
+    assert forward.route("read", "desk") is None
+    assert config.load()["display_label"] == "Desk"
+
+
+def test_an_offline_display_is_said_plainly(operator):
+    StubOperator.answer = (503, {"error": "attic is offline", "display": "attic"})
+    assert forward.route("read", "attic") == "ERR attic is offline"
+
+
+def test_an_unpaired_mac_can_only_drive_itself(operator):
+    config.update(agent_id=None, agent_secret=None)
+    assert forward.route("read", "attic").startswith("ERR This Mac is not paired")
+    assert forward.route("read", "") is None
+
+
+def test_an_unreachable_operator_is_an_error_not_an_exception(operator):
+    config.update(operator_url="http://127.0.0.1:1")
+    assert forward.route("read", "attic") == "ERR I could not reach the operator."
+
+
+@pytest.mark.parametrize("said", ["Mac mini", "mac-mini", "macmini", "MAC_MINI", "mac.mini"])
+def test_the_name_rule_is_the_operators(said):
+    assert forward.display_key(said) == "macmini"
+
+
+# -- the Shortcut ------------------------------------------------------------------
+
+def test_the_shortcut_asks_where_after_scale_and_sends_it_beside_cmd():
+    actions = plistlib.loads(shortcut.template())["WFWorkflowActions"]
+    prompts = [a["WFWorkflowActionParameters"].get("WFAskActionPrompt") for a in actions]
+    assert prompts.index("Where?") > prompts.index("What scale?")
+    final = actions[prompts.index("Where?") + 1]["WFWorkflowActionParameters"]
+    fields = {i["WFKey"]["Value"]["string"]: i["WFValue"]["Value"]
+              for i in final["WFJSONValues"]["Value"]["WFDictionaryFieldValueItems"]}
+    assert fields["cmd"]["string"] == "set  | ", "the vocab grammar is unchanged"
+    where = actions[prompts.index("Where?")]["WFWorkflowActionParameters"]["UUID"]
+    assert fields["where"]["attachmentsByRange"]["{0, 1}"]["OutputUUID"] == where

{chartremotely-0.2.3 → chartremotely-0.2.4}/tests/test_relay.py

@@ -143,7 +143,7 @@ def test_the_wire_logic_imports_without_the_macos_drivers():
 
     forbidden = {"Quartz", "AppKit", "ApplicationServices", "CoreFoundation"}
     for name in ("relay", "resolve", "scales", "config", "registry", "snapshot", "push", "guilock",
-                 "mcpclient", "keystore", "services", "tailnet", "shortcut", "setup"):
+                 "mcpclient", "keystore", "services", "tailnet", "shortcut", "setup", "forward"):
         tree = ast.parse(Path(f"chartremotely/{name}.py").read_text())
         for node in ast.walk(tree):
             if isinstance(node, ast.Import):

{chartremotely-0.2.3 → chartremotely-0.2.4}/tests/test_setup.py

@@ -203,6 +203,7 @@ def test_a_made_key_never_reaches_the_agents_config(monkeypatch, tmp_path):
     stored = (tmp_path / "config.json").read_text()
     assert NSEC not in stored and "proof-for" not in stored
     assert json.loads(stored)["agent_id"] == "a1"
+    assert json.loads(stored)["display_label"] == "Desk", "so \"Where? Desk\" stays on this Mac"
     assert kept == [NPUB], "the made key is handed to the human's Keychain"
     assert built == ["https://mac.example.ts.net/chart"]
     assert not any(NSEC in s for s in said), "the key is never printed"