Add json serialize test (#182)

* WIP

* add json-serialize-tests, and add two fields being not implemented

* fix lint warning

* add richMenu tests, and refactor

* add tests for get_message_quota

Author: okue

linebot/models/events.py

@@ -36,7 +36,7 @@
     DeviceLink,
     ScenarioResult,
 )
-from linebot.models.things import Things  # noqa
+from linebot.models.things import Things  # noqa, backward compatibility
 
 
 class Event(with_metaclass(ABCMeta, Base)):

linebot/models/template.py

@@ -81,7 +81,7 @@ class ButtonsTemplate(Template):
     def __init__(self, text=None, title=None, thumbnail_image_url=None,
                  image_aspect_ratio=None,
                  image_size=None, image_background_color=None,
-                 actions=None, **kwargs):
+                 actions=None, default_action=None, **kwargs):
         """__init__ method.
 
         :param str text: Message text.
@@ -105,6 +105,9 @@ def __init__(self, text=None, title=None, thumbnail_image_url=None,
         :param actions: Action when tapped.
             Max: 4
         :type actions: list[T <= :py:class:`linebot.models.actions.Action`]
+        :param default_action: Action when image is tapped;
+            set for the entire image, title, and text area
+        :type default_action: T <= :py:class:`linebot.models.actions.Action`
         :param kwargs:
         """
         super(ButtonsTemplate, self).__init__(**kwargs)
