support hmos

Author: jg-json

docs/push/push.md

@@ -250,7 +250,7 @@ ios(alert=None, badge='+1', sound=None， content_available=False, mutable_conte
 
 返回值
 
-> ios payload 字典
+> android payload 字典
 
 #####  android payload
 ```

examples/device_example.py

@@ -6,7 +6,7 @@
 
 def alias_user():
     alias = "alias1"
-    platform = "android,ios"
+    platform = "android,ios,hmos"
     device.get_aliasuser(alias, platform)
 
 def ctrl_tag():
@@ -20,12 +20,12 @@ def get_device():
 
 def delete_alias():
     alias = "alias1"
-    platform = "android,ios"
+    platform = "android,ios,hmos"
     device.delete_alias(alias, platform)
 
 def delete_tag():
     tag = "ddd"
-    platform = "android,ios"
+    platform = "android,ios,hmos"
     device.delete_tag(tag, platform)
 
 def check_tag():

examples/push_example.py

@@ -58,8 +58,9 @@ def notification():
 
     ios = jpush.ios(alert="Hello, IOS JPush!", sound="a.caf", extras={'k1':'v1'})
     android = jpush.android(alert="Hello, Android msg", priority=1, style=1, alert_type=1,big_text='jjjjjjjjjj', extras={'k1':'v1'})
+    hmos = jpush.hmos(alert="Hello, HMOS JPush!", category="category", large_icon="large_icon", intent={"url":"action.system.home"}, extras={'k1':'v1'}, style="style", inbox="inbox")
 
-    push.notification = jpush.notification(alert="Hello, JPush!", android=android, ios=ios)
+    push.notification = jpush.notification(alert="Hello, JPush!", android=android, ios=ios, hmos=hmos)
 
     # pprint (push.payload)
     result = push.send()
@@ -77,7 +78,8 @@ def platfrom_msg():
     push.audience = jpush.all_
     ios_msg = jpush.ios(alert="Hello, IOS JPush!", badge="+1", sound="a.caf", extras={'k1':'v1'})
     android_msg = jpush.android(alert="Hello, android msg")
-    push.notification = jpush.notification(alert="Hello, JPush!", android=android_msg, ios=ios_msg)
+    hmos_msg = jpush.hmos(alert="Hello, HMOS JPush msg")
+    push.notification = jpush.notification(alert="Hello, JPush!", android=android_msg, ios=ios_msg, hmos=hmos_msg)
     push.message=jpush.message("content",extras={'k2':'v2','k3':'v3'})
     push.platform = jpush.all_
     push.send()
@@ -88,7 +90,8 @@ def silent():
     push.audience = jpush.all_
     ios_msg = jpush.ios(alert="Hello, IOS JPush!", badge="+1", extras={'k1':'v1'}, sound_disable=True)
     android_msg = jpush.android(alert="Hello, android msg")
-    push.notification = jpush.notification(alert="Hello, JPush!", android=android_msg, ios=ios_msg)
+    hmos_msg = jpush.hmos(alert="Hello, HMOS JPush msg")
+    push.notification = jpush.notification(alert="Hello, JPush!", android=android_msg, ios=ios_msg, hmos=hmos_msg)
     push.platform = jpush.all_
     push.send()
 

jpush/__init__.py

@@ -13,6 +13,7 @@
     notification,
     ios,
     android,
+    hmos,
     winphone,
     platform,
     audience,
@@ -57,6 +58,7 @@
     notification,
     ios,
     android,
+    hmos,
     winphone,
     message,
     smsmessage,

jpush/push/__init__.py

@@ -14,6 +14,7 @@
     android,
     ios,
     winphone,
+    hmos,
     platform,
     cid,
     notification,

jpush/push/payload.py

@@ -13,13 +13,14 @@
     string_types = (str, unicode)
 
 
-def notification(alert=None, ios=None, android=None, winphone=None):
+def notification(alert=None, ios=None, android=None, winphone=None,hmos=None):
     """Create a notification payload.
 
     :keyword alert: A simple text alert, applicable for all platforms.
     :keyword ios: An iOS platform override, as generated by :py:func:`ios`.
     :keyword android: An Android platform override, as generated by :py:func:`android`.
     :keyword winphone: A MPNS platform override, as generated by :py:func:`mpns`.
+    :keyword hmos: A hmos platform override, as generated by :py:func:`hmos`.
 
     """
     payload = {}
@@ -31,6 +32,8 @@ def notification(alert=None, ios=None, android=None, winphone=None):
         payload['android'] = android
     if winphone is not None:
         payload['winphone'] = winphone
+    if hmos is not None:
+        payload['hmos'] = hmos
     if not payload:
         raise ValueError("Notification body may not be empty")
     return payload
@@ -48,6 +51,9 @@ def ios(alert=None, badge='+1', sound=None, content_available=False,
     :keyword extras: A set of key/value pairs to include in the push payload
         sent to the device.
     :keyword sound_disalbe: Disable sound to implement slient push.
+    :keyword mutable_content: If True, enables modifying notification content in iOS service extension.
+    :keyword category: String category for iOS notification action buttons.
+    :keyword thread_id: String identifier to group related notifications in iOS.
 
     >>> ios(alert='Hello!', sound='cat.caf',
     ...     extras={'articleid': '12345'})
@@ -147,6 +153,38 @@ def winphone(alert, title=None, _open_page=None, extras=None):
         payload['extras'] = extras
     return payload
 
+def hmos(alert, title=None, category=None, large_icon=None, intent=None, extras=None, style=None, inbox=None):
+    """Hmos specific platform override payload.
+    more info:https://docs.jiguang.cn/jpush/server/push/rest_api_v3_push#hmos
+
+    :keyword alert: String alert text.
+    :keyword title: String
+    :keyword category: String
+    :keyword large_icon: String
+    :keyword intent: A set of key/value pairs to include in the push payload
+    :keyword extras: A set of key/value pairs to include in the push payload
+    :keyword style: String
+    :keyword inbox: String
+    """
+    payload = {}
+    if alert is not None:
+        payload['alert'] = alert
+    if title is not None:
+        payload['title'] = title
+    if category is not None:
+        payload['category'] = category
+    if large_icon is not None:
+        payload['large_icon'] = large_icon
+    if intent is not None:
+        payload['intent'] = intent
+    if extras is not None:
+        payload['extras'] = extras
+    if style is not None:
+        payload['style'] = style
+    if inbox is not None:
+        payload['inbox'] = inbox
+    return payload
+
 def message(msg_content, title=None, content_type=None, extras=None):
     """Inner-conn push message payload creation.
 
@@ -199,7 +237,7 @@ def platform(*types):
     if len(types) == 1 and types[0] == 'all':
         return 'all'
     for t in types:
-        if t not in ('ios', 'android', 'winphone'):
+        if t not in ('ios', 'android', 'winphone', 'hmos'):
             raise ValueError("Invalid platform '%s'" % t)
     return [t for t in types]
 

setup.py

@@ -4,7 +4,7 @@
 try:
     from setuptools import setup
 except (ImportError):
-    from distutils.core import setup
+    from distutils.core import setup  
 
 _version_re = re.compile(r'__version__\s+=\s+(.*)')
 
@@ -16,7 +16,7 @@
     name='jpush',
     version=version,
     description='JPush\'s officially supported Python client library',
-    keywords=('JPush', 'JPush API', 'Android Push', 'iOS Push'),
+    keywords=('JPush', 'JPush API', 'Android Push', 'iOS Push', 'HMOS Push'),
     license='MIT License',
     long_description=open("README.rst", "r").read(),
     long_description_content_type="text/markdown",

tests/devices/test_devices.py

@@ -19,7 +19,7 @@ def test_create_device(self):
 
     def test_aliasuser(self):
         alias = "alias1"
-        platform = "android,ios"
+        platform = "android,ios,hmos"
         result = device.get_aliasuser(alias, platform)
         self.assertEqual(result.status_code, 200)
 
@@ -44,13 +44,13 @@ def test_get_device(self):
 
     def test_remove_alias(self):
         alias = "alias1"
-        platform = "android,ios"
+        platform = "android,ios,hmos"
         result = device.delete_alias(alias, platform)
         self.assertEqual(result.status_code, 200)
 
     def test_remove_tags(self):
         tag = "ddd"
-        platform = "android,ios"
+        platform = "android,ios,hmos"
         result = device.delete_tag(tag, platform)
         self.assertEqual(result.status_code, 200)
 

tests/push/test_message.py

@@ -33,6 +33,12 @@ def test_winphone(self):
             jpush.notification(winphone=jpush.winphone(alert="Hello", extras={'k3':'v3'})),
             {'winphone': {'extras': {'k3': 'v3'}, 'alert': 'Hello'}}
         )
+        
+    def test_hmos(self):
+        self.assertEqual(
+            jpush.notification(hmos=jpush.hmos(alert="Hello", title="Title", extras={'k4':'v4'})),
+            {'hmos': {'extras': {'k4': 'v4'}, 'alert': 'Hello', 'title': 'Title'}}
+        )
 
     def test_push(self):
         _jpush = jpush.JPush(app_key, master_secret)