Automatic API retry on failure

[iloveitaly]

Enhancement description

Like the Stripe API bindings, it would be great if you could configure network and system retries when intermittent network failures occur or server errors on the todoist side of things.

The problem it solves

Script failing out because of something that isn't the developers fault.

Alternatives

NA

Use case / screenshots

NA

Additional information

[jkawamoto]

If I'm not mistaken, we can use requests’ HTTPAdapter with urllib3’s Retry to retry requests.
For example, this code retries requests ten times if connecting to the server fails or the server returns 500:

from todoist_api_python.api import TodoistAPI
from todoist_api_python.endpoints import BASE_URL
from requests import Session
from requests.adapters import HTTPAdapter, Retry

s = Session()
s.mount(BASE_URL, HTTPAdapter(max_retries=Retry(status_forcelist=[500])))

api = TodoistAPI("my token", s)
try:
    tasks = api.get_tasks()
    print(tasks)
except Exception as error:
    print(error)

This patch also adds a test that checks if the retry works with a mock server.

diff --git a/tests/test_http_requests.py b/tests/test_http_requests.py
index 9cbe87d..33c9da0 100644
--- a/tests/test_http_requests.py
+++ b/tests/test_http_requests.py
@@ -4,6 +4,8 @@ from typing import Any, Dict
 import pytest
 import responses
 from requests import HTTPError, Session
+from requests.adapters import HTTPAdapter, Retry
+from responses.registries import OrderedRegistry
 
 from tests.conftest import DEFAULT_TOKEN
 from todoist_api_python.endpoints import BASE_URL, TASKS_ENDPOINT
@@ -47,6 +49,27 @@ def test_get_raise_for_status():
         get(Session(), DEFAULT_URL, DEFAULT_TOKEN)
 
 
+@responses.activate(registry=OrderedRegistry)
+def test_get_retry(default_task_response: Dict[str, Any]):
+    responses.add(
+        responses.GET,
+        DEFAULT_URL,
+        status=500,
+    )
+    responses.add(
+        responses.GET,
+        DEFAULT_URL,
+        json=default_task_response,
+        status=200,
+    )
+
+    s = Session()
+    s.mount(BASE_URL, HTTPAdapter(max_retries=Retry(status_forcelist=[500])))
+
+    res = get(s, DEFAULT_URL, DEFAULT_TOKEN)
+    assert res == default_task_response
+
+
 @responses.activate
 def test_post_with_data(default_task_response: Dict[str, Any]):
     request_id = "12345"