dropbox_api 0.1.18 → 0.1.19

Sign up to get free protection for your applications and to get access to all the features.
Files changed (212) hide show
  1. checksums.yaml +4 -4
  2. data/.rubocop.yml +9 -8
  3. data/.travis.yml +0 -2
  4. data/Gemfile +4 -3
  5. data/README.md +7 -2
  6. data/Rakefile +4 -3
  7. data/api_coverage.md +1 -1
  8. data/bin/console +4 -3
  9. data/dropbox_api.gemspec +15 -14
  10. data/lib/dropbox_api.rb +12 -2
  11. data/lib/dropbox_api/authenticator.rb +3 -2
  12. data/lib/dropbox_api/chunked_uploader.rb +2 -1
  13. data/lib/dropbox_api/client.rb +2 -1
  14. data/lib/dropbox_api/connection_builder.rb +1 -0
  15. data/lib/dropbox_api/endpoints/auth/token_revoke.rb +2 -1
  16. data/lib/dropbox_api/endpoints/base.rb +4 -3
  17. data/lib/dropbox_api/endpoints/content_download.rb +4 -6
  18. data/lib/dropbox_api/endpoints/content_upload.rb +2 -1
  19. data/lib/dropbox_api/endpoints/file_requests/create_file_request.rb +4 -3
  20. data/lib/dropbox_api/endpoints/files/copy.rb +4 -3
  21. data/lib/dropbox_api/endpoints/files/copy_batch.rb +3 -2
  22. data/lib/dropbox_api/endpoints/files/copy_batch_check.rb +3 -2
  23. data/lib/dropbox_api/endpoints/files/copy_reference_get.rb +3 -2
  24. data/lib/dropbox_api/endpoints/files/copy_reference_save.rb +4 -3
  25. data/lib/dropbox_api/endpoints/files/create_folder.rb +3 -2
  26. data/lib/dropbox_api/endpoints/files/create_folder_batch.rb +3 -2
  27. data/lib/dropbox_api/endpoints/files/create_folder_batch_check.rb +3 -2
  28. data/lib/dropbox_api/endpoints/files/delete.rb +3 -2
  29. data/lib/dropbox_api/endpoints/files/delete_batch.rb +3 -2
  30. data/lib/dropbox_api/endpoints/files/delete_batch_check.rb +3 -2
  31. data/lib/dropbox_api/endpoints/files/download.rb +3 -2
  32. data/lib/dropbox_api/endpoints/files/get_metadata.rb +3 -2
  33. data/lib/dropbox_api/endpoints/files/get_preview.rb +3 -2
  34. data/lib/dropbox_api/endpoints/files/get_temporary_link.rb +3 -2
  35. data/lib/dropbox_api/endpoints/files/get_thumbnail.rb +3 -2
  36. data/lib/dropbox_api/endpoints/files/get_thumbnail_batch.rb +4 -3
  37. data/lib/dropbox_api/endpoints/files/list_folder.rb +3 -2
  38. data/lib/dropbox_api/endpoints/files/list_folder_continue.rb +3 -2
  39. data/lib/dropbox_api/endpoints/files/list_folder_get_latest_cursor.rb +2 -1
  40. data/lib/dropbox_api/endpoints/files/list_folder_longpoll.rb +3 -2
  41. data/lib/dropbox_api/endpoints/files/list_revisions.rb +3 -2
  42. data/lib/dropbox_api/endpoints/files/move.rb +4 -3
  43. data/lib/dropbox_api/endpoints/files/permanently_delete.rb +3 -2
  44. data/lib/dropbox_api/endpoints/files/restore.rb +4 -3
  45. data/lib/dropbox_api/endpoints/files/save_url.rb +4 -3
  46. data/lib/dropbox_api/endpoints/files/save_url_check_job_status.rb +3 -2
  47. data/lib/dropbox_api/endpoints/files/search.rb +16 -27
  48. data/lib/dropbox_api/endpoints/files/upload.rb +2 -1
  49. data/lib/dropbox_api/endpoints/files/upload_session_append_v2.rb +3 -2
  50. data/lib/dropbox_api/endpoints/files/upload_session_finish.rb +4 -3
  51. data/lib/dropbox_api/endpoints/files/upload_session_start.rb +4 -3
  52. data/lib/dropbox_api/endpoints/rpc.rb +2 -1
  53. data/lib/dropbox_api/endpoints/rpc_content.rb +2 -1
  54. data/lib/dropbox_api/endpoints/rpc_notify.rb +2 -1
  55. data/lib/dropbox_api/endpoints/sharing/add_file_member.rb +4 -3
  56. data/lib/dropbox_api/endpoints/sharing/add_folder_member.rb +4 -3
  57. data/lib/dropbox_api/endpoints/sharing/create_shared_link_with_settings.rb +4 -3
  58. data/lib/dropbox_api/endpoints/sharing/get_shared_link_metadata.rb +3 -2
  59. data/lib/dropbox_api/endpoints/sharing/list_file_members.rb +4 -3
  60. data/lib/dropbox_api/endpoints/sharing/list_folder_members.rb +4 -3
  61. data/lib/dropbox_api/endpoints/sharing/list_shared_links.rb +2 -1
  62. data/lib/dropbox_api/endpoints/sharing/revoke_shared_link.rb +3 -2
  63. data/lib/dropbox_api/endpoints/sharing/share_folder.rb +3 -2
  64. data/lib/dropbox_api/endpoints/sharing/unshare_file.rb +3 -2
  65. data/lib/dropbox_api/endpoints/users/get_account.rb +3 -2
  66. data/lib/dropbox_api/endpoints/users/get_account_batch.rb +3 -2
  67. data/lib/dropbox_api/endpoints/users/get_current_account.rb +2 -1
  68. data/lib/dropbox_api/endpoints/users/get_space_usage.rb +2 -1
  69. data/lib/dropbox_api/endpoints/virtual/upload_by_chunks.rb +1 -0
  70. data/lib/dropbox_api/errors/add_file_member_error.rb +5 -4
  71. data/lib/dropbox_api/errors/add_folder_member_error.rb +11 -10
  72. data/lib/dropbox_api/errors/add_member_selector_error.rb +6 -5
  73. data/lib/dropbox_api/errors/already_shared_error.rb +1 -0
  74. data/lib/dropbox_api/errors/basic_error.rb +2 -1
  75. data/lib/dropbox_api/errors/create_file_request_error.rb +1 -0
  76. data/lib/dropbox_api/errors/create_folder_batch_error.rb +2 -1
  77. data/lib/dropbox_api/errors/create_folder_error.rb +2 -1
  78. data/lib/dropbox_api/errors/create_shared_link_with_settings_error.rb +6 -5
  79. data/lib/dropbox_api/errors/delete_error.rb +4 -3
  80. data/lib/dropbox_api/errors/download_error.rb +2 -1
  81. data/lib/dropbox_api/errors/file_member_action_error.rb +5 -4
  82. data/lib/dropbox_api/errors/get_account_error.rb +2 -1
  83. data/lib/dropbox_api/errors/get_copy_reference_error.rb +2 -1
  84. data/lib/dropbox_api/errors/get_metadata_error.rb +2 -1
  85. data/lib/dropbox_api/errors/http_error.rb +1 -0
  86. data/lib/dropbox_api/errors/list_folder_continue_error.rb +3 -2
  87. data/lib/dropbox_api/errors/list_folder_error.rb +2 -1
  88. data/lib/dropbox_api/errors/list_folder_longpoll_error.rb +2 -1
  89. data/lib/dropbox_api/errors/list_revisions_error.rb +2 -1
  90. data/lib/dropbox_api/errors/list_shared_links_error.rb +3 -2
  91. data/lib/dropbox_api/errors/lookup_error.rb +6 -5
  92. data/lib/dropbox_api/errors/poll_error.rb +3 -2
  93. data/lib/dropbox_api/errors/preview_error.rb +5 -4
  94. data/lib/dropbox_api/errors/relocation_batch_entry_error.rb +4 -3
  95. data/lib/dropbox_api/errors/relocation_error.rb +8 -7
  96. data/lib/dropbox_api/errors/restore_error.rb +4 -3
  97. data/lib/dropbox_api/errors/revoke_shared_link_error.rb +5 -4
  98. data/lib/dropbox_api/errors/save_copy_reference_error.rb +6 -5
  99. data/lib/dropbox_api/errors/save_url_error.rb +5 -4
  100. data/lib/dropbox_api/errors/search_error.rb +2 -1
  101. data/lib/dropbox_api/errors/settings_error.rb +3 -2
  102. data/lib/dropbox_api/errors/share_folder_error.rb +6 -5
  103. data/lib/dropbox_api/errors/share_path_error.rb +12 -11
  104. data/lib/dropbox_api/errors/shared_folder_access_error.rb +5 -4
  105. data/lib/dropbox_api/errors/shared_link_error.rb +4 -3
  106. data/lib/dropbox_api/errors/sharing_file_access_error.rb +6 -5
  107. data/lib/dropbox_api/errors/sharing_user_error.rb +2 -1
  108. data/lib/dropbox_api/errors/thumbnail_batch_error.rb +2 -1
  109. data/lib/dropbox_api/errors/thumbnail_error.rb +5 -4
  110. data/lib/dropbox_api/errors/too_many_requests_error.rb +3 -2
  111. data/lib/dropbox_api/errors/unshare_file_error.rb +3 -2
  112. data/lib/dropbox_api/errors/upload_error.rb +2 -1
  113. data/lib/dropbox_api/errors/upload_session_finish_error.rb +4 -3
  114. data/lib/dropbox_api/errors/upload_session_lookup_error.rb +5 -4
  115. data/lib/dropbox_api/errors/upload_session_offset_error.rb +1 -0
  116. data/lib/dropbox_api/errors/upload_write_failed_error.rb +2 -1
  117. data/lib/dropbox_api/errors/write_conflict_error.rb +4 -3
  118. data/lib/dropbox_api/errors/write_error.rb +6 -5
  119. data/lib/dropbox_api/metadata/access_level.rb +1 -0
  120. data/lib/dropbox_api/metadata/add_file_member_result.rb +1 -0
  121. data/lib/dropbox_api/metadata/add_member.rb +3 -2
  122. data/lib/dropbox_api/metadata/base.rb +2 -1
  123. data/lib/dropbox_api/metadata/basic_account.rb +1 -0
  124. data/lib/dropbox_api/metadata/commit_info.rb +2 -1
  125. data/lib/dropbox_api/metadata/deleted.rb +1 -0
  126. data/lib/dropbox_api/metadata/dimensions.rb +1 -0
  127. data/lib/dropbox_api/metadata/field.rb +7 -4
  128. data/lib/dropbox_api/metadata/file.rb +2 -1
  129. data/lib/dropbox_api/metadata/file_categories_list.rb +9 -0
  130. data/lib/dropbox_api/metadata/file_category.rb +22 -0
  131. data/lib/dropbox_api/metadata/file_extensions_list.rb +13 -0
  132. data/lib/dropbox_api/metadata/file_link_metadata.rb +1 -0
  133. data/lib/dropbox_api/metadata/file_member_action.rb +2 -1
  134. data/lib/dropbox_api/metadata/file_request.rb +1 -0
  135. data/lib/dropbox_api/metadata/file_status.rb +14 -0
  136. data/lib/dropbox_api/metadata/folder.rb +2 -1
  137. data/lib/dropbox_api/metadata/folder_link_metadata.rb +1 -0
  138. data/lib/dropbox_api/metadata/folder_sharing_info.rb +1 -0
  139. data/lib/dropbox_api/metadata/link_permissions.rb +1 -0
  140. data/lib/dropbox_api/metadata/location.rb +1 -0
  141. data/lib/dropbox_api/metadata/media_info.rb +1 -0
  142. data/lib/dropbox_api/metadata/media_metadata.rb +1 -0
  143. data/lib/dropbox_api/metadata/member.rb +6 -5
  144. data/lib/dropbox_api/metadata/member_action.rb +1 -0
  145. data/lib/dropbox_api/metadata/member_action_list.rb +1 -0
  146. data/lib/dropbox_api/metadata/member_permission.rb +1 -0
  147. data/lib/dropbox_api/metadata/member_permission_list.rb +1 -0
  148. data/lib/dropbox_api/metadata/metadata_v2.rb +7 -0
  149. data/lib/dropbox_api/metadata/name.rb +1 -0
  150. data/lib/dropbox_api/metadata/parent_folder_access_info.rb +1 -0
  151. data/lib/dropbox_api/metadata/photo_metadata.rb +1 -0
  152. data/lib/dropbox_api/metadata/resource.rb +2 -1
  153. data/lib/dropbox_api/metadata/search_match_field_options.rb +9 -0
  154. data/lib/dropbox_api/metadata/search_match_type_v2.rb +16 -0
  155. data/lib/dropbox_api/metadata/search_match_v2.rb +18 -0
  156. data/lib/dropbox_api/metadata/search_options.rb +33 -0
  157. data/lib/dropbox_api/metadata/search_order_by.rb +14 -0
  158. data/lib/dropbox_api/metadata/shared_folder.rb +1 -0
  159. data/lib/dropbox_api/metadata/shared_folder_policy.rb +1 -0
  160. data/lib/dropbox_api/metadata/shared_link.rb +3 -2
  161. data/lib/dropbox_api/metadata/shared_link_metadata.rb +2 -1
  162. data/lib/dropbox_api/metadata/space_allocation.rb +1 -0
  163. data/lib/dropbox_api/metadata/space_usage.rb +1 -0
  164. data/lib/dropbox_api/metadata/tag.rb +2 -1
  165. data/lib/dropbox_api/metadata/team.rb +1 -0
  166. data/lib/dropbox_api/metadata/team_member_info.rb +1 -0
  167. data/lib/dropbox_api/metadata/thumbnail_batch_result_data.rb +1 -0
  168. data/lib/dropbox_api/metadata/thumbnail_batch_result_entry.rb +3 -2
  169. data/lib/dropbox_api/metadata/upload_session_cursor.rb +1 -0
  170. data/lib/dropbox_api/metadata/video_metadata.rb +1 -0
  171. data/lib/dropbox_api/metadata/write_mode.rb +6 -5
  172. data/lib/dropbox_api/middleware/decode_result.rb +3 -2
  173. data/lib/dropbox_api/middleware/stack.rb +1 -0
  174. data/lib/dropbox_api/options_validator.rb +1 -0
  175. data/lib/dropbox_api/result_builder.rb +3 -2
  176. data/lib/dropbox_api/results/add_file_member_result_list.rb +1 -0
  177. data/lib/dropbox_api/results/base.rb +1 -0
  178. data/lib/dropbox_api/results/basic_account_batch.rb +1 -0
  179. data/lib/dropbox_api/results/copy_batch_result.rb +2 -1
  180. data/lib/dropbox_api/results/create_folder_batch_result.rb +5 -4
  181. data/lib/dropbox_api/results/create_folder_batch_result_entry.rb +1 -0
  182. data/lib/dropbox_api/results/delete_batch_result.rb +5 -4
  183. data/lib/dropbox_api/results/delete_batch_result_entry.rb +1 -0
  184. data/lib/dropbox_api/results/get_copy_reference_result.rb +4 -3
  185. data/lib/dropbox_api/results/get_temporary_link_result.rb +3 -2
  186. data/lib/dropbox_api/results/get_thumbnail_batch_result.rb +2 -1
  187. data/lib/dropbox_api/results/list_folder_get_latest_cursor_result.rb +2 -1
  188. data/lib/dropbox_api/results/list_folder_longpoll_result.rb +3 -2
  189. data/lib/dropbox_api/results/list_folder_result.rb +4 -3
  190. data/lib/dropbox_api/results/list_revisions_result.rb +3 -2
  191. data/lib/dropbox_api/results/list_shared_links_result.rb +4 -3
  192. data/lib/dropbox_api/results/relocation_batch_result.rb +5 -4
  193. data/lib/dropbox_api/results/relocation_batch_result_entry.rb +1 -0
  194. data/lib/dropbox_api/results/save_copy_reference_result.rb +2 -1
  195. data/lib/dropbox_api/results/save_url_job_status.rb +7 -6
  196. data/lib/dropbox_api/results/save_url_result.rb +2 -1
  197. data/lib/dropbox_api/results/search/match.rb +3 -2
  198. data/lib/dropbox_api/results/search_v2_result.rb +24 -0
  199. data/lib/dropbox_api/results/share_folder_launch.rb +4 -3
  200. data/lib/dropbox_api/results/shared_file_members.rb +5 -4
  201. data/lib/dropbox_api/results/shared_folder_members.rb +5 -4
  202. data/lib/dropbox_api/results/upload_session_start.rb +2 -1
  203. data/lib/dropbox_api/results/void_result.rb +1 -0
  204. data/lib/dropbox_api/version.rb +2 -1
  205. data/yardoc/endpoint_handler.rb +2 -1
  206. data/yardoc/helpers/html_helper.rb +2 -1
  207. data/yardoc/rspec.rb +8 -7
  208. data/yardoc/templates/default/method_details/setup.rb +1 -0
  209. metadata +24 -16
  210. data/.rubocop_todo.yml +0 -442
  211. data/CHANGES.md +0 -7
  212. data/lib/dropbox_api/results/search_result.rb +0 -22
