feat: add useragent to graphql requests with caller info

Author: RobBrazier

libs/graphql/src/graphql/client.py

@@ -1,4 +1,4 @@
-from typing import Union
+from typing import Optional
 from urllib import request, error
 import json
 import logging
@@ -7,14 +7,15 @@
 
 
 class GraphQLClient:
-    def __init__(self, endpoint: str):
+    def __init__(self, endpoint: str, useragent: Optional[str] = None):
         self.endpoint = endpoint
         self.token = None
+        self.useragent = useragent
 
     def set_token(self, token: str):
         self.token = token
 
-    def execute(self, query: str, variables: Union[dict, None] = None, timeout=30):
+    def execute(self, query: str, variables: Optional[dict] = None, timeout=30):
         data = {"query": query, "variables": variables}
         headers = {"Accept": "application/json", "Content-Type": "application/json"}
 
@@ -25,6 +26,8 @@ def execute(self, query: str, variables: Union[dict, None] = None, timeout=30):
             ):  # does it have a 'prefix' like Bearer already there?
                 token = f"Bearer {token}"
             headers["Authorization"] = token
+        if self.useragent:
+            headers["User-Agent"] = self.useragent
 
         body = json.dumps(data).encode("utf-8")
 

plugins/hardcover/src/hardcover/provider.py

@@ -10,6 +10,7 @@
 
 from .identifier import HardcoverIdentifier
 from .models import Book
+from ._version import __version__
 
 
 class HardcoverProvider:
@@ -19,7 +20,8 @@ class HardcoverProvider:
     def __init__(self, source):
         self.source = source
         self.prefs = source.prefs
-        self.client = GraphQLClient(self.API_URL)
+        useragent = f"hardcover-calibre-plugin/{__version__} (https://github.com/RobBrazier/calibre-plugins)"
+        self.client = GraphQLClient(self.API_URL, useragent)
 
     def get_book_url(self, identifiers) -> tuple[str, str, str] | None:
         hardcover_id: str | None = identifiers.get(self.ID_NAME, None)