Merge pull request #2 from netz39/spaceapi

Add SpaceAPI entry, observation and return JSON

Author: penguineer

.env.template

@@ -1 +1,6 @@
 PORT=8080
+MQTT_BROKER=mqtt.local
+MQTT_PORT=1883
+
+MQTT_TOPIC_STATUS=SpaceAPI/isOpen
+MQTT_TOPIC_LASTCHANGE=SpaceAPI/lastChange

README.md

@@ -9,6 +9,11 @@
 Configuration is done using environment variables:
 
 * `PORT`: Target port when used with docker-compose (default `8080`)
+* `MQTT_BROKER`: MQTT broker server (default `mqtt`)
+* `MQTT_PORT`: MQTT broker port (default `1883`)
+* `MQTT_TOPIC_STATUS`: MQTT topic to listen for status messages (default `status`)
+* `MQTT_TOPIC_LASTCHANGE`: MQTT topic to listen for last change messages (default `lastchange`)
+
 
 ### Run with Docker
 

requirements.txt

@@ -1,4 +1,5 @@
 pytest==7.1.2
 pytest-asyncio==0.19.0
 tornado==6.4.1
-isodate==0.6.0
+isodate==0.6.0
+paho-mqtt==2.1.0

src/SpaceApiEntry.py

@@ -0,0 +1,71 @@
+class SpaceApiEntry:
+    @staticmethod
+    def create_netz39():
+        entry = SpaceApiEntry(
+            space="Netz39",
+            logo="https://wiki.netz39.de/_media/resources:public_relations:logo:netz39_logo_2013-07-11.png",
+            url="https://www.netz39.de/",
+            address="Leibnizstr. 32, 39104 Magdeburg, Germany",
+            lat=52.119561,
+            lon=11.629398,
+            icon_open="https://www.netz39.de/open.png",
+            icon_closed="https://www.netz39.de/closed.png"
+        )
+        entry.add_contact("email", "kontakt@netz39.de", is_issue_channel=True)
+        entry.add_contact("twitter", "@netz39", is_issue_channel=True)
+        entry.add_contact("ml", "list@netz39.de", is_issue_channel=True)
+        entry.add_contact("jabber", "lounge@conference.jabber.n39.eu")
+
+        entry.add_feed("blog", "rss", "https://www.netz39.de/feed/")
+        entry.add_feed("calendar", "ical", "https://www.netz39.de/feed/eo-events/")
+
+        return entry
+
+    TEMPLATE = {
+        "api": "0.13",
+        "state": {
+            "open": True,
+            "lastchange": 0,
+            "trigger_person": "",
+            "message": "",
+        },
+        "contact": {},
+        "issue_report_channels": [],
+        "feeds": {}
+    }
+
+    def __init__(self, space, logo, url, address, lat, lon, icon_open, icon_closed):
+        self.data = self.TEMPLATE.copy()
+        self.data.update({
+            "space": space,
+            "logo": logo,
+            "url": url,
+            "location": {
+                "address": address,
+                "lat": lat,
+                "lon": lon
+            },
+            "state": {
+                "icon": {
+                    "open": icon_open,
+                    "closed": icon_closed
+                }
+            }
+        })
+
+    def add_contact(self, key, value, is_issue_channel=False):
+        self.data["contact"][key] = value
+        if is_issue_channel:
+            self.data["issue_report_channels"].append(key)
+
+    def add_feed(self, feed, schema, url):
+        self.data["feeds"][feed] = {
+            "type": schema,
+            "url": url
+        }
+
+    def set_is_open(self, is_open):
+        self.data["state"]["open"] = is_open
+
+    def set_lastchange(self, lastchange):
+        self.data["state"]["lastchange"] = lastchange

src/SpaceStatusObserver.py

@@ -0,0 +1,47 @@
+import paho.mqtt.client as mqtt
+
+class SpaceStatusObserver:
+    def __init__(self, broker, port, topic_status, topic_lastchange, space_api_entry):
+        self.broker = broker
+        self.port = int(port)
+        self.topic_status = topic_status
+        self.topic_lastchange = topic_lastchange
+        self.space_api_entry = space_api_entry
+
+        self.client = mqtt.Client()
+        self.client.on_connect = self.on_connect
+        self.client.on_disconnect = self.on_disconnect
+        self.client.on_message = self.on_message
+
+    def on_connect(self, client, _userdata, _flags, rc):
+        print(f"Connected with result code {rc}")
+        for topic in [self.topic_status, self.topic_lastchange]:
+            print(f"Subscribing to topic {topic}")
+            client.subscribe(topic)
+
+    def on_disconnect(self, client, userdata, rc):
+        print(f"Disconnected with result code {rc}")
+        if rc != 0:
+            print("Unexpected disconnection. Reconnecting...")
+            self.client.reconnect()
+
+    def on_message(self, client, userdata, msg):
+        print(f"Message received on topic {msg.topic}: {msg.payload.decode()}")
+        self.on_message_callback(msg.topic, msg.payload.decode())
+
+    def on_message_callback(self, topic, message):
+        if topic == self.topic_status:
+            self.space_api_entry.set_is_open(message == "true")
+        elif topic == self.topic_lastchange:
+            self.space_api_entry.set_lastchange(int(message))
+
+    def start(self):
+        self.client.connect(self.broker, self.port, 60)
+        self.client.loop_start()
+
+    def stop(self):
+        self.client.loop_stop()
+        self.client.disconnect()
+
+    def get_space_api_entry(self):
+        return self.space_api_entry.data

src/app.py

@@ -15,6 +15,8 @@
 
 import json
 
+from src.SpaceApiEntry import SpaceApiEntry
+from src.SpaceStatusObserver import SpaceStatusObserver
 
 startup_timestamp = datetime.now()
 
@@ -71,11 +73,23 @@ def get(self):
         self.finish()
 
 
-def make_app():
+class SpaceAPIHandler(tornado.web.RequestHandler, ABC):
+    # noinspection PyAttributeOutsideInit
+    def initialize(self, observer):
+        self.observer = observer
+
+    def get(self):
+        self.set_header("Content-Type", "application/json")
+        self.write(json.dumps(self.observer.get_space_api_entry(), indent=4))
+        self.finish()
+
+
+def make_app(observer):
     version_path = r"/v[0-9]"
     return tornado.web.Application([
         (version_path + r"/health", HealthHandler),
         (version_path + r"/oas3", Oas3Handler),
+        (r"/", SpaceAPIHandler, dict(observer=observer)),
     ])
 
 
@@ -91,10 +105,23 @@ def load_env(key, default):
 
 def main():
     arg_port = load_env('PORT', 8080)
+    arg_mqtt_broker_server = load_env('MQTT_BROKER', 'mqtt')
+    arg_mqtt_broker_port = load_env('MQTT_PORT', 1883)
+    arg_topic_status = load_env('MQTT_TOPIC_STATUS', 'status')
+    arg_topic_lastchange = load_env('MQTT_TOPIC_LASTCHANGE', 'lastchange')
 
     # Setup
 
-    app = make_app()
+    observer = SpaceStatusObserver(
+        broker=arg_mqtt_broker_server,
+        port=arg_mqtt_broker_port,
+        topic_status=arg_topic_status,
+        topic_lastchange=arg_topic_lastchange,
+        space_api_entry=SpaceApiEntry.create_netz39()
+    )
+    observer.start()
+
+    app = make_app(observer)
     sockets = tornado.netutil.bind_sockets(arg_port, '')
     server = tornado.httpserver.HTTPServer(app)
     server.add_sockets(sockets)