Merge pull request #59 from crdbrd/user-agent

Add python-brreg with version to User-Agent header
crdbrd · Aug 18, 2024 · 7f16ce6 · 7f16ce6
2 parents b000d1a + 763dffe
commit 7f16ce6
Show file tree

Hide file tree

Showing 7 changed files with 62 additions and 3 deletions.
diff --git a/src/brreg/__init__.py b/src/brreg/__init__.py
@@ -1,6 +1,9 @@
 """API client for Brønnøysundregistrene's open API."""
 
-__version__ = "1.0.0a1"
+from importlib.metadata import (  # pyright: ignore[reportMissingImports]
+    PackageNotFoundError,  # pyright: ignore[reportUnknownVariableType]
+    version,  # pyright: ignore[reportUnknownVariableType]
+)
 
 from brreg._exceptions import BrregError, BrregRestError
 
@@ -9,3 +12,8 @@
     "BrregError",
     "BrregRestError",
 ]
+
+try:
+    __version__: str = version(__name__)  # pyright: ignore[reportUnknownVariableType]
+except PackageNotFoundError:  # pragma: no cover
+    __version__ = "unknown"
diff --git a/src/brreg/enhetsregisteret/_client.py b/src/brreg/enhetsregisteret/_client.py
@@ -4,6 +4,7 @@
 
 import httpx
 
+import brreg
 from brreg import BrregError, BrregRestError
 from brreg.enhetsregisteret._pagination import Cursor, EnhetPage, UnderenhetPage
 from brreg.enhetsregisteret._queries import EnhetQuery, UnderenhetQuery
@@ -59,6 +60,12 @@ def open(self) -> None:
         """
         self._client = httpx.Client(
             base_url="https://data.brreg.no/enhetsregisteret/api",
+            headers={
+                "user-agent": (
+                    f"python-brreg/{brreg.__version__} "
+                    f"python-httpx/{httpx.__version__}"
+                ),
+            },
         )
 
     def close(self) -> None:

diff --git a/tests/enhetsregisteret/test_get_enhet.py b/tests/enhetsregisteret/test_get_enhet.py
@@ -5,6 +5,7 @@
 import pytest
 from pytest_httpx import HTTPXMock
 
+import brreg
 from brreg import BrregError, BrregRestError, enhetsregisteret
 
 DATA_DIR = Path(__file__).parent.parent / "data"
@@ -21,6 +22,13 @@ def test_get_enhet(httpx_mock: HTTPXMock) -> None:
 
     org = enhetsregisteret.Client().get_enhet("112233445")
 
+    requests = httpx_mock.get_requests()  # pyright: ignore[reportUnknownMemberType]
+    assert len(requests) == 1
+    assert (
+        requests[0].headers["user-agent"]
+        == f"python-brreg/{brreg.__version__} python-httpx/{httpx.__version__}"
+    )
+
     assert org is not None
     assert org.organisasjonsnummer == "112233445"
     assert org.navn == "SESAM STASJON"

diff --git a/tests/enhetsregisteret/test_get_roller.py b/tests/enhetsregisteret/test_get_roller.py
@@ -1,9 +1,11 @@
 from datetime import date
 from pathlib import Path
 
+import httpx
 import pytest
 from pytest_httpx import HTTPXMock
 
+import brreg
 from brreg import enhetsregisteret
 
 DATA_DIR = Path(__file__).parent.parent / "data"
@@ -20,6 +22,13 @@ def test_get_roller_with_person(httpx_mock: HTTPXMock) -> None:
 
     rollegrupper = enhetsregisteret.Client().get_roller("810004622")
 
+    requests = httpx_mock.get_requests()  # pyright: ignore[reportUnknownMemberType]
+    assert len(requests) == 1
+    assert (
+        requests[0].headers["user-agent"]
+        == f"python-brreg/{brreg.__version__} python-httpx/{httpx.__version__}"
+    )
+
     assert rollegrupper
 
     styret = rollegrupper[0]

diff --git a/tests/enhetsregisteret/test_get_underenhet.py b/tests/enhetsregisteret/test_get_underenhet.py
@@ -1,9 +1,11 @@
 from datetime import date
 from pathlib import Path
 
+import httpx
 import pytest
 from pytest_httpx import HTTPXMock
 
+import brreg
 from brreg import enhetsregisteret
 
 DATA_DIR = Path(__file__).parent.parent / "data"
@@ -20,6 +22,13 @@ def test_get_underenhet(httpx_mock: HTTPXMock) -> None:
 
     org = enhetsregisteret.Client().get_underenhet("776655441")
 
+    requests = httpx_mock.get_requests()  # pyright: ignore[reportUnknownMemberType]
+    assert len(requests) == 1
+    assert (
+        requests[0].headers["user-agent"]
+        == f"python-brreg/{brreg.__version__} python-httpx/{httpx.__version__}"
+    )
+
     assert org is not None
     assert org.organisasjonsnummer == "776655441"
     assert org.navn == "SESAM STASJON"

diff --git a/tests/enhetsregisteret/test_search_enhet.py b/tests/enhetsregisteret/test_search_enhet.py
@@ -1,8 +1,10 @@
 from datetime import date
 from pathlib import Path
 
+import httpx
 from pytest_httpx import HTTPXMock
 
+import brreg
 from brreg import enhetsregisteret
 
 DATA_DIR = Path(__file__).parent.parent / "data"
@@ -52,8 +54,15 @@ def test_search_enhet(httpx_mock: HTTPXMock) -> None:
             konkurs=False,
         ),
     )
-    page = next(cursor.pages)
 
+    requests = httpx_mock.get_requests()  # pyright: ignore[reportUnknownMemberType]
+    assert len(requests) == 1
+    assert (
+        requests[0].headers["user-agent"]
+        == f"python-brreg/{brreg.__version__} python-httpx/{httpx.__version__}"
+    )
+
+    page = next(cursor.pages)
     assert page.page_size == 1
     assert page.page_number == 0
     assert page.total_elements == 1

diff --git a/tests/enhetsregisteret/test_search_underenhet.py b/tests/enhetsregisteret/test_search_underenhet.py
@@ -1,8 +1,10 @@
 from datetime import date
 from pathlib import Path
 
+import httpx
 from pytest_httpx import HTTPXMock
 
+import brreg
 from brreg import enhetsregisteret
 
 DATA_DIR = Path(__file__).parent.parent / "data"
@@ -47,8 +49,15 @@ def test_search_underenhet(httpx_mock: HTTPXMock) -> None:
             naeringskode=["90.012"],
         ),
     )
-    page = next(cursor.pages)
 
+    requests = httpx_mock.get_requests()  # pyright: ignore[reportUnknownMemberType]
+    assert len(requests) == 1
+    assert (
+        requests[0].headers["user-agent"]
+        == f"python-brreg/{brreg.__version__} python-httpx/{httpx.__version__}"
+    )
+
+    page = next(cursor.pages)
     assert page.page_size == 1
     assert page.page_number == 0
     assert page.total_elements == 1