enh: add user agent to request headers (#29)

Author: vegard-solum-4ss

fourinsight/api/authenticate.py

@@ -18,6 +18,8 @@
 from requests.packages.urllib3 import Retry
 from requests_oauthlib import OAuth2Session
 
+import fourinsight.api as fapi
+
 from .appdirs import user_data_dir
 
 log = logging.getLogger(__name__)
@@ -141,6 +143,10 @@ def __init__(self, client, auth_force=False, **kwargs):
         if self.token_updater:
             self.token_updater(token)
 
+        self.headers.update(
+            {"user-agent": f"python-fourinsight-api/{fapi.__version__}"}
+        )
+
     def fetch_token(self):
         """Fetch new access and refresh token."""
         args, kwargs = self._prepare_fetch_token_args()

tests/test_authenticator.py

@@ -5,6 +5,7 @@
 
 import pytest
 
+import fourinsight.api as fapi
 from fourinsight.api import authenticate
 
 _CONSTANTS = authenticate._CONSTANTS
@@ -187,6 +188,9 @@ def test_init(self, mock_fetch, mock_refresh):
             include_client_id=True,
         )
         assert auth.auto_refresh_url == _CONSTANTS["CLIENT_TOKEN_URL"]
+        assert (
+            auth.headers["user-agent"] == f"python-fourinsight-api/{fapi.__version__}"
+        )
 
     def test_refresh_token(self, mock_fetch, mock_refresh):
         auth = authenticate.ClientSession("my_client_id", "my_client_secret")
@@ -244,6 +248,11 @@ def test_init_force_auth(self, mock_token, mock_fetch, mock_refresh):
 
             auth = authenticate.UserSession(auth_force=True)
 
+            assert (
+                auth.headers["user-agent"]
+                == f"python-fourinsight-api/{fapi.__version__}"
+            )
+
             mock_fetch.assert_called_once_with(
                 "my_token_url",
                 code="my_code",