files.com 1.1.647 → 1.1.649

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a9039a7054a6c0d9d48c3079e135a0172e430eb301878cdfebde9dce183c5fc
-  data.tar.gz: 4b316018052171a078451a0eaa3c9e5608829c8f700269e76ddb40c51d9f48d8
+  metadata.gz: f762883ff6e320131d7226422ae25f1800e1fbe172e47364e4af6551a32545a0
+  data.tar.gz: 2869f62037e0932d98f81023013b9ed08f180cba307a137f5b6fad728dbd2f65
 SHA512:
-  metadata.gz: 4f769a4ae46c896209ff33c9303b47639d28b33145e7d36e863a898f9dcd4d554dad058854d54df357af3c585e3ebaabe531c188f04d637a62326f020c7d4d09
-  data.tar.gz: 1d33bd48df21b62ae715d54ed611d69ec5bda31534b7a22adc8c178b50a6a62c6b81ed6ef2f6c94d6b2a7f6bb20872037869e09ed3965a84d29de8162a833b96
+  metadata.gz: 826dc59eaa2592234e807c00d047e4323efb3a1dc6c511413b349ebe4a78b385a8dbeb6d4733eb8a9000bbf280a7ac94f5cf764c4a5f72bf399f4a7b1a3530b7
+  data.tar.gz: db29182d2dee5cf4c7896f84521e9a0b79bb2a6ef42bf0ada476d7d2407bd5d36faa3fa0bed0bf4ed7fd2f9322621c4be49c27da103b25540f431641750c7e8d

data/README.md

@@ -405,32 +405,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 Ruby SDK supports workspace scoping by using the `Files.workspace_id` configuration attribute. Scope a single request by passing `workspace_id` in the request options.
+```ruby title="Example Request"
+require "files.com"
 
-To use Workspaces with the REST API, send the following request header:
+Files.workspace_id = 123
 
-```http
-X-Files-Workspace-Id: <workspace_id>
+Files::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 Ruby SDK supports localized responses by using the `Files.language` configuration attribute.

data/_VERSION

@@ -1 +1 @@
-1.1.647
+1.1.649

data/lib/files.com/api.rb

@@ -11,13 +11,14 @@ module Files
       api_key = headers.delete(:api_key)
       client = headers.delete(:client)
       session_id = headers.delete(:session_id)
+      workspace_id = headers.delete(:workspace_id)
       if session = headers.delete(:session)
         session.save unless session.id
         session_id = session.id
       end
 
       resp, options[:api_key], options[:session_id] = client.execute_request(
-        verb, path, api_key: api_key, headers: headers, params: params, session_id: session_id
+        verb, path, api_key: api_key, headers: headers, params: params, session_id: session_id, workspace_id: workspace_id
       )
 
       # Hash#select returns an array before 1.9

data/lib/files.com/api_client.rb

@@ -93,9 +93,10 @@ module Files
       end
     end
 
-    def execute_request(method, path, base_url: nil, api_key: nil, session_id: nil, headers: {}, params: {})
+    def execute_request(method, path, base_url: nil, api_key: nil, session_id: nil, workspace_id: nil, headers: {}, params: {})
       base_url ||= Files.base_url
       session_id ||= Files.session_id
+      workspace_id = Files.workspace_id if workspace_id.nil?
 
       if session_id and session_id != ""
         check_session_id!(session_id)
@@ -113,7 +114,7 @@ module Files
         body = params
       end
 
-      headers = request_headers(api_key, session_id, method).update(headers)
+      headers = request_headers(api_key, session_id, method, workspace_id).update(headers)
       url = api_url(path, base_url)
 
       context = RequestLogContext.new
@@ -315,7 +316,7 @@ module Files
       raise APIConnectionError, message
     end
 
-    private def request_headers(api_key, session_id, _method)
+    private def request_headers(api_key, session_id, _method, workspace_id)
       user_agent = "Files.com Ruby SDK v#{Files::VERSION}"
       user_agent += " #{format_app_info(Files.app_info)}" unless Files.app_info.nil?
 
@@ -334,6 +335,8 @@ module Files
       headers["X-FilesAPI-Key"] = api_key if api_key
       headers["X-FilesAPI-Auth"] = session_id if session_id
       headers["Accept-Language"] = Files.language if Files.language
