brick_ftp 1.0.1 → 2.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (90) hide show
  1. checksums.yaml +4 -4
  2. data/.github/action/publish_gem/Dockerfile +14 -0
  3. data/.github/action/publish_gem/entrypoint.sh +18 -0
  4. data/.github/action/write_github_release/Dockerfile +14 -0
  5. data/.github/action/write_github_release/entrypoint.sh +48 -0
  6. data/.github/main.workflow +14 -0
  7. data/CHANGELOG.md +17 -2
  8. data/README.md +2 -2
  9. data/lib/brick_ftp.rb +1 -1
  10. data/lib/brick_ftp/restful_api.rb +11 -11
  11. data/lib/brick_ftp/restful_api/add_group_member.rb +1 -1
  12. data/lib/brick_ftp/restful_api/client.rb +2 -2
  13. data/lib/brick_ftp/restful_api/complete_upload.rb +1 -1
  14. data/lib/brick_ftp/restful_api/continue_upload.rb +1 -1
  15. data/lib/brick_ftp/restful_api/copy_folder.rb +1 -1
  16. data/lib/brick_ftp/restful_api/count_folder_contents.rb +2 -2
  17. data/lib/brick_ftp/restful_api/count_users.rb +1 -1
  18. data/lib/brick_ftp/restful_api/create_api_key.rb +1 -1
  19. data/lib/brick_ftp/restful_api/create_behavior.rb +1 -1
  20. data/lib/brick_ftp/restful_api/create_bundle.rb +1 -1
  21. data/lib/brick_ftp/restful_api/create_folder.rb +1 -1
  22. data/lib/brick_ftp/restful_api/create_group.rb +1 -1
  23. data/lib/brick_ftp/restful_api/create_notification.rb +1 -1
  24. data/lib/brick_ftp/restful_api/create_permission.rb +1 -1
  25. data/lib/brick_ftp/restful_api/create_public_key.rb +1 -1
  26. data/lib/brick_ftp/restful_api/create_user.rb +1 -1
  27. data/lib/brick_ftp/restful_api/create_user_in_group.rb +1 -1
  28. data/lib/brick_ftp/restful_api/delete_api_key.rb +1 -1
  29. data/lib/brick_ftp/restful_api/delete_behavior.rb +1 -1
  30. data/lib/brick_ftp/restful_api/delete_bundle.rb +1 -1
  31. data/lib/brick_ftp/restful_api/delete_folder.rb +1 -1
  32. data/lib/brick_ftp/restful_api/delete_group.rb +1 -1
  33. data/lib/brick_ftp/restful_api/delete_notification.rb +1 -1
  34. data/lib/brick_ftp/restful_api/delete_permission.rb +1 -1
  35. data/lib/brick_ftp/restful_api/delete_public_key.rb +1 -1
  36. data/lib/brick_ftp/restful_api/delete_user.rb +1 -1
  37. data/lib/brick_ftp/restful_api/download_file.rb +1 -1
  38. data/lib/brick_ftp/restful_api/get_api_key.rb +1 -1
  39. data/lib/brick_ftp/restful_api/get_behavior.rb +1 -1
  40. data/lib/brick_ftp/restful_api/get_bundle.rb +1 -1
  41. data/lib/brick_ftp/restful_api/get_bundle_zip.rb +1 -1
  42. data/lib/brick_ftp/restful_api/get_file_in_bundle.rb +1 -1
  43. data/lib/brick_ftp/restful_api/get_folder_size.rb +1 -1
  44. data/lib/brick_ftp/restful_api/get_group.rb +1 -1
  45. data/lib/brick_ftp/restful_api/get_public_key.rb +1 -1
  46. data/lib/brick_ftp/restful_api/get_user.rb +1 -1
  47. data/lib/brick_ftp/restful_api/list_api_keys.rb +1 -1
  48. data/lib/brick_ftp/restful_api/list_behaviors.rb +1 -1
  49. data/lib/brick_ftp/restful_api/list_bundle_contents.rb +1 -1
  50. data/lib/brick_ftp/restful_api/list_bundles.rb +1 -1
  51. data/lib/brick_ftp/restful_api/list_folder_behaviors.rb +1 -1
  52. data/lib/brick_ftp/restful_api/list_folders.rb +1 -1
  53. data/lib/brick_ftp/restful_api/list_groups.rb +1 -1
  54. data/lib/brick_ftp/restful_api/list_notifications.rb +1 -1
  55. data/lib/brick_ftp/restful_api/list_permissions.rb +1 -1
  56. data/lib/brick_ftp/restful_api/list_public_keys.rb +1 -1
  57. data/lib/brick_ftp/restful_api/list_users.rb +1 -1
  58. data/lib/brick_ftp/restful_api/move_folder.rb +1 -1
  59. data/lib/brick_ftp/restful_api/remove_group_member.rb +1 -1
  60. data/lib/brick_ftp/restful_api/retrieve_file_history.rb +1 -1
  61. data/lib/brick_ftp/restful_api/retrieve_folder_history.rb +1 -1
  62. data/lib/brick_ftp/restful_api/retrieve_login_history.rb +1 -1
  63. data/lib/brick_ftp/restful_api/retrieve_site_history.rb +1 -1
  64. data/lib/brick_ftp/restful_api/retrieve_user_history.rb +1 -1
  65. data/lib/brick_ftp/restful_api/search_user.rb +1 -1
  66. data/lib/brick_ftp/restful_api/start_upload.rb +1 -1
  67. data/lib/brick_ftp/restful_api/unlock_user.rb +1 -1
  68. data/lib/brick_ftp/restful_api/update_behavior.rb +1 -1
  69. data/lib/brick_ftp/restful_api/update_group.rb +1 -1
  70. data/lib/brick_ftp/restful_api/update_group_member.rb +1 -1
  71. data/lib/brick_ftp/restful_api/update_user.rb +1 -1
  72. data/lib/brick_ftp/restful_api/upload_file.rb +4 -4
  73. data/lib/brick_ftp/types/behavior.rb +1 -1
  74. data/lib/brick_ftp/types/bundle.rb +1 -1
  75. data/lib/brick_ftp/types/bundle_content.rb +1 -1
  76. data/lib/brick_ftp/types/bundle_zip.rb +1 -1
  77. data/lib/brick_ftp/types/file.rb +1 -1
  78. data/lib/brick_ftp/types/file_in_bundle.rb +1 -1
  79. data/lib/brick_ftp/types/folder_contents_count.rb +2 -2
  80. data/lib/brick_ftp/types/group.rb +1 -1
  81. data/lib/brick_ftp/types/group_membership.rb +1 -1
  82. data/lib/brick_ftp/types/history.rb +1 -1
  83. data/lib/brick_ftp/types/notification.rb +1 -1
  84. data/lib/brick_ftp/types/permission.rb +1 -1
  85. data/lib/brick_ftp/types/upload.rb +1 -1
  86. data/lib/brick_ftp/types/user.rb +1 -1
  87. data/lib/brick_ftp/types/user_api_key.rb +1 -1
  88. data/lib/brick_ftp/types/user_public_key.rb +1 -1
  89. data/lib/brick_ftp/version.rb +1 -1
  90. metadata +8 -4
