files.com 1.1.789 → 1.1.791

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9c42c4be41a85eb500534af2a8bfc913f7683435a0769ac8ba2c98049146320
-  data.tar.gz: e091e95f59da16e8f1c29096adf7e41befbb2145fbcb871b31736a8f901858ee
+  metadata.gz: 64bba2627e8f620bf8ead9f5f6aca7bada4416bba947b3614973c15fc5add90c
+  data.tar.gz: f7abd0e2d505f535dd902a692b273c85bcc6a5bd96cc6baba3bbf36bd5eb3bca
 SHA512:
-  metadata.gz: 3a007e57ef79dce41780e1c6b3d36fd2a8387b97a49cbdb3eb1a9c620b5a522772b0a1b8a5fb0501aee64274de1aba1de60a1a1c7c613eafaad31fac326ed435
-  data.tar.gz: 7bae97105effe118f4b4b99d2fba6e5fd1c88e629342e555bbc81649b7a092bcfa1362e062b1ca55517007ca6d699154d54ba8521b2174130f16c9d63bf2c12f
+  metadata.gz: 7c00385eb48e0aa4061b568935a44be82b53556a0f6fd826c8b96d31286cb561d929caa05aa92209342189698698bc415f90782e64239d28f068fdcd03e035a5
+  data.tar.gz: e4e6a231effa2ca3e313b7883c7af756aeff26c82c764cd9e462b59a8a628291e2c98e7b34061fa31970923ea41942fcd49c25d8c79ba21ef332e5bd2085c928

data/README.md

@@ -833,8 +833,8 @@ end
 
 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 never checks credentials: send any placeholder API key, and never use real Files.com credentials
-with it.
+It never checks credentials: send any placeholder API key, such as `YOUR_API_KEY`, and never use
+real Files.com credentials with it.
 
 The server has two modes, chosen when it starts:
 
@@ -847,10 +847,38 @@ The server has two modes, chosen when it starts:
   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`.
+### Quick Start with Docker
+
+With [Docker](https://docs.docker.com/get-docker/) installed, start the published image from
+[Docker Hub](https://hub.docker.com/r/filescom/files-mock-server) with the command shown. It runs
+legacy mode at `http://127.0.0.1:4041`, reachable from your machine only: point your integration's
+Files.com API base URL there and use a placeholder API key. Stop it with Ctrl+C; `--rm` removes its
+container.
+
+The published image is built for `linux/amd64` only, so the command asks for that platform;
+without it, Docker on a machine of another architecture, such as an Apple silicon Mac, looks for
+an image the tag does not have. The `latest` tag moves to whichever server was published last,
+and `--pull=always` fetches it again each time, so it need not include simulation mode. To run
+simulation mode, build the image from the source as below.
+
+```shell title="Start the Mock Server with Docker"
+docker run --platform linux/amd64 --rm --pull=always -p 127.0.0.1:4041:4041 filescom/files-mock-server:latest
+
+## In another terminal, with a placeholder API key:
+curl -H "X-FilesAPI-Key: YOUR_API_KEY" http://127.0.0.1:4041/api/rest/v1/users
+```
+
+### Simulation Mode in Docker
+
+To run exactly the server the source's README describes, simulation mode included, build the image
+from a checkout of the source on [GitHub](https://github.com/Files-com/files-mock-server) and run
+it by the image ID you record with your test results. Only `linux/amd64` builds of the source have
+been checked, so both commands ask for that platform.
+
+Simulation mode listens only on loopback unless told otherwise, so the command binds it to the
+container's interfaces with `-b tcp://0.0.0.0:4041` and publishes the port on your machine's
+loopback address only. `FILES_MOCK_TRANSFER_ORIGIN` tells it the address your tests use, so the
+upload and download URLs it returns point at the published port.
 
 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
@@ -858,13 +886,27 @@ and return the journal of the requests it received. It refuses work over its lim
 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.
+```shell title="Simulation Mode from the Source"
+## In a checkout of the source:
+docker build --platform linux/amd64 -t files-mock-server:local .
+image=$(docker image inspect --format '{{.Id}}' files-mock-server:local)
+echo "$image"   # record this ID with your test results
+docker run --platform linux/amd64 --rm -e FILES_MOCK_MODE=simulation \
+  -e FILES_MOCK_TRANSFER_ORIGIN=http://127.0.0.1:40410 \
+  -p 127.0.0.1:40410:4041 "$image" -b tcp://0.0.0.0:4041
+
+## In another terminal:
+curl http://127.0.0.1:40410/__files_mock/v1/ready
+```
+
+### From the Source with Ruby
 
-The Source Code is also available on [GitHub](https://github.com/Files-com/files-mock-server).
+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`.
 
-```shell title="Start the Mock Server"
+```shell title="Start the Mock Server with Ruby"
 bundle install
 
 ## Legacy mode

data/_VERSION

@@ -1 +1 @@
-1.1.789
+1.1.791

data/spec/models/folder_spec.rb

@@ -31,7 +31,7 @@ RSpec.describe Files::Folder, :with_test_folder do
     end
   end
 
-  xdescribe "mkdir" do
+  describe "mkdir" do
     it "makes a new folder" do
       Files::Folder.mkdir(test_folder.join("my-new-folder").to_s, {}, options)
       expect(Files::Folder.exist?(test_folder.join("my-new-folder").to_s, options)).to eq(true)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.1.789
+  version: 1.1.791
 platform: ruby
 authors:
 - files.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2026-10-13 00:00:00.000000000 Z
+date: 2026-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable