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

esi/tests/test_openapi.json

@@ -0,0 +1,264 @@
+{
+  "components": {
+    "headers": {
+      "CacheControl": {
+        "description": "Directives for caching mechanisms. It controls how the response can be cached, by whom, and for how long.",
+        "schema": { "type": "string" }
+      },
+      "ContentLanguage": {
+        "description": "The language used in the response.",
+        "schema": {
+          "enum": ["en", "de", "fr", "ja", "ru", "zh", "ko", "es"],
+          "type": "string"
+        }
+      },
+      "ETag": {
+        "description": "The ETag value of the response body. Use this with If-None-Match to check whether the resource has changed.",
+        "schema": { "type": "string" }
+      },
+      "LastModified": {
+        "description": "The last modified date of the response. Use this with If-Modified-Since to check whether the resource has changed.",
+        "schema": { "type": "string" }
+      }
+    },
+    "parameters": {
+      "AcceptLanguage": {
+        "description": "The language to use for the response.",
+        "in": "header",
+        "name": "Accept-Language",
+        "schema": {
+          "default": "en",
+          "enum": ["en", "de", "fr", "ja", "ru", "zh", "ko", "es"],
+          "type": "string"
+        }
+      },
+      "CompatibilityDate": {
+        "description": "The compatibility date for the request.",
+        "in": "header",
+        "name": "X-Compatibility-Date",
+        "required": true,
+        "schema": { "enum": ["2025-08-26"], "format": "date", "type": "string" }
+      },
+      "IfModifiedSince": {
+        "description": "The date the resource was last modified. A 304 will be returned if the resource has not been modified since this date.",
+        "in": "header",
+        "name": "If-Modified-Since",
+        "schema": { "type": "string" }
+      },
+      "IfNoneMatch": {
+        "description": "The ETag of the previous request. A 304 will be returned if this matches the current ETag.",
+        "in": "header",
+        "name": "If-None-Match",
+        "schema": { "type": "string" }
+      },
+      "Tenant": {
+        "description": "The tenant ID for the request.",
+        "example": "",
+        "in": "header",
+        "name": "X-Tenant",
+        "schema": { "default": "tranquility", "type": "string" }
+      }
+    },
+    "schemas": {
+      "StatusGet": {
+        "properties": {
+          "players": {
+            "description": "Current online player count",
+            "type": "integer"
+          },
+          "server_version": {
+            "description": "Running version as string",
+            "type": "string"
+          },
+          "start_time": {
+            "description": "Server start timestamp",
+            "format": "date-time",
+            "type": "string"
+          },
+          "vip": {
+            "description": "If the server is in VIP mode",
+            "type": "boolean"
+          }
+        },
+        "required": ["start_time", "players", "server_version"],
+        "type": "object"
+      },
+      "Error": {
+        "additionalProperties": false,
+        "properties": {
+          "details": {
+            "description": "List of individual error details.",
+            "items": {
+              "$ref": "#/components/schemas/ErrorDetail"
+            },
+            "type": [
+              "array",
+              "null"
+            ]
+          },
+          "error": {
+            "description": "Error message.",
+            "type": "string"
+          }
+        },
+        "required": [
+          "error"
+        ],
+        "type": "object"
+      },
+      "ErrorDetail": {
+        "additionalProperties": false,
+        "properties": {
+          "location": {
+            "description": "Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'",
+            "type": "string"
+          },
+          "message": {
+            "description": "Error message text",
+            "type": "string"
+          },
+          "value": {
+            "description": "The value at the given location"
+          }
+        },
+        "type": "object"
+      }
+    },
+    "securitySchemes": {
+      "OAuth2": {
+        "flows": {
+          "authorizationCode": {
+            "authorizationUrl": "https://login.eveonline.com/v2/oauth/authorize",
+            "scopes": {
+              "esi-alliances.read_contacts.v1": "esi-alliances.read_contacts.v1",
+              "esi-assets.read_assets.v1": "esi-assets.read_assets.v1",
+              "esi-assets.read_corporation_assets.v1": "esi-assets.read_corporation_assets.v1",
+              "esi-calendar.read_calendar_events.v1": "esi-calendar.read_calendar_events.v1",
+              "esi-calendar.respond_calendar_events.v1": "esi-calendar.respond_calendar_events.v1",
+              "esi-characters.read_agents_research.v1": "esi-characters.read_agents_research.v1",
+              "esi-characters.read_blueprints.v1": "esi-characters.read_blueprints.v1",
+              "esi-characters.read_contacts.v1": "esi-characters.read_contacts.v1",
+              "esi-characters.read_corporation_roles.v1": "esi-characters.read_corporation_roles.v1",
+              "esi-characters.read_fatigue.v1": "esi-characters.read_fatigue.v1",
+              "esi-characters.read_fw_stats.v1": "esi-characters.read_fw_stats.v1",
+              "esi-characters.read_loyalty.v1": "esi-characters.read_loyalty.v1",
+              "esi-characters.read_medals.v1": "esi-characters.read_medals.v1",
+              "esi-characters.read_notifications.v1": "esi-characters.read_notifications.v1",
+              "esi-characters.read_standings.v1": "esi-characters.read_standings.v1",
+              "esi-characters.read_titles.v1": "esi-characters.read_titles.v1",
+              "esi-characters.write_contacts.v1": "esi-characters.write_contacts.v1",
+              "esi-clones.read_clones.v1": "esi-clones.read_clones.v1",
+              "esi-clones.read_implants.v1": "esi-clones.read_implants.v1",
+              "esi-contracts.read_character_contracts.v1": "esi-contracts.read_character_contracts.v1",
+              "esi-contracts.read_corporation_contracts.v1": "esi-contracts.read_corporation_contracts.v1",
+              "esi-corporations.read_blueprints.v1": "esi-corporations.read_blueprints.v1",
+              "esi-corporations.read_contacts.v1": "esi-corporations.read_contacts.v1",
+              "esi-corporations.read_container_logs.v1": "esi-corporations.read_container_logs.v1",
+              "esi-corporations.read_corporation_membership.v1": "esi-corporations.read_corporation_membership.v1",
+              "esi-corporations.read_divisions.v1": "esi-corporations.read_divisions.v1",
+              "esi-corporations.read_facilities.v1": "esi-corporations.read_facilities.v1",
+              "esi-corporations.read_fw_stats.v1": "esi-corporations.read_fw_stats.v1",
+              "esi-corporations.read_medals.v1": "esi-corporations.read_medals.v1",
+              "esi-corporations.read_projects.v1": "esi-corporations.read_projects.v1",
+              "esi-corporations.read_standings.v1": "esi-corporations.read_standings.v1",
+              "esi-corporations.read_starbases.v1": "esi-corporations.read_starbases.v1",
+              "esi-corporations.read_structures.v1": "esi-corporations.read_structures.v1",
+              "esi-corporations.read_titles.v1": "esi-corporations.read_titles.v1",
+              "esi-corporations.track_members.v1": "esi-corporations.track_members.v1",
+              "esi-fittings.read_fittings.v1": "esi-fittings.read_fittings.v1",
+              "esi-fittings.write_fittings.v1": "esi-fittings.write_fittings.v1",
+              "esi-fleets.read_fleet.v1": "esi-fleets.read_fleet.v1",
+              "esi-fleets.write_fleet.v1": "esi-fleets.write_fleet.v1",
+              "esi-industry.read_character_jobs.v1": "esi-industry.read_character_jobs.v1",
+              "esi-industry.read_character_mining.v1": "esi-industry.read_character_mining.v1",
+              "esi-industry.read_corporation_jobs.v1": "esi-industry.read_corporation_jobs.v1",
+              "esi-industry.read_corporation_mining.v1": "esi-industry.read_corporation_mining.v1",
+              "esi-killmails.read_corporation_killmails.v1": "esi-killmails.read_corporation_killmails.v1",
+              "esi-killmails.read_killmails.v1": "esi-killmails.read_killmails.v1",
+              "esi-location.read_location.v1": "esi-location.read_location.v1",
+              "esi-location.read_online.v1": "esi-location.read_online.v1",
+              "esi-location.read_ship_type.v1": "esi-location.read_ship_type.v1",
+              "esi-mail.organize_mail.v1": "esi-mail.organize_mail.v1",
+              "esi-mail.read_mail.v1": "esi-mail.read_mail.v1",
+              "esi-mail.send_mail.v1": "esi-mail.send_mail.v1",
+              "esi-markets.read_character_orders.v1": "esi-markets.read_character_orders.v1",
+              "esi-markets.read_corporation_orders.v1": "esi-markets.read_corporation_orders.v1",
+              "esi-markets.structure_markets.v1": "esi-markets.structure_markets.v1",
+              "esi-planets.manage_planets.v1": "esi-planets.manage_planets.v1",
+              "esi-planets.read_customs_offices.v1": "esi-planets.read_customs_offices.v1",
+              "esi-search.search_structures.v1": "esi-search.search_structures.v1",
+              "esi-skills.read_skillqueue.v1": "esi-skills.read_skillqueue.v1",
+              "esi-skills.read_skills.v1": "esi-skills.read_skills.v1",
+              "esi-ui.open_window.v1": "esi-ui.open_window.v1",
+              "esi-ui.write_waypoint.v1": "esi-ui.write_waypoint.v1",
+              "esi-universe.read_structures.v1": "esi-universe.read_structures.v1",
+              "esi-wallet.read_character_wallet.v1": "esi-wallet.read_character_wallet.v1",
+              "esi-wallet.read_corporation_wallets.v1": "esi-wallet.read_corporation_wallets.v1"
+            },
+            "tokenUrl": "https://login.eveonline.com/v2/oauth/token"
+          }
+        },
+        "type": "oauth2"
+      }
+    }
+  },
+  "info": {
+    "contact": {
+      "name": "ESI Support",
+      "url": "https://developers.eveonline.com/docs/support/"
+    },
+    "license": {
+      "name": "EVE Developer License",
+      "url": "https://developers.eveonline.com/license-agreement"
+    },
+    "termsOfService": "https://support.eveonline.com/hc/en-us/articles/8414770561948-EVE-Online-Terms-of-Service",
+    "title": "EVE Stable Infrastructure (ESI) - tranquility",
+    "version": "2025-08-26"
+  },
+  "openapi": "3.1.0",
+  "paths": {
+    "/status": {
+      "get": {
+        "description": "EVE Server status",
+        "operationId": "GetStatus",
+        "parameters": [
+          { "$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/StatusGet" }
+              }
+            },
+            "description": "OK",
+            "headers": {
+              "Cache-Control": { "$ref": "#/components/headers/CacheControl" },
+              "ETag": { "$ref": "#/components/headers/ETag" },
+              "Last-Modified": { "$ref": "#/components/headers/LastModified" }
+            }
+          },
+          "default": {
+            "content": {
+              "application/json": {
+                "schema": { "$ref": "#/components/schemas/Error" }
+              }
+            },
+            "description": "Error"
+          }
+        },
+        "summary": "Retrieve the uptime and player counts",
+        "tags": ["Status"],
+        "x-cache-age": 30,
+        "x-compatibility-date": "2020-01-01"
+      }
+    }
+  },
+  "servers": [{ "url": "https://esi.evetech.net" }],
+  "tags": [
+    { "name": "Status" }
+  ]
+}