@@ -4,7 +4,7 @@ module BrickFTP
4
4
  module RESTfulAPI
5
5
  # Delete an API key
6
6
  #
7
- # @see https://developers.brickftp.com/#delete-an-api-key Delete an API key
7
+ # @see https://developers.files.com/#delete-an-api-key Delete an API key
8
8
  #
9
9
  class DeleteAPIKey
10
10
  include Command
@@ -4,7 +4,7 @@ module BrickFTP
4
4
  module RESTfulAPI
5
5
  # Delete a behavior
6
6
  #
7
- # @see https://developers.brickftp.com/#delete-a-behavior Delete a behavior
7
+ # @see https://developers.files.com/#delete-a-behavior Delete a behavior
8
8
  #
9
9
  class DeleteBehavior
10
10
  include Command
@@ -4,7 +4,7 @@ module BrickFTP
4
4
  module RESTfulAPI
5
5
  # Delete a bundle
6
6
  #
7
- # @see https://developers.brickftp.com/#delete-a-bundle Delete a bundle
7
+ # @see https://developers.files.com/#delete-a-bundle Delete a bundle
8
8
  #
9
9
  class DeleteBundle
10
10
  include Command
@@ -6,7 +6,7 @@ module BrickFTP
6
6
  module RESTfulAPI