@@ -1,7 +1,8 @@
1
+ # frozen_string_literal: true
1
2
  module DropboxApi::Endpoints::Files
2
3
  class CreateFolder < DropboxApi::Endpoints::Rpc
3
4
  Method = :post
4
- Path = "/2/files/create_folder".freeze
5
+ Path = '/2/files/create_folder'
5
6
  ResultType = DropboxApi::Metadata::Folder
6
7
  ErrorType = DropboxApi::Errors::CreateFolderError
7
8
 
@@ -11,7 +12,7 @@ module DropboxApi::Endpoints::Files
11
12
  # @return [DropboxApi::Metadata::Folder] The new folder.
12
13
  add_endpoint :create_folder do |path|
13
14
  perform_request({
14
- :path => path
15
+ path: path
15
16
  })
16
17
  end
17
18
  end
@@ -1,7 +1,8 @@
1
+ # frozen_string_literal: true
1
2
  module DropboxApi::Endpoints::Files
2
3
  class CreateFolderBatch < DropboxApi::Endpoints::Rpc
3
4
  Method = :post
4
- Path = "/2/files/create_folder_batch".freeze
5
+ Path = '/2/files/create_folder_batch'
5
6
  ResultType = DropboxApi::Results::CreateFolderBatchResult
6
7
 
