files.com 1.1.186 → 1.1.187

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 620caceed8d041f86ccb966010f80f6708936bb7d6176a05c97c19bc139cd3c1
-  data.tar.gz: 740fdc967930f91692e6426a3a711c52e8470cb0476e6cd60e058f87616569dd
+  metadata.gz: 33f2f11a2d2de88c9a6b4ea9567827e56c4d2314a59d6e4e89acc99a90ab8138
+  data.tar.gz: 034b20521c3925dc61ab04a46f29ea5f537928b40b52f1388028151c46d98a25
 SHA512:
-  metadata.gz: 07aa95ef57a284e2d35c74b1f0d2b0167a41bfcdab45f08f192b145ebdd526a0cbc40e71acd0b6f89663703b0cd4cddf2420f662515ea86223b68a4ffdbd94b5
-  data.tar.gz: 6e6714095b0a4026fc1198ea777d69924c23801ccbd3528227a468dcbd003de7c343320faa0f290e86dcdf5d99bfbcfd1d8b84e95200b9e5a44924b5fb9b69fb
+  metadata.gz: 3ca76d9dba94ae2067cadd2fd381139ada1484841c67d26cb66c457850c85a6b8483c0e7d235af6a947ad1f4b7c1c5dbbcbb77ad190684dda16ceec4c552189e
+  data.tar.gz: 172e3434d3e97b41e1ac8aa83b4dfa07127d2217fc00761bfcbb086206e361d63665da7f5d95ae0f76380b976e1345c7795f6a42c0789075594317b1bf88c86b

data/README.md

@@ -499,25 +499,7 @@ Files::FolderAdminPermissionRequiredError -> Files::NotAuthorizedError -> Files:
 |`TrialLockedError`|  `SiteConfigurationError` |
 |`UserRequestsEnabledRequiredError`|  `SiteConfigurationError` |
 
-## Mock Server
-
-Files.com publishes a Files.com API server, which is useful for testing your use of the Files.com
-SDKs and other direct integrations against the Files.com API in an integration test environment.
-
-It is a Ruby app that operates as a minimal server for the purpose of testing basic network
-operations and JSON encoding for your SDK or API client. It does not maintain state and it does not
-deeply inspect your submissions for correctness.
-
-Eventually we will add more features intended for integration testing, such as the ability to
-intentionally provoke errors.
-
-Download the server as a Docker image via [Docker Hub](https://hub.docker.com/r/filescom/files-mock-server).
-
-The Source Code is also available on [GitHub](https://github.com/Files-com/files-mock-server).
-
-A README is available on the GitHub link.
-
-## File/Folder Operations
+## Examples
 
 The Files::File and Files::Dir models implement the standard Ruby API
 for File and Dir, respectively.  (Note that the Files.com SDK uses the
@@ -526,11 +508,15 @@ Files::Folder).
 
 ### Upload
 
+#### Upload a File
+
 ```ruby
-## Upload a file on disk.
-Files::upload_file("local.txt", "/remote.txt")
+Files::File.upload_file("local.txt", "remote.txt")
+```
+
+#### Upload Raw File Data
 
-## Upload raw file data.
+```ruby
 File.open("local.txt") do |local_file|
   Files::File.open("remote.txt", "w") do |remote_file|
     remote_file.write(local_file.read)
@@ -538,16 +524,78 @@ File.open("local.txt") do |local_file|
 end
 ```
 
+#### Create a Folder
+
+```ruby
+Files::Folder.create("path/to/folder/to/be/created",
+  mkdir_parents: true
+)
+```
+
 ### Download
 
+#### Download a File
+
 ```ruby
-Files::File.find("foo.txt").read
+Files::File.download_file("remote.txt", "local.txt")
 ```
 
 ### List
 
+#### List Folder Contents
+
 ```ruby
-Files::Folder.list_for("/").each do |file|
+Files::Folder.list_for("remote/path/to/folder/").each do |file|
   puts file.path
 end
 ```
+
+### Copy
+
+The copy method works for both files and folders.
+
+```ruby
+file = Files::File.new("source/path")
+file.copy(destination: "destination/path")
+```
+
+### Move
+
+The move method works for both files and folders.
+
+```ruby
+file = Files::File.new("source/path")
+file.move(destination: "destination/path")
+```
+
+### Delete
+
+The delete method works for both files and folders.
+
+```ruby
+Files::File.delete("path/to/file/or/folder")
+```
+
+In case the folder is not empty, you can use the `recursive` argument:
+
+```ruby
+Files::File.delete("path/to/folder", recursive: true)
+```
+
+## Mock Server
+
+Files.com publishes a Files.com API server, which is useful for testing your use of the Files.com
+SDKs and other direct integrations against the Files.com API in an integration test environment.
+
+It is a Ruby app that operates as a minimal server for the purpose of testing basic network
+operations and JSON encoding for your SDK or API client. It does not maintain state and it does not
+deeply inspect your submissions for correctness.
+
+Eventually we will add more features intended for integration testing, such as the ability to
+intentionally provoke errors.
+
+Download the server as a Docker image via [Docker Hub](https://hub.docker.com/r/filescom/files-mock-server).
+
+The Source Code is also available on [GitHub](https://github.com/Files-com/files-mock-server).
+
+A README is available on the GitHub link.

data/_VERSION

@@ -1 +1 @@
-1.1.186
+1.1.187

data/lib/files.com/version.rb

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

metadata

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