7
7
  # Delete a file or folder
8
8
  #
9
- # @see https://developers.brickftp.com/#delete-a-file-or-folder Delete a file or folder
9
+ # @see https://developers.files.com/#delete-a-file-or-folder Delete a file or folder
10
10
  #
11
11
  class DeleteFolder
12
12
  include Command
@@ -4,7 +4,7 @@ module BrickFTP
4
4
  module RESTfulAPI
5
5
  # Delete a group
6
6
  #
7
- # @see https://developers.brickftp.com/#delete-a-group Delete a group
7
+ # @see https://developers.files.com/#delete-a-group Delete a group
8
8
  #
9
9
  class DeleteGroup
10
10
  include Command
@@ -4,7 +4,7 @@ module BrickFTP
4
4
  module RESTfulAPI
5
5
  # Delete a notification
6
6
  #
7
- # @see https://developers.brickftp.com/#delete-a-notification Delete a notification
7
+ # @see https://developers.files.com/#delete-a-notification Delete a notification
8
8
  #
9
9
  class DeleteNotification
10
10
  include Command
@@ -4,7 +4,7 @@ module BrickFTP
4
4
  module RESTfulAPI
5
5
  # Delete a permission
6
6
  #
7
- # @see https://developers.brickftp.com/#delete-a-permission Delete a permission
7
+ # @see https://developers.files.com/#delete-a-permission Delete a permission
8
8
  #
9
9
  class DeletePermission
10
10
  include Command
@@ -4,7 +4,7 @@ module BrickFTP
4
4
  module RESTfulAPI
5
5
  # Delete a public key
6
6
  #
7
- # @see https://developers.brickftp.com/#delete-a-public-key Delete a public key
7
+ # @see https://developers.files.com/#delete-a-public-key Delete a public key
8
8
  #
9
9
  class DeletePublicKey
10
10
  include Command
@@ -4,7 +4,7 @@ module BrickFTP
4
4
  module RESTfulAPI
5
5
  # Delete a user
6
6
  #
7
- # @see https://developers.brickftp.com/#delete-a-user Delete a user
7
+ # @see https://developers.files.com/#delete-a-user Delete a user
8
8
  #
9
9
  class DeleteUser
10
10
  include Command
@@ -4,7 +4,7 @@ module BrickFTP
4
4
  module RESTfulAPI
5
5
  # Download a file
6
6
  #
7
- # @see https://developers.brickftp.com/#download-a-file Download a file
7
+ # @see https://developers.files.com/#download-a-file Download a file
8
8
  #
9
9
  # ### Params
10
10
  #
@@ -4,7 +4,7 @@ module BrickFTP
4
4
  module RESTfulAPI
5
5
  # Show an API key
6
6
  #
7
- # @see https://developers.brickftp.com/#show-an-api-key Show an API key
7
+ # @see https://developers.files.com/#show-an-api-key Show an API key
8
8
  #
9
9
  class GetAPIKey
10
10
  include Command
@@ -4,7 +4,7 @@ module BrickFTP
4
4
  module RESTfulAPI
5
5
  # Show a behavior
6
6
  #
7
- # @see https://developers.brickftp.com/#show-a-behavior Show a behavior
7
+ # @see https://developers.files.com/#show-a-behavior Show a behavior
8
8
  #
9
9
  class GetBehavior
10
10
  include Command
@@ -4,7 +4,7 @@ module BrickFTP
4
4
  module RESTfulAPI
5
5
  # Show a bundle
6
6
  #
7
- # @see https://developers.brickftp.com/#show-a-bundle Show a bundle
7
+ # @see https://developers.files.com/#show-a-bundle Show a bundle
8
8
  #
9
9
  class GetBundle
10
10
  include Command
@@ -4,7 +4,7 @@ module BrickFTP
4
4
  module RESTfulAPI
5
5
  # Download entire bundle as ZIP
6
6
  #
7
- # @see https://developers.brickftp.com/#download-entire-bundle-as-zip Download entire bundle as ZIP
7
+ # @see https://developers.files.com/#download-entire-bundle-as-zip Download entire bundle as ZIP
8
8
  #
