pypomes-iam 0.5.0__tar.gz → 0.5.1__tar.gz

{pypomes_iam-0.5.0 → pypomes_iam-0.5.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pypomes_iam
-Version: 0.5.0
+Version: 0.5.1
 Summary: A collection of Python pomes, penyeach (IAM modules)
 Project-URL: Homepage, https://github.com/TheWiseCoder/PyPomes-IAM
 Project-URL: Bug Tracker, https://github.com/TheWiseCoder/PyPomes-IAM/issues

{pypomes_iam-0.5.0 → pypomes_iam-0.5.1}/pyproject.toml

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

{pypomes_iam-0.5.0 → pypomes_iam-0.5.1}/src/pypomes_iam/iam_pomes.py

@@ -24,7 +24,7 @@ def user_login(iam_server: IamServer,
     Build the URL for redirecting the request to *iam_server*'s authentication page.
 
     These are the expected attributes in *args*:
-        - user-id: optional, identifies the reference user (aliases: 'user_id', 'login')
+        - user-id: optional, identifies the reference user (alias: 'login')
         - redirect-uri: a parameter to be added to the query part of the returned URL
 
     If provided, the user identification will be validated against the authorization data
@@ -41,7 +41,7 @@ def user_login(iam_server: IamServer,
     result: str | None = None
 
     # obtain the optional user's identification
-    user_id: str = args.get("user-id") or args.get("user_id") or args.get("login")
+    user_id: str = args.get("user-id") or args.get("login")
 
     # build the user data
     # ('oauth_state' is a randomly-generated string, thus 'user_data' is always a new entry)
@@ -84,7 +84,7 @@ def user_logout(iam_server: IamServer,
     """
     Logout the user, by removing all data associating it from *iam_server*'s registry.
 
-    The user is identified by the attribute *user-id*, *user_id*, or "login", provided in *args*.
+    The user is identified by the attribute *user-id* or "login", provided in *args*.
     If successful, remove all data relating to the user from the *IAM* server's registry.
     Otherwise, this operation fails silently, unless an error has ocurred.
 
@@ -94,7 +94,7 @@ def user_logout(iam_server: IamServer,
     :param logger: optional logger
     """
     # obtain the user's identification
-    user_id: str = args.get("user-id") or args.get("user_id") or args.get("login")
+    user_id: str = args.get("user-id") or args.get("login")
 
     if user_id:
         with _iam_lock:
@@ -115,19 +115,19 @@ def user_token(iam_server: IamServer,
     """
     Retrieve the authentication token for the user, from *iam_server*.
 
-    The user is identified by the attribute *user-id*, *user_id*, or *login*, provided in *args*.
+    The user is identified by the attribute *user-id* or *login*, provided in *args*.
 
     :param iam_server: the reference registered *IAM* server
     :param args: the arguments passed when requesting the service
     :param errors: incidental error messages
     :param logger: optional logger
-    :return: the token for *user_id*, or *None* if error
+    :return: the token for user indicated, or *None* if error
     """
     # initialize the return variable
     result: str | None = None
 
     # obtain the user's identification
-    user_id: str = args.get("user-id") or args.get("user_id") or args.get("login")
+    user_id: str = args.get("user-id") or args.get("login")
 
     err_msg: str | None = None
     if user_id:
@@ -272,7 +272,7 @@ def token_exchange(iam_server: IamServer,
     Request *iam_server* to issue a token in exchange for the token obtained from another *IAM* server.
 
     The expected parameters in *args* are:
-        - user-id: identification for the reference user (aliases: 'user_id', 'login')
+        - user-id: identification for the reference user (alias: 'login')
         - token: the token to be exchanged
 
     The typical data set returned contains the following attributes:
@@ -294,10 +294,10 @@ def token_exchange(iam_server: IamServer,
     result: dict[str, Any] | None = None
 
     # obtain the user's identification
-    user_id: str = args.get("user-id") or args.get("user_id") or args.get("login")
+    user_id: str = args.get("user-id") or args.get("login")
 
-    # obtain the token to be exchanges
-    token: str = args.get("token")
+    # obtain the token to be exchanged
+    token: str = args.get("access-token")
 
     if user_id and token:
         # HAZARD: only 'IAM_KEYCLOAK' is currently supported

{pypomes_iam-0.5.0 → pypomes_iam-0.5.1}/src/pypomes_iam/iam_services.py

@@ -33,7 +33,7 @@ def service_login() -> Response:
     Entry point for the IAM server's login service.
 
     These are the expected request parameters:
-        - user-id: optional, identifies the reference user (aliases: 'user_id', 'login')
+        - user-id: optional, identifies the reference user (alias: 'login')
         - redirect-uri: a parameter to be added to the query part of the returned URL
 
     If provided, the user identification will be validated against the authorization data
@@ -85,7 +85,7 @@ def service_logout() -> Response:
     """
     Entry point for the JusBR logout service.
 
-    The user is identified by the attribute *user-id*, *user_id*, or "login", provided as a request parameter.
+    The user is identified by the attribute *user-id* or "login", provided as a request parameter.
     If successful, remove all data relating to the user from the *IAM* server's registry.
     Otherwise, this operation fails silently, unless an error has ocurred.
 
@@ -142,7 +142,7 @@ def service_callback() -> Response:
     On success, the returned *Response* will contain the following JSON:
         {
             "user-id": <reference-user-identification>,
-            "token": <token>
+            "access-token": <token>
         }
 
     :return: *Response* containing the reference user identification and the token, or *BAD REQUEST*
@@ -170,7 +170,7 @@ def service_callback() -> Response:
         result.status_code = 400
     else:
         result = jsonify({"user-id": token_data[0],
-                          "token": token_data[1]})
+                          "access-token": token_data[1]})
     # log the response
     if __IAM_LOGGER:
         __IAM_LOGGER.debug(msg=f"Response {result}, {result.get_data(as_text=True)}")
@@ -186,12 +186,12 @@ def service_token() -> Response:
     """
     Entry point for retrieving a token from the *IAM* server.
 
-    The user is identified by the attribute *user-id*, *user_id*, or "login", provided as a request parameter.
+    The user is identified by the attribute *user-id* or "login", provided as a request parameter.
 
     On success, the returned *Response* will contain the following JSON:
         {
             "user-id": <reference-user-identification>,
-            "token": <token>
+            "access-token": <token>
         }
 
     :return: *Response* containing the user reference identification and the token, or *BAD REQUEST*
@@ -202,7 +202,7 @@ def service_token() -> Response:
 
     # obtain the user's identification
     args: dict[str, Any] = request.args
-    user_id: str = args.get("user-id") or args.get("user_id") or args.get("login")
+    user_id: str = args.get("user-id") or args.get("login")
 
     errors: list[str] = []
     token: str | None = None
@@ -231,7 +231,7 @@ def service_token() -> Response:
         result.status_code = 400
     else:
         result = jsonify({"user-id": user_id,
-                          "token": token})
+                          "access-token": token})
     # log the response
     if __IAM_LOGGER:
         __IAM_LOGGER.debug(msg=f"Response {result}, {result.get_data(as_text=True)}")
@@ -247,8 +247,8 @@ def service_exchange() -> Response:
 
     This is currently limited to the *KEYCLOAK* server. The token itself is stored in *KEYCLOAK*'s registry.
     The expected request parameters are:
-        - user-id: identification for the reference user (aliases: 'user_id', 'login')
-        - token: the token to be exchanged
+        - user-id: identification for the reference user (alias: 'login')
+        - access-token: the token to be exchanged
 
     If the exchange is successful, the token data is stored in the *IAM* server's registry, and returned.
     Otherwise, *errors* will contain the appropriate error message.