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

js7/client/action/inventory/import_configurations_action.py

@@ -0,0 +1,153 @@
+from pathlib import Path
+from typing import Any, Dict, List, Literal, Optional, Tuple, Union
+
+from ...client import Context
+from ....model.public.client.common.audit_log import AuditLog
+from ....model.private.http.joc.joc_v_2_8_2 import OK as OK_V_2_8_2
+from ....model.private.api.endpoint import EndpointCall
+
+from ....util.bytes_converter.bytes_to_archive_bytes import bytes_to_archive_bytes
+from ....util.bytes_converter.read_bytes_archive_files_to_bytes import read_bytes_archive_files_to_bytes
+from ....util.bytes_converter.files_to_bytes import files_to_bytes
+from ....util.check_matching_version import check_matching_version
+from ....util.detect_archive_type import detect_archive_type
+
+
+def import_configurations_action(
+    *,
+    context: Context,
+    file_path: Union[Path, str],
+    archive_format: Literal["ZIP", "TAR_GZ"],
+    overwrite: bool,
+    target_folder: Optional[str],
+    suffix: Optional[str],
+    prefix: Optional[str],
+    overwrite_tags: bool,
+    audit_log: Optional[AuditLog]
+) -> bool:
+    
+    if check_matching_version(min="2.6.5", max="2.8.3", check=context.version):
+        options, archive = _build_v_2_8_2_request(
+            file_path=Path(file_path),
+            archive_format=archive_format,
+            overwrite=overwrite,
+            target_folder=target_folder,
+            suffix=suffix,
+            prefix=prefix,
+            overwrite_tags=overwrite_tags,
+            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="inventory/import", call=EndpointCall(
+        http_service=context.http_service,
+        access_token=context.auth_provider.login(),
+        payload=archive,
+        options=options
+    ))
+    
+    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                   #
+# Returns: [Formdata, List of archives] #
+#---------------------------------------#
+def _build_v_2_8_2_request(
+    *,
+    file_path: Path,
+    archive_format: Literal["ZIP", "TAR_GZ"],
+    overwrite: bool,
+    target_folder: Optional[str],
+    suffix: Optional[str],
+    prefix: Optional[str],
+    overwrite_tags: bool,
+    audit_log: Optional[AuditLog]
+) -> Tuple[Dict[str, Any], bytes]:
+    
+    # Validate: file_path
+    if not file_path.exists():
+        raise ValueError(f"File path does not exist: {file_path}")
+    
+    # Validate: archive_format
+    if archive_format not in ("ZIP", "TAR_GZ"):
+        raise ValueError("'archive_format' must be 'ZIP' or 'TAR_GZ'.")
+    
+    # Build: files_as_bytes
+    files_as_bytes = files_to_bytes(
+        file_path=file_path,
+        filter_suffixes=[".json", ".zip", ".tar.gz", ".tgz"]
+    )
+    
+    if not files_as_bytes:
+        raise ValueError(
+            "No matching files found for import. "
+            "Expected: '*.json', '*.zip', '*.tar.gz', '*.tgz'."
+        )
+    
+    # Build: res_files
+    files: List[Tuple[str, bytes]] = []
+    
+    for path, file in files_as_bytes:
+        # Skips invalid filenames
+        if path.rsplit("/", 1)[-1].startswith((".", "_", "-")):
+            continue
+                
+        archive_type = detect_archive_type(file)
+        
+        if not archive_type and path.endswith(".json"):
+            files.append((path, file))
+        else:
+            arch_files = read_bytes_archive_files_to_bytes(
+                file=file, 
+                filter_suffixes=[".json"]
+            )
+            
+            if not arch_files:
+                continue
+            
+            for arch_path, arch_file in arch_files:
+                # Skips invalid filenames
+                if arch_path.rsplit("/", 1)[-1].startswith((".", "_", "-")):
+                    continue
+                
+                # Removes archive suffix
+                path = path.split(".")[0]
+                
+                new_path = path + "/" + arch_path
+                files.append((new_path, arch_file))
+    
+    # Build: res_archive
+    res_archive = bytes_to_archive_bytes(archive_format=archive_format, files=files)
+    
+    # Build: options
+    res_options: Dict[str, Any] = {
+        "format": archive_format,
+        "overwrite": overwrite,
+        "overwrite_tags": overwrite_tags    
+    }
+    
+    if target_folder:
+        res_options["target_folder"] = target_folder
+    
+    if suffix:
+        res_options["suffix"] = suffix
+        
+    if prefix:
+        res_options["prefix"] = prefix
+    
+    # Build: audit_log
+    if audit_log:
+        if audit_log.ticket_link:
+            res_options["audit_log_ticket_link"] = audit_log.ticket_link
+        if audit_log.comment:
+            res_options["audit_log_comment"] = audit_log.comment
+        if audit_log.time_spent:
+            res_options["audit_log_time_spent"] = audit_log.time_spent
+    
+    # Result
+    return res_options, res_archive

