Passing oauth params properly. Returning the entire SlackResponse in …

…SlackApiError's. (#527)

slack/errors.py

@@ -21,7 +21,16 @@ class SlackRequestError(SlackClientError):
 
 
 class SlackApiError(SlackClientError):
-    """Error raised when Slack does not send the expected response."""
+    """Error raised when Slack does not send the expected response.
+
+    Attributes:
+        response (SlackResponse): The SlackResponse object containing all of the data sent back from the API.
+
+    Note:
+        The message (str) passed into the exception is used when
+        a user converts the exception to a str.
+        i.e. str(SlackApiError("This text will be sent as a string."))
+    """
 
     def __init__(self, message, response):
         msg = f"{message}\nThe server responded with: {response}"

slack/web/base_client.py

@@ -13,7 +13,7 @@
 
 # ThirdParty Imports
 import aiohttp
-from aiohttp import FormData
+from aiohttp import FormData, BasicAuth
 
 # Internal Imports
 from slack.web.slack_response import SlackResponse
@@ -104,6 +104,7 @@ def api_call(
         params: dict = None,
         json: dict = None,
         headers: dict = {},
+        auth: dict = None,
     ) -> Union[asyncio.Future, SlackResponse]:
         """Create a request and execute the API call to Slack.
 
@@ -143,6 +144,9 @@ def api_call(
 
         api_url = self._get_url(api_method)
 
+        if auth:
+            auth = BasicAuth(auth["client_id"], auth["client_secret"])
+
         req_args = {
             "headers": self._get_headers(has_json, has_files, headers),
             "data": data,
@@ -151,6 +155,7 @@ def api_call(
             "json": json,
             "ssl": self.ssl,
             "proxy": self.proxy,
+            "auth": auth,
         }
 
         if self._event_loop is None:
@@ -248,7 +253,9 @@ async def _request(self, *, http_verb, api_url, req_args):
                     "status_code": res.status,
                 }
         async with aiohttp.ClientSession(
-            loop=self._event_loop, timeout=aiohttp.ClientTimeout(total=self.timeout)
+            loop=self._event_loop,
+            timeout=aiohttp.ClientTimeout(total=self.timeout),
+            auth=req_args.pop("auth"),
         ) as session:
             async with session.request(http_verb, api_url, **req_args) as res:
                 return {

slack/web/client.py

@@ -1124,8 +1124,12 @@ def oauth_access(
             client_secret (str): Issued when you created your application. e.g. '33fea0113f5b1'
             code (str): The code param returned via the OAuth callback. e.g. 'ccdaa72ad'
         """
-        headers = {"client_id": client_id, "client_secret": client_secret, "code": code}
-        return self.api_call("oauth.access", data=kwargs, headers=headers)
+        kwargs.update({"code": code})
+        return self.api_call(
+            "oauth.access",
+            data=kwargs,
+            auth={"client_id": client_id, "client_secret": client_secret},
+        )
 
     def pins_add(self, *, channel: str, **kwargs) -> Union[Future, SlackResponse]:
         """Pins an item to a channel.

slack/web/slack_response.py

@@ -173,7 +173,7 @@ def validate(self):
             self._logger.debug("Received the following response: %s", self.data)
             return self
         msg = "The request to the Slack API failed."
-        raise e.SlackApiError(message=msg, response=self.data)
+        raise e.SlackApiError(message=msg, response=self)
 
     @staticmethod
     def _next_cursor_is_present(data):

tests/helpers.py

@@ -16,6 +16,7 @@ def fake_req_args(headers=ANY, data=ANY, params=ANY, json=ANY):
         "json": json,
         "ssl": ANY,
         "proxy": ANY,
+        "auth": ANY,
     }
     return req_args
 
@@ -29,6 +30,7 @@ def fake_send_req_args(headers=ANY, data=ANY, params=ANY, json=ANY):
         "ssl": ANY,
         "proxy": ANY,
         "files": ANY,
+        "auth": ANY,
     }
     return req_args
 

tests/web/test_web_client.py

@@ -170,6 +170,17 @@ def test_slack_api_error_is_raised_on_unsuccessful_responses(self, mock_request)
         with self.assertRaises(err.SlackApiError):
             self.client.api_test()
 
+    def test_slack_api_rate_limiting_exception_returns_retry_after(self, mock_request):
+        mock_request.response.side_effect = [
+            {"data": {"ok": False}, "status_code": 429, "headers": {"Retry-After": 30}}
+        ]
+        with self.assertRaises(err.SlackApiError) as context:
+            self.client.api_test()
+        slack_api_error = context.exception
+        self.assertFalse(slack_api_error.response["ok"])
+        self.assertEqual(429, slack_api_error.response.status_code)
+        self.assertEqual(30, slack_api_error.response.headers["Retry-After"])
+
     def test_the_api_call_files_argument_creates_the_expected_data(self, mock_request):
         self.client.token = "xoxa-123"
         with mock.patch("builtins.open", mock.mock_open(read_data="fake")):