feat: add bark,chanify,pushdeer support. add docs

Author: jetsung

README.md

@@ -1,11 +1,13 @@
 # ipush
 
-APP 推送通知
+APP 推送通知。支持往 **钉钉群、飞书群、Lark 群、Bark、Chanify、PushDeer** 推送消息。
 
 ## 使用说明
 
 1. 安装依赖
 
+- https://pypi.org/project/ipush/
+
 ```shell
 pip install -U ipush
 ```
@@ -14,32 +16,48 @@ pip install -U ipush
 
 ```python
 from ipush.notify.dingtalk import Dingtalk
-from ipush.notify.feishu import Feishu
-from ipush.notify.lark import Lark
 
 notify = Dingtalk("token", "secret")
 notify.send("ipush test")
-
-notify = Feishu("token", "secret")
-notify.send("ipush test")
-
-notify = Lark("token", "secret")
-notify.send("ipush test")
 ```
 
 ## 支持平台
 
-| 状态     | **国内**平台      | 官网                                                                                                      | 文档 | 备注 |
-| :------- | :---------------- | :-------------------------------------------------------------------------------------------------------- | :--- | :--- |
-| ✔ **荐** | **钉钉群机器人**  | [https://open.dingtalk.com/](https://open.dingtalk.com/document/robots/customize-robot-security-settings) | -    |      |
-| ✔ **荐** | **飞书群机器人**  | [https://open.feishu.cn/](https://open.feishu.cn/document/client-docs/bot-v3/add-custom-bot)              | -    |      |
-| ✔ **荐** | **Lark 群机器人** | [https://open.larksuite.com/](https://open.larksuite.com/document/client-docs/bot-v3/add-custom-bot)      | -    |      |
+| 状态     | **国内**平台      | 官网                                                                                                      | 文档 | 备注         |
+| :------- | :---------------- | :-------------------------------------------------------------------------------------------------------- | :--- | :----------- |
+| ✔ **荐** | **钉钉群机器人**  | [https://open.dingtalk.com/](https://open.dingtalk.com/document/robots/customize-robot-security-settings) | -    |              |
+| ✔ **荐** | **飞书群机器人**  | [https://open.feishu.cn/](https://open.feishu.cn/document/client-docs/bot-v3/add-custom-bot)              | -    |              |
+| ✔ **荐** | **Lark 群机器人** | [https://open.larksuite.com/](https://open.larksuite.com/document/client-docs/bot-v3/add-custom-bot)      | -    |              |
+| ✔ **荐** | **Bark**          | [https://day.app/2021/06/barkfaq/](https://day.app/2021/06/barkfaq/)                                      | -    | 仅支持 `iOS` |
+| ✔        | **Chanify**       | [https://www.chanify.net/](https://www.chanify.net/)                                                      | -    | 仅支持 `iOS` |
+| ✔        | **PushDeer**      | https://www.pushdeer.com/                                                                                 | -    |              |
+
+## 开发
 
-## 前置环境
+### 前置环境
 
 1. 使用 [**Rye**](https://rye-up.com/) 作为包管理工具
 
-## 单元测试
+### 开发
+
+1. 安装依赖包：
+
+```bash
+# 同步
+rye sync
+```
+
+2. 代码检测与格式化：
+
+```bash
+# 检测
+rye run check
+
+# 格式化
+rye run format
+```
+
+3. 单元测试：
 
 ```bash
 # rye test

docs/README.md

@@ -0,0 +1,63 @@
+# ipush 使用教程
+
+## 使用
+
+1. **钉钉群**
+
+```python
+from ipush.notify.dingtalk import Dingtalk
+
+notify = Dingtalk("token", "secret")
+notify.send("ipush test")
+```
+
+2. **飞书群**
+
+```python
+from ipush.notify.feishu import Feishu
+
+notify = Feishu("token", "secret")
+notify.send("ipush test")
+```
+
+3. **Lark 群**
+
+```python
+from ipush.notify.lark import Lark
+
+notify = Lark("token", "secret")
+notify.send("ipush test")
+```
+
+4. **Bark**
+
+```python
+from ipush.notify.bark import Bark
+
+notify = Bark("token")
+notify.send("ipush test")
+notify.seturl("https://self-hosted")
+notify.send("ipush test custom url")
+```
+
+5. **Chanify**
+
+```python
+from ipush.notify.chanify import Chanify
+
+notify = Chanify("token")
+notify.send("ipush test")
+notify.seturl("https://self-hosted")
+notify.send("ipush test custom url")
+```
+
+6. **PushDeer**
+
+```python
+from ipush.notify.pushdeer import PushDeer
+
+notify = PushDeer("token")
+notify.send("ipush test")
+notify.seturl("https://self-hosted")
+notify.send("ipush test custom url")
+```

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "ipush"
-version = "0.1.1"
+version = "0.2.0"
 description = "Push for python"
 authors = [
     { name = "Jetsung Chan", email = "[email protected]" }

src/ipush/notify/bark.py

@@ -0,0 +1,47 @@
+import json
+
+from ..utils.fetch import Fetch
+from .notify import Notify
+
+
+class Bark(Notify):
+    """
+    Bark通知
+    """
+
+    def __init__(self, token=''):
+        self.token = token
+        self.url = 'https://api.day.app'
+
+    def signature(self):
+        pass
+
+    def seturl(self, url):
+        self.url = url
+
+    def requrl(self):
+        """
+        生成请求的 URL
+        """
+        return f'{self.url}/push'
+
+    def send(self, message):
+        """
+        发送通知
+        :param message: 消息内容
+        """
+        req_url = self.requrl()
+
+        headers = {
+            'content-type': 'application/json',
+        }
+        req = Fetch()
+        req.update_headers(headers)
+
+        data = {
+            'body': message,
+            'device_key': self.token,
+        }
+        data = json.dumps(data, indent=4)
+        req.post(req_url, data=data.encode('utf-8'))
+        return req.response

src/ipush/notify/chanify.py

@@ -0,0 +1,46 @@
+import json
+
+from ..utils.fetch import Fetch
+from .notify import Notify
+
+
+class Chanify(Notify):
+    """
+    Chanify通知
+    """
+
+    def __init__(self, token=''):
+        self.token = token
+        self.url = 'https://api.chanify.net'
+
+    def signature(self):
+        pass
+
+    def seturl(self, url):
+        self.url = url
+
+    def requrl(self):
+        """
+        生成请求的 URL
+        """
+        return f'{self.url}/v1/sender/{self.token}'
+
+    def send(self, message):
+        """
+        发送通知
+        :param message: 消息内容
+        """
+        req_url = self.requrl()
+
+        headers = {
+            'content-type': 'application/json',
+        }
+        req = Fetch()
+        req.update_headers(headers)
+
+        data = {
+            'text': message,
+        }
+        data = json.dumps(data, indent=4)
+        req.post(req_url, data=data.encode('utf-8'))
+        return req.response

src/ipush/notify/pushdeer.py

@@ -0,0 +1,47 @@
+import json
+
+from ..utils.fetch import Fetch
+from .notify import Notify
+
+
+class PushDeer(Notify):
+    """
+    PushDeer通知
+    """
+
+    def __init__(self, token=''):
+        self.token = token
+        self.url = 'https://api2.pushdeer.com'
+
+    def signature(self):
+        pass
+
+    def seturl(self, url):
+        self.url = url
+
+    def requrl(self):
+        """
+        生成请求的 URL
+        """
+        return f'{self.url}/message/push'
+
+    def send(self, message):
+        """
+        发送通知
+        :param message: 消息内容
+        """
+        req_url = self.requrl()
+
+        headers = {
+            'content-type': 'application/json',
+        }
+        req = Fetch()
+        req.update_headers(headers)
+
+        data = {
+            'text': message,
+            'pushkey': self.token,
+        }
+        data = json.dumps(data, indent=4)
+        req.post(req_url, data=data.encode('utf-8'))
+        return req.response

tests/test_bark.py

@@ -0,0 +1,36 @@
+import os
+
+import pytest
+
+from ipush.notify.bark import Bark
+
+
+@pytest.fixture
+def access_token():
+    token = os.environ.get('BarkToken')
+    custom_url = os.environ.get('BarkCustomURL')
+    return token, custom_url
+
+
+@pytest.mark.skipif(not os.environ.get('BarkToken'), reason='Bark Token not provided')
+def test_bark(access_token):
+    token, _ = access_token
+    notify = Bark(token)
+    res = notify.send('pypush test')
+    assert res.status_code == 200
+    json = res.json()
+    assert json['code'] == 200
+
+
+@pytest.mark.skipif(
+    not os.environ.get('BarkToken') or not os.environ.get('BarkCustomURL'),
+    reason='Bark Token not provided',
+)
+def test_bark_custom_url(access_token):
+    token, custom_url = access_token
+    notify = Bark(token)
+    notify.seturl(custom_url)
+    res = notify.send('pypush test custom url')
+    assert res.status_code == 200
+    json = res.json()
+    assert json['code'] == 200

tests/test_chanify.py

@@ -0,0 +1,34 @@
+import os
+
+import pytest
+
+from ipush.notify.chanify import Chanify
+
+
+@pytest.fixture
+def access_token():
+    token = os.environ.get('ChanifyToken')
+    custom_url = os.environ.get('ChanifyCustomURL')
+    return token, custom_url
+
+
+@pytest.mark.skipif(
+    not os.environ.get('ChanifyToken'), reason='Chanify Token not provided'
+)
+def test_chanify(access_token):
+    token, _ = access_token
+    notify = Chanify(token)
+    res = notify.send('pypush test')
+    assert res.status_code == 200
+
+
+@pytest.mark.skipif(
+    not os.environ.get('ChanifyToken') or not os.environ.get('ChanifyCustomURL'),
+    reason='Chanify Token not provided',
+)
+def test_chanify_custom_url(access_token):
+    token, custom_url = access_token
+    notify = Chanify(token)
+    notify.seturl(custom_url)
+    res = notify.send('pypush test custom url')
+    assert res.status_code == 200

tests/test_dingtalk.py

@@ -6,7 +6,7 @@
 
 
 @pytest.fixture
-def assess_token():
+def access_token():
     token = os.environ.get('DingtalkToken')
     secret = os.environ.get('DingtalkSecret')
     return token, secret
@@ -15,9 +15,10 @@ def assess_token():
 @pytest.mark.skipif(
     not os.environ.get('DingtalkToken'), reason='Dingtalk Token not provided'
 )
-def test_dintalk(assess_token):
-    token, secret = assess_token
+def test_dintalk(access_token):
+    token, secret = access_token
     notify = Dingtalk(token, secret)
     res = notify.send('pypush test')
+    assert res.status_code == 200
     json = res.json()
     assert json['errcode'] == 0