pypomes-jwt 1.2.4__tar.gz → 1.2.5__tar.gz

{pypomes_jwt-1.2.4 → pypomes_jwt-1.2.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pypomes_jwt
-Version: 1.2.4
+Version: 1.2.5
 Summary: A collection of Python pomes, penyeach (JWT module)
 Project-URL: Homepage, https://github.com/TheWiseCoder/PyPomes-JWT
 Project-URL: Bug Tracker, https://github.com/TheWiseCoder/PyPomes-JWT/issues

{pypomes_jwt-1.2.4 → pypomes_jwt-1.2.5}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "pypomes_jwt"
-version = "1.2.4"
+version = "1.2.5"
 authors = [
   { name="GT Nunes", email="wisecoder01@gmail.com" }
 ]

{pypomes_jwt-1.2.4 → pypomes_jwt-1.2.5}/src/pypomes_jwt/jwt_external.py

@@ -14,6 +14,8 @@ from typing import Any
 #      "grant-type": <type-of-grant-to-request>,
 #      "user": <basic-auth-user>,
 #      "pwd": <basic-auth-pwd>,
+#      "client-id": <client-identification>,
+#      "use-header": <bool>,
 #      "token": <auth-token>,
 #      "expiration": <timestamp>
 #    }
@@ -29,15 +31,15 @@ def provider_register(provider_id: str,
                       client_id: str = None,
                       use_header: bool = None) -> None:
     """
-    Register an external token provider.
+    Register an external authentication token provider.
 
     :param provider_id: the provider's identification
     :param grant_type: the type of grant to request (typically, 'client_credentials' or 'password')
-    :param access_url: the url to request tokens with
+    :param access_url: the url to request authentication tokens with
     :param auth_user: the basic authorization user
     :param auth_pwd: the basic authorization password
-    :param client_id: optional client id to add to the request body
-    :param use_header: use HTTP header on the request
+    :param client_id: optional client identification to add to the request data
+    :param use_header: add authorization data to HTTP header (defaults to sending them in the body of the request)
     """
     global _provider_registry  # noqa: PLW0602
     _provider_registry[provider_id] = {
@@ -45,8 +47,8 @@ def provider_register(provider_id: str,
         "grant_type": grant_type,
         "user": auth_user,
         "pwd": auth_pwd,
-        "client_id": client_id,
-        "use_header": use_header,
+        "client-id": client_id,
+        "use-header": use_header,
         "token": None,
         "expiration": datetime.now(tz=TZ_LOCAL).timestamp()
     }
@@ -71,18 +73,18 @@ def provider_get_token(errors: list[str] | None,
     if provider:
         now: float = datetime.now(tz=TZ_LOCAL).timestamp()
         if now > provider.get("expiration"):
-            data: dict[str, str] = {"grant_type": provider.get("grant-type")}
-            headers: dict[str, str] = {"Content-Type": Mimetype.URLENCODED}
             user: str = provider.get("user")
             pwd: str = provider.get("pwd")
-            if provider.get("use_header"):
+            data: dict[str, str] = {"grant-type": provider.get("grant-type")}
+            headers: dict[str, str] = {"Content-Type": Mimetype.URLENCODED}
+            if provider.get("use-header"):
                 enc_bytes: bytes = b64encode(f"{user}:{pwd}".encode())
                 headers["Authorization"] = f"Basic {enc_bytes.decode()}"
             else:
                 data["username"] = user
                 data["password"] = pwd
-                if provider.get("client_id"):
-                    data["client_id"] = provider.get("client_id")
+            if provider.get("client-id"):
+                data["client-id"] = provider.get("client-id")
             url: str = provider.get("url")
             try:
                 # typical return on a token request: