files.com 1.1.795 → 1.1.797

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11c9cb5536d9eae379bb5ed007a014c12a743458e057eeef86b2a7334f1edc7c
-  data.tar.gz: 6dd7da27279f732340fa662aca010d577deae9d2b0de35da14d2610ca184d41e
+  metadata.gz: 5ff0801679675d74a77850b8b613be4230e3c652bc649c9b1ad6d1efe45dbcd4
+  data.tar.gz: 65880cc3c2ff063f8bd35798fbd1457367e23f9bf300bf86d6c65c02cec87232
 SHA512:
-  metadata.gz: f242163c3e01950dde4dcddc118768fe6dae7483c6d1c21e505ff2dd58cd8bba1c6549da0cbd6dd4062c68ba7b614f219cc413b03b90f2c66cc8f4266df8bb2b
-  data.tar.gz: 366bbb0dcf8ff40afb34f3cf808264c2c3d9fa913062211adb5bd5d536c8abe365519b321cffe1f46f18d74c50d714c3e3efca0f1043effa54a6906a418a7d2a
+  metadata.gz: c4a8b61e41f95f29e1bcdf56a236ba4c573e9e2b16e2be235792d36b086423e4a8dad787082714b0ecfade5ebc8534ddfdd8427b7913a9ae9328e771bdd3ee2c
+  data.tar.gz: 6f2c9a22034fd46a304facc1b23d297d7b4e4746d02b0a9eeae4396d5043f5b627f51af4973630742c492d3aab1602b3a344f17826e79786da04543130ffe00d

data/_VERSION

@@ -1 +1 @@
-1.1.795
+1.1.797

data/docs/gpg_key.md