7
8
  include DropboxApi::OptionsValidator
@@ -33,7 +34,7 @@ module DropboxApi::Endpoints::Files
33
34
  options[:force_async] ||= false
34
35
 
35
36
  perform_request(options.merge({
36
- :paths => paths
37
+ paths: paths
37
38
  }))
38
39
  end
39
40
  end
@@ -1,7 +1,8 @@
1
+ # frozen_string_literal: true
1
2
  module DropboxApi::Endpoints::Files
2
3
  class CreateFolderBatchCheck < DropboxApi::Endpoints::Rpc
3
4
  Method = :post
4
- Path = "/2/files/create_folder_batch/check".freeze
5
+ Path = '/2/files/create_folder_batch/check'
5
6
  ResultType = DropboxApi::Results::CreateFolderBatchResult
6
7
  ErrorType = DropboxApi::Errors::PollError
7
8
 
@@ -14,7 +15,7 @@ module DropboxApi::Endpoints::Files
14
15
  # @return [Array] A list of one result for each entry.
15
16
  add_endpoint :create_folder_batch_check do |async_job_id|
16
17
  perform_request({
17
- :async_job_id => async_job_id
18
+ async_job_id: async_job_id
18
19
  })
19
20
  end
20
21
  end
@@ -1,7 +1,8 @@
1
+ # frozen_string_literal: true
1
2
  module DropboxApi::Endpoints::Files
