PyPI - django-esi - Versions diffs - 6.0.0__py3-none-any.whl → 7.0.0b1__py3-none-any.whl - Mend

django-esi 6.0.0py3-none-any.whl → 7.0.0b1py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.

This version of django-esi might be problematic. Click here for more details.

Files changed (17) hide show

{django_esi-6.0.0.dist-info → django_esi-7.0.0b1.dist-info}/METADATA +21 -19
{django_esi-6.0.0.dist-info → django_esi-7.0.0b1.dist-info}/RECORD +17 -16
{django_esi-6.0.0.dist-info → django_esi-7.0.0b1.dist-info}/WHEEL +1 -1
esi/__init__.py +3 -3
esi/admin.py +0 -1
esi/apps.py +1 -1
esi/checks.py +23 -0
esi/clients.py +62 -32
esi/decorators.py +2 -1
esi/migrations/0013_squashed_0012_fix_token_type_choices.py +57 -0
esi/models.py +8 -7
esi/tasks.py +29 -2
esi/templates/esi/select_token.html +9 -9
esi/tests/factories.py +1 -1
esi/tests/test_clients.py +122 -98
esi/tests/test_tasks.py +59 -4
{django_esi-6.0.0.dist-info → django_esi-7.0.0b1.dist-info/licenses}/LICENSE +0 -0

{django_esi-6.0.0.dist-info → django_esi-7.0.0b1.dist-info}/METADATA RENAMED Viewed

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: django-esi
-Version: 6.0.0
+Version: 7.0.0b1
 Summary: Django app for accessing the EVE Swagger Interface (ESI).
 Author-email: Alliance Auth <adarnof@gmail.com>
 Requires-Python: >=3.8
@@ -8,8 +8,8 @@ Description-Content-Type: text/markdown
 Classifier: Environment :: Web Environment
 Classifier: Framework :: Django
 Classifier: Framework :: Django :: 4.2
-Classifier: Framework :: Django :: 5.0
 Classifier: Framework :: Django :: 5.1
+Classifier: Framework :: Django :: 5.2
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
 Classifier: Operating System :: OS Independent
@@ -20,12 +20,14 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Internet :: WWW/HTTP
 Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
-Requires-Dist: bravado>=10.6,<11
+License-File: LICENSE
+Requires-Dist: bravado>=10.6,<12
 Requires-Dist: brotli
 Requires-Dist: celery>=4.0.2
-Requires-Dist: django>=4.2,<5.2
+Requires-Dist: django>=4.2,<6
 Requires-Dist: jsonschema<4
 Requires-Dist: python-jose>=3.3
 Requires-Dist: requests>=2.26
@@ -34,7 +36,7 @@ Requires-Dist: tqdm>=4.62.3
 Requires-Dist: myst-parser ; extra == "docs"
 Requires-Dist: sphinx ; extra == "docs"
 Requires-Dist: sphinx-copybutton ; extra == "docs"
-Requires-Dist: sphinx-rtd-theme<3,>=2 ; extra == "docs"
+Requires-Dist: sphinx-rtd-theme>=3,<4 ; extra == "docs"
 Requires-Dist: sphinx-tabs ; extra == "docs"
 Requires-Dist: sphinxcontrib-django ; extra == "docs"
 Requires-Dist: coverage ; extra == "test"
@@ -47,27 +49,27 @@ Project-URL: Tracker, https://gitlab.com/allianceauth/django-esi/-/issues
 Provides-Extra: docs
 Provides-Extra: test
-# django-esi
+# Django-ESI
 Django app for easy access to the EVE Swagger Interface (ESI)
