Skip to content

Support 'user_id' in SourceGroup and SourceRoom #48

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jun 1, 2017
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
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -101,4 +101,4 @@ ENV/
.idea
.DS_Store
tmp/

*.iml
2 changes: 2 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -534,9 +534,11 @@ Source
- SourceGroup
- type
- group\_id
- user\_id
- SourceRoom
- type
- room\_id
- user\_id

Message
^^^^^^^
Expand Down
2 changes: 1 addition & 1 deletion linebot/__about__.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

from __future__ import unicode_literals

__version__ = '1.2.0'
__version__ = '1.3.0'
__author__ = 'LINE Corporation'
__copyright__ = 'Copyright 2016, LINE Corporation'
__license__ = 'Apache 2.0'
Expand Down
21 changes: 19 additions & 2 deletions linebot/models/sources.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@

from __future__ import unicode_literals

import warnings
from abc import ABCMeta, abstractproperty

from future.utils import with_metaclass
Expand All @@ -42,9 +43,12 @@ def sender_id(self):
If SourceGroup, return group_id.
If SourceRoom, return room_id.

'sender_id' is deprecated.

:rtype: str
:return:
"""
warnings.warn("'sender_id' is deprecated.", DeprecationWarning, stacklevel=2)
raise NotImplementedError


Expand All @@ -71,9 +75,12 @@ def __init__(self, user_id=None, **kwargs):
def sender_id(self):
"""Alias of user_id.

'sender_id' is deprecated. Use 'user_id' instead.

:rtype: str
:return:
"""
warnings.warn("'sender_id' is deprecated.", DeprecationWarning, stacklevel=2)
return self.user_id


Expand All @@ -85,24 +92,29 @@ class SourceGroup(Source):
JSON object which contains the source group of the event.
"""

def __init__(self, group_id=None, **kwargs):
def __init__(self, group_id=None, user_id=None, **kwargs):
"""__init__ method.

:param str group_id: ID of the source group
:param str user_id: ID of the source user
:param kwargs:
"""
super(SourceGroup, self).__init__(**kwargs)

self.type = 'group'
self.group_id = group_id
self.user_id = user_id

@property
def sender_id(self):
"""Alias of group_id.

'sender_id' is deprecated. Use 'group_id' instead.

:rtype: str
:return:
"""
warnings.warn("'sender_id' is deprecated.", DeprecationWarning, stacklevel=2)
return self.group_id


Expand All @@ -114,22 +126,27 @@ class SourceRoom(Source):
JSON object which contains the source room of the event.
"""

def __init__(self, room_id=None, **kwargs):
def __init__(self, room_id=None, user_id=None, **kwargs):
"""__init__ method.

:param str room_id: ID of the source room
:param str user_id: ID of the source user
:param kwargs:
"""
super(SourceRoom, self).__init__(**kwargs)

self.type = 'room'
self.room_id = room_id
self.user_id = user_id

@property
def sender_id(self):
"""Alias of room_id.

'sender_id' is deprecated. Use 'room_id' instead.