2
3
  class Delete < DropboxApi::Endpoints::Rpc
3
4
  Method = :post
4
- Path = "/2/files/delete".freeze
5
+ Path = '/2/files/delete'
5
6
  ResultType = DropboxApi::Metadata::Resource
6
7
  ErrorType = DropboxApi::Errors::DeleteError
7
8
 
@@ -25,7 +26,7 @@ module DropboxApi::Endpoints::Files
25
26
  validate_options([:parent_rev], options)
26
27
 
27
28
  perform_request options.merge({
28
- :path => path
29
+ path: path
29
30
  })
30
31
  end
31
32
  end
@@ -1,7 +1,8 @@
1
+ # frozen_string_literal: true
1
2
  module DropboxApi::Endpoints::Files
2
3
  class DeleteBatch < DropboxApi::Endpoints::Rpc
3
4
  Method = :post
4
- Path = "/2/files/delete_batch".freeze
5
+ Path = '/2/files/delete_batch'
5
6
  ResultType = DropboxApi::Results::DeleteBatchResult
6
7
 
7
8
  # Delete multiple files/folders at once.
@@ -15,7 +16,7 @@ module DropboxApi::Endpoints::Files
15
16
  # @return [String, Array] Either the job id or the list of job statuses.
16
17
  add_endpoint :delete_batch do |entries|
