From a994c584398bc8e1e7c25491fb2d3025b75db62f Mon Sep 17 00:00:00 2001
From: LoopThrough-i-j <dganguly1120@gmail.com>
Date: Thu, 4 Mar 2021 01:14:25 +0530
Subject: [PATCH] zulip-bots: Add `BotHandler` Protocol.

- The `BotHandler` Protocol is a mypy Protocol
  s.t. all BotHandlers can use it as a default type.
- Fix ExternalBotHandler and StubBotHandler to
  follow `BotHandler` Protocol

Fixes part of #639
---
 zulip_bots/zulip_bots/lib.py      | 35 +++++++++++++++++++++++++++++--
 zulip_bots/zulip_bots/test_lib.py |  3 ++-
 2 files changed, 35 insertions(+), 3 deletions(-)

diff --git a/zulip_bots/zulip_bots/lib.py b/zulip_bots/zulip_bots/lib.py
index 47696be..e1d70a0 100644
--- a/zulip_bots/zulip_bots/lib.py
+++ b/zulip_bots/zulip_bots/lib.py
@@ -112,6 +112,37 @@ class BotStorage(Protocol):
     def contains(self, key: Text) -> bool:
         ...
 
+class BotHandler(Protocol):
+
+    user_id: int
+    email: str
+    full_name: str
+
+    @property
+    def storage(self) -> BotStorage:
+        ...
+
+    def identity(self) -> BotIdentity:
+        ...
+
+    def react(self, message: Dict[str, Any], emoji_name: str) -> Dict[str, Any]:
+        ...
+
+    def send_message(self, message: Dict[str, Any]) -> Optional[Dict[str, Any]]:
+        ...
+
+    def send_reply(self, message: Dict[str, Any], response: str, widget_content: Optional[str] = None) -> Optional[Dict[str, Any]]:
+        ...
+
+    def update_message(self, message: Dict[str, Any]) -> Optional[Dict[str, Any]]:
+        ...
+
+    def get_config_info(self, bot_name: str, optional: bool = False) -> Dict[str, str]:
+        ...
+
+    def quit(self, message: str = "") -> None:
+        ...
+
 class ExternalBotHandler:
     def __init__(
         self,
@@ -168,7 +199,7 @@ class ExternalBotHandler:
                                               emoji_name=emoji_name,
                                               reaction_type='unicode_emoji'))
 
-    def send_message(self, message: (Dict[str, Any])) -> Dict[str, Any]:
+    def send_message(self, message: Dict[str, Any]) -> Dict[str, Any]:
         if not self._rate_limit.is_legal():
             self._rate_limit.show_error_and_exit()
         resp = self._client.send_message(message)
@@ -198,7 +229,7 @@ class ExternalBotHandler:
             self._rate_limit.show_error_and_exit()
         return self._client.update_message(message)
 
-    def get_config_info(self, bot_name: str, optional: Optional[bool] = False) -> Dict[str, Any]:
+    def get_config_info(self, bot_name: str, optional: bool = False) -> Dict[str, str]:
         if self._bot_config_parser is not None:
             config_parser = self._bot_config_parser
         else:
diff --git a/zulip_bots/zulip_bots/test_lib.py b/zulip_bots/zulip_bots/test_lib.py
index 1708993..395a5c6 100755
--- a/zulip_bots/zulip_bots/test_lib.py
+++ b/zulip_bots/zulip_bots/test_lib.py
@@ -28,6 +28,7 @@ class StubBotHandler:
         self.storage = SimpleStorage()
         self.full_name = 'test-bot'
         self.email = 'test-bot@example.com'
+        self.user_id = 0
         self.message_server = SimpleMessageServer()
         self.reset_transcript()
 
@@ -69,7 +70,7 @@ class StubBotHandler:
     def quit(self, message: str = "") -> None:
         raise self.BotQuitException()
 
-    def get_config_info(self, bot_name: str, optional: bool = False) -> Dict[str, Any]:
+    def get_config_info(self, bot_name: str, optional: bool = False) -> Dict[str, str]:
         return {}
 
     def unique_reply(self) -> Dict[str, Any]: