Send own User-Agent

bugme.py

@@ -14,13 +14,11 @@
 from typing import Any
 
 from scantags import scan_tags
-from services import get_urltag, Issue
+from services import get_urltag, Issue, VERSION
 from services.guess import guess_service
 from utils import dateit, html_tag
 
 
-VERSION = "2.4.0"
-
 DEFAULT_CREDENTIALS_FILE = os.path.expanduser("~/creds.json")
 
 

gitblame.py

@@ -11,7 +11,7 @@
 import requests
 from requests import RequestException
 
-from services import debugme
+from services import debugme, VERSION
 from utils import utc_date
 
 
@@ -54,6 +54,7 @@ def __init__(self, repo: str, branch: str, access_token: str) -> None:
         self.api_url = "https://api.github.com/graphql"
         self.session = requests.Session()
         self.session.headers["Authorization"] = f"Bearer {access_token}"
+        self.session.headers["User-Agent"] = f"bugme/{VERSION}"
         self.timeout = 30
         if os.getenv("DEBUG"):
             self.session.hooks["response"].append(debugme)

services/__init__.py

@@ -19,6 +19,8 @@
 from requests_toolbelt.utils import dump  # type: ignore
 
 
+VERSION = "2.4.1"
+
 TAG_REGEX = "|".join(
     [
         r"(?:bnc|bsc|boo|poo|lp)#[0-9]+",
@@ -230,6 +232,7 @@ def __init__(self, url: str, token: str | None):
         if token is not None:
             self.session.headers["Authorization"] = f"token {token}"
         self.session.headers["Accept"] = "application/json"
+        self.session.headers["User-Agent"] = f"bugme/{VERSION}"
         if os.getenv("DEBUG"):
             self.session.hooks["response"].append(debugme)
         self.timeout = 10

services/bugzilla.py

@@ -11,7 +11,7 @@
 from requests.exceptions import RequestException
 
 from utils import utc_date
-from . import Service, Issue, debugme, status
+from . import Service, Issue, debugme, status, VERSION
 
 
 # Reference: https://bugzilla.readthedocs.io/en/latest/api/index.html#apis
@@ -31,6 +31,7 @@ def __init__(self, url: str, creds: dict):
             self.client = Bugzilla(self.url, **options)
         except (BugzillaError, RequestException) as exc:
             logging.error("Bugzilla: %s: %s", self.url, exc)
+        self.client._session._session.headers["User-Agent"] = f"bugme/{VERSION}"
         if os.getenv("DEBUG"):
             self.client._session._session.hooks["response"].append(debugme)
 

services/github.py

@@ -10,7 +10,7 @@
 from requests.exceptions import RequestException
 
 from utils import utc_date
-from . import Service, Issue, status
+from . import Service, Issue, status, VERSION
 
 
 # Reference:
@@ -26,7 +26,7 @@ def __init__(self, url: str, creds: dict):
         # auth = Auth.Token(**creds)
         # self.client = Github(auth=auth)
         self.tag = "gh"
-        self.client = Github(**creds)
+        self.client = Github(user_agent=f"bugme/{VERSION}", **creds)
         if os.getenv("DEBUG"):
             logging.getLogger("github").setLevel(logging.DEBUG)
 

services/gitlab.py

@@ -12,7 +12,7 @@
 from requests.exceptions import RequestException
 
 from utils import utc_date
-from . import Service, Issue, debugme, status
+from . import Service, Issue, debugme, status, VERSION
 
 
 # References:
@@ -27,6 +27,7 @@ def __init__(self, url: str, creds: dict):
         super().__init__(url)
         options: dict[str, Any] = {
             "ssl_verify": os.environ.get("REQUESTS_CA_BUNDLE", True),
+            "user_agent": f"bugme/{VERSION}",
         }
         options |= creds
         hostname = str(urlparse(self.url).hostname)

services/guess.py

@@ -9,7 +9,7 @@
 import requests
 from requests.exceptions import RequestException
 
-from . import debugme
+from . import debugme, VERSION
 from .bugzilla import MyBugzilla
 from .gitea import MyGitea
 from .github import MyGithub
@@ -72,6 +72,7 @@ def guess_service2(server: str) -> Any | None:
 
     with requests.Session() as session:
         session.headers["Accept"] = "application/json"
+        session.headers["User-Agent"] = f"bugme/{VERSION}"
         session.verify = os.environ.get("REQUESTS_CA_BUNDLE", True)
         if os.getenv("DEBUG"):
             session.hooks["response"].append(debugme)

services/jira.py

@@ -11,7 +11,7 @@
 from requests.exceptions import RequestException
 
 from utils import utc_date
-from . import Service, Issue, debugme, status
+from . import Service, Issue, debugme, status, VERSION
 
 
 # References:
@@ -24,6 +24,7 @@ class MyJira(Service):
     def __init__(self, url: str, creds: dict):
         super().__init__(url)
         self.client = Jira(url=self.url, **creds)
+        self.client.session.headers["User-Agent"] = f"bugme/{VERSION}"
         if os.getenv("DEBUG"):
             self.client.session.hooks["response"].append(debugme)
 

services/redmine.py

@@ -11,7 +11,7 @@
 from requests.exceptions import RequestException
 
 from utils import utc_date
-from . import Service, Issue, debugme, status
+from . import Service, Issue, debugme, status, VERSION
 
 
 # Reference: https://www.redmine.org/projects/redmine/wiki/Rest_api
@@ -27,6 +27,7 @@ def __init__(self, url: str, creds: dict):
         }
         options |= creds
         self.client = Redmine(url=self.url, **options)
+        self.client.engine.session.headers["User-Agent"] = f"bugme/{VERSION}"
         if os.getenv("DEBUG"):
             self.client.engine.session.hooks["response"].append(debugme)