Added option to override user agent string (#62)

Author: dacoburn

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "socketdev"
-version = "3.0.24"
+version = "3.0.25"
 requires-python = ">= 3.9"
 dependencies = [
     'requests',

socketdev/__init__.py

@@ -52,7 +52,7 @@
 
 
 class socketdev:
-    def __init__(self, token: Optional[str] = None, timeout: int = 1200, allow_unverified: bool = False):
+    def __init__(self, token: Optional[str] = None, timeout: int = 1200, allow_unverified: bool = False, user_agent: Optional[str] = None):
         # Try to get token from environment variables if not provided
         if token is None:
             token = (
@@ -73,6 +73,8 @@ def __init__(self, token: Optional[str] = None, timeout: int = 1200, allow_unver
         self.api.encode_key(self.token)
         self.api.set_timeout(timeout)
         self.api.set_allow_unverified(allow_unverified)
+        if user_agent is not None:
+            self.api.set_user_agent(user_agent)
 
         self.dependencies = Dependencies(self.api)
         self.export = Export(self.api)

socketdev/core/api.py

@@ -26,6 +26,7 @@ def __init__(self):
         self.api_url = "https://api.socket.dev/v0"
         self.request_timeout = 30
         self.allow_unverified = False
+        self.user_agent = None
 
     def encode_key(self, token: str):
         self.encoded_key = base64.b64encode(token.encode()).decode("ascii")
@@ -36,6 +37,9 @@ def set_timeout(self, timeout: int):
     def set_allow_unverified(self, allow_unverified: bool):
         self.allow_unverified = allow_unverified
 
+    def set_user_agent(self, user_agent: str):
+        self.user_agent = user_agent
+
     def do_request(
         self,
         path: str,
@@ -48,9 +52,10 @@ def do_request(
             raise APIKeyMissing
 
         if headers is None:
+            user_agent_string = self.user_agent if self.user_agent is not None else f"SocketSDKPython/{__version__}"
             headers = {
                 "Authorization": f"Basic {self.encoded_key}",
-                "User-Agent": f"SocketSDKPython/{__version__}",
+                "User-Agent": user_agent_string,
                 "accept": "application/json",
             }
         url = f"{self.api_url}/{path}"

socketdev/version.py

@@ -1 +1 @@
-__version__ = "3.0.24"
+__version__ = "3.0.25"