From a73cb55b0d5a61da3aab011d2a3d71ceb5aa1119 Mon Sep 17 00:00:00 2001 From: jblu Date: Sun, 30 Oct 2022 23:27:08 -0500 Subject: [PATCH] #2 --- clogging.py | 6 +- config.json.example | 14 --- containers.json.example | 3 - pushover.py | 234 ++++++++++++++++++++++++++++++++++++++++ test_pushover.py | 12 +++ 5 files changed, 249 insertions(+), 20 deletions(-) delete mode 100644 config.json.example delete mode 100644 containers.json.example create mode 100644 pushover.py create mode 100644 test_pushover.py diff --git a/clogging.py b/clogging.py index 9b4cfa2..843ee94 100644 --- a/clogging.py +++ b/clogging.py @@ -10,12 +10,12 @@ def cont_notify(self): """Seting up to use pushover, if self.use_pushover is set to true and if valid self.po_key and self.po_token is provided in the config file""" if self.use_pushover: - self.poc = self.po.Client(self.po_key, api_token=self.po_token) + self.poc = self.po.Pushover(self.po_token) def cont_notify_summary(self): """Main notification method when the app is used in an automated fashion""" - self.poc.send_message(f" \ - {self.extm}", title="--- qbit-maid summary ---") + self.poc.message(self.po_key,f" \ + {self.extm}", title="--- crane summary ---") def list_first_cont(self, index=0): """Only lists the first torrent""" diff --git a/config.json.example b/config.json.example deleted file mode 100644 index 7673c78..0000000 --- a/config.json.example +++ /dev/null @@ -1,14 +0,0 @@ -{ - "host": "192.168.1.1", - "port": 9443, - "username": "admin", - "password": "admin", - "endpoint": 1, - "log_level": "INFO", - "log_path": "./crn.log", - "use_pushover": false, - "use_log": true, - "po_key": "", - "po_token": "", - "start_containers": false -} \ No newline at end of file diff --git a/containers.json.example b/containers.json.example deleted file mode 100644 index 5c2cf11..0000000 --- a/containers.json.example +++ /dev/null @@ -1,3 +0,0 @@ -{ - "cont": "container_name" -} \ No newline at end of file diff --git a/pushover.py b/pushover.py new file mode 100644 index 0000000..56c697d --- /dev/null +++ b/pushover.py @@ -0,0 +1,234 @@ +# pushover 1.2 +# +# Copyright (C) 2013-2018 Thibaut Horel + +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. + +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. + +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . +import time +import requests + +BASE_URL = "https://api.pushover.net/1/" +MESSAGE_URL = BASE_URL + "messages.json" +USER_URL = BASE_URL + "users/validate.json" +SOUND_URL = BASE_URL + "sounds.json" +RECEIPT_URL = BASE_URL + "receipts/" +GLANCE_URL = BASE_URL + "glances.json" + + +class RequestError(Exception): + """Exception which is raised when Pushover's API returns an error code. + + The list of errors is stored in the :attr:`errors` attribute. + """ + + def __init__(self, errors): + Exception.__init__(self) + self.errors = errors + + def __str__(self): + return "\n==> " + "\n==> ".join(self.errors) + + +class Request(object): + """Base class to send a request to the Pushover server and check the return + status code. The request is sent on instantiation and raises + a :class:`RequestError` exception when the request is rejected. + """ + + def __init__(self, method, url, payload): + files = {} + if "attachment" in payload: + files["attachment"] = payload["attachment"] + del payload["attachment"] + self.payload = payload + self.files = files + request = getattr(requests, method)(url, params=payload, files=files) + self.answer = request.json() + if 400 <= request.status_code < 500: + raise RequestError(self.answer["errors"]) + + def __str__(self): + return str(self.answer) + + +class MessageRequest(Request): + """This class represents a message request to the Pushover API. You do not + need to create it yourself, but the :func:`Pushover.message` function + returns :class:`MessageRequest` objects. + + The :attr:`answer` attribute contains a JSON representation of the answer + made by the Pushover API. When sending a message with a priority of 2, you + can poll the status of the notification with the :func:`poll` function. + """ + + params = { + "expired": "expires_at", + "called_back": "called_back_at", + "acknowledged": "acknowledged_at", + } + + def __init__(self, payload): + Request.__init__(self, "post", MESSAGE_URL, payload) + self.status = {"done": True} + if payload.get("priority", 0) == 2: + self.url = RECEIPT_URL + self.answer["receipt"] + self.status["done"] = False + for param, when in MessageRequest.params.items(): + self.status[param] = False + self.status[when] = 0 + + def poll(self): + """If the message request has a priority of 2, Pushover keeps sending + the same notification until the client acknowledges it. Calling the + :func:`poll` function fetches the status of the :class:`MessageRequest` + object until the notifications either expires, is acknowledged by the + client, or the callback url is reached. The status is available in the + ``status`` dictionary. + + Returns ``True`` when the request has expired or been acknowledged and + ``False`` otherwise so that a typical handling of a priority-2 + notification can look like this:: + + request = p.message("Urgent!", priority=2, expire=120, retry=60) + while not request.poll(): + # do something + time.sleep(5) + + print request.status + """ + if not self.status["done"]: + r = Request("get", self.url + ".json", {"token": self.payload["token"]}) + for param, when in MessageRequest.params.items(): + self.status[param] = bool(r.answer[param]) + self.status[when] = int(r.answer[when]) + for param in ["acknowledged_by", "acknowledged_by_device"]: + self.status[param] = r.answer[param] + self.status["last_delivered_at"] = int(r.answer["last_delivered_at"]) + if any(self.status[param] for param in MessageRequest.params): + self.status["done"] = True + return self.status["done"] + + def cancel(self): + """If the message request has a priority of 2, Pushover keeps sending + the same notification until it either reaches its ``expire`` value or + is aknowledged by the client. Calling the :func:`cancel` function + cancels the notification early. + """ + if not self.status["done"]: + return Request( + "post", self.url + "/cancel.json", {"token": self.payload["token"]} + ) + else: + return None + + +class Pushover(object): + """This is the main class of the module. It represents a Pushover app and + is tied to a unique API token. + + * ``token``: Pushover API token + """ + + _SOUNDS = None + message_keywords = [ + "title", + "priority", + "sound", + "callback", + "timestamp", + "url", + "url_title", + "device", + "retry", + "expire", + "html", + "attachment", + ] + glance_keywords = ["title", "text", "subtext", "count", "percent", "device"] + + def __init__(self, token): + self.token = token + + @property + def sounds(self): + """Return a dictionary of sounds recognized by Pushover and that can be + used in a notification message. + """ + if not Pushover._SOUNDS: + request = Request("get", SOUND_URL, {"token": self.token}) + Pushover._SOUNDS = request.answer["sounds"] + return Pushover._SOUNDS + + def verify(self, user, device=None): + """Verify that the `user` and optional `device` exist. Returns + `None` when the user/device does not exist or a list of the user's + devices otherwise. + """ + payload = {"user": user, "token": self.token} + if device: + payload["device"] = device + try: + request = Request("post", USER_URL, payload) + except RequestError: + return None + else: + return request.answer["devices"] + + def message(self, user, message, **kwargs): + """Send `message` to the user specified by `user`. It is possible + to specify additional properties of the message by passing keyword + arguments. The list of valid keywords is ``title, priority, sound, + callback, timestamp, url, url_title, device, retry, expire and html`` + which are described in the Pushover API documentation. + + For convenience, you can simply set ``timestamp=True`` to set the + timestamp to the current timestamp. + + An image can be attached to a message by passing a file-like object + to the `attachment` keyword argument. + + This method returns a :class:`MessageRequest` object. + """ + + payload = {"message": message, "user": user, "token": self.token} + for key, value in kwargs.items(): + if key not in Pushover.message_keywords: + raise ValueError("{0}: invalid message parameter".format(key)) + elif key == "timestamp" and value is True: + payload[key] = int(time.time()) + elif key == "sound" and value not in self.sounds: + raise ValueError("{0}: invalid sound".format(value)) + else: + payload[key] = value + + return MessageRequest(payload) + + def glance(self, user, **kwargs): + """Send a glance to the user. The default property is ``text``, as this + is used on most glances, however a valid glance does not need to + require text and can be constructed using any combination of valid + keyword properties. The list of valid keywords is ``title, text, + subtext, count, percent and device`` which are described in the + Pushover Glance API documentation. + + This method returns a :class:`GlanceRequest` object. + """ + payload = {"user": user, "token": self.token} + + for key, value in kwargs.items(): + if key not in Pushover.glance_keywords: + raise ValueError("{0}: invalid glance parameter".format(key)) + else: + payload[key] = value + + return Request("post", GLANCE_URL, payload) \ No newline at end of file diff --git a/test_pushover.py b/test_pushover.py new file mode 100644 index 0000000..1e8358d --- /dev/null +++ b/test_pushover.py @@ -0,0 +1,12 @@ +import pushover +from tomllib import load + +with open('./config.toml', mode="rb") as c: + config = load(c) + +po_key = config["pushover"]["po_key"] +po_token = config["pushover"]["po_token"] + +message = "hello" + +pushover.Pushover(po_token).message(po_key, message, title="--- crane summary ---") \ No newline at end of file -- 2.45.2