17
18
  perform_request({
18
- :entries => entries
19
+ entries: entries
19
20
  })
20
21
  end
21
22
  end
@@ -1,7 +1,8 @@
1
+ # frozen_string_literal: true
1
2
  module DropboxApi::Endpoints::Files
2
3
  class DeleteBatchCheck < DropboxApi::Endpoints::Rpc
3
4
  Method = :post
4
- Path = "/2/files/delete_batch/check".freeze
5
+ Path = '/2/files/delete_batch/check'
5
6
  ResultType = DropboxApi::Results::DeleteBatchResult
6
7
  ErrorType = DropboxApi::Errors::PollError
7
8
 
@@ -13,7 +14,7 @@ module DropboxApi::Endpoints::Files
13
14
  # flag or a list of job statuses.
14
15
  add_endpoint :delete_batch_check do |async_job_id|
15
16
  perform_request({
16
- :async_job_id => async_job_id
17
+ async_job_id: async_job_id
17
18
  })
18
19
  end
19
20
  end
@@ -1,7 +1,8 @@
1
+ # frozen_string_literal: true
1
2
  module DropboxApi::Endpoints::Files
2
3
  class Download < DropboxApi::Endpoints::ContentDownload
3
4
  Method = :post
4
- Path = "/2/files/download".freeze
5
+ Path = '/2/files/download'
5
6
  ResultType = DropboxApi::Metadata::File
6
7
  ErrorType = DropboxApi::Errors::DownloadError
7
8
 
@@ -9,7 +10,7 @@ module DropboxApi::Endpoints::Files
9
10
  #
10
11
  # @param path [String] The path of the file to download.
11
12
  add_endpoint :download do |path, &block|
12
- perform_request({:path => path}, &block)
13
+ perform_request({path: path}, &block)
13
14
  end
14
15
  end
15
16
  end
@@ -1,7 +1,8 @@
1
+ # frozen_string_literal: true
1
2
  module DropboxApi::Endpoints::Files
2
3
  class GetMetadata < DropboxApi::Endpoints::Rpc
3
4
  Method = :post
4
- Path = "/2/files/get_metadata".freeze
5
+ Path = '/2/files/get_metadata'
5
6
  ResultType = DropboxApi::Metadata::Resource
6
7
  ErrorType = DropboxApi::Errors::GetMetadataError
7
8
 
@@ -34,7 +35,7 @@ module DropboxApi::Endpoints::Files
34
35
  ], options)
35
36
 
36
37
  perform_request(options.merge({
37
- :path => path
38
+ path: path
38
39
  }))
39
40
  end
40
41
  end