esi/tests/test_openapi.py

@@ -1,7 +1,219 @@
+import os
+from unittest import mock
+from unittest.mock import MagicMock, patch
 from django.test import TestCase
-from datetime import date
+from datetime import date, timedelta
 
 from esi.openapi_clients import ESIClientProvider
+from django.utils import timezone
+from httpx import RequestError, HTTPStatusError
+from esi.exceptions import ESIErrorLimitException
+from esi import app_settings
+from esi import __title__, __url__, __version__
+import httpx
+
+from .. import openapi_clients as oc
+
+SPEC_PATH = os.path.join(
+    os.path.dirname(os.path.abspath(__file__)), "test_openapi.json"
+)
+
+
+class TestClientFunctions(TestCase):
+    def test_time_to_expiry_valid(self):
+        expires = (
+            timezone.now() + timedelta(seconds=120)
+        ).strftime('%a, %d %b %Y %H:%M:%S %Z')
+        ttl = oc._time_to_expiry(expires)
+
+        # this shouldnt take more that 10 seconds
+        self.assertGreater(ttl, 110)
+
+    def test_time_to_expiry_invalid(self):
+        # invalid format returns 0
+        self.assertEqual(oc._time_to_expiry("not-a-date"), 0)
+
+    def test_httpx_exceptions_valids(self):
+        self.assertTrue(
+            oc._httpx_exceptions(
+                RequestError("Bad Request")
+            )
+        )
+
+        response = MagicMock(status_code=502)
+        exc = HTTPStatusError("msg", request=None, response=response)
+
+        self.assertTrue(
+            oc._httpx_exceptions(exc)
+        )
+
+        response.status_code = 400
+        exc = HTTPStatusError("msg", request=None, response=response)
+
+        self.assertFalse(
+            oc._httpx_exceptions(exc)
+        )
+
+        self.assertFalse(
+            oc._httpx_exceptions(
+                ESIErrorLimitException(reset=10)
+            )
+        )
+
+    def test_httpx_exceptions_invalid(self):
+        self.assertFalse(
+            oc._httpx_exceptions(
+                "this is not an exception!"
+            )
+        )
+
+
+class BuildUserAgentTests(TestCase):
+    app_name = "TestsApp"
+    app_ver = "1.2.3"
+    app_url = "https://tests.pass"
+
+    def test_build_user_agent_with_url(self):
+        ua = oc._build_user_agent(self.app_name, self.app_ver, self.app_url)
+        self.assertEqual(
+            (
+                f"{self.app_name}/{self.app_ver} "
+                f"({app_settings.ESI_USER_CONTACT_EMAIL}{f'; +{self.app_url})'} "
+                f"{__title__}/{__version__} (+{__url__})"
+            ),
+            ua
+        )
+
+    def test_build_user_agent_without_url(self):
+        ua = oc._build_user_agent(self.app_name, self.app_ver)
+        self.assertEqual(
+            (
+                f"{self.app_name}/{self.app_ver} "
+                f"({app_settings.ESI_USER_CONTACT_EMAIL}) "
+                f"{__title__}/{__version__} (+{__url__})"
+            ),
+            ua
+        )
+
+
+class BaseEsiOperationTests(TestCase):
+    def setUp(self):
+        self.page_param = MagicMock()
+        self.page_param.name = "page"
+
+        self.after_param = MagicMock()
+        self.after_param.name = "after"
+
+        self.before_param = MagicMock()
+        self.before_param.name = "before"
+
+        self.data_param = MagicMock()
+        self.data_param.name = "data"
+
+        self.lang_param = MagicMock()
+        self.lang_param.name = "Accept-Language"
+
+        self.body_param = MagicMock()
+        self.body_param.name = "body"
+
+        self.fake_op = MagicMock()
+        self.fake_op.parameters = [
+            self.data_param,
+            self.lang_param
+        ]
+        self.fake_op.tags = ["test"]
+        self.fake_op.operationId = "fake_op"
+        self.api = MagicMock(app_name="TestApp")
+        self.op = oc.BaseEsiOperation(
+            ("GET", "/fake_op", self.fake_op, {}),
+            self.api
+        )
+
+    def test_non_unique_kwargs(self):
+        op_1 = self.op(data="bar")
+        key_1 = op_1._cache_key()
+        op_2 = self.op(data="foo")
+        key_2 = op_2._cache_key()
+        self.assertNotEqual(key_1, key_2)
+
+    def test_unique_kwargs(self):
+        op_1 = self.op(data="foo")
+        key_1 = op_1._cache_key()
+        op_2 = self.op(data="foo")
+        key_2 = op_2._cache_key()
+        self.assertEqual(key_1, key_2)
+
+    def test_extract_body(self):
+        test_body = "something somethng something..."
+        op = self.op(body=test_body)
+        body = op._extract_body_param()
+        self.assertEqual(test_body, body)
+
+    def test_extract_body_exception(self):
+        test_body = "something somethng something..."
+        self.fake_op.requestBody = False
+        op = self.op(body=test_body)
+        with self.assertRaises(ValueError):
+            op._extract_body_param()
+
+    def test_extract_token(self):
+        test_tkn = {"token": "token model goes here"}
+        op = self.op(token=test_tkn)
+        token = op._extract_token_param()
+        self.assertEqual(test_tkn, token)
+
+    def test_extract_token_exception_no_token_needed(self):
+        self.op._kwargs = {"token": "token"}
+        self.fake_op.security = None
+        with self.assertRaises(ValueError):
+            self.op._extract_token_param()
+
+    def test_not_page_or_cursor_param(self):
+        self.assertFalse(self.op._has_page_param())
+        self.assertFalse(self.op._has_cursor_param())
+
+    def test_has_page_param(self):
+        self.fake_op.parameters += [self.page_param]
+        op = self.op()
+        self.assertTrue(op._has_page_param())
+
+    def test_has_cursor_params(self):
+        self.fake_op.parameters = [self.after_param]
+        op = self.op()
+        self.assertTrue(op._has_cursor_param())
+
+        self.fake_op.parameters = [self.before_param]
+        op = self.op()
+        self.assertTrue(op._has_cursor_param())
+
+
+class EsiOperationTests(TestCase):
+    def setUp(self):
+        self.op_mock = MagicMock()
+        self.op_mock.parameters = []
+        self.op_mock.tags = ["tag"]
+        self.op_mock.operationId = "opid"
+
+        self.api_mock = MagicMock()
+        self.api_mock.app_name = "TestApp"
+
+        self.op = oc.EsiOperation(
+            (
+                "GET",
+                "/url",
+                self.op_mock,
+                {}
+            ),
+            self.api_mock
+        )
+
+    @patch.object(oc.EsiOperation, "_make_request")
+    def test_result_and_results(self, mock_make_request):
+        data = {"data": "stuff"}
+        mock_resp = MagicMock(status_code=200, headers={"Expires": "Wed, 1 July 2099 11:00:00 GMT"})
+        mock_make_request.return_value = ({"Expires": "date"}, data, mock_resp)
+        data_resp = self.op(foo="bar").result()
+        self.assertEqual(data, data_resp)
 
 
 class TestOpenapiClientProvider(TestCase):
