files.com 1.1.784 → 1.1.786

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd5e31f4e4c09fa7272e5c337ddc01c434546c93f177fe8fecd887839326f060
-  data.tar.gz: 143a0c464a2530296c1e67243d5f8d2e3640cff840c897ae2067517147af45b7
+  metadata.gz: 297ac56fe0c1ad0e834dcd371599ce418443650c0c136adbd6530e42da051e09
+  data.tar.gz: 20c046024f6830e02e7b73daccbe7dbe32ec9cce8ca38509a8c932bc4b826ab3
 SHA512:
-  metadata.gz: 0d5eca777f0554ded3ad22b322bd8dcf959885c986c461a1d478c8097ffb00e2ee6d6741fd426cd36d0031796890f7d6ec7d0400f8c37072ae9079484a856fc7
-  data.tar.gz: f377e72e2cdb7e3f49391059d4c4c6115e506053cf7c371e6a0c2957018e701e8f3fd09ef8daeb099c498de22d8ce490826ea66cf596511bc43f8dd3f1fbaa89
+  metadata.gz: a0ceefe70ae7603de8bdfcaa0856a40c08201ec2a601ec2a4003cb093c8cb0eab0ace565d4a704ce93e487cc1d57bce3b85363da27a80f426f74c0000918a118
+  data.tar.gz: 6e9c93ff74b7f96d603b1da2249373c57c4843fbfbc66508d46b62e55ff1880a1d80c33427247db753f633649adfdc7f66dc17fcac9894fa756d8707a354e78f

data/_VERSION

@@ -1 +1 @@
-1.1.784
+1.1.786

data/lib/files.com/api_client.rb

@@ -8,7 +8,7 @@ module Files
     QUERY_METHODS = %i[get head delete].freeze
     private_constant :QUERY_METHODS
 
-    # The default for a logging option this client does not set itself.
+    # The default for an option this client does not set itself.
     USE_GLOBAL = Object.new.freeze
     private_constant :USE_GLOBAL
 
@@ -27,10 +27,16 @@ module Files
     #             Files.log_level is set.
     #
     # A client created with logger: nil, log_level: nil logs no ordinary API messages.
-    def initialize(conn = nil, logger: USE_GLOBAL, log_level: USE_GLOBAL)
+    #
+    # Its API requests likewise name the library-wide Files.workspace_id, read for each request, unless
+    # +workspace_id+ gives this client its own workspace; 0 is sent as "0". A request's own workspace_id option still
+    # takes precedence, and a request whose workspace_id is nil uses this client's. Pass workspace_id: nil to name no
+    # workspace for this client's requests even when Files.workspace_id is set.
+    def initialize(conn = nil, logger: USE_GLOBAL, log_level: USE_GLOBAL, workspace_id: USE_GLOBAL)
       self.conn = conn || self.class.default_conn
       @logger = logger
       @log_level = log_level.equal?(USE_GLOBAL) ? log_level : Util.normalize_log_level(log_level)
+      @workspace_id = workspace_id
       @system_profiler = SystemProfiler.new
       @last_request_metrics = nil
     end
@@ -125,7 +131,7 @@ module Files
       else
         session_id = nil
       end
-      workspace_id = Files.workspace_id if workspace_id.nil?
+      workspace_id = default_workspace_id if workspace_id.nil?
 
       if session_id and session_id != ""
         check_session_id!(session_id)
@@ -550,6 +556,11 @@ module Files
                            )
     end
 
+    # This client's own workspace where it set one, and the library-wide one otherwise.
+    private def default_workspace_id
+      @workspace_id.equal?(USE_GLOBAL) ? Files.workspace_id : @workspace_id
+    end
+
     class RequestLogContext
       attr_accessor :body, :api_key, :method, :path, :query_params, :session_id
     end

data/lib/files.com/version.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
 module Files
-  VERSION = "1.1.784"
+  # The SDK's release version, reported in the API User-Agent. The package's _VERSION file holds it; the gemspec
+  # reads the same file for the gem version, and releases write the new version there.
+  VERSION = File.read(File.expand_path("../../_VERSION", __dir__)).strip.freeze
 end

data/spec/lib/api_client_spec.rb

@@ -402,6 +402,54 @@ RSpec.describe Files::ApiClient do
     end
   end
 
+  describe "client workspaces" do
+    around do |example|
+      original = Files.workspace_id
+      example.run
+    ensure
+      Files.workspace_id = original
+    end
+
+    it "sends each client's own workspace, and the library-wide one for clients without their own" do
+      workspace_headers = []
+      connection = Faraday.new do |builder|
+        builder.response :raise_error
+        builder.adapter :test do |stub|
+          stub.get("/api/rest/v1/workspaces/1") do |env|
+            workspace_headers << env.request_headers["X-Files-Workspace-Id"]
+            [ 200, { "Content-Type" => "application/json" }, { id: 1 }.to_json ]
+          end
+        end
+      end
+      find_workspace = ->(client, **options) { Files::Workspace.find(1, {}, api_key: "key", client: client, **options) }
+      Files.workspace_id = 5
+      client_a = described_class.new(connection, workspace_id: 0)
+      client_b = described_class.new(connection, workspace_id: 7)
+
+      find_workspace.call(client_a)
+      find_workspace.call(client_b)
+      Files.workspace_id = 6
+      find_workspace.call(client_a)
+      find_workspace.call(described_class.new(connection))
+      find_workspace.call(described_class.new(connection, workspace_id: nil))
+      find_workspace.call(client_b, workspace_id: 0)
+      find_workspace.call(client_b, workspace_id: "")
+      find_workspace.call(client_b, workspace_id: nil)
+
+      expect(workspace_headers).to eq([ "0", "7", "0", "6", nil, "0", nil, "7" ])
+      expect(Files.workspace_id).to eq(6)
+    end
+  end
+
+  describe "User-Agent" do
+    it "reports the SDK version the package declares" do
+      package_version = Gem::Specification.load(File.expand_path("../../files.com.gemspec", __dir__)).version.to_s
+      user_agent = described_class.new.send(:request_headers, nil, nil, :get, nil)["User-Agent"]
+
+      expect(user_agent).to match(/\AFiles\.com Ruby SDK v#{Regexp.escape(package_version)}(?: |\z)/)
+    end
+  end
+
   describe "network timeouts" do
     around do |example|
       original = [ Files.open_timeout, Files.read_timeout ]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.1.784
+  version: 1.1.786
 platform: ruby
 authors:
 - files.com