Add notificationDisabled to send message APIs (#164)

clsung · be-hase · commit 2192bd78f29e · 2019-05-22T10:49:45.000+09:00
- refer to #162 - also add test to broadcast
diff --git a/linebot/api.py b/linebot/api.py
@@ -58,7 +58,7 @@ def __init__(self, channel_access_token, endpoint=DEFAULT_API_ENDPOINT,
         else:
             self.http_client = RequestsHttpClient(timeout=timeout)
 
-    def reply_message(self, reply_token, messages, timeout=None):
+    def reply_message(self, reply_token, messages, notification_disabled=False, timeout=None):
         """Call reply message API.
 
         https://devdocs.line.me/en/#reply-message
@@ -78,6 +78,8 @@ def reply_message(self, reply_token, messages, timeout=None):
             Max: 5
         :type messages: T <= :py:class:`linebot.models.send_messages.SendMessage` |
             list[T <= :py:class:`linebot.models.send_messages.SendMessage`]
+        :param bool notification_disabled: (optional) True to disable push notification
+            when the message is sent. The default value is False.
         :param timeout: (optional) How long to wait for the server
             to send data before giving up, as a float,
             or a (connect timeout, read timeout) float tuple.
@@ -89,14 +91,15 @@ def reply_message(self, reply_token, messages, timeout=None):
 
         data = {
             'replyToken': reply_token,
-            'messages': [message.as_json_dict() for message in messages]
+            'messages': [message.as_json_dict() for message in messages],
+            'notificationDisabled': notification_disabled,
         }
 
         self._post(
             '/v2/bot/message/reply', data=json.dumps(data), timeout=timeout
         )
 
-    def push_message(self, to, messages, timeout=None):
+    def push_message(self, to, messages, notification_disabled=False, timeout=None):
         """Call push message API.
 
         https://devdocs.line.me/en/#push-message
@@ -108,6 +111,8 @@ def push_message(self, to, messages, timeout=None):
             Max: 5
         :type messages: T <= :py:class:`linebot.models.send_messages.SendMessage` |
             list[T <= :py:class:`linebot.models.send_messages.SendMessage`]
+        :param bool notification_disabled: (optional) True to disable push notification
+            when the message is sent. The default value is False.
         :param timeout: (optional) How long to wait for the server
             to send data before giving up, as a float,
             or a (connect timeout, read timeout) float tuple.
@@ -119,14 +124,15 @@ def push_message(self, to, messages, timeout=None):
 
         data = {
             'to': to,
-            'messages': [message.as_json_dict() for message in messages]
+            'messages': [message.as_json_dict() for message in messages],
+            'notificationDisabled': notification_disabled,
         }
 
         self._post(
             '/v2/bot/message/push', data=json.dumps(data), timeout=timeout
         )
 
-    def multicast(self, to, messages, timeout=None):
+    def multicast(self, to, messages, notification_disabled=False, timeout=None):
         """Call multicast API.
 
         https://devdocs.line.me/en/#multicast
@@ -140,6 +146,8 @@ def multicast(self, to, messages, timeout=None):
             Max: 5
         :type messages: T <= :py:class:`linebot.models.send_messages.SendMessage` |
             list[T <= :py:class:`linebot.models.send_messages.SendMessage`]
+        :param bool notification_disabled: (optional) True to disable push notification
+            when the message is sent. The default value is False.
         :param timeout: (optional) How long to wait for the server
             to send data before giving up, as a float,
             or a (connect timeout, read timeout) float tuple.
@@ -151,14 +159,15 @@ def multicast(self, to, messages, timeout=None):
 
         data = {
             'to': to,
-            'messages': [message.as_json_dict() for message in messages]
+            'messages': [message.as_json_dict() for message in messages],
+            'notificationDisabled': notification_disabled,
         }
 
         self._post(
             '/v2/bot/message/multicast', data=json.dumps(data), timeout=timeout
         )
 
-    def broadcast(self, messages, timeout=None):
+    def broadcast(self, messages, notification_disabled=False, timeout=None):
         """Call broadcast API.
 
         https://developers.line.biz/en/reference/messaging-api/#send-broadcast-message
@@ -169,6 +178,8 @@ def broadcast(self, messages, timeout=None):
             Max: 5
         :type messages: T <= :py:class:`linebot.models.send_messages.SendMessage` |
             list[T <= :py:class:`linebot.models.send_messages.SendMessage`]
+        :param bool notification_disabled: (optional) True to disable push notification
+            when the message is sent. The default value is False.
         :param timeout: (optional) How long to wait for the server
             to send data before giving up, as a float,
             or a (connect timeout, read timeout) float tuple.
@@ -179,7 +190,8 @@ def broadcast(self, messages, timeout=None):
             messages = [messages]
 
         data = {
-            'messages': [message.as_json_dict() for message in messages]
+            'messages': [message.as_json_dict() for message in messages],
+            'notificationDisabled': notification_disabled,
         }
 
         self._post(
diff --git a/tests/api/test_send_audio_message.py b/tests/api/test_send_audio_message.py
@@ -62,6 +62,7 @@ def test_push_audio_message(self):
             json.loads(request.body),
             {
                 "to": "to",
+                'notificationDisabled': False,
                 "messages": self.message
             }
         )
@@ -85,6 +86,7 @@ def test_reply_audio_message(self):
             json.loads(request.body),
             {
                 "replyToken": "replyToken",
+                'notificationDisabled': False,
                 "messages": self.message
             }
         )
@@ -108,6 +110,7 @@ def test_multicast_audio_message(self):
             json.loads(request.body),
             {
                 "to": ['to1', 'to2'],
+                'notificationDisabled': False,
                 "messages": self.message
             }
         )
