Support emoji length and X-Line-Retry-key (#270)

#266

Emojis
- add length paramter

X-Line-Retry-key
- modified exception string condition if accepted_request_id was shown
- add retry_key parameter

Author: louis70109

linebot/api.py

@@ -109,7 +109,9 @@ def reply_message(self, reply_token, messages, notification_disabled=False, time
             '/v2/bot/message/reply', data=json.dumps(data), timeout=timeout
         )
 
-    def push_message(self, to, messages, notification_disabled=False, timeout=None):
+    def push_message(
+            self, to, messages,
+            retry_key=None, notification_disabled=False, timeout=None):
         """Call push message API.
 
         https://developers.line.biz/en/reference/messaging-api/#send-push-message
@@ -121,6 +123,7 @@ def push_message(self, to, messages, notification_disabled=False, timeout=None):
             Max: 5
         :type messages: T <= :py:class:`linebot.models.send_messages.SendMessage` |
             list[T <= :py:class:`linebot.models.send_messages.SendMessage`]
+        :param retry_key: (optional) Arbitrarily generated UUID in hexadecimal notation.
         :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
@@ -132,6 +135,9 @@ def push_message(self, to, messages, notification_disabled=False, timeout=None):
         if not isinstance(messages, (list, tuple)):
             messages = [messages]
 
+        if retry_key:
+            self.headers['X-Line-Retry-Key'] = retry_key
+
         data = {
             'to': to,
             'messages': [message.as_json_dict() for message in messages],
@@ -142,7 +148,7 @@ def push_message(self, to, messages, notification_disabled=False, timeout=None):
             '/v2/bot/message/push', data=json.dumps(data), timeout=timeout
         )
 
-    def multicast(self, to, messages, notification_disabled=False, timeout=None):
+    def multicast(self, to, messages, retry_key=None, notification_disabled=False, timeout=None):
         """Call multicast API.
 
         https://developers.line.biz/en/reference/messaging-api/#send-multicast-message
@@ -157,6 +163,7 @@ def multicast(self, to, messages, notification_disabled=False, timeout=None):
             Max: 5
         :type messages: T <= :py:class:`linebot.models.send_messages.SendMessage` |
             list[T <= :py:class:`linebot.models.send_messages.SendMessage`]
+        :param retry_key: (optional) Arbitrarily generated UUID in hexadecimal notation.
         :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
@@ -168,6 +175,9 @@ def multicast(self, to, messages, notification_disabled=False, timeout=None):
         if not isinstance(messages, (list, tuple)):
             messages = [messages]
 
+        if retry_key:
+            self.headers['X-Line-Retry-Key'] = retry_key
+
         data = {
             'to': to,
             'messages': [message.as_json_dict() for message in messages],
@@ -178,7 +188,7 @@ def multicast(self, to, messages, notification_disabled=False, timeout=None):
             '/v2/bot/message/multicast', data=json.dumps(data), timeout=timeout
         )
 
-    def broadcast(self, messages, notification_disabled=False, timeout=None):
+    def broadcast(self, messages, retry_key=None, notification_disabled=False, timeout=None):
         """Call broadcast API.
 
         https://developers.line.biz/en/reference/messaging-api/#send-broadcast-message
@@ -189,6 +199,7 @@ def broadcast(self, messages, notification_disabled=False, timeout=None):
             Max: 5
         :type messages: T <= :py:class:`linebot.models.send_messages.SendMessage` |
             list[T <= :py:class:`linebot.models.send_messages.SendMessage`]
+        :param retry_key: (optional) Arbitrarily generated UUID in hexadecimal notation.
         :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
@@ -201,6 +212,9 @@ def broadcast(self, messages, notification_disabled=False, timeout=None):
         if not isinstance(messages, (list, tuple)):
             messages = [messages]
 
+        if retry_key:
+            self.headers['X-Line-Retry-Key'] = retry_key
+
         data = {
             'messages': [message.as_json_dict() for message in messages],
             'notificationDisabled': notification_disabled,
@@ -212,7 +226,9 @@ def broadcast(self, messages, notification_disabled=False, timeout=None):
 
         return BroadcastResponse(request_id=response.headers.get('X-Line-Request-Id'))
 
-    def narrowcast(self, messages, recipient=None, filter=None, limit=None, timeout=None):
+    def narrowcast(
+            self, messages,
+            retry_key=None, recipient=None, filter=None, limit=None, timeout=None):
         """Call narrowcast API.
 
         https://developers.line.biz/en/reference/messaging-api/#send-narrowcast-message
@@ -224,6 +240,7 @@ def narrowcast(self, messages, recipient=None, filter=None, limit=None, timeout=
             Max: 5
         :type messages: T <= :py:class:`linebot.models.send_messages.SendMessage` |
             list[T <= :py:class:`linebot.models.send_messages.SendMessage`]
+        :param retry_key: (optional) Arbitrarily generated UUID in hexadecimal notation.
         :param recipient: audience object of recipient
         :type recipient: T <= :py:class:`linebot.models.recipient.AudienceRecipient`
         :param filter: demographic filter of recipient
@@ -240,6 +257,9 @@ def narrowcast(self, messages, recipient=None, filter=None, limit=None, timeout=
         if not isinstance(messages, (list, tuple)):
             messages = [messages]
 
+        if retry_key:
+            self.headers['X-Line-Retry-Key'] = retry_key
+
         data = {
             'messages': [message.as_json_dict() for message in messages],
             'recipient': recipient.as_json_dict(),
@@ -1156,5 +1176,6 @@ def __check_error(response):
                 status_code=response.status_code,
                 headers=dict(response.headers.items()),
                 request_id=response.headers.get('X-Line-Request-Id'),
+                accepted_request_id=response.headers.get('X-Line-Accepted-Request-Id'),
                 error=Error.new_from_json_dict(response.json)
             )

linebot/exceptions.py

@@ -58,13 +58,21 @@ def __init__(self, message='-'):
 class LineBotApiError(BaseError):
     """When LINE Messaging API response error, this error will be raised."""
 
-    def __init__(self, status_code, headers, request_id=None, error=None):
+    def __init__(
+            self,
+            status_code,
+            headers,
+            request_id=None,
+            accepted_request_id=None,
+            error=None
+    ):
         """__init__ method.
 
         :param int status_code: HTTP status code
         :param headers: Response headers
         :type headers: dict[str, str]
         :param str request_id: (optional) Request ID. A unique ID is generated for each request
+        :param str accepted_request_id: (optional) The same request has already been accepted
         :param error: (optional) Error class object.
         :type error: :py:class:`linebot.models.error.Error`
         """
@@ -73,12 +81,23 @@ def __init__(self, status_code, headers, request_id=None, error=None):
         self.status_code = status_code
         self.headers = headers
         self.request_id = request_id
+        self.accepted_request_id = accepted_request_id
         self.error = error
 
     def __str__(self):
         """str.
 
         :rtype: str
         """
+        if self.accepted_request_id:
+            return "{0}: status_code={1}, request_id={2}, " \
+                   "accepted_request_id={3}, error_response={4}, headers={5}" \
+                .format(self.__class__.__name__,
+                        self.status_code,
+                        self.request_id,
+                        self.accepted_request_id,
+                        self.error,
+                        self.headers)
         return '{0}: status_code={1}, request_id={2}, error_response={3}, headers={4}'.format(
-            self.__class__.__name__, self.status_code, self.request_id, self.error, self.headers)
+            self.__class__.__name__, self.status_code, self.request_id, self.error,
+            self.headers)

linebot/models/emojis.py

@@ -30,13 +30,14 @@ class Emojis(with_metaclass(ABCMeta, Base)):
 
     """
 
-    def __init__(self, index=None, product_id=None, emoji_id=None, **kwargs):
+    def __init__(self, index=None, length=None, product_id=None, emoji_id=None, **kwargs):
         """__init__ method.
 
         :param kwargs:
         """
         super(Emojis, self).__init__(**kwargs)
 
         self.index = index
+        self.length = length
         self.product_id = product_id
         self.emoji_id = emoji_id

tests/api/test_narrowcast_message.py

@@ -217,6 +217,90 @@ def test_narrowcast_text_message(self):
         )
         self.assertEqual('request_id_test', response.request_id)
 
+    @responses.activate
+    def test_narrowcast_text_message_with_retry_key(self):
+        responses.add(
+            responses.POST,
+            LineBotApi.DEFAULT_API_ENDPOINT + '/v2/bot/message/narrowcast',
+            json={}, status=200,
+            headers={
+                'X-Line-Request-Id': 'request_id_test',
+                'X-Line-Retry-Key': '123e4567-e89b-12d3-a456-426614174000'
+            },
+        )
+
+        response = self.tested.narrowcast(
+            self.text_message,
+            recipient=And(
+                AudienceRecipient(group_id=5614991017776),
+                Not(AudienceRecipient(group_id=4389303728991))
+            ),
+            filter=Filter(
+                demographic=Or(
+                    And(
+                        GenderFilter(one_of=["male", "female"])
+                    )
+                )
+            ),
+            limit=Limit(max=100),
+            retry_key='123e4567-e89b-12d3-a456-426614174000',
+        )
+
+        request = responses.calls[0].request
+        self.assertEqual(
+            request.url,
+            LineBotApi.DEFAULT_API_ENDPOINT + '/v2/bot/message/narrowcast')
+        self.assertEqual(request.method, 'POST')
+        self.assertEqual(
+            request.headers['X-Line-Retry-Key'],
+            '123e4567-e89b-12d3-a456-426614174000'
+        )
+        self.assertEqual(
+            json.loads(request.body),
+            {
+                "messages": self.message,
+                "recipient": {
+                    "type": "operator",
+                    "and": [
+                        {
+                            'audienceGroupId': 5614991017776,
+                            'type': 'audience'
+                        },
+                        {
+                            "type": "operator",
+                            "not": {
+                                "type": "audience",
+                                "audienceGroupId": 4389303728991
+                            }
+                        }
+                    ]
+                },
+                "filter": {
+                    "demographic": {
+                        "type": "operator",
+                        "or": [
+                            {
+                                "type": "operator",
+                                "and": [
+                                    {
+                                        "type": "gender",
+                                        "oneOf": [
+                                            "male",
+                                            "female"
+                                        ]
+                                    }
+                                ]
+                            }
+                        ]
+                    }
+                },
+                "limit": {
+                    "max": 100
+                }
+            }
+        )
+        self.assertEqual('request_id_test', response.request_id)
+
     @responses.activate
     def test_get_progress_status_narrowcast(self):
         responses.add(