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

esi/tests/test_openapi.py

@@ -5,9 +5,10 @@ from django.test import TestCase
 from datetime import date, timedelta
 
 from esi.openapi_clients import ESIClientProvider
+from django.core.cache import cache
 from django.utils import timezone
 from httpx import RequestError, HTTPStatusError
-from esi.exceptions import ESIErrorLimitException
+from esi.exceptions import ESIErrorLimitException, HTTPNotModified
 from esi import app_settings
 from esi import __title__, __url__, __version__
 import httpx
@@ -69,28 +70,80 @@ class TestClientFunctions(TestCase):
 
 
 class BuildUserAgentTests(TestCase):
-    app_name = "TestsApp"
+    app_name = "TestApp"
     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)
+
+        expected_app_name = "TestApp"
+        expected_title = 'DjangoEsi'
+
         self.assertEqual(
             (
-                f"{self.app_name}/{self.app_ver} "
+                f"{expected_app_name}/{self.app_ver} "
                 f"({app_settings.ESI_USER_CONTACT_EMAIL}{f'; +{self.app_url})'} "
-                f"{__title__}/{__version__} (+{__url__})"
+                f"{expected_title}/{__version__} (+{__url__})"
+            ),
+            ua
+        )
+
+    def test_enforce_pascal_case_for_ua_appname_with_space(self):
+        """
+        Test that the application name is converted to PascalCase in the User-Agent string when it contains spaces.
+
+        :return:
+        :rtype:
+        """
+
+        ua = oc._build_user_agent("test app", self.app_ver, self.app_url)
+
+        expected_app_name = "TestApp"
+        expected_title = 'DjangoEsi'
+
+        self.assertEqual(
+            (
+                f"{expected_app_name}/{self.app_ver} "
+                f"({app_settings.ESI_USER_CONTACT_EMAIL}{f'; +{self.app_url})'} "
+                f"{expected_title}/{__version__} (+{__url__})"
+            ),
+            ua
+        )
+
+    def test_enforce_pascal_case_for_ua_appname_with_hyphen(self):
+        """
+        Test that the application name is converted to PascalCase in the User-Agent string when it contains hyphens.
+
+        :return:
+        :rtype:
+        """
+
+        ua = oc._build_user_agent("test-app", self.app_ver, self.app_url)
+
+        expected_app_name = "TestApp"
+        expected_title = 'DjangoEsi'
+
+        self.assertEqual(
+            (
+                f"{expected_app_name}/{self.app_ver} "
+                f"({app_settings.ESI_USER_CONTACT_EMAIL}{f'; +{self.app_url})'} "
+                f"{expected_title}/{__version__} (+{__url__})"
             ),
             ua
         )
 
     def test_build_user_agent_without_url(self):
         ua = oc._build_user_agent(self.app_name, self.app_ver)
+
+        expected_app_name = "TestApp"
+        expected_title = 'DjangoEsi'
+
         self.assertEqual(
             (
-                f"{self.app_name}/{self.app_ver} "
+                f"{expected_app_name}/{self.app_ver} "
                 f"({app_settings.ESI_USER_CONTACT_EMAIL}) "
-                f"{__title__}/{__version__} (+{__url__})"
+                f"{expected_title}/{__version__} (+{__url__})"
             ),
             ua
         )
@@ -235,8 +288,10 @@ class TestOpenapiClientProvider(TestCase):
             ua_url=app_url,
             ua_version=app_ver,
             compatibility_date="2020-01-01",
+            tags=["Status"],
             spec_file=SPEC_PATH
         )
+        cache.clear()
 
         send.return_value = httpx.Response(
             200,
@@ -250,12 +305,111 @@ class TestOpenapiClientProvider(TestCase):
 
         status = esi.client.Status.GetStatus().result()
         call_args, call_kwargs = send.call_args
+
+        expected_app_name = "TestsApp"
+        expected_title = 'DjangoEsi'
+
         self.assertEqual(
             call_args[0].headers["user-agent"],
             (
-                f"{app_name}/{app_ver} "
+                f"{expected_app_name}/{app_ver} "
                 f"({app_settings.ESI_USER_CONTACT_EMAIL}{f'; +{app_url})'} "
-                f"{__title__}/{__version__} (+{__url__})"
+                f"{expected_title}/{__version__} (+{__url__})"
             )
         )
         self.assertEqual(status.players, 1234)
+
+    @patch.object(httpx.Client, "send")
+    def test_etag_hit_cached(self, send: MagicMock):
+        app_name = "TestsApp"
+        app_ver = "1.2.3"
+        app_url = "https://tests.pass"
+        etag = "'123456789abcdef123456789abcdef'"
+        esi = ESIClientProvider(
+            ua_appname=app_name,
+            ua_url=app_url,
+            ua_version=app_ver,
+            compatibility_date="2020-01-01",
+            tags=["Status"],
+            spec_file=SPEC_PATH
+        )
+        cache.clear()
+
+        expires = (
+            timezone.now() + timedelta(minutes=5)
+        ).strftime('%a, %d %b %Y %H:%M:%S %Z')
+
+        send.return_value = httpx.Response(
+            200,
+            json={
+                "players": 1234,
+                "server_version": "1234",
+                "start_time": "2029-09-19T11:02:08Z"
+            },
+            headers={
+                "etag": etag,
+                "expires": expires
+            },
+            request=httpx.Request(
+                "GET",
+                "test",
+            ),
+        )
+
+        esi.client.Status.GetStatus().result()
+
+        with self.assertRaises(HTTPNotModified):
+            esi.client.Status.GetStatus().result()
+
+    @patch.object(httpx.Client, "send")
+    def test_etag_hit_external(self, send: MagicMock):
+        app_name = "TestsApp"
+        app_ver = "1.2.3"
+        app_url = "https://tests.pass"
+        etag = "'123456789abcdef123456789abcdef'"
+        esi = ESIClientProvider(
+            ua_appname=app_name,
+            ua_url=app_url,
+            ua_version=app_ver,
+            compatibility_date="2020-01-01",
+            tags=["Status"],
+            spec_file=SPEC_PATH
+        )
+        cache.clear()
+        expires = (
+            timezone.now() + timedelta(minutes=5)
+        ).strftime('%a, %d %b %Y %H:%M:%S %Z')
+
+        send.return_value = httpx.Response(
+            200,
+            json={
+                "players": 1234,
+                "server_version": "1234",
+                "start_time": "2029-09-19T11:02:08Z"
+            },
+            headers={
+                "etag": etag,
+                "expires": expires
+            },
+            request=httpx.Request(
+                "GET",
+                "test",
+            ),
+        )
+        esi.client.Status.GetStatus().result()
+
+        cache.delete(esi.client.Status.GetStatus()._cache_key())
+
+        send.return_value = httpx.Response(
+            304,
+            headers={
+                "etag": etag,
+                "expires": expires
+            },
+            request=httpx.Request(
+                "GET",
+                "test",
+            ),
+        )
+        with self.assertRaises(HTTPNotModified):
+            esi.client.Status.GetStatus().result()