diff --git a/tests/api/test_send_image_message.py b/tests/api/test_send_image_message.py
@@ -61,6 +61,7 @@ def test_push_image_message(self):
             json.loads(request.body),
             {
                 "to": "to",
+                'notificationDisabled': False,
                 "messages": self.message
             }
         )
@@ -84,6 +85,7 @@ def test_reply_image_message(self):
             json.loads(request.body),
             {
                 "replyToken": "replyToken",
+                'notificationDisabled': False,
                 "messages": self.message
             }
         )
@@ -107,6 +109,7 @@ def test_multicast_image_message(self):
             json.loads(request.body),
             {
                 "to": ['to1', 'to2'],
+                'notificationDisabled': False,
                 "messages": self.message
             }
         )
diff --git a/tests/api/test_send_imagemap_message.py b/tests/api/test_send_imagemap_message.py
@@ -129,6 +129,7 @@ def test_push_imagemap_message(self):
             json.loads(request.body),
             {
                 "to": "to",
+                'notificationDisabled': False,
                 "messages": self.message
             }
         )
@@ -152,6 +153,7 @@ def test_reply_imagemap_message(self):
             json.loads(request.body),
             {
                 "replyToken": "replyToken",
+                'notificationDisabled': False,
                 "messages": self.message
             }
         )
@@ -175,6 +177,7 @@ def test_multicast_imagemap_message(self):
             json.loads(request.body),
             {
                 "to": ['to1', 'to2'],
+                'notificationDisabled': False,
                 "messages": self.message
             }
         )
diff --git a/tests/api/test_send_location_message.py b/tests/api/test_send_location_message.py
@@ -65,6 +65,7 @@ def test_push_location_message(self):
             json.loads(request.body),
             {
                 "to": "to",
+                'notificationDisabled': False,
                 "messages": self.message
             }
         )
@@ -88,6 +89,7 @@ def test_reply_location_message(self):
             json.loads(request.body),
             {
                 "replyToken": "replyToken",
+                'notificationDisabled': False,
                 "messages": self.message
             }
         )
@@ -111,6 +113,7 @@ def test_multicast_location_message(self):
             json.loads(request.body),
             {
                 "to": ['to1', 'to2'],
+                'notificationDisabled': False,
                 "messages": self.message
             }
         )
