diff --git a/CHANGELOG.md b/CHANGELOG.md index 768c77aa..5e59e17b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -35,6 +35,10 @@ Section Order: ### Security --> +### Changed + +- Set user agent according to MDN guidelines + ## [2.5.4] - 2024-12-14 ### Added diff --git a/aasrp/constants.py b/aasrp/constants.py index 43d64931..15f5dc9e 100644 --- a/aasrp/constants.py +++ b/aasrp/constants.py @@ -2,18 +2,24 @@ Constants """ +# Third Party +from requests.__version__ import __version__ as requests_version + # Django -from django.utils.text import slugify from django.utils.translation import gettext_lazy as _ +# Alliance Auth +from esi import __version__ as esi_version + # AA SRP from aasrp import __version__ -VERBOSE_NAME = "AA-SRP - A ship replacement module for Alliance Auth" - -verbose_name_slugified: str = slugify(value=VERBOSE_NAME, allow_unicode=True) -github_url: str = "https://github.com/ppfeufer/aa-srp" -USERAGENT = f"{verbose_name_slugified} v{__version__} {github_url}" +APP_NAME = "aa-srp" +GITHUB_URL = f"https://github.com/ppfeufer/{APP_NAME}" +USER_AGENT_ESI = f"{APP_NAME}/{__version__} +{GITHUB_URL} via django-esi/{esi_version}" +USER_AGENT_REQUESTS = ( + f"{APP_NAME}/{__version__} +{GITHUB_URL} via requests/{requests_version}" +) SRP_REQUEST_NOTIFICATION_INQUIRY_NOTE = _( diff --git a/aasrp/managers.py b/aasrp/managers.py index 32220b39..b508cbc8 100644 --- a/aasrp/managers.py +++ b/aasrp/managers.py @@ -19,7 +19,7 @@ # AA SRP from aasrp import __title__ -from aasrp.constants import KILLBOARD_DATA, USERAGENT +from aasrp.constants import KILLBOARD_DATA, USER_AGENT_REQUESTS from aasrp.providers import esi logger = LoggerAddTag(get_extension_logger(__name__), __title__) @@ -59,7 +59,10 @@ def get_kill_data(kill_id: str): # pylint: disable=too-many-locals zkillboard_api_url = KILLBOARD_DATA["zKillboard"]["api_url"] url = f"{zkillboard_api_url}killID/{kill_id}/" - headers = {"User-Agent": USERAGENT, "Content-Type": "application/json"} + headers = { + "User-Agent": USER_AGENT_REQUESTS, + "Content-Type": "application/json", + } request_result = requests.get(url=url, headers=headers, timeout=5) try: diff --git a/aasrp/providers.py b/aasrp/providers.py index 640de240..b96e52e7 100644 --- a/aasrp/providers.py +++ b/aasrp/providers.py @@ -6,7 +6,7 @@ from esi.clients import EsiClientProvider # AA SRP -from aasrp.constants import USERAGENT +from aasrp.constants import USER_AGENT_ESI # ESI client -esi = EsiClientProvider(app_info_text=USERAGENT) +esi = EsiClientProvider(app_info_text=USER_AGENT_ESI)