js7-client-python 2.0.1__py3-none-any.whl

js7/client/action/workflow/set_workflow_version_as_current_action.py

@@ -0,0 +1,86 @@
+from typing import Optional
+
+from ...context import Context
+from ....model.public.client.common.audit_log import AuditLog
+from ....model.private.api.endpoint import EndpointCall
+from ....model.private.http.joc.joc_v_2_8_2 import (
+    OK as OK_V_2_8_2,
+    AuditParams as AuditParams_V_2_8_2,
+    ModifyWorkflow as ModifyWorkflow_V_2_8_2,
+    WorkflowID as WorkflowID_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def set_workflow_version_as_current_action(
+    *, 
+    context: Context, 
+    controller_id: str,
+    workflow_path: str,
+    workflow_version_id: str,
+    audit_log: Optional[AuditLog]
+) -> bool:
+
+    if check_matching_version(min="2.6.5", max="2.8.3", check=context.version):
+        request_data = _build_v_2_8_2_request(
+            controller_id=controller_id, 
+            workflow_path=workflow_path,
+            workflow_version_id=workflow_version_id,
+            audit_log=audit_log
+        )
+    else:
+        raise RuntimeError(f"Version {context.version} is not compatible with building the request.")
+    
+    # Calls the dispatcher for the matching JOC version
+    result = context.joc_api.dispatch(endpoint_id="workflow/transition", call=EndpointCall(
+        http_service=context.http_service,
+        access_token=context.auth_provider.login(),
+        payload=request_data,
+        options=None,
+    ))
+    
+    if isinstance(result, OK_V_2_8_2):
+        return bool(result.ok)
+    
+    raise RuntimeError(f"Unexpected response type: {type(result).__name__}")
+
+#---------------------#
+# Build 2.8.2 request #
+#---------------------#
+def _build_v_2_8_2_request(
+    *,
+    controller_id: str,
+    workflow_path: str,
+    workflow_version_id: str,
+    audit_log: Optional[AuditLog]
+) -> ModifyWorkflow_V_2_8_2:
+
+    # Validate: controller_id
+    if not controller_id:
+        raise ValueError("'controller_id' is required")
+    
+    # Validate: workflow_version_id
+    if not workflow_version_id:
+        raise ValueError("'workflow_version_id' is required")
+    
+    # Validate: workflow_path
+    if not workflow_path:
+        raise ValueError("'workflow_path' is required")
+    
+    # Build: audit_log 
+    res_audit_log = AuditParams_V_2_8_2(
+        ticket_link=audit_log.ticket_link,
+        comment=audit_log.comment,
+        time_spent=audit_log.time_spent
+    ) if audit_log else None
+    
+    # Result
+    return ModifyWorkflow_V_2_8_2(
+        controller_id=controller_id,
+        workflow_id=WorkflowID_V_2_8_2(
+            path=workflow_path,
+            version_id=workflow_version_id
+        ),
+        audit_log=res_audit_log
+    )

js7/client/action/workflow/skip_job_instructions_action.py

@@ -0,0 +1,83 @@
+from typing import List, Optional
+
+from ...context import Context
+from ....model.public.client.common.audit_log import AuditLog
+from ....model.private.api.endpoint import EndpointCall
+from ....model.private.http.joc.joc_v_2_8_2 import (
+    OK as OK_V_2_8_2,
+    AuditParams as AuditParams_V_2_8_2,
+    ModifyWorkflowLabels as ModifyWorkflowLabels_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def skip_job_instructions_action(
+    *, 
+    context: Context, 
+    controller_id: str, 
+    workflow_path: str,
+    labels: List[str],
+    audit_log: Optional[AuditLog]
+) -> bool:
+
+    if check_matching_version(min="2.6.5", max="2.8.3", check=context.version):
+        request_data = _build_v_2_8_2_request(
+            controller_id=controller_id, 
+            workflow_path=workflow_path,
+            labels=labels,
+            audit_log=audit_log
+        )
+    else:
+        raise RuntimeError(f"Version {context.version} is not compatible with building the request.")
+    
+    # Calls the dispatcher for the matching JOC version
+    result = context.joc_api.dispatch(endpoint_id="workflow/skip", call=EndpointCall(
+        http_service=context.http_service,
+        access_token=context.auth_provider.login(),
+        payload=request_data,
+        options=None,
+    ))
+    
+    if isinstance(result, OK_V_2_8_2):
+        return bool(result.ok)
+    
+    raise RuntimeError(f"Unexpected response type: {type(result).__name__}")
+
+#---------------------#
+# Build 2.8.2 request #
+#---------------------#
+def _build_v_2_8_2_request(
+    *,
+    controller_id: str,
+    workflow_path: str,
+    labels: List[str],
+    audit_log: Optional[AuditLog]
+) -> ModifyWorkflowLabels_V_2_8_2:
+
+    # Validate: controller_id
+    if not controller_id:
+        raise ValueError("'controller_id' is required.")
+    
+    # Validate: workflow_path
+    if not workflow_path:
+        raise ValueError("'workflow_path' is required.")
+    
+    # Validate: labels
+    if not labels:
+        raise ValueError("At least one label in 'labels' is required.")
+    
+    # Build: audit_log 
+    res_audit_log = AuditParams_V_2_8_2(
+        ticket_link=audit_log.ticket_link,
+        comment=audit_log.comment,
+        time_spent=audit_log.time_spent
+    ) if audit_log else None
+    
+    # Result
+    return ModifyWorkflowLabels_V_2_8_2(
+        controller_id=controller_id,
+        workflow_path=workflow_path,
+        labels=labels,
+        audit_log=res_audit_log
+    )

js7/client/action/workflow/stop_job_instructions_action.py

@@ -0,0 +1,83 @@
+from typing import List, Optional
+
+from ...context import Context
+from ....model.public.client.common.audit_log import AuditLog
+from ....model.private.api.endpoint import EndpointCall
+from ....model.private.http.joc.joc_v_2_8_2 import (
+    OK as OK_V_2_8_2,
+    AuditParams as AuditParams_V_2_8_2,
+    ModifyWorkflowPositions as ModifyWorkflowPositions_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def stop_job_instructions_action(
+    *, 
+    context: Context, 
+    controller_id: str, 
+    workflow_path: str,
+    labels: List[str],
+    audit_log: Optional[AuditLog]
+) -> bool:
+
+    if check_matching_version(min="2.6.5", max="2.8.3", check=context.version):
+        request_data = _build_v_2_8_2_request(
+            controller_id=controller_id, 
+            workflow_path=workflow_path,
+            labels=labels,
+            audit_log=audit_log
+        )
+    else:
+        raise RuntimeError(f"Version {context.version} is not compatible with building the request.")
+    
+    # Calls the dispatcher for the matching JOC version
+    result = context.joc_api.dispatch(endpoint_id="workflow/stop", call=EndpointCall(
+        http_service=context.http_service,
+        access_token=context.auth_provider.login(),
+        payload=request_data,
+        options=None,
+    ))
+    
+    if isinstance(result, OK_V_2_8_2):
+        return bool(result.ok)
+    
+    raise RuntimeError(f"Unexpected response type: {type(result).__name__}")
+
+#---------------------#
+# Build 2.8.2 request #
+#---------------------#
+def _build_v_2_8_2_request(
+    *,
+    controller_id: str,
+    workflow_path: str,
+    labels: List[str],
+    audit_log: Optional[AuditLog]
+) -> ModifyWorkflowPositions_V_2_8_2:
+
+    # Validate: controller_id
+    if not controller_id:
+        raise ValueError("'controller_id' is required")
+    
+    # Validate: workflow_path
+    if not workflow_path:
+        raise ValueError("'workflow_path' is required")
+    
+    # Validate: labels
+    if not labels:
+        raise ValueError("At least one label in 'labels' is required.")
+    
+    # Build: audit_log 
+    res_audit_log = AuditParams_V_2_8_2(
+        ticket_link=audit_log.ticket_link,
+        comment=audit_log.comment,
+        time_spent=audit_log.time_spent
+    ) if audit_log else None
+    
+    # Result
+    return ModifyWorkflowPositions_V_2_8_2(
+        controller_id=controller_id,
+        workflow_paths=[workflow_path],
+        positions=[label for label in labels], # Type checker trick.
+        audit_log=res_audit_log
+    )

js7/client/action/workflow/suspend_workflows_action.py

@@ -0,0 +1,76 @@
+from typing import List, Optional
+
+from ...context import Context
+from ....model.public.client.common.audit_log import AuditLog
+from ....model.private.api.endpoint import EndpointCall
+from ....model.private.http.joc.joc_v_2_8_2 import (
+    OK as OK_V_2_8_2,
+    AuditParams as AuditParams_V_2_8_2,
+    ModifyWorkflows as ModifyWorkflows_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def suspend_workflows_action(
+    *, 
+    context: Context, 
+    controller_id: str, 
+    workflow_paths: List[str],
+    audit_log: Optional[AuditLog]
+) -> bool:
+
+    if check_matching_version(min="2.6.5", max="2.8.3", check=context.version):
+        request_data = _build_v_2_8_2_request(
+            controller_id=controller_id, 
+            workflow_paths=workflow_paths, 
+            audit_log=audit_log
+        )
+    else:
+        raise RuntimeError(f"Version {context.version} is not compatible with building the request.")
+    
+    # Calls the dispatcher for the matching JOC version
+    result = context.joc_api.dispatch(endpoint_id="workflows/suspend", call=EndpointCall(
+        http_service=context.http_service,
+        access_token=context.auth_provider.login(),
+        payload=request_data,
+        options=None,
+    ))
+    
+    if isinstance(result, OK_V_2_8_2):
+        return bool(result.ok)
+    
+    raise RuntimeError(f"Unexpected response type: {type(result).__name__}")
+
+#---------------------#
+# Build 2.8.2 request #
+#---------------------#
+def _build_v_2_8_2_request(
+    *,
+    controller_id: str,
+    workflow_paths: List[str],
+    audit_log: Optional[AuditLog]
+) -> ModifyWorkflows_V_2_8_2:
+
+    # Validate: controller_id
+    if not controller_id:
+        raise ValueError("'controller_id' is required")
+    
+    # Validate: workflow_paths
+    if not workflow_paths:
+        raise ValueError("At least one workflow path in 'workflow_paths' is required.")
+    
+    # Build: audit_log 
+    res_audit_log = AuditParams_V_2_8_2(
+        ticket_link=audit_log.ticket_link,
+        comment=audit_log.comment,
+        time_spent=audit_log.time_spent
+    ) if audit_log else None
+    
+    # Result
+    return ModifyWorkflows_V_2_8_2(
+        controller_id=controller_id,
+        workflow_paths=workflow_paths,
+        all=False,
+        audit_log=res_audit_log
+    )

js7/client/action/workflow/unskip_job_instructions_action.py

@@ -0,0 +1,83 @@
+from typing import List, Optional
+
+from ...context import Context
+from ....model.public.client.common.audit_log import AuditLog
+from ....model.private.api.endpoint import EndpointCall
+from ....model.private.http.joc.joc_v_2_8_2 import (
+    OK as OK_V_2_8_2,
+    AuditParams as AuditParams_V_2_8_2,
+    ModifyWorkflowLabels as ModifyWorkflowLabels_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def unskip_job_instructions_action(
+    *, 
+    context: Context, 
+    controller_id: str, 
+    workflow_path: str,
+    labels: List[str],
+    audit_log: Optional[AuditLog]
+) -> bool:
+
+    if check_matching_version(min="2.6.5", max="2.8.3", check=context.version):
+        request_data = _build_v_2_8_2_request(
+            controller_id=controller_id, 
+            workflow_path=workflow_path,
+            labels=labels,
+            audit_log=audit_log
+        )
+    else:
+        raise RuntimeError(f"Version {context.version} is not compatible with building the request.")
+    
+    # Calls the dispatcher for the matching JOC version
+    result = context.joc_api.dispatch(endpoint_id="workflow/unskip", call=EndpointCall(
+        http_service=context.http_service,
+        access_token=context.auth_provider.login(),
+        payload=request_data,
+        options=None,
+    ))
+    
+    if isinstance(result, OK_V_2_8_2):
+        return bool(result.ok)
+    
+    raise RuntimeError(f"Unexpected response type: {type(result).__name__}")
+
+#---------------------#
+# Build 2.8.2 request #
+#---------------------#
+def _build_v_2_8_2_request(
+    *,
+    controller_id: str,
+    workflow_path: str,
+    labels: List[str],
+    audit_log: Optional[AuditLog]
+) -> ModifyWorkflowLabels_V_2_8_2:
+
+    # Validate: controller_id
+    if not controller_id:
+        raise ValueError("'controller_id' is required.")
+    
+    # Validate: workflow_path
+    if not workflow_path:
+        raise ValueError("'workflow_path' is required.")
+    
+    # Validate: labels
+    if not labels:
+        raise ValueError("At least one label in 'labels' is required.")
+    
+    # Build: audit_log 
+    res_audit_log = AuditParams_V_2_8_2(
+        ticket_link=audit_log.ticket_link,
+        comment=audit_log.comment,
+        time_spent=audit_log.time_spent
+    ) if audit_log else None
+    
+    # Result
+    return ModifyWorkflowLabels_V_2_8_2(
+        controller_id=controller_id,
+        workflow_path=workflow_path,
+        labels=labels,
+        audit_log=res_audit_log
+    )

js7/client/action/workflow/unstop_job_instructions_action.py

@@ -0,0 +1,79 @@
+from typing import List, Optional
+
+from ...context import Context
+from ....model.public.client.common.audit_log import AuditLog
+from ....model.private.api.endpoint import EndpointCall
+from ....model.private.http.joc.joc_v_2_8_2 import (
+    OK as OK_V_2_8_2,
+    AuditParams as AuditParams_V_2_8_2,
+    ModifyWorkflowPositions as ModifyWorkflowPositions_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def unstop_job_instructions_action(
+    *, 
+    context: Context, 
+    controller_id: str, 
+    workflow_path: str,
+    labels: List[str],
+    audit_log: Optional[AuditLog]
+) -> bool:
+
+    if check_matching_version(min="2.6.5", max="2.8.3", check=context.version):
+        request_data = _build_v_2_8_2_request(
+            controller_id=controller_id, 
+            workflow_path=workflow_path,
+            labels=labels,
+            audit_log=audit_log
+        )
+    else:
+        raise RuntimeError(f"Version {context.version} is not compatible with building the request.")
+    
+    # Calls the dispatcher for the matching JOC version
+    result = context.joc_api.dispatch(endpoint_id="workflow/unstop", call=EndpointCall(
+        http_service=context.http_service,
+        access_token=context.auth_provider.login(),
+        payload=request_data,
+        options=None,
+    ))
+    
+    if isinstance(result, OK_V_2_8_2):
+        return bool(result.ok)
+    
+    raise RuntimeError(f"Unexpected response type: {type(result).__name__}")
+
+#---------------------#
+# Build 2.8.2 request #
+#---------------------#
+def _build_v_2_8_2_request(
+    *,
+    controller_id: str,
+    workflow_path: str,
+    labels: List[str],
+    audit_log: Optional[AuditLog]
+) -> ModifyWorkflowPositions_V_2_8_2:
+
+    # Validate: controller_id
+    if not controller_id:
+        raise ValueError("'controller_id' is required")
+    
+    # Validate: workflow_path
+    if not workflow_path:
+        raise ValueError("'workflow_path' is required")
+    
+    # Build: audit_log 
+    res_audit_log = AuditParams_V_2_8_2(
+        ticket_link=audit_log.ticket_link,
+        comment=audit_log.comment,
+        time_spent=audit_log.time_spent
+    ) if audit_log else None
+    
+    # Result
+    return ModifyWorkflowPositions_V_2_8_2(
+        controller_id=controller_id,
+        workflow_paths=[workflow_path],
+        positions=[label for label in labels], # Type checker trick.
+        audit_log=res_audit_log
+    )

js7/client/auth/auth_provider.py

@@ -0,0 +1,109 @@
+import base64, time
+from typing import Optional
+
+from ...service.http_service import HTTPService
+from ...model.configuration.auth_configuration import AuthConfiguration
+
+from .login import login as login_handler
+from .logout import logout as logout_handler
+
+
+class AuthProvider:
+    def __init__(self, http_service: HTTPService, joc_version: Optional[str]):
+        self._http_service = http_service
+        self._joc_version = joc_version
+        
+        self._auth_cache: Optional[AuthConfiguration] = None
+        self._access_token: Optional[str] = None
+        self._access_token_expires_at: float = 0.0
+
+    def _basic_auth_header(self, username: str, password: str) -> str:
+        if not username or not password:
+            raise ValueError("'username' or 'password' must not be empty.")
+        
+        token = f"{username}:{password}"
+        encoded_token = base64.b64encode(token.encode("utf-8")).decode("ascii")
+        return f"Basic {encoded_token}"
+    
+    def login(self, auth_config: Optional[AuthConfiguration] = None, force_server_login: bool = False) -> str:
+        """Returns the access token"""
+        
+        # Checks whether the access token is still valid
+        if self._access_token and self._access_token_expires_at > time.time():
+            # Returns the cached access token if no forced server login is required
+            if not force_server_login:
+                return self._access_token
+            
+            # Return stored access token if no auth was provided
+            if self._access_token and not auth_config:
+                return self._access_token
+            
+        if not auth_config:
+            self._auth_cache = None
+            raise ValueError("Authentication failed.")
+        
+        # Performs certificate login
+        if auth_config.cert_auth:
+            # Sets cert file paths in server handler
+            self._http_service.auth_certfile_path = auth_config.cert_auth.certfile_path
+            self._http_service.auth_keyfile_path  = auth_config.cert_auth.keyfile_path
+            
+            login_response = login_handler(
+                http_service=self._http_service,
+                basic_auth=None
+            )
+            
+            self._auth_cache = auth_config
+            self._access_token = login_response.access_token
+            
+            if login_response.session_timeout:
+                self._access_token_expires_at = time.time() + login_response.session_timeout / 1000
+            else:
+                self._access_token_expires_at = 0
+            
+            return self._access_token
+        
+        elif auth_config.basic_auth: # Performs username & password login
+            if not auth_config.basic_auth.username or not auth_config.basic_auth.password:
+                raise ValueError("'username' and 'password' are required.")
+            
+            basic_auth_str = self._basic_auth_header(auth_config.basic_auth.username, auth_config.basic_auth.password)
+            
+            login_response = login_handler(
+                http_service=self._http_service,
+                basic_auth=basic_auth_str
+            )
+            
+            self._access_token = login_response.access_token
+            
+            if login_response.session_timeout:
+                self._access_token_expires_at = time.time() + login_response.session_timeout / 1000
+            else:
+                self._access_token_expires_at = 0
+            
+            return self._access_token
+        
+        else:
+            raise RuntimeError("Authentication failed. Neither certificate nor Basic Auth parameters are available.")
+            
+    def logout(self) -> bool:
+        try:
+            access_token = self.login()
+            
+            if not access_token:
+                return False
+            
+            return logout_handler(
+                http_service=self._http_service,
+                access_token=access_token,
+            )
+        except Exception:
+            return False
+        finally:
+            # Always clean up local state
+            self._http_service.close()
+            self._joc_version = None
+            self._logger = None 
+            self._auth_cache = None
+            self._access_token = None
+            self._access_token_expires_at = 0.0

js7/client/auth/login.py

@@ -0,0 +1,34 @@
+from dataclasses import dataclass
+from typing import Optional
+
+
+from ...api.joc.interface.interface import Interface
+from ...service.http_service import HTTPService
+from ...model.private.http.joc.joc_v_2_8_2 import Authentication as Authentication_V_2_8_2
+from ...model.private.api.endpoint import EndpointCall
+
+
+@dataclass
+class LoginResponse:
+    access_token: str
+    session_timeout: Optional[int]
+
+
+def login(*, http_service: HTTPService, basic_auth: Optional[str]) -> LoginResponse:
+    joc_in = Interface(version=None)
+    
+    result = joc_in.dispatch(endpoint_id="authentication/login", call=EndpointCall(
+        http_service=http_service,
+        access_token=None,
+        options={ "basic_auth": basic_auth }
+    ))
+
+    if isinstance(result, Authentication_V_2_8_2):
+        if not result.access_token:
+            raise ValueError("Authentication response does not contain an access token.")
+        
+        if all([result.access_token, result.session_timeout]):
+            return LoginResponse(access_token=result.access_token, session_timeout=result.session_timeout)     
+    
+    raise RuntimeError("Response model is unknown")
+

js7/client/auth/logout.py

@@ -0,0 +1,22 @@
+from ...model.private.api.endpoint import EndpointCall
+from ...service.http_service import HTTPService
+from ...model.private.http.joc.joc_v_2_8_2 import Authentication as Authentication_V_2_8_2
+from ...api.joc.interface.interface import Interface
+
+
+def logout(*, http_service: HTTPService, access_token: str) -> bool:
+    joc_in = Interface(version=None)
+    
+    result = joc_in.dispatch(endpoint_id="authentication/logout", call=EndpointCall(
+        http_service=http_service,
+        access_token=access_token,
+        options=None
+    ))
+        
+    if isinstance(result, Authentication_V_2_8_2):
+        if not result.is_authenticated:
+            return True
+        else:
+            return False
+    
+    raise RuntimeError("Response model is unknown")