9
9
  # ### Params
10
10
  #
@@ -4,7 +4,7 @@ module BrickFTP
4
4
  module RESTfulAPI
5
5
  # Download one file in a bundle
6
6
  #
7
- # @see https://developers.brickftp.com/#download-one-file-in-a-bundle Download one file in a bundle
7
+ # @see https://developers.files.com/#download-one-file-in-a-bundle Download one file in a bundle
8
8
  #
9
9
  # ### Params
10
10
  #
@@ -6,7 +6,7 @@ module BrickFTP
6
6
  module RESTfulAPI
7
7
  # Get folder size
8
8
  #
9
- # @see https://developers.brickftp.com/#get-folder-size Get folder size
9
+ # @see https://developers.files.com/#get-folder-size Get folder size
10
10
  #
11
11
  class GetFolderSize
12
12
  include Command
@@ -4,7 +4,7 @@ module BrickFTP
4
4
  module RESTfulAPI
5
5
  # Show a group
6
6
  #
7
- # @see https://developers.brickftp.com/#show-a-group Show a group
7
+ # @see https://developers.files.com/#show-a-group Show a group
8
8
  #
9
9
  class GetGroup
10
10
  include Command
@@ -4,7 +4,7 @@ module BrickFTP
4
4
  module RESTfulAPI
5
5
  # Show a public key
6
6
  #
7
- # @see https://developers.brickftp.com/#show-a-public-key Show a public key
7
+ # @see https://developers.files.com/#show-a-public-key Show a public key
8
8
  #
9
9
  class GetPublicKey
10
10
  include Command
@@ -4,7 +4,7 @@ module BrickFTP
4
4
  module RESTfulAPI
5
5
  # Show a user
6
6
  #
7
- # @see https://developers.brickftp.com/#show-a-user Show a user
7
+ # @see https://developers.files.com/#show-a-user Show a user
8
8
  #
9
9
  class GetUser
10
10
  include Command
@@ -4,7 +4,7 @@ module BrickFTP
4
4
  module RESTfulAPI
5
5
  # List API keys
6
6
  #
7
- # @see https://developers.brickftp.com/#list-api-keys List API keys
7
+ # @see https://developers.files.com/#list-api-keys List API keys
8
8
  #
9
9
  class ListAPIKeys
10
10
  include Command
@@ -4,7 +4,7 @@ module BrickFTP
4
4
  module RESTfulAPI
5
5
  # List all behaviors
6
6
  #
7
- # @see https://developers.brickftp.com/#list-all-behaviors List all behaviors
7
+ # @see https://developers.files.com/#list-all-behaviors List all behaviors
8
8
  #
9
9
  class ListBehaviors
10
10
  include Command
@@ -6,7 +6,7 @@ module BrickFTP
6
6
  module RESTfulAPI
7
7
  # List bundle contents
8
8
  #
9
- # @see https://developers.brickftp.com/#list-bundle-contents List bundle contents
9
+ # @see https://developers.files.com/#list-bundle-contents List bundle contents
10
10
  #
11
11
  # ### Params
12
12
  #
@@ -4,7 +4,7 @@ module BrickFTP
4
4
  module RESTfulAPI
5
5
  # List all bundles
6
6
  #
7
- # @see https://developers.brickftp.com/#list-all-bundles List all bundles
7
+ # @see https://developers.files.com/#list-all-bundles List all bundles
8
8
  #
9
9
  class ListBundles
10
10
  include Command
@@ -6,7 +6,7 @@ module BrickFTP
6
6
  module RESTfulAPI
7
7
  # List behaviors for a folder
8
8
  #
9
- # @see https://developers.brickftp.com/#list-behaviors-for-a-folder List behaviors for a folder
9
+ # @see https://developers.files.com/#list-behaviors-for-a-folder List behaviors for a folder
10
10
  #
11
11
  # ### Params
12
12
  #
@@ -6,7 +6,7 @@ module BrickFTP
6
6
  module RESTfulAPI
7
7
  # List folder contents
8
8
  #
9
- # @see https://developers.brickftp.com/#list-folder-contents List folder contents
9
+ # @see https://developers.files.com/#list-folder-contents List folder contents
10
10
  #
11
11
  # ### Params
12
12
  #