@@ -1,7 +1,8 @@
1
+ # frozen_string_literal: true
1
2
  module DropboxApi::Endpoints::Files
2
3
  class GetPreview < DropboxApi::Endpoints::ContentDownload
3
4
  Method = :post
4
- Path = "/2/files/get_preview".freeze
5
+ Path = '/2/files/get_preview'
5
6
  ResultType = DropboxApi::Metadata::File
6
7
  ErrorType = DropboxApi::Errors::PreviewError
7
8
 
@@ -11,7 +12,7 @@ module DropboxApi::Endpoints::Files
11
12
  #
12
13
  # @param path [String] The path of the file to preview.
13
14
  add_endpoint :get_preview do |path, &block|
14
- perform_request({:path => path}, &block)
15
+ perform_request({path: path}, &block)
15
16
  end
16
17
  end
17
18
  end
@@ -1,7 +1,8 @@
1
+ # frozen_string_literal: true
1
2
  module DropboxApi::Endpoints::Files
2
3
  class GetTemporaryLink < DropboxApi::Endpoints::Rpc
3
4
  Method = :post
4
- Path = "/2/files/get_temporary_link".freeze
5
+ Path = '/2/files/get_temporary_link'
5
6
  ResultType = DropboxApi::Results::GetTemporaryLinkResult
6
7
  ErrorType = DropboxApi::Errors::GetMetadataError
7
8
 
@@ -11,7 +12,7 @@ module DropboxApi::Endpoints::Files
11
12
  #
12
13
  # @param path [String] The path to the file you want a temporary link to.
13
14
  add_endpoint :get_temporary_link do |path|
14
- perform_request({:path => path})
15
+ perform_request({path: path})
15
16
  end
16
17
  end
17
18
  end
@@ -1,7 +1,8 @@
1
+ # frozen_string_literal: true
1
2
  module DropboxApi::Endpoints::Files
2
3
  class GetThumbnail < DropboxApi::Endpoints::ContentDownload
3
4
  Method = :post
4
- Path = "/2/files/get_thumbnail".freeze
5
+ Path = '/2/files/get_thumbnail'
5
6
  ResultType = DropboxApi::Metadata::File
6
7
  ErrorType = DropboxApi::Errors::PreviewError
7
8
 
@@ -50,7 +51,7 @@ module DropboxApi::Endpoints::Files
50
51
  options[:size] ||= :w64h64
51
52
 
52
53
  perform_request(options.merge({
53
- :path => path
54
+ path: path
54
55
  }), &block)
55
56
  end
56
57
  end
@@ -1,7 +1,8 @@
1
+ # frozen_string_literal: true
1
2
  module DropboxApi::Endpoints::Files
2
3
  class GetThumbnailBatch < DropboxApi::Endpoints::RpcContent
3
4
  Method = :post
4
- Path = "/2/files/get_thumbnail_batch".freeze
5
+ Path = '/2/files/get_thumbnail_batch'
5
6
  ResultType = DropboxApi::Results::GetThumbnailBatchResult
6
7
  ErrorType = DropboxApi::Errors::ThumbnailBatchError
7
8
 
@@ -25,12 +26,12 @@ module DropboxApi::Endpoints::Files
25
26
  options[:size] ||= :w64h64
26
27
  options[:mode] ||= :strict
27
28
 
28
- perform_request :entries => build_entries_params(paths, options)
29
+ perform_request entries: build_entries_params(paths, options)
29
30
  end
30
31
 
31
32
  def build_entries_params(paths, options)
32
33
  paths.map do |path|
33
- options.merge({ :path => path })
34
+ options.merge({ path: path })
34
35
  end
35
36
  end
36
37
 
@@ -1,7 +1,8 @@
1
+ # frozen_string_literal: true
1
2
  module DropboxApi::Endpoints::Files
2
3
  class ListFolder < DropboxApi::Endpoints::Rpc
3
4
  Method = :post
4
- Path = "/2/files/list_folder".freeze
5
+ Path = '/2/files/list_folder'
5
6
  ResultType = DropboxApi::Results::ListFolderResult
6
7
  ErrorType = DropboxApi::Errors::ListFolderError
7
8
 
@@ -41,7 +42,7 @@ module DropboxApi::Endpoints::Files
41
42
  options[:limit] = options[:limit] if options[:limit]
42
43
 
43
44
  perform_request options.merge({
44
- :path => path
45
+ path: path
45
46
  })
46
47
  end
47
48
 
@@ -1,10 +1,11 @@
1
+ # frozen_string_literal: true
1
2
  module DropboxApi::Endpoints::Files
2
3
  class ListFolderContinue < DropboxApi::Endpoints::Rpc
3
4
  # NOTE: This hasn't been tested with real data, I couldn't make a query
4
5
  # long enough to enable the `has_more` attribute in the
5
6
  # `ListFolderResult`.