diff --git a/tests/api/test_send_sticker_message.py b/tests/api/test_send_sticker_message.py
@@ -60,6 +60,7 @@ def test_push_sticker_message(self):
             json.loads(request.body),
             {
                 "to": "to",
+                'notificationDisabled': False,
                 "messages": self.message
             }
         )
@@ -83,6 +84,7 @@ def test_reply_sticker_message(self):
             json.loads(request.body),
             {
                 "replyToken": "replyToken",
+                'notificationDisabled': False,
                 "messages": self.message
             }
         )
@@ -106,6 +108,7 @@ def test_multicast_sticker_message(self):
             json.loads(request.body),
             {
                 "to": ['to1', 'to2'],
+                'notificationDisabled': False,
                 "messages": self.message
             }
         )
diff --git a/tests/api/test_send_template_message.py b/tests/api/test_send_template_message.py
@@ -380,6 +380,7 @@ def test_push_buttons_template_message(self):
             json.loads(request.body),
             {
                 "to": "to",
+                'notificationDisabled': False,
                 "messages": self.button_message
             }
         )
@@ -403,6 +404,7 @@ def test_reply_buttons_template_message(self):
             json.loads(request.body),
             {
                 "replyToken": "replyToken",
+                'notificationDisabled': False,
                 "messages": self.button_message
             }
         )
@@ -426,6 +428,7 @@ def test_push_confirm_template_message(self):
             json.loads(request.body),
             {
                 "to": "to",
+                'notificationDisabled': False,
                 "messages": self.confirm_message
             }
         )
@@ -450,6 +453,7 @@ def test_reply_confirm_template_message(self):
             json.loads(request.body),
             {
                 "replyToken": "replyToken",
+                'notificationDisabled': False,
                 "messages": self.confirm_message
             }
         )
@@ -473,6 +477,7 @@ def test_push_carousel_template_message(self):
             json.loads(request.body),
             {
                 "to": "to",
+                'notificationDisabled': False,
                 "messages": self.carousel_message
             }
         )
@@ -496,6 +501,7 @@ def test_reply_carousel_template_message(self):
             json.loads(request.body),
             {
                 "replyToken": "replyToken",
+                'notificationDisabled': False,
                 "messages": self.carousel_message
             }
         )
@@ -519,6 +525,7 @@ def test_multicast_carousel_template_message(self):
             json.loads(request.body),
             {
                 "to": ['to1', 'to2'],
+                'notificationDisabled': False,
                 "messages": self.carousel_message
             }
         )
@@ -542,6 +549,7 @@ def test_push_image_carousel_template_message(self):
             json.loads(request.body),
             {
                 "to": "to",
+                'notificationDisabled': False,
                 "messages": self.image_carousel_message
             }
         )
@@ -565,6 +573,7 @@ def test_reply_image_carousel_template_message(self):
             json.loads(request.body),
             {
                 "replyToken": "replyToken",
+                'notificationDisabled': False,
                 "messages": self.image_carousel_message
             }
         )
@@ -588,6 +597,7 @@ def test_multicast_image_carousel_template_message(self):
             json.loads(request.body),
             {
                 "to": ['to1', 'to2'],
+                'notificationDisabled': False,
                 "messages": self.image_carousel_message
             }
         )
diff --git a/tests/api/test_send_text_message.py b/tests/api/test_send_text_message.py
@@ -54,6 +54,7 @@ def test_push_text_message(self):
             json.loads(request.body),
             {
                 "to": "to",
+                'notificationDisabled': False,
                 "messages": self.message
             }
         )
@@ -77,6 +78,7 @@ def test_reply_text_message(self):
             json.loads(request.body),
             {
                 "replyToken": "replyToken",
+                'notificationDisabled': False,
                 "messages": self.message
             }
         )
