Fix #690 by adding basic auth handling in the new sync client

Author: seratch

integration_tests/samples/issues/issue_690.py

@@ -0,0 +1,44 @@
+# ------------------
+# Only for running this script here
+import logging
+import sys
+from os.path import dirname
+
+sys.path.insert(1, f"{dirname(__file__)}/../../..")
+logging.basicConfig(level=logging.DEBUG)
+# ------------------
+
+# ---------------------
+# Flask App
+# ---------------------
+
+import os
+
+# pip install flask
+from flask import Flask, make_response, request
+
+app = Flask(__name__)
+logger = logging.getLogger(__name__)
+
+
+@app.route("/slack/oauth/callback", methods=["GET"])
+def endpoint():
+    code = request.args.get("code")
+    try:
+        from slack import WebClient
+        from slack.errors import SlackApiError
+        client = WebClient(token="")
+        client_id = os.environ["SLACK_CLIENT_ID"]
+        client_secret = os.environ["SLACK_CLIENT_SECRET"]
+        response = client.oauth_v2_access(client_id=client_id, client_secret=client_secret, code=code)
+        result = response.get("error", "success!")
+        return str(result)
+    except SlackApiError as e:
+        return make_response(str(e), 400)
+
+
+if __name__ == "__main__":
+    # export SLACK_CLIENT_ID=111.222
+    # export SLACK_CLIENT_SECRET=
+    # FLASK_ENV=development python integration_tests/samples/issues/issue_690.py
+    app.run(debug=True, host="localhost", port=3000)

slack/web/base_client.py

@@ -304,6 +304,19 @@ def _sync_send(self, api_url, req_args):
         _json = req_args["json"] if "json" in req_args else None
         headers = req_args["headers"] if "headers" in req_args else None
         token = params.get("token") if params and "token" in params else None
+        auth = (
+            req_args["auth"] if "auth" in req_args else None
+        )  # Basic Auth for oauth.v2.access / oauth.access
+        if auth is not None:
+            if isinstance(auth, BasicAuth):
+                headers["Authorization"] = auth.encode()
+            elif isinstance(auth, str):
+                headers["Authorization"] = auth
+            else:
+                self._logger.warning(
+                    f"As the auth: {auth}: {type(auth)} is unsupported, skipped"
+                )
+
         body_params = {}
         if params:
             body_params.update(params)

tests/web/mock_web_api_server.py

@@ -45,6 +45,16 @@ def set_common_headers(self):
 
     def _handle(self):
         try:
+            if self.path in {"/oauth.access", "/oauth.v2.access"}:
+                self.send_response(200)
+                self.set_common_headers()
+                if self.headers["authorization"] == "Basic MTExLjIyMjpzZWNyZXQ=":
+                    self.wfile.write("""{"ok":true}""".encode("utf-8"))
+                    return
+                else:
+                    self.wfile.write("""{"ok":false, "error":"invalid"}""".encode("utf-8"))
+                    return
+
             if self.is_valid_token() and self.is_valid_user_agent():
                 parsed_path = urlparse(self.path)
 

tests/web/test_web_client.py

@@ -147,3 +147,33 @@ async def test_issue_560_bool_in_params_async(self):
         await self.async_client.conversations_list(exclude_archived=1)  # ok
         await self.async_client.conversations_list(exclude_archived="true")  # ok
         await self.async_client.conversations_list(exclude_archived=True)  # TypeError
+
+    def test_issue_690_oauth_v2_access(self):
+        self.client.token = ""
+        resp = self.client.oauth_v2_access(client_id="111.222", client_secret="secret", code="codeeeeeeeeee")
+        self.assertIsNone(resp["error"])
+        with self.assertRaises(err.SlackApiError):
+            self.client.oauth_v2_access(client_id="999.999", client_secret="secret", code="codeeeeeeeeee")
+
+    @async_test
+    async def test_issue_690_oauth_v2_access_async(self):
+        self.async_client.token = ""
+        resp = await self.async_client.oauth_v2_access(client_id="111.222", client_secret="secret", code="codeeeeeeeeee")
+        self.assertIsNone(resp["error"])
+        with self.assertRaises(err.SlackApiError):
+            await self.async_client.oauth_v2_access(client_id="999.999", client_secret="secret", code="codeeeeeeeeee")
+
+    def test_issue_690_oauth_access(self):
+        self.client.token = ""
+        resp = self.client.oauth_access(client_id="111.222", client_secret="secret", code="codeeeeeeeeee")
+        self.assertIsNone(resp["error"])
+        with self.assertRaises(err.SlackApiError):
+            self.client.oauth_access(client_id="999.999", client_secret="secret", code="codeeeeeeeeee")
+
+    @async_test
+    async def test_issue_690_oauth_access_async(self):
+        self.async_client.token = ""
+        resp = await self.async_client.oauth_access(client_id="111.222", client_secret="secret", code="codeeeeeeeeee")
+        self.assertIsNone(resp["error"])
+        with self.assertRaises(err.SlackApiError):
+            await self.async_client.oauth_access(client_id="999.999", client_secret="secret", code="codeeeeeeeeee")