feat: friend related APIs (#206)

* feat(friend): friend

* feat(friend): friend

* feat(friend): friend

* feat(friend): friend

* feat(friend): friend

* feat(friend): friend

Author: DeeChael

khl/__init__.py

@@ -14,6 +14,7 @@
     BadgeTypes,
     MessageFlagModes,
     GameTypes,
+    FriendTypes
 )
 from .cert import Cert
 from .receiver import Receiver, WebhookReceiver, WebsocketReceiver
@@ -23,7 +24,7 @@
 
 # concepts
 from .role import Role
-from .user import User, GuildUser
+from .user import User, GuildUser, Friend, FriendRequest
 from .intimacy import Intimacy
 from .channel import Channel, PublicTextChannel, PublicVoiceChannel, PrivateChannel, PublicChannel
 from .game import Game

khl/_types.py

@@ -153,3 +153,10 @@ class GameTypes(Enum):
     ALL = '0'
     USER_CREATED = '1'
     SYSTEM_CREATED = '2'
+
+
+class FriendTypes(Enum):
+    """types of friends"""
+    REQUEST = "request"
+    FRIEND = "friend"
+    BLOCKED = "blocked"

khl/api.py

@@ -675,7 +675,7 @@ class Friend:
     def request(
         user_code,
         _from,
-        guild_id,
+        guild_id=None,
     ):
         ...
 
@@ -693,3 +693,17 @@ def delete(
         user_id
     ):
         ...
+
+    @staticmethod
+    @req('POST')
+    def block(
+        user_id
+    ):
+        ...
+
+    @staticmethod
+    @req('POST')
+    def unblock(
+        user_id
+    ):
+        ...

khl/client.py

@@ -14,7 +14,7 @@
 from .interface import AsyncRunnable
 from .message import RawMessage, Message, Event, PublicMessage, PrivateMessage
 from ._types import SoftwareTypes, MessageTypes, SlowModeTypes, GameTypes
-from .user import User
+from .user import User, Friend, FriendRequest
 from .util import unpack_id, unpack_value
 
 log = logging.getLogger(__name__)
@@ -346,5 +346,20 @@ async def fetch_guild_boost(self,
             api.GuildBoost.history(guild_id=unpack_id(guild), start_time=start_time, end_time=end_time), **kwargs)
         return [GuildBoost(**item, _gate_=self.gate) for item in boost_list]
 
+    async def fetch_friends(self) -> List[Friend]:
+        """list friends who have been added to friend list"""
+        friends = (await self.gate.exec_req(api.friend(type='friend')))['friend']
+        return [Friend(_gate_=self.gate, user_id=i['friend_info']['id'], **i) for i in friends]
+
+    async def fetch_friend_requests(self) -> List[FriendRequest]:
+        """list friends requests received"""
+        friends = (await self.gate.exec_req(api.friend(type='request')))['request']
+        return [FriendRequest(_gate_=self.gate, user_id=i['friend_info']['id'], **i) for i in friends]
+
+    async def fetch_blocked_friends(self) -> List[Friend]:
+        """list friends who are blocked"""
+        friends = (await self.gate.exec_req(api.friend(type='blocked')))['blocked']
+        return [Friend(_gate_=self.gate, user_id=i['friend_info']['id'], **i) for i in friends]
+
     async def start(self):
         await asyncio.gather(self.handle_pkg(), self.gate.run(self._pkg_queue))

khl/user.py

@@ -2,11 +2,11 @@
 from typing import List, Union
 
 from . import api
+from ._types import MessageTypes, FriendTypes
 from .gateway import Requestable, Gateway
 from .interface import LazyLoadable
 from .intimacy import Intimacy
 from .role import Role
-from ._types import MessageTypes
 
 
 class User(LazyLoadable, Requestable):
@@ -85,6 +85,14 @@ async def update_intimacy(self, score: int = 0, social_info: str = None, img_id:
             params['img_id'] = img_id
         return await self.gate.exec_req(api.Intimacy.update(**params))
 
+    async def add_friend(self):
+        """send friend request to the user"""
+        await self.gate.exec_req(api.Friend.request(user_code=f'{self.username}#{self.identify_num}', _from=0))
+
+    async def block(self):
+        """block the user"""
+        await self.gate.exec_req(api.Friend.block(user_id=self.id))
+
 
 class GuildUser(User):
     """a user in guild
@@ -127,3 +135,69 @@ async def set_nickname(self, nickname: str):
         Set user's nickname
         """
         await self.gate.exec_req(api.Guild.nickname(guild_id=self.guild_id, nickname=nickname, user_id=self.id))
+
+    async def add_friend(self):
+        await self.gate.exec_req(
+            api.Friend.request(user_code=f'{self.username}#{self.identify_num}', _from=2, guild_id=self.guild_id))
+
+
+class Friend:
+    """
+    Friend with specific friend id and friend info
+    """
+
+    gate: Gateway
+
+    id: int
+    user_id: str
+
+    _user: User
+    _type: FriendTypes
+
+    def __init__(self, _gate_: Gateway, **kwargs):
+        self.gate = _gate_
+        self.id = kwargs.get('id')
+        self.user_id = kwargs.get('user_id')
+        self._type = kwargs.get('type')
+
+    async def fetch_user(self) -> User:
+        """get user"""
+        if self._user is None:
+            self._user = User(_gate_=self.gate, **(await self.gate.exec_req(api.User.view(user_id=self.user_id))))
+        return self._user
+
+    async def delete(self):
+        """delete the friend"""
+        await self.gate.exec_req(api.Friend.delete(user_id=self.user_id))
+
+    async def block(self):
+        """block the user"""
+        await self.gate.exec_req(api.Friend.block(user_id=self.user_id))
+
+    async def unblock(self):
+        """unblock the blocked user"""
+        await self.gate.exec_req(api.Friend.unblock(user_id=self.user_id))
+
+    @property
+    def type(self) -> FriendTypes:
+        """the type of the friend"""
+        return self._type
+
+
+class FriendRequest(Friend):
+    """
+    Friend request with specific id and user info
+    """
+
+    async def accept(self):
+        """accept the friend request"""
+        await self.gate.exec_req(api.Friend.handleRequest(id=self.id, accept=1))
+        return Friend(_gate_=self.gate, user_id=self.user_id)
+
+    async def deny(self):
+        """deny the friend request"""
+        await self.gate.exec_req(api.Friend.handleRequest(id=self.id, accept=0))
+
+    @property
+    def type(self) -> FriendTypes:
+        return FriendTypes.REQUEST