Create Slack Client from Integration (#5)

meierj-wayscript · web-flow · commit 7fe7bc25ab00 · 2021-08-17T08:23:17.000-04:00
* Fix up linting errors

* Add slack_sdk

* Fix typo in test script

* Add workspace integration detail route

* Mount local to build directory

* Test get_client_for_workspace_integration

* Add error for missing credentials

* Add slack integration

* Fix linting

* Credentials come as a str
diff --git a/Pipfile b/Pipfile
@@ -4,6 +4,7 @@ verify_ssl = true
 name = "pypi"
 
 [packages]
+slack-sdk = "*"
 
 [dev-packages]
 pytest = "*"
diff --git a/Pipfile.lock b/Pipfile.lock
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -3,9 +3,8 @@ services:
   app:
     build:
       context: .
-    working_dir: /opt/project
     volumes:
-      - .:/opt/project
+      - .:/usr/local/src/project
     environment:
       - TWINE_USERNAME=__token__
       - TWINE_NON_INTERACTIVE=1
diff --git a/files/usr/local/bin/test b/files/usr/local/bin/test
@@ -3,5 +3,5 @@
 set -e
 set -x
 
-pipe install -e .
+pip install -e .
 pytest
diff --git a/src/wayscript/context.py b/src/wayscript/context.py
@@ -1,4 +1,3 @@
-import os
 from functools import lru_cache
 
 from . import utils
diff --git a/src/wayscript/errors.py b/src/wayscript/errors.py
@@ -0,0 +1,7 @@
+"""
+WayScript Errors
+"""
+
+class MissingCredentialsError(Exception):
+    """Error thrown when a workspace integration does not have requisite credentials"""
+    pass
diff --git a/src/wayscript/integrations/__init__.py b/src/wayscript/integrations/__init__.py
diff --git a/src/wayscript/integrations/slack.py b/src/wayscript/integrations/slack.py
@@ -0,0 +1,28 @@
+import json
+
+from slack_sdk import WebClient
+
+from wayscript import utils
+from wayscript.errors import MissingCredentialsError
+
+
+def get_client_for_workspace_integration(_id: str) -> WebClient:
+    """Get a slack client with credentials from a workspace integration"""
+    wayscript_client = utils.WayScriptClient()
+    response = wayscript_client.get_workspace_integration_detail(_id)
+    response.raise_for_status()
+    workspace_integration_data = response.json()
+
+    access_token = None
+    credentials_str = workspace_integration_data["credentials"]
+
+    try:
+        credentials = json.loads(credentials_str)
+        access_token = credentials.get("access_token")
+    except json.decoder.JSONDecodeError:
+        access_token = None
+    
+    if not access_token:
+        raise MissingCredentialsError(f"No credentials found for {_id}")
+    else:
+        return WebClient(access_token)
diff --git a/src/wayscript/settings.py b/src/wayscript/settings.py
@@ -7,12 +7,14 @@
 PROCESSES_ROUTE = "processes"
 LAIRS_ROUTE = "lairs"
 WORKSPACES_ROUTE = "workspaces"
+WORKSPACE_INTEGRATIONS_ROUTE = "workspace-integrations"
 
 
 ROUTES = {
     "lairs": {"detail": f"{LAIRS_ROUTE}/$id"},
     "processes": { "detail_expanded": f"{PROCESSES_ROUTE}/$id/detail"},
     "workspaces": {"detail": f"{WORKSPACES_ROUTE}/$id"},
+    "workspace-integrations": {"detail": f"{WORKSPACE_INTEGRATIONS_ROUTE}/$id"}
 }
 
 # origin is scheme + domain + port. explanation: https://stackoverflow.com/a/37366696/4293004
diff --git a/src/wayscript/utils.py b/src/wayscript/utils.py
@@ -39,6 +39,12 @@ def get_process_detail_expanded(self, _id: str):
         response = self.session.get(url)
         return response
 
+    def get_workspace_integration_detail(self, _id: str):
+        """Request a workspace-integrations detail"""
+        url = self._get_url(subpath="workspace-integrations", route="detail", template_args={"id": _id})
+        response = self.session.get(url)
+        return response
+
     def get_lair_detail(self, _id: str):
         """Request lair detail"""
         url = self._get_url(subpath="lairs", route="detail", template_args={"id": _id})
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -1,3 +1,4 @@
+import json
 import os
 
 import pytest
@@ -16,6 +17,8 @@ def stub_environment():
 
 LAIR_ID = "61429be0-25a0-4030-a824-0e34163e441e"
 WORKSPACE_ID = "fbcb455f-0d49-4fb7-b6d4-44e005a3ca42"
+WORKSPACE_INTEGRATION_ID = "9b3e827e-f113-41fc-a14e-4ba53afa1707"
+ 
 
 @pytest.fixture
 def patch_client_get_url(monkeypatch):
@@ -85,3 +88,16 @@ def workspaces_detail_response():
         "workspace_uuid": WORKSPACE_ID,
     }
     return data
+
+
+@pytest.fixture
+def workspace_integrations_detail_response():
+    """Data from GET /workspaces-integrations/<id>"""
+    data = {
+        "id": WORKSPACE_INTEGRATION_ID,
+        "type": "slack",
+        "credentials": json.dumps({
+            "access_token": "d259c1df-0ef0-4f62-8458-3548bbf5c28d"
+        })
+    }
+    return data
diff --git a/tests/integrations/test_slack.py b/tests/integrations/test_slack.py
@@ -0,0 +1,16 @@
+import responses
+
+from slack_sdk import WebClient
+
+from wayscript.integrations import slack
+
+@responses.activate
+def test_slack_get_client_for_workspace_integration(workspace_integrations_detail_response, patch_client_get_url):
+    """Test that we can retrieve a slack client from an integration"""
+
+    responses.add(responses.GET, patch_client_get_url,
+                  json=workspace_integrations_detail_response, status=200)
+    _id = workspace_integrations_detail_response["id"]
+    client = slack.get_client_for_workspace_integration(_id)
+    assert isinstance(client, WebClient)
+
diff --git a/tests/test_context.py b/tests/test_context.py
@@ -1,9 +1,7 @@
 import pytest
 import responses
-import requests
 
 from wayscript import context as ws_context
-from wayscript import settings as ws_settings
 
 
 @responses.activate
diff --git a/tests/test_utils.py b/tests/test_utils.py

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-import os`
`2`	`1`	`from functools import lru_cache`
`3`	`2`
`4`	`3`	`from . import utils`