js7/client/action/inventory/import_deploy_configurations_action.py

@@ -0,0 +1,188 @@
+from pathlib import Path
+from typing import Any, Dict, List, Literal, Optional, Tuple, Union
+
+from cryptography.hazmat.primitives import hashes, serialization
+from cryptography.hazmat.primitives.asymmetric import rsa, ec
+from cryptography.hazmat.backends import default_backend
+
+from ...client import Context
+from ....model.public.client.common.audit_log import AuditLog
+from ....model.private.http.joc.joc_v_2_8_2 import OK as OK_V_2_8_2
+from ....model.private.api.endpoint import EndpointCall
+
+from ....util.bytes_converter.bytes_to_archive_bytes import bytes_to_archive_bytes
+from ....util.bytes_converter.read_bytes_archive_files_to_bytes import read_bytes_archive_files_to_bytes
+from ....util.bytes_converter.files_to_bytes import files_to_bytes
+from ....util.check_matching_version import check_matching_version
+from ....util.detect_archive_type import detect_archive_type
+from ....util.bytes_converter.sign_to_bytes import sign_to_bytes
+
+
+def import_deploy_configurations_action(
+    *,
+    context: Context,
+    controller_id: str,
+    file_path: Union[Path, str],
+    archive_format: Literal["ZIP", "TAR_GZ"],
+    private_key_file: Union[Path, str],
+    public_key_file: Optional[Union[Path, str]],
+    key_password: Optional[bytes],
+    hash_alg: hashes.HashAlgorithm,
+    audit_log: Optional[AuditLog]
+) -> bool:
+    
+    if check_matching_version(min="2.6.5", max="2.8.3", check=context.version):
+        options, archive = _build_v_2_8_2_request(
+            controller_id=controller_id,
+            file_path=Path(file_path),
+            archive_format=archive_format,
+            private_key_file=Path(private_key_file),
+            public_key_file=Path(public_key_file) if public_key_file else None,
+            key_password=key_password,
+            hash_alg=hash_alg,
+            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="inventory/deployment/import_deploy", call=EndpointCall(
+        http_service=context.http_service,
+        access_token=context.auth_provider.login(),
+        payload=archive,
+        options=options
+    ))
+    
+    if isinstance(result, OK_V_2_8_2):
+        return bool(result.ok)
+    
+    raise RuntimeError(f"Unexpected response type: {type(result).__name__}")
+
+def get_signature_alg(
+    private_key_file: Path,
+    key_password: Optional[bytes],
+    hash_alg: hashes.HashAlgorithm,
+) -> str:
+
+    with open(private_key_file, "rb") as f:
+        key = serialization.load_pem_private_key(
+            f.read(),
+            password=key_password,
+            backend=default_backend(),
+        )
+
+    if isinstance(key, rsa.RSAPrivateKey):
+        key_part = "RSA"
+    elif isinstance(key, ec.EllipticCurvePrivateKey):
+        key_part = "ECDSA"
+    else:
+        raise TypeError("Only RSA and ECDSA private keys are supported")
+
+    return f"{hash_alg.name.upper()}with{key_part}"
+
+#-------------------------------#
+# Build 2.8.2 request           #
+# Returns: [Formdata, Aarchive] #
+#-------------------------------#
+def _build_v_2_8_2_request(
+    *,
+    controller_id: str,
+    file_path: Path,
+    archive_format: Literal["ZIP", "TAR_GZ"],
+    private_key_file: Path,
+    public_key_file: Optional[Path],
+    key_password: Optional[bytes],
+    hash_alg: hashes.HashAlgorithm,
+    audit_log: Optional[AuditLog]
+) -> Tuple[Dict[str, Any], bytes]:
+    
+    # Validate: controller_id
+    if not controller_id:
+        raise ValueError(f"'controller_id' is required.")
+    
+    # Validate: file_path
+    if not file_path.exists():
+        raise ValueError(f"File path does not exist: {file_path}")
+    
+    # Validate: archive_format
+    if archive_format not in ("ZIP", "TAR_GZ"):
+        raise ValueError("'archive_format' must be 'ZIP' or 'TAR_GZ'.")
+    
+    # Build: files_as_bytes
+    files_as_bytes = files_to_bytes(
+        file_path=file_path,
+        filter_suffixes=[".json", ".zip", ".tar.gz", ".tgz"]
+    )
+    
+    if not files_as_bytes:
+        raise ValueError(
+            "No matching files found for import. "
+            "Expected: '*.json', '*.zip', '*.tar.gz', '*.tgz'."
+        )
+    
+    # Build: files
+    files: List[Tuple[str, bytes]] = []
+    
+    for path, file in files_as_bytes:
+        # Skips invalid filenames
+        if path.rsplit("/", 1)[-1].startswith((".", "_", "-")):
+            continue
+                
+        archive_type = detect_archive_type(file)
+        
+        if not archive_type and path.endswith(".json"):
+            files.append((path, file))
+        else:
+            arch_files = read_bytes_archive_files_to_bytes(
+                file=file, 
+                filter_suffixes=[".json"]
+            )
+            
+            if not arch_files:
+                continue
+            
+            for arch_path, arch_file in arch_files:
+                # Skips invalid filenames
+                if arch_path.rsplit("/", 1)[-1].startswith((".", "_", "-")):
+                    continue
+                
+                # Removes archive suffix
+                path = path.split(".")[0]
+                
+                new_path = path + "/" + arch_path
+                files.append((new_path, arch_file))
+    
+    # Build: Signing
+    files.extend(sign_to_bytes(
+        files=files,
+        private_key_file=private_key_file,
+        public_key_file=public_key_file,
+        key_password=key_password,
+        hash_alg=hash_alg
+    ))
+    
+    # Build: res_archive
+    res_archive = bytes_to_archive_bytes(archive_format=archive_format, files=files)
+    
+    # Build: options
+    res_options: Dict[str, Any] = {
+        "controller_id": controller_id,
+        "signature_algorithm": get_signature_alg(
+            private_key_file=private_key_file, 
+            key_password=key_password,
+            hash_alg=hash_alg
+        ),
+        "format": archive_format, 
+    }
+    
+    # Build: audit_log
+    if audit_log:
+        if audit_log.ticket_link:
+            res_options["audit_log_ticket_link"] = audit_log.ticket_link
+        if audit_log.comment:
+            res_options["audit_log_comment"] = audit_log.comment
+        if audit_log.time_spent:
+            res_options["audit_log_time_spent"] = audit_log.time_spent
+    
+    # Result
+    return res_options, res_archive

