dropbox_api 0.1.19 → 0.1.20
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +113 -22
- data/docs/DropboxApi/Authenticator.html +12 -12
- data/docs/DropboxApi/ChunkedUploader.html +20 -20
- data/docs/DropboxApi/Client.html +1673 -906
- data/docs/DropboxApi/ConnectionBuilder.html +16 -16
- data/docs/DropboxApi/Endpoints/Auth/TokenRevoke.html +10 -10
- data/docs/DropboxApi/Endpoints/Auth.html +6 -6
- data/docs/DropboxApi/Endpoints/Base.html +9 -9
- data/docs/DropboxApi/Endpoints/ContentDownload.html +19 -19
- data/docs/DropboxApi/Endpoints/ContentUpload.html +17 -17
- data/docs/DropboxApi/Endpoints/Files/Copy.html +12 -12
- data/docs/DropboxApi/Endpoints/Files/CopyBatch.html +11 -11
- data/docs/DropboxApi/Endpoints/Files/CopyBatchCheck.html +11 -11
- data/docs/DropboxApi/Endpoints/Files/CopyReferenceGet.html +11 -11
- data/docs/DropboxApi/Endpoints/Files/CopyReferenceSave.html +12 -12
- data/docs/DropboxApi/Endpoints/Files/CreateFileRequest.html +12 -12
- data/docs/DropboxApi/Endpoints/Files/CreateFolder.html +11 -11
- data/docs/DropboxApi/Endpoints/Files/CreateFolderBatch.html +11 -11
- data/docs/DropboxApi/Endpoints/Files/CreateFolderBatchCheck.html +11 -11
- data/docs/DropboxApi/Endpoints/Files/Delete.html +11 -11
- data/docs/DropboxApi/Endpoints/Files/DeleteBatch.html +11 -11
- data/docs/DropboxApi/Endpoints/Files/DeleteBatchCheck.html +11 -11
- data/docs/DropboxApi/Endpoints/Files/Download.html +11 -11
- data/docs/DropboxApi/Endpoints/Files/GetMetadata.html +11 -11
- data/docs/DropboxApi/Endpoints/Files/GetPreview.html +11 -11
- data/docs/DropboxApi/Endpoints/Files/GetTemporaryLink.html +11 -11
- data/docs/DropboxApi/Endpoints/Files/GetThumbnail.html +11 -11
- data/docs/DropboxApi/Endpoints/Files/GetThumbnailBatch.html +15 -15
- data/docs/DropboxApi/Endpoints/Files/ListFolder.html +11 -11
- data/docs/DropboxApi/Endpoints/Files/ListFolderContinue.html +11 -11
- data/docs/DropboxApi/Endpoints/Files/ListFolderGetLatestCursor.html +10 -10
- data/docs/DropboxApi/Endpoints/Files/ListFolderLongpoll.html +11 -11
- data/docs/DropboxApi/Endpoints/Files/ListRevisions.html +11 -11
- data/docs/DropboxApi/Endpoints/Files/Move.html +12 -12
- data/docs/DropboxApi/Endpoints/Files/PermanentlyDelete.html +11 -11
- data/docs/DropboxApi/Endpoints/Files/Restore.html +12 -12
- data/docs/DropboxApi/Endpoints/Files/SaveUrl.html +12 -12
- data/docs/DropboxApi/Endpoints/Files/SaveUrlCheckJobStatus.html +11 -11
- data/docs/DropboxApi/Endpoints/Files/Search.html +48 -96
- data/docs/DropboxApi/Endpoints/Files/Upload.html +10 -10
- data/docs/DropboxApi/Endpoints/Files/UploadSessionAppendV2.html +11 -11
- data/docs/DropboxApi/Endpoints/Files/UploadSessionFinish.html +12 -12
- data/docs/DropboxApi/Endpoints/Files/UploadSessionStart.html +12 -12
- data/docs/DropboxApi/Endpoints/Files.html +6 -6
- data/docs/DropboxApi/Endpoints/Rpc.html +17 -17
- data/docs/DropboxApi/Endpoints/RpcContent.html +11 -11
- data/docs/DropboxApi/Endpoints/RpcNotify.html +11 -11
- data/docs/DropboxApi/Endpoints/Sharing/AddFileMember.html +12 -12
- data/docs/DropboxApi/Endpoints/Sharing/AddFolderMember.html +12 -12
- data/docs/DropboxApi/Endpoints/Sharing/CreateSharedLinkWithSettings.html +12 -12
- data/docs/DropboxApi/Endpoints/Sharing/GetSharedLinkMetadata.html +11 -11
- data/docs/DropboxApi/Endpoints/Sharing/ListFileMembers.html +12 -12
- data/docs/DropboxApi/Endpoints/Sharing/ListFolderMembers.html +12 -12
- data/docs/DropboxApi/Endpoints/Sharing/ListSharedLinks.html +10 -10
- data/docs/DropboxApi/Endpoints/Sharing/RevokeSharedLink.html +11 -11
- data/docs/DropboxApi/Endpoints/Sharing/ShareFolder.html +11 -11
- data/docs/DropboxApi/Endpoints/Sharing/UnshareFile.html +11 -11
- data/docs/DropboxApi/Endpoints/Sharing.html +6 -6
- data/docs/DropboxApi/Endpoints/Users/GetAccount.html +11 -11
- data/docs/DropboxApi/Endpoints/Users/GetAccountBatch.html +11 -11
- data/docs/DropboxApi/Endpoints/Users/GetCurrentAccount.html +10 -10
- data/docs/DropboxApi/Endpoints/Users/GetSpaceUsage.html +10 -10
- data/docs/DropboxApi/Endpoints/Users.html +6 -6
- data/docs/DropboxApi/Endpoints.html +6 -6
- data/docs/DropboxApi/Errors/AddFileMemberError.html +10 -10
- data/docs/DropboxApi/Errors/AddFolderMemberError.html +16 -16
- data/docs/DropboxApi/Errors/AddMemberSelectorError.html +11 -11
- data/docs/DropboxApi/Errors/AlreadySharedError.html +9 -9
- data/docs/DropboxApi/Errors/BadPathError.html +6 -6
- data/docs/DropboxApi/Errors/BasicError.html +17 -17
- data/docs/DropboxApi/Errors/CantCopySharedFolderError.html +6 -6
- data/docs/DropboxApi/Errors/CantMoveFolderIntoItselfError.html +6 -6
- data/docs/DropboxApi/Errors/CantNestSharedFolderError.html +6 -6
- data/docs/DropboxApi/Errors/CantShareOutsideTeamError.html +6 -6
- data/docs/DropboxApi/Errors/ContainsSharedFolderError.html +6 -6
- data/docs/DropboxApi/Errors/ConversionError.html +6 -6
- data/docs/DropboxApi/Errors/CreateFileRequestError.html +6 -6
- data/docs/DropboxApi/Errors/CreateFolderBatchError.html +7 -7
- data/docs/DropboxApi/Errors/CreateFolderError.html +7 -7
- data/docs/DropboxApi/Errors/CreateSharedLinkWithSettingsError.html +11 -11
- data/docs/DropboxApi/Errors/CursorClosedError.html +6 -6
- data/docs/DropboxApi/Errors/CursorNotClosedError.html +6 -6
- data/docs/DropboxApi/Errors/DeleteError.html +9 -9
- data/docs/DropboxApi/Errors/DisallowedNameError.html +6 -6
- data/docs/DropboxApi/Errors/DisallowedSharedLinkPolicyError.html +6 -6
- data/docs/DropboxApi/Errors/DownloadError.html +7 -7
- data/docs/DropboxApi/Errors/DownloadFailedError.html +6 -6
- data/docs/DropboxApi/Errors/EmailUnverifiedError.html +6 -6
- data/docs/DropboxApi/Errors/FileAncestorConflictError.html +6 -6
- data/docs/DropboxApi/Errors/FileConflictError.html +6 -6
- data/docs/DropboxApi/Errors/FileMemberActionError.html +10 -10
- data/docs/DropboxApi/Errors/FolderConflictError.html +6 -6
- data/docs/DropboxApi/Errors/GetAccountError.html +7 -7
- data/docs/DropboxApi/Errors/GetCopyReferenceError.html +7 -7
- data/docs/DropboxApi/Errors/GetMetadataError.html +7 -7
- data/docs/DropboxApi/Errors/GroupDeletedError.html +6 -6
- data/docs/DropboxApi/Errors/GroupNotOnTeamError.html +6 -6
- data/docs/DropboxApi/Errors/HttpError.html +6 -6
- data/docs/DropboxApi/Errors/InProgressError.html +6 -6
- data/docs/DropboxApi/Errors/InsideAppFolderError.html +6 -6
- data/docs/DropboxApi/Errors/InsideOsxPackageError.html +6 -6
- data/docs/DropboxApi/Errors/InsidePublicFolderError.html +6 -6
- data/docs/DropboxApi/Errors/InsideSharedFolderError.html +6 -6
- data/docs/DropboxApi/Errors/InsufficientPlanError.html +6 -6
- data/docs/DropboxApi/Errors/InsufficientSpaceError.html +6 -6
- data/docs/DropboxApi/Errors/InternalError.html +6 -6
- data/docs/DropboxApi/Errors/InvalidCommentError.html +6 -6
- data/docs/DropboxApi/Errors/InvalidCopyReferenceError.html +6 -6
- data/docs/DropboxApi/Errors/InvalidCursorError.html +6 -6
- data/docs/DropboxApi/Errors/InvalidDropboxIdError.html +6 -6
- data/docs/DropboxApi/Errors/InvalidEmailError.html +6 -6
- data/docs/DropboxApi/Errors/InvalidFileError.html +6 -6
- data/docs/DropboxApi/Errors/InvalidIdError.html +6 -6
- data/docs/DropboxApi/Errors/InvalidMemberError.html +6 -6
- data/docs/DropboxApi/Errors/InvalidPathError.html +6 -6
- data/docs/DropboxApi/Errors/InvalidRevisionError.html +6 -6
- data/docs/DropboxApi/Errors/InvalidSettingsError.html +6 -6
- data/docs/DropboxApi/Errors/InvalidUrlError.html +6 -6
- data/docs/DropboxApi/Errors/IsAppFolderError.html +6 -6
- data/docs/DropboxApi/Errors/IsFileError.html +6 -6
- data/docs/DropboxApi/Errors/IsFolderError.html +6 -6
- data/docs/DropboxApi/Errors/IsOsxPackageError.html +6 -6
- data/docs/DropboxApi/Errors/IsPublicFolderError.html +6 -6
- data/docs/DropboxApi/Errors/ListFolderContinueError.html +8 -8
- data/docs/DropboxApi/Errors/ListFolderError.html +7 -7
- data/docs/DropboxApi/Errors/ListFolderLongpollError.html +7 -7
- data/docs/DropboxApi/Errors/ListRevisionsError.html +7 -7
- data/docs/DropboxApi/Errors/ListSharedLinksError.html +8 -8
- data/docs/DropboxApi/Errors/LookupError.html +11 -11
- data/docs/DropboxApi/Errors/MalformedPathError.html +6 -6
- data/docs/DropboxApi/Errors/NoAccountError.html +6 -6
- data/docs/DropboxApi/Errors/NoPermissionError.html +6 -6
- data/docs/DropboxApi/Errors/NoWritePermissionError.html +6 -6
- data/docs/DropboxApi/Errors/NotAMemberError.html +6 -6
- data/docs/DropboxApi/Errors/NotFileError.html +6 -6
- data/docs/DropboxApi/Errors/NotFolderError.html +6 -6
- data/docs/DropboxApi/Errors/NotFoundError.html +6 -6
- data/docs/DropboxApi/Errors/PollError.html +8 -8
- data/docs/DropboxApi/Errors/PreviewError.html +10 -10
- data/docs/DropboxApi/Errors/RateLimitError.html +6 -6
- data/docs/DropboxApi/Errors/RelocationBatchEntryError.html +9 -9
- data/docs/DropboxApi/Errors/RelocationError.html +13 -13
- data/docs/DropboxApi/Errors/RestoreError.html +9 -9
- data/docs/DropboxApi/Errors/RestrictedContentError.html +6 -6
- data/docs/DropboxApi/Errors/RevokeSharedLinkError.html +10 -10
- data/docs/DropboxApi/Errors/SaveCopyReferenceError.html +11 -11
- data/docs/DropboxApi/Errors/SaveUrlError.html +10 -10
- data/docs/DropboxApi/Errors/SearchError.html +7 -7
- data/docs/DropboxApi/Errors/SettingsError.html +8 -8
- data/docs/DropboxApi/Errors/ShareFolderError.html +11 -11
- data/docs/DropboxApi/Errors/SharePathError.html +17 -17
- data/docs/DropboxApi/Errors/SharedFolderAccessError.html +10 -10
- data/docs/DropboxApi/Errors/SharedLinkAccessDeniedError.html +6 -6
- data/docs/DropboxApi/Errors/SharedLinkAlreadyExistsError.html +6 -6
- data/docs/DropboxApi/Errors/SharedLinkError.html +9 -9
- data/docs/DropboxApi/Errors/SharedLinkMalformedError.html +6 -6
- data/docs/DropboxApi/Errors/SharedLinkNotFoundError.html +6 -6
- data/docs/DropboxApi/Errors/SharingFileAccessError.html +11 -11
- data/docs/DropboxApi/Errors/SharingUserError.html +7 -7
- data/docs/DropboxApi/Errors/TeamFolderError.html +6 -6
- data/docs/DropboxApi/Errors/TeamPolicyDisallowsMemberPolicyError.html +6 -6
- data/docs/DropboxApi/Errors/ThumbnailBatchError.html +7 -7
- data/docs/DropboxApi/Errors/ThumbnailError.html +10 -10
- data/docs/DropboxApi/Errors/TooManyFilesError.html +6 -6
- data/docs/DropboxApi/Errors/TooManyMembersError.html +6 -6
- data/docs/DropboxApi/Errors/TooManyPendingInvitesError.html +6 -6
- data/docs/DropboxApi/Errors/TooManyRequestsError.html +15 -15
- data/docs/DropboxApi/Errors/TooManySharedFolderTargetsError.html +6 -6
- data/docs/DropboxApi/Errors/TooManyWriteOperationsError.html +6 -6
- data/docs/DropboxApi/Errors/UnmountedError.html +6 -6
- data/docs/DropboxApi/Errors/UnshareFileError.html +8 -8
- data/docs/DropboxApi/Errors/UnsupportedContentError.html +6 -6
- data/docs/DropboxApi/Errors/UnsupportedExtensionError.html +6 -6
- data/docs/DropboxApi/Errors/UnsupportedImageError.html +6 -6
- data/docs/DropboxApi/Errors/UnsupportedLinkTypeError.html +6 -6
- data/docs/DropboxApi/Errors/UnverifiedDropboxId.html +6 -6
- data/docs/DropboxApi/Errors/UploadError.html +7 -7
- data/docs/DropboxApi/Errors/UploadSessionFinishError.html +9 -9
- data/docs/DropboxApi/Errors/UploadSessionLookupError.html +10 -10
- data/docs/DropboxApi/Errors/UploadSessionOffsetError.html +10 -10
- data/docs/DropboxApi/Errors/UploadWriteFailedError.html +7 -7
- data/docs/DropboxApi/Errors/WriteConflictError.html +9 -9
- data/docs/DropboxApi/Errors/WriteError.html +11 -11
- data/docs/DropboxApi/Errors.html +6 -6
- data/docs/DropboxApi/Metadata/AccessLevel.html +9 -9
- data/docs/DropboxApi/Metadata/AddFileMemberResult.html +6 -6
- data/docs/DropboxApi/Metadata/AddMember.html +11 -11
- data/docs/DropboxApi/Metadata/Base.html +24 -24
- data/docs/DropboxApi/Metadata/BasicAccount.html +6 -6
- data/docs/DropboxApi/Metadata/CommitInfo.html +9 -9
- data/docs/DropboxApi/Metadata/Deleted.html +6 -6
- data/docs/DropboxApi/Metadata/Dimensions.html +6 -6
- data/docs/DropboxApi/Metadata/Field.html +24 -20
- data/docs/DropboxApi/Metadata/File.html +10 -10
- data/docs/DropboxApi/Metadata/FileCategoriesList.html +205 -0
- data/docs/DropboxApi/Metadata/FileCategory.html +250 -0
- data/docs/DropboxApi/Metadata/FileExtensionsList.html +213 -0
- data/docs/DropboxApi/Metadata/FileLinkMetadata.html +6 -6
- data/docs/DropboxApi/Metadata/FileMemberAction.html +10 -10
- data/docs/DropboxApi/Metadata/FileRequest.html +6 -6
- data/docs/DropboxApi/Metadata/FileStatus.html +242 -0
- data/docs/DropboxApi/Metadata/Folder.html +10 -10
- data/docs/DropboxApi/Metadata/FolderLinkMetadata.html +6 -6
- data/docs/DropboxApi/Metadata/FolderSharingInfo.html +6 -6
- data/docs/DropboxApi/Metadata/LinkPermissions.html +6 -6
- data/docs/DropboxApi/Metadata/Location.html +6 -6
- data/docs/DropboxApi/Metadata/MediaInfo.html +9 -9
- data/docs/DropboxApi/Metadata/MediaMetadata.html +9 -9
- data/docs/DropboxApi/Metadata/Member.html +13 -13
- data/docs/DropboxApi/Metadata/MemberAction.html +9 -9
- data/docs/DropboxApi/Metadata/MemberActionList.html +9 -9
- data/docs/DropboxApi/Metadata/MemberPermission.html +6 -6
- data/docs/DropboxApi/Metadata/MemberPermissionList.html +10 -10
- data/docs/DropboxApi/Metadata/MetadataV2.html +140 -0
- data/docs/DropboxApi/Metadata/Name.html +6 -6
- data/docs/DropboxApi/Metadata/ParentFolderAccessInfo.html +6 -6
- data/docs/DropboxApi/Metadata/PhotoMetadata.html +6 -6
- data/docs/DropboxApi/Metadata/Resource.html +10 -10
- data/docs/DropboxApi/Metadata/SearchMatchFieldOptions.html +140 -0
- data/docs/DropboxApi/Metadata/SearchMatchTypeV2.html +244 -0
- data/docs/DropboxApi/Metadata/SearchMatchV2.html +216 -0
- data/docs/DropboxApi/Metadata/SearchOptions.html +140 -0
- data/docs/DropboxApi/Metadata/SearchOrderBy.html +242 -0
- data/docs/DropboxApi/Metadata/SharedFolder.html +6 -6
- data/docs/DropboxApi/Metadata/SharedFolderPolicy.html +6 -6
- data/docs/DropboxApi/Metadata/SharedLink.html +18 -18
- data/docs/DropboxApi/Metadata/SharedLinkMetadata.html +10 -10
- data/docs/DropboxApi/Metadata/SpaceAllocation.html +6 -6
- data/docs/DropboxApi/Metadata/SpaceUsage.html +6 -6
- data/docs/DropboxApi/Metadata/Tag.html +14 -14
- data/docs/DropboxApi/Metadata/Team.html +6 -6
- data/docs/DropboxApi/Metadata/TeamMemberInfo.html +6 -6
- data/docs/DropboxApi/Metadata/ThumbnailBatchResultData.html +6 -6
- data/docs/DropboxApi/Metadata/ThumbnailBatchResultEntry.html +11 -11
- data/docs/DropboxApi/Metadata/UploadSessionCursor.html +9 -9
- data/docs/DropboxApi/Metadata/VideoMetadata.html +6 -6
- data/docs/DropboxApi/Metadata/WriteMode.html +21 -21
- data/docs/DropboxApi/Metadata.html +8 -8
- data/docs/DropboxApi/MiddleWare/DecodeResult.html +13 -13
- data/docs/DropboxApi/MiddleWare/Stack.html +22 -22
- data/docs/DropboxApi/MiddleWare.html +6 -6
- data/docs/DropboxApi/OptionsValidator.html +9 -9
- data/docs/DropboxApi/ResultBuilder.html +30 -30
- data/docs/DropboxApi/Results/AddFileMemberResultList.html +10 -10
- data/docs/DropboxApi/Results/Base.html +11 -11
- data/docs/DropboxApi/Results/BasicAccountBatch.html +10 -10
- data/docs/DropboxApi/Results/CopyBatchResult.html +10 -10
- data/docs/DropboxApi/Results/CreateFolderBatchResult.html +13 -13
- data/docs/DropboxApi/Results/CreateFolderBatchResultEntry.html +9 -9
- data/docs/DropboxApi/Results/DeleteBatchResult.html +13 -13
- data/docs/DropboxApi/Results/DeleteBatchResultEntry.html +9 -9
- data/docs/DropboxApi/Results/GetCopyReferenceResult.html +18 -18
- data/docs/DropboxApi/Results/GetTemporaryLinkResult.html +14 -14
- data/docs/DropboxApi/Results/GetThumbnailBatchResult.html +10 -10
- data/docs/DropboxApi/Results/ListFolderGetLatestCursorResult.html +10 -10
- data/docs/DropboxApi/Results/ListFolderLongpollResult.html +14 -14
- data/docs/DropboxApi/Results/ListFolderResult.html +18 -18
- data/docs/DropboxApi/Results/ListRevisionsResult.html +14 -14
- data/docs/DropboxApi/Results/ListSharedLinksResult.html +18 -18
- data/docs/DropboxApi/Results/RelocationBatchResult.html +13 -13
- data/docs/DropboxApi/Results/RelocationBatchResultEntry.html +9 -9
- data/docs/DropboxApi/Results/SaveCopyReferenceResult.html +10 -10
- data/docs/DropboxApi/Results/SaveUrlJobStatus.html +15 -15
- data/docs/DropboxApi/Results/SaveUrlResult.html +10 -10
- data/docs/DropboxApi/Results/Search/Match.html +18 -18
- data/docs/DropboxApi/Results/Search.html +6 -6
- data/docs/DropboxApi/Results/SearchV2Result.html +368 -0
- data/docs/DropboxApi/Results/ShareFolderLaunch.html +12 -12
- data/docs/DropboxApi/Results/SharedFileMembers.html +22 -22
- data/docs/DropboxApi/Results/SharedFolderMembers.html +22 -22
- data/docs/DropboxApi/Results/UploadSessionStart.html +10 -10
- data/docs/DropboxApi/Results/VoidResult.html +6 -6
- data/docs/DropboxApi/Results.html +8 -8
- data/docs/DropboxApi.html +7 -7
- data/docs/DropboxScaffoldBuilder.html +220 -108
- data/docs/_index.html +86 -16
- data/docs/class_list.html +3 -3
- data/docs/css/common.css +3 -0
- data/docs/css/style.css +3 -2
- data/docs/file.README.html +28 -23
- data/docs/file.api_coverage.html +14 -14
- data/docs/file.rails_setup.html +10 -10
- data/docs/file_list.html +2 -2
- data/docs/frames.html +2 -2
- data/docs/index.html +28 -23
- data/docs/js/app.js +14 -3
- data/docs/method_list.html +338 -266
- data/docs/top-level-namespace.html +6 -6
- data/lib/dropbox_api/authenticator.rb +2 -6
- data/lib/dropbox_api/client.rb +23 -2
- data/lib/dropbox_api/connection_builder.rb +38 -4
- data/lib/dropbox_api/endpoints/base.rb +24 -1
- data/lib/dropbox_api/endpoints/content_download.rb +2 -2
- data/lib/dropbox_api/endpoints/content_upload.rb +2 -2
- data/lib/dropbox_api/endpoints/files/search_continue.rb +23 -0
- data/lib/dropbox_api/endpoints/rpc.rb +2 -2
- data/lib/dropbox_api/endpoints/rpc_content.rb +2 -2
- data/lib/dropbox_api/endpoints/rpc_notify.rb +2 -2
- data/lib/dropbox_api/errors/expired_access_token_error.rb +5 -0
- data/lib/dropbox_api/metadata/basic_account.rb +7 -1
- data/lib/dropbox_api/metadata/namespace_id.rb +10 -0
- data/lib/dropbox_api/metadata/root_info.rb +32 -0
- data/lib/dropbox_api/metadata/team_root_info.rb +8 -0
- data/lib/dropbox_api/metadata/user_root_info.rb +7 -0
- data/lib/dropbox_api/middleware/path_root.rb +35 -0
- data/lib/dropbox_api/results/search_v2_result.rb +2 -3
- data/lib/dropbox_api/version.rb +1 -1
- data/lib/dropbox_api.rb +10 -3
- metadata +21 -3
data/docs/css/common.css
CHANGED
data/docs/css/style.css
CHANGED
@@ -52,6 +52,7 @@ body {
|
|
52
52
|
background: #fff;
|
53
53
|
padding: 1.2em;
|
54
54
|
padding-top: 0.2em;
|
55
|
+
box-sizing: border-box;
|
55
56
|
}
|
56
57
|
|
57
58
|
@media (max-width: 920px) {
|
@@ -422,8 +423,8 @@ li.r2 { background: #fafafa; }
|
|
422
423
|
#toc ol { padding-left: 1.8em; }
|
423
424
|
#toc li { font-size: 1.1em; line-height: 1.7em; }
|
424
425
|
#toc > ol > li { font-size: 1.1em; font-weight: bold; }
|
425
|
-
#toc ol > ol { font-size: 0.9em; }
|
426
|
-
#toc ol ol > ol { padding-left: 2.3em; }
|
426
|
+
#toc ol > li > ol { font-size: 0.9em; }
|
427
|
+
#toc ol ol > li > ol { padding-left: 2.3em; }
|
427
428
|
#toc ol + li { margin-top: 0.3em; }
|
428
429
|
#toc.hidden { padding: 10px; background: #fefefe; box-shadow: none; }
|
429
430
|
#toc.hidden:hover { background: #fafafa; }
|
data/docs/file.README.html
CHANGED
@@ -6,15 +6,15 @@
|
|
6
6
|
<title>
|
7
7
|
File: README
|
8
8
|
|
9
|
-
— Documentation by YARD 0.9.
|
9
|
+
— Documentation by YARD 0.9.26
|
10
10
|
|
11
11
|
</title>
|
12
12
|
|
13
|
-
<link rel="stylesheet" href="css/style.css" type="text/css"
|
13
|
+
<link rel="stylesheet" href="css/style.css" type="text/css" />
|
14
14
|
|
15
|
-
<link rel="stylesheet" href="css/common.css" type="text/css"
|
15
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" />
|
16
16
|
|
17
|
-
<script type="text/javascript"
|
17
|
+
<script type="text/javascript">
|
18
18
|
pathId = "README";
|
19
19
|
relpath = '';
|
20
20
|
</script>
|
@@ -57,11 +57,11 @@
|
|
57
57
|
<div class="clear"></div>
|
58
58
|
</div>
|
59
59
|
|
60
|
-
<div id="content"><div id='filecontents'><h1>DropboxApi</h1>
|
60
|
+
<div id="content"><div id='filecontents'><h1 id="dropboxapi">DropboxApi</h1>
|
61
61
|
|
62
62
|
<p>Library for communicating with Dropbox API v2.</p>
|
63
63
|
|
64
|
-
<h2>Installation</h2>
|
64
|
+
<h2 id="installation">Installation</h2>
|
65
65
|
|
66
66
|
<p>Add this line to your application's Gemfile:</p>
|
67
67
|
|
@@ -78,7 +78,7 @@
|
|
78
78
|
<pre class="code ruby"><code class="ruby">$ gem install dropbox_api
|
79
79
|
</code></pre>
|
80
80
|
|
81
|
-
<h2>Documentation</h2>
|
81
|
+
<h2 id="documentation">Documentation</h2>
|
82
82
|
|
83
83
|
<p>Please, refer to this gem's custom <a href="http://jesus.github.io/dropbox_api">Dropbox API
|
84
84
|
documentation</a>.
|
@@ -96,9 +96,9 @@ an example of its usage.</li>
|
|
96
96
|
use them.</li>
|
97
97
|
</ul>
|
98
98
|
|
99
|
-
<h2>Basic set up</h2>
|
99
|
+
<h2 id="basic-set-up">Basic set up</h2>
|
100
100
|
|
101
|
-
<h3>Authorize your application</h3>
|
101
|
+
<h3 id="authorize-your-application">Authorize your application</h3>
|
102
102
|
|
103
103
|
<p>Dropbox uses OAuth, in order to use this library from your application you'll
|
104
104
|
have to get an authorization code.</p>
|
@@ -119,7 +119,7 @@ have to get an authorization code.</p>
|
|
119
119
|
<p>Note that setting an ENV variable is only a feasible choice if you're only
|
120
120
|
using one account.</p>
|
121
121
|
|
122
|
-
<h4>Option A: Get your access token from the website</h4>
|
122
|
+
<h4 id="option-a-get-your-access-token-from-the-website">Option A: Get your access token from the website</h4>
|
123
123
|
|
124
124
|
<p>The easiest way to obtain an access token is to get it from the Dropbox website.
|
125
125
|
You just need to log in to Dropbox and refer to the <em>developers</em> section, go to
|
@@ -129,7 +129,7 @@ haven't done so yet.</p>
|
|
129
129
|
<p>Under your application settings, find section <em>OAuth 2</em>. You'll find a button
|
130
130
|
to generate an access token.</p>
|
131
131
|
|
132
|
-
<h4>Option B: Use <code>DropboxApi::Authenticator</code></h4>
|
132
|
+
<h4 id="option-b-use-dropboxapi-authenticator">Option B: Use <code>DropboxApi::Authenticator</code></h4>
|
133
133
|
|
134
134
|
<p>You can obtain an authorization code with this library:</p>
|
135
135
|
|
@@ -144,7 +144,7 @@ to generate an access token.</p>
|
|
144
144
|
</span><span class='comment'># Keep this token, you'll need it to initialize a `DropboxApi::Client` object
|
145
145
|
</span></code></pre>
|
146
146
|
|
147
|
-
<h4>Standard OAuth 2 flow</h4>
|
147
|
+
<h4 id="standard-oauth-2-flow">Standard OAuth 2 flow</h4>
|
148
148
|
|
149
149
|
<p>This is what many web applications will use. The process is described in
|
150
150
|
Dropbox's <a href="https://www.dropbox.com/developers/reference/oauth-guide#oauth-2-on-the-web">OAuth guide</a>.</p>
|
@@ -152,7 +152,7 @@ Dropbox's <a href="https://www.dropbox.com/developers/reference/oauth-guide#
|
|
152
152
|
<p>If you have a Rails application, you might be interested in this <a href="http://jesus.github.io/dropbox_api/file.rails_setup.html">setup
|
153
153
|
guide</a>.</p>
|
154
154
|
|
155
|
-
<h3>Performing API calls</h3>
|
155
|
+
<h3 id="performing-api-calls">Performing API calls</h3>
|
156
156
|
|
157
157
|
<p>Once you've initialized a client, for example:</p>
|
158
158
|
|
@@ -174,7 +174,7 @@ guide</a>.</p>
|
|
174
174
|
perform API calls. You can check the class' documentation to find
|
175
175
|
<a href="http://jesus.github.io/dropbox_api/DropboxApi/Client.html">all available endpoints</a>.</p>
|
176
176
|
|
177
|
-
<h3>Large file uploads</h3>
|
177
|
+
<h3 id="large-file-uploads">Large file uploads</h3>
|
178
178
|
|
179
179
|
<p>If you need to upload files larger than 150MB the default <code>#upload</code> endpoint
|
180
180
|
won't work. Instead, you need to start a upload session and upload
|
@@ -194,21 +194,21 @@ example:</p>
|
|
194
194
|
<a href="http://www.xuuso.com/dropbox_api/DropboxApi/Client.html#upload_by_chunks-instance_method">method documentation</a>
|
195
195
|
to find out all available options.</p>
|
196
196
|
|
197
|
-
<h2>Dependencies</h2>
|
197
|
+
<h2 id="dependencies">Dependencies</h2>
|
198
198
|
|
199
199
|
<p>This gem depends on
|
200
200
|
<a href="https://github.com/oauth-xx/oauth2">oauth2</a>
|
201
201
|
and
|
202
202
|
<a href="https://github.com/lostisland/faraday">faraday</a>.</p>
|
203
203
|
|
204
|
-
<p>It has official support for Ruby versions <code>
|
204
|
+
<p>It has official support for Ruby versions <code>2.x</code>.</p>
|
205
205
|
|
206
|
-
<h2>Development</h2>
|
206
|
+
<h2 id="development">Development</h2>
|
207
207
|
|
208
208
|
<p>After checking out the repo, run <code>bin/setup</code> to install dependencies. Then, run
|
209
209
|
<code>bin/console</code> for an interactive prompt that will allow you to experiment.</p>
|
210
210
|
|
211
|
-
<h3>Testing</h3>
|
211
|
+
<h3 id="testing">Testing</h3>
|
212
212
|
|
213
213
|
<p>I recommend you to use a test account other than your main one.</p>
|
214
214
|
|
@@ -224,7 +224,12 @@ will pass. If it doesn't exist you may need to write it yourself, check
|
|
224
224
|
the <code>DropboxScaffoldBuilder</code> class to find all existing scaffold builders.</p>
|
225
225
|
|
226
226
|
<pre class="code text"><code class="text">DROPBOX_OAUTH_BEARER=YOUR_AUTH_BEARER rake test:build_scaffold[list_folder]
|
227
|
-
</code></pre
|
227
|
+
</code></pre>
|
228
|
+
|
229
|
+
<p>Note that you'll have to type <code>rake test:build_scaffold\[list_folder\]</code>
|
230
|
+
if you use <code>zsh</code>.</p>
|
231
|
+
|
232
|
+
<p>You can build all available scaffolds with just <code>rake test:build_scaffold</code>.</p></li>
|
228
233
|
<li><p>Run the tests and the cassettes will be written:</p>
|
229
234
|
|
230
235
|
<pre class="code text"><code class="text">DROPBOX_OAUTH_BEARER=YOUR_AUTH_BEARER rspec spec/endpoints/files/list_folder_spec.rb
|
@@ -235,11 +240,11 @@ the <code>DropboxScaffoldBuilder</code> class to find all existing scaffold buil
|
|
235
240
|
been filtered. However, you may want to double check before pushing your
|
236
241
|
updates to Github.</p>
|
237
242
|
|
238
|
-
<p>Tip:
|
243
|
+
<p>Tip: you can simply run <code>export DROPBOX_OAUTH_BEARER=YOUR_AUTH_BEARER</code> at
|
239
244
|
the beginning of your work session so you don't need to prefix it in every
|
240
245
|
command line.</p>
|
241
246
|
|
242
|
-
<h2>Contributing</h2>
|
247
|
+
<h2 id="contributing">Contributing</h2>
|
243
248
|
|
244
249
|
<p>Any help will be much appreciated. The easiest way to help is to implement one
|
245
250
|
or more of the <a href="http://jesus.github.io/dropbox_api/file.api_coverage.html">endpoints that are still pending</a>. To see how the
|
@@ -247,9 +252,9 @@ endpoints are implemented, check out the <code>lib/dropbox_api/endpoints</code>
|
|
247
252
|
</div></div>
|
248
253
|
|
249
254
|
<div id="footer">
|
250
|
-
Generated on
|
255
|
+
Generated on Sun Feb 7 11:51:54 2021 by
|
251
256
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
252
|
-
0.9.
|
257
|
+
0.9.26 (ruby-2.5.1).
|
253
258
|
</div>
|
254
259
|
|
255
260
|
</div>
|
data/docs/file.api_coverage.html
CHANGED
@@ -6,15 +6,15 @@
|
|
6
6
|
<title>
|
7
7
|
File: API Implementation Coverage
|
8
8
|
|
9
|
-
— Documentation by YARD 0.9.
|
9
|
+
— Documentation by YARD 0.9.26
|
10
10
|
|
11
11
|
</title>
|
12
12
|
|
13
|
-
<link rel="stylesheet" href="css/style.css" type="text/css"
|
13
|
+
<link rel="stylesheet" href="css/style.css" type="text/css" />
|
14
14
|
|
15
|
-
<link rel="stylesheet" href="css/common.css" type="text/css"
|
15
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" />
|
16
16
|
|
17
|
-
<script type="text/javascript"
|
17
|
+
<script type="text/javascript">
|
18
18
|
pathId = "api_coverage";
|
19
19
|
relpath = '';
|
20
20
|
</script>
|
@@ -65,7 +65,7 @@ implemented.</p>
|
|
65
65
|
of the endpoint has been implemented but some options may be missing. Guess
|
66
66
|
what new moon means.</p>
|
67
67
|
|
68
|
-
<h2>File properties</h2>
|
68
|
+
<h2 id="file-properties">File properties</h2>
|
69
69
|
|
70
70
|
<table><thead>
|
71
71
|
<tr>
|
@@ -119,7 +119,7 @@ what new moon means.</p>
|
|
119
119
|
</tr>
|
120
120
|
</tbody></table>
|
121
121
|
|
122
|
-
<h2>File requests</h2>
|
122
|
+
<h2 id="file-requests">File requests</h2>
|
123
123
|
|
124
124
|
<table><thead>
|
125
125
|
<tr>
|
@@ -145,7 +145,7 @@ what new moon means.</p>
|
|
145
145
|
</tr>
|
146
146
|
</tbody></table>
|
147
147
|
|
148
|
-
<h2>Files</h2>
|
148
|
+
<h2 id="files">Files</h2>
|
149
149
|
|
150
150
|
<table><thead>
|
151
151
|
<tr>
|
@@ -278,7 +278,7 @@ what new moon means.</p>
|
|
278
278
|
<td style="text-align: center">🌕</td>
|
279
279
|
</tr>
|
280
280
|
<tr>
|
281
|
-
<td><code>/
|
281
|
+
<td><code>/search_v2</code></td>
|
282
282
|
<td style="text-align: center">🌔</td>
|
283
283
|
</tr>
|
284
284
|
<tr>
|
@@ -311,7 +311,7 @@ what new moon means.</p>
|
|
311
311
|
</tr>
|
312
312
|
</tbody></table>
|
313
313
|
|
314
|
-
<h2>Paper</h2>
|
314
|
+
<h2 id="paper">Paper</h2>
|
315
315
|
|
316
316
|
<table><thead>
|
317
317
|
<tr>
|
@@ -385,7 +385,7 @@ what new moon means.</p>
|
|
385
385
|
</tr>
|
386
386
|
</tbody></table>
|
387
387
|
|
388
|
-
<h2>Sharing</h2>
|
388
|
+
<h2 id="sharing">Sharing</h2>
|
389
389
|
|
390
390
|
<table><thead>
|
391
391
|
<tr>
|
@@ -551,7 +551,7 @@ what new moon means.</p>
|
|
551
551
|
</tr>
|
552
552
|
</tbody></table>
|
553
553
|
|
554
|
-
<h2>Users</h2>
|
554
|
+
<h2 id="users">Users</h2>
|
555
555
|
|
556
556
|
<table><thead>
|
557
557
|
<tr>
|
@@ -577,7 +577,7 @@ what new moon means.</p>
|
|
577
577
|
</tr>
|
578
578
|
</tbody></table>
|
579
579
|
|
580
|
-
<h2>Dropbox Business API</h2>
|
580
|
+
<h2 id="dropbox-business-api">Dropbox Business API</h2>
|
581
581
|
|
582
582
|
<p>Unfortunately, none of the Dropbox Business endpoints have been implemented.
|
583
583
|
If this is a problem for you, please <a href="https://github.com/Jesus/dropbox_api/issues/new">open an
|
@@ -585,9 +585,9 @@ issue</a>.</p>
|
|
585
585
|
</div></div>
|
586
586
|
|
587
587
|
<div id="footer">
|
588
|
-
Generated on
|
588
|
+
Generated on Sun Feb 7 11:51:54 2021 by
|
589
589
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
590
|
-
0.9.
|
590
|
+
0.9.26 (ruby-2.5.1).
|
591
591
|
</div>
|
592
592
|
|
593
593
|
</div>
|
data/docs/file.rails_setup.html
CHANGED
@@ -6,15 +6,15 @@
|
|
6
6
|
<title>
|
7
7
|
File: Rails setup
|
8
8
|
|
9
|
-
— Documentation by YARD 0.9.
|
9
|
+
— Documentation by YARD 0.9.26
|
10
10
|
|
11
11
|
</title>
|
12
12
|
|
13
|
-
<link rel="stylesheet" href="css/style.css" type="text/css"
|
13
|
+
<link rel="stylesheet" href="css/style.css" type="text/css" />
|
14
14
|
|
15
|
-
<link rel="stylesheet" href="css/common.css" type="text/css"
|
15
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" />
|
16
16
|
|
17
|
-
<script type="text/javascript"
|
17
|
+
<script type="text/javascript">
|
18
18
|
pathId = "rails_setup";
|
19
19
|
relpath = '';
|
20
20
|
</script>
|
@@ -57,7 +57,7 @@
|
|
57
57
|
<div class="clear"></div>
|
58
58
|
</div>
|
59
59
|
|
60
|
-
<div id="content"><div id='filecontents'><h1>Standard OAuth 2 flow set up</h1>
|
60
|
+
<div id="content"><div id='filecontents'><h1 id="standard-oauth-2-flow-set-up">Standard OAuth 2 flow set up</h1>
|
61
61
|
|
62
62
|
<p>This document describes how to implement the OAuth2 flow in a Rails
|
63
63
|
application, the process is represented in the following diagram:</p>
|
@@ -66,7 +66,7 @@ application, the process is represented in the following diagram:</p>
|
|
66
66
|
|
67
67
|
<p>Source: <a href="https://www.dropbox.com/developers/reference/oauth-guide#oauth-2-on-the-web">https://www.dropbox.com/developers/reference/oauth-guide#oauth-2-on-the-web</a></p>
|
68
68
|
|
69
|
-
<h2>1. Set up some new routes</h2>
|
69
|
+
<h2 id="1-set-up-some-new-routes">1. Set up some new routes</h2>
|
70
70
|
|
71
71
|
<p>You'll have to create a couple of new routes:</p>
|
72
72
|
|
@@ -80,7 +80,7 @@ will redirect to Dropbox.</p>
|
|
80
80
|
<p>The other route, <code>dropbox/auth_callback</code>, will process the authentication token
|
81
81
|
that we'll receive from Dropbox. Steps 4 & 5.</p>
|
82
82
|
|
83
|
-
<h2>2. Set up a Dropbox controller</h2>
|
83
|
+
<h2 id="2-set-up-a-dropbox-controller">2. Set up a Dropbox controller</h2>
|
84
84
|
|
85
85
|
<pre class="code ruby"><code class="ruby"><span class='kw'>class</span> <span class='const'>DropboxController</span> <span class='op'><</span> <span class='const'>ApplicationController</span>
|
86
86
|
<span class='comment'># Example call:
|
@@ -121,7 +121,7 @@ that we'll receive from Dropbox. Steps 4 & 5.</p>
|
|
121
121
|
<span class='kw'>end</span>
|
122
122
|
</code></pre>
|
123
123
|
|
124
|
-
<h2>3. Set up redirect URI in your Dropbox app settings</h2>
|
124
|
+
<h2 id="3-set-up-redirect-uri-in-your-dropbox-app-settings">3. Set up redirect URI in your Dropbox app settings</h2>
|
125
125
|
|
126
126
|
<p>In the previous code, you probably noticed that we're providing a <code>redirect_uri</code>
|
127
127
|
parameter. This is where the user will be redirected to after accepting our
|
@@ -142,9 +142,9 @@ settings.</li>
|
|
142
142
|
</div></div>
|
143
143
|
|
144
144
|
<div id="footer">
|
145
|
-
Generated on
|
145
|
+
Generated on Sun Feb 7 11:51:54 2021 by
|
146
146
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
147
|
-
0.9.
|
147
|
+
0.9.26 (ruby-2.5.1).
|
148
148
|
</div>
|
149
149
|
|
150
150
|
</div>
|
data/docs/file_list.html
CHANGED
@@ -4,9 +4,9 @@
|
|
4
4
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
5
5
|
<meta charset="utf-8" />
|
6
6
|
|
7
|
-
<link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen"
|
7
|
+
<link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" />
|
8
8
|
|
9
|
-
<link rel="stylesheet" href="css/common.css" type="text/css" media="screen"
|
9
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" />
|
10
10
|
|
11
11
|
|
12
12
|
|
data/docs/frames.html
CHANGED
@@ -2,9 +2,9 @@
|
|
2
2
|
<html>
|
3
3
|
<head>
|
4
4
|
<meta charset="utf-8">
|
5
|
-
<title>Documentation by YARD 0.9.
|
5
|
+
<title>Documentation by YARD 0.9.26</title>
|
6
6
|
</head>
|
7
|
-
<script type="text/javascript"
|
7
|
+
<script type="text/javascript">
|
8
8
|
var match = unescape(window.location.hash).match(/^#!(.+)/);
|
9
9
|
var name = match ? match[1] : 'index.html';
|
10
10
|
name = name.replace(/^(\w+):\/\//, '').replace(/^\/\//, '');
|
data/docs/index.html
CHANGED
@@ -6,15 +6,15 @@
|
|
6
6
|
<title>
|
7
7
|
File: README
|
8
8
|
|
9
|
-
— Documentation by YARD 0.9.
|
9
|
+
— Documentation by YARD 0.9.26
|
10
10
|
|
11
11
|
</title>
|
12
12
|
|
13
|
-
<link rel="stylesheet" href="css/style.css" type="text/css"
|
13
|
+
<link rel="stylesheet" href="css/style.css" type="text/css" />
|
14
14
|
|
15
|
-
<link rel="stylesheet" href="css/common.css" type="text/css"
|
15
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" />
|
16
16
|
|
17
|
-
<script type="text/javascript"
|
17
|
+
<script type="text/javascript">
|
18
18
|
pathId = "README";
|
19
19
|
relpath = '';
|
20
20
|
</script>
|
@@ -57,11 +57,11 @@
|
|
57
57
|
<div class="clear"></div>
|
58
58
|
</div>
|
59
59
|
|
60
|
-
<div id="content"><div id='filecontents'><h1>DropboxApi</h1>
|
60
|
+
<div id="content"><div id='filecontents'><h1 id="dropboxapi">DropboxApi</h1>
|
61
61
|
|
62
62
|
<p>Library for communicating with Dropbox API v2.</p>
|
63
63
|
|
64
|
-
<h2>Installation</h2>
|
64
|
+
<h2 id="installation">Installation</h2>
|
65
65
|
|
66
66
|
<p>Add this line to your application's Gemfile:</p>
|
67
67
|
|
@@ -78,7 +78,7 @@
|
|
78
78
|
<pre class="code ruby"><code class="ruby">$ gem install dropbox_api
|
79
79
|
</code></pre>
|
80
80
|
|
81
|
-
<h2>Documentation</h2>
|
81
|
+
<h2 id="documentation">Documentation</h2>
|
82
82
|
|
83
83
|
<p>Please, refer to this gem's custom <a href="http://jesus.github.io/dropbox_api">Dropbox API
|
84
84
|
documentation</a>.
|
@@ -96,9 +96,9 @@ an example of its usage.</li>
|
|
96
96
|
use them.</li>
|
97
97
|
</ul>
|
98
98
|
|
99
|
-
<h2>Basic set up</h2>
|
99
|
+
<h2 id="basic-set-up">Basic set up</h2>
|
100
100
|
|
101
|
-
<h3>Authorize your application</h3>
|
101
|
+
<h3 id="authorize-your-application">Authorize your application</h3>
|
102
102
|
|
103
103
|
<p>Dropbox uses OAuth, in order to use this library from your application you'll
|
104
104
|
have to get an authorization code.</p>
|
@@ -119,7 +119,7 @@ have to get an authorization code.</p>
|
|
119
119
|
<p>Note that setting an ENV variable is only a feasible choice if you're only
|
120
120
|
using one account.</p>
|
121
121
|
|
122
|
-
<h4>Option A: Get your access token from the website</h4>
|
122
|
+
<h4 id="option-a-get-your-access-token-from-the-website">Option A: Get your access token from the website</h4>
|
123
123
|
|
124
124
|
<p>The easiest way to obtain an access token is to get it from the Dropbox website.
|
125
125
|
You just need to log in to Dropbox and refer to the <em>developers</em> section, go to
|
@@ -129,7 +129,7 @@ haven't done so yet.</p>
|
|
129
129
|
<p>Under your application settings, find section <em>OAuth 2</em>. You'll find a button
|
130
130
|
to generate an access token.</p>
|
131
131
|
|
132
|
-
<h4>Option B: Use <code>DropboxApi::Authenticator</code></h4>
|
132
|
+
<h4 id="option-b-use-dropboxapi-authenticator">Option B: Use <code>DropboxApi::Authenticator</code></h4>
|
133
133
|
|
134
134
|
<p>You can obtain an authorization code with this library:</p>
|
135
135
|
|
@@ -144,7 +144,7 @@ to generate an access token.</p>
|
|
144
144
|
</span><span class='comment'># Keep this token, you'll need it to initialize a `DropboxApi::Client` object
|
145
145
|
</span></code></pre>
|
146
146
|
|
147
|
-
<h4>Standard OAuth 2 flow</h4>
|
147
|
+
<h4 id="standard-oauth-2-flow">Standard OAuth 2 flow</h4>
|
148
148
|
|
149
149
|
<p>This is what many web applications will use. The process is described in
|
150
150
|
Dropbox's <a href="https://www.dropbox.com/developers/reference/oauth-guide#oauth-2-on-the-web">OAuth guide</a>.</p>
|
@@ -152,7 +152,7 @@ Dropbox's <a href="https://www.dropbox.com/developers/reference/oauth-guide#
|
|
152
152
|
<p>If you have a Rails application, you might be interested in this <a href="http://jesus.github.io/dropbox_api/file.rails_setup.html">setup
|
153
153
|
guide</a>.</p>
|
154
154
|
|
155
|
-
<h3>Performing API calls</h3>
|
155
|
+
<h3 id="performing-api-calls">Performing API calls</h3>
|
156
156
|
|
157
157
|
<p>Once you've initialized a client, for example:</p>
|
158
158
|
|
@@ -174,7 +174,7 @@ guide</a>.</p>
|
|
174
174
|
perform API calls. You can check the class' documentation to find
|
175
175
|
<a href="http://jesus.github.io/dropbox_api/DropboxApi/Client.html">all available endpoints</a>.</p>
|
176
176
|
|
177
|
-
<h3>Large file uploads</h3>
|
177
|
+
<h3 id="large-file-uploads">Large file uploads</h3>
|
178
178
|
|
179
179
|
<p>If you need to upload files larger than 150MB the default <code>#upload</code> endpoint
|
180
180
|
won't work. Instead, you need to start a upload session and upload
|
@@ -194,21 +194,21 @@ example:</p>
|
|
194
194
|
<a href="http://www.xuuso.com/dropbox_api/DropboxApi/Client.html#upload_by_chunks-instance_method">method documentation</a>
|
195
195
|
to find out all available options.</p>
|
196
196
|
|
197
|
-
<h2>Dependencies</h2>
|
197
|
+
<h2 id="dependencies">Dependencies</h2>
|
198
198
|
|
199
199
|
<p>This gem depends on
|
200
200
|
<a href="https://github.com/oauth-xx/oauth2">oauth2</a>
|
201
201
|
and
|
202
202
|
<a href="https://github.com/lostisland/faraday">faraday</a>.</p>
|
203
203
|
|
204
|
-
<p>It has official support for Ruby versions <code>
|
204
|
+
<p>It has official support for Ruby versions <code>2.x</code>.</p>
|
205
205
|
|
206
|
-
<h2>Development</h2>
|
206
|
+
<h2 id="development">Development</h2>
|
207
207
|
|
208
208
|
<p>After checking out the repo, run <code>bin/setup</code> to install dependencies. Then, run
|
209
209
|
<code>bin/console</code> for an interactive prompt that will allow you to experiment.</p>
|
210
210
|
|
211
|
-
<h3>Testing</h3>
|
211
|
+
<h3 id="testing">Testing</h3>
|
212
212
|
|
213
213
|
<p>I recommend you to use a test account other than your main one.</p>
|
214
214
|
|
@@ -224,7 +224,12 @@ will pass. If it doesn't exist you may need to write it yourself, check
|
|
224
224
|
the <code>DropboxScaffoldBuilder</code> class to find all existing scaffold builders.</p>
|
225
225
|
|
226
226
|
<pre class="code text"><code class="text">DROPBOX_OAUTH_BEARER=YOUR_AUTH_BEARER rake test:build_scaffold[list_folder]
|
227
|
-
</code></pre
|
227
|
+
</code></pre>
|
228
|
+
|
229
|
+
<p>Note that you'll have to type <code>rake test:build_scaffold\[list_folder\]</code>
|
230
|
+
if you use <code>zsh</code>.</p>
|
231
|
+
|
232
|
+
<p>You can build all available scaffolds with just <code>rake test:build_scaffold</code>.</p></li>
|
228
233
|
<li><p>Run the tests and the cassettes will be written:</p>
|
229
234
|
|
230
235
|
<pre class="code text"><code class="text">DROPBOX_OAUTH_BEARER=YOUR_AUTH_BEARER rspec spec/endpoints/files/list_folder_spec.rb
|
@@ -235,11 +240,11 @@ the <code>DropboxScaffoldBuilder</code> class to find all existing scaffold buil
|
|
235
240
|
been filtered. However, you may want to double check before pushing your
|
236
241
|
updates to Github.</p>
|
237
242
|
|
238
|
-
<p>Tip:
|
243
|
+
<p>Tip: you can simply run <code>export DROPBOX_OAUTH_BEARER=YOUR_AUTH_BEARER</code> at
|
239
244
|
the beginning of your work session so you don't need to prefix it in every
|
240
245
|
command line.</p>
|
241
246
|
|
242
|
-
<h2>Contributing</h2>
|
247
|
+
<h2 id="contributing">Contributing</h2>
|
243
248
|
|
244
249
|
<p>Any help will be much appreciated. The easiest way to help is to implement one
|
245
250
|
or more of the <a href="http://jesus.github.io/dropbox_api/file.api_coverage.html">endpoints that are still pending</a>. To see how the
|
@@ -247,9 +252,9 @@ endpoints are implemented, check out the <code>lib/dropbox_api/endpoints</code>
|
|
247
252
|
</div></div>
|
248
253
|
|
249
254
|
<div id="footer">
|
250
|
-
Generated on
|
255
|
+
Generated on Sun Feb 7 11:51:54 2021 by
|
251
256
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
252
|
-
0.9.
|
257
|
+
0.9.26 (ruby-2.5.1).
|
253
258
|
</div>
|
254
259
|
|
255
260
|
</div>
|
data/docs/js/app.js
CHANGED
@@ -171,6 +171,7 @@ function generateTOC() {
|
|
171
171
|
var counter = 0;
|
172
172
|
var tags = ['h2', 'h3', 'h4', 'h5', 'h6'];
|
173
173
|
var i;
|
174
|
+
var curli;
|
174
175
|
if ($('#filecontents h1').length > 1) tags.unshift('h1');
|
175
176
|
for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
|
176
177
|
var lastTag = parseInt(tags[0][1], 10);
|
@@ -190,15 +191,25 @@ function generateTOC() {
|
|
190
191
|
}
|
191
192
|
if (thisTag > lastTag) {
|
192
193
|
for (i = 0; i < thisTag - lastTag; i++) {
|
193
|
-
|
194
|
+
if ( typeof(curli) == "undefined" ) {
|
195
|
+
curli = $('<li/>');
|
196
|
+
toc.append(curli);
|
197
|
+
}
|
198
|
+
toc = $('<ol/>');
|
199
|
+
curli.append(toc);
|
200
|
+
curli = undefined;
|
194
201
|
}
|
195
202
|
}
|
196
203
|
if (thisTag < lastTag) {
|
197
|
-
for (i = 0; i < lastTag - thisTag; i++)
|
204
|
+
for (i = 0; i < lastTag - thisTag; i++) {
|
205
|
+
toc = toc.parent();
|
206
|
+
toc = toc.parent();
|
207
|
+
}
|
198
208
|
}
|
199
209
|
var title = $(this).attr('toc-title');
|
200
210
|
if (typeof(title) == "undefined") title = $(this).text();
|
201
|
-
|
211
|
+
curli =$('<li><a href="#' + this.id + '">' + title + '</a></li>');
|
212
|
+
toc.append(curli);
|
202
213
|
lastTag = thisTag;
|
203
214
|
});
|
204
215
|
if (!show) return;
|