Add get_group_member_ids / get_room_member_ids (#58)

be-hase · okdtsk · commit 0b4b6b74b867 · 2017-09-04T15:22:12.000+09:00
diff --git a/README.rst b/README.rst
@@ -174,6 +174,36 @@ https://devdocs.line.me/en/#get-group-room-member-profile
     print(profile.user_id)
     print(profile.picture_url)
 
+get\_group\_member\_ids(self, group\_id, start=None, timeout=None)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Gets the user IDs of the members of a group that the bot is in.
+This includes the user IDs of users who have not added the bot as a friend or has blocked the bot.
+
+https://devdocs.line.me/en/#get-group-room-member-ids
+
+.. code:: python
+
+    member_ids_res = line_bot_api.get_group_member_ids(group_id)
+
+    print(member_ids_res.member_ids)
+    print(member_ids_res.next)
+
+get\_room\_member\_ids(self, room\_id, start=None, timeout=None)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Gets the user IDs of the members of a room that the bot is in.
+This includes the user IDs of users who have not added the bot as a friend or has blocked the bot.
+
+https://devdocs.line.me/en/#get-group-room-member-ids
+
+.. code:: python
+
+    member_ids_res = line_bot_api.get_room_member_ids(room_id)
+
+    print(member_ids_res.member_ids)
+    print(member_ids_res.next)
+
 get\_message\_content(self, message\_id, timeout=None)
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
diff --git a/linebot/api.py b/linebot/api.py
@@ -22,7 +22,7 @@
 from .exceptions import LineBotApiError
 from .http_client import HttpClient, RequestsHttpClient
 from .models.error import Error
-from .models.responses import Profile, MessageContent
+from .models.responses import Profile, MemberIds, MessageContent
 
 
 class LineBotApi(object):
@@ -231,6 +231,64 @@ def get_room_member_profile(self, room_id, user_id, timeout=None):
 
         return Profile.new_from_json_dict(response.json)
 
+    def get_group_member_ids(self, group_id, start=None, timeout=None):
+        """Call get group member IDs API.
+
+        https://devdocs.line.me/en/#get-group-room-member-ids
+
+        Gets the user IDs of the members of a group that the bot is in.
+        This includes the user IDs of users who have not added the bot as a friend
+        or has blocked the bot.
+
+        :param str group_id: Group ID
+        :param str start: continuationToken
+        :param timeout: (optional) How long to wait for the server
+            to send data before giving up, as a float,
+            or a (connect timeout, read timeout) float tuple.
+            Default is self.http_client.timeout
+        :type timeout: float | tuple(float, float)
+        :rtype: :py:class:`linebot.models.responses.MemberIds`
+        :return: MemberIds instance
+        """
+        params = None if start is None else {'start': start}
+
+        response = self._get(
+            '/v2/bot/group/{group_id}/members/ids'.format(group_id=group_id),
+            params=params,
+            timeout=timeout
+        )
+
+        return MemberIds.new_from_json_dict(response.json)
+
+    def get_room_member_ids(self, room_id, start=None, timeout=None):
+        """Call get room member IDs API.
+
+        https://devdocs.line.me/en/#get-group-room-member-ids
+
+        Gets the user IDs of the members of a group that the bot is in.
+        This includes the user IDs of users who have not added the bot as a friend
+        or has blocked the bot.
+
+        :param str room_id: Room ID
+        :param str start: continuationToken
+        :param timeout: (optional) How long to wait for the server
+            to send data before giving up, as a float,
+            or a (connect timeout, read timeout) float tuple.
+            Default is self.http_client.timeout
+        :type timeout: float | tuple(float, float)
+        :rtype: :py:class:`linebot.models.responses.MemberIds`
+        :return: MemberIds instance
+        """
+        params = None if start is None else {'start': start}
+
+        response = self._get(
+            '/v2/bot/room/{room_id}/members/ids'.format(room_id=room_id),
+            params=params,
+            timeout=timeout
+        )
+
+        return MemberIds.new_from_json_dict(response.json)
+
     def get_message_content(self, message_id, timeout=None):
         """Call get content API.
 
@@ -292,11 +350,11 @@ def leave_room(self, room_id, timeout=None):
             timeout=timeout
         )
 
-    def _get(self, path, stream=False, timeout=None):
+    def _get(self, path, params=None, stream=False, timeout=None):
         url = self.endpoint + path
 
         response = self.http_client.get(
-            url, headers=self.headers, stream=stream, timeout=timeout
+            url, headers=self.headers, params=params, stream=stream, timeout=timeout
         )
 
         self.__check_error(response)
diff --git a/linebot/http_client.py b/linebot/http_client.py
@@ -32,7 +32,7 @@ def __init__(self, timeout=DEFAULT_TIMEOUT):
 
         :param timeout: (optional) How long to wait for the server
             to send data before giving up, as a float,
-            or a (connect timeout, readtimeout) float tuple.
+            or a (connect timeout, read timeout) float tuple.
             Default is :py:attr:`DEFAULT_TIMEOUT`
         :type timeout: float | tuple(float, float)
         :rtype: T <= :py:class:`HttpResponse`
@@ -50,7 +50,7 @@ def get(self, url, headers=None, params=None, stream=False, timeout=None):
         :param bool stream: (optional) get content as stream
         :param timeout: (optional), How long to wait for the server
             to send data before giving up, as a float,
-            or a (connect timeout, readtimeout) float tuple.
+            or a (connect timeout, read timeout) float tuple.
             Default is :py:attr:`self.timeout`
         :type timeout: float | tuple(float, float)
         :rtype: T <= :py:class:`HttpResponse`
@@ -67,7 +67,7 @@ def post(self, url, headers=None, data=None, timeout=None):
         :param data: (optional) Dictionary, bytes, or file-like object to send in the body
         :param timeout: (optional), How long to wait for the server
             to send data before giving up, as a float,
-            or a (connect timeout, readtimeout) float tuple.
+            or a (connect timeout, read timeout) float tuple.
             Default is :py:attr:`self.timeout`
         :type timeout: float | tuple(float, float)
         :rtype: T <= :py:class:`HttpResponse`
@@ -84,7 +84,7 @@ def __init__(self, timeout=HttpClient.DEFAULT_TIMEOUT):
 
         :param timeout: (optional) How long to wait for the server
             to send data before giving up, as a float,
-            or a (connect timeout, readtimeout) float tuple.
+            or a (connect timeout, read timeout) float tuple.
             Default is :py:attr:`DEFAULT_TIMEOUT`
         :type timeout: float | tuple(float, float)
         """
@@ -99,7 +99,7 @@ def get(self, url, headers=None, params=None, stream=False, timeout=None):
         :param bool stream: (optional) get content as stream
         :param timeout: (optional), How long to wait for the server
             to send data before giving up, as a float,
-            or a (connect timeout, readtimeout) float tuple.
+            or a (connect timeout, read timeout) float tuple.
             Default is :py:attr:`self.timeout`
         :type timeout: float | tuple(float, float)
         :rtype: :py:class:`RequestsHttpResponse`
@@ -122,7 +122,7 @@ def post(self, url, headers=None, data=None, timeout=None):
         :param data: (optional) Dictionary, bytes, or file-like object to send in the body
         :param timeout: (optional), How long to wait for the server
             to send data before giving up, as a float,
-            or a (connect timeout, readtimeout) float tuple.
+            or a (connect timeout, read timeout) float tuple.
             Default is :py:attr:`self.timeout`
         :type timeout: float | tuple(float, float)
         :rtype: :py:class:`RequestsHttpResponse`
diff --git a/linebot/models/responses.py b/linebot/models/responses.py
@@ -43,6 +43,28 @@ def __init__(self, display_name=None, user_id=None, picture_url=None,
         self.status_message = status_message
 
 
+class MemberIds(Base):
+    """MemberIds.
+
+    https://devdocs.line.me/en/#get-group-room-member-ids
+    """
+
+    def __init__(self, member_ids=None, next=None, **kwargs):
+        """__init__ method.
+
+        :param member_ids: List of user IDs of the members in the group or room.
+            Max: 100 user IDs
+        :type member_ids: list[str]
+        :param str next: continuationToken.
+            Only returned when there are more user IDs remaining in memberIds.
+        :param kwargs:
+        """
+        super(MemberIds, self).__init__(**kwargs)
+
+        self.member_ids = member_ids
+        self.next = next
+
+
 class MessageContent(object):
     """MessageContent.
 
@@ -54,7 +76,6 @@ def __init__(self, response):
 
         :param response: HttpResponse object
         :type response: T <= :py:class:`linebot.http_client.HttpResponse`
-        :param kwargs:
         """
         self.response = response
 
diff --git a/tests/api/test_get_member_ids.py b/tests/api/test_get_member_ids.py
@@ -0,0 +1,122 @@
+# -*- 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_group_member_ids(self):
+        responses.add(
+            responses.GET,
+            LineBotApi.DEFAULT_API_ENDPOINT + '/v2/bot/group/group_id/members/ids',
+            json={
+                'memberIds': ['U1', 'U2']
+            },
+            status=200
+        )
+
+        member_ids_response = self.tested.get_group_member_ids('group_id')
+
+        request = responses.calls[0].request
+        self.assertEqual(request.method, 'GET')
+        self.assertEqual(
+            request.url,
+            LineBotApi.DEFAULT_API_ENDPOINT + '/v2/bot/group/group_id/members/ids')
+        self.assertEqual(member_ids_response.member_ids, ['U1', 'U2'])
+        self.assertEqual(member_ids_response.next, None)
+
+    @responses.activate
+    def test_get_group_member_ids_with_start(self):
+        responses.add(
+            responses.GET,
+            LineBotApi.DEFAULT_API_ENDPOINT + '/v2/bot/group/group_id/members/ids',
+            json={
+                'memberIds': ['U1', 'U2'],
+                'next': 'continuationToken2'
+            },
+            status=200
+        )
+
+        member_ids_response = self.tested.get_group_member_ids('group_id',
+                                                               start='continuationToken1')
+
+        request = responses.calls[0].request
+        self.assertEqual(request.method, 'GET')
+        self.assertEqual(
+            request.url,
+            LineBotApi.DEFAULT_API_ENDPOINT +
+            '/v2/bot/group/group_id/members/ids?start=continuationToken1')
+        self.assertEqual(member_ids_response.member_ids, ['U1', 'U2'])
+        self.assertEqual(member_ids_response.next, 'continuationToken2')
+
+    @responses.activate
+    def test_get_room_member_ids(self):
+        responses.add(
+            responses.GET,
+            LineBotApi.DEFAULT_API_ENDPOINT + '/v2/bot/room/room_id/members/ids',
+            json={
+                'memberIds': ['U1', 'U2']
+            },
+            status=200
+        )
+
+        member_ids_response = self.tested.get_room_member_ids('room_id')
+
+        request = responses.calls[0].request
+        self.assertEqual(request.method, 'GET')
+        self.assertEqual(
+            request.url,
+            LineBotApi.DEFAULT_API_ENDPOINT + '/v2/bot/room/room_id/members/ids')
+        self.assertEqual(member_ids_response.member_ids, ['U1', 'U2'])
+        self.assertEqual(member_ids_response.next, None)
+
+    @responses.activate
+    def test_get_room_member_ids_with_start(self):
+        responses.add(
+            responses.GET,
+            LineBotApi.DEFAULT_API_ENDPOINT + '/v2/bot/room/room_id/members/ids',
+            json={
+                'memberIds': ['U1', 'U2'],
+                'next': 'continuationToken2'
+            },
+            status=200
+        )
+
+        member_ids_response = self.tested.get_room_member_ids('room_id',
+                                                              start='continuationToken1')
+
+        request = responses.calls[0].request
+        self.assertEqual(request.method, 'GET')
+        self.assertEqual(
+            request.url,
+            LineBotApi.DEFAULT_API_ENDPOINT +
+            '/v2/bot/room/room_id/members/ids?start=continuationToken1')
+        self.assertEqual(member_ids_response.member_ids, ['U1', 'U2'])
+        self.assertEqual(member_ids_response.next, 'continuationToken2')
+
+
+if __name__ == '__main__':
+    unittest.main()
diff --git a/tests/api/test_get_member_profile.py b/tests/api/test_get_member_profile.py
@@ -51,6 +51,30 @@ def test_get_group_member_profile(self):
         self.assertEqual(profile.user_id, 'Uxxxxxxxxxxxxxx...')
         self.assertEqual(profile.picture_url, 'http://obs.line-apps.com/...')
 
+    @responses.activate
+    def test_get_room_member_profile(self):
+        responses.add(
+            responses.GET,
+            LineBotApi.DEFAULT_API_ENDPOINT + '/v2/bot/room/room_id/member/user_id',
+            json={
+                "displayName": "LINE taro",
+                "userId": "Uxxxxxxxxxxxxxx...",
+                "pictureUrl": "http://obs.line-apps.com/..."
+            },
+            status=200
+        )
+
+        profile = self.tested.get_room_member_profile('room_id', 'user_id')
+
+        request = responses.calls[0].request
+        self.assertEqual(request.method, 'GET')
+        self.assertEqual(
+            request.url,
+            LineBotApi.DEFAULT_API_ENDPOINT + '/v2/bot/room/room_id/member/user_id')
+        self.assertEqual(profile.display_name, 'LINE taro')
+        self.assertEqual(profile.user_id, 'Uxxxxxxxxxxxxxx...')
+        self.assertEqual(profile.picture_url, 'http://obs.line-apps.com/...')
+
 
 if __name__ == '__main__':
     unittest.main()
diff --git a/tests/api/test_get_profile.py b/tests/api/test_get_profile.py
@@ -17,6 +17,7 @@
 import unittest
 
 import responses
+
 from linebot import (
     LineBotApi
 )
diff --git a/tests/api/test_get_room_member_profile.py b/tests/api/test_get_room_member_profile.py

Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,7 @@`
`17`	`17`	`import unittest`
`18`	`18`
`19`	`19`	`import responses`
	`20`	`+`
`20`	`21`	`from linebot import (`
`21`	`22`	`LineBotApi`
`22`	`23`	`)`