diff --git a/CHANGELOG.md b/CHANGELOG.md index e5f6e7b..5c55982 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +- update "text" key to "body". + ## [3.1.0] - 2021-07-18 - Publish on PyPI & Docker Hub with Github Actions diff --git a/README.md b/README.md index 29a96ea..9f2442a 100644 --- a/README.md +++ b/README.md @@ -74,7 +74,7 @@ docker-compose up -d ## Test / Usage ``` -curl -d '{"text":"new contrib from toto: [44](http://radio.localhost/map/#44)", "key": "secret"}' \ +curl -d '{"body":"new contrib from toto: [44](http://radio.localhost/map/#44)", "key": "secret"}' \ 'http://matrixwebhook.localhost/!DPrUlnwOhBEfYwsDLh:matrix.org' ``` (or localhost:4785 without docker) diff --git a/matrix_webhook/__main__.py b/matrix_webhook/__main__.py index 2b4a7d7..2977f72 100644 --- a/matrix_webhook/__main__.py +++ b/matrix_webhook/__main__.py @@ -38,9 +38,13 @@ async def handler(request): except json.decoder.JSONDecodeError: return create_json_response(HTTPStatus.BAD_REQUEST, "Invalid JSON") - if not all(key in data for key in ["text", "key"]): + # legacy naming: + if "text" in data and "body" not in data: + data["body"] = data["text"] + + if not all(key in data for key in ["body", "key"]): return create_json_response( - HTTPStatus.BAD_REQUEST, "Missing text and/or API key property" + HTTPStatus.BAD_REQUEST, "Missing body and/or API key property" ) if data["key"] != conf.API_KEY: @@ -49,9 +53,9 @@ async def handler(request): room_id = request.path[1:] content = { "msgtype": "m.text", - "body": data["text"], + "body": data["body"], "format": "org.matrix.custom.html", - "formatted_body": markdown(str(data["text"]), extensions=["extra"]), + "formatted_body": markdown(str(data["body"]), extensions=["extra"]), } for _ in range(10): try: diff --git a/tests/start.py b/tests/start.py index 3df3418..3acb3b5 100755 --- a/tests/start.py +++ b/tests/start.py @@ -88,7 +88,7 @@ def run_and_test(): srv.terminate() # TODO Check what the bot says when the server is offline - # print(bot_req({'text': 'bye'}, KEY), {'status': 200, 'ret': 'OK'}) + # print(bot_req({'data': 'bye'}, KEY), {'status': 200, 'ret': 'OK'}) LOGGER.info("Stopping the bot") bot.terminate() diff --git a/tests/tests.py b/tests/tests.py index c92fb95..096dace 100644 --- a/tests/tests.py +++ b/tests/tests.py @@ -15,19 +15,19 @@ class BotTest(unittest.IsolatedAsyncioTestCase): self.assertEqual(bot_req(), {"status": 400, "ret": "Invalid JSON"}) self.assertEqual( bot_req({"toto": 3}), - {"status": 400, "ret": "Missing text and/or API key property"}, + {"status": 400, "ret": "Missing body and/or API key property"}, ) self.assertEqual( - bot_req({"text": 3, "key": None}), {"status": 401, "ret": "Invalid API key"} + bot_req({"body": 3, "key": None}), {"status": 401, "ret": "Invalid API key"} ) # TODO: if the client from matrix_webhook has olm support, this won't be a 403 from synapse, # but a LocalProtocolError from matrix_webhook self.assertEqual( - bot_req({"text": 3}, KEY), {"status": 403, "ret": "Unknown room"} + bot_req({"body": 3}, KEY), {"status": 403, "ret": "Unknown room"} ) async def test_message(self): - """Send a markdown message, and check the result.""" + """Send a markdown message with the old format, and check the result.""" text = "# Hello" messages = [] client = nio.AsyncClient(MATRIX_URL, MATRIX_ID) @@ -48,6 +48,28 @@ class BotTest(unittest.IsolatedAsyncioTestCase): self.assertEqual(message.body, text) self.assertEqual(message.formatted_body, "

Hello

") + async def test_markdown_body(self): + """Send a markdown message, and check the result.""" + body = "# Hello" + messages = [] + client = nio.AsyncClient(MATRIX_URL, MATRIX_ID) + + await client.login(MATRIX_PW) + room = await client.room_create() + + self.assertEqual( + bot_req({"body": body}, KEY, room.room_id), {"status": 200, "ret": "OK"} + ) + + sync = await client.sync() + messages = await client.room_messages(room.room_id, sync.next_batch) + await client.close() + + message = messages.chunk[0] + self.assertEqual(message.sender, FULL_ID) + self.assertEqual(message.body, body) + self.assertEqual(message.formatted_body, "

Hello

") + async def test_reconnect(self): """Check the reconnecting path.""" client = nio.AsyncClient(MATRIX_URL, MATRIX_ID) @@ -56,6 +78,6 @@ class BotTest(unittest.IsolatedAsyncioTestCase): await client.logout(all_devices=True) await client.close() self.assertEqual( - bot_req({"text": "Re"}, KEY, room.room_id), + bot_req({"body": "Re"}, KEY, room.room_id), {"status": 200, "ret": "OK"}, )