+      workspace_id = workspace_id.to_s
+      headers["X-Files-Workspace-Id"] = workspace_id unless workspace_id.empty?
 
       user_agent = @system_profiler.user_agent
       begin

data/lib/files.com/util.rb

@@ -2,7 +2,7 @@
 
 module Files
   module Util
-    OPTS = Set[:api_key, :client, :session_id].freeze
+    OPTS = Set[:api_key, :client, :session_id, :workspace_id].freeze
     COLOR_CODES = {
       black:   0, light_black:   60,
       red:     1, light_red:     61,

data/lib/files.com/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Files
-  VERSION = "1.1.647"
+  VERSION = "1.1.649"
 end

data/lib/files.com.rb

@@ -176,6 +176,7 @@ module Files
   @logger = nil
   @proxy = nil
   @session_id = nil
+  @workspace_id = nil
   @default_headers = nil
 
   @max_network_retries = 3
@@ -186,7 +187,7 @@ module Files
   @read_timeout = 60
 
   class << self
-    attr_accessor :api_key, :base_url, :default_headers, :initial_network_retry_delay, :language, :max_network_retry_delay, :open_timeout, :read_timeout, :proxy, :session_id
+    attr_accessor :api_key, :base_url, :default_headers, :initial_network_retry_delay, :language, :max_network_retry_delay, :open_timeout, :read_timeout, :proxy, :session_id, :workspace_id
   end
 
   # map to the same values as the standard library's logger

data/spec/workspace_id_spec.rb

@@ -0,0 +1,79 @@
+require "spec_helper"
+
+RSpec.describe "Workspace scoping" do
+  around do |example|
+    old_workspace_id = Files.workspace_id
+    Files.workspace_id = nil
+    example.run
+  ensure
+    Files.workspace_id = old_workspace_id
+  end
+
+  describe Files::ApiClient do
+    let(:client) { described_class.new }
+
+    it "includes the configured workspace ID header" do
+      headers = client.send(:request_headers, "api-key", nil, :get, 123)
+
+      expect(headers["X-Files-Workspace-Id"]).to eq("123")
+    end
+
+    it "omits the workspace ID header when unset" do
+      headers = client.send(:request_headers, "api-key", nil, :get, nil)
+
+      expect(headers).not_to have_key("X-Files-Workspace-Id")
+    end
+
+    it "falls back to the configured workspace ID" do
+      Files.workspace_id = 123
+      response = double(status: 204, body: "", headers: {})
+      conn = double
+      client = described_class.new(conn)
+
+      expect(client).to receive(:request_headers).with("api-key", nil, :get, 123).and_return({})
+      expect(conn).to receive(:run_request).and_return(response)
+
+      client.execute_request(:get, "/folders", api_key: "api-key")
+    end
+
+    it "lets a per-request workspace ID override the configured workspace ID" do
+      Files.workspace_id = 123
+      response = double(status: 204, body: "", headers: {})
+      conn = double
+      client = described_class.new(conn)
+
+      expect(client).to receive(:request_headers).with("api-key", nil, :get, 456).and_return({})
+      expect(conn).to receive(:run_request).and_return(response)
+
+      client.execute_request(:get, "/folders", api_key: "api-key", workspace_id: 456)
+    end
+  end
+
+  describe Files::Api do
+    it "passes per-request workspace ID options to the API client" do
+      client = instance_double(Files::ApiClient)
+      response = instance_double(Files::Response)
+
+      expect(client).to receive(:execute_request).with(
+        :get,
+        "/folders",
+        api_key: nil,
+        headers: {},
+        params: {},
+        session_id: nil,
+        workspace_id: 456
+      ).and_return([ response, nil, nil ])
+
+      actual_response, options = described_class.send_request(
+        "/folders",
+        :get,
+        {},
+        client: client,
+        workspace_id: 456
+      )
+
+      expect(actual_response).to eq(response)
+      expect(options[:workspace_id]).to eq(456)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.1.647
+  version: 1.1.649
 platform: ruby
 authors:
 - files.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2026-06-15 00:00:00.000000000 Z
+date: 2026-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -461,6 +461,7 @@ files:
 - spec/path_util_spec.rb
 - spec/spec_helper.rb
 - spec/uri_spec.rb
+- spec/workspace_id_spec.rb
 - test.sh
 - test/test.rb
 homepage: https://www.files.com