refactor(toggl): use requests.Session

pre-configure headers

Author: thekaveman

compiler_admin/api/toggl.py

@@ -24,6 +24,8 @@ def __init__(self, api_token: str, workspace_id: int, **kwargs):
         self.headers = dict(Toggl.API_HEADERS)
         self.headers.update(self._authorization_header())
 
+        self.session = requests.Session()
+        self.session.headers.update(self.headers)
         self.timeout = int(kwargs.get("timeout", 5))
 
     @property
@@ -47,7 +49,7 @@ def _make_report_url(self, endpoint: str):
         """
         return "/".join((Toggl.API_BASE_URL, Toggl.API_REPORTS_BASE_URL, self.workspace_url_fragment, endpoint))
 
-    def detailed_time_entries(self, start_date: datetime, end_date: datetime, **kwargs):
+    def detailed_time_entries(self, start_date: datetime, end_date: datetime, **kwargs) -> requests.Response:
         """Request a CSV report from Toggl of detailed time entries for the given date range.
 
         Args:
@@ -104,7 +106,7 @@ def post_reports(self, endpoint: str, **kwargs) -> requests.Response:
         """
         url = self._make_report_url(endpoint)
 
-        response = requests.post(url, json=kwargs, timeout=self.timeout)
+        response = self.session.post(url, json=kwargs, timeout=self.timeout)
         response.raise_for_status()
 
         return response

tests/api/test_toggl.py

@@ -9,7 +9,7 @@
 
 @pytest.fixture
 def mock_requests(mocker):
-    return mocker.patch(f"{MODULE}.requests")
+    return mocker.patch(f"{MODULE}.requests.Session").return_value
 
 
 @pytest.fixture
@@ -63,9 +63,7 @@ def test_toggl_post_reports(mock_requests, toggl):
 
     response.raise_for_status.assert_called_once()
 
-    mock_requests.post.assert_called_once_with(
-        url, json=dict(kwarg1=1, kwarg2="two"), headers=toggl.headers, timeout=toggl.timeout
-    )
+    mock_requests.post.assert_called_once_with(url, json=dict(kwarg1=1, kwarg2="two"), timeout=toggl.timeout)
 
 
 def test_toggl_detailed_time_entries(toggl_mock_post_reports):