@@ -100,6 +102,46 @@ def test_multicast_text_message(self):
             json.loads(request.body),
             {
                 "to": ['to1', 'to2'],
+                'notificationDisabled': False,
+                "messages": self.message
+            }
+        )
+
+    @responses.activate
+    def test_broadcast_text_message(self):
+        responses.add(
+            responses.POST,
+            LineBotApi.DEFAULT_API_ENDPOINT + '/v2/bot/message/broadcast',
+            json={}, status=200
+        )
+
+        self.tested.broadcast(self.text_message)
+
+        request = responses.calls[0].request
+        self.assertEqual(
+            request.url,
+            LineBotApi.DEFAULT_API_ENDPOINT + '/v2/bot/message/broadcast')
+        self.assertEqual(request.method, 'POST')
+        self.assertEqual(
+            json.loads(request.body),
+            {
+                'notificationDisabled': False,
+                "messages": self.message
+            }
+        )
+
+        # call with notification_disable=True
+        self.tested.broadcast(self.text_message, notification_disabled=True)
+
+        request = responses.calls[1].request
+        self.assertEqual(
+            request.url,
+            LineBotApi.DEFAULT_API_ENDPOINT + '/v2/bot/message/broadcast')
+        self.assertEqual(request.method, 'POST')
+        self.assertEqual(
+            json.loads(request.body),
+            {
+                'notificationDisabled': True,
                 "messages": self.message
             }
         )