@@ -117,6 +120,7 @@ def __init__(self, text=None, title=None, thumbnail_image_url=None,
         self.image_size = image_size
         self.image_background_color = image_background_color
         self.actions = get_actions(actions)
+        self.default_action = get_action(default_action)
 
 
 class ConfirmTemplate(Template):
@@ -214,8 +218,9 @@ class CarouselColumn(Base):
     https://developers.line.biz/en/reference/messaging-api/#column-object
     """
 
-    def __init__(self, text=None, title=None, thumbnail_image_url=None,
-                 image_background_color=None, actions=None, **kwargs):
+    def __init__(self, text=None, title=None,
+                 thumbnail_image_url=None, image_background_color=None,
+                 actions=None, default_action=None, **kwargs):
         """__init__ method.
 
         :param str text: Message text.
@@ -230,6 +235,9 @@ def __init__(self, text=None, title=None, thumbnail_image_url=None,
         :param actions: Action when tapped.
             Max: 3
         :type actions: list[T <= :py:class:`linebot.models.actions.Action`]
+        :param default_action: Action when image is tapped;
+            set for the entire image, title, and text area
+        :type default_action: T <= :py:class:`linebot.models.actions.Action`
         :param kwargs:
         """
         super(CarouselColumn, self).__init__(**kwargs)
@@ -239,6 +247,7 @@ def __init__(self, text=None, title=None, thumbnail_image_url=None,
         self.thumbnail_image_url = thumbnail_image_url
         self.image_background_color = image_background_color
         self.actions = get_actions(actions)
+        self.default_action = get_action(default_action)
 
 
 class ImageCarouselColumn(Base):

tests/api/test_get_message_quota.py

@@ -0,0 +1,75 @@
+# -*- coding: utf-8 -*-
+
+#  Licensed under the Apache License, Version 2.0 (the "License"); you may
+#  not use this file except in compliance with the License. You may obtain
+#  a copy of the License at
+#
+#       https://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#  License for the specific language governing permissions and limitations
+#  under the License.
+
+from __future__ import unicode_literals, absolute_import
+
+import unittest
+
+import responses
+
+from linebot import (
+    LineBotApi
+)
+
+
+class TestLineBotApi(unittest.TestCase):
+    def setUp(self):
+        self.tested = LineBotApi('channel_secret')
+
+    @responses.activate
+    def test_get_message_quota(self):
+        responses.add(
+            responses.GET,
+            LineBotApi.DEFAULT_API_ENDPOINT + '/v2/bot/message/quota',
+            json={
+                'type': 'limited',
+                'value': 1000
+            },
+            status=200
+        )
+        res = self.tested.get_message_quota()
+        request = responses.calls[0].request
+        self.assertEqual('GET', request.method)
+        self.assertEqual('limited', res.type)
+        self.assertEqual(1000, res.value)
+
+    @responses.activate
+    def test_get_message_quota_2(self):
+        responses.add(
+            responses.GET,
+            LineBotApi.DEFAULT_API_ENDPOINT + '/v2/bot/message/quota',
+            json={'type': 'none'},
+            status=200
+        )
+        res = self.tested.get_message_quota()
+        request = responses.calls[0].request
+        self.assertEqual('GET', request.method)
+        self.assertEqual('none', res.type)
+
+    @responses.activate
+    def test_get_message_quota_consumption(self):
+        responses.add(
+            responses.GET,
+            LineBotApi.DEFAULT_API_ENDPOINT + '/v2/bot/message/quota/consumption',
+            json={'totalUsage': 500},
+            status=200
+        )
+        res = self.tested.get_message_quota_consumption()
+        request = responses.calls[0].request
+        self.assertEqual('GET', request.method)
+        self.assertEqual(500, res.total_usage)
+
+
+if __name__ == '__main__':
+    unittest.main()

tests/api/test_rich_menu.py

@@ -388,6 +388,56 @@ def test_cancel_default_rich_menu(self):
             LineBotApi.DEFAULT_API_ENDPOINT + '/v2/bot/user/all/richmenu'
         )
 
+    @responses.activate
+    def test_get_rich_menu_image(self):
+        rich_menu_id = '1234'
+        body = b'hogieoidksk'
+        responses.add(
+            responses.GET,
+            LineBotApi.DEFAULT_API_ENDPOINT +
+            '/v2/bot/richmenu/{rich_menu_id}/content'.format(rich_menu_id=rich_menu_id),
+            body=body, status=200
+        )
+
+        res = self.tested.get_rich_menu_image(rich_menu_id)
+
+        request = responses.calls[0].request
+        self.assertEqual(request.method, 'GET')
+        self.assertEqual(
+            request.url,
+            LineBotApi.DEFAULT_API_ENDPOINT +
+            '/v2/bot/richmenu/{rich_menu_id}/content'.format(rich_menu_id=rich_menu_id),
+        )
+        self.assertEqual(
+            body,
+            res.content
+        )
+
+    @responses.activate
+    def test_set_rich_menu_image(self):
+        rich_menu_id = '1234'
+        body = b'hogieoidksk'
+        responses.add(
+            responses.POST,
+            LineBotApi.DEFAULT_API_ENDPOINT +
+            '/v2/bot/richmenu/{rich_menu_id}/content'.format(rich_menu_id=rich_menu_id),
+            json={}, status=200
+        )
+
+        self.tested.set_rich_menu_image(
+            rich_menu_id=rich_menu_id,
+            content_type='image/jpeg',
+            content=body
+        )
+
+        request = responses.calls[0].request
+        self.assertEqual('POST', request.method)
+        self.assertEqual(
+            LineBotApi.DEFAULT_API_ENDPOINT +
+            '/v2/bot/richmenu/{rich_menu_id}/content'.format(rich_menu_id=rich_menu_id),
+            request.url
+        )
+
 
 if __name__ == '__main__':
     unittest.main()

tests/models/serialize_test_case.py

@@ -0,0 +1,81 @@
+# -*- coding: utf-8 -*-
+
+#  Licensed under the Apache License, Version 2.0 (the "License"); you may
+#  not use this file except in compliance with the License. You may obtain
+#  a copy of the License at
+#
+#       https://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#  License for the specific language governing permissions and limitations
+#  under the License.
+
+from __future__ import unicode_literals, absolute_import
+
+import sys
+import unittest
+from numbers import Number
+
+from linebot.models import (
+    Base,
+)
+from linebot.utils import to_camel_case
+
+PY3 = sys.version_info[0] == 3
+
+
+class SerializeTestCase(unittest.TestCase):
+    MESSAGE = 'message'
+    STICKER = 'sticker'
+    POSTBACK = 'postback'
+    CAMERA = 'camera'
+    CAMERA_ROLL = 'cameraRoll'
+    DATETIMEPICKER = 'datetimepicker'
+    URI = 'uri'
+    LOCATION = 'location'
+    FLEX = 'flex'
+    SPACER = 'spacer'
+    BUBBLE = 'bubble'
+    CAROUSEL = 'carousel'
+    BOX = 'box'
+    BUTTON = 'button'
+    FILLER = 'filler'
+    ICON = 'icon'
+    TEXT = 'text'
+    IMAGE = 'image'
+    VIDEO = 'video'
+    AUDIO = 'audio'
+    SEPARATOR = 'separator'
+    IMAGEMAP = 'imagemap'
+    ACTION = 'action'
+    TEMPLATE = 'template'
+    BUTTONS = 'buttons'
+    CONFIRM = 'confirm'
+    IMAGE_CAROUSEL = 'image_carousel'
+
+    def serialize_as_dict(self, obj, type=None):
+        if isinstance(obj, Base):
+            return obj.as_json_dict()
+        elif isinstance(obj, dict):
+            ret = {to_camel_case(k): self.serialize_as_dict(v) for k, v in obj.items()}
+            if type is not None:
+                ret['type'] = type
+            return ret
+        elif isinstance(obj, list):
+            return [self.serialize_as_dict(elem) for elem in obj]
+        else:
+            if PY3:
+                self.assertIsInstance(obj, (str, bool, Number))
+            else:
+                self.assertIsInstance(obj, (basestring, bool, Number))  # noqa
+            return obj
+
+    class ConstError(TypeError):
+        pass
+
+    def __setattr__(self, name, value):
+        if name in SerializeTestCase.__dict__:
+            raise self.ConstError("Can't rebind const (%s)" % name)
+        self.__dict__[name] = value

tests/models/test_actions.py

@@ -0,0 +1,108 @@
+# -*- coding: utf-8 -*-
+
+#  Licensed under the Apache License, Version 2.0 (the "License"); you may
+#  not use this file except in compliance with the License. You may obtain
+#  a copy of the License at
+#
+#       https://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#  License for the specific language governing permissions and limitations
+#  under the License.
+
+from __future__ import unicode_literals, absolute_import
+
+import unittest
+
+from linebot.models import (
+    PostbackAction,
+    MessageAction,
+    CameraRollAction,
+    CameraAction,
+    URIAction,
+    LocationAction,
+    DatetimePickerAction,
+    AltUri,
+)
+from tests.models.serialize_test_case import SerializeTestCase
+
+
+class TestActions(SerializeTestCase):
+    def test_postback(self):
+        arg = {
+            'label': 'Buy',
+            'data': 'action=buy&id=1',
+            'display_text': 'buy'
+        }
+        self.assertEqual(
+            self.serialize_as_dict(arg, type=self.POSTBACK),
+            PostbackAction(**arg).as_json_dict()
+        )
+
+    def test_message(self):
+        arg = {
+            'label': 'Yes',
+            'text': 'yes'
+        }
+        self.assertEqual(
+            self.serialize_as_dict(arg, type=self.MESSAGE),
+            MessageAction(**arg).as_json_dict()
+        )
+
+    def test_camera(self):
+        arg = {
+            'label': 'camera'
+        }
+        self.assertEqual(
+            self.serialize_as_dict(arg, type=self.CAMERA),
+            CameraAction(**arg).as_json_dict()
+        )
+
+    def test_camera_roll(self):
+        arg = {
+            'label': 'camera roll'
+        }
+        self.assertEqual(
+            self.serialize_as_dict(arg, type=self.CAMERA_ROLL),
+            CameraRollAction(**arg).as_json_dict()
+        )
+
+    def test_datetime_picker(self):
+        arg = {
+            'label': 'Select date',
+            'data': 'storeId=12345',
+            'mode': 'datetime',
+            'initial': '2017-12-25t00:00',
+            'max': '2018-01-24t23:59',
+            'min': '2017-12-25t00:00'
+        }
+        self.assertEqual(
+            self.serialize_as_dict(arg, type=self.DATETIMEPICKER),
+            DatetimePickerAction(**arg).as_json_dict()
+        )
+
+    def test_uri(self):
+        arg = {
+            'label': 'View detail',
+            'uri': 'https://example.com',
+            'alt_uri': AltUri(desktop='https://example.com')
+        }
+        self.assertEqual(
+            self.serialize_as_dict(arg, type=self.URI),
+            URIAction(**arg).as_json_dict()
+        )
+
+    def test_location(self):
+        arg = {
+            'label': 'Location'
+        }
+        self.assertEqual(
+            self.serialize_as_dict(arg, type=self.LOCATION),
+            LocationAction(**arg).as_json_dict()
+        )
+
+
+if __name__ == '__main__':
+    unittest.main()