V1.0.7.2

SendSafely-GitHub · SendSafely-GitHub · commit baa09ff825a2 · 2025-01-09T07:48:34.000-06:00
Enhancements to the api
diff --git a/scripts/sendsafely_workspace_example.py b/scripts/sendsafely_workspace_example.py
@@ -0,0 +1,57 @@
+import json
+
+from sendsafely import SendSafely, Package
+
+# Edit these variables
+api_key = ""
+api_secret = ""
+base_url = "https://companyabc.sendsafely.com"
+# Make sure all directories exist on your file system
+upload_file = "fileToUpload.txt"
+download_filename = "fileDownloaded.txt"
+download_dir = "."
+recipient = "user@foobar.com"
+directory_id = ""
+
+def main():
+    sendsafely = SendSafely(base_url, api_key, api_secret)
+    workspace_package = Package(sendsafely, workspace=True)
+    print("Successfully created new workspace " + workspace_package.package_id)
+
+    workspace_package.update_workspace_name("MyWorkspace")
+    print("Successfully updated Workspace name")
+
+    secure_link = base_url + "/receive/?thread=" + workspace_package.package_id + "&packageCode=" + workspace_package.package_code + "#keyCode=" + workspace_package.client_secret
+    print("Secure link is " + secure_link)
+
+    directory_id = workspace_package.create_directory("MyDirectory")["directoryId"]
+    print("Successfully created new directory " + directory_id)
+
+    with open(upload_file, 'wb') as file:
+        content = bytes("SendSafely lets you easily exchange encrypted files and information with anyone on any device.", "utf-8")
+        file.write(content)
+
+    f = workspace_package.encrypt_and_upload_file(upload_file, directory_id=directory_id)
+    file_id = f["fileId"]
+    print("Successfully encrypted and uploaded file id " + str(file_id) + " to " + directory_id)
+
+    workspace_package.add_recipient(recipient)
+    print("Successfully added recipient " + recipient)
+
+    new_directory_id = workspace_package.create_directory("MyNewDirectory")["directoryId"]
+    print("Successfully created new directory " + new_directory_id)
+
+    workspace_package.move_file(file_id, new_directory_id)
+    print("Moved file " + file_id + " to " + new_directory_id + "")
+
+    workspace_package.move_directory(directory_id, new_directory_id)
+    print("Moved directory " + directory_id + " to " + new_directory_id + "")
+
+    workspace_package.download_and_decrypt_file(file_id, directory_id=new_directory_id, download_directory=download_dir, file_name=download_filename)
+    print("Successfully downloaded and decrypted file " + download_filename)
+
+    print("Package Info: ")
+    print(json.dumps(workspace_package.get_info(), indent=4, sort_keys=True))
+
+if __name__ == '__main__':
+    main()
diff --git a/sendsafely/Package.py b/sendsafely/Package.py
@@ -1,6 +1,8 @@
 import json
 import math
 import os
+import re
+
 import requests
 import cryptography
 major, minor, patch = [int(x, 10) for x in cryptography.__version__.split('.')]
@@ -16,7 +18,8 @@
     UploadFileException, DeletePackageException, KeycodeRequiredException, GetPackageInformationFailedException, \
     UploadKeycodeException, AddRecipientFailedException, UpdateRecipientFailedException, UploadMessageException, \
     GetPublicKeysFailedException, GetFileInformationException, DeleteFileException, GetPackageMessageException, \
-    AddFileFailedException
+    AddFileFailedException, MoveFileException, GetDirectoryException, DeleteDirectoryException, \
+    RenameDirectoryException, UpdatePackageException, MoveDirectoryException, CreateDirectoryException
 
 from sendsafely.utilities import _generate_keycode, make_headers, _encrypt_message, _encrypt_file_part, _upload_file_part_to_s3, \
     _calculate_package_checksum, _decrypt_message, _get_upload_urls, _get_download_urls, _update_file_completion_status, _encrypt_keycode, \