6
7
  Method = :post
7
- Path = "/2/files/list_folder/continue".freeze
8
+ Path = '/2/files/list_folder/continue'
8
9
  ResultType = DropboxApi::Results::ListFolderResult
9
10
  ErrorType = DropboxApi::Errors::ListFolderContinueError
10
11
 
@@ -14,7 +15,7 @@ module DropboxApi::Endpoints::Files
14
15
  # @param cursor [String] The cursor returned by your last call to
15
16
  # list_folder or list_folder_continue.
16
17
  add_endpoint :list_folder_continue do |cursor|
17
- perform_request :cursor => cursor
18
+ perform_request cursor: cursor
18
19
  end
19
20
  end
20
21
  end
@@ -1,7 +1,8 @@
1
+ # frozen_string_literal: true
1
2
  module DropboxApi::Endpoints::Files
2
3
  class ListFolderGetLatestCursor < DropboxApi::Endpoints::Rpc
3
4
  Method = :post
4
- Path = "/2/files/list_folder/get_latest_cursor".freeze
5
+ Path = '/2/files/list_folder/get_latest_cursor'
5
6
  ResultType = DropboxApi::Results::ListFolderGetLatestCursorResult
6
7
  ErrorType = DropboxApi::Errors::ListFolderError
7
8
 
@@ -1,7 +1,8 @@
1
+ # frozen_string_literal: true
1
2
  module DropboxApi::Endpoints::Files
2
3
  class ListFolderLongpoll < DropboxApi::Endpoints::RpcNotify
3
4
  Method = :post
4
- Path = "/2/files/list_folder/longpoll".freeze
5
+ Path = '/2/files/list_folder/longpoll'
5
6
  ResultType = DropboxApi::Results::ListFolderLongpollResult
6
7
  ErrorType = DropboxApi::Errors::ListFolderLongpollError
7
8
 
@@ -28,7 +29,7 @@ module DropboxApi::Endpoints::Files
28
29
  options[:timeout] ||= 30
29
30
 
30
31
  perform_request options.merge({
31
- :cursor => cursor
32
+ cursor: cursor
32
33
  })
33
34
  end
34
35
  end
@@ -1,7 +1,8 @@
1
+ # frozen_string_literal: true
1
2
  module DropboxApi::Endpoints::Files
2
3
  class ListRevisions < DropboxApi::Endpoints::Rpc
3
4
  Method = :post
4
- Path = "/2/files/list_revisions".freeze
5
+ Path = '/2/files/list_revisions'
5
6
  ResultType = DropboxApi::Results::ListRevisionsResult
6
7
  ErrorType = DropboxApi::Errors::ListRevisionsError
7
8
 
@@ -19,7 +20,7 @@ module DropboxApi::Endpoints::Files
19
20
  options[:limit] ||= 10
20
21
 
21
22
  perform_request options.merge({
22
- :path => path
23
+ path: path
23
24
  })
24
25
  end
25
26
  end
@@ -1,7 +1,8 @@
1
+ # frozen_string_literal: true
1
2
  module DropboxApi::Endpoints::Files
2
3
  class Move < DropboxApi::Endpoints::Rpc
3
4
  Method = :post
4
- Path = "/2/files/move".freeze
5
+ Path = '/2/files/move'
5
6
  ResultType = DropboxApi::Metadata::Resource
6
7
  ErrorType = DropboxApi::Errors::RelocationError
7
8
 
@@ -25,8 +26,8 @@ module DropboxApi::Endpoints::Files
25
26
  ], options)
26
27
 
27
28
  perform_request options.merge({
28
- :from_path => from,
29
- :to_path => to
29
+ from_path: from,
30
+ to_path: to
30
31
  })
31
32
  end
32
33
  end
@@ -1,7 +1,8 @@
1
+ # frozen_string_literal: true
1
2
  module DropboxApi::Endpoints::Files
2
3
  class PermanentlyDelete < DropboxApi::Endpoints::Rpc
3
4
  Method = :post
4
- Path = "/2/files/permanently_delete".freeze
5
+ Path = '/2/files/permanently_delete'
5
6
  ResultType = DropboxApi::Results::VoidResult
6
7
  ErrorType = DropboxApi::Errors::DeleteError
7
8
 
@@ -21,7 +22,7 @@ module DropboxApi::Endpoints::Files
21
22
  validate_options([:parent_rev], options)
22
23
 
23
24
  perform_request options.merge({
24
- :path => path
25
+ path: path
25
26
  })
26
27
  end
27
28
  end
@@ -1,7 +1,8 @@
1
+ # frozen_string_literal: true
1
2
  module DropboxApi::Endpoints::Files
2
3
  class Restore < DropboxApi::Endpoints::Rpc
3
4
  Method = :post
4
- Path = "/2/files/restore".freeze
5
+ Path = '/2/files/restore'
5
6
  ResultType = DropboxApi::Metadata::File