diff --git a/tests/api/test_send_text_message_with_quick_reply.py b/tests/api/test_send_text_message_with_quick_reply.py
@@ -81,6 +81,7 @@ def test_push_text_message_with_quick_reply(self):
             json.loads(request.body),
             {
                 "to": "to",
+                'notificationDisabled': False,
                 "messages": [
                     {
                         "type": "text",
diff --git a/tests/api/test_send_video_message.py b/tests/api/test_send_video_message.py

Original file line number	Diff line number	Diff line change
`@@ -62,6 +62,7 @@ def test_push_audio_message(self):`
`62`	`62`	`json.loads(request.body),`
`63`	`63`	`{`
`64`	`64`	`"to": "to",`
	`65`	`+ 'notificationDisabled': False,`
`65`	`66`	`"messages": self.message`
`66`	`67`	`}`
`67`	`68`	`)`
`@@ -85,6 +86,7 @@ def test_reply_audio_message(self):`
`85`	`86`	`json.loads(request.body),`
`86`	`87`	`{`
`87`	`88`	`"replyToken": "replyToken",`
	`89`	`+ 'notificationDisabled': False,`
`88`	`90`	`"messages": self.message`
`89`	`91`	`}`
`90`	`92`	`)`
`@@ -108,6 +110,7 @@ def test_multicast_audio_message(self):`
`108`	`110`	`json.loads(request.body),`
`109`	`111`	`{`
`110`	`112`	`"to": ['to1', 'to2'],`
	`113`	`+ 'notificationDisabled': False,`
`111`	`114`	`"messages": self.message`
`112`	`115`	`}`
`113`	`116`	`)`
Original file line number	Diff line number	Diff line change
`@@ -61,6 +61,7 @@ def test_push_image_message(self):`
`61`	`61`	`json.loads(request.body),`
`62`	`62`	`{`
`63`	`63`	`"to": "to",`
	`64`	`+ 'notificationDisabled': False,`
`64`	`65`	`"messages": self.message`
`65`	`66`	`}`
`66`	`67`	`)`
`@@ -84,6 +85,7 @@ def test_reply_image_message(self):`
`84`	`85`	`json.loads(request.body),`
`85`	`86`	`{`
`86`	`87`	`"replyToken": "replyToken",`
	`88`	`+ 'notificationDisabled': False,`
`87`	`89`	`"messages": self.message`
`88`	`90`	`}`
`89`	`91`	`)`
`@@ -107,6 +109,7 @@ def test_multicast_image_message(self):`
`107`	`109`	`json.loads(request.body),`
`108`	`110`	`{`
`109`	`111`	`"to": ['to1', 'to2'],`
	`112`	`+ 'notificationDisabled': False,`
`110`	`113`	`"messages": self.message`
`111`	`114`	`}`
`112`	`115`	`)`
Original file line number	Diff line number	Diff line change
`@@ -129,6 +129,7 @@ def test_push_imagemap_message(self):`
`129`	`129`	`json.loads(request.body),`
`130`	`130`	`{`
`131`	`131`	`"to": "to",`
	`132`	`+ 'notificationDisabled': False,`
`132`	`133`	`"messages": self.message`
`133`	`134`	`}`
`134`	`135`	`)`
`@@ -152,6 +153,7 @@ def test_reply_imagemap_message(self):`
`152`	`153`	`json.loads(request.body),`
`153`	`154`	`{`
`154`	`155`	`"replyToken": "replyToken",`
	`156`	`+ 'notificationDisabled': False,`
`155`	`157`	`"messages": self.message`
`156`	`158`	`}`
`157`	`159`	`)`
`@@ -175,6 +177,7 @@ def test_multicast_imagemap_message(self):`
`175`	`177`	`json.loads(request.body),`
`176`	`178`	`{`
`177`	`179`	`"to": ['to1', 'to2'],`
	`180`	`+ 'notificationDisabled': False,`
`178`	`181`	`"messages": self.message`
`179`	`182`	`}`
`180`	`183`	`)`
Original file line number	Diff line number	Diff line change
`@@ -65,6 +65,7 @@ def test_push_location_message(self):`
`65`	`65`	`json.loads(request.body),`
`66`	`66`	`{`
`67`	`67`	`"to": "to",`
	`68`	`+ 'notificationDisabled': False,`
`68`	`69`	`"messages": self.message`
`69`	`70`	`}`
`70`	`71`	`)`
`@@ -88,6 +89,7 @@ def test_reply_location_message(self):`
`88`	`89`	`json.loads(request.body),`
`89`	`90`	`{`
`90`	`91`	`"replyToken": "replyToken",`
	`92`	`+ 'notificationDisabled': False,`
`91`	`93`	`"messages": self.message`
`92`	`94`	`}`
`93`	`95`	`)`
`@@ -111,6 +113,7 @@ def test_multicast_location_message(self):`
`111`	`113`	`json.loads(request.body),`
`112`	`114`	`{`
`113`	`115`	`"to": ['to1', 'to2'],`
	`116`	`+ 'notificationDisabled': False,`
`114`	`117`	`"messages": self.message`
`115`	`118`	`}`
`116`	`119`	`)`
Original file line number	Diff line number	Diff line change
`@@ -60,6 +60,7 @@ def test_push_sticker_message(self):`
`60`	`60`	`json.loads(request.body),`
`61`	`61`	`{`
`62`	`62`	`"to": "to",`
	`63`	`+ 'notificationDisabled': False,`
`63`	`64`	`"messages": self.message`
`64`	`65`	`}`
`65`	`66`	`)`
`@@ -83,6 +84,7 @@ def test_reply_sticker_message(self):`
`83`	`84`	`json.loads(request.body),`
`84`	`85`	`{`
`85`	`86`	`"replyToken": "replyToken",`
	`87`	`+ 'notificationDisabled': False,`
`86`	`88`	`"messages": self.message`
`87`	`89`	`}`
`88`	`90`	`)`
`@@ -106,6 +108,7 @@ def test_multicast_sticker_message(self):`
`106`	`108`	`json.loads(request.body),`
`107`	`109`	`{`
`108`	`110`	`"to": ['to1', 'to2'],`
	`111`	`+ 'notificationDisabled': False,`
`109`	`112`	`"messages": self.message`
`110`	`113`	`}`
`111`	`114`	`)`
Original file line number	Diff line number	Diff line change
`@@ -380,6 +380,7 @@ def test_push_buttons_template_message(self):`
`380`	`380`	`json.loads(request.body),`
`381`	`381`	`{`
`382`	`382`	`"to": "to",`
	`383`	`+ 'notificationDisabled': False,`
`383`	`384`	`"messages": self.button_message`
`384`	`385`	`}`
`385`	`386`	`)`
`@@ -403,6 +404,7 @@ def test_reply_buttons_template_message(self):`
`403`	`404`	`json.loads(request.body),`
`404`	`405`	`{`
`405`	`406`	`"replyToken": "replyToken",`
	`407`	`+ 'notificationDisabled': False,`
`406`	`408`	`"messages": self.button_message`
`407`	`409`	`}`
`408`	`410`	`)`
`@@ -426,6 +428,7 @@ def test_push_confirm_template_message(self):`
`426`	`428`	`json.loads(request.body),`
`427`	`429`	`{`
`428`	`430`	`"to": "to",`
	`431`	`+ 'notificationDisabled': False,`
`429`	`432`	`"messages": self.confirm_message`
`430`	`433`	`}`
`431`	`434`	`)`
`@@ -450,6 +453,7 @@ def test_reply_confirm_template_message(self):`
`450`	`453`	`json.loads(request.body),`
`451`	`454`	`{`
`452`	`455`	`"replyToken": "replyToken",`
	`456`	`+ 'notificationDisabled': False,`
`453`	`457`	`"messages": self.confirm_message`
`454`	`458`	`}`
`455`	`459`	`)`
`@@ -473,6 +477,7 @@ def test_push_carousel_template_message(self):`
`473`	`477`	`json.loads(request.body),`
`474`	`478`	`{`
`475`	`479`	`"to": "to",`
	`480`	`+ 'notificationDisabled': False,`
`476`	`481`	`"messages": self.carousel_message`
`477`	`482`	`}`
`478`	`483`	`)`
`@@ -496,6 +501,7 @@ def test_reply_carousel_template_message(self):`
`496`	`501`	`json.loads(request.body),`
`497`	`502`	`{`
`498`	`503`	`"replyToken": "replyToken",`
	`504`	`+ 'notificationDisabled': False,`
`499`	`505`	`"messages": self.carousel_message`
`500`	`506`	`}`
`501`	`507`	`)`
`@@ -519,6 +525,7 @@ def test_multicast_carousel_template_message(self):`
`519`	`525`	`json.loads(request.body),`
`520`	`526`	`{`
`521`	`527`	`"to": ['to1', 'to2'],`
	`528`	`+ 'notificationDisabled': False,`
`522`	`529`	`"messages": self.carousel_message`
`523`	`530`	`}`
`524`	`531`	`)`
`@@ -542,6 +549,7 @@ def test_push_image_carousel_template_message(self):`
`542`	`549`	`json.loads(request.body),`
`543`	`550`	`{`
`544`	`551`	`"to": "to",`
	`552`	`+ 'notificationDisabled': False,`
`545`	`553`	`"messages": self.image_carousel_message`
`546`	`554`	`}`
`547`	`555`	`)`
`@@ -565,6 +573,7 @@ def test_reply_image_carousel_template_message(self):`
`565`	`573`	`json.loads(request.body),`
`566`	`574`	`{`
`567`	`575`	`"replyToken": "replyToken",`
	`576`	`+ 'notificationDisabled': False,`
`568`	`577`	`"messages": self.image_carousel_message`
`569`	`578`	`}`
`570`	`579`	`)`
`@@ -588,6 +597,7 @@ def test_multicast_image_carousel_template_message(self):`
`588`	`597`	`json.loads(request.body),`
`589`	`598`	`{`
`590`	`599`	`"to": ['to1', 'to2'],`
	`600`	`+ 'notificationDisabled': False,`
`591`	`601`	`"messages": self.image_carousel_message`
`592`	`602`	`}`
`593`	`603`	`)`
Original file line number	Diff line number	Diff line change
`@@ -81,6 +81,7 @@ def test_push_text_message_with_quick_reply(self):`
`81`	`81`	`json.loads(request.body),`
`82`	`82`	`{`
`83`	`83`	`"to": "to",`
	`84`	`+ 'notificationDisabled': False,`
`84`	`85`	`"messages": [`
`85`	`86`	`{`
`86`	`87`	`"type": "text",`