feat: third party app support in EVADB (#1033)

This PR introduces a generic interface to support 3rd party apps in
EVADB. As an example. the template for integrating slack has been added.
In a subsequent PR the integration with slack will be completed.

---------

Co-authored-by: Gaurav Tarlok Kakkar <gaurav21776@gmail.com>
Co-authored-by: Joy Arulraj <jjamesaj@gmail.com>
Co-authored-by: Joy Arulraj <arulraj@gatech.edu>
Co-authored-by: Kaushik Ravichandran <kravicha3@ada-01.cc.gatech.edu>

evadb/third_party/databases/interface.py

@@ -48,6 +48,8 @@ def _get_database_handler(engine: str, **kwargs):
         return mod.SnowFlakeDbHandler(engine, **kwargs)
     elif engine == "github":
         return mod.GithubHandler(engine, **kwargs)
+    elif engine == "slack":
+        return mod.SlackHandler(engine, **kwargs)
     else:
         raise NotImplementedError(f"Engine {engine} is not supported")
 

evadb/third_party/databases/slack/__init__.py

@@ -0,0 +1,15 @@
+# coding=utf-8
+# Copyright 2018-2023 EvaDB
+#
+# 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
+#
+#     http://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.
+"""third party/applications/slack"""

evadb/third_party/databases/slack/slack_handler.py

@@ -0,0 +1,129 @@
+# coding=utf-8
+# Copyright 2018-2023 EvaDB
+#
+# 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
+#
+#     http://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.
+
+import pandas as pd
+from slack_sdk import WebClient
+from slack_sdk.errors import SlackApiError
+
+from evadb.third_party.types import DBHandler, DBHandlerResponse, DBHandlerStatus
+
+
+class SlackHandler(DBHandler):
+    def __init__(self, name: str, **kwargs):
+        super().__init__(name)
+        self.token = kwargs.get("token")
+        self.channel_name = kwargs.get("channel")
+
+    def connect(self):
+        try:
+            self.client = WebClient(token=self.token)
+            return DBHandlerStatus(status=True)
+        except Exception as e:
+            return DBHandlerStatus(status=False, error=str(e))
+
+    def disconnect(self):
+        """
+        TODO: integrate code for disconnecting from slack
+        """
+        raise NotImplementedError()
+
+    def check_connection(self) -> DBHandlerStatus:
+        try:
+            self.client.api_test()
+        except SlackApiError as e:
+            assert e.response["ok"] is False
+            return False
+        return True
+
+    def get_tables(self) -> DBHandlerResponse:
+        if self.client:
+            channels = self.client.conversations_list(
+                types="public_channel,private_channel"
+            )["channels"]
+            self.channel_names = [c["name"] for c in channels]
+            tables_df = pd.DataFrame(self.channel_names, columns=["table_name"])
+            return DBHandlerResponse(data=tables_df)
+
+    def get_columns(self, table_name: str) -> DBHandlerResponse:
+        columns = [
+            "ts",
+            "text",
+            "message_created_at",
+            "user",
+            "channel",
+            "reactions",
+            "attachments",
+            "thread_ts",
+            "reply_count",
+            "reply_users_count",
+            "latest_reply",
+            "subtype",
+            "hidden",
+        ]
+        columns_df = pd.DataFrame(columns, columns=["column_name"])
+        return DBHandlerResponse(data=columns_df)
+
+    def post_message(self, message) -> DBHandlerResponse:
+        try:
+            response = self.client.chat_postMessage(channel=self.channel, text=message)
+            return DBHandlerResponse(data=response["message"]["text"])
+        except SlackApiError as e:
+            assert e.response["ok"] is False
+            assert e.response["error"]
+            return DBHandlerResponse(data=None, error=e.response["error"])
+
+    def _convert_json_response_to_DataFrame(self, json_response):
+        messages = json_response["messages"]
+        columns = ["text", "ts", "user"]
+        data_df = pd.DataFrame(columns=columns)
+        for message in messages:
+            if message["text"] and message["ts"] and message["user"]:
+                data_df.loc[len(data_df.index)] = [
+                    message["text"],
+                    message["ts"],
+                    message["user"],
+                ]
+        return data_df
+
+    def get_messages(self) -> DBHandlerResponse:
+        try:
+            channels = self.client.conversations_list(
+                types="public_channel,private_channel"
+            )["channels"]
+            channel_ids = {c["name"]: c["id"] for c in channels}
+            response = self.client.conversations_history(
+                channel=channel_ids[self.channel_name]
+            )
+            data_df = self._convert_json_response_to_DataFrame(response)
+            return data_df
+
+        except SlackApiError as e:
+            assert e.response["ok"] is False
+            assert e.response["error"]
+            return DBHandlerResponse(data=None, error=e.response["error"])
+
+    def del_message(self, timestamp) -> DBHandlerResponse:
+        try:
+            self.client.chat_delete(channel=self.channel, ts=timestamp)
+        except SlackApiError as e:
+            assert e.response["ok"] is False
+            assert e.response["error"]
+            return DBHandlerResponse(data=None, error=e.response["error"])
+
+    def execute_native_query(self, query_string: str) -> DBHandlerResponse:
+        """
+        TODO: integrate code for executing query on slack
+        """
+        raise NotImplementedError()