@@ -12,3 +224,38 @@ class TestOpenapiClientProvider(TestCase):
 
         self.assertEqual("2024-01-01", ESIClientProvider._date_to_string(testdate_1))
         self.assertEqual("2025-08-26", ESIClientProvider._date_to_string(testdate_2))
+
+    @patch.object(httpx.Client, "send")
+    def test_ua(self, send: MagicMock):
+        app_name = "TestsApp"
+        app_ver = "1.2.3"
+        app_url = "https://tests.pass"
+        esi = ESIClientProvider(
+            ua_appname=app_name,
+            ua_url=app_url,
+            ua_version=app_ver,
+            compatibility_date="2020-01-01",
+            spec_file=SPEC_PATH
+        )
+
+        send.return_value = httpx.Response(
+            200,
+            json={
+                "players": 1234,
+                "server_version": "1234",
+                "start_time": "2029-09-19T11:02:08Z"
+            },
+            request=httpx.Request("GET", "test"),
+        )
+
+        status = esi.client.Status.GetStatus().result()
+        call_args, call_kwargs = send.call_args
+        self.assertEqual(
+            call_args[0].headers["user-agent"],
+            (
+                f"{app_name}/{app_ver} "
+                f"({app_settings.ESI_USER_CONTACT_EMAIL}{f'; +{app_url})'} "
+                f"{__title__}/{__version__} (+{__url__})"
+            )
+        )
+        self.assertEqual(status.players, 1234)