@@ -4,7 +4,7 @@ module BrickFTP
4
4
  module RESTfulAPI
5
5
  # List all groups
6
6
  #
7
- # @see https://developers.brickftp.com/#list-all-groups List all groups
7
+ # @see https://developers.files.com/#list-all-groups List all groups
8
8
  #
9
9
  class ListGroups
10
10
  include Command
@@ -4,7 +4,7 @@ module BrickFTP
4
4
  module RESTfulAPI
5
5
  # List all notifications
6
6
  #
7
- # @see https://developers.brickftp.com/#list-all-notifications List all notifications
7
+ # @see https://developers.files.com/#list-all-notifications List all notifications
8
8
  #
9
9
  class ListNotifications
10
10
  include Command
@@ -6,7 +6,7 @@ module BrickFTP
6
6
  module RESTfulAPI
7
7
  # List permissions
8
8
  #
9
- # @see https://developers.brickftp.com/#list-permissions List permissions
9
+ # @see https://developers.files.com/#list-permissions List permissions
10
10
  #
11
11
  # ### Params
12
12
  #
@@ -4,7 +4,7 @@ module BrickFTP
4
4
  module RESTfulAPI
5
5
  # List public keys
6
6
  #
7
- # @see https://developers.brickftp.com/#list-public-keys List public keys
7
+ # @see https://developers.files.com/#list-public-keys List public keys
8
8
  #
9
9
  class ListPublicKeys
10
10
  include Command
@@ -4,7 +4,7 @@ module BrickFTP
4
4
  module RESTfulAPI
5
5
  # List users
6
6
  #
7
- # @see https://developers.brickftp.com/#list-users List users
7
+ # @see https://developers.files.com/#list-users List users
8
8
  #
9
9
  # ### Params
10
10
  #
@@ -6,7 +6,7 @@ module BrickFTP
6
6
  module RESTfulAPI
7
7
  # Move or rename a file or folder
8
8
  #
9
- # @see https://developers.brickftp.com/#move-or-rename-a-file-or-folder Move or rename a file or folder
9
+ # @see https://developers.files.com/#move-or-rename-a-file-or-folder Move or rename a file or folder
10
10
  #
11
11
  # ### Params
12
12
  #
@@ -4,7 +4,7 @@ module BrickFTP
4
4
  module RESTfulAPI
5
5
  # Remove a member
6
6
  #
7
- # @see https://developers.brickftp.com/#remove-a-member Remove a member
7
+ # @see https://developers.files.com/#remove-a-member Remove a member
8
8
  #
9
9
  class RemoveGroupMember
10
10
  include Command
@@ -6,7 +6,7 @@ module BrickFTP
6
6
  module RESTfulAPI
7
7
  # Retrieve file history
8
8
  #
9
- # @see https://developers.brickftp.com/#retrieve-file-history Retrieve file history
9
+ # @see https://developers.files.com/#retrieve-file-history Retrieve file history
10
10
  #
11
11
  # ### Params
12
12
  #
@@ -6,7 +6,7 @@ module BrickFTP
6
6
  module RESTfulAPI
7
7
  # Retrieve folder history
8
8
  #
9
- # @see https://developers.brickftp.com/#retrieve-folder-history Retrieve folder history
9
+ # @see https://developers.files.com/#retrieve-folder-history Retrieve folder history
10
10
  #
11
11
  # ### Params
12
12
  #
@@ -4,7 +4,7 @@ module BrickFTP
4
4
  module RESTfulAPI
5
5
  # Retrieve login history
6
6
  #
7
- # @see https://developers.brickftp.com/#retrieve-login-history Retrieve login history
7
+ # @see https://developers.files.com/#retrieve-login-history Retrieve login history
8
8
  #
9
9
  # ### Params
10
10
  #
@@ -4,7 +4,7 @@ module BrickFTP
4
4
  module RESTfulAPI
5
5
  # Retrieve site history
6
6
  #
7
- # @see https://developers.brickftp.com/#retrieve-site-history Retrieve site history
7
+ # @see https://developers.files.com/#retrieve-site-history Retrieve site history
8
8
  #
9
9
  # ### Params
10
10
  #
@@ -4,7 +4,7 @@ module BrickFTP
4
4
  module RESTfulAPI