-[![version](https://img.shields.io/pypi/v/django-esi)](https://pypi.org/project/django-esi/)
-[![python](https://img.shields.io/pypi/pyversions/django-esi)](https://pypi.org/project/django-esi/)
-[![django](https://img.shields.io/pypi/djversions/django-esi)](https://pypi.org/project/django-esi/)
-[![license](https://img.shields.io/badge/license-GPLv3-green)](https://pypi.org/project/django-esi/)
-[![pipeline-status](https://gitlab.com/allianceauth/django-esi/badges/master/pipeline.svg)](https://gitlab.com/allianceauth/django-esi/pipelines)
-[![coverage](https://gitlab.com/allianceauth/django-esi/badges/master/coverage.svg)](https://gitlab.com/allianceauth/django-esi/pipelines)
+[![Version](https://img.shields.io/pypi/v/django-esi)](https://pypi.org/project/django-esi/)
+[![Python Versions](https://img.shields.io/pypi/pyversions/django-esi)](https://pypi.org/project/django-esi/)
+[![Django Versions](https://img.shields.io/pypi/djversions/django-esi)](https://pypi.org/project/django-esi/)
+[![License](https://img.shields.io/badge/license-GPLv3-green)](https://pypi.org/project/django-esi/)
+[![Pipeline Status](https://gitlab.com/allianceauth/django-esi/badges/master/pipeline.svg)](https://gitlab.com/allianceauth/django-esi/pipelines)
+[![Coverage](https://gitlab.com/allianceauth/django-esi/badges/master/coverage.svg)](https://gitlab.com/allianceauth/django-esi/pipelines)
 [![Documentation Status](https://readthedocs.org/projects/django-esi/badge/?version=latest)](https://django-esi.readthedocs.io/en/latest/?badge=latest)
 [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
 [![Chat on Discord](https://img.shields.io/discord/399006117012832262.svg)](https://discord.gg/fjnHAmk)
 ## Overview
-Django-esi is a Django app that provides an interface for easy access to the EVE Swagger Interface (ESI), the official API for the game [EVE Online](https://www.eveonline.com/).
+Django-ESI is a Django app that provides an interface for easy access to the EVE Swagger Interface (ESI), the official API for the game [EVE Online](https://www.eveonline.com/).
-It is build upon [Bravado](https://github.com/Yelp/bravado) - a python client library for Swagger 2.0 services.
+It is built upon [Bravado](https://github.com/Yelp/bravado) - a python client library for Swagger 2.0 services.
-Django-esi adds the following main functionalities to a Django site:
+Django-ESI adds the following main functionalities to a Django site:
 - Dynamically generated client for interacting with public and private ESI endpoints
 - Support for adding EVE SSO to authenticate characters and retrieve tokens
@@ -75,8 +77,8 @@ Django-esi adds the following main functionalities to a Django site:
 ## Python Support
-Django-esi follows the Django Python support schedule, The supported version of Python will differ based on the version of Django used.
-<https://docs.djangoproject.com/en/5.0/faq/install/#what-python-version-can-i-use-with-django>
+Django-ESI follows the Django Python support schedule, The supported version of Python will differ based on the version of Django used.
+<https://docs.djangoproject.com/en/5.2/faq/install/#what-python-version-can-i-use-with-django>
 ## History of this app
@@ -84,5 +86,5 @@ This app is a fork from [adarnauth-esi](https://gitlab.com/Adarnof/adarnauth-esi
 ## Documentation
-For all details on how to install and use django-esi please see the [documentation](https://django-esi.readthedocs.io/en/latest/).
+For all details on how to install and use Django-ESI please see the [Documentation](https://django-esi.readthedocs.io/en/latest/).

{django_esi-6.0.0.dist-info → django_esi-7.0.0b1.dist-info}/RECORD RENAMED Viewed

@@ -1,14 +1,14 @@
-esi/__init__.py,sha256=NtkIRztRvZcWgRF9JOeRXIdygDh6Yy5at20njzh1b5g,113
-esi/admin.py,sha256=Cr9cMMS9WA64-OqVcw-jpes1hTnMnqrhK9eyfz6QwC4,1111
+esi/__init__.py,sha256=H-zKZVSyUvnk6nsG5H5S1P1GjtLAitPB2NqcBd1oHoM,169
+esi/admin.py,sha256=glkzGf8Z76mEd6BGpsMC0B5LLH5--MWlfOCEkSBL7mI,1110
 esi/app_settings.py,sha256=O8TkKonK2zdF7RjMem1vMhEMulAtjvksxKgchrI8jME,3783
-esi/apps.py,sha256=RXDeRh62DO8NcKEzpiQovOay9wmb7MoVyC1W-cc-Aqc,272
-esi/checks.py,sha256=o3ka-Ux3QqTaf0u-oFGCPxwuG7DNJ3XYXiC7_2rQ1Ic,1154
-esi/clients.py,sha256=gkkJVZ9xqcd0TOI-5VduqYLaave1LjI16ucckr3UX9o,21303
-esi/decorators.py,sha256=USqGaIrVoyMpKlUB_ddZPe7QK0fBrFqAnoZDj8MMlSI,8081
+esi/apps.py,sha256=HIu1niTkOXYmCzMVAjYcaFhHrrXeBbHvui6I44OCHXw,280
+esi/checks.py,sha256=Aa3qiEK86w-dhJ4_OfepUxxxjiySMdR-e2fFKGYA9ss,1912
+esi/clients.py,sha256=hQ8LMfqMh5DnwomatIzCWaDeDOP76-9M6glFLZbNrDE,23529
+esi/decorators.py,sha256=HEaOHv-stiyU-AL4nv24kRNzUbN5TMvT282WA6ZC8pY,8128
 esi/errors.py,sha256=KfFtgX8Mys4uMoQtco0n_pQeaM83yVrRSyW6StXuUjo,308
 esi/managers.py,sha256=0g3J2jgoX-BviisjDEEAypkTayVBY-G2I_ZuskTDUqg,11350
-esi/models.py,sha256=fJJu8rLDMGW3ChxwFAZtFBWKB7PgMuDBatTuT06gWiA,11412
-esi/tasks.py,sha256=6wOqlANbQ83uvOt0L4_QHaLz0YZe1jtrQyr7zmxKY6g,1516
+esi/models.py,sha256=bc8DtvX4cTgLK92O-mgNGXtHIyT_TbH3eefVDGoS8O8,11507
+esi/tasks.py,sha256=AdX30ADt1OK6alTmVW014aDlDs7GEkTYGpQdx2cYQBY,2659
 esi/urls.py,sha256=23dY6ciekJ5wfwzo5LzLp0LFvWudrEAGICpDrscTeD8,152
 esi/views.py,sha256=ytfCILjz1rzITGgAGPyCY9bkFpE3KUfnii2UpHu6Bmc,3916
 esi/locale/de/LC_MESSAGES/django.mo,sha256=9_Fc_R8oZpT_CojH8gBxdSqj2K84EMEMn4wkvmOr7Dg,820
@@ -43,33 +43,34 @@ esi/migrations/0009_set_old_tokens_to_sso_v1.py,sha256=8NqOauSw3_bU12MKyHEJOXe2u
 esi/migrations/0010_set_new_tokens_to_sso_v2.py,sha256=d0YlpAWE6rQm7FQ9h39fF7eJTuOIgBLIouPKF7hj0gU,421
 esi/migrations/0011_add_token_indices.py,sha256=xPvfdIUJ3ewc4zv-7oWRe2nWBL9k5VI74C5sVvQJDD8,1016
 esi/migrations/0012_fix_token_type_choices.py,sha256=QyQs8pi5KqDtHUsbA7w7nH-AGda3GPvyUQs74RXEiGY,525
+esi/migrations/0013_squashed_0012_fix_token_type_choices.py,sha256=eZnYDNevow9XrqlYEtSeGQy_PYDbxHU-GS_oRumGlrA,3951
 esi/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 esi/static/esi/img/EVE_SSO_Login_Buttons_Large_Black.png,sha256=XjjhXr6EIum1ZsmXPXFOMDdYcezbkoAFmDjwC7fpi6E,2308
 esi/static/esi/img/EVE_SSO_Login_Buttons_Large_White.png,sha256=FUsOnYwHvYTiLZN5dN-_nPgOfLfZmmuFpVLbpcnOXE8,2248
 esi/static/esi/img/EVE_SSO_Login_Buttons_Small_Black.png,sha256=l-YlGVyegcTrfMRhdxDLorRAlkz5xMKiRR5LYvjEZYE,1622
 esi/static/esi/img/EVE_SSO_Login_Buttons_Small_White.png,sha256=al3NRjIngZtrNzExqBqPFDI4d7oSRp6LSdT3p5o9GOU,1546
-esi/templates/esi/select_token.html,sha256=v8F-tRFLe6y4rszysQUskbED1rdXlgqB4zhI95HVbc4,6905
+esi/templates/esi/select_token.html,sha256=iBdVN0EYuha9CIWG2FgbTbyhJR_HcurDjt3NZy2xQxg,6941
 esi/templatetags/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 esi/templatetags/scope_tags.py,sha256=5-7vEwe-B91xo7oSnn-tSuudHSJCoGIhbddDpNrqUnw,167
 esi/tests/__init__.py,sha256=1ymL-74_4alt8AQNs7cFiXO5MmQKlIeOcA4OPOdAitM,3092
 esi/tests/client_authed_pilot.py,sha256=GN0J59TcscHM9HZH6OaPODM9Zel3mvObjJ4Dmmzc2j8,1622
 esi/tests/client_public_pilot.py,sha256=u6P-qbdYSvQ6A_MJqt8Jrkswt-u-FlvYDKtCvA5-PMo,1252
-esi/tests/factories.py,sha256=6I5Z9CKBtP26MwUwWEE8vSh_HFCvKGIGO-BLPoJeo7g,1368
+esi/tests/factories.py,sha256=2pjkSYKDfO50bzX1nNcUHz_FAAJs7k07u7R8om6AlP0,1375
 esi/tests/factories_2.py,sha256=25NqVe9zzHkl4U1EN3R7pjdN2ahIBXxrrJhQzZhvw58,1972
 esi/tests/jwt_factory.py,sha256=1Ilg99V7Nc_jtUFrYVNm6GfnJ2f5ev0vhpnDhRur8zo,4944
 esi/tests/test_checks.py,sha256=ntq2ijuJ-6pxGruNh21rM4GlXDLVm-o3sy8DrFbjwEM,1846
-esi/tests/test_clients.py,sha256=eaB0DniNrpaQiAQGokLMmcwWYq0H1iswz3fdKvuf3E4,36037
+esi/tests/test_clients.py,sha256=1JWTBV83nZbt82e37DAnJ7h4gm9m_xU1ZDvEjt0sHsc,41363
 esi/tests/test_decorators.py,sha256=I5MhcLKhN5xD4PxgEQqOWQ2kiXquDqQIEve9dbTOsho,15069
 esi/tests/test_management_command.py,sha256=mtxfBtG6CHP1bTy1tJEO-djX4SQwMT3T_mqGnUIM6qs,9863
 esi/tests/test_managers.py,sha256=CEpjXSXyVY6xxgrs0f9FnEh-KY9JPaKjKYiutXLLShE,24309
 esi/tests/test_models.py,sha256=lDj5IcYgXHeOFTHXTsWGg13CSooFaxD0c51kJn_ytAc,13748
 esi/tests/test_swagger.json,sha256=HOrPgbvwm5N521QNcE3baWcZJkSjmuN_VWrR06wEQoo,17241
 esi/tests/test_swagger_full.json,sha256=JCEAZNMFhkdZhquTx4lDhrqGgCrzzzlYU64HdbEv8E4,2548369
-esi/tests/test_tasks.py,sha256=P3vtqSno92DywNYu38nIo-_UiSicRAbun1AAsav0EBo,2104
+esi/tests/test_tasks.py,sha256=nIvfXax_8nQCxNQeT-4TJ84i0__t1qWe155z5rnsktQ,4399
 esi/tests/test_templatetags.py,sha256=b68JWE3HvOlr2aUisJHsTsDS4e7IMjDeqTuzMqC7Re4,517
 esi/tests/test_views.py,sha256=Kj_f2yIpmPG0kx-lAX_sfkaHlIpgbkm02ieA1V3o-k4,13073
 esi/tests/threading_pilot.py,sha256=ax_dEdnTNibA-UQHqbZle_2dh_3jcHKRyrYSOKuE_6U,1931
-django_esi-6.0.0.dist-info/LICENSE,sha256=WJ7YI-moTFb-uVrFjnzzhGJrnL9P2iqQe8NuED3hutI,35141
-django_esi-6.0.0.dist-info/WHEEL,sha256=EZbGkh7Ie4PoZfRQ8I0ZuP9VklN_TvcZ6DSE5Uar4z4,81
-django_esi-6.0.0.dist-info/METADATA,sha256=0WMNumAVhCwNIO4tWXLmV3RU6ovU1VHRKmbhTlfOGhk,4656
-django_esi-6.0.0.dist-info/RECORD,,
+django_esi-7.0.0b1.dist-info/licenses/LICENSE,sha256=WJ7YI-moTFb-uVrFjnzzhGJrnL9P2iqQe8NuED3hutI,35141
+django_esi-7.0.0b1.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
+django_esi-7.0.0b1.dist-info/METADATA,sha256=9gZR6sDOlFinhRO_9WFmuFJpiHpPsPM94u54rPY1l5U,4747
+django_esi-7.0.0b1.dist-info/RECORD,,

{django_esi-6.0.0.dist-info → django_esi-7.0.0b1.dist-info}/WHEEL RENAMED Viewed

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: flit 3.9.0
+Generator: flit 3.12.0
 Root-Is-Purelib: true
 Tag: py3-none-any

esi/__init__.py CHANGED Viewed

@@ -1,5 +1,5 @@
 """Django app for accessing the EVE Swagger Interface (ESI)."""
-__version__ = '6.0.0'
-__title__ = 'django-esi'
+__version__ = '7.0.0b1'
+__title__ = 'Django-ESI'
+__url__ = 'https://gitlab.com/allianceauth/django-esi'

esi/admin.py CHANGED Viewed

@@ -23,7 +23,6 @@ class TokenAdmin(admin.ModelAdmin):
     def get_scopes(self, obj):
         return ", ".join([x.name for x in obj.scopes.all()])
     User = get_user_model()
     list_display = ('user', 'character_name', 'get_scopes')
     search_fields = ['user__%s' % User.USERNAME_FIELD, 'character_name', 'scopes__name']

esi/apps.py CHANGED Viewed

@@ -6,6 +6,6 @@ class EsiConfig(AppConfig):
     name = 'esi'
     verbose_name = 'EVE Swagger Interface (SSO v2)'
-    def ready(self):
+    def ready(self) -> None:
         super().ready()
         from esi import checks  # noqa

esi/checks.py CHANGED Viewed

@@ -4,7 +4,9 @@ from django.conf import settings
 @register(Tags.security)
 def check_sso_application_settings(*args, **kwargs):
     errors = []
     if (
         not hasattr(settings, "ESI_SSO_CLIENT_ID")
         or not hasattr(settings, "ESI_SSO_CLIENT_SECRET")
@@ -30,4 +32,25 @@ def check_sso_application_settings(*args, **kwargs):
                     id='esi.E001'
                 )
             )
+    # Check for ESI_USER_CONTACT_EMAIL
+    if hasattr(settings, "ESI_USER_CONTACT_EMAIL"):
+        # Check if ESI_USER_CONTACT_EMAIL is empty
+        if settings.ESI_USER_CONTACT_EMAIL == "":
+            errors.append(
+                Error(
+                    msg="'ESI_USER_CONTACT_EMAIL' is empty. A valid email is required as maintainer contact for CCP.",
+                    hint="",
+                    id="esi.E002",
+                )
+            )
+    # ESI_USER_CONTACT_EMAIL not found
+    else:
+        errors.append(
+            Error(
+                msg="No 'ESI_USER_CONTACT_EMAIL' found is settings. A valid email is required as maintainer contact for CCP.",
+                hint="",
+                id="esi.E003",
+            )
+        )
     return errors

esi/clients.py CHANGED Viewed

@@ -5,6 +5,7 @@ import logging
 from time import sleep
 from urllib import parse as urlparse
 from typing import Any, Union, Tuple
+import warnings
 from bravado.client import SwaggerClient
 from bravado import requests_client
@@ -20,7 +21,7 @@ from requests.adapters import HTTPAdapter
 from django.core.cache import cache
 from .errors import TokenExpiredError
-from . import app_settings, __version__, __title__
+from . import app_settings, __version__, __title__, __url__
 logger = logging.getLogger(__name__)
@@ -438,13 +439,9 @@ def read_spec(path, http_client=None):
 def esi_client_factory(
-    token=None,
-    datasource: str = None,
-    spec_file: str = None,
-    version: str = None,
-    app_info_text: str = None,
-    **kwargs
-) -> SwaggerClient:
+        token=None, datasource: str = None, spec_file: str = None, version: str = None,
+        app_info_text: str = None,  # Deprecate in favour of the following variables
+        ua_appname: str = None, ua_version: str = None, ua_url: str = None, **kwargs) -> SwaggerClient:
     """Generate a new ESI client.
     Args:
@@ -452,10 +449,9 @@ def esi_client_factory(
         datasource: Name of the ESI datasource to access.
         spec_file: Absolute path to a swagger spec file to load.
         version: Base ESI API version. Accepted values are 'legacy', 'latest',
-        app_info_text: Text identifying the application using ESI which will be \
-            included in the User-Agent header. Should contain name and version of the \
-            application using ESI. e.g. `"my-app v1.0.0"`. \
-            Note that spaces are used as delimiter.
+        ua_appname: Name of the App for generating a User-Agent,
+        ua_version: Version of the App for generating a User-Agent,
+        ua_url: (optional) URL To the Source Code or Documentation for generating a User-Agent,
         kwargs: Explicit resource versions to build, in the form Character='v4'. \
             Same values accepted as version.
@@ -466,15 +462,40 @@ def esi_client_factory(
     Returns:
         New ESI client
     """
+    if app_info_text is not None:
+        warnings.warn(
+            "The 'app_info_text' parameter is deprecated and will be removed in a future release. "
+            "Use 'ua_appname', 'ua_version', and `ua_url` to dynamically build a User-Agent instead",
+            DeprecationWarning,
+            stacklevel=2
+        )
+    if ua_appname is None or ua_version is None:
+        warnings.warn(
+            "Applications must define their own 'ua_appname' and 'ua_version' to generate a User-Agent",
+            DeprecationWarning,
+            stacklevel=2
+        )
     if app_settings.ESI_INFO_LOGGING_ENABLED:
         logger.info('Generating an ESI client...')
     client = RequestsClientPlus()
-    user_agent = (
-        str(app_info_text) if app_info_text else f"{__title__} v{__version__}"
-    )
-    if app_settings.ESI_USER_CONTACT_EMAIL:
-        user_agent += f" {app_settings.ESI_USER_CONTACT_EMAIL}"
+    if app_info_text:
+        # app_info_text (email@example) Django-ESI/1.2.3 (+https://gitlab.com/allianceauth/django-esi)
+        # Deprecated
+        user_agent = f"{app_info_text} ({app_settings.ESI_USER_CONTACT_EMAIL}) {__title__}/{__version__} (+{__url__})"
+    elif ua_appname is None or ua_version is None:
+        # Django-ESI/1.2.3 () (email@example; +https://gitlab.com/allianceauth/django-esi)
+        # Deprecated
+        user_agent = f"{__title__}/{__version__} ({app_settings.ESI_USER_CONTACT_EMAIL}; +{__url__})"
+    else:
+        # AppName/1.2.3 (email@example.com) Django-ESI/1.2.3 (+https://gitlab.com/allianceauth/django-esi)
+        # or AppName/1.2.3 (email@example.com; +https://gitlab.com/) Django-ESI/1.2.3 (+https://gitlab.com/allianceauth/django-esi) (+https://gitlab.com/allianceauth/django-esi)
+        # Preferred
+        user_agent = f"{ua_appname}/{ua_version} ({app_settings.ESI_USER_CONTACT_EMAIL}{f'; +{ua_url})' if ua_url else ')'} {__title__}/{__version__} (+{__url__})"
     client.user_agent = user_agent
@@ -535,10 +556,9 @@ class EsiClientProvider:
         datasource: Name of the ESI datasource to access.
         spec_file: Absolute path to a swagger spec file to load.
         version: Base ESI API version. Accepted values are 'legacy', 'latest',
-        app_info_text: Text identifying the application using ESI which will be \
-            included in the User-Agent header. Should contain name and version of \
-            the application using ESI. e.g. `"my-app v1.0.0"`. \
-            Note that spaces are used as delimiter.
+        ua_appname: Name of the App for generating a User-Agent,
+        ua_version: Version of the App for generating a User-Agent,
+        ua_url: (optional) URL To the Source Code or Documentation for generating a User-Agent,
         kwargs: Explicit resource versions to build, in the form Character='v4'. \
             Same values accepted as version.
@@ -550,30 +570,40 @@ class EsiClientProvider:
     _client = None
     def __init__(
-        self,
-        datasource=None,
-        spec_file=None,
-        version=None,
-        app_info_text=None,
-        **kwargs
-    ):
+            self, datasource=None, spec_file=None, version=None,
+            app_info_text=None,  # Deprecate in favour of the following variables
+            ua_appname: str = None, ua_version: str = None, ua_url: str = None, **kwargs) -> None:
         self._datasource = datasource
         self._spec_file = spec_file
         self._version = version
-        self._app_text = app_info_text
+        self._app_text = app_info_text  # Deprecate in favour of the following variables
+        self._ua_appname = ua_appname
+        self._ua_version = ua_version
+        self._ua_url = ua_url
         self._kwargs = kwargs
+        if app_info_text is not None:
+            warnings.warn(
+                "The 'app_info_text' parameter is deprecated and will be removed in a future release. "
+                "Use 'ua_appname', 'ua_version', and `ua_url` to dynamically build a User-Agent instead",
+                DeprecationWarning,
+                stacklevel=2
+            )
     @property
-    def client(self):
+    def client(self) -> SwaggerClient:
         if self._client is None:
             self._client = esi_client_factory(
                 datasource=self._datasource,
                 spec_file=self._spec_file,
                 version=self._version,
-                app_info_text=self._app_text,
+                app_info_text=self._app_text,  # Deprecate in favour of the following variables
+                ua_appname=self._ua_appname,
+                ua_version=self._ua_version,
+                ua_url=self._ua_url,
                 **self._kwargs,
             )
         return self._client
-    def __str__(self):
+    def __str__(self) -> str:
         return 'EsiClientProvider'

esi/decorators.py CHANGED Viewed

@@ -1,5 +1,6 @@
 import logging
 from functools import wraps
+from typing import Union
 from .models import Token, CallbackRedirect
@@ -7,7 +8,7 @@ from .models import Token, CallbackRedirect
 logger = logging.getLogger(__name__)
-def _check_callback(request):
+def _check_callback(request) -> Union[Token, None]:
     # ensure session installed in database
     if not request.session.exists(request.session.session_key):
         logger.debug("Creating new session for %s", request.user)

esi/migrations/0013_squashed_0012_fix_token_type_choices.py ADDED Viewed

@@ -0,0 +1,57 @@
+# Generated by Django 4.2 on 2025-04-04 01:28
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+# Squashmigration imported a RunPython, not needed
+# Manually optimized
+class Migration(migrations.Migration):
+    replaces = [('esi', '0001_initial'), ('esi', '0002_scopes_20161208'), ('esi', '0003_hide_tokens_from_admin_site'), ('esi', '0004_remove_unique_access_token'), ('esi', '0005_remove_token_length_limit'), ('esi', '0006_remove_url_length_limit'), ('esi', '0007_fix_mysql_8_migration'), ('esi', '0008_nullable_refresh_token'), ('esi', '0009_set_old_tokens_to_sso_v1'), ('esi', '0010_set_new_tokens_to_sso_v2'), ('esi', '0011_add_token_indices'), ('esi', '0012_fix_token_type_choices')]
+    initial = True
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+    ]
+    operations = [
+        migrations.CreateModel(
+            name='Scope',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('name', models.CharField(help_text='The official EVE name for the scope.', max_length=100, unique=True)),
+                ('help_text', models.TextField(help_text='The official EVE description of the scope.')),
+            ],
+        ),
+        migrations.CreateModel(
+            name='Token',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('created', models.DateTimeField(auto_now_add=True)),
+                ('access_token', models.TextField(editable=False, help_text='The access token granted by SSO.')),
+                ('refresh_token', models.TextField(editable=False, help_text='A re-usable token to generate new access tokens upon expiry.', null=True)),
+                ('character_id', models.IntegerField(db_index=True, help_text='The ID of the EVE character who authenticated by SSO.')),
+                ('character_name', models.CharField(db_index=True, help_text='The name of the EVE character who authenticated by SSO.', max_length=100)),
+                ('token_type', models.CharField(choices=[('character', 'Character'), ('corporation', 'Corporation')], default='character', help_text='The applicable range of the token.', max_length=100)),
+                ('character_owner_hash', models.CharField(db_index=True, help_text='The unique string identifying this character and its owning EVE account. Changes if the owning account changes.', max_length=254)),
+                ('scopes', models.ManyToManyField(blank=True, help_text='The access scopes granted by this token.', to='esi.scope')),
+                ('user', models.ForeignKey(blank=True, help_text='The user to whom this token belongs.', null=True, on_delete=django.db.models.deletion.CASCADE, to=settings.AUTH_USER_MODEL)),
+                ('sso_version', models.IntegerField(default=2, help_text='EVE SSO Version.')),
+            ],
+        ),
+        migrations.CreateModel(
+            name='CallbackRedirect',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('url', models.TextField(default='/', help_text='The internal URL to redirect this callback towards.')),
+                ('session_key', models.CharField(help_text='Session key identifying the session this redirect was created for.', max_length=254, unique=True)),
+                ('state', models.CharField(help_text='OAuth2 state string representing this session.', max_length=128)),
+                ('created', models.DateTimeField(auto_now_add=True)),
+                ('token', models.ForeignKey(blank=True, help_text='Token generated by a completed code exchange from callback processing.', null=True, on_delete=django.db.models.deletion.CASCADE, to='esi.token')),
+            ],
+        ),
+    ]

esi/models.py CHANGED Viewed

@@ -1,6 +1,7 @@
 import datetime
 import re
 import logging
+from typing import ClassVar
 from bravado.client import SwaggerClient
 from requests.auth import HTTPBasicAuth
@@ -54,7 +55,7 @@ class Scope(models.Model):
         except IndexError:
             return name
-    def __str__(self):
+    def __str__(self) -> str:
         return self.name
@@ -121,16 +122,16 @@ class Token(models.Model):
         default=2
     )
-    objects = TokenManager()
+    objects: ClassVar[TokenManager] = TokenManager()
-    def __str__(self):
+    def __str__(self) -> str:
         try:
             scopes = sorted(s.name for s in self.scopes.all())
         except ValueError:
             scopes = []
         return f'{self.character_name} - {", ".join(scopes)}'
-    def __repr__(self):
+    def __repr__(self) -> str:
         return "<{}(id={}): {}, {}>".format(
             self.__class__.__name__,
             self.pk,
@@ -248,7 +249,7 @@ class Token(models.Model):
             logger.debug("Not a refreshable token.")
             raise NotRefreshableTokenError()
-    def refresh_or_delete(self):
+    def refresh_or_delete(self) -> None:
         """Refresh this token or delete it if it can not be refreshed."""
         try:
             self.refresh()
@@ -345,10 +346,10 @@ class CallbackRedirect(models.Model):
         )
     )
-    def __str__(self):
+    def __str__(self) -> str:
         return f"{self.session_key}: {self.url}"
-    def __repr__(self):
+    def __repr__(self) -> str:
         return "<{}(pk={}): {} to {}>".format(
             self.__class__.__name__, self.pk,
             self.session_key, self.url

esi/tasks.py CHANGED Viewed

@@ -1,5 +1,6 @@
 from datetime import timedelta
 import logging
+from math import ceil
 from celery import shared_task
@@ -26,14 +27,15 @@ def cleanup_callbackredirect(max_age=300):
 @shared_task
-def cleanup_token():
+def cleanup_token() -> None:
     """
-    Delete expired :model:`esi.Token` models.
+    Delete Orphaned Tokens, then refresh or delete expired :model:`esi.Token` models.
     """
     orphaned_tokens = Token.objects.filter(user__isnull=True)
     if orphaned_tokens.exists():
         logger.info("Deleting %d orphaned tokens.", orphaned_tokens.count())
         orphaned_tokens.delete()
     expired_tokens = Token.objects.exclude(user__isnull=True).get_expired()
     if expired_tokens.exists():
         logger.info(
@@ -46,6 +48,31 @@ def cleanup_token():
             refresh_or_delete_token.apply_async(args=[token_pk], priority=8)
+@shared_task
+def cleanup_token_subset(fraction: int = 48) -> None:
+    """
+    Delete Orphaned Tokens, then refresh or delete a subset of expired :model:`esi.Token` models.
+    This task operates on 1/fraction of the oldest tokens and can be called on a more regular schedule
+    """
+    orphaned_tokens = Token.objects.filter(user__isnull=True)
+    if orphaned_tokens.exists():
+        logger.info("Deleting %d orphaned tokens.", orphaned_tokens.count())
+        orphaned_tokens.delete()
+    expired_tokens = Token.objects.exclude(user__isnull=True).get_expired()
+    expired_tokens_subset = expired_tokens.filter(
+        refresh_token__isnull=False
+    ).order_by("created")[:ceil(expired_tokens.count() / fraction)]
+    if expired_tokens.exists():
+        logger.info(
+            f"Triggering bulk refresh of subset/possible {expired_tokens_subset.count()}/{expired_tokens.count()} expired tokens."
+        )
+        for token_pk in expired_tokens_subset.values_list("pk", flat=True):
+            refresh_or_delete_token.apply_async(args=[token_pk], priority=8)
 @shared_task
 def refresh_or_delete_token(token_pk: int):
     token = Token.objects.get(pk=token_pk)

esi/templates/esi/select_token.html CHANGED Viewed

@@ -10,7 +10,7 @@
         <meta name="description" content="">
         <meta name="author" content="">
-        <title>{% trans "ESI Token Selection" %}</title>
+        <title>{% translate "ESI Token Selection" %}</title>
         <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.6.1/css/bootstrap.min.css" integrity="sha512-T584yQ/tdRR5QwOpfvDfVQUidzfgc2339Lc8uBDtcp/wYu80d7jwBgAxbyMh0a9YM9F8N3tdErpFI8iaGx6x5g==" crossorigin="anonymous" referrerpolicy="no-referrer" />
         <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.6.0/jquery.slim.min.js" integrity="sha512-6ORWJX/LrnSjBzwefdNUyLCMTIsGoNP6NftMy2UAm1JBm6PRZCO1d7OHBStWpVFZLO+RerTvqX/Z9mBFfCJZ4A==" crossorigin="anonymous" referrerpolicy="no-referrer"></script>
@@ -41,11 +41,11 @@
     </head>
     <body class="bg-dark">
         <div class="container-fluid mt-5">
-            <h3 class="text-light font-weight-light text-center">{% trans "Select Character" %}</h3><br>
+            <h3 class="text-light font-weight-light text-center">{% translate "Select Character" %}</h3><br>
             <div class="mt-2">
                 <div class="col-lg-10 offset-lg-1 col-md-12" style="padding-left: 0 !important; padding-right: 0 !important;">
                     <div class="card text-white bg-secondary">
-                        <div class="card-header text-center">{% trans "Scopes Requested" %}</div>
+                        <div class="card-header text-center">{% translate "Scopes Requested" %}</div>
                         <div class="card-body align-middle text-center">
                             {% for scope in scopes %}<span class="badge badge-dark">{{ scope|scope_friendly_name }}</span> {% endfor %}
                         </div>
@@ -58,7 +58,7 @@
                     {% if tokens|length > 14 %}
                         <form method="post">
                             <div class="card text-white bg-secondary m-2 sso-card">
-                                <div class="card-header text-center">{% trans "New Character" %}</div>
+                                <div class="card-header text-center">{% translate "New Character" %}</div>
                                 <div class="card-body text-center  d-none d-sm-block">
                                     <input type="image" formmethod="post" class="ra-avatar img-responsive character-image rounded-lg"
                                         src="https://images.evetech.net/characters/1/portrait?size=256">
@@ -68,7 +68,7 @@
                                         <input type="hidden" name="_add" value="True">
                                         <a href="#" type="submit" class="m-1">
                                             <input type="image" name="go" src="{% static 'esi\img\EVE_SSO_Login_Buttons_Small_Black.png'%}"
-                                                alt="{% trans "Add Token" %}">
+                                                alt="{% translate "Add Token" %}">
                                         </a>
                                 </div>
                             </div>
@@ -85,8 +85,8 @@
                                 </div>
                                 <div class="card-footer">
                                         <input type="hidden" name="_token" value="{{ token.pk }}">
-                                        <button class="btn btn-success w-100" type="submit" title="{% trans "Select" %}" formmethod="post">
-                                            {% trans "Select" %}
+                                        <button class="btn btn-success w-100" type="submit" title="{% translate "Select" %}" formmethod="post">
+                                            {% translate "Select" %}
                                         </button>
                                 </div>
                             </div>
@@ -95,7 +95,7 @@
                     <form method="post">
                         {% csrf_token %}
                         <div class="card text-white bg-secondary m-2 sso-card">
-                            <div class="card-header text-center">{% trans "New Character" %}</div>
+                            <div class="card-header text-center">{% translate "New Character" %}</div>
                             <div class="card-body text-center  d-none d-sm-block">
                                 <input type="image" formmethod="post" class="ra-avatar img-responsive character-image rounded-lg"
                                     src="https://images.evetech.net/characters/1/portrait?size=256">
@@ -104,7 +104,7 @@
                                     <input type="hidden" name="_add" value="True">
                                     <a href="#" type="submit" class="m-1">
                                         <input type="image" name="go" src="{% static 'esi\img\EVE_SSO_Login_Buttons_Small_Black.png'%}"
-                                            alt="{% trans "Add Token" %}">
+                                            alt="{% translate "Add Token" %}">
                                     </a>
                             </div>
                         </div>

esi/tests/factories.py CHANGED Viewed

@@ -43,5 +43,5 @@ class BravadoResponseStub:
         self.headers = headers if headers else dict()
         self.raw_bytes = raw_bytes
-    def __str__(self):
+    def __str__(self) -> str:
         return f"{self.status_code} {self.reason}"

esi/tests/test_clients.py CHANGED Viewed

@@ -716,8 +716,8 @@ class TestClientResult2(NoSocketsTestCase):
     def setUpClass(cls) -> None:
         super().setUpClass()
         spec = _load_json_file(SWAGGER_SPEC_PATH_MINIMAL)
-        with patch(MODULE_PATH + ".app_settings.ESI_USER_CONTACT_EMAIL", None), patch(
-            MODULE_PATH + ".__title__", "django-esi"
+        with patch(MODULE_PATH + ".app_settings.ESI_USER_CONTACT_EMAIL", "email@example.com"), patch(
+            MODULE_PATH + ".__title__", "Django-ESI"
         ), patch(MODULE_PATH + ".__version__", "1.0.0"):
             with requests_mock.Mocker() as requests_mocker:
                 requests_mocker.register_uri(
@@ -733,7 +733,7 @@ class TestClientResult2(NoSocketsTestCase):
         # then
         self.assertTrue(requests_mocker.called)
         request = requests_mocker.last_request
-        self.assertEqual(request._request.headers["User-Agent"], "django-esi v1.0.0")
+        self.assertEqual(request._request.headers["User-Agent"], "Django-ESI/1.0.0 (email@example.com; +https://gitlab.com/allianceauth/django-esi)")
     def test_existing_headers(self, requests_mocker):
         # given
@@ -743,7 +743,7 @@ class TestClientResult2(NoSocketsTestCase):
         # then
         self.assertTrue(requests_mocker.called)
         request = requests_mocker.last_request
-        self.assertEqual(request._request.headers["User-Agent"], "django-esi v1.0.0")
+        self.assertEqual(request._request.headers["User-Agent"], "Django-ESI/1.0.0 (email@example.com; +https://gitlab.com/allianceauth/django-esi)")
 class TestRequestsClientPlus(NoSocketsTestCase):
@@ -764,11 +764,11 @@ class TestRequestsClientPlus(NoSocketsTestCase):
             {
                 "method": "GET",
                 "url": "https://esi.evetech.net/v1/status/",
-                "headers": {"From": "dummy@example.com"},
+                "headers": {"From": "email@example.com"},
             }
         )
         self.assertEqual(result.future.request.headers["User-Agent"], "abc")
-        self.assertEqual(result.future.request.headers["From"], "dummy@example.com")
+        self.assertEqual(result.future.request.headers["From"], "email@example.com")
     def test_no_user_agent(self):
         """When no user agent is defined, leave the existing header intact"""
@@ -777,14 +777,14 @@ class TestRequestsClientPlus(NoSocketsTestCase):
             {
                 "method": "GET",
                 "url": "https://esi.evetech.net/v1/status/",
-                "headers": {"From": "dummy@example.com"},
+                "headers": {"From": "email@example.com"},
             }
         )
-        self.assertEqual(result.future.request.headers["From"], "dummy@example.com")
+        self.assertEqual(result.future.request.headers["From"], "email@example.com")
         self.assertNotIn("User-Agent", result.future.request.headers)
-@patch(MODULE_PATH + ".__title__", "django-esi")
+@patch(MODULE_PATH + ".__title__", "Django-ESI")
 @patch(MODULE_PATH + ".__version__", "1.0.0")
 @requests_mock.Mocker()
 class TestEsiClientFactoryAppText(NoSocketsTestCase):
@@ -799,88 +799,81 @@ class TestEsiClientFactoryAppText(NoSocketsTestCase):
         }
     @patch(MODULE_PATH + ".app_settings.ESI_USER_CONTACT_EMAIL", None)
-    def test_defaults(self, requests_mocker):
+    def test_defaults(self, requests_mocker) -> None:
+        # This test is not expected to hit given that ESI_USER_CONTACT_EMAIL must be set
+        # But here it is for completeness
+        requests_mocker.register_uri("GET", url="https://esi.evetech.net/_latest/swagger.json", json=self.spec)
+        requests_mocker.register_uri("GET", url="https://esi.evetech.net/latest/swagger.json", json=self.spec)
+        requests_mocker.register_uri("GET", url="https://esi.evetech.net/v1/status/", json=self.status_response)
+        client = esi_client_factory()
+        # when
+        operation = client.Status.get_status()
+        # then
+        self.assertEqual(operation.future.request.headers["User-Agent"], "Django-ESI/1.0.0 (None; +https://gitlab.com/allianceauth/django-esi)")
+    @patch(MODULE_PATH + ".app_settings.ESI_USER_CONTACT_EMAIL", "email@example.com")
+    def test_defaults_email(self, requests_mocker) -> None:
         # given
-        requests_mocker.register_uri(
-            "GET", url="https://esi.evetech.net/_latest/swagger.json", json=self.spec
-        )
-        requests_mocker.register_uri(
-            "GET", url="https://esi.evetech.net/latest/swagger.json", json=self.spec
-        )
-        requests_mocker.register_uri(
-            "GET", url="https://esi.evetech.net/v1/status/", json=self.status_response
-        )
+        requests_mocker.register_uri("GET", url="https://esi.evetech.net/_latest/swagger.json", json=self.spec)
+        requests_mocker.register_uri("GET", url="https://esi.evetech.net/latest/swagger.json", json=self.spec)
+        requests_mocker.register_uri("GET", url="https://esi.evetech.net/v1/status/", json=self.status_response)
         client = esi_client_factory()
         # when
         operation = client.Status.get_status()
         # then
-        self.assertEqual(
-            operation.future.request.headers["User-Agent"], "django-esi v1.0.0"
-        )
+        self.assertEqual(operation.future.request.headers["User-Agent"], "Django-ESI/1.0.0 (email@example.com; +https://gitlab.com/allianceauth/django-esi)")
     @patch(MODULE_PATH + ".app_settings.ESI_USER_CONTACT_EMAIL", None)
-    def test_app_text(self, requests_mocker):
+    def test_app_text(self, requests_mocker) -> None:
+        # Deprecated
+        # This test is not expected to hit given that ESI_USER_CONTACT_EMAIL must be set
         # given
-        requests_mocker.register_uri(
-            "GET", url="https://esi.evetech.net/_latest/swagger.json", json=self.spec
-        )
-        requests_mocker.register_uri(
-            "GET", url="https://esi.evetech.net/latest/swagger.json", json=self.spec
-        )
-        requests_mocker.register_uri(
-            "GET", url="https://esi.evetech.net/v1/status/", json=self.status_response
-        )
+        requests_mocker.register_uri("GET", url="https://esi.evetech.net/_latest/swagger.json", json=self.spec)
+        requests_mocker.register_uri("GET", url="https://esi.evetech.net/latest/swagger.json", json=self.spec)
+        requests_mocker.register_uri("GET", url="https://esi.evetech.net/v1/status/", json=self.status_response)
         client = esi_client_factory(app_info_text="my-app v1.0.0")
         # when
         operation = client.Status.get_status()
         # then
-        self.assertEqual(
-            operation.future.request.headers["User-Agent"], "my-app v1.0.0"
-        )
+        self.assertEqual(operation.future.request.headers["User-Agent"], "my-app v1.0.0 (None) Django-ESI/1.0.0 (+https://gitlab.com/allianceauth/django-esi)",)
-    @patch(MODULE_PATH + ".app_settings.ESI_USER_CONTACT_EMAIL", "dummy@example.com")
+    @patch(MODULE_PATH + ".app_settings.ESI_USER_CONTACT_EMAIL", "email@example.com")
     def test_app_text_with_email(self, requests_mocker):
+        # Deprecated
         # given
-        requests_mocker.register_uri(
-            "GET", url="https://esi.evetech.net/_latest/swagger.json", json=self.spec
-        )
-        requests_mocker.register_uri(
-            "GET", url="https://esi.evetech.net/latest/swagger.json", json=self.spec
-        )
-        requests_mocker.register_uri(
-            "GET", url="https://esi.evetech.net/v1/status/", json=self.status_response
-        )
+        requests_mocker.register_uri("GET", url="https://esi.evetech.net/_latest/swagger.json", json=self.spec)
+        requests_mocker.register_uri("GET", url="https://esi.evetech.net/latest/swagger.json", json=self.spec)
+        requests_mocker.register_uri("GET", url="https://esi.evetech.net/v1/status/", json=self.status_response)
         client = esi_client_factory(app_info_text="my-app v1.0.0")
         # when
         operation = client.Status.get_status()
         # then
-        self.assertEqual(
-            operation.future.request.headers["User-Agent"],
-            "my-app v1.0.0 dummy@example.com",
-        )
-    @patch(MODULE_PATH + ".app_settings.ESI_USER_CONTACT_EMAIL", "dummy@example.com")
-    def test_defaults_with_email(self, requests_mocker):
-        # given
-        requests_mocker.register_uri(
-            "GET", url="https://esi.evetech.net/_latest/swagger.json", json=self.spec
-        )
-        requests_mocker.register_uri(
-            "GET", url="https://esi.evetech.net/latest/swagger.json", json=self.spec
-        )
-        requests_mocker.register_uri(
-            "GET", url="https://esi.evetech.net/v1/status/", json=self.status_response
-        )
-        client = esi_client_factory()
+        self.assertEqual(operation.future.request.headers["User-Agent"], "my-app v1.0.0 (email@example.com) Django-ESI/1.0.0 (+https://gitlab.com/allianceauth/django-esi)",)
+    @patch(MODULE_PATH + ".app_settings.ESI_USER_CONTACT_EMAIL", "email@example.com")
+    def test_ua_generator(self, requests_mocker):
+        requests_mocker.register_uri("GET", url="https://esi.evetech.net/_latest/swagger.json", json=self.spec)
+        requests_mocker.register_uri("GET", url="https://esi.evetech.net/latest/swagger.json", json=self.spec)
+        requests_mocker.register_uri("GET", url="https://esi.evetech.net/v1/status/", json=self.status_response)
+        client = esi_client_factory(ua_appname="MyApp", ua_version="1.0.0")
         # when
         operation = client.Status.get_status()
         # then
-        self.assertEqual(
-            operation.future.request.headers["User-Agent"],
-            "django-esi v1.0.0 dummy@example.com",
-        )
+        self.assertEqual(operation.future.request.headers["User-Agent"], "MyApp/1.0.0 (email@example.com) Django-ESI/1.0.0 (+https://gitlab.com/allianceauth/django-esi)")
+    @patch(MODULE_PATH + ".app_settings.ESI_USER_CONTACT_EMAIL", "email@example.com")
+    def test_ua_generator_with_url(self, requests_mocker):
+        requests_mocker.register_uri("GET", url="https://esi.evetech.net/_latest/swagger.json", json=self.spec)
+        requests_mocker.register_uri("GET", url="https://esi.evetech.net/latest/swagger.json", json=self.spec)
+        requests_mocker.register_uri("GET", url="https://esi.evetech.net/v1/status/", json=self.status_response)
+        client = esi_client_factory(ua_appname="MyApp", ua_version="1.0.0", ua_url="https://example.com")
+        # when
+        operation = client.Status.get_status()
+        # then
+        self.assertEqual(operation.future.request.headers["User-Agent"], "MyApp/1.0.0 (email@example.com; +https://example.com) Django-ESI/1.0.0 (+https://gitlab.com/allianceauth/django-esi)")
+@patch(MODULE_PATH + ".__title__", "Django-ESI")
+@patch(MODULE_PATH + ".__version__", "1.0.0")
 @requests_mock.Mocker()
 class TestEsiClientProviderAppText(NoSocketsTestCase):
     @classmethod
@@ -893,45 +886,76 @@ class TestEsiClientProviderAppText(NoSocketsTestCase):
             "start_time": "2017-01-02T12:34:56Z",
         }
-    @patch(MODULE_PATH + ".__title__", "django-esi")
-    @patch(MODULE_PATH + ".__version__", "1.0.0")
     @patch(MODULE_PATH + ".app_settings.ESI_USER_CONTACT_EMAIL", None)
-    def test_defaults(self, requests_mocker):
+    def test_defaults(self, requests_mocker) -> None:
+        # This test is not expected to hit given that ESI_USER_CONTACT_EMAIL must be set
+        # But here it is for completeness
+        requests_mocker.register_uri("GET", url="https://esi.evetech.net/_latest/swagger.json", json=self.spec)
+        requests_mocker.register_uri("GET", url="https://esi.evetech.net/latest/swagger.json", json=self.spec)
+        requests_mocker.register_uri("GET", url="https://esi.evetech.net/v1/status/", json=self.status_response)
+        client = EsiClientProvider().client
+        # when
+        operation = client.Status.get_status()
+        # then
+        self.assertEqual(operation.future.request.headers["User-Agent"], "Django-ESI/1.0.0 (None; +https://gitlab.com/allianceauth/django-esi)")
+    @patch(MODULE_PATH + ".app_settings.ESI_USER_CONTACT_EMAIL", "email@example.com")
+    def test_defaults_email(self, requests_mocker) -> None:
         # given
-        requests_mocker.register_uri(
-            "GET", url="https://esi.evetech.net/_latest/swagger.json", json=self.spec
-        )
-        requests_mocker.register_uri(
-            "GET", url="https://esi.evetech.net/latest/swagger.json", json=self.spec
-        )
-        requests_mocker.register_uri(
-            "GET", url="https://esi.evetech.net/v1/status/", json=self.status_response
-        )
+        requests_mocker.register_uri("GET", url="https://esi.evetech.net/_latest/swagger.json", json=self.spec)
+        requests_mocker.register_uri("GET", url="https://esi.evetech.net/latest/swagger.json", json=self.spec)
+        requests_mocker.register_uri("GET", url="https://esi.evetech.net/v1/status/", json=self.status_response)
         client = EsiClientProvider().client
-        # whem
+        # when
         operation = client.Status.get_status()
         # then
-        self.assertEqual(
-            operation.future.request.headers["User-Agent"], "django-esi v1.0.0"
-        )
+        self.assertEqual(operation.future.request.headers["User-Agent"], "Django-ESI/1.0.0 (email@example.com; +https://gitlab.com/allianceauth/django-esi)")
-    @patch(MODULE_PATH + ".app_settings.ESI_USER_CONTACT_EMAIL", "dummy@example.com")
+    @patch(MODULE_PATH + ".app_settings.ESI_USER_CONTACT_EMAIL", None)
+    def test_app_text(self, requests_mocker) -> None:
+        # Deprecated
+        # This test is not expected to hit given that ESI_USER_CONTACT_EMAIL must be set
+        # given
+        requests_mocker.register_uri("GET", url="https://esi.evetech.net/_latest/swagger.json", json=self.spec)
+        requests_mocker.register_uri("GET", url="https://esi.evetech.net/latest/swagger.json", json=self.spec)
+        requests_mocker.register_uri("GET", url="https://esi.evetech.net/v1/status/", json=self.status_response)
+        client = EsiClientProvider(app_info_text="my-app v1.0.0").client
+        # when
+        operation = client.Status.get_status()
+        # then
+        self.assertEqual(operation.future.request.headers["User-Agent"], "my-app v1.0.0 (None) Django-ESI/1.0.0 (+https://gitlab.com/allianceauth/django-esi)",)
+    @patch(MODULE_PATH + ".app_settings.ESI_USER_CONTACT_EMAIL", "email@example.com")
     def test_app_text_with_email(self, requests_mocker):
+        # Deprecated
         # given
-        requests_mocker.register_uri(
-            "GET", url="https://esi.evetech.net/_latest/swagger.json", json=self.spec
-        )
-        requests_mocker.register_uri(
-            "GET", url="https://esi.evetech.net/latest/swagger.json", json=self.spec
-        )
-        requests_mocker.register_uri(
-            "GET", url="https://esi.evetech.net/v1/status/", json=self.status_response
-        )
+        requests_mocker.register_uri("GET", url="https://esi.evetech.net/_latest/swagger.json", json=self.spec)
+        requests_mocker.register_uri("GET", url="https://esi.evetech.net/latest/swagger.json", json=self.spec)
+        requests_mocker.register_uri("GET", url="https://esi.evetech.net/v1/status/", json=self.status_response)
         client = EsiClientProvider(app_info_text="my-app v1.0.0").client
         # when
         operation = client.Status.get_status()
         # then
-        self.assertEqual(
-            operation.future.request.headers["User-Agent"],
-            "my-app v1.0.0 dummy@example.com",
-        )
+        self.assertEqual(operation.future.request.headers["User-Agent"], "my-app v1.0.0 (email@example.com) Django-ESI/1.0.0 (+https://gitlab.com/allianceauth/django-esi)",)
+    @patch(MODULE_PATH + ".app_settings.ESI_USER_CONTACT_EMAIL", "email@example.com")
+    def test_ua_generator(self, requests_mocker):
+        requests_mocker.register_uri("GET", url="https://esi.evetech.net/_latest/swagger.json", json=self.spec)
+        requests_mocker.register_uri("GET", url="https://esi.evetech.net/latest/swagger.json", json=self.spec)
+        requests_mocker.register_uri("GET", url="https://esi.evetech.net/v1/status/", json=self.status_response)
+        client = EsiClientProvider(ua_appname="MyApp", ua_version="1.0.0").client
+        # when
+        operation = client.Status.get_status()
+        # then
+        self.assertEqual(operation.future.request.headers["User-Agent"], "MyApp/1.0.0 (email@example.com) Django-ESI/1.0.0 (+https://gitlab.com/allianceauth/django-esi)")
+    @patch(MODULE_PATH + ".app_settings.ESI_USER_CONTACT_EMAIL", "email@example.com")
+    def test_ua_generator_with_url(self, requests_mocker):
+        requests_mocker.register_uri("GET", url="https://esi.evetech.net/_latest/swagger.json", json=self.spec)
+        requests_mocker.register_uri("GET", url="https://esi.evetech.net/latest/swagger.json", json=self.spec)
+        requests_mocker.register_uri("GET", url="https://esi.evetech.net/v1/status/", json=self.status_response)
+        client = EsiClientProvider(ua_appname="MyApp", ua_version="1.0.0", ua_url="https://example.com").client
+        # when
+        operation = client.Status.get_status()
+        # then
+        self.assertEqual(operation.future.request.headers["User-Agent"], "MyApp/1.0.0 (email@example.com; +https://example.com) Django-ESI/1.0.0 (+https://gitlab.com/allianceauth/django-esi)")

esi/tests/test_tasks.py CHANGED Viewed

@@ -5,13 +5,16 @@ from celery import current_app as celery_app
 from django.utils.timezone import now
 from esi.models import CallbackRedirect, Token
-from esi.tasks import cleanup_callbackredirect, cleanup_token
+from esi.tasks import cleanup_callbackredirect, cleanup_token, cleanup_token_subset
 from . import NoSocketsTestCase
 from .factories_2 import TokenFactory, CallbackRedirectFactory
+from math import ceil
 MANAGERS_PATH = "esi.managers"
 MODELS_PATH = "esi.models"
+TASKS_PATH = "esi.tasks"
 class CeleryTestCase(NoSocketsTestCase):
@@ -23,7 +26,7 @@ class CeleryTestCase(NoSocketsTestCase):
 class TestCleanupCallbackredirect(CeleryTestCase):
-    def test_should_remove_expired(self):
+    def test_should_remove_expired(self) -> None:
         # given
         cb_valid = CallbackRedirectFactory()
         with patch("django.utils.timezone.now") as m:
@@ -39,7 +42,7 @@ class TestCleanupCallbackredirect(CeleryTestCase):
 @patch(MANAGERS_PATH + '.app_settings.ESI_TOKEN_VALID_DURATION', 120)
 @patch(MODELS_PATH + '.Token.refresh', spec=True)
 class TestCleanupToken(CeleryTestCase):
-    def test_should_delete_orphaned_tokens(self, mock_token_refresh):
+    def test_should_delete_orphaned_tokens(self, mock_token_refresh) -> None:
         # given
         token_1 = TokenFactory(user=None)
         token_2 = TokenFactory()
@@ -49,7 +52,7 @@ class TestCleanupToken(CeleryTestCase):
         self.assertFalse(Token.objects.filter(pk=token_1.pk).exists())
         self.assertTrue(Token.objects.filter(pk=token_2.pk).exists())
-    def test_should_refresh_expired_tokens_only(self, mock_token_refresh):
+    def test_should_refresh_expired_tokens_only(self, mock_token_refresh) -> None:
         # given
         TokenFactory()
         with patch("django.utils.timezone.now") as m:
@@ -59,3 +62,55 @@ class TestCleanupToken(CeleryTestCase):
         cleanup_token.delay()
         # then
         self.assertEqual(mock_token_refresh.call_count, 1)
+class TestCleanupTokenSubset(CeleryTestCase):
+    @patch(MANAGERS_PATH + '.app_settings.ESI_TOKEN_VALID_DURATION', 120)
+    @patch(TASKS_PATH + ".refresh_or_delete_token.apply_async")
+    def test_should_delete_orphaned_tokens(self, mock_token_refresh) -> None:
+        # given
+        orphaned = TokenFactory(user=None)
+        valid = TokenFactory()
+        # when
+        cleanup_token_subset.delay()
+        # then
+        self.assertFalse(Token.objects.filter(pk=orphaned.pk).exists())
+        self.assertTrue(Token.objects.filter(pk=valid.pk).exists())
+    @patch(MANAGERS_PATH + '.app_settings.ESI_TOKEN_VALID_DURATION', 1)
+    @patch(TASKS_PATH + ".refresh_or_delete_token.apply_async")
+    def test_should_refresh_fraction_of_expired_tokens(self, mock_token_refresh) -> None:
+        # given
+        num_expired = 100
+        for _ in range(num_expired):
+            TokenFactory(refresh_token="some_token")
+        # patch time so all tokens are expired
+        with patch("django.utils.timezone.now") as m:
+            m.return_value = now() + timedelta(minutes=5)
+            # when
+            cleanup_token_subset.delay(fraction=10)
+        # then
+        expected_count = ceil(num_expired / 10)
+        self.assertEqual(mock_token_refresh.call_count, expected_count)
+    @patch(MANAGERS_PATH + '.app_settings.ESI_TOKEN_VALID_DURATION', 1)
+    @patch("esi.tasks.refresh_or_delete_token.apply_async")
+    def test_should_refresh_expired_tokens_only(self, mock_token_refresh) -> None:
+        # given
+        TokenFactory()
+        with patch("django.utils.timezone.now") as m:
+            m.return_value = now() - timedelta(minutes=3)
+            TokenFactory()
+        # when
+        cleanup_token_subset.delay()
+        # then
+        self.assertEqual(mock_token_refresh.call_count, 1)
+    @patch(MANAGERS_PATH + '.app_settings.ESI_TOKEN_VALID_DURATION', 1)
+    @patch(TASKS_PATH + ".refresh_or_delete_token.apply_async")
+    def test_should_log_and_exit_gracefully_with_no_tokens(self, mock_token_refresh) -> None:
+        # when
+        cleanup_token_subset.delay()
+        # then
+        self.assertEqual(Token.objects.count(), 0)
+        mock_token_refresh.assert_not_called()

{django_esi-6.0.0.dist-info → django_esi-7.0.0b1.dist-info/licenses}/LICENSE RENAMED Viewed

File without changes

django-esi 6.0.0__py3-none-any.whl → 7.0.0b1__py3-none-any.whl

Potentially problematic release.

django-esi 6.0.0py3-none-any.whl → 7.0.0b1py3-none-any.whl