6
7
  ErrorType = DropboxApi::Errors::RestoreError
7
8
 
@@ -11,8 +12,8 @@ module DropboxApi::Endpoints::Files
11
12
  # @param rev [String] The revision to restore for the file.
12
13
  add_endpoint :restore do |path, rev|
13
14
  perform_request({
14
- :path => path,
15
- :rev => rev
15
+ path: path,
16
+ rev: rev
16
17
  })
17
18
  end
18
19
  end
@@ -1,7 +1,8 @@
1
+ # frozen_string_literal: true
1
2
  module DropboxApi::Endpoints::Files
2
3
  class SaveUrl < DropboxApi::Endpoints::Rpc
3
4
  Method = :post
4
- Path = "/2/files/save_url".freeze
5
+ Path = '/2/files/save_url'
5
6
  ResultType = DropboxApi::Results::SaveUrlResult
6
7
  ErrorType = DropboxApi::Errors::SaveUrlError
7
8
 
@@ -14,8 +15,8 @@ module DropboxApi::Endpoints::Files
14
15
  # @return Either the saved file or a reference to the async job.
15
16
  add_endpoint :save_url do |path, url|
16
17
  perform_request({
17
- :path => path,
18
- :url => url
18
+ path: path,
19
+ url: url
19
20
  })
20
21
  end
21
22
  end
@@ -1,7 +1,8 @@
1
+ # frozen_string_literal: true
1
2
  module DropboxApi::Endpoints::Files
2
3
  class SaveUrlCheckJobStatus < DropboxApi::Endpoints::Rpc
3
4
  Method = :post
4
- Path = "/2/files/save_url/check_job_status".freeze
5
+ Path = '/2/files/save_url/check_job_status'
5
6
  ResultType = DropboxApi::Results::SaveUrlJobStatus
6
7
  ErrorType = DropboxApi::Errors::PollError
7
8
 
@@ -12,7 +13,7 @@ module DropboxApi::Endpoints::Files
12
13
  # @return The current status of the job.
13
14
  add_endpoint :save_url_check_job_status do |job_id|
14
15
  perform_request({
15
- :async_job_id => job_id
16
+ async_job_id: job_id
16
17
  })
17
18
  end
18
19
  end
@@ -1,8 +1,9 @@
1
+ # frozen_string_literal: true
1
2
  module DropboxApi::Endpoints::Files
2
3
  class Search < DropboxApi::Endpoints::Rpc
3
4
  Method = :post
4
- Path = "/2/files/search".freeze
5
- ResultType = DropboxApi::Results::SearchResult
5
+ Path = '/2/files/search_v2'
6
+ ResultType = DropboxApi::Results::SearchV2Result
6
7
  ErrorType = DropboxApi::Errors::SearchError
7
8
 
8
9
  include DropboxApi::OptionsValidator
@@ -12,32 +13,20 @@ module DropboxApi::Endpoints::Files
12
13
  # Note: Recent changes may not immediately be reflected in search results
13
14
  # due to a short delay in indexing.
14
15
  #
15
- # @param query [String] The string to search for. The search string is
16
- # split on spaces into multiple tokens. For file name searching, the last
17
- # token is used for prefix matching (i.e. "bat c" matches "bat cave" but
18
- # not "batman car").
19
- # @param path [String] The path in the user's Dropbox to search.
20
- # @option options start [Numeric] The starting index within the search
21
- # results (used for paging). The default for this field is 0.
22
- # @option options max_results [Numeric] The maximum number of search
23
- # results to return. The default for this field is 100.
24
- # @option options mode [:filename, :filename_and_content, :deleted_filename]
25
- # The search mode. Note that searching file content is only
26
- # available for Dropbox Business accounts. The default is filename.
27
- add_endpoint :search do |query, path = "", options = {}|
28
- validate_options([
29
- :start,
30
- :max_results,
31
- :mode
32
- ], options)
33
- options[:start] ||= 0
34
- options[:max_results] ||= 100
35
- options[:mode] ||= :filename
16
+ # @param query [String] The string to search for. May match across
17
+ # multiple fields based on the request arguments.
18
+ # @param options [DropboxApi::Metadata::SearchOptions] Options for more
19
+ # targeted search results. This field is optional.
20
+ # @param match_field_options [DropboxApi::Metadata::SearchMatchFieldOptions]
21
+ # Options for search results match fields. This field is optional.
22
+ add_endpoint :search do |query, options = nil, match_field_options = nil|
23
+ params = { query: query }
36
24
 
37
- perform_request options.merge({
38
- :query => query,
39
- :path => path
40
- })
25
+ params[:options] = options.to_hash unless options.nil?
26
+
27
+ params[:match_field_options] = match_field_options.to_hash unless match_field_options.nil?
28
+
29
+ perform_request(params)
41
30
  end
42
31
  end
43
32
  end