update readme, doc, and status / return codes
This commit is contained in:
parent
7f466261d1
commit
1b31e7bba9
2 changed files with 12 additions and 12 deletions
|
@ -10,6 +10,7 @@ environment variables:
|
||||||
- `MATRIX_URL`: the url of the matrix homeserver
|
- `MATRIX_URL`: the url of the matrix homeserver
|
||||||
- `MATRIX_ID`: the user id of the bot on this server
|
- `MATRIX_ID`: the user id of the bot on this server
|
||||||
- `MATRIX_PW`: the password for this user
|
- `MATRIX_PW`: the password for this user
|
||||||
|
- `API_KEY`: a secret to share with the users of the service
|
||||||
|
|
||||||
## Dev
|
## Dev
|
||||||
|
|
||||||
|
@ -33,6 +34,6 @@ docker-compose up -d
|
||||||
## Test / Usage
|
## Test / Usage
|
||||||
|
|
||||||
```
|
```
|
||||||
curl -d '{"text":"new contrib from toto: http://radio.localhost/map/#44", "key": "secret"}' matrixwebhook.localhost/!FwpsPdeIYWcXDVpRmO:matrix.org
|
curl -d '{"text":"new contrib from toto: http://radio.localhost/map/#44", "key": "secret"}' 'matrixwebhook.localhost/!FwpsPdeIYWcXDVpRmO:matrix.org'
|
||||||
```
|
```
|
||||||
(or matrixwebhook.localhost:4785 without docker)
|
(or localhost:4785 without docker)
|
||||||
|
|
|
@ -31,32 +31,31 @@ class MatrixWebhookServer(HTTPServer):
|
||||||
|
|
||||||
class MatrixWebhookHandler(BaseHTTPRequestHandler):
|
class MatrixWebhookHandler(BaseHTTPRequestHandler):
|
||||||
"""
|
"""
|
||||||
Class given to the server, st. it knows what to do with a request.
|
Class given to the server, st. it knows what to do with an HTTP request.
|
||||||
This one handles the HTTP request, and forwards it to the matrix room.
|
This one handles a POST, checks its content, and forwards it to the matrix room.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
def do_POST(self):
|
def do_POST(self):
|
||||||
"""
|
"""
|
||||||
main method, get a json dict from wifi-with-me, send a message to a matrix room
|
get a json dict from the request, send a message to a matrix room
|
||||||
"""
|
"""
|
||||||
length = int(self.headers.get('Content-Length'))
|
length = int(self.headers.get('Content-Length'))
|
||||||
data = json.loads(self.rfile.read(length).decode())
|
data = json.loads(self.rfile.read(length).decode())
|
||||||
status = 'I need a json dict with text & key'
|
status, ret = 400, 'I need a json dict with text & key'
|
||||||
if all(key in data for key in ['text', 'key']):
|
if all(key in data for key in ['text', 'key']):
|
||||||
status = 'wrong key'
|
status, ret = 401, 'I need the good "key"'
|
||||||
if data['key'] == API_KEY:
|
if data['key'] == API_KEY:
|
||||||
status = 'I need the id of the room as a path, and to be in this room'
|
status, ret = 404, 'I need the id of the room as a path, and to be in this room'
|
||||||
if self.path[1:] not in self.server.rooms:
|
if self.path[1:] not in self.server.rooms:
|
||||||
# try to see if this room has been joined recently
|
# try to see if this room has been joined recently
|
||||||
self.server.rooms = self.server.client.get_rooms()
|
self.server.rooms = self.server.client.get_rooms()
|
||||||
if self.path[1:] in self.server.rooms:
|
if self.path[1:] in self.server.rooms:
|
||||||
status = 'OK'
|
status, ret = 200, json.dumps(self.server.rooms[self.path[1:]].send_text(data['text']))
|
||||||
self.server.rooms[self.path[1:]].send_text(data['text'])
|
|
||||||
|
|
||||||
self.send_response(200 if status == 'OK' else 401)
|
self.send_response(status)
|
||||||
self.send_header('Content-Type', 'application/json')
|
self.send_header('Content-Type', 'application/json')
|
||||||
self.end_headers()
|
self.end_headers()
|
||||||
self.wfile.write(b'{"status": "%a"}' % status)
|
self.wfile.write(b'{"status": %i, "ret": "%a"}' % (status, ret))
|
||||||
|
|
||||||
|
|
||||||
if __name__ == '__main__':
|
if __name__ == '__main__':
|
||||||
|
|
Loading…
Reference in a new issue