Add new API for Image Carousel (#59)

* Add new api for Image Carousel

* Fix D400 in ImageCarouselColumn

* Remove debug logger

* Fix action array count in ImageCarouselColumn

* Fix ImageCarouselColumn#action to single action

* Fix Image Carousel's test code

* Add ImagePostbackTemplateAction for Image Carousel action

* Fix D204

* Replace ImagePostbackTemplateAction to PostbackTemplateAction & delete former class

Author: nnsnodnb

linebot/models/__init__.py

@@ -79,4 +79,6 @@
     PostbackTemplateAction,
     MessageTemplateAction,
     URITemplateAction,
+    ImageCarouselTemplate,
+    ImageCarouselColumn,
 )

linebot/models/template.py

@@ -24,17 +24,22 @@
 from .send_messages import SendMessage
 
 
+def _get_action(action):
+    action_obj = Base.get_or_new_from_json_dict_with_types(
+        action, {
+            'postback': PostbackTemplateAction,
+            'message': MessageTemplateAction,
+            'uri': URITemplateAction
+        }
+    )
+    return action_obj
+
+
 def _get_actions(actions):
     new_actions = []
     if actions:
         for action in actions:
-            action_obj = Base.get_or_new_from_json_dict_with_types(
-                action, {
-                    'postback': PostbackTemplateAction,
-                    'message': MessageTemplateAction,
-                    'uri': URITemplateAction
-                }
-            )
+            action_obj = _get_action(action)
             if action_obj:
                 new_actions.append(action_obj)
 
@@ -67,7 +72,8 @@ def __init__(self, alt_text=None, template=None, **kwargs):
             template, {
                 'buttons': ButtonsTemplate,
                 'confirm': ConfirmTemplate,
-                'carousel': CarouselTemplate
+                'carousel': CarouselTemplate,
+                'image_carousel': ImageCarouselTemplate
             }
         )
 
@@ -175,6 +181,35 @@ def __init__(self, columns=None, **kwargs):
         self.columns = new_columns
 
 
