files.com 1.0.109 → 1.0.110

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b59cab41d33457bbffc4a0d0d536c2af86947d6cc0f4655dea9e5e4ba5843ae6
-  data.tar.gz: 62971b3941be99b9fbc546b9a641d94d3c02632c51a67f7ef1771ac0289d7017
+  metadata.gz: b823cad7eb84b62cf77fbf4b37829a3b36c937c1532c7d9798fd7910fa48adf1
+  data.tar.gz: 839b5d017058a7a21afe3b90a8acee4ddf5df348712ab2b61285be58441430a7
 SHA512:
-  metadata.gz: 956c8660b3324077b7a3f62cc7bcb6244caead532f9ab2005a9d72afd145e83151a06c3fec8e66b1803ded3141382d805155059c5fd90ed3b33b4e91b260f61e
-  data.tar.gz: 4a22e77eff78368ef8fc7625c6435d5377179e6a63c69ee6cbad53e96a44d80e6f46cf0036f3b79563994ef973d1e3b9b3bc65b3ca4c1db4079d4ef8fe0b3356
+  metadata.gz: ab72c400c26db6e38f5c4c94ea1bfe01f60093dfbbfddb1c3c26699ba31bcdce257bd9422697f555914b8d2c403a0a28983af54a2097bb2a4e3277485127b883
+  data.tar.gz: 2f0688fea58866785311afc8260306260d3d4d6ad811ce851dd9a2dffe899a9e39451c223b8fb40b1e01f70462f44ed8569b8179e3d73328e9d00e5d521321bb

data/_VERSION

@@ -1 +1 @@
-1.0.109
+1.0.110

data/docs/file_upload_part.md

@@ -0,0 +1,39 @@
+# FileUploadPart
+
+## Example FileUploadPart Object
+
+```
+{
+  "send": "",
+  "action": "multipart",
+  "ask_about_overwrites": true,
+  "available_parts": 1,
+  "expires": "",
+  "headers": "",
+  "http_method": "PUT",
+  "next_partsize": 1,
+  "parallel_parts": true,
+  "parameters": "{}",
+  "part_number": 1,
+  "partsize": 1,
+  "path": "",
+  "ref": "upload-1",
+  "upload_uri": ""
+}
+```
+
+* `send` (object): Content-Type and File to send
+* `action` (string): Type of upload
+* `ask_about_overwrites` (boolean): If `true`, this file exists and you may wish to ask the user for overwrite confirmation
+* `available_parts` (int64): Number of parts in the upload
+* `expires` (string): Date/time of when this Upload part expires and the URL cannot be used any more
+* `headers` (object): Additional upload headers to provide as part of the upload
+* `http_method` (string): HTTP Method to use for uploading the part, usually `PUT`
+* `next_partsize` (int64): Size in bytes for this part
+* `parallel_parts` (boolean): If `true`, multiple parts may be uploaded in parallel.  If `false`, be sure to only upload one part at a time, in order.
+* `parameters` (object): Additional HTTP parameters to send with the upload
+* `part_number` (int64): Number of this upload part
+* `partsize` (int64): Size in bytes for the next upload part
+* `path` (string): New file path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+* `ref` (string): Reference name for this upload part
+* `upload_uri` (string): URI to upload this part to

data/lib/files.com.rb

@@ -46,7 +46,7 @@ require "files.com/models/file"
 require "files.com/models/file_action"
 require "files.com/models/file_comment"
 require "files.com/models/file_comment_reaction"
-require "files.com/models/file_part_upload"
+require "files.com/models/file_upload_part"
 require "files.com/models/folder"
 require "files.com/models/group"
 require "files.com/models/group_user"

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

@@ -119,7 +119,7 @@ module Files
 
       response, options = Api.send_request("/file_actions/begin_upload/#{params[:path]}", :post, params, options)
       response.data.map do |entity_data|
-        FilePartUpload.new(entity_data, options)
+        FileUploadPart.new(entity_data, options)
       end
     end
   end

