csp-adapter-slack 0.1.0__tar.gz → 0.2.0__tar.gz

{csp_adapter_slack-0.1.0 → csp_adapter_slack-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: csp_adapter_slack
-Version: 0.1.0
+Version: 0.2.0
 Summary: A csp adapter for slack
 Project-URL: Repository, https://github.com/point72/csp-adapter-slack
 Project-URL: Homepage, https://github.com/point72/csp-adapter-slack
@@ -206,7 +206,6 @@ License:                                  Apache License
            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.
-License-File: LICENSE
 Keywords: chat,chatbot,csp,slack,stream-processing
 Classifier: Development Status :: 4 - Beta
 Classifier: Framework :: Jupyter
@@ -218,19 +217,22 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Requires-Python: >=3.8
 Requires-Dist: csp
+Requires-Dist: pydantic>=2
 Requires-Dist: slack-sdk>=3
 Provides-Extra: develop
-Requires-Dist: bump2version>=1.0.0; extra == 'develop'
+Requires-Dist: bump-my-version; extra == 'develop'
 Requires-Dist: check-manifest; extra == 'develop'
-Requires-Dist: codespell<2.3,>=2.2.6; extra == 'develop'
+Requires-Dist: codespell<2.4,>=2.2.6; extra == 'develop'
 Requires-Dist: hatchling; extra == 'develop'
+Requires-Dist: mdformat-tables<1.1,>=1; extra == 'develop'
 Requires-Dist: mdformat<0.8,>=0.7.17; extra == 'develop'
 Requires-Dist: pytest; extra == 'develop'
 Requires-Dist: pytest-cov; extra == 'develop'
-Requires-Dist: ruff<0.6,>=0.5; extra == 'develop'
-Requires-Dist: twine<5.2,>=5; extra == 'develop'
+Requires-Dist: ruff<0.9,>=0.5; extra == 'develop'
+Requires-Dist: twine<7,>=5; extra == 'develop'
 Provides-Extra: test
 Requires-Dist: pytest; extra == 'test'
 Requires-Dist: pytest-cov; extra == 'test'

csp_adapter_slack-0.2.0/csp_adapter_slack/__init__.py

@@ -0,0 +1,4 @@
+__version__ = "0.2.0"
+
+from .adapter import *
+from .adapter_config import *

{csp_adapter_slack-0.1.0 → csp_adapter_slack-0.2.0}/csp_adapter_slack/adapter.py

@@ -1,10 +1,9 @@
 import threading
 from logging import getLogger
 from queue import Queue
-from ssl import SSLContext
 from threading import Thread
 from time import sleep
-from typing import Dict, List, Optional, TypeVar
+from typing import Dict, List, TypeVar
 
 import csp
 from csp.impl.adaptermanager import AdapterManagerImpl
@@ -13,13 +12,14 @@ from csp.impl.pushadapter import PushInputAdapter
 from csp.impl.struct import Struct
 from csp.impl.types.tstype import ts
 from csp.impl.wiring import py_output_adapter_def, py_push_adapter_def
-
 from slack_sdk.errors import SlackApiError
 from slack_sdk.socket_mode import SocketModeClient
 from slack_sdk.socket_mode.request import SocketModeRequest
 from slack_sdk.socket_mode.response import SocketModeResponse
 from slack_sdk.web import WebClient
 
+from .adapter_config import SlackAdapterConfig
+
 T = TypeVar("T")
 log = getLogger(__file__)
 
@@ -49,13 +49,10 @@ def mention_user(userid: str) -> str:
 
 
 class SlackAdapterManager(AdapterManagerImpl):
-    def __init__(self, app_token: str, bot_token: str, ssl: Optional[SSLContext] = None):
-        if not app_token.startswith("xapp-") or not bot_token.startswith("xoxb-"):
-            raise RuntimeError("Slack app token or bot token looks malformed")
-
+    def __init__(self, config: SlackAdapterConfig):
         self._slack_client = SocketModeClient(
-            app_token=app_token,
-            web_client=WebClient(token=bot_token, ssl=ssl),
+            app_token=config.app_token,
+            web_client=WebClient(token=config.bot_token, ssl=config.ssl),
         )
         self._slack_client.socket_mode_request_listeners.append(self._process_slack_message)
 
@@ -121,7 +118,7 @@ class SlackAdapterManager(AdapterManagerImpl):
             if ret.status_code == 200:
                 # TODO OAuth scopes required
                 name = ret.data["user"]["profile"].get("real_name_normalized", ret.data["user"]["name"])
-                email = ret.data["user"]["profile"]["email"]
+                email = ret.data["user"]["profile"].get("email", "")
                 self._user_id_to_user_name[user_id] = name
                 self._user_name_to_user_id[name] = user_id  # TODO is this 1-1 in slack?
                 self._user_id_to_user_email[user_id] = email
@@ -200,14 +197,8 @@ class SlackAdapterManager(AdapterManagerImpl):
             return self._room_name_to_room_id.get(channel_name, None)
         return channel_id
 
-    def _get_tags_from_message(self, blocks, authorizations=None) -> List[str]:
+    def _get_tags_from_message(self, blocks) -> List[str]:
         """extract tags from message, potentially excluding the bot's own @"""
-        authorizations = authorizations or []
-        if len(authorizations) > 0:
-            bot_id = authorizations[0]["user_id"]  # TODO more than one?
-        else:
-            bot_id = ""
-
         tags = []
         to_search = blocks.copy()
 
@@ -219,11 +210,9 @@ class SlackAdapterManager(AdapterManagerImpl):
 
             if element.get("type", "") == "user":
                 tag_id = element.get("user_id")
-                if tag_id != bot_id:
-                    # TODO tag with id or with name?
-                    name, _ = self._get_user_from_id(tag_id)
-                    if name:
-                        tags.append(name)
+                name, _ = self._get_user_from_id(tag_id)
+                if name:
+                    tags.append(name)
         return tags
 
     def _process_slack_message(self, client: SocketModeClient, req: SocketModeRequest):
@@ -236,7 +225,7 @@ class SlackAdapterManager(AdapterManagerImpl):
             if req.payload["event"]["type"] in ("message", "app_mention") and req.payload["event"].get("subtype") is None:
                 user, user_email = self._get_user_from_id(req.payload["event"]["user"])
                 channel, channel_type = self._get_channel_from_id(req.payload["event"]["channel"])
-                tags = self._get_tags_from_message(req.payload["event"]["blocks"], req.payload["authorizations"])
+                tags = self._get_tags_from_message(req.payload["event"]["blocks"])
                 slack_msg = SlackMessage(
                     user=user or "",
                     user_email=user_email or "",

csp_adapter_slack-0.2.0/csp_adapter_slack/adapter_config.py

@@ -0,0 +1,37 @@
+from pathlib import Path
+from ssl import SSLContext
+from typing import Optional
+
+from pydantic import BaseModel, Field, field_validator
+
+__all__ = ("SlackAdapterConfig",)
+
+
+class SlackAdapterConfig(BaseModel):
+    """A config class that holds the required information to interact with Slack."""
+
+    app_token: str = Field(description="The app token for the Slack bot")
+    bot_token: str = Field(description="The bot token for the Slack bot")
+    ssl: Optional[object] = None
+
+    @field_validator("app_token")
+    def validate_app_token(cls, v):
+        if v.startswith("xapp-"):
+            return v
+        elif Path(v).exists():
+            return Path(v).read_text().strip()
+        raise ValueError("App token must start with 'xoxb-' or be a file path")
+
+    @field_validator("bot_token")
+    def validate_bot_token(cls, v):
+        if v.startswith("xoxb-"):
+            return v
+        elif Path(v).exists():
+            return Path(v).read_text().strip()
+        raise ValueError("Bot token must start with 'xoxb-' or be a file path")
+
+    @field_validator("ssl")
+    def validate_ssl(cls, v):
+        # TODO pydantic validation via schema
+        assert v is None or isinstance(v, SSLContext)
+        return v

{csp_adapter_slack-0.1.0 → csp_adapter_slack-0.2.0}/csp_adapter_slack/tests/test_adapter.py

@@ -1,11 +1,13 @@
-import pytest
 from datetime import timedelta
 from ssl import create_default_context
 from unittest.mock import MagicMock, call, patch
 
 import csp
+import pytest
 from csp import ts
-from csp_adapter_slack import SlackAdapterManager, SlackMessage, mention_user
+from pydantic import ValidationError
+
+from csp_adapter_slack import SlackAdapterConfig, SlackAdapterManager, SlackMessage, mention_user
 
 
 @csp.node
@@ -119,8 +121,10 @@ DIRECT_MESSAGE_PAYLOAD = {
 
 class TestSlack:
     def test_slack_tokens(self):
-        with pytest.raises(RuntimeError):
-            SlackAdapterManager("abc", "def")
+        with pytest.raises(ValidationError):
+            SlackAdapterConfig(app_token="abc", bot_token="xoxb-def")
+        with pytest.raises(ValidationError):
+            SlackAdapterConfig(app_token="xapp-abc", bot_token="def")
 
     @pytest.mark.parametrize("payload", (PUBLIC_CHANNEL_MENTION_PAYLOAD, DIRECT_MESSAGE_PAYLOAD))
     def test_slack(self, payload):
@@ -150,7 +154,7 @@ class TestSlack:
             clientmock.return_value.web_client.conversations_list.return_value = mock_list_response
 
             def graph():
-                am = SlackAdapterManager("xapp-1-dummy", "xoxb-dummy", ssl=create_default_context())
+                am = SlackAdapterManager(SlackAdapterConfig(app_token="xapp-1-dummy", bot_token="xoxb-dummy", ssl=create_default_context()))
 
                 # send a fake slack message to the app
                 stop = send_fake_message(clientmock, reqmock, am)

{csp_adapter_slack-0.1.0 → csp_adapter_slack-0.2.0}/pyproject.toml

@@ -1,14 +1,14 @@
 [build-system]
 requires = [
-    "hatchling>=1.22.4,<1.23",
-    "pkginfo>=1.10,<1.11",
+    "hatchling>=1.22.4,<1.27",
+    "pkginfo>=1.10,<1.12",
 ]
 build-backend = "hatchling.build"
 
 [project]
 name = "csp_adapter_slack"
 description = "A csp adapter for slack"
-version = "0.1.0"
+version = "0.2.0"
 readme = "README.md"
 license = { file = "LICENSE" }
 requires-python = ">=3.8"
@@ -30,22 +30,25 @@ classifiers = [
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
     "License :: OSI Approved :: Apache Software License",
 ]
 dependencies = [
     "csp",
+    "pydantic>=2",
     "slack-sdk>=3",
 ]
 
 [project.optional-dependencies]
 develop = [
-    "bump2version>=1.0.0",
+    "bump-my-version",
     "check-manifest",
-    "codespell>=2.2.6,<2.3",
+    "codespell>=2.2.6,<2.4",
     "hatchling",
     "mdformat>=0.7.17,<0.8",
-    "ruff>=0.5,<0.6",
-    "twine>=5,<5.2",
+    "mdformat-tables>=1,<1.1",
+    "ruff>=0.5,<0.9",
+    "twine>=5,<7",
     # test
     "pytest",
     "pytest-cov",
@@ -59,9 +62,38 @@ test = [
 Repository = "https://github.com/point72/csp-adapter-slack"
 Homepage = "https://github.com/point72/csp-adapter-slack"
 
+[tool.bumpversion]
+current_version = "0.2.0"
+commit = true
+tag = false
+commit_args = "-s"
+
+[[tool.bumpversion.files]]
+filename = "csp_adapter_slack/__init__.py"
+search = '__version__ = "{current_version}"'
+replace = '__version__ = "{new_version}"'
+
+[[tool.bumpversion.files]]
+filename = "pyproject.toml"
+search = 'version = "{current_version}"'
+replace = 'version = "{new_version}"'
+
 [tool.check-manifest]
 ignore = []
 
+[tool.coverage.run]
+branch = true
+omit = []
+
+[tool.coverage.report]
+exclude_also = [
+    "raise NotImplementedError",
+    "if __name__ == .__main__.:",
+    "@(abc\\.)?abstractmethod",
+]
+ignore_errors = true
+fail_under = 75
+
 [tool.hatch.build]
 artifacts = []
 
@@ -69,11 +101,7 @@ artifacts = []
 src = "/"
 
 [tool.hatch.build.targets.sdist]
-include = [
-    "/csp_adapter_slack",
-    "LICENSE",
-    "README.md",
-]
+packages = ["csp_adapter_slack"]
 exclude = [
     "/.github",
     "/.gitignore",
@@ -81,9 +109,7 @@ exclude = [
 ]
 
 [tool.hatch.build.targets.wheel]
-include = [
-    "/csp_adapter_slack",
-]
+packages = ["csp_adapter_slack"]
 exclude = [
     "/.github",
     "/.gitignore",
@@ -92,12 +118,16 @@ exclude = [
 ]
 
 [tool.pytest.ini_options]
+addopts = ["-vvv", "--junitxml=junit.xml"]
 asyncio_mode = "strict"
 testpaths = "csp_adapter_slack/tests"
 
 [tool.ruff]
 line-length = 150
 
+[tool.ruff.lint]
+extend-select = ["I"]
+
 [tool.ruff.lint.per-file-ignores]
 "__init__.py" = ["F401", "F403"]
 
@@ -107,7 +137,8 @@ default-section = "third-party"
 known-first-party = ["csp_adapter_slack"]
 section-order = [
     "future",
+    "standard-library",
     "third-party",
     "first-party",
     "local-folder",
-]
+]

csp_adapter_slack-0.1.0/csp_adapter_slack/__init__.py

@@ -1,3 +0,0 @@
-__version__ = "0.1.0"
-
-from .adapter import *