+class ImageCarouselTemplate(Template):
+    """ImageCarouselTemplate.
+
+    https://devdocs.line.me/en/#image-carousel
+
+    Template message with multiple images columns which can be cycled like as carousel.
+    """
+
+    def __init__(self, columns=None, **kwargs):
+        """__init__ method.
+
+        :param columns: Array of columns.
+            Max: 5
+        :type columns: list[T <= :py:class:`linebot.models.template.ImageCarouselColumn`]
+        :param kwargs:
+        """
+        super(ImageCarouselTemplate, self).__init__(**kwargs)
+
+        self.type = 'image_carousel'
+
+        new_columns = []
+        if columns:
+            for column in columns:
+                new_columns.append(self.get_or_new_from_json_dict(
+                    column, ImageCarouselColumn
+                ))
+        self.columns = new_columns
+
+
 class CarouselColumn(Base):
     """CarouselColumn.
 
@@ -208,6 +243,32 @@ def __init__(self, text=None, title=None, thumbnail_image_url=None, actions=None
         self.actions = _get_actions(actions)
 
 
+class ImageCarouselColumn(Base):
+    """ImageCarouselColumn.
+
+    https://devdocs.line.me/en/#column-object-for-image-carousel
+    """
+
+    def __init__(self, image_url=None, action=None, **kwargs):
+        """__init__ method.
+
+        :param str image_url: Image URL.
+            HTTPS
+            JPEG or PNG
+            Aspect ratio: 1:1
+            Max width: 1024px
+            Max: 1 MB
+        :param action: Action when image is tapped
+            Max: 5
+        :type action: T <= :py:class:`linebot.models.template.TemplateAction`
+        :param kwargs:
+        """
+        super(ImageCarouselColumn, self).__init__(**kwargs)
+
+        self.image_url = image_url
+        self.action = _get_action(action)
+
+
 class TemplateAction(with_metaclass(ABCMeta, Base)):
     """Abstract Base Class of TemplateAction."""
 

tests/api/test_send_template_message.py

@@ -25,7 +25,8 @@
 from linebot.models import (
     TemplateSendMessage, ButtonsTemplate,
     PostbackTemplateAction, MessageTemplateAction, URITemplateAction,
-    ConfirmTemplate, CarouselTemplate, CarouselColumn
+    ConfirmTemplate, CarouselTemplate, CarouselColumn,
+    ImageCarouselTemplate, ImageCarouselColumn
 )
 
 
@@ -223,6 +224,73 @@ def setUp(self):
             }
         }]
 
+        self.image_carousel_template_message = TemplateSendMessage(
+            alt_text='Image carousel template',
+            template=ImageCarouselTemplate(
+                columns=[
+                    ImageCarouselColumn(
+                        image_url='https://example.com/'
+                                  'item1.jpg',
+                        action=PostbackTemplateAction(
+                            label='postback1',
+                            data='action=buy&itemid=1'
+                        )
+                    ),
+                    ImageCarouselColumn(
+                        image_url='https://example.com'
+                                  '/item2.jpg',
+                        action=MessageTemplateAction(
+                            label='message2',
+                            text='message text2'
+                        )
+                    ),
+                    ImageCarouselColumn(
+                        image_url='https://example.com/'
+                                  'item3.jpg',
+                        action=URITemplateAction(
+                            label='uri1',
+                            uri='https://example.com/1'
+                        )
+                    )
+                ]
+            )
+        )
+
+        self.image_carousel_message = [{
+            "type": "template",
+            "altText": "Image carousel template",
+            "template": {
+                "type": "image_carousel",
+                "columns": [
+                    {
+                        "imageUrl": "https://example.com/item1.jpg",
+                        "action": {
+                            "type": "postback",
+                            "label": "postback1",
+                            "data": "action=buy&itemid=1",
+                            "text": None
+                        }
+                    },
+                    {
+                        "imageUrl": "https://example.com/item2.jpg",
+                        "action": {
+                            "type": "message",
+                            "label": "message2",
+                            "text": "message text2"
+                        }
+                    },
+                    {
+                        "imageUrl": "https://example.com/item3.jpg",
+                        "action": {
+                            "type": "uri",
+                            "label": "uri1",
+                            "uri": "https://example.com/1"
+                        }
+                    }
+                ]
+            }
+        }]
+
     @responses.activate
     def test_push_buttons_template_message(self):
         responses.add(
@@ -385,6 +453,75 @@ def test_multicast_carousel_template_message(self):
             }
         )
 
+    @responses.activate
+    def test_push_image_carousel_template_message(self):
+        responses.add(
+            responses.POST,
+            LineBotApi.DEFAULT_API_ENDPOINT + '/v2/bot/message/push',
+            json={}, status=200
+        )
+
+        self.tested.push_message('to', self.image_carousel_template_message)
+
+        request = responses.calls[0].request
+        self.assertEqual(request.method, 'POST')
+        self.assertEqual(
+            request.url,
+            LineBotApi.DEFAULT_API_ENDPOINT + '/v2/bot/message/push')
+        self.assertEqual(
+            json.loads(request.body),
+            {
+                "to": "to",
+                "messages": self.image_carousel_message
+            }
+        )
+
+    @responses.activate
+    def test_reply_image_carousel_template_message(self):
+        responses.add(
+            responses.POST,
+            LineBotApi.DEFAULT_API_ENDPOINT + '/v2/bot/message/reply',
+            json={}, status=200
+        )
+
+        self.tested.reply_message('replyToken', self.image_carousel_template_message)
+
+        request = responses.calls[0].request
+        self.assertEqual(request.method, 'POST')
+        self.assertEqual(
+            request.url,
+            LineBotApi.DEFAULT_API_ENDPOINT + '/v2/bot/message/reply')
+        self.assertEqual(
+            json.loads(request.body),
+            {
+                "replyToken": "replyToken",
+                "messages": self.image_carousel_message
+            }
+        )
+
+    @responses.activate
+    def test_multicast_image_carousel_template_message(self):
+        responses.add(
+            responses.POST,
+            LineBotApi.DEFAULT_API_ENDPOINT + '/v2/bot/message/multicast',
+            json={}, status=200
+        )
+
+        self.tested.multicast(['to1', 'to2'], self.image_carousel_template_message)
+
+        request = responses.calls[0].request
+        self.assertEqual(request.method, 'POST')
+        self.assertEqual(
+            request.url,
+            LineBotApi.DEFAULT_API_ENDPOINT + '/v2/bot/message/multicast')
+        self.assertEqual(
+            json.loads(request.body),
+            {
+                "to": ['to1', 'to2'],
+                "messages": self.image_carousel_message
+            }
+        )
+
 
 if __name__ == '__main__':
     unittest.main()