Files.com 1.6.391__tar.gz → 1.6.392__tar.gz

files_com-1.6.391/README.md → files_com-1.6.392/PKG-INFO

@@ -1,3 +1,15 @@
+Metadata-Version: 2.4
+Name: files_com
+Version: 1.6.392
+Summary: Python bindings for the Files.com API
+License: MIT
+Requires-Python: >=3.5
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.20
+Requires-Dist: requests-toolbelt>=1.0.0
+Dynamic: license-file
+
 # Files.com Python Client
 
 The Files.com Python Client provides a direct, high performance integration to Files.com from applications written in Python.
@@ -444,32 +456,16 @@ A Workspace is a lightweight way to organize related resources inside a single F
 Customers commonly group resources by project, department, client, or region. Workspaces provide a built-in structure for that grouping, so the UI can operate within a clear "workspace context" and admins can delegate management for a subset of resources without requiring full site-level isolation.
 
 Every Site has an implicit Default workspace (ID `0`). Resources that are not explicitly assigned to a named workspace are considered part of the Default workspace.
-<div></div>
-
-### SDK Support
 
-We are still in the process of adding Workspaces support to each SDK. If you require Workspaces support right now, you need to use the REST API or the CLI.
-<div></div>
-
-### Using Workspaces with the REST API
+The Files.com Python SDK supports workspace scoping by using the `files_sdk.set_workspace_id` configuration method. Scope a single request by passing `workspace_id` in the request options.
+```python title="Example Request"
+import files_sdk
 
-To use Workspaces with the REST API, send the following request header:
+files_sdk.set_workspace_id(123)
 
-```http
-X-Files-Workspace-Id: <workspace_id>
+files_sdk.folder.list_for("", {}, {"workspace_id": 456})
 ```
 
-This changes path mapping and "what you're looking at."
-
-When the `X-Files-Workspace-Id` header is provided:
-
-- List, show, update, and delete operations are constrained to that workspace for workspace-scoped models.
-- Create operations default `workspace_id` to the scoped workspace when not explicitly provided.
-- Attempts to provide a mismatching `workspace_id` are rejected with `not-authorized/insufficient-permission-for-params`.
-
-This header only works for sitewide keys, or keys related to users with permissions to more than one workspace.
-<div></div>
-
 ## Foreign Language Support
 
 The Files.com Python SDK supports localized responses by using the `files_sdk.set_language` configuration method.

files_com-1.6.391/PKG-INFO → files_com-1.6.392/README.md

@@ -1,15 +1,3 @@
-Metadata-Version: 2.4
-Name: files_com
-Version: 1.6.391
-Summary: Python bindings for the Files.com API
-License: MIT
-Requires-Python: >=3.5
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: requests>=2.20
-Requires-Dist: requests-toolbelt>=1.0.0
-Dynamic: license-file
-
 # Files.com Python Client
 
 The Files.com Python Client provides a direct, high performance integration to Files.com from applications written in Python.
@@ -456,32 +444,16 @@ A Workspace is a lightweight way to organize related resources inside a single F
 Customers commonly group resources by project, department, client, or region. Workspaces provide a built-in structure for that grouping, so the UI can operate within a clear "workspace context" and admins can delegate management for a subset of resources without requiring full site-level isolation.
 
 Every Site has an implicit Default workspace (ID `0`). Resources that are not explicitly assigned to a named workspace are considered part of the Default workspace.
-<div></div>
-
-### SDK Support
 
-We are still in the process of adding Workspaces support to each SDK. If you require Workspaces support right now, you need to use the REST API or the CLI.
-<div></div>
-
-### Using Workspaces with the REST API
+The Files.com Python SDK supports workspace scoping by using the `files_sdk.set_workspace_id` configuration method. Scope a single request by passing `workspace_id` in the request options.
+```python title="Example Request"
+import files_sdk
 
-To use Workspaces with the REST API, send the following request header:
+files_sdk.set_workspace_id(123)
 
-```http
-X-Files-Workspace-Id: <workspace_id>
+files_sdk.folder.list_for("", {}, {"workspace_id": 456})
 ```
 
-This changes path mapping and "what you're looking at."
-
-When the `X-Files-Workspace-Id` header is provided:
-
-- List, show, update, and delete operations are constrained to that workspace for workspace-scoped models.
-- Create operations default `workspace_id` to the scoped workspace when not explicitly provided.
-- Attempts to provide a mismatching `workspace_id` are rejected with `not-authorized/insufficient-permission-for-params`.
-
-This header only works for sitewide keys, or keys related to users with permissions to more than one workspace.
-<div></div>
-
 ## Foreign Language Support
 
 The Files.com Python SDK supports localized responses by using the `files_sdk.set_language` configuration method.