data/lib/files.com/models/{file_part_upload.rb → file_upload_part.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Files
-  class FilePartUpload
+  class FileUploadPart
     attr_reader :options, :attributes
 
     def initialize(attributes = {}, options = {})
@@ -19,57 +19,57 @@ module Files
       @attributes[:action]
     end
 
-    # boolean - If false, rename conflicting files instead of asking for overwrite confirmation
+    # boolean - If `true`, this file exists and you may wish to ask the user for overwrite confirmation
     def ask_about_overwrites
       @attributes[:ask_about_overwrites]
     end
 
-    # int64 - Currently unused
+    # int64 - Number of parts in the upload
     def available_parts
       @attributes[:available_parts]
     end
 
-    # string - Currently unused
+    # string - Date/time of when this Upload part expires and the URL cannot be used any more
     def expires
       @attributes[:expires]
     end
 
-    # object - Additional upload headers
+    # object - Additional upload headers to provide as part of the upload
     def headers
       @attributes[:headers]
     end
 
-    # string - Upload method, usually POST
+    # string - HTTP Method to use for uploading the part, usually `PUT`
     def http_method
       @attributes[:http_method]
     end
 
-    # int64 - Currently unused
+    # int64 - Size in bytes for this part
     def next_partsize
       @attributes[:next_partsize]
     end
 
-    # boolean - If true, parts may be uploaded in parallel
+    # boolean - If `true`, multiple parts may be uploaded in parallel.  If `false`, be sure to only upload one part at a time, in order.
     def parallel_parts
       @attributes[:parallel_parts]
     end
 
-    # object - Additional upload parameters
+    # object - Additional HTTP parameters to send with the upload
     def parameters
       @attributes[:parameters]
     end
 
-    # int64 - Currently unused
+    # int64 - Number of this upload part
     def part_number
       @attributes[:part_number]
     end
 
-    # int64 - Currently unused
+    # int64 - Size in bytes for the next upload part
     def partsize
       @attributes[:partsize]
     end
 
-    # string - Upload path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+    # string - New file path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
     def path
       @attributes[:path]
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.0.109
+  version: 1.0.110
 platform: ruby
 authors:
 - files.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-26 00:00:00.000000000 Z
+date: 2020-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -105,7 +105,7 @@ files:
 - docs/file_action.md
 - docs/file_comment.md
 - docs/file_comment_reaction.md
-- docs/file_part_upload.md
+- docs/file_upload_part.md
 - docs/file_utils.md
 - docs/folder.md
 - docs/group.md
@@ -170,7 +170,7 @@ files:
 - lib/files.com/models/file_action.rb
 - lib/files.com/models/file_comment.rb
 - lib/files.com/models/file_comment_reaction.rb
-- lib/files.com/models/file_part_upload.rb
+- lib/files.com/models/file_upload_part.rb
 - lib/files.com/models/file_utils.rb
 - lib/files.com/models/folder.rb
 - lib/files.com/models/group.rb

data/docs/file_part_upload.md

@@ -1,39 +0,0 @@
-# FilePartUpload
-
-## Example FilePartUpload Object
-
-```
-{
-  "send": "",
-  "action": "upload/direct",
-  "ask_about_overwrites": true,
-  "available_parts": 1,
-  "expires": "",
-  "headers": "",
-  "http_method": "POST",
-  "next_partsize": 1,
-  "parallel_parts": true,
-  "parameters": "{}",
-  "part_number": 1,
-  "partsize": 1,
-  "path": "",
-  "ref": "upload-1",
-  "upload_uri": ""
-}
-```
-
-* `send` (object): Content-Type and File to send
-* `action` (string): Type of upload
-* `ask_about_overwrites` (boolean): If false, rename conflicting files instead of asking for overwrite confirmation
-* `available_parts` (int64): Currently unused
-* `expires` (string): Currently unused
-* `headers` (object): Additional upload headers
-* `http_method` (string): Upload method, usually POST
-* `next_partsize` (int64): Currently unused
-* `parallel_parts` (boolean): If true, parts may be uploaded in parallel
-* `parameters` (object): Additional upload parameters
-* `part_number` (int64): Currently unused
-* `partsize` (int64): Currently unused
-* `path` (string): Upload path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
-* `ref` (string): Reference name for this upload part
-* `upload_uri` (string): URI to upload this part to