Merge pull request #39 from stax-labs/feat/user_agent

feat(api) add user data to all api requests

Author: ZXYmania

examples/workloads/create_catalogue_version.py

@@ -43,6 +43,6 @@
 	ManifestBody=manifest_body,
 	Version=catalogue_version,
 	Description='Updating versions via sdk',
-	catalogue_id=catalogue["Id"]
+	catalogue_id=catalogue_id
 )
 print(response)

staxapp/api.py

@@ -1,3 +1,5 @@
+import json
+
 import requests
 
 from staxapp.config import Config
@@ -7,6 +9,20 @@
 class Api:
     _requests_auth = None
 
+    @classmethod
+    def _headers(cls, custom_headers) -> dict:
+        headers = {
+            **custom_headers,
+            "User-Agent": json.dumps(
+                {
+                    "platform": Config.platform,
+                    "python_version": Config.python_version,
+                    "sdk_version": Config.sdk_version,
+                }
+            ),
+        }
+        return headers
+
     @classmethod
     def _auth(cls, **kwargs):
         if not cls._requests_auth:
@@ -27,7 +43,13 @@ def get(cls, url_frag, params={}, **kwargs):
         url_frag = url_frag.replace(f"/{Config.API_VERSION}", "")
         url = f"{Config.api_base_url()}/{url_frag.lstrip('/')}"
 
-        response = requests.get(url, auth=cls._auth(), params=params, **kwargs)
+        response = requests.get(
+            url,
+            auth=cls._auth(),
+            params=params,
+            headers=cls._headers(kwargs.get("headers", {})),
+            **kwargs,
+        )
         cls.handle_api_response(response)
         return response.json()
 
@@ -36,7 +58,13 @@ def post(cls, url_frag, payload={}, **kwargs):
         url_frag = url_frag.replace(f"/{Config.API_VERSION}", "")
         url = f"{Config.api_base_url()}/{url_frag.lstrip('/')}"
 
-        response = requests.post(url, json=payload, auth=cls._auth(), **kwargs)
+        response = requests.post(
+            url,
+            json=payload,
+            auth=cls._auth(),
+            headers=cls._headers(kwargs.get("headers", {})),
+            **kwargs,
+        )
         cls.handle_api_response(response)
         return response.json()
 
@@ -45,7 +73,13 @@ def put(cls, url_frag, payload={}, **kwargs):
         url_frag = url_frag.replace(f"/{Config.API_VERSION}", "")
         url = f"{Config.api_base_url()}/{url_frag.lstrip('/')}"
 
-        response = requests.put(url, json=payload, auth=cls._auth(), **kwargs)
+        response = requests.put(
+            url,
+            json=payload,
+            auth=cls._auth(),
+            headers=cls._headers(kwargs.get("headers", {})),
+            **kwargs,
+        )
         cls.handle_api_response(response)
         return response.json()
 
@@ -54,6 +88,12 @@ def delete(cls, url_frag, params={}, **kwargs):
         url_frag = url_frag.replace(f"/{Config.API_VERSION}", "")
         url = f"{Config.api_base_url()}/{url_frag.lstrip('/')}"
 
-        response = requests.delete(url, auth=cls._auth(), params=params, **kwargs)
+        response = requests.delete(
+            url,
+            auth=cls._auth(),
+            params=params,
+            headers=cls._headers(kwargs.get("headers", {})),
+            **kwargs,
+        )
         cls.handle_api_response(response)
         return response.json()

staxapp/config.py

@@ -1,8 +1,10 @@
 import logging
 import os
+import platform as sysinfo
 
 import requests
 
+import staxapp
 from staxapp.exceptions import ApiException
 
 logging.getLogger().setLevel(logging.DEBUG)
@@ -32,17 +34,21 @@ class Config:
     expiration = None
     load_live_schema = False
 
+    platform = (sysinfo.platform(),)
+    python_version = (sysinfo.python_version(),)
+    sdk_version = (staxapp.__version__,)
+
     @classmethod
     def set_config(cls):
-        cls.base_url = f"https://api.{cls.STAX_REGION}/{cls.API_VERSION}"
+        cls.base_url = f"https://{cls.hostname}/{cls.API_VERSION}"
         config_url = f"{cls.api_base_url()}/public/config"
         config_response = requests.get(config_url)
         try:
             config_response.raise_for_status()
         except requests.exceptions.HTTPError as e:
             logging.error(f"{config_response.status_code}: {config_response.json()}")
             raise ApiException(
-                str(e), config_response, detail="Could not load API config."
+                str(e), config_response, detail=" Could not load API config."
             )
 
         cls.api_config = config_response.json()

staxapp/exceptions.py

@@ -12,7 +12,7 @@ def __init__(self, message, response, detail=""):
             else:
                 logging.error(f"{response.status_code}: {response.json()}")
                 self.message = f"Api Exception:{detail} {message}"
-        except JSONDecodeError:
+        except:
             if response.content:
                 logging.error(f"{response.status_code}: {response.content}")
             else:

staxapp/openapi.py

@@ -5,9 +5,9 @@
 
 from staxapp.api import Api
 from staxapp.auth import ApiTokenAuth
-from staxapp.config import ApiException, Config
+from staxapp.config import Config
 from staxapp.contract import StaxContract
-from staxapp.exceptions import ValidationException
+from staxapp.exceptions import ApiException, ValidationException
 
 
 class StaxClient: