files.com 1.1.757 → 1.1.759

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ebfcb0a65a636d80b045dec828bd4febd6691b14f5b6499b2429093b577ce61a
-  data.tar.gz: 8741f0fe95e2590c5c817dbcd1f4b5f2218608d5caa09e95c61a36b9489ec6c4
+  metadata.gz: 844199f222c0d7a81f7a17742192f06608db347a37872ff38e1cb6d07998c1ee
+  data.tar.gz: b84c2d7340036beafea02c69321fe1b718ff7370f847dff54af10d587572b276
 SHA512:
-  metadata.gz: ee616f53de17251896dd450716b6fbdc000e70cb29e7f66be2b68ea48239cb14f2a81e5e300cba022f632eafe23e99bbec9931fe1b47a8e0dce55da77f9f807e
-  data.tar.gz: 31bb8f5f62b4db746062ab14b9f867d66a2b63ed272f73411c4461669bccca8b26c5f48bb990d047d3cf05c1e6f041f99129f5503bcedc3059094a41785748a2
+  metadata.gz: 773fa097b3fdbf512cbb946d82a367bf220606f3743b68c00cab6af1f2ed5ae011fa678d3d963a46384a301e86f605c2bdf9934488d37d0719c06a77236de6e0
+  data.tar.gz: ff3a484319e8e215f48ab3241f09d3dd9e548858f3e04441b3cff3f998e4233fa3971c07fd7241c3950d83f819648e6d85f1ff5a493c29a165d81ad2c6a51162

data/README.md

@@ -684,6 +684,7 @@ Files::FolderAdminPermissionRequiredError -> Files::NotAuthorizedError -> Files:
 |`TooManySharesError`|  `RateLimitedError` |
 |`AutomationsUnavailableError`|  `ServiceUnavailableError` |
 |`MigrationInProgressError`|  `ServiceUnavailableError` |
+|`SearchUnavailableError`|  `ServiceUnavailableError` |
 |`SiteDisabledError`|  `ServiceUnavailableError` |
 |`UploadsUnavailableError`|  `ServiceUnavailableError` |
 |`AccountAlreadyExistsError`|  `SiteConfigurationError` |

data/_VERSION

@@ -1 +1 @@
-1.1.757
+1.1.759

data/docs/folder.md

