feat: initial commit

Author: Zxilly

.gitignore

@@ -0,0 +1,79 @@
+.idea
+*.iml
+out
+gen
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+*.manifest
+*.spec
+pip-log.txt
+pip-delete-this-directory.txt
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+*.mo
+*.pot
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+instance/
+.webassets-cache
+.scrapy
+docs/_build/
+.pybuilder/
+target/
+.ipynb_checkpoints
+profile_default/
+ipython_config.py
+__pypackages__/
+celerybeat-schedule
+celerybeat.pid
+*.sage.py
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+.spyderproject
+.spyproject
+.ropeproject
+/site
+.mypy_cache/
+.dmypy.json
+dmypy.json
+.pyre/
+.pytype/
+cython_debug/

README.md

@@ -0,0 +1,27 @@
+# notify-py-sdk
+
+Send notifications to [Notify](https://github.com/znotify/Notify)
+
+## Installation
+
+```bash
+pip install znotify
+```
+
+## Usage
+
+```python
+import znotify
+
+client = znotify.Client.create("user_id")
+client.send("Hello World")
+```
+
+## Development
+
+### Run tests
+
+```bash
+python -m unittest discover
+```
+

poetry.lock

@@ -0,0 +1,28 @@
+[tool.poetry]
+name = "znotify"
+version = "0.0.1"
+description = "sdk for notify"
+authors = ["Zxilly <[email protected]>"]
+license = "GPL-3.0"
+readme = "README.md"
+repository = "https://github.com/ZNotify/py-sdk"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Development Status :: 4 - Beta",
+    "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
+    "Operating System :: OS Independent",
+    "Natural Language :: Chinese (Simplified)"
+]
+
+[tool.poetry.dependencies]
+python = "^3.10"
+requests = "^2.27.1"
+
+[tool.poetry.dev-dependencies]
+
+[tool.poetry.urls]
+"Bug Tracker" = "https://github.com/ZNotify/py-sdk/issues"
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"

pyproject.toml

@@ -0,0 +1,2 @@
+from .send_test import *
+from .client_test import *

tests/__init__.py

@@ -0,0 +1,52 @@
+import unittest
+from znotify import Client
+
+
+class TestClient(unittest.TestCase):
+    @classmethod
+    def setUpClass(cls):
+        cls.client = Client.create("zxilly")
+        pass
+
+    def test_client_create(self):
+        self.assertIsInstance(self.client, Client)
+        pass
+
+    def test_client_create_failed(self):
+        with self.assertRaises(Exception) as context:
+            Client.create("error")
+        self.assertTrue("User ID not valid" in str(context.exception))
+        pass
+
+    def test_client_send_0(self):
+        with self.assertRaises(Exception) as context:
+            self.client.send("")
+        self.assertTrue("Content is required" in str(context.exception))
+        pass
+
+    def test_client_send_1(self):
+        self.assertEqual(self.client.send("test"), {
+            "content": "test",
+            "long": "",
+            "title": "Notification"
+        })
+        pass
+
+    def test_client_send_2(self):
+        self.assertEqual(self.client.send("content", "title"), {
+            "content": "content",
+            "long": "",
+            "title": "title"
+        })
+        pass
+
+    def test_client_send_3(self):
+        self.assertEqual(self.client.send("content", "title", "long"), {
+            "content": "content",
+            "long": "long",
+            "title": "title"
+        })
+
+
+if __name__ == "__main__":
+    unittest.main()

tests/client_test.py

@@ -0,0 +1,44 @@
+import unittest
+from znotify.send import send
+
+
+class TestSend(unittest.TestCase):
+
+    def test_send_create_failed(self):
+        with self.assertRaises(Exception) as context:
+            send("error", "error")
+        self.assertTrue("User ID not valid" in str(context.exception))
+        pass
+
+    def test_send_0(self):
+        with self.assertRaises(Exception) as context:
+            send("zxilly", "")
+        self.assertTrue("Content is required" in str(context.exception))
+        pass
+
+    def test_send_1(self):
+        self.assertEqual(send("zxilly", "test"), {
+            "content": "test",
+            "long": "",
+            "title": "Notification"
+        })
+        pass
+
+    def test_send_2(self):
+        self.assertEqual(send("zxilly", "content", "title"), {
+            "content": "content",
+            "long": "",
+            "title": "title"
+        })
+        pass
+
+    def test_send_3(self):
+        self.assertEqual(send("zxilly", "content", "title", "long"), {
+            "content": "content",
+            "long": "long",
+            "title": "title"
+        })
+
+
+if __name__ == "__main__":
+    unittest.main()

tests/send_test.py

@@ -0,0 +1,2 @@
+from .client import *
+from .send import *

znotify/__init__.py

@@ -0,0 +1,45 @@
+import sys
+
+import requests
+from requests.exceptions import ConnectionError
+
+
+class Client:
+    def __init__(self, user_id, endpoint):
+        self.endpoint = endpoint if endpoint else "https://push.learningman.top"
+        self.user_id = user_id
+
+    @staticmethod
+    def create(user_id, endpoint=None):
+        client = Client(user_id, endpoint)
+        client.check()
+        return client
+
+    def check(self):
+        resp = requests.get(f"{self.endpoint}/{self.user_id}/check")
+        if not resp.json():
+            raise Exception("User ID not valid")
+
+    def send(self, content, title=None, long=None):
+        if content is None or content == "":
+            raise Exception("Content is required")
+
+        params = {}
+        if 'unittest' in sys.modules:
+            params['dry'] = True
+
+        if title is None:
+            title = "Notification"
+        if long is None:
+            long = ""
+
+        data = {
+            "title": title,
+            "content": content,
+            "long": long
+        }
+        try:
+            resp = requests.post(f"{self.endpoint}/{self.user_id}/send", data=data, params=params)
+        except ConnectionError as e:
+            raise Exception("Connection error") from e
+        return resp.json()

znotify/client.py

@@ -0,0 +1,6 @@
+from znotify import Client
+
+
+def send(user_id, content, title=None, long=None):
+    client = Client.create(user_id)
+    return client.send(content, title, long)