@@ -56,7 +56,7 @@ Files::GpgKey.list(
 * `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`, `name` or `expires_at`.
-* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `workspace_id`, `partner_id` or `expires_at`. Valid field combinations are `[ workspace_id, expires_at ]`.
+* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `workspace_id`, `partner_id` or `expires_at`. Valid field combinations are `[ workspace_id, partner_id ]`, `[ workspace_id, expires_at ]`, `[ partner_id, expires_at ]` or `[ workspace_id, partner_id, expires_at ]`.
 * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `expires_at`.
 * `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `expires_at`.
 * `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `expires_at`.

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

@@ -72,9 +72,9 @@ module Files
       PathUtil.normalize("_", root, id.to_s, relative_path)
     end
 
-    def self.upload_to_remote_server(path, remote_server_id, destination = nil, options = {}, params: {})
+    def self.upload_to_remote_server(path, remote_server_id, destination = nil, options = {}, params: {}, progress: nil)
       destination ||= ::File.basename(path)
-      upload_file(path, underscore_destination_path("RemoteServers", remote_server_id, destination), options, params: params)
+      upload_file(path, underscore_destination_path("RemoteServers", remote_server_id, destination), options, params: params, progress: progress)
     end
 
     def self.copy_to_remote_server(path, remote_server_id, destination, params = {}, options = {})
@@ -85,9 +85,9 @@ module Files
       move(path, params.merge(destination: underscore_destination_path("RemoteServers", remote_server_id, destination)), options)
     end
 
-    def self.upload_to_snapshot(path, snapshot_id, destination = nil, options = {}, params: {})
+    def self.upload_to_snapshot(path, snapshot_id, destination = nil, options = {}, params: {}, progress: nil)
       destination ||= ::File.basename(path)
-      upload_file(path, underscore_destination_path("Snapshots", snapshot_id, destination), options, params: params)
+      upload_file(path, underscore_destination_path("Snapshots", snapshot_id, destination), options, params: params, progress: progress)
     end
 
     def self.copy_to_snapshot(path, snapshot_id, destination, params = {}, options = {})
@@ -98,9 +98,9 @@ module Files
       move(path, params.merge(destination: underscore_destination_path("Snapshots", snapshot_id, destination)), options)
     end
 
-    def self.upload_to_child_site(path, site_id, destination = nil, options = {}, params: {})
+    def self.upload_to_child_site(path, site_id, destination = nil, options = {}, params: {}, progress: nil)
       destination ||= ::File.basename(path)
-      upload_file(path, underscore_destination_path("Sites", site_id, destination), options, params: params)
+      upload_file(path, underscore_destination_path("Sites", site_id, destination), options, params: params, progress: progress)
     end
 
     def self.copy_to_child_site(path, site_id, destination, params = {}, options = {})
@@ -207,27 +207,59 @@ module Files
       paths.map { |p| delete(p) }
     end
 
-    def self.upload_chunks(io, path, options, upload = nil, etags = [], params: {})
+    # Uploads what io holds to path, a part at a time as the API grants each, and returns the last part, the parts'
+    # ETags and the bytes sent. Each part is filled from as many reads as it takes (read_part). With progress, a
+    # callable, each part's response must be a success (2xx) before the part counts as acknowledged; progress is then
+    # called with total_bytes (nil: unknown here), acknowledged_bytes (this call's bytes so far), part_number and
+    # part_bytes. Anything it raises ends the upload there, with no later part planned or sent.
+    def self.upload_chunks(io, path, options, upload = nil, etags = [], params: {}, progress: nil)
       etags ||= []
       bytes_written = 0
       request_parts = options[:size] && options[:size] < 5.megabytes ? 1 : 5
       loop do
         begin_upload = File.begin_upload(path, params.merge(ref: upload&.ref, parts: request_parts, part: (upload&.part_number || 0) + 1), options) if begin_upload.nil? || begin_upload.empty?
         upload = begin_upload.is_a?(Enumerable) ? begin_upload.shift : begin_upload
-        buf = io.read(upload.partsize) || ""
+        buf = read_part(io, upload.partsize)
         bytes_written += buf.length
         method = upload.http_method.downcase.to_sym
         response = client(options).remote_request(method, upload.upload_uri, { 'Content-Length': buf.length.to_s, 'Content-Type': 'application/octet-stream' }, buf)
+        raise APIError.new("Transfer request failed", http_status: response.status), cause: nil if progress && !response.status.between?(200, 299)
+
         etags << { etag: response.headers["ETag"], part: upload.part_number }
+        progress&.call({ total_bytes: nil, acknowledged_bytes: bytes_written, part_number: upload.part_number, part_bytes: buf.length })
         return upload, etags, bytes_written if io.eof?
       end
     end
 
-    def self.upload_file(path, destination = nil, options = {}, params: {})
+    # The next part's bytes from io: as many reads as it takes to fill length bytes. A read that gives nothing (nil or
+    # "") ends the part when io.eof? says the source has ended; before its end, the source made no progress, and the
+    # part is not sent.
+    private_class_method def self.read_part(io, length)
+      buf = String.new(encoding: Encoding::BINARY)
+      while buf.bytesize < length
+        chunk = io.read(length - buf.bytesize)
+        if chunk.nil? || chunk.empty?
+          break if io.eof?
+
+          raise InvalidParameterError, "The upload source returned no bytes before its end"
+        end
+        # A read that fills the part at once, as an IO's or a StringIO's does, is sent as it came.
+        return chunk if buf.empty? && chunk.bytesize == length
+
+        buf << chunk.b
+      end
+      buf
+    end
+
+    # With progress, a callable, it is called after each part is acknowledged, as upload_chunks reports it, with
+    # total_bytes the local file's size.
+    def self.upload_file(path, destination = nil, options = {}, params: {}, progress: nil)
       local_file = ::File.open(path, 'r')
       destination ||= File.basename(path)
       params[:size] ||= local_file.size
-      upload, etags = upload_chunks(local_file, destination, options, params: params)
+      total_bytes = local_file.size
+      report = progress && ->(part) { progress.call(part.merge(total_bytes: total_bytes)) }
+      upload, etags = upload_chunks(local_file, destination, options, params: params, progress: report)
 
       params = {
         action: "end",

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

@@ -242,7 +242,7 @@ module Files
     #   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`, `name` or `expires_at`.
-    #   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `workspace_id`, `partner_id` or `expires_at`. Valid field combinations are `[ workspace_id, expires_at ]`.
+    #   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `workspace_id`, `partner_id` or `expires_at`. Valid field combinations are `[ workspace_id, partner_id ]`, `[ workspace_id, expires_at ]`, `[ partner_id, expires_at ]` or `[ workspace_id, partner_id, expires_at ]`.
     #   filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `expires_at`.
     #   filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `expires_at`.
     #   filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `expires_at`.