Files.com 1.6.514__tar.gz → 1.6.516__tar.gz

{files_com-1.6.514 → files_com-1.6.516}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: files_com
-Version: 1.6.514
+Version: 1.6.516
 Summary: Python bindings for the Files.com API
 License: MIT
 Requires-Python: >=3.5
@@ -865,18 +865,45 @@ except files_sdk.error.Error as err:
 
 ## Mock Server
 
-Files.com publishes a Files.com API server, which is useful for testing your use of the Files.com
+Files.com publishes a mock Files.com API server, which is useful for testing your use of the Files.com
 SDKs and other direct integrations against the Files.com API in an integration test environment.
-
-It is a Ruby app that operates as a minimal server for the purpose of testing basic network
-operations and JSON encoding for your SDK or API client. It does not maintain state and it does not
-deeply inspect your submissions for correctness.
-
-Eventually we will add more features intended for integration testing, such as the ability to
-intentionally provoke errors.
+It never checks credentials: send any placeholder API key, and never use real Files.com credentials
+with it.
+
+The server has two modes, chosen when it starts:
+
+* **Legacy mode** (the default) checks required parameters and parameter types, then returns a fixed
+  example response for each API endpoint. It does not maintain state and it does not deeply inspect
+  your submissions for correctness, which makes it useful for testing basic network operations and
+  JSON encoding for your SDK or API client.
+* **Simulation mode** keeps records, files and folders in memory, so a test can create, list, update
+  and delete resources, upload a file and download the same bytes, and make chosen requests fail,
+  stall or lose their connection on purpose. Requests it does not simulate fail with a clear error
+  instead of returning an example response.
+
+Start the server from its source with Ruby and Bundler. `FILES_MOCK_MODE` is read once at startup:
+leaving it unset or setting it to `legacy` starts legacy mode, `simulation` starts simulation mode,
+and any other value stops startup with an error. Legacy mode listens on port 4041 on all IPv4
+interfaces, and simulation mode on `127.0.0.1:4041`.
+
+Simulation mode keeps its state only in the server process. Its control endpoints under
+`/__files_mock/v1` report when the server is ready, reset it with your fixtures, add fault rules
+and return the journal of the requests it received. It refuses work over its limits instead of
+truncating it. The README in the source describes all of these, the operations it simulates and
+how to configure its limits.
 
 Download the server as a Docker image via [Docker Hub](https://hub.docker.com/r/filescom/files-mock-server).
+The image's `latest` tag moves to whichever server was published last, so it need not include
+simulation mode; to run exactly the server the README describes, build the image from the source.
 
 The Source Code is also available on [GitHub](https://github.com/Files-com/files-mock-server).
 
-A README is available on the GitHub link.
+```shell title="Start the Mock Server"
+bundle install
+
+## Legacy mode
+bundle exec puma
+
+## Simulation mode
+FILES_MOCK_MODE=simulation bundle exec puma
+```

files_com-1.6.514/files_com.egg-info/PKG-INFO → files_com-1.6.516/README.md

@@ -1,15 +1,3 @@
-Metadata-Version: 2.4
-Name: files_com
-Version: 1.6.514
-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.
@@ -865,18 +853,45 @@ except files_sdk.error.Error as err:
 
 ## Mock Server
 
-Files.com publishes a Files.com API server, which is useful for testing your use of the Files.com
+Files.com publishes a mock Files.com API server, which is useful for testing your use of the Files.com
 SDKs and other direct integrations against the Files.com API in an integration test environment.
-
-It is a Ruby app that operates as a minimal server for the purpose of testing basic network
-operations and JSON encoding for your SDK or API client. It does not maintain state and it does not
-deeply inspect your submissions for correctness.
-
-Eventually we will add more features intended for integration testing, such as the ability to
-intentionally provoke errors.
+It never checks credentials: send any placeholder API key, and never use real Files.com credentials
+with it.
+
+The server has two modes, chosen when it starts:
+
+* **Legacy mode** (the default) checks required parameters and parameter types, then returns a fixed
+  example response for each API endpoint. It does not maintain state and it does not deeply inspect
+  your submissions for correctness, which makes it useful for testing basic network operations and
+  JSON encoding for your SDK or API client.
+* **Simulation mode** keeps records, files and folders in memory, so a test can create, list, update
+  and delete resources, upload a file and download the same bytes, and make chosen requests fail,
+  stall or lose their connection on purpose. Requests it does not simulate fail with a clear error
+  instead of returning an example response.
+
+Start the server from its source with Ruby and Bundler. `FILES_MOCK_MODE` is read once at startup:
+leaving it unset or setting it to `legacy` starts legacy mode, `simulation` starts simulation mode,
+and any other value stops startup with an error. Legacy mode listens on port 4041 on all IPv4
+interfaces, and simulation mode on `127.0.0.1:4041`.
+
+Simulation mode keeps its state only in the server process. Its control endpoints under
+`/__files_mock/v1` report when the server is ready, reset it with your fixtures, add fault rules
+and return the journal of the requests it received. It refuses work over its limits instead of
+truncating it. The README in the source describes all of these, the operations it simulates and
+how to configure its limits.
 
 Download the server as a Docker image via [Docker Hub](https://hub.docker.com/r/filescom/files-mock-server).
+The image's `latest` tag moves to whichever server was published last, so it need not include
+simulation mode; to run exactly the server the README describes, build the image from the source.
 
 The Source Code is also available on [GitHub](https://github.com/Files-com/files-mock-server).
 
-A README is available on the GitHub link.
+```shell title="Start the Mock Server"
+bundle install
+
+## Legacy mode
+bundle exec puma
+
+## Simulation mode
+FILES_MOCK_MODE=simulation bundle exec puma
+```

files_com-1.6.516/_VERSION

@@ -0,0 +1 @@
+1.6.516

files_com-1.6.514/README.md → files_com-1.6.516/files_com.egg-info/PKG-INFO

@@ -1,3 +1,15 @@
+Metadata-Version: 2.4
+Name: files_com
+Version: 1.6.516
+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.
@@ -853,18 +865,45 @@ except files_sdk.error.Error as err:
 
 ## Mock Server
 
-Files.com publishes a Files.com API server, which is useful for testing your use of the Files.com
+Files.com publishes a mock Files.com API server, which is useful for testing your use of the Files.com
 SDKs and other direct integrations against the Files.com API in an integration test environment.
-
-It is a Ruby app that operates as a minimal server for the purpose of testing basic network
-operations and JSON encoding for your SDK or API client. It does not maintain state and it does not
-deeply inspect your submissions for correctness.
-
-Eventually we will add more features intended for integration testing, such as the ability to
-intentionally provoke errors.
+It never checks credentials: send any placeholder API key, and never use real Files.com credentials
+with it.
+
+The server has two modes, chosen when it starts:
+
+* **Legacy mode** (the default) checks required parameters and parameter types, then returns a fixed
+  example response for each API endpoint. It does not maintain state and it does not deeply inspect
+  your submissions for correctness, which makes it useful for testing basic network operations and
+  JSON encoding for your SDK or API client.
+* **Simulation mode** keeps records, files and folders in memory, so a test can create, list, update
+  and delete resources, upload a file and download the same bytes, and make chosen requests fail,
+  stall or lose their connection on purpose. Requests it does not simulate fail with a clear error
+  instead of returning an example response.
+
+Start the server from its source with Ruby and Bundler. `FILES_MOCK_MODE` is read once at startup:
+leaving it unset or setting it to `legacy` starts legacy mode, `simulation` starts simulation mode,
+and any other value stops startup with an error. Legacy mode listens on port 4041 on all IPv4
+interfaces, and simulation mode on `127.0.0.1:4041`.
+
+Simulation mode keeps its state only in the server process. Its control endpoints under
+`/__files_mock/v1` report when the server is ready, reset it with your fixtures, add fault rules
+and return the journal of the requests it received. It refuses work over its limits instead of
+truncating it. The README in the source describes all of these, the operations it simulates and
+how to configure its limits.
 
 Download the server as a Docker image via [Docker Hub](https://hub.docker.com/r/filescom/files-mock-server).
+The image's `latest` tag moves to whichever server was published last, so it need not include
+simulation mode; to run exactly the server the README describes, build the image from the source.
 
 The Source Code is also available on [GitHub](https://github.com/Files-com/files-mock-server).
 
-A README is available on the GitHub link.
+```shell title="Start the Mock Server"
+bundle install
+
+## Legacy mode
+bundle exec puma
+
+## Simulation mode
+FILES_MOCK_MODE=simulation bundle exec puma
+```

{files_com-1.6.514 → files_com-1.6.516}/files_sdk/__init__.py

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

{files_com-1.6.514 → files_com-1.6.516}/files_sdk/models/ai_task.py

@@ -237,7 +237,7 @@ class AiTask:
 # Parameters:
 #   cursor - string - Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
 #   per_page - int64 - Number of records to show per page.  (Max: 10000, 1,000 or less is recommended).
-#   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`, `id`, `disabled` or `updated_at`.
+#   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`, `name`, `disabled` or `updated_at`.
 #   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `disabled`, `trigger` or `workspace_id`. Valid field combinations are `[ workspace_id, disabled ]`.
 def list(params=None, options=None):
     if not isinstance(params, dict):

{files_com-1.6.514 → files_com-1.6.516}/files_sdk/models/partner.py

@@ -176,7 +176,7 @@ class Partner:
 # Parameters:
 #   cursor - string - Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
 #   per_page - int64 - Number of records to show per page.  (Max: 10000, 1,000 or less is recommended).
-#   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id` and `id`.
+#   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id` and `name`.
 #   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `workspace_id`.
 def list(params=None, options=None):
     if not isinstance(params, dict):

{files_com-1.6.514 → files_com-1.6.516}/files_sdk/models/user_sftp_client_use.py

@@ -46,6 +46,7 @@ class UserSftpClientUse:
 #   user_id - int64 - User ID. If provided, will return uses for this user.
 #   cursor - string - Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
 #   per_page - int64 - Number of records to show per page.  (Max: 10000, 1,000 or less is recommended).
+#   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`.
 def list(params=None, options=None):
     if not isinstance(params, dict):
         params = {}
@@ -57,6 +58,8 @@ def list(params=None, options=None):
         raise InvalidParameterError("Bad parameter: cursor must be an str")
     if "per_page" in params and not isinstance(params["per_page"], int):
         raise InvalidParameterError("Bad parameter: per_page must be an int")
+    if "sort_by" in params and not isinstance(params["sort_by"], dict):
+        raise InvalidParameterError("Bad parameter: sort_by must be an dict")
     return ListObj(
         UserSftpClientUse, "GET", "/user_sftp_client_uses", params, options
     )

{files_com-1.6.514 → files_com-1.6.516}/pyproject.toml

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

files_com-1.6.514/_VERSION

@@ -1 +0,0 @@
-1.6.514