django-esi 8.0.0a4__py3-none-any.whl → 8.0.0b2__py3-none-any.whl

esi/stubs.pyi

@@ -2100,18 +2100,18 @@ class GetUniverseSchematicsSchematicIdOperation(EsiOperation):
         ...
 
 
-class GetRouteOriginDestinationOperation(EsiOperation):
+class PostRouteOperation(EsiOperation):
     """EsiOperation, use result(), results() or results_localized()"""
-    def result(self, use_etag: bool = True, return_response: bool = False, force_refresh: bool = False, use_cache: bool = True, **extra) -> list[int]:
-        """Get the systems between origin and destination"""
+    def result(self, use_etag: bool = True, return_response: bool = False, force_refresh: bool = False, use_cache: bool = True, **extra) -> Any:
+        """Calculate the systems between the given origin and destination."""
         ...
 
-    def results(self, use_etag: bool = True, return_response: bool = False, force_refresh: bool = False, use_cache: bool = True, **extra) -> list[int]:
-        """Get the systems between origin and destination"""
+    def results(self, use_etag: bool = True, return_response: bool = False, force_refresh: bool = False, use_cache: bool = True, **extra) -> list[Any]:
+        """Calculate the systems between the given origin and destination."""
         ...
 
-    def results_localized(self, languages: list[str] | str | None = None, **extra) -> dict[str, list[int]]:
-        """Get the systems between origin and destination"""
+    def results_localized(self, languages: list[str] | str | None = None, **extra) -> dict[str, list[Any]]:
+        """Calculate the systems between the given origin and destination."""
         ...
 
 
@@ -3581,8 +3581,8 @@ class ESIClientStub:
     Planetary_Interaction: _Planetary_Interaction = _Planetary_Interaction()
 
     class _Routes:
-        def GetRouteOriginDestination(self, destination: int, origin: int, avoid: list[Any] | None = ..., connections: list[Any] | None = ..., flag: str | None = ..., Accept_Language: str | None = ..., If_None_Match: str | None = ..., X_Compatibility_Date: str | None = ..., X_Tenant: str | None = ..., **kwargs: Any) -> GetRouteOriginDestinationOperation:
-            """Get the systems between origin and destination"""
+        def PostRoute(self, body: dict[str, Any], origin_system_id: int, destination_system_id: int, Accept_Language: str | None = ..., If_None_Match: str | None = ..., X_Compatibility_Date: str | None = ..., X_Tenant: str | None = ..., **kwargs: Any) -> PostRouteOperation:
+            """Calculate the systems between the given origin and destination."""
             ...
 
 

esi/tests/__init__.py

@@ -23,10 +23,10 @@ def _generate_token(
     expires_in: int = 1200,
     sso_version: int = 2
 ) -> dict:
-    from datetime import datetime, timedelta
+    import datetime as dt
 
     if timestamp_dt is None:
-        timestamp_dt = datetime.utcnow()
+        timestamp_dt = dt.datetime.now(dt.timezone.utc)
     if scopes is None:
         scopes = [
             'esi-mail.read_mail.v1',
@@ -40,7 +40,7 @@ def _generate_token(
         'timestamp': int(timestamp_dt.timestamp()),
         'character_id': character_id,
         'name': character_name,
-        'ExpiresOn': _dt_eveformat(timestamp_dt + timedelta(seconds=expires_in)),
+        'ExpiresOn': _dt_eveformat(timestamp_dt + dt.timedelta(seconds=expires_in)),
         'scp': scopes,
         'token_type': 'character',
         'owner': character_owner_hash,
@@ -84,6 +84,32 @@ class SocketAccessError(Exception):
     """Error raised when a test script accesses the network"""
 
 
+class GuardedSocket(socket.socket):
+    """A socket subclass that only allows loopback/localhost."""
+
+    def _address_is_loopback(self, address):
+
+        host = None
+        if isinstance(address, tuple):
+            host = address[0]
+        else:
+            host = address
+
+        if isinstance(host, bytes):
+            host = host.decode()
+
+        # quick allow by obvious names
+        if host in ("localhost", "127.0.0.1", "::1"):
+            return True
+        else:
+            return False
+
+    def connect(self, address):
+        if not self._address_is_loopback(address):
+            raise SocketAccessError(f"Attempt to connect to non-localhost address: {address!r}")
+        return super().connect(address)
+
+
 class NoSocketsTestCase(TestCase):
     """Variation of Django's TestCase class that prevents any network use.
 
@@ -98,15 +124,11 @@ class NoSocketsTestCase(TestCase):
     """
     @classmethod
     def setUpClass(cls):
-        cls.socket_original = socket.socket
-        socket.socket = cls.guard
+        cls._socket_original = socket.socket
+        socket.socket = GuardedSocket
         return super().setUpClass()
 
     @classmethod
     def tearDownClass(cls):
-        socket.socket = cls.socket_original
-        return super().tearDownClass()
-
-    @staticmethod
-    def guard(*args, **kwargs):
-        raise SocketAccessError("Attempted to access network")
+        socket.socket = cls._socket_original
+        super().tearDownClass()

esi/tests/test_clients.py

@@ -1,4 +1,4 @@
-from datetime import datetime, timedelta, timezone
+import datetime
 import os
 from unittest.mock import patch, Mock
 import json
@@ -49,7 +49,7 @@ def _load_json_file(path):
 
 class MockResultFuture:
     def __init__(self):
-        dt = datetime.utcnow().replace(tzinfo=timezone.utc) + timedelta(seconds=60)
+        dt = datetime.datetime.now(datetime.timezone.utc) + datetime.timedelta(seconds=60)
         self.headers = {"Expires": dt.strftime("%a, %d %b %Y %H:%M:%S %Z")}
         self.status_code = 200
         self.text = "dummy"
@@ -57,7 +57,7 @@ class MockResultFuture:
 
 class MockResultPast:
     def __init__(self):
-        dt = datetime.utcnow().replace(tzinfo=timezone.utc) - timedelta(seconds=60)
+        dt = datetime.datetime.now(datetime.timezone.utc) - datetime.timedelta(seconds=60)
         self.headers = {"Expires": dt.strftime("%a, %d %b %Y %H:%M:%S %Z")}
 
 
@@ -198,7 +198,7 @@ class TestTokenAuthenticator(NoSocketsTestCase):
         request.headers = dict()
         request.params = dict()
 
-        self.token.created -= timedelta(121)
+        self.token.created -= datetime.timedelta(121)
 
         x = TokenAuthenticator(token=self.token)
         request2 = x.apply(request)
@@ -212,7 +212,7 @@ class TestTokenAuthenticator(NoSocketsTestCase):
         request.headers = dict()
         request.params = dict()
 
-        self.token.created -= timedelta(121)
+        self.token.created -= datetime.timedelta(121)
         self.token.refresh_token = None
 
         x = TokenAuthenticator(token=self.token)
@@ -733,7 +733,10 @@ class TestClientResult2(NoSocketsTestCase):
         # then
         self.assertTrue(requests_mocker.called)
         request = requests_mocker.last_request
-        self.assertEqual(request._request.headers["User-Agent"], "Django-ESI/1.0.0 (email@example.com; +https://gitlab.com/allianceauth/django-esi)")
+
+        expected_title = 'DjangoEsi'
+
+        self.assertEqual(request._request.headers["User-Agent"], f"{expected_title}/1.0.0 (email@example.com; +https://gitlab.com/allianceauth/django-esi)")
 
     def test_existing_headers(self, requests_mocker):
         # given
@@ -743,7 +746,10 @@ class TestClientResult2(NoSocketsTestCase):
         # then
         self.assertTrue(requests_mocker.called)
         request = requests_mocker.last_request
-        self.assertEqual(request._request.headers["User-Agent"], "Django-ESI/1.0.0 (email@example.com; +https://gitlab.com/allianceauth/django-esi)")
+
+        expected_title = 'DjangoEsi'
+
+        self.assertEqual(request._request.headers["User-Agent"], f"{expected_title}/1.0.0 (email@example.com; +https://gitlab.com/allianceauth/django-esi)")
 
 
 class TestRequestsClientPlus(NoSocketsTestCase):
@@ -809,7 +815,9 @@ class TestEsiClientFactoryAppText(NoSocketsTestCase):
         # 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)")
+        expected_app_name = "MyApp"
+        expected_title = 'DjangoEsi'
+        self.assertEqual(operation.future.request.headers["User-Agent"], f"{expected_title}/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:
@@ -821,7 +829,9 @@ class TestEsiClientFactoryAppText(NoSocketsTestCase):
         # when
         operation = client.Status.get_status()
         # then
-        self.assertEqual(operation.future.request.headers["User-Agent"], "Django-ESI/1.0.0 (email@example.com; +https://gitlab.com/allianceauth/django-esi)")
+        expected_app_name = "MyApp"
+        expected_title = 'DjangoEsi'
+        self.assertEqual(operation.future.request.headers["User-Agent"], f"{expected_title}/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) -> None:
@@ -835,7 +845,9 @@ class TestEsiClientFactoryAppText(NoSocketsTestCase):
         # 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)",)
+        expected_app_name = "MyApp"
+        expected_title = 'DjangoEsi'
+        self.assertEqual(operation.future.request.headers["User-Agent"], f"my-app v1.0.0 (None) {expected_title}/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):
@@ -848,7 +860,9 @@ class TestEsiClientFactoryAppText(NoSocketsTestCase):
         # when
         operation = client.Status.get_status()
         # then
-        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)",)
+        expected_app_name = "MyApp"
+        expected_title = 'DjangoEsi'
+        self.assertEqual(operation.future.request.headers["User-Agent"], f"my-app v1.0.0 (email@example.com) {expected_title}/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):
@@ -859,7 +873,41 @@ class TestEsiClientFactoryAppText(NoSocketsTestCase):
         # 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)")
+        expected_app_name = "MyApp"
+        expected_title = 'DjangoEsi'
+        self.assertEqual(operation.future.request.headers["User-Agent"], f"{expected_app_name}/1.0.0 (email@example.com) {expected_title}/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_for_appname_with_spaces(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="My App", ua_version="1.0.0")
+
+        # when
+        operation = client.Status.get_status()
+
+        # then
+        expected_app_name = "MyApp"
+        expected_title = 'DjangoEsi'
+
+        self.assertEqual(operation.future.request.headers["User-Agent"], f"{expected_app_name}/1.0.0 (email@example.com) {expected_title}/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_for_appname_with_hyphens(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="My-App", ua_version="1.0.0")
+
+        # when
+        operation = client.Status.get_status()
+
+        # then
+        expected_app_name = "MyApp"
+        expected_title = 'DjangoEsi'
+
+        self.assertEqual(operation.future.request.headers["User-Agent"], f"{expected_app_name}/1.0.0 (email@example.com) {expected_title}/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):
@@ -870,7 +918,9 @@ class TestEsiClientFactoryAppText(NoSocketsTestCase):
         # 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)")
+        expected_app_name = "MyApp"
+        expected_title = 'DjangoEsi'
+        self.assertEqual(operation.future.request.headers["User-Agent"], f"{expected_app_name}/1.0.0 (email@example.com; +https://example.com) {expected_title}/1.0.0 (+https://gitlab.com/allianceauth/django-esi)")
 
 @patch(MODULE_PATH + ".__title__", "Django-ESI")
 @patch(MODULE_PATH + ".__version__", "1.0.0")
@@ -897,7 +947,8 @@ class TestEsiClientProviderAppText(NoSocketsTestCase):
         # 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)")
+        expected_title = 'DjangoEsi'
+        self.assertEqual(operation.future.request.headers["User-Agent"], f"{expected_title}/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:
@@ -909,7 +960,8 @@ class TestEsiClientProviderAppText(NoSocketsTestCase):
         # when
         operation = client.Status.get_status()
         # then
-        self.assertEqual(operation.future.request.headers["User-Agent"], "Django-ESI/1.0.0 (email@example.com; +https://gitlab.com/allianceauth/django-esi)")
+        expected_title = 'DjangoEsi'
+        self.assertEqual(operation.future.request.headers["User-Agent"], f"{expected_title}/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) -> None:
@@ -923,7 +975,8 @@ class TestEsiClientProviderAppText(NoSocketsTestCase):
         # 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)",)
+        expected_title = 'DjangoEsi'
+        self.assertEqual(operation.future.request.headers["User-Agent"], f"my-app v1.0.0 (None) {expected_title}/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):
@@ -936,7 +989,8 @@ class TestEsiClientProviderAppText(NoSocketsTestCase):
         # when
         operation = client.Status.get_status()
         # then
-        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)",)
+        expected_title = 'DjangoEsi'
+        self.assertEqual(operation.future.request.headers["User-Agent"], f"my-app v1.0.0 (email@example.com) {expected_title}/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):
@@ -947,7 +1001,9 @@ class TestEsiClientProviderAppText(NoSocketsTestCase):
         # 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)")
+        expected_app_name = "MyApp"
+        expected_title = 'DjangoEsi'
+        self.assertEqual(operation.future.request.headers["User-Agent"], f"{expected_app_name}/1.0.0 (email@example.com) {expected_title}/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):
@@ -958,4 +1014,6 @@ class TestEsiClientProviderAppText(NoSocketsTestCase):
         # 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)")
+        expected_app_name = "MyApp"
+        expected_title = 'DjangoEsi'
+        self.assertEqual(operation.future.request.headers["User-Agent"], f"{expected_app_name}/1.0.0 (email@example.com; +https://example.com) {expected_title}/1.0.0 (+https://gitlab.com/allianceauth/django-esi)")

esi/tests/test_decorators.py

@@ -1,8 +1,10 @@
 """unit tests for esi decorators"""
 
 import logging
+from time import time
 from unittest.mock import patch, Mock
 
+from django.core.cache import cache
 from django.contrib.auth.models import User
 from django.contrib.auth.views import redirect_to_login
 from django.contrib.sessions.middleware import SessionMiddleware
@@ -10,8 +12,10 @@ from django.http import HttpResponse
 from django.test import TestCase, RequestFactory
 
 from . import _generate_token, _store_as_Token
+from ..rate_limiting import ESIRateLimitBucket, ESIRateLimits
+from ..exceptions import ESIBucketLimitException
 from ..decorators import (
-    _check_callback, tokens_required, token_required, single_use_token
+    _check_callback, esi_rate_limiter_bucketed, tokens_required, token_required, single_use_token, wait_for_esi_errorlimit_reset
 )
 from ..models import Token, CallbackRedirect
 
@@ -516,3 +520,59 @@ class TestSingleUseTokenRequired(TestCase):
             response,
             self.token
         )
+
+
+class TestESIRateLimitDecorator(TestCase):
+
+    def setUp(self):
+        self.bucket = ESIRateLimitBucket(
+            "test-bucket",
+            1,
+            5
+        )
+        cache.clear()
+
+    def test_raise(self):
+        @esi_rate_limiter_bucketed(bucket=self.bucket)
+        def my_func():
+            return "Pass"
+
+        _t = time()
+        my_func()
+        self.assertLess(time() - _t, 1)
+        _t = time()
+        with self.assertRaises(ESIBucketLimitException):
+            my_func()
+
+    def test_sleep(self):
+        @esi_rate_limiter_bucketed(bucket=self.bucket, raise_on_limit=False)
+        def my_func():
+            return "Pass"
+
+        _t = time()
+        my_func()
+        self.assertLess(time() - _t, 1)
+        _t = time()
+        my_func()
+        duration = time() - _t
+        self.assertGreater(duration, 5)
+
+
+class TestESIErrorLimitDecorator(TestCase):
+
+    def setUp(self):
+        cache.clear()
+
+    def test_sleep(self):
+        @wait_for_esi_errorlimit_reset()
+        def my_func():
+            return "Pass"
+
+        _t = time()
+        my_func()
+        self.assertLess(time() - _t, 1)
+        cache.set("esi_error_limit_reset", 5, timeout=5)
+        _t = time()
+        my_func()
+        duration = time() - _t
+        self.assertGreater(duration, 5)

esi/tests/test_openapi.json

@@ -122,7 +122,12 @@
           }
         },
         "type": "object"
+      },
+      "UniverseTypesGet": {
+        "items": { "format": "int64", "type": "integer" },
+        "type": "array"
       }
+
     },
     "securitySchemes": {
       "OAuth2": {
@@ -217,6 +222,58 @@
   },
   "openapi": "3.1.0",
   "paths": {
+    "/universe/types": {
+      "get": {
+        "description": "Get a list of type ids\n\nThis route expires daily at 11:05",
+        "operationId": "GetUniverseTypes",
+        "parameters": [
+          {
+            "in": "query",
+            "name": "page",
+            "schema": {
+              "description": "Which page of results to return.",
+              "format": "int32",
+              "minimum": 1,
+              "type": "integer"
+            }
+          },
+          { "$ref": "#/components/parameters/AcceptLanguage" },
+          { "$ref": "#/components/parameters/IfNoneMatch" },
+          { "$ref": "#/components/parameters/CompatibilityDate" },
+          { "$ref": "#/components/parameters/Tenant" }
+        ],
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": { "$ref": "#/components/schemas/UniverseTypesGet" }
+              }
+            },
+            "description": "OK",
+            "headers": {
+              "Cache-Control": { "$ref": "#/components/headers/CacheControl" },
+              "ETag": { "$ref": "#/components/headers/ETag" },
+              "Last-Modified": { "$ref": "#/components/headers/LastModified" },
+              "X-Pages": {
+                "description": "The total number of pages in the result set.",
+                "schema": { "format": "int64", "type": "integer" }
+              }
+            }
+          },
+          "default": {
+            "content": {
+              "application/json": {
+                "schema": { "$ref": "#/components/schemas/Error" }
+              }
+            },
+            "description": "Error"
+          }
+        },
+        "summary": "Get types",
+        "tags": ["Universe"],
+        "x-compatibility-date": "2020-01-01"
+      }
+    },
     "/status": {
       "get": {
         "description": "EVE Server status",
@@ -253,12 +310,18 @@
         "summary": "Retrieve the uptime and player counts",
         "tags": ["Status"],
         "x-cache-age": 30,
-        "x-compatibility-date": "2020-01-01"
+        "x-compatibility-date": "2020-01-01",
+        "x-rate-limit": {
+          "group": "status",
+          "max-tokens": 600,
+          "window-size": "15m"
+        }
       }
     }
   },
   "servers": [{ "url": "https://esi.evetech.net" }],
   "tags": [
-    { "name": "Status" }
+    { "name": "Status" },
+    { "name": "Universe" }
   ]
 }