js7/client/action/inventory/read_from_local_repository_action.py

@@ -0,0 +1,67 @@
+from typing import List, Literal
+
+from ...context import Context
+from ....model.public.client.common.configurations import Configuration
+from ....model.private.api.endpoint import EndpointCall
+from ....model.public.client.enum.object_types import ObjectType
+from ....model.private.http.joc.joc_v_2_8_2 import (
+    ResponseFolder as ResponseFolder_V_2_8_2,
+    ReadFromFilter as ReadFromFilter_V_2_8_2,
+    Category as Category_V_2_8_2,
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def read_from_local_repository_action(
+    *, 
+    context: Context,
+    folder_path: str, 
+    category: Literal["LOCAL", "ROLLOUT"]
+) -> List[Configuration]:
+
+    if check_matching_version(min="2.6.5", max="2.8.3", check=context.version):
+        request_data = _build_v_2_8_2_request(folder_path=folder_path, category=category)
+    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="inventory/repository/read", call=EndpointCall(
+        http_service=context.http_service,
+        access_token=context.auth_provider.login(),
+        payload=request_data,
+        options=None
+    ))
+
+    if isinstance(result, ResponseFolder_V_2_8_2):
+        if not result.items:
+            return []
+        
+        return [
+            Configuration(
+                object_type=ObjectType(item.object_type.value if item.object_type else ""), 
+                path=item.folder or ""
+            )
+            for item in result.items
+        ]
+
+    raise RuntimeError(f"Unexpected response type: {type(result).__name__}")
+
+#---------------------#
+# Build 2.8.2 request #
+#---------------------#
+def _build_v_2_8_2_request(*, folder_path: str, category: Literal["LOCAL", "ROLLOUT"]) -> ReadFromFilter_V_2_8_2:
+    # Validates controller id and category
+    if not folder_path or not category:
+        raise ValueError("'folder_path' and 'category' are required.")
+    
+    # Validate: category
+    if category not in ("LOCAL", "ROLLOUT"):
+        raise ValueError("'category' must be one of 'LOCAL' or 'ROLLOUT'.")
+    
+    # Result
+    return ReadFromFilter_V_2_8_2(
+        folder=folder_path,
+        category=Category_V_2_8_2(category), # Raises ValueError() if invalid.
+        recursive=True
+    )

js7/client/action/inventory/recall_folder_action.py

