feat: allow to send the headers parameters to pywebpush

README.md

@@ -36,6 +36,9 @@ WEBPUSH_SETTINGS = {
 ```
 **Replace ``"Vapid Public Key"`` and ``"Vapid Private Key"`` with your Vapid Keys. Also replace ``[email protected]`` with your email so that the push server of browser can reach to you if anything goes wrong.**
 
+To send push notifications to the safari browser, be sure to write the vapid email as `'[email protected]'` instead of `'mailto:[email protected]'`
+
+
 > **To know how to obtain Vapid Keys please see this [`py_vapid`](https://github.com/web-push-libs/vapid/tree/master/python) and [Google Developer Documentation](https://developers.google.com/web/fundamentals/push-notifications/subscribing-a-user#how_to_create_application_server_keys). You can obtain one easily from [web-push-codelab.glitch.me](https://web-push-codelab.glitch.me/). ``Application Server Keys`` and ``Vapid Keys`` both are same.**
 
 Then include `webpush` in the `urls.py`
@@ -201,8 +204,26 @@ So in order to send notification, see below.
 
  **And the subscribers will get a notification like**
  ![Web Push Notification](http://i.imgur.com/VA6cxRc.png)
+
+
 
 
+- To send push notifications to the safari browser, apple allows you to pass custom headers, you can send them as follows:
+
+    ```python
+    from webpush import send_user_notification
+
+    headers = {"topic": "0", "urgency": "normal"}
+    payload = {"head": "Welcome!", "body": "Hello World"}
+
+    send_user_notification(user=user, payload=payload, ttl=1000, headers=headers)
+
+    ```
+
+    You can also send custom headers, for example, apple allows you to [send extra parameters](https://developer.apple.com/documentation/usernotifications/sending_web_push_notifications_in_web_apps_safari_and_other_browsers#3994592), then you can use the headers argument to send them.
+
+
+
 License
 =======
 ----

setup.py

@@ -9,7 +9,7 @@
 
 setup(
     name='django-webpush',
-    version='0.3.5',
+    version='0.3.6',
     packages=find_packages(),
     include_package_data=True,
     license='GNU Public License',
@@ -34,6 +34,6 @@
         'Topic :: Internet :: WWW/HTTP :: Dynamic Content',
     ],
     install_requires=[
-        'pywebpush==1.9.4'
+        'pywebpush>=1.9.4'
     ]
 )

webpush/__init__.py

@@ -3,11 +3,11 @@
 from .utils import send_notification_to_group, send_notification_to_user
 
 
-def send_group_notification(group_name, payload, ttl=0):
+def send_group_notification(group_name, payload, ttl=0, headers={}):
     payload = json.dumps(payload)
-    send_notification_to_group(group_name, payload, ttl)
+    send_notification_to_group(group_name, payload, ttl, headers=headers)
 
 
-def send_user_notification(user, payload, ttl=0):
+def send_user_notification(user, payload, ttl=0, headers={}):
     payload = json.dumps(payload)
-    send_notification_to_user(user, payload, ttl)
+    send_notification_to_user(user, payload, ttl, headers=headers)

webpush/utils.py

@@ -5,28 +5,28 @@
 from pywebpush import WebPushException, webpush
 
 
-def send_notification_to_user(user, payload, ttl=0):
+def send_notification_to_user(user, payload, ttl=0, headers={}):
     # Get all the push_info of the user
 
     push_infos = user.webpush_info.select_related("subscription")
     for push_info in push_infos:
-        _send_notification(push_info.subscription, payload, ttl)
+        _send_notification(push_info.subscription, payload, ttl, headers=headers)
 
 
-def send_notification_to_group(group_name, payload, ttl=0):
+def send_notification_to_group(group_name, payload, ttl=0, headers={}):
     from .models import Group
     # Get all the subscription related to the group
 
     push_infos = Group.objects.get(name=group_name).webpush_info.select_related("subscription")
     for push_info in push_infos:
-        _send_notification(push_info.subscription, payload, ttl)
+        _send_notification(push_info.subscription, payload, ttl, headers=headers)
 
 
-def send_to_subscription(subscription, payload, ttl=0):
-    return _send_notification(subscription, payload, ttl)
+def send_to_subscription(subscription, payload, ttl=0, headers={}):
+    return _send_notification(subscription, payload, ttl, headers=headers)
 
 
-def _send_notification(subscription, payload, ttl):
+def _send_notification(subscription, payload, ttl, headers={}):
     subscription_data = _process_subscription_info(subscription)
     vapid_data = {}
 
@@ -42,8 +42,21 @@ def _send_notification(subscription, payload, ttl):
             'vapid_claims': {"sub": "mailto:{}".format(vapid_admin_email)}
         }
 
+    endpoint = subscription_data.get("endpoint")
+    if endpoint.startswith("https://web.push.apple.com"):
+        """
+        ttl, topic, urgency now are optional headers for web push notifications in Safari
+        Documentation:
+        https://developer.apple.com/documentation/usernotifications/sending_web_push_notifications_in_web_apps_safari_and_other_browsers#3994592
+        """
+
+        headers['ttl'] = str(headers.get("ttl", ttl))
+        headers['topic'] = str(headers.get("topic", "10"))
+        headers['urgency'] = headers.get("urgency", "normal")
+
+
     try:
-        req = webpush(subscription_info=subscription_data, data=payload, ttl=ttl, **vapid_data)
+        req = webpush(subscription_info=subscription_data, data=payload, ttl=ttl, headers=headers, **vapid_data)
         return req
     except WebPushException as e:
         # If the subscription is expired, delete it.