@@ -125,7 +125,7 @@ Files::Folder.list_for(path,
 * `path` (string): Required - Path to operate on.
 * `preview_size` (string): Request a preview size.  Can be `small` (default), `large`, `xlarge`, or `pdf`.
 * `sort_by` (object): Search by field and direction. Valid fields are `path`, `size`, `modified_at_datetime`, `provided_modified_at`.  Valid directions are `asc` and `desc`.  Defaults to `{"path":"asc"}`.
-* `search` (string): If specified, will search the folders/files list by name. Ignores text before last `/`. This is the same API used by the search bar in the web UI when running 'Search This Folder'.  Search results are a best effort, not real time, and not guaranteed to perfectly match the latest folder listing.  Results may be truncated if more than 1,000 possible matches exist.  This field should only be used for ad-hoc (human) searching, and not as part of an automated process.
+* `search` (string): If specified, will search the folders/files list by name. Ignores text before last `/`. This is the same API used by the search bar in the web UI when running 'Search This Folder'.  Search results are a best effort, not real time, and not guaranteed to perfectly match the latest folder listing.  Results may be truncated if more than 1,000 possible matches exist.  This field should only be used for ad-hoc (human) searching, and not as part of an automated process. During scheduled search maintenance, indexed searches return HTTP 422 with error type `service-unavailable/search-unavailable`; retry after maintenance ends. Folder listing without `search` remains available.
 * `search_custom_metadata_key` (string): If provided, the search string in `search` will search for files where this custom metadata key matches the value sent in `search`.  Set this to `*` to allow any metadata key to match the value sent in `search`.
 * `search_all` (boolean): Search entire site?  If true, we will search the entire site.  Do not provide a path when using this parameter.  This is the same API used by the search bar in the web UI when running 'Search All Files'.  Search results are a best effort, not real time, and not guaranteed to match every file.  This field should only be used for ad-hoc (human) searching, and not as part of an automated process.
 * `with_previews` (boolean): Include file previews?

data/docs/remote_server.md

@@ -111,7 +111,7 @@
 * `s3_assume_role_duration_seconds` (int64): Session duration in seconds for AssumeRole authentication (900-43200).
 * `s3_assume_role_external_id` (string): External ID for AssumeRole authentication.
 * `server_certificate` (string): Remote server certificate
-* `server_host_key` (string): Pinned plain SSH host key for SFTP, in OpenSSH public key format. If omitted, Files.com detects and stores the server's plain host key, including when the server offers an OpenSSH host certificate. With `server_certificate=require_match` (the default), the server must present the pinned key and prove it holds the matching private key. The pin remains in force until an administrator updates `server_host_key`. Files.com does not authenticate remote hosts through SSH certificates and does not check their CA signatures, principals, or validity periods. Certificate expiration does not end the pin; update `server_host_key` to retire a host key.
+* `server_host_key` (string): Pinned SSH host key or OpenSSH host certificate for SFTP. If omitted, Files.com detects and stores a host key, preferring plain keys over certificates. With `server_certificate=require_match` (the default), the server must present the exact pinned key or certificate and prove it holds the matching private key. A pinned certificate is compared in full, so renewal can require updating `server_host_key` even when its underlying key is unchanged. Files.com does not check certificate CA signatures, principals, or validity periods. Certificate expiration alone does not end the pin. Update `server_host_key` to replace the pin.
 * `server_type` (string): Remote server type.
 * `workspace_id` (int64): Workspace ID (0 for default workspace)
 * `ssl` (string): Should we require SSL?
@@ -401,7 +401,7 @@ Files::RemoteServer.create(
 * `s3_compatible_virtual_hosted_style` (boolean): S3-compatible: If true, use virtual-hosted-style URLs instead of path-style URLs
 * `s3_region` (string): S3 region
 * `server_certificate` (string): Remote server certificate
-* `server_host_key` (string): Pinned plain SSH host key for SFTP, in OpenSSH public key format. If omitted, Files.com detects and stores the server's plain host key, including when the server offers an OpenSSH host certificate. With `server_certificate=require_match` (the default), the server must present the pinned key and prove it holds the matching private key. The pin remains in force until an administrator updates `server_host_key`. Files.com does not authenticate remote hosts through SSH certificates and does not check their CA signatures, principals, or validity periods. Certificate expiration does not end the pin; update `server_host_key` to retire a host key.
+* `server_host_key` (string): Pinned SSH host key or OpenSSH host certificate for SFTP. If omitted, Files.com detects and stores a host key, preferring plain keys over certificates. With `server_certificate=require_match` (the default), the server must present the exact pinned key or certificate and prove it holds the matching private key. A pinned certificate is compared in full, so renewal can require updating `server_host_key` even when its underlying key is unchanged. Files.com does not check certificate CA signatures, principals, or validity periods. Certificate expiration alone does not end the pin. Update `server_host_key` to replace the pin.
 * `server_type` (string): Remote server type.
 * `sharepoint_client_id` (string): SharePoint: Microsoft Entra application client ID for app-only authentication.
 * `sharepoint_site_url` (string): SharePoint: Site URL to scope app-only authentication to a single site. Leave blank to browse all sites.
@@ -574,7 +574,7 @@ Files::RemoteServer.update(id,
 * `s3_compatible_virtual_hosted_style` (boolean): S3-compatible: If true, use virtual-hosted-style URLs instead of path-style URLs
 * `s3_region` (string): S3 region
 * `server_certificate` (string): Remote server certificate
-* `server_host_key` (string): Pinned plain SSH host key for SFTP, in OpenSSH public key format. If omitted, Files.com detects and stores the server's plain host key, including when the server offers an OpenSSH host certificate. With `server_certificate=require_match` (the default), the server must present the pinned key and prove it holds the matching private key. The pin remains in force until an administrator updates `server_host_key`. Files.com does not authenticate remote hosts through SSH certificates and does not check their CA signatures, principals, or validity periods. Certificate expiration does not end the pin; update `server_host_key` to retire a host key.
+* `server_host_key` (string): Pinned SSH host key or OpenSSH host certificate for SFTP. If omitted, Files.com detects and stores a host key, preferring plain keys over certificates. With `server_certificate=require_match` (the default), the server must present the exact pinned key or certificate and prove it holds the matching private key. A pinned certificate is compared in full, so renewal can require updating `server_host_key` even when its underlying key is unchanged. Files.com does not check certificate CA signatures, principals, or validity periods. Certificate expiration alone does not end the pin. Update `server_host_key` to replace the pin.
 * `server_type` (string): Remote server type.
 * `sharepoint_client_id` (string): SharePoint: Microsoft Entra application client ID for app-only authentication.
 * `sharepoint_site_url` (string): SharePoint: Site URL to scope app-only authentication to a single site. Leave blank to browse all sites.
@@ -778,7 +778,7 @@ remote_server.update(
 * `s3_compatible_virtual_hosted_style` (boolean): S3-compatible: If true, use virtual-hosted-style URLs instead of path-style URLs
 * `s3_region` (string): S3 region
 * `server_certificate` (string): Remote server certificate
-* `server_host_key` (string): Pinned plain SSH host key for SFTP, in OpenSSH public key format. If omitted, Files.com detects and stores the server's plain host key, including when the server offers an OpenSSH host certificate. With `server_certificate=require_match` (the default), the server must present the pinned key and prove it holds the matching private key. The pin remains in force until an administrator updates `server_host_key`. Files.com does not authenticate remote hosts through SSH certificates and does not check their CA signatures, principals, or validity periods. Certificate expiration does not end the pin; update `server_host_key` to retire a host key.
+* `server_host_key` (string): Pinned SSH host key or OpenSSH host certificate for SFTP. If omitted, Files.com detects and stores a host key, preferring plain keys over certificates. With `server_certificate=require_match` (the default), the server must present the exact pinned key or certificate and prove it holds the matching private key. A pinned certificate is compared in full, so renewal can require updating `server_host_key` even when its underlying key is unchanged. Files.com does not check certificate CA signatures, principals, or validity periods. Certificate expiration alone does not end the pin. Update `server_host_key` to replace the pin.
 * `server_type` (string): Remote server type.
 * `sharepoint_client_id` (string): SharePoint: Microsoft Entra application client ID for app-only authentication.
 * `sharepoint_site_url` (string): SharePoint: Site URL to scope app-only authentication to a single site. Leave blank to browse all sites.

data/lib/files.com/errors.rb

@@ -257,6 +257,7 @@ module Files
   class ServiceUnavailableError < APIError; end
   class AutomationsUnavailableError < ServiceUnavailableError; end
   class MigrationInProgressError < ServiceUnavailableError; end
+  class SearchUnavailableError < ServiceUnavailableError; end
   class SiteDisabledError < ServiceUnavailableError; end
   class UploadsUnavailableError < ServiceUnavailableError; end
 

data/lib/files.com/models/file.rb

@@ -34,10 +34,19 @@ module Files
     end
 
     def self.download_file(path, local_path = nil)
-      local_path ||= File.basename(path)
+      local_path ||= default_local_path(path)
       new(path).download_file(local_path)
     end
 
+    private_class_method def self.default_local_path(path)
+      name = PathUtil.normalize(path).split("/").last.to_s
+      # On Windows a colon makes the name a drive-relative path or an NTFS
+      # stream, which can write outside the working directory or onto another file.
+      raise InvalidParameterError.new("Bad parameter: local_path is required because #{name.inspect} is not a valid local file name") if Gem.win_platform? && name.include?(":")
+
+      name
+    end
+
     private_class_method def self.underscore_destination_path(root, id, relative_path = nil)
       PathUtil.normalize("_", root, id.to_s, relative_path)
     end

data/lib/files.com/models/folder.rb

@@ -491,7 +491,7 @@ module Files
     #   path (required) - string - Path to operate on.
     #   preview_size - string - Request a preview size.  Can be `small` (default), `large`, `xlarge`, or `pdf`.
     #   sort_by - object - Search by field and direction. Valid fields are `path`, `size`, `modified_at_datetime`, `provided_modified_at`.  Valid directions are `asc` and `desc`.  Defaults to `{"path":"asc"}`.
-    #   search - string - If specified, will search the folders/files list by name. Ignores text before last `/`. This is the same API used by the search bar in the web UI when running 'Search This Folder'.  Search results are a best effort, not real time, and not guaranteed to perfectly match the latest folder listing.  Results may be truncated if more than 1,000 possible matches exist.  This field should only be used for ad-hoc (human) searching, and not as part of an automated process.
+    #   search - string - If specified, will search the folders/files list by name. Ignores text before last `/`. This is the same API used by the search bar in the web UI when running 'Search This Folder'.  Search results are a best effort, not real time, and not guaranteed to perfectly match the latest folder listing.  Results may be truncated if more than 1,000 possible matches exist.  This field should only be used for ad-hoc (human) searching, and not as part of an automated process. During scheduled search maintenance, indexed searches return HTTP 422 with error type `service-unavailable/search-unavailable`; retry after maintenance ends. Folder listing without `search` remains available.
     #   search_custom_metadata_key - string - If provided, the search string in `search` will search for files where this custom metadata key matches the value sent in `search`.  Set this to `*` to allow any metadata key to match the value sent in `search`.
     #   search_all - boolean - Search entire site?  If true, we will search the entire site.  Do not provide a path when using this parameter.  This is the same API used by the search bar in the web UI when running 'Search All Files'.  Search results are a best effort, not real time, and not guaranteed to match every file.  This field should only be used for ad-hoc (human) searching, and not as part of an automated process.
     #   with_previews - boolean - Include file previews?

data/lib/files.com/models/remote_server.rb

@@ -207,7 +207,7 @@ module Files
       @attributes[:server_certificate] = value
     end
 
-    # string - Pinned plain SSH host key for SFTP, in OpenSSH public key format. If omitted, Files.com detects and stores the server's plain host key, including when the server offers an OpenSSH host certificate. With `server_certificate=require_match` (the default), the server must present the pinned key and prove it holds the matching private key. The pin remains in force until an administrator updates `server_host_key`. Files.com does not authenticate remote hosts through SSH certificates and does not check their CA signatures, principals, or validity periods. Certificate expiration does not end the pin; update `server_host_key` to retire a host key.
+    # string - Pinned SSH host key or OpenSSH host certificate for SFTP. If omitted, Files.com detects and stores a host key, preferring plain keys over certificates. With `server_certificate=require_match` (the default), the server must present the exact pinned key or certificate and prove it holds the matching private key. A pinned certificate is compared in full, so renewal can require updating `server_host_key` even when its underlying key is unchanged. Files.com does not check certificate CA signatures, principals, or validity periods. Certificate expiration alone does not end the pin. Update `server_host_key` to replace the pin.
     def server_host_key
       @attributes[:server_host_key]
     end
@@ -1023,7 +1023,7 @@ module Files
     #   s3_compatible_virtual_hosted_style - boolean - S3-compatible: If true, use virtual-hosted-style URLs instead of path-style URLs
     #   s3_region - string - S3 region
     #   server_certificate - string - Remote server certificate
-    #   server_host_key - string - Pinned plain SSH host key for SFTP, in OpenSSH public key format. If omitted, Files.com detects and stores the server's plain host key, including when the server offers an OpenSSH host certificate. With `server_certificate=require_match` (the default), the server must present the pinned key and prove it holds the matching private key. The pin remains in force until an administrator updates `server_host_key`. Files.com does not authenticate remote hosts through SSH certificates and does not check their CA signatures, principals, or validity periods. Certificate expiration does not end the pin; update `server_host_key` to retire a host key.
+    #   server_host_key - string - Pinned SSH host key or OpenSSH host certificate for SFTP. If omitted, Files.com detects and stores a host key, preferring plain keys over certificates. With `server_certificate=require_match` (the default), the server must present the exact pinned key or certificate and prove it holds the matching private key. A pinned certificate is compared in full, so renewal can require updating `server_host_key` even when its underlying key is unchanged. Files.com does not check certificate CA signatures, principals, or validity periods. Certificate expiration alone does not end the pin. Update `server_host_key` to replace the pin.
     #   server_type - string - Remote server type.
     #   sharepoint_client_id - string - SharePoint: Microsoft Entra application client ID for app-only authentication.
     #   sharepoint_site_url - string - SharePoint: Site URL to scope app-only authentication to a single site. Leave blank to browse all sites.
@@ -1283,7 +1283,7 @@ module Files
     #   s3_compatible_virtual_hosted_style - boolean - S3-compatible: If true, use virtual-hosted-style URLs instead of path-style URLs
     #   s3_region - string - S3 region
     #   server_certificate - string - Remote server certificate
-    #   server_host_key - string - Pinned plain SSH host key for SFTP, in OpenSSH public key format. If omitted, Files.com detects and stores the server's plain host key, including when the server offers an OpenSSH host certificate. With `server_certificate=require_match` (the default), the server must present the pinned key and prove it holds the matching private key. The pin remains in force until an administrator updates `server_host_key`. Files.com does not authenticate remote hosts through SSH certificates and does not check their CA signatures, principals, or validity periods. Certificate expiration does not end the pin; update `server_host_key` to retire a host key.
+    #   server_host_key - string - Pinned SSH host key or OpenSSH host certificate for SFTP. If omitted, Files.com detects and stores a host key, preferring plain keys over certificates. With `server_certificate=require_match` (the default), the server must present the exact pinned key or certificate and prove it holds the matching private key. A pinned certificate is compared in full, so renewal can require updating `server_host_key` even when its underlying key is unchanged. Files.com does not check certificate CA signatures, principals, or validity periods. Certificate expiration alone does not end the pin. Update `server_host_key` to replace the pin.
     #   server_type - string - Remote server type.
     #   sharepoint_client_id - string - SharePoint: Microsoft Entra application client ID for app-only authentication.
     #   sharepoint_site_url - string - SharePoint: Site URL to scope app-only authentication to a single site. Leave blank to browse all sites.
@@ -1463,7 +1463,7 @@ module Files
     #   s3_compatible_virtual_hosted_style - boolean - S3-compatible: If true, use virtual-hosted-style URLs instead of path-style URLs
     #   s3_region - string - S3 region
     #   server_certificate - string - Remote server certificate
-    #   server_host_key - string - Pinned plain SSH host key for SFTP, in OpenSSH public key format. If omitted, Files.com detects and stores the server's plain host key, including when the server offers an OpenSSH host certificate. With `server_certificate=require_match` (the default), the server must present the pinned key and prove it holds the matching private key. The pin remains in force until an administrator updates `server_host_key`. Files.com does not authenticate remote hosts through SSH certificates and does not check their CA signatures, principals, or validity periods. Certificate expiration does not end the pin; update `server_host_key` to retire a host key.
+    #   server_host_key - string - Pinned SSH host key or OpenSSH host certificate for SFTP. If omitted, Files.com detects and stores a host key, preferring plain keys over certificates. With `server_certificate=require_match` (the default), the server must present the exact pinned key or certificate and prove it holds the matching private key. A pinned certificate is compared in full, so renewal can require updating `server_host_key` even when its underlying key is unchanged. Files.com does not check certificate CA signatures, principals, or validity periods. Certificate expiration alone does not end the pin. Update `server_host_key` to replace the pin.
     #   server_type - string - Remote server type.
     #   sharepoint_client_id - string - SharePoint: Microsoft Entra application client ID for app-only authentication.
     #   sharepoint_site_url - string - SharePoint: Site URL to scope app-only authentication to a single site. Leave blank to browse all sites.

data/lib/files.com/version.rb

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

data/spec/models/file_download_default_path_spec.rb

@@ -0,0 +1,22 @@
+require "spec_helper"
+
+RSpec.describe Files::File do
+  describe ".download_file without a local path" do
+    it "downloads to the remote file name" do
+      allow(Gem).to receive(:win_platform?).and_return(false)
+      file = described_class.new("folder/report:2026.txt")
+      allow(described_class).to receive(:new).with("folder/report:2026.txt").and_return(file)
+      expect(file).to receive(:download_file).with("report:2026.txt")
+
+      described_class.download_file("folder/report:2026.txt")
+    end
+
+    it "refuses a drive or stream name on Windows" do
+      allow(Gem).to receive(:win_platform?).and_return(true)
+
+      [ "folder/C:victim.txt", "C:victim.txt", "folder/victim.txt::$DATA" ].each do |remote_path|
+        expect { described_class.download_file(remote_path) }.to raise_error(Files::InvalidParameterError)
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.1.757
+  version: 1.1.759
 platform: ruby
 authors:
 - files.com
@@ -487,6 +487,7 @@ files:
 - spec/language_spec.rb
 - spec/lib/api_client_spec.rb
 - spec/list_spec.rb
+- spec/models/file_download_default_path_spec.rb
 - spec/models/file_spec.rb
 - spec/models/file_underscore_destinations_spec.rb
 - spec/models/folder_spec.rb