From f8a727b7ef4050a54236efd7cef31da7c1eb9043 Mon Sep 17 00:00:00 2001
From: foefl <f.foerster@d-opt.com>
Date: Thu, 20 Mar 2025 08:23:48 +0100
Subject: [PATCH] rename parameter for user in credentials

---
 src/delta_barth/_csharp/json_types.py |  2 +-
 src/delta_barth/api/common.py         | 10 +++++-----
 src/delta_barth/management.py         |  4 ++--
 src/delta_barth/types.py              |  2 +-
 tests/api/conftest.py                 |  2 +-
 tests/api/test_common.py              | 12 ++++++------
 6 files changed, 16 insertions(+), 16 deletions(-)

diff --git a/src/delta_barth/_csharp/json_types.py b/src/delta_barth/_csharp/json_types.py
index 112299b..96b9acf 100644
--- a/src/delta_barth/_csharp/json_types.py
+++ b/src/delta_barth/_csharp/json_types.py
@@ -48,6 +48,6 @@ def status_err() -> str:
 
 def api_credentials() -> str:
     model = ApiCredentials(
-        user_name="user", password="pass", database="test1", mandant="mandant1"
+        username="user", password="pass", database="test1", mandant="mandant1"
     )
     return model.model_dump_json()
diff --git a/src/delta_barth/api/common.py b/src/delta_barth/api/common.py
index 88bff59..6f0d2de 100644
--- a/src/delta_barth/api/common.py
+++ b/src/delta_barth/api/common.py
@@ -39,13 +39,13 @@ class Session:
 
     def set_credentials(
         self,
-        user_name: str,
+        username: str,
         password: str,
         database: str,
         mandant: str,
     ) -> None:
         self._creds = validate_credentials(
-            user_name=user_name,
+            username=username,
             password=password,
             database=database,
             mandant=mandant,
@@ -99,7 +99,7 @@ class Session:
         URL: Final = combine_route(self.base_url, ROUTE)
 
         login_req = LoginRequest(
-            userName=self.creds.user_name,
+            userName=self.creds.username,
             password=self.creds.password,
             databaseName=self.creds.database,
             mandantName=self.creds.mandant,
@@ -182,13 +182,13 @@ class Session:
 
 
 def validate_credentials(
-    user_name: str,
+    username: str,
     password: str,
     database: str,
     mandant: str,
 ) -> ApiCredentials:
     return ApiCredentials(
-        user_name=user_name,
+        username=username,
         password=password,
         database=database,
         mandant=mandant,
diff --git a/src/delta_barth/management.py b/src/delta_barth/management.py
index 330f7c9..592417c 100644
--- a/src/delta_barth/management.py
+++ b/src/delta_barth/management.py
@@ -12,13 +12,13 @@ SESSION: Final[Session] = Session(HTTP_BASE_CONTENT_HEADERS)
 
 
 def set_credentials(
-    user_name: str,
+    username: str,
     password: str,
     database: str,
     mandant: str,
 ) -> None:  # pragma: no cover
     SESSION.set_credentials(
-        user_name=user_name,
+        username=username,
         password=password,
         database=database,
         mandant=mandant,
diff --git a/src/delta_barth/types.py b/src/delta_barth/types.py
index 4e59571..65397df 100644
--- a/src/delta_barth/types.py
+++ b/src/delta_barth/types.py
@@ -84,7 +84,7 @@ JsonStatus = t.NewType("JsonStatus", str)
 class ApiCredentials(BaseModel):
     model_config: ConfigDict = ConfigDict(str_strip_whitespace=True)
 
-    user_name: str
+    username: str
     password: str
     database: str
     mandant: str
diff --git a/tests/api/conftest.py b/tests/api/conftest.py
index b824bb8..494a6b4 100644
--- a/tests/api/conftest.py
+++ b/tests/api/conftest.py
@@ -11,7 +11,7 @@ def session(credentials, api_base_url) -> common.Session:
     session = common.Session(HTTP_BASE_CONTENT_HEADERS)
     session.set_base_url(api_base_url)
     session.set_credentials(
-        user_name=credentials["user"],
+        username=credentials["user"],
         password=credentials["pwd"],
         database=credentials["db"],
         mandant=credentials["mandant"],
diff --git a/tests/api/test_common.py b/tests/api/test_common.py
index 4fb8df3..441be77 100644
--- a/tests/api/test_common.py
+++ b/tests/api/test_common.py
@@ -11,30 +11,30 @@ from delta_barth.types import HttpRequestTypes
 
 def test_validate_creds(credentials):
     creds = common.validate_credentials(
-        user_name=credentials["user"],
+        username=credentials["user"],
         password=credentials["pwd"],
         database=credentials["db"],
         mandant=credentials["mandant"],
     )
-    assert creds.user_name == credentials["user"]
+    assert creds.username == credentials["user"]
     assert creds.password == credentials["pwd"]
     assert creds.database == credentials["db"]
     assert creds.mandant == credentials["mandant"]
     # with whitespaces
     user = "  " + credentials["user"] + " "
     creds = common.validate_credentials(
-        user_name=user,
+        username=user,
         password=credentials["pwd"],
         database=credentials["db"],
         mandant=credentials["mandant"],
     )
     assert user != credentials["user"]
-    assert creds.user_name == credentials["user"]
+    assert creds.username == credentials["user"]
     # invalid type
     user = 123
     with pytest.raises(ValidationError):
         creds = common.validate_credentials(
-            user_name=user,  # type: ignore
+            username=user,  # type: ignore
             password=credentials["pwd"],
             database=credentials["db"],
             mandant=credentials["mandant"],
@@ -64,7 +64,7 @@ def test_session(credentials, api_base_url):
     session.set_base_url(api_base_url)
     assert session._base_url is not None
     session.set_credentials(
-        user_name=credentials["user"],
+        username=credentials["user"],
         password=credentials["pwd"],
         database=credentials["db"],
         mandant=credentials["mandant"],