Files.com 1.6.393__tar.gz → 1.6.394__tar.gz

{files_com-1.6.393/files_com.egg-info → files_com-1.6.394}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: files_com
-Version: 1.6.393
+Version: 1.6.394
 Summary: Python bindings for the Files.com API
 License: MIT
 Requires-Python: >=3.5

files_com-1.6.394/_VERSION

@@ -0,0 +1 @@
+1.6.394

{files_com-1.6.393 → files_com-1.6.394/files_com.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: files_com
-Version: 1.6.393
+Version: 1.6.394
 Summary: Python bindings for the Files.com API
 License: MIT
 Requires-Python: >=3.5

{files_com-1.6.393 → files_com-1.6.394}/files_sdk/__init__.py

@@ -288,7 +288,7 @@ source_ip = None
 workspace_id = None
 base_url = "https://app.files.com"
 base_path = "api/rest/v1"
-version = "1.6.393"
+version = "1.6.394"
 
 __version__ = version
 

{files_com-1.6.393 → files_com-1.6.394}/files_sdk/models/file.py

@@ -398,6 +398,110 @@ class File:
         )
         return response.data
 
+    # Decrypt a GPG-encrypted file and save it to a destination path
+    #
+    # Parameters:
+    #   destination (required) - string - Destination file path for the decrypted file.
+    #   gpg_key_ids - array(int64) - GPG Key IDs to decrypt with. If omitted, every accessible private GPG key in the source workspace is used.
+    #   gpg_key_partner_id - int64 - Partner ID whose GPG keys should be used for decryption.
+    #   use_all_private_keys - boolean - Use every accessible private GPG key in the source workspace for decryption.
+    #   ignore_mdc_error - boolean - Ignore errors from the MDC (modification detection code) check.
+    #   overwrite - boolean - Overwrite existing file in the destination?
+    def gpg_decrypt(self, params=None):
+        if not isinstance(params, dict):
+            params = {}
+
+        if hasattr(self, "path") and self.path:
+            params["path"] = self.path
+        else:
+            raise MissingParameterError("Current object doesn't have a path")
+        if "path" not in params:
+            raise MissingParameterError("Parameter missing: path")
+        if "destination" not in params:
+            raise MissingParameterError("Parameter missing: destination")
+        if "path" in params and not isinstance(params["path"], str):
+            raise InvalidParameterError("Bad parameter: path must be an str")
+        if "destination" in params and not isinstance(
+            params["destination"], str
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: destination must be an str"
+            )
+        if "gpg_key_ids" in params and not isinstance(
+            params["gpg_key_ids"], builtins.list
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: gpg_key_ids must be an list"
+            )
+        if "gpg_key_partner_id" in params and not isinstance(
+            params["gpg_key_partner_id"], int
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: gpg_key_partner_id must be an int"
+            )
+        response, _options = Api.send_request(
+            "POST",
+            "/file_actions/gpg_decrypt/{path}".format(path=params["path"]),
+            params,
+            self.options,
+        )
+        return response.data
+
+    # Encrypt a file with GPG and save it to a destination path
+    #
+    # Parameters:
+    #   destination (required) - string - Destination file path for the encrypted file.
+    #   gpg_key_ids - array(int64) - GPG Key IDs to encrypt with.
+    #   gpg_key_partner_id - int64 - Partner ID whose GPG keys should be used for encryption.
+    #   signing_key_id - int64 - Optional GPG Key ID to sign with.
+    #   armor - boolean - Output ASCII-armored encrypted data.
+    #   overwrite - boolean - Overwrite existing file in the destination?
+    def gpg_encrypt(self, params=None):
+        if not isinstance(params, dict):
+            params = {}
+
+        if hasattr(self, "path") and self.path:
+            params["path"] = self.path
+        else:
+            raise MissingParameterError("Current object doesn't have a path")
+        if "path" not in params:
+            raise MissingParameterError("Parameter missing: path")
+        if "destination" not in params:
+            raise MissingParameterError("Parameter missing: destination")
+        if "path" in params and not isinstance(params["path"], str):
+            raise InvalidParameterError("Bad parameter: path must be an str")
+        if "destination" in params and not isinstance(
+            params["destination"], str
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: destination must be an str"
+            )
+        if "gpg_key_ids" in params and not isinstance(
+            params["gpg_key_ids"], builtins.list
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: gpg_key_ids must be an list"
+            )
+        if "gpg_key_partner_id" in params and not isinstance(
+            params["gpg_key_partner_id"], int
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: gpg_key_partner_id must be an int"
+            )
+        if "signing_key_id" in params and not isinstance(
+            params["signing_key_id"], int
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: signing_key_id must be an int"
+            )
+        response, _options = Api.send_request(
+            "POST",
+            "/file_actions/gpg_encrypt/{path}".format(path=params["path"]),
+            params,
+            self.options,
+        )
+        return response.data
+
     # Extract a ZIP file to a destination folder
     #
     # Parameters:
@@ -805,6 +909,122 @@ def move(path, params=None, options=None):
     return FileAction(response.data, options)
 
 
+# Decrypt a GPG-encrypted file and save it to a destination path
+#
+# Parameters:
+#   destination (required) - string - Destination file path for the decrypted file.
+#   gpg_key_ids - array(int64) - GPG Key IDs to decrypt with. If omitted, every accessible private GPG key in the source workspace is used.
+#   gpg_key_partner_id - int64 - Partner ID whose GPG keys should be used for decryption.
+#   use_all_private_keys - boolean - Use every accessible private GPG key in the source workspace for decryption.
+#   ignore_mdc_error - boolean - Ignore errors from the MDC (modification detection code) check.
+#   overwrite - boolean - Overwrite existing file in the destination?
+def gpg_decrypt(path, params=None, options=None):
+    if not isinstance(params, dict):
+        params = {}
+    if not isinstance(options, dict):
+        options = {}
+    params["path"] = path
+    if "path" in params and not isinstance(params["path"], str):
+        raise InvalidParameterError("Bad parameter: path must be an str")
+    if "destination" in params and not isinstance(params["destination"], str):
+        raise InvalidParameterError(
+            "Bad parameter: destination must be an str"
+        )
+    if "gpg_key_ids" in params and not isinstance(
+        params["gpg_key_ids"], builtins.list
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: gpg_key_ids must be an list"
+        )
+    if "gpg_key_partner_id" in params and not isinstance(
+        params["gpg_key_partner_id"], int
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: gpg_key_partner_id must be an int"
+        )
+    if "use_all_private_keys" in params and not isinstance(
+        params["use_all_private_keys"], bool
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: use_all_private_keys must be an bool"
+        )
+    if "ignore_mdc_error" in params and not isinstance(
+        params["ignore_mdc_error"], bool
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: ignore_mdc_error must be an bool"
+        )
+    if "overwrite" in params and not isinstance(params["overwrite"], bool):
+        raise InvalidParameterError("Bad parameter: overwrite must be an bool")
+    if "path" not in params:
+        raise MissingParameterError("Parameter missing: path")
+    if "destination" not in params:
+        raise MissingParameterError("Parameter missing: destination")
+    response, options = Api.send_request(
+        "POST",
+        "/file_actions/gpg_decrypt/{path}".format(path=params["path"]),
+        params,
+        options,
+    )
+    return FileAction(response.data, options)
+
+
+# Encrypt a file with GPG and save it to a destination path
+#
+# Parameters:
+#   destination (required) - string - Destination file path for the encrypted file.
+#   gpg_key_ids - array(int64) - GPG Key IDs to encrypt with.
+#   gpg_key_partner_id - int64 - Partner ID whose GPG keys should be used for encryption.
+#   signing_key_id - int64 - Optional GPG Key ID to sign with.
+#   armor - boolean - Output ASCII-armored encrypted data.
+#   overwrite - boolean - Overwrite existing file in the destination?
+def gpg_encrypt(path, params=None, options=None):
+    if not isinstance(params, dict):
+        params = {}
+    if not isinstance(options, dict):
+        options = {}
+    params["path"] = path
+    if "path" in params and not isinstance(params["path"], str):
+        raise InvalidParameterError("Bad parameter: path must be an str")
+    if "destination" in params and not isinstance(params["destination"], str):
+        raise InvalidParameterError(
+            "Bad parameter: destination must be an str"
+        )
+    if "gpg_key_ids" in params and not isinstance(
+        params["gpg_key_ids"], builtins.list
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: gpg_key_ids must be an list"
+        )
+    if "gpg_key_partner_id" in params and not isinstance(
+        params["gpg_key_partner_id"], int
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: gpg_key_partner_id must be an int"
+        )
+    if "signing_key_id" in params and not isinstance(
+        params["signing_key_id"], int
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: signing_key_id must be an int"
+        )
+    if "armor" in params and not isinstance(params["armor"], bool):
+        raise InvalidParameterError("Bad parameter: armor must be an bool")
+    if "overwrite" in params and not isinstance(params["overwrite"], bool):
+        raise InvalidParameterError("Bad parameter: overwrite must be an bool")
+    if "path" not in params:
+        raise MissingParameterError("Parameter missing: path")
+    if "destination" not in params:
+        raise MissingParameterError("Parameter missing: destination")
+    response, options = Api.send_request(
+        "POST",
+        "/file_actions/gpg_encrypt/{path}".format(path=params["path"]),
+        params,
+        options,
+    )
+    return FileAction(response.data, options)
+
+
 # Extract a ZIP file to a destination folder
 #
 # Parameters:

{files_com-1.6.393 → files_com-1.6.394}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "files_com"
-version = "1.6.393"
+version = "1.6.394"
 description = "Python bindings for the Files.com API"
 readme = "README.md"
 license = { text = "MIT" }

{files_com-1.6.393 → files_com-1.6.394}/tests/test_file.py

@@ -61,6 +61,24 @@ class FileTest(TestBase):
         file = File(params)
         file.move(params)
 
+    @unittest.skipUnless(TestBase.mock_server_path_exists("POST", "/file_actions/gpg_decrypt/{path}"), "Mock path does not exist")
+    def test_gpg_decrypt(self):
+        params = {
+            "path" : "foo",
+            "destination" : "foo",
+        }
+        file = File(params)
+        file.gpg_decrypt(params)
+
+    @unittest.skipUnless(TestBase.mock_server_path_exists("POST", "/file_actions/gpg_encrypt/{path}"), "Mock path does not exist")
+    def test_gpg_encrypt(self):
+        params = {
+            "path" : "foo",
+            "destination" : "foo",
+        }
+        file = File(params)
+        file.gpg_encrypt(params)
+
     @unittest.skipUnless(TestBase.mock_server_path_exists("POST", "/file_actions/unzip"), "Mock path does not exist")
     def test_unzip(self):
         params = {
@@ -146,6 +164,24 @@ class FileTest(TestBase):
         }
         file.move(path, params)
 
+    @unittest.skipUnless(TestBase.mock_server_path_exists("POST", "/file_actions/gpg_decrypt/{path}"), "Mock path does not exist")
+    def test_gpg_decrypt(self):
+        path = "foo"
+        params = {
+            "path" : "foo",
+            "destination" : "foo",
+        }
+        file.gpg_decrypt(path, params)
+
+    @unittest.skipUnless(TestBase.mock_server_path_exists("POST", "/file_actions/gpg_encrypt/{path}"), "Mock path does not exist")
+    def test_gpg_encrypt(self):
+        path = "foo"
+        params = {
+            "path" : "foo",
+            "destination" : "foo",
+        }
+        file.gpg_encrypt(path, params)
+
     @unittest.skipUnless(TestBase.mock_server_path_exists("POST", "/file_actions/unzip"), "Mock path does not exist")
     def test_unzip(self):
         path = "foo"

files_com-1.6.393/_VERSION

@@ -1 +0,0 @@
-1.6.393