@@ -28,7 +31,7 @@ class Package:
     To be used in conjunction with it's handler the SendSafely object. Should not be instantiated directly.
     """
 
-    def __init__(self, sendsafely_instance, package_variables=None):
+    def __init__(self, sendsafely_instance, package_variables=None, workspace=False):
         """
         :param sendsafely_instance: The authenticated SendSafely object.
         :param package_variables:
@@ -39,7 +42,10 @@ def __init__(self, sendsafely_instance, package_variables=None):
         if package_variables is None:
             self.client_secret = _generate_keycode()
             self.sendsafely = sendsafely_instance
-            data = {"vdr": "false"}
+            if workspace:
+                data = {"vdr": "true"}
+            else:
+                data = {"vdr": "false"}
             endpoint = "/package"
             url = self.sendsafely.BASE_URL + endpoint
             headers = make_headers(self.sendsafely.API_SECRET, self.sendsafely.API_KEY, endpoint,
@@ -181,7 +187,7 @@ def encrypt_and_upload_file(self, filepath, directory_id=None, progress_instance
                     progress = progress + 1
                 part = part + 25
             file.close()
-            response = _update_file_completion_status(self, file_id=file_id, complete=True)
+            response = _update_file_completion_status(self, file_id=file_id, directory_id=directory_id, complete=True)
             response["fileId"] = file_id
             return response
         except Exception as e:
@@ -276,17 +282,20 @@ def _add_file(self, filename, filesize, parts=1, directory_id=None):
             raise AddFileFailedException(details=response["message"])
         return response
 
-    def delete_file_from_package(self, file_id):
+    def delete_file_from_package(self, file_id, directory_id=None):
         """
         Deletes the file with the specified id from the package with the specified ID
         """
-        endpoint = "/package/" + self.package_id + "/file/" + file_id
+        if directory_id:
+            endpoint = "/package/" + self.package_id + "/directory/" + directory_id + "/file/" + file_id
+        else:
+            endpoint = "/package/" + self.package_id + "/file/" + file_id
         url = self.sendsafely.BASE_URL + endpoint
         headers = make_headers(self.sendsafely.API_SECRET, self.sendsafely.API_KEY, endpoint)
         try:
             response = requests.delete(url=url, headers=headers).json()
         except Exception as e:
-            raise DeleteFileException(details=e)
+            raise DeleteFileException(details=str(e))
         if response["response"] != "SUCCESS":
             raise DeleteFileException(details=response["message"])
         return response
@@ -315,6 +324,7 @@ def download_and_decrypt_file(self, file_id, directory_id=None, download_directo
         if not file_name:
             file_name = file_info["fileName"]
         total = file_info["fileParts"]
+        file_name = re.sub(r'[<>:\"/\\|?*]', '_', file_name)
         file_path = download_directory + "/" + file_name
         passphrase = self.server_secret + self.client_secret
         progress = 1
@@ -338,6 +348,111 @@ def download_and_decrypt_file(self, file_id, directory_id=None, download_directo
         except Exception as e:
             raise DownloadFileException(details=str(e))
 
+    def update_workspace_name(self, workspace_name):
+        """
+        Rename a Workspace (packageLabel)
+        """
+        endpoint = "/package/" + self.package_id
+        url = self.sendsafely.BASE_URL + endpoint
+        body = {"label": workspace_name}
+        headers = make_headers(self.sendsafely.API_SECRET, self.sendsafely.API_KEY, endpoint, request_body=json.dumps(body))
+        try:
+            response = requests.post(url=url, headers=headers, json=body).json()
+        except Exception as e:
+            raise UpdatePackageException(details=str(e))
+
+        if response["response"] != "SUCCESS":
+            raise UpdatePackageException(details=response["message"])
+        return response
+
+    def move_file(self, file_id, destination_directory_id):
+        """
+        Moves a Workspace file with the specified id to the directory with the specified ID
+        """
+        endpoint = "/package/" + self.package_id + "/directory/" + destination_directory_id + "/file/" + file_id
+        url = self.sendsafely.BASE_URL + endpoint
+        headers = make_headers(self.sendsafely.API_SECRET, self.sendsafely.API_KEY, endpoint)
+        try:
+            response = requests.post(url=url, headers=headers).json()
+        except Exception as e:
+            raise MoveFileException(details=str(e))
+
+        if response["response"] != "SUCCESS":
+            raise MoveFileException(details=response["message"])
+        return response
+
+    def create_directory(self, directory_name, source_directory_id=None):
+        if not source_directory_id:
+            source_directory_id = self.sendsafely.get_package_information(self.package_id)["rootDirectoryId"]
+        endpoint = "/package/" + self.package_id + "/directory/" + source_directory_id + "/subdirectory/"
+        url = self.sendsafely.BASE_URL + endpoint
+        body = {"directoryName": directory_name}
+        headers = make_headers(self.sendsafely.API_SECRET, self.sendsafely.API_KEY, endpoint, request_body=json.dumps(body))
+        try:
+            response = requests.put(url=url, headers=headers, json=body).json()
+        except Exception as e:
+            raise CreateDirectoryException(details=str(e))
+
+        if response["response"] != "SUCCESS":
+            raise CreateDirectoryException(details=response["message"])
+        return response
+
+    def move_directory(self, source_directory_id, target_directory_id):
+        """
+        Moves a Workspace directory with the specified id to the directory with the specified ID
+        """
+        endpoint = "/package/" + self.package_id + "/move/" + source_directory_id + "/" + target_directory_id
+        url = self.sendsafely.BASE_URL + endpoint
+        headers = make_headers(self.sendsafely.API_SECRET, self.sendsafely.API_KEY, endpoint)
+        try:
+            response = requests.post(url=url, headers=headers).json()
+        except Exception as e:
+            raise MoveDirectoryException(details=str(e))
+
+        if response["response"] != "SUCCESS":
+            raise MoveDirectoryException(details=response["message"])
+        return response
+
+    def get_directory_information(self, directory_id):
+        endpoint = "/package/" + self.package_id + "/directory/" + directory_id
+        url = self.sendsafely.BASE_URL + endpoint
+        headers = make_headers(self.sendsafely.API_SECRET, self.sendsafely.API_KEY, endpoint)
+        try:
+            response = requests.get(url=url, headers=headers).json()
+        except Exception as e:
+            raise GetDirectoryException(details=str(e))
+
+        if response["response"] != "SUCCESS":
+            raise GetDirectoryException(details=response["message"])
+        return response
+
+    def delete_directory(self, directory_id):
+        endpoint = "/package/" + self.package_id + "/directory/" + directory_id
+        url = self.sendsafely.BASE_URL + endpoint
+        headers = make_headers(self.sendsafely.API_SECRET, self.sendsafely.API_KEY, endpoint)
+        try:
+            response = requests.delete(url=url, headers=headers).json()
+        except Exception as e:
+            raise DeleteDirectoryException(details=str(e))
+
+        if response["response"] != "SUCCESS":
+            raise DeleteDirectoryException(details=response["message"])
+        return response
+
+    def rename_directory(self, directory_id, directory_name):
+        endpoint = "/package/" + self.package_id + "/directory/" + directory_id
+        url = self.sendsafely.BASE_URL + endpoint
+        body = {"directoryName": directory_name}
+        headers = make_headers(self.sendsafely.API_SECRET, self.sendsafely.API_KEY, endpoint, request_body=json.dumps(body))
+        try:
+            response = requests.post(url, headers=headers, json=body).json()
+        except Exception as e:
+            raise RenameDirectoryException(details=str(e))
+
+        if response["response"] != "SUCCESS":
+            raise RenameDirectoryException(details=response["message"])
+        return response
+
     def _block_operation_without_keycode(self):
         if not self.initialized_via_keycode:
             raise KeycodeRequiredException()
@@ -350,3 +465,4 @@ def calculate_progress(self, file_id, current, total, progress_instance):
         progress_instance.update_progress(file_id, percent)
 
 
+
diff --git a/sendsafely/exceptions.py b/sendsafely/exceptions.py
@@ -21,6 +21,18 @@ def __init__(self, details=None):
         super().__init__(display)
 
 
+class UpdatePackageException(Exception):
+    """Exception raised during package update.
+    """
+    def __init__(self, details=None):
+        self.message = "An error occurred during package update."
+        self.details = details
+        display = self.details
+        if display is None:
+            display = self.message
+        super().__init__(display)
+
+
 class DeletePackageException(Exception):
     """Exception raised during package deletion.
     """
@@ -45,6 +57,30 @@ def __init__(self, details=None):
         super().__init__(display)
 
 
+class DeleteDirectoryException(Exception):
+    """Exception raised during Workspace directory deletion.
+    """
+    def __init__(self, details=None):
+        self.message = "An error occurred during Workspace directory deletion."
+        self.details = details
+        display = self.details
+        if display is None:
+            display = self.message
+        super().__init__(display)
+
+
+class RenameDirectoryException(Exception):
+    """Exception raised while trying to rename a Workspace directory.
+    """
+    def __init__(self, details=None):
+        self.message = "An error occurred while trying to rename a Workspace directory."
+        self.details = details
+        display = self.details
+        if display is None:
+            display = self.message
+        super().__init__(display)
+
+
 class FinalizePackageFailedException(Exception):
     """Exception raised while finalizing package.
     """
@@ -260,3 +296,48 @@ def __init__(self, details=None):
             display = self.message
         super().__init__(display)
 
+
+class MoveFileException(Exception):
+    """Exception that occurs while attempting to move a Workspace file
+    """
+    def __init__(self, details=None):
+        self.message = "An error occurred while attempting to move a Workspace file."
+        self.details = details
+        display = self.details
+        if display is None:
+            display = self.message
+        super().__init__(display)
+
+
+class MoveDirectoryException(Exception):
+    """Exception that occurs while attempting to move a Workspace directory
+    """
+    def __init__(self, details=None):
+        self.message = "An error occurred while attempting to move a Workspace directory."
+        self.details = details
+        display = self.details
+        if display is None:
+            display = self.message
+        super().__init__(display)
+
+class CreateDirectoryException(Exception):
+    """Exception that occurs while creating a Workspace subdirectory
+    """
+    def __init__(self, details=None):
+        self.message = "An error occurred while attempting to create a Workspace directory."
+        self.details = details
+        display = self.details
+        if display is None:
+            display = self.message
+        super().__init__(display)
+
+class GetDirectoryException(Exception):
+    """Exception that occurs while attempting to get Directory information
+    """
+    def __init__(self, details=None):
+        self.message = "An error occurred while getting Directory information."
+        self.details = details
+        display = self.details
+        if display is None:
+            display = self.message
+        super().__init__(display)
diff --git a/sendsafely/utilities.py b/sendsafely/utilities.py
@@ -230,7 +230,7 @@ def _get_upload_urls(package, file_id, part=1):
     return upload_urls
 
 
-def _update_file_completion_status(package, file_id, complete=False):
+def _update_file_completion_status(package, file_id, directory_id=None, complete=False):
     """
     Sets the file upload status as complete, the server will verify if all segments have been uploaded
     :param file_id: The ID (string) of the file we're updating (must be associated with the package_id from previously)
@@ -240,6 +240,8 @@ def _update_file_completion_status(package, file_id, complete=False):
     endpoint = '/package/' + package.package_id + '/file/' + file_id + '/upload-complete'
     url = package.sendsafely.BASE_URL + endpoint
     body = {'complete': complete}
+    if directory_id is not None:
+        body['directoryId'] = directory_id
     headers = make_headers(package.sendsafely.API_SECRET, package.sendsafely.API_KEY, endpoint, request_body=json.dumps(body))
     return requests.post(url=url, json=body, headers=headers).json()
 
diff --git a/setup.py b/setup.py
@@ -2,7 +2,7 @@
 
 setup(
 	name='sendsafely',
-	version='1.0.6',
+	version='1.0.7.2',
 	packages=['sendsafely'],
 	description='The SendSafely Client API allows programmatic access to SendSafely and provides a layer of abstraction from our REST API, which requires developers to perform several complex tasks in a correct manner.',
 	long_description_content_type="text/markdown",