@@ -0,0 +1,89 @@
+from typing import List, Optional
+
+from ....model.public.client.common.audit_log import AuditLog
+from ....model.public.client.enum.object_types import ReleaseObjectType
+from ...context import Context
+from ....model.private.api.endpoint import EndpointCall
+from ....model.private.http.joc.joc_v_2_8_2 import (
+    CommonConfigurationType as ConfigurationType_V_2_8_2,
+    RequestFolder as RequestFolder_V_2_8_2,
+    AuditParams as AuditParams_V_2_8_2,
+    OK as OK_V_2_8_2,
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def recall_folder_action(
+    *,
+    context: Context,
+    folder_path: str, 
+    filter_object_types: Optional[List[ReleaseObjectType]],
+    filter_no_invalid_objects: bool,
+    recursive: bool,
+    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(
+            folder_path=folder_path,
+            filter_object_types=filter_object_types,
+            filter_no_invalid_objects=filter_no_invalid_objects,
+            recursive=recursive,
+            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="inventory/releasables/recall/folder", 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(
+    *,
+    folder_path: str, 
+    filter_object_types: Optional[List[ReleaseObjectType]],
+    filter_no_invalid_objects: bool,
+    recursive: bool,
+    audit_log: Optional[AuditLog],
+) -> RequestFolder_V_2_8_2:
+    
+    # Validate: folder_path
+    if not folder_path:
+        raise ValueError("'folder_path' must not be empty.")
+
+    # Build: res_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
+     
+    # Build: res_object_types
+    res_object_types = [
+        ConfigurationType_V_2_8_2(obj_type.value)
+        for obj_type in filter_object_types
+    ] if filter_object_types else None
+
+    # Result
+    return RequestFolder_V_2_8_2(
+        controller_id=None,
+        path=folder_path,
+        recursive=recursive,
+        object_types=res_object_types,
+        audit_log=res_audit_log,
+        only_valid_objects=filter_no_invalid_objects,
+        cancel_orders_date_from=None,
+    )

js7/client/action/inventory/recall_released_configuration_action.py

@@ -0,0 +1,75 @@
+from typing import List, Optional
+
+from ...context import Context
+from ....model.public.client.common.configurations import ReleaseConfiguration
+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 (
+    CommonConfigurationType as ConfigurationType_V_2_8_2, 
+    Releasable as Releasable_V_2_8_2, 
+    ReleasableRecallFilter as ReleasableRecallFilter_V_2_8_2, 
+    OK as OK_V_2_8_2,
+    AuditParams as AuditParams_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def recall_released_configurations_action(
+    *,
+    context: Context,
+    configurations: List[ReleaseConfiguration],
+    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(
+            configurations=configurations,
+            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="inventory/releasables/recall", 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(
+    *,
+    configurations: List[ReleaseConfiguration],
+    audit_log: Optional[AuditLog]
+) -> ReleasableRecallFilter_V_2_8_2:
+    
+    # Build: res_releasables
+    res_releasables = [
+        Releasable_V_2_8_2(
+            path=c.path,
+            object_type=ConfigurationType_V_2_8_2(c.object_type.value) # Raises ValueError() if invalid.
+        )
+        for c in configurations
+    ]
+
+    # 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 ReleasableRecallFilter_V_2_8_2(
+        releasables=res_releasables,
+        audit_log=res_audit_log,
+    )

js7/client/action/inventory/release_configuartions_action.py

@@ -0,0 +1,89 @@
+from typing import List, Optional
+
+from ....model.public.client.common.configurations import ReleaseConfiguration
+from ....model.public.client.common.audit_log import AuditLog
+from ...context import Context
+from ....model.private.api.endpoint import EndpointCall
+from ....model.private.http.joc.joc_v_2_8_2 import (
+    CommonConfigurationType as ConfigurationType_V_2_8_2,
+    CommonRequestFilter as CommonRequestFilter_V_2_8_2,
+    AuditParams as AuditParams_V_2_8_2,
+    ReleaseFilter as ReleaseFilter_V_2_8_2,
+    OK as OK_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def release_configuartions_action(
+    *,
+    context: Context,
+    update: Optional[List[ReleaseConfiguration]],
+    delete: Optional[List[ReleaseConfiguration]],
+    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(
+            update=update,
+            delete=delete,
+            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="inventory/release", 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(*, 
+    update: Optional[List[ReleaseConfiguration]],
+    delete: Optional[List[ReleaseConfiguration]],
+    audit_log: Optional[AuditLog]
+) -> ReleaseFilter_V_2_8_2:
+    
+    # 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
+    
+    # Build: Update
+    res_update = [
+        CommonRequestFilter_V_2_8_2(
+            path=u.path,
+            object_type=ConfigurationType_V_2_8_2(u.object_type.value) # Raises ValueError() if invalid.
+        )
+        for u in update
+    ] if update else None
+    
+    # Build: Delete
+    res_delete = [
+        CommonRequestFilter_V_2_8_2(
+            path=d.path,
+            object_type=ConfigurationType_V_2_8_2(d.object_type.value) # Raises ValueError() if invalid.
+        )
+        for d in delete
+    ] if delete else None
+    
+    # Result
+    return ReleaseFilter_V_2_8_2(
+        audit_log=res_audit_log,
+        delete=res_delete,
+        update=res_update,
+        add_orders_date_from=None, 
+        include_late=None,         
+    )