files_com-1.6.392/_VERSION

@@ -0,0 +1 @@
+1.6.392

{files_com-1.6.391 → files_com-1.6.392}/files_com.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: files_com
-Version: 1.6.391
+Version: 1.6.392
 Summary: Python bindings for the Files.com API
 License: MIT
 Requires-Python: >=3.5
@@ -456,32 +456,16 @@ A Workspace is a lightweight way to organize related resources inside a single F
 Customers commonly group resources by project, department, client, or region. Workspaces provide a built-in structure for that grouping, so the UI can operate within a clear "workspace context" and admins can delegate management for a subset of resources without requiring full site-level isolation.
 
 Every Site has an implicit Default workspace (ID `0`). Resources that are not explicitly assigned to a named workspace are considered part of the Default workspace.
-<div></div>
-
-### SDK Support
-
-We are still in the process of adding Workspaces support to each SDK. If you require Workspaces support right now, you need to use the REST API or the CLI.
-<div></div>
 
-### Using Workspaces with the REST API
+The Files.com Python SDK supports workspace scoping by using the `files_sdk.set_workspace_id` configuration method. Scope a single request by passing `workspace_id` in the request options.
+```python title="Example Request"
+import files_sdk
 
-To use Workspaces with the REST API, send the following request header:
+files_sdk.set_workspace_id(123)
 
-```http
-X-Files-Workspace-Id: <workspace_id>
+files_sdk.folder.list_for("", {}, {"workspace_id": 456})
 ```
 
-This changes path mapping and "what you're looking at."
-
-When the `X-Files-Workspace-Id` header is provided:
-
-- List, show, update, and delete operations are constrained to that workspace for workspace-scoped models.
-- Create operations default `workspace_id` to the scoped workspace when not explicitly provided.
-- Attempts to provide a mismatching `workspace_id` are rejected with `not-authorized/insufficient-permission-for-params`.
-
-This header only works for sitewide keys, or keys related to users with permissions to more than one workspace.
-<div></div>
-
 ## Foreign Language Support
 
 The Files.com Python SDK supports localized responses by using the `files_sdk.set_language` configuration method.

{files_com-1.6.391 → files_com-1.6.392}/files_com.egg-info/SOURCES.txt

@@ -281,4 +281,5 @@ tests/test_user_sftp_client_use.py
 tests/test_web_dav_action_log.py
 tests/test_webhook_test.py
 tests/test_workspace.py
+tests/test_workspace_id.py
 tests/test_zip_list_entry.py

{files_com-1.6.391 → files_com-1.6.392}/files_sdk/__init__.py

@@ -283,9 +283,10 @@ the_api_key = ""
 language = None
 session_id = None
 source_ip = None
+workspace_id = None
 base_url = "https://app.files.com"
 base_path = "api/rest/v1"
-version = "1.6.391"
+version = "1.6.392"
 
 __version__ = version
 
@@ -297,7 +298,14 @@ max_network_retries = 3
 
 console_log_level = "none"
 
-OPTS = ("api_key", "client", "session_id", "source_ip", "language")
+OPTS = (
+    "api_key",
+    "client",
+    "session_id",
+    "source_ip",
+    "language",
+    "workspace_id",
+)
 
 
 def set_api_key(_api_key):
@@ -320,6 +328,16 @@ def get_language():
     return language
 
 
+def set_workspace_id(_workspace_id):
+    global workspace_id
+    workspace_id = _workspace_id
+
+
+def get_workspace_id():
+    global workspace_id
+    return workspace_id
+
+
 def set_session(_session):
     if not _session.id:
         _session.save()

{files_com-1.6.391 → files_com-1.6.392}/files_sdk/api.py

@@ -24,6 +24,7 @@ class Api:
         api_key = headers.pop("api_key", None)
         session_id = headers.pop("session_id", None)
         language = headers.pop("language", None)
+        workspace_id = headers.pop("workspace_id", None)
 
         session = headers.pop("session", None)
         if session:
@@ -37,6 +38,7 @@ class Api:
             api_key=api_key,
             session_id=session_id,
             language=language,
+            workspace_id=workspace_id,
             params=params,
         )
 

{files_com-1.6.391 → files_com-1.6.392}/files_sdk/api_client.py

@@ -50,6 +50,7 @@ class ApiClient:
         api_key=None,
         session_id=None,
         language=None,
+        workspace_id=None,
         headers=None,
         params=None,
     ):
@@ -71,9 +72,14 @@ class ApiClient:
         if files_sdk.language:
             language = files_sdk.language
 
+        if workspace_id is None:
+            workspace_id = files_sdk.get_workspace_id()
+
         headers = {
             **headers,
-            **self.request_headers(api_key, session_id, language),
+            **self.request_headers(
+                api_key, session_id, language, workspace_id
+            ),
         }
 
         def _serialize_value(value):
@@ -204,7 +210,7 @@ class ApiClient:
         sleep_seconds *= 0.5 * (1 + random.random())
         return max(files_sdk.initial_network_retry_delay, sleep_seconds)
 
-    def request_headers(self, api_key, session_id, language):
+    def request_headers(self, api_key, session_id, language, workspace_id):
         user_agent = "Files.com Python SDK v{version}".format(
             version=files_sdk.version
         )
@@ -220,6 +226,8 @@ class ApiClient:
             headers["X-FilesAPI-Auth"] = session_id
         if language:
             headers["Accept-Language"] = language
+        if workspace_id is not None and workspace_id != "":
+            headers["X-Files-Workspace-Id"] = str(workspace_id)
 
         return headers
 

{files_com-1.6.391 → files_com-1.6.392}/pyproject.toml

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

files_com-1.6.392/tests/test_workspace_id.py

@@ -0,0 +1,90 @@
+import unittest
+from unittest.mock import patch
+
+import files_sdk
+import requests
+from files_sdk.api import Api
+from files_sdk.api_client import ApiClient
+
+
+class TestWorkspaceId(unittest.TestCase):
+    def setUp(self):
+        super().setUp()
+        files_sdk.set_api_key("testkey")
+        files_sdk.set_workspace_id(None)
+
+    def test_request_headers_include_configured_workspace_id(self):
+        files_sdk.set_workspace_id(123)
+        client = ApiClient()
+        response = requests.Response()
+        response.status_code = 204
+
+        with patch.object(
+            client, "execute_request_with_auto_retry", return_value=response
+        ) as mock_execute:
+            client.send_request(
+                "GET", "/folders", api_key="testkey", params={}
+            )
+
+        request = mock_execute.call_args[0][0]
+        self.assertEqual(request.headers["X-Files-Workspace-Id"], "123")
+
+    def test_per_call_workspace_id_overrides_configured_workspace_id(self):
+        files_sdk.set_workspace_id(123)
+        client = ApiClient()
+        response = requests.Response()
+        response.status_code = 204
+
+        with patch.object(
+            client, "execute_request_with_auto_retry", return_value=response
+        ) as mock_execute:
+            client.send_request(
+                "GET",
+                "/folders",
+                api_key="testkey",
+                workspace_id=456,
+                params={},
+            )
+
+        request = mock_execute.call_args[0][0]
+        self.assertEqual(request.headers["X-Files-Workspace-Id"], "456")
+
+    def test_request_headers_omit_workspace_id_when_unset(self):
+        client = ApiClient()
+        response = requests.Response()
+        response.status_code = 204
+
+        with patch.object(
+            client, "execute_request_with_auto_retry", return_value=response
+        ) as mock_execute:
+            client.send_request(
+                "GET", "/folders", api_key="testkey", params={}
+            )
+
+        request = mock_execute.call_args[0][0]
+        self.assertNotIn("X-Files-Workspace-Id", request.headers)
+
+    def test_per_call_options_pass_workspace_id_to_api_client(self):
+        with patch.object(Api, "client") as mock_client:
+            response = requests.Response()
+            mock_client.return_value.send_request.return_value = response
+
+            actual_response, options = Api.send_request(
+                "GET", "/folders", {}, {"workspace_id": 456}
+            )
+
+        self.assertEqual(actual_response, response)
+        self.assertEqual(options["workspace_id"], 456)
+        mock_client.return_value.send_request.assert_called_once_with(
+            "GET",
+            "/folders",
+            api_key=None,
+            session_id=None,
+            language=None,
+            workspace_id=456,
+            params={},
+        )
+
+
+if __name__ == "__main__":
+    unittest.main()

files_com-1.6.391/_VERSION

@@ -1 +0,0 @@
-1.6.391