Update rate limit exception to happen on 429

Author: Thetwam

canvasapi/requester.py

@@ -262,21 +262,19 @@ def request(
             else:
                 raise Unauthorized(response.json())
         elif response.status_code == 403:
-            if b"Rate Limit Exceeded" in response.content:
-                remaining = str(
-                    response.headers.get("X-Rate-Limit-Remaining", "Unknown")
-                )
-                raise RateLimitExceeded(
-                    "Rate Limit Exceeded. X-Rate-Limit-Remaining: {}".format(remaining)
-                )
-            else:
-                raise Forbidden(response.text)
+            raise Forbidden(response.text)
         elif response.status_code == 404:
             raise ResourceDoesNotExist("Not Found")
         elif response.status_code == 409:
             raise Conflict(response.text)
         elif response.status_code == 422:
             raise UnprocessableEntity(response.text)
+        elif response.status_code == 429:
+            raise RateLimitExceeded(
+                "Rate Limit Exceeded. X-Rate-Limit-Remaining: {}".format(
+                    response.headers.get("X-Rate-Limit-Remaining", "Unknown")
+                )
+            )
         elif response.status_code > 400:
             # generic catch-all for error codes
             raise CanvasException(

tests/fixtures/requests.json

@@ -26,25 +26,6 @@
 		"data": {},
 		"status_code": 403
 	},
-	"403_rate_limit": {
-		"method": "ANY",
-		"endpoint": "403_rate_limit",
-		"data": "403 Forbidden (Rate Limit Exceeded)",
-		"headers": {
-			"X-Rate-Limit-Remaining": "3.14159265359",
-			"X-Request-Cost": "1.61803398875"
-		},
-		"status_code": 403
-	},
-	"403_rate_limit_no_remaining_header": {
-		"method": "ANY",
-		"endpoint": "403_rate_limit_no_remaining_header",
-		"data": "403 Forbidden (Rate Limit Exceeded)",
-		"headers": {
-			"X-Request-Cost": "1.61803398875"
-		},
-		"status_code": 403
-	},
 	"404": {
 		"method": "ANY",
 		"endpoint": "404",
@@ -63,6 +44,29 @@
 		"data": {},
 		"status_code": 422
 	},
+	"429_rate_limit": {
+		"method": "ANY",
+		"endpoint": "429_rate_limit",
+		"data": {
+			"error": "Page Views rate limit exceeded. Please wait and try again."
+		},
+		"headers": {
+			"X-Rate-Limit-Remaining": "3.14159265359",
+			"X-Request-Cost": "1.61803398875"
+		},
+		"status_code": 429
+	},
+	"429_rate_limit_no_remaining_header": {
+		"method": "ANY",
+		"endpoint": "429_rate_limit_no_remaining_header",
+		"data": {
+			"error": "Page Views rate limit exceeded. Please wait and try again."
+		},
+		"headers": {
+			"X-Request-Cost": "1.61803398875"
+		},
+		"status_code": 429
+	},
 	"500": {
 		"method": "ANY",
 		"endpoint": "500",
@@ -117,4 +121,4 @@
 		"data": {},
 		"status_code": 200
 	}
-}
+}

tests/test_requester.py

@@ -153,28 +153,6 @@ def test_request_403(self, m):
         with self.assertRaises(Forbidden):
             self.requester.request("GET", "403")
 
-    def test_request_403_RateLimitExeeded(self, m):
-        register_uris({"requests": ["403_rate_limit"]}, m)
-
-        with self.assertRaises(RateLimitExceeded) as exc:
-            self.requester.request("GET", "403_rate_limit")
-
-        self.assertEqual(
-            exc.exception.message,
-            "Rate Limit Exceeded. X-Rate-Limit-Remaining: 3.14159265359",
-        )
-
-    def test_request_403_RateLimitExeeded_no_remaining_header(self, m):
-        register_uris({"requests": ["403_rate_limit_no_remaining_header"]}, m)
-
-        with self.assertRaises(RateLimitExceeded) as exc:
-            self.requester.request("GET", "403_rate_limit_no_remaining_header")
-
-        self.assertEqual(
-            exc.exception.message,
-            "Rate Limit Exceeded. X-Rate-Limit-Remaining: Unknown",
-        )
-
     def test_request_404(self, m):
         register_uris({"requests": ["404"]}, m)
 
@@ -193,6 +171,28 @@ def test_request_422(self, m):
         with self.assertRaises(UnprocessableEntity):
             self.requester.request("GET", "422")
 
+    def test_request_429_RateLimitExeeded(self, m):
+        register_uris({"requests": ["429_rate_limit"]}, m)
+
+        with self.assertRaises(RateLimitExceeded) as exc:
+            self.requester.request("GET", "429_rate_limit")
+
+        self.assertEqual(
+            exc.exception.message,
+            "Rate Limit Exceeded. X-Rate-Limit-Remaining: 3.14159265359",
+        )
+
+    def test_request_429_RateLimitExeeded_no_remaining_header(self, m):
+        register_uris({"requests": ["429_rate_limit_no_remaining_header"]}, m)
+
+        with self.assertRaises(RateLimitExceeded) as exc:
+            self.requester.request("GET", "429_rate_limit_no_remaining_header")
+
+        self.assertEqual(
+            exc.exception.message,
+            "Rate Limit Exceeded. X-Rate-Limit-Remaining: Unknown",
+        )
+
     def test_request_500(self, m):
         register_uris({"requests": ["500"]}, m)