[ntfy] Use file option to signal uploading a local file as attachment

Author: amotl

README.rst

@@ -190,7 +190,7 @@ you an idea how to pass relevant information on the command line using JSON::
     mqttwarn --plugin=ntfy --options='{"addrs": {"url": "http://localhost:5555/testdrive"}, "title": "Example notification", "message": "Hello world"}' --data='{"attach": "https://unsplash.com/photos/spdQ1dVuIHw/download?w=320", "filename": "goat.jpg"}'
 
     # Launch "ntfy" service plugin, and add attachment from local filesystem
-    mqttwarn --plugin=ntfy --options='{"addrs": {"url": "http://localhost:5555/testdrive", "attachment": "goat.jpg"}, "title": "Example notification", "message": "Hello world"}'
+    mqttwarn --plugin=ntfy --options='{"addrs": {"url": "http://localhost:5555/testdrive", "file": "goat.jpg"}, "title": "Example notification", "message": "Hello world"}'
 
     # Launch "ssh" service plugin
     mqttwarn --plugin=ssh --config='{"host": "ssh.example.org", "port": 22, "user": "foo", "password": "bar"}' --options='{"addrs": ["command with substitution %s"], "payload": "{\"args\": \"192.168.0.1\"}"}'

docs/notifier-catalog.md

@@ -1810,7 +1810,7 @@ data will also get interpolated into.
 targets  = {
     'test': {
         'url': 'https://ntfy.sh/testdrive',
-        'attachment': '/tmp/ntfy-attachment-{slot}-{label}.png',
+        'file': '/tmp/ntfy-attachment-{slot}-{label}.png',
         }
     }
 ```

mqttwarn/services/ntfy.py

@@ -123,7 +123,7 @@ def decode_jobitem(item: ProcessorItem) -> NtfyRequest:
         raise TypeError(f"Unable to handle `targets` address descriptor data type `{type(item.addrs).__name__}`: {item.addrs}")
 
     url = options["url"]
-    attachment_path = options.get("attachment")
+    attachment_path = options.get("file")
 
     # Collect ntfy fields.
     fields: DataDict = OrderedDict()

tests/services/test_ntfy.py

@@ -63,14 +63,14 @@ def test_ntfy_decode_jobitem_attachment_success(attachment_dummy):
     """
 
     item = Item(
-        addrs={"url": "http://localhost:9999/testdrive", "attachment": attachment_dummy.name},
+        addrs={"url": "http://localhost:9999/testdrive", "file": attachment_dummy.name},
     )
 
     ntfy_request = decode_jobitem(item)
 
     assert ntfy_request.url == "http://localhost:9999/testdrive"
     assert ntfy_request.options["url"] == "http://localhost:9999/testdrive"
-    assert ntfy_request.options["attachment"] == attachment_dummy.name
+    assert ntfy_request.options["file"] == attachment_dummy.name
     assert ntfy_request.fields["filename"] == Path(attachment_dummy.name).name
     assert ntfy_request.attachment_data.read() == b"foo"
 
@@ -81,14 +81,14 @@ def test_ntfy_decode_jobitem_attachment_failure(caplog):
     """
 
     item = Item(
-        addrs={"url": "http://localhost:9999/testdrive", "attachment": "/tmp/mqttwarn-random-unknown"},
+        addrs={"url": "http://localhost:9999/testdrive", "file": "/tmp/mqttwarn-random-unknown"},
     )
 
     ntfy_request = decode_jobitem(item)
 
     assert ntfy_request.url == "http://localhost:9999/testdrive"
     assert ntfy_request.options["url"] == "http://localhost:9999/testdrive"
-    assert ntfy_request.options["attachment"] == "/tmp/mqttwarn-random-unknown"
+    assert ntfy_request.options["file"] == "/tmp/mqttwarn-random-unknown"
     assert "filename" not in ntfy_request.fields
     assert ntfy_request.attachment_data is None
 
@@ -101,15 +101,15 @@ def test_ntfy_decode_jobitem_attachment_with_filename_success(attachment_dummy):
     """
 
     item = Item(
-        addrs={"url": "http://localhost:9999/testdrive", "attachment": attachment_dummy.name},
+        addrs={"url": "http://localhost:9999/testdrive", "file": attachment_dummy.name},
         data={"filename": "testdrive.txt"},
     )
 
     ntfy_request = decode_jobitem(item)
 
     assert ntfy_request.url == "http://localhost:9999/testdrive"
     assert ntfy_request.options["url"] == "http://localhost:9999/testdrive"
-    assert ntfy_request.options["attachment"] == attachment_dummy.name
+    assert ntfy_request.options["file"] == attachment_dummy.name
     assert ntfy_request.fields["filename"] == "testdrive.txt"
     assert ntfy_request.attachment_data.read() == b"foo"
 
@@ -275,7 +275,7 @@ def test_ntfy_plugin_success(srv, caplog, attachment_dummy):
     module = load_module_by_name("mqttwarn.services.ntfy")
 
     item = Item(
-        addrs={"url": "http://localhost:9999/testdrive", "attachment": attachment_dummy.name},
+        addrs={"url": "http://localhost:9999/testdrive", "file": attachment_dummy.name},
         title="⚽ Message title ⚽",
         message="⚽ Notification message ⚽",
         data={"priority": "high", "tags": "foo,bar,äöü", "click": "https://example.org/testdrive"},