feat: Add extra headers on APIModel (#97)

* feat: Add extra headers APIModel

---------

Co-authored-by: Pascal Zimmermann <[email protected]>

Author: hugoprudente

docs/content/grafana_api/model.md

@@ -85,6 +85,7 @@ The class includes all necessary variables to establish a connection to the Graf
 - `username` _str_ - Specify the username of the Grafana system
 - `password` _str_ - Specify the password of the Grafana system
 - `timeout` _float_ - Specify the timeout of the Grafana system
+- `headers` _dict_ - Specify the headers of the Grafana system
 - `http2_support` _bool_ - Specify if you want to use HTTP/2
 - `ssl_context` _ssl.SSLContext_ - Specify the custom ssl context of the Grafana system
 - `num_pools` _int_ - Specify the number of the connection pool

grafana_api/api.py

@@ -50,7 +50,12 @@ def call_the_api(
         """
 
         api_url: str = f"{self.grafana_api_model.host}{api_call}"
-        headers: dict = dict(
+
+        headers: dict = dict()
+        if self.grafana_api_model.headers is not None:
+            headers: dict = self.grafana_api_model.headers
+
+        headers.update(
             {"Authorization": f"Bearer {self.grafana_api_model.token}"},
         )
 

grafana_api/model.py

@@ -85,6 +85,7 @@ class APIModel:
         username (str): Specify the username of the Grafana system
         password (str): Specify the password of the Grafana system
         timeout (float): Specify the timeout of the Grafana system
+        headers (dict): Specify the headers of the Grafana system
         http2_support (bool): Specify if you want to use HTTP/2
         ssl_context (ssl.SSLContext): Specify the custom ssl context of the Grafana system
         num_pools (int): Specify the number of the connection pool
@@ -95,6 +96,7 @@ class APIModel:
     token: str = None
     username: str = None
     password: str = None
+    headers: dict = None
     timeout: float = 10.0
     http2_support: bool = False
     ssl_context: ssl.SSLContext = httpx.create_ssl_context(http2=http2_support)

tests/unittests/test_api.py

@@ -35,6 +35,24 @@ def test_call_the_api_basic_auth(self, httpx_client_mock):
             api.call_the_api(api_call=MagicMock())["status"],
         )
 
+    @patch("httpx.Client")
+    def test_call_the_api_with_proxy_headers(self, httpx_client_mock):
+        model: APIModel = APIModel(
+            host="https://test.test.de", username="test", password="test",
+            headers=dict({"X-Custom-Header": "custom_value"})
+        )
+        api: Api = Api(grafana_api_model=model)
+
+        httpx_client_mock.return_value.request.return_value.text = '{"status": "success"}'
+
+        self.assertEqual(
+            "success",
+            api.call_the_api(api_call=MagicMock())["status"],
+        )
+
+        httpx_client_mock.assert_called()
+        self.assertEqual(dict({"X-Custom-Header": "custom_value", "Authorization": "Basic dGVzdDp0ZXN0", "Content-Type": "application/json", "Accept": "application/json"}), httpx_client_mock.call_args[1]["headers"])
+
     @patch("httpx.Client")
     def test_call_the_api_org_id(self, httpx_client_mock):
         httpx_client_mock.return_value.request.return_value.text = (