5
5
  # Retrieve user history
6
6
  #
7
- # @see https://developers.brickftp.com/#retrieve-user-history Retrieve user history
7
+ # @see https://developers.files.com/#retrieve-user-history Retrieve user history
8
8
  #
9
9
  # ### Params
10
10
  #
@@ -6,7 +6,7 @@ module BrickFTP
6
6
  module RESTfulAPI
7
7
  # Search users
8
8
  #
9
- # @see https://developers.brickftp.com/#search-users Search users
9
+ # @see https://developers.files.com/#search-users Search users
10
10
  #
11
11
  class SearchUser
12
12
  include Command
@@ -6,7 +6,7 @@ module BrickFTP
6
6
  module RESTfulAPI
7
7
  # Starting a new upload
8
8
  #
9
- # @see https://developers.brickftp.com/#starting-a-new-upload Starting a new upload
9
+ # @see https://developers.files.com/#starting-a-new-upload Starting a new upload
10
10
  #
11
11
  class StartUpload
12
12
  include Command
@@ -4,7 +4,7 @@ module BrickFTP
4
4
  module RESTfulAPI
5
5
  # Unlock a user
6
6
  #
7
- # @see https://developers.brickftp.com/#unlock-a-user Unlock a user
7
+ # @see https://developers.files.com/#unlock-a-user Unlock a user
8
8
  #
9
9
  class UnlockUser
10
10
  include Command
@@ -4,7 +4,7 @@ module BrickFTP
4
4
  module RESTfulAPI
5
5
  # Update a behavior
6
6
  #
7
- # @see https://developers.brickftp.com/#update-a-behavior Update a behavior
7
+ # @see https://developers.files.com/#update-a-behavior Update a behavior
8
8
  #
9
9
  # ### Params
10
10
  #
@@ -4,7 +4,7 @@ module BrickFTP
4
4
  module RESTfulAPI
5
5
  # Update a group
6
6
  #
7
- # @see https://developers.brickftp.com/#update-a-group Update a group
7
+ # @see https://developers.files.com/#update-a-group Update a group
8
8
  #
9
9
  # ### Params
10
10
  #
@@ -4,7 +4,7 @@ module BrickFTP
4
4
  module RESTfulAPI
5
5
  # Update a member
6
6
  #
7
- # @see https://developers.brickftp.com/#update-a-member Update a member
7
+ # @see https://developers.files.com/#update-a-member Update a member
8
8
  #
9
9
  # ### Params
10
10
  #
@@ -4,7 +4,7 @@ module BrickFTP
4
4
  module RESTfulAPI
5
5
  # Update a user
6
6
  #
7
- # @see https://developers.brickftp.com/#update-a-user Update a user
7
+ # @see https://developers.files.com/#update-a-user Update a user
8
8
  #
9
9
  # ### Params
10
10
  #
@@ -6,13 +6,13 @@ module BrickFTP
6
6
  module RESTfulAPI
7
7
  # Overview of uploading
8
8
  #
9
- # @see https://developers.brickftp.com/#overview-of-uploading Overview of uploading
9
+ # @see https://developers.files.com/#overview-of-uploading Overview of uploading
10
10
  #
11
11
  # ### Uploading files using the REST API is done in 3 stages:
12
12
  #
13
- # 1. {https://developers.brickftp.com/#starting-a-new-upload Start a new upload} by sending a request to REST API to indicate intent to upload a file.
14
- # 2. {https://developers.brickftp.com/#uploading-the-file-or-file-parts Upload the file} to the URL(s) provided by the REST API, possibly in parts via multiple uploads.
15
- # 3. {https://developers.brickftp.com/#completing-an-upload Complete the upload} by notifying the REST API that the file upload has completed.
13
+ # 1. {https://developers.files.com/#starting-a-new-upload Start a new upload} by sending a request to REST API to indicate intent to upload a file.
14
+ # 2. {https://developers.files.com/#uploading-the-file-or-file-parts Upload the file} to the URL(s) provided by the REST API, possibly in parts via multiple uploads.
15
+ # 3. {https://developers.files.com/#completing-an-upload Complete the upload} by notifying the REST API that the file upload has completed.
16
16
  #
17
17
  class UploadFile
18
18
  include Command