:rtype: str
:return:
"""
warnings.warn("'sender_id' is deprecated.", DeprecationWarning, stacklevel=2)
return self.room_id
2 changes: 1 addition & 1 deletion requirements-test.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
pytest
pytest-pep8
pytest-cov
responses
responses
2 changes: 1 addition & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
requests >= 2.0
future
future
45 changes: 39 additions & 6 deletions tests/test_webhook.py
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,9 @@ def test_parse(self):
self.assertEqual(events[1].timestamp, 1462629479859)
self.assertIsInstance(events[1].source, SourceRoom)
self.assertEqual(events[1].source.type, 'room')
self.assertEqual(events[1].source.room_id, 'U206d25c2ea6bd87c17655609a1c37cb8')
self.assertEqual(events[1].source.sender_id, 'U206d25c2ea6bd87c17655609a1c37cb8')
self.assertEqual(events[1].source.room_id, 'Ra8dbf4673c4c812cd491258042226c99')
self.assertEqual(events[1].source.user_id, None)
self.assertEqual(events[1].source.sender_id, 'Ra8dbf4673c4c812cd491258042226c99')
self.assertIsInstance(events[1].message, ImageMessage)
self.assertEqual(events[1].message.id, '325708')
self.assertEqual(events[1].message.type, 'image')
Expand Down Expand Up @@ -170,17 +171,19 @@ def test_parse(self):
self.assertEqual(events[8].timestamp, 1462629479859)
self.assertIsInstance(events[8].source, SourceGroup)
self.assertEqual(events[8].source.type, 'group')
self.assertEqual(events[8].source.group_id, 'cxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx')
self.assertEqual(events[8].source.sender_id, 'cxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx')
self.assertEqual(events[8].source.group_id, 'Ca56f94637cc4347f90a25382909b24b9')
self.assertEqual(events[8].source.user_id, None)
self.assertEqual(events[8].source.sender_id, 'Ca56f94637cc4347f90a25382909b24b9')

# LeaveEvent, SourceGroup
self.assertIsInstance(events[9], LeaveEvent)
self.assertEqual(events[9].type, 'leave')
self.assertEqual(events[9].timestamp, 1462629479859)
self.assertIsInstance(events[9].source, SourceGroup)
self.assertEqual(events[9].source.type, 'group')
self.assertEqual(events[9].source.group_id, 'cxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx')
self.assertEqual(events[9].source.sender_id, 'cxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx')
self.assertEqual(events[9].source.group_id, 'Ca56f94637cc4347f90a25382909b24b9')
self.assertEqual(events[9].source.user_id, None)
self.assertEqual(events[9].source.sender_id, 'Ca56f94637cc4347f90a25382909b24b9')

# PostbackEvent, SourceUser
self.assertIsInstance(events[10], PostbackEvent)
Expand Down Expand Up @@ -221,6 +224,36 @@ def test_parse(self):
self.assertEqual(events[12].beacon.dm, '1234567890abcdef')
self.assertEqual(events[12].beacon.device_message, bytearray(b'\x124Vx\x90\xab\xcd\xef'))

# MessageEvent, SourceGroup with userId, TextMessage
self.assertIsInstance(events[13], MessageEvent)
self.assertEqual(events[13].reply_token, 'nHuyWiB7yP5Zw52FIkcQobQuGDXCTA')
self.assertEqual(events[13].type, 'message')
self.assertEqual(events[13].timestamp, 1462629479859)
self.assertIsInstance(events[13].source, SourceGroup)
self.assertEqual(events[13].source.type, 'group')
self.assertEqual(events[13].source.group_id, 'Ca56f94637cc4347f90a25382909b24b9')
self.assertEqual(events[13].source.user_id, 'U206d25c2ea6bd87c17655609a1c37cb8')
self.assertEqual(events[13].source.sender_id, 'Ca56f94637cc4347f90a25382909b24b9')
self.assertIsInstance(events[13].message, TextMessage)
self.assertEqual(events[13].message.id, '325708')
self.assertEqual(events[13].message.type, 'text')
self.assertEqual(events[13].message.text, 'Hello, world')

# MessageEvent, SourceRoom with userId, TextMessage
self.assertIsInstance(events[14], MessageEvent)
self.assertEqual(events[14].reply_token, 'nHuyWiB7yP5Zw52FIkcQobQuGDXCTA')
self.assertEqual(events[14].type, 'message')
self.assertEqual(events[14].timestamp, 1462629479859)
self.assertIsInstance(events[14].source, SourceRoom)
self.assertEqual(events[14].source.type, 'room')
self.assertEqual(events[14].source.room_id, 'Ra8dbf4673c4c812cd491258042226c99')
self.assertEqual(events[14].source.user_id, 'U206d25c2ea6bd87c17655609a1c37cb8')
self.assertEqual(events[14].source.sender_id, 'Ra8dbf4673c4c812cd491258042226c99')
self.assertIsInstance(events[14].message, TextMessage)
self.assertEqual(events[14].message.id, '325708')
self.assertEqual(events[14].message.type, 'text')
self.assertEqual(events[14].message.text, 'Hello, world')


class TestWebhookHandler(unittest.TestCase):
def setUp(self):
Expand Down
Loading