Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions linebot/models/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,7 @@
StickerSendMessage,
QuickReply,
QuickReplyButton,
Sender,
)
from .sources import ( # noqa
Source,
Expand Down
23 changes: 22 additions & 1 deletion linebot/models/send_messages.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,17 +27,20 @@
class SendMessage(with_metaclass(ABCMeta, Base)):
"""Abstract Base Class of SendMessage."""

def __init__(self, quick_reply=None, **kwargs):
def __init__(self, quick_reply=None, sender=None, **kwargs):
"""__init__ method.

:param quick_reply: QuickReply object
:type quick_reply: T <= :py:class:`linebot.models.send_messages.QuickReply`
:param sender: Sender object
:type sender: T <= :py:class:`linebot.models.send_messages.Sender`
:param kwargs:
"""
super(SendMessage, self).__init__(**kwargs)

self.type = None
self.quick_reply = self.get_or_new_from_json_dict(quick_reply, QuickReply)
self.sender = self.get_or_new_from_json_dict(sender, Sender)


class TextSendMessage(SendMessage):
Expand Down Expand Up @@ -232,3 +235,21 @@ def __init__(self, image_url=None, action=None, **kwargs):
self.type = 'action'
self.image_url = image_url
self.action = get_action(action)


class Sender(with_metaclass(ABCMeta, Base)):
"""Sender.

https://developers.line.biz/en/reference/messaging-api/#icon-nickname-switch
"""

def __init__(self, name=None, icon_url=None, **kwargs):
"""__init__ method.

:param str name: Display name
:param str icon_url: Icon image URL
"""
super(Sender, self).__init__(**kwargs)

self.name = name
self.icon_url = icon_url
79 changes: 79 additions & 0 deletions tests/api/test_send_text_message_with_sender.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
# -*- 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 json
import unittest

import responses

from linebot import (
LineBotApi
)
from linebot.models import (
TextSendMessage, Sender
)


class TestLineBotApi(unittest.TestCase):
def setUp(self):
self.tested = LineBotApi('channel_secret')

# test data
self.text_message = TextSendMessage(text='Hello, world')
self.message = [{"type": "text", "text": "Hello, world"}]

@responses.activate
def test_push_text_message_with_quick_reply(self):
responses.add(
responses.POST,
LineBotApi.DEFAULT_API_ENDPOINT + '/v2/bot/message/push',
json={}, status=200
)

self.tested.push_message('to',
TextSendMessage(
text='Hello, world',
sender=Sender(
name='Cony',
icon_url='https://example.com/original.jpg'
)))

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",
'notificationDisabled': False,
"messages": [
{
"type": "text",
"text": "Hello, world",
"sender": {
"name": "Cony",
"iconUrl": "https://example.com/original.jpg"
}
}
]
}
)


if __name__ == '__main__':
unittest.main()