Class: DropboxClient

Inherits:
Object
  • Object
show all
Defined in:
lib/dropbox_sdk.rb

Overview

Use this class to make Dropbox API calls. You’ll need to obtain an OAuth 2 access token first; you can get one using either DropboxOAuth2Flow or DropboxOAuth2FlowNoRedirect.

Defined Under Namespace

Classes: ChunkedUploader

Constant Summary collapse

RESERVED_CHARACTERS =

From the oauth spec plus “/”. Slash should not be ecsaped

/[^a-zA-Z0-9\-\.\_\~\/]/

Instance Method Summary collapse

Constructor Details

#initialize(oauth2_access_token, root = "auto", locale = nil) ⇒ DropboxClient

Args:

  • oauth2_access_token: Obtained via DropboxOAuth2Flow or DropboxOAuth2FlowNoRedirect.

  • locale: The user’s current locale (used to localize error messages).



728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
 
# File 'lib/dropbox_sdk.rb', line 728

def initialize(oauth2_access_token, root="auto", locale=nil)
  if oauth2_access_token.is_a?(String)
    @session = DropboxOAuth2Session.new(oauth2_access_token, locale)
  elsif oauth2_access_token.is_a?(DropboxSession)
    @session = oauth2_access_token
    @session.get_access_token
    if not locale.nil?
      @session.locale = locale
    end
  else
    raise ArgumentError.new("oauth2_access_token doesn't have a valid type")
  end

  @root = root.to_s  # If they passed in a symbol, make it a string

  if not ["dropbox","app_folder","auto"].include?(@root)
    raise ArgumentError.new("root must be :dropbox, :app_folder, or :auto")
  end
  if @root == "app_folder"
    #App Folder is the name of the access type, but for historical reasons
    #sandbox is the URL root component that indicates this
    @root = "sandbox"
  end
end

Instance Method Details

#account_info ⇒ Object

Returns some information about the current user’s Dropbox account (the “current user” is the user associated with the access token you’re using).

For a detailed description of what this call returns, visit: www.dropbox.com/developers/reference/api#account-info



758
759
760
761
 
# File 'lib/dropbox_sdk.rb', line 758

def ()
  response = @session.do_get "/account/info"
  Dropbox::parse_response(response)
end

#add_copy_ref(to_path, copy_ref) ⇒ Object

Adds the file referenced by the copy ref to the specified path

Args:

  • copy_ref: A copy ref string that was returned from a create_copy_ref call. The copy_ref can be created from any other Dropbox account, or from the same account.

  • to_path: The path to where the file will be created.

Returns:

  • A hash with the metadata of the new file.



1408
1409
1410
1411
1412
1413
1414
1415
 
# File 'lib/dropbox_sdk.rb', line 1408

def add_copy_ref(to_path, copy_ref)
  params = {'from_copy_ref' => copy_ref,
            'to_path' => "#{to_path}",
            'root' => @root}

  response = @session.do_post "/fileops/copy", params
  Dropbox::parse_response(response)
end

#commit_chunked_upload(to_path, upload_id, overwrite = false, parent_rev = nil) ⇒ Object

:nodoc



921
922
923
924
925
926
927
928
929
 
# File 'lib/dropbox_sdk.rb', line 921

def commit_chunked_upload(to_path, upload_id, overwrite=false, parent_rev=nil)  #:nodoc
  path = "/commit_chunked_upload/#{@root}#{format_path(to_path)}"
  params = {'overwrite' => overwrite.to_s,
            'upload_id' => upload_id,
            'parent_rev' => parent_rev
  }
  headers = nil
  @session.do_post path, params, headers, :content
end

#create_copy_ref(path) ⇒ Object

Creates and returns a copy ref for a specific file. The copy ref can be used to instantly copy that file to the Dropbox of another account.

Args:

  • path: The path to the file for a copy ref to be created on.

Returns:

  • A Hash object that looks like the following example:

    {"expires"=>"Fri, 31 Jan 2042 21:01:05 +0000", "copy_ref"=>"z1X6ATl6aWtzOGq0c3g5Ng"}



1393
1394
1395
1396
1397
 
# File 'lib/dropbox_sdk.rb', line 1393

def create_copy_ref(path)
  path = "/copy_ref/#{@root}#{format_path(path)}"
  response = @session.do_get path
  Dropbox::parse_response(response)
end

#create_oauth2_access_token ⇒ Object

If this DropboxClient was created with an OAuth 1 access token, this method can be used to create an equivalent OAuth 2 access token. This can be used to upgrade your app’s existing access tokens from OAuth 1 to OAuth 2.



773
774
775
776
777
778
779
780
 
# File 'lib/dropbox_sdk.rb', line 773

def create_oauth2_access_token
  if not @session.is_a?(DropboxSession)
    raise ArgumentError.new("This call requires a DropboxClient that is configured with " \
                            "an OAuth 1 access token.")
  end
  response = @session.do_post "/oauth2/token_from_oauth1"
  Dropbox::parse_response(response)['access_token']
end

#delta(cursor = nil, path_prefix = nil) ⇒ Object

A way of letting you keep a local representation of the Dropbox folder heirarchy. You can periodically call delta() to get a list of “delta entries”, which are instructions on how to update your local state to match the server’s state.

Arguments:

  • cursor: On the first call, omit this argument (or pass in nil). On subsequent calls, pass in the cursor string returned by the previous call.

  • path_prefix: If provided, results will be limited to files and folders whose paths are equal to or under path_prefix. The path_prefix is fixed for a given cursor. Whatever path_prefix you use on the first delta() must also be passed in on subsequent calls that use the returned cursor.

Returns: A hash with three fields.

  • entries: A list of “delta entries” (described below)

  • reset: If true, you should reset local state to be an empty folder before processing the list of delta entries. This is only true only in rare situations.

  • cursor: A string that is used to keep track of your current state. On the next call to delta(), pass in this value to return entries that were recorded since the cursor was returned.

  • has_more: If true, then there are more entries available; you can call delta() again immediately to retrieve those entries. If false, then wait at least 5 minutes (preferably longer) before checking again.

Delta Entries: Each entry is a 2-item list of one of following forms:

  • [path, metadata]: Indicates that there is a file/folder at the given path. You should add the entry to your local state. (The metadata value is the same as what would be returned by the #metadata() call.)

    • If the path refers to parent folders that don’t yet exist in your local state, create those parent folders in your local state. You will eventually get entries for those parent folders.

    • If the new entry is a file, replace whatever your local state has at path with the new entry.

    • If the new entry is a folder, check what your local state has at path. If it’s a file, replace it with the new entry. If it’s a folder, apply the new metadata to the folder, but do not modify the folder’s children.

  • [path, nil]: Indicates that there is no file/folder at the path on Dropbox. To update your local state to match, delete whatever is at path, including any children (you will sometimes also get separate delta entries for each child, but this is not guaranteed). If your local state doesn’t have anything at path, ignore this entry.

Remember: Dropbox treats file names in a case-insensitive but case-preserving way. To facilitate this, the path strings above are lower-cased versions of the actual path. The metadata dicts have the original, case-preserved path.



1329
1330
1331
1332
1333
1334
1335
1336
1337
 
# File 'lib/dropbox_sdk.rb', line 1329

def delta(cursor=nil, path_prefix=nil)
  params = {
    'cursor' => cursor,
    'path_prefix' => path_prefix,
  }

  response = @session.do_post "/delta", params
  Dropbox::parse_response(response)
end

#disable_access_token ⇒ Object

Disables the access token that this DropboxClient is using. If this call succeeds, further API calls using this object will fail.



765
766
767
768
 
# File 'lib/dropbox_sdk.rb', line 765

def disable_access_token
  @session.do_post "/disable_access_token"
  nil
end

#file_copy(from_path, to_path) ⇒ Object

Copy a file or folder to a new location.

Args:

  • from_path: The path to the file or folder to be copied.

  • to_path: The destination path of the file or folder to be copied. This parameter should include the destination filename (e.g. from_path: ‘/test.txt’, to_path: ‘/dir/test.txt’). If there’s already a file at the to_path, this copy will be renamed to be unique.

Returns:



1019
1020
1021
1022
1023
1024
1025
1026
1027
 
# File 'lib/dropbox_sdk.rb', line 1019

def file_copy(from_path, to_path)
  params = {
    "root" => @root,
    "from_path" => format_path(from_path, false),
    "to_path" => format_path(to_path, false),
  }
  response = @session.do_post "/fileops/copy", params
  Dropbox::parse_response(response)
end

#file_create_folder(path) ⇒ Object

Create a folder.

Arguments:

  • path: The path of the new folder.

Returns:



1038
1039
1040
1041
1042
1043
1044
1045
1046
 
# File 'lib/dropbox_sdk.rb', line 1038

def file_create_folder(path)
  params = {
    "root" => @root,
    "path" => format_path(path, false),
  }
  response = @session.do_post "/fileops/create_folder", params

  Dropbox::parse_response(response)
end

#file_delete(path) ⇒ Object

Deletes a file

Arguments:

  • path: The path of the file to delete

Returns:



1057
1058
1059
1060
1061
1062
1063
1064
 
# File 'lib/dropbox_sdk.rb', line 1057

def file_delete(path)
  params = {
    "root" => @root,
    "path" => format_path(path, false),
  }
  response = @session.do_post "/fileops/delete", params
  Dropbox::parse_response(response)
end

#file_move(from_path, to_path) ⇒ Object

Moves a file

Arguments:

  • from_path: The path of the file to be moved

  • to_path: The destination path of the file or folder to be moved If the file or folder already exists, it will be renamed to be unique.

Returns:



1077
1078
1079
1080
1081
1082
1083
1084
1085
 
# File 'lib/dropbox_sdk.rb', line 1077

def file_move(from_path, to_path)
  params = {
    "root" => @root,
    "from_path" => format_path(from_path, false),
    "to_path" => format_path(to_path, false),
  }
  response = @session.do_post "/fileops/move", params
  Dropbox::parse_response(response)
end

#format_path(path, escape = true) ⇒ Object

:nodoc:



1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
 
# File 'lib/dropbox_sdk.rb', line 1455

def format_path(path, escape=true) # :nodoc:
  path = path.gsub(/\/+/,"/")
  # replace multiple slashes with a single one

  path = path.gsub(/^\/?/,"/")
  # ensure the path starts with a slash

  path.gsub(/\/?$/,"")
  # ensure the path doesn't end with a slash

  return URI.escape(path, RESERVED_CHARACTERS) if escape
  path
end

#get_chunked_uploader(file_obj, total_size) ⇒ Object

Returns a ChunkedUploader object.

Args:

  • file_obj: The file-like object to be uploaded. Must support .read()

  • total_size: The total size of file_obj



833
834
835
 
# File 'lib/dropbox_sdk.rb', line 833

def get_chunked_uploader(file_obj, total_size)
  ChunkedUploader.new(self, file_obj, total_size)
end

#get_file(from_path, rev = nil) ⇒ Object

Download a file

Args:

  • from_path: The path to the file to be downloaded

  • rev: A previous revision value of the file to be downloaded

Returns:

  • The file contents.



948
949
950
951
 
# File 'lib/dropbox_sdk.rb', line 948

def get_file(from_path, rev=nil)
  response = get_file_impl(from_path, rev)
  Dropbox::parse_response(response, raw=true)
end

#get_file_and_metadata(from_path, rev = nil) ⇒ Object

Download a file and get its metadata.

Args:

  • from_path: The path to the file to be downloaded

  • rev: A previous revision value of the file to be downloaded

Returns:

  • The file contents.

  • The file metadata as a hash.



962
963
964
965
966
967
 
# File 'lib/dropbox_sdk.rb', line 962

def get_file_and_metadata(from_path, rev=nil)
  response = get_file_impl(from_path, rev)
  parsed_response = Dropbox::parse_response(response, raw=true)
  metadata = parse_metadata(response)
  return parsed_response, metadata
end

#longpoll_delta(cursor, timeout = 30) ⇒ Object

Calls the long-poll endpoint which waits for changes on an account. In conjunction with #delta, this call gives you a low-latency way to monitor an account for file changes.

The passed in cursor can only be acquired via a call to #delta

Arguments:

  • cursor: A delta cursor as returned from a call to #delta

  • timeout: An optional integer indicating a timeout, in seconds. The default value is 30 seconds, which is also the minimum allowed value. The maximum is 480 seconds.

Returns: A hash with one or two fields.

  • changes: A boolean value indicating whether new changes are available.

  • backoff: If present, indicates how many seconds your code should wait before calling #longpoll_delta again.



1355
1356
1357
1358
1359
1360
1361
1362
1363
 
# File 'lib/dropbox_sdk.rb', line 1355

def longpoll_delta(cursor, timeout=30)
  params = {
    'cursor' => cursor,
    'timeout' => timeout
  }

  response = @session.do_get "/longpoll_delta", params, :notify
  Dropbox::parse_response(response)
end

#media(path) ⇒ Object

Returns a direct link to a media file All of Dropbox’s API methods require OAuth, which may cause problems in situations where an application expects to be able to hit a URL multiple times (for example, a media player seeking around a video file). This method creates a time-limited URL that can be accessed without any authentication.

Arguments:

  • path: The file to stream.

Returns:

  • A Hash object that looks like the following:

    {'url': 'https://dl.dropboxusercontent.com/1/view/abcdefghijk/example', 'expires': 'Thu, 16 Sep 2011 01:01:25 +0000'}



1207
1208
1209
1210
 
# File 'lib/dropbox_sdk.rb', line 1207

def media(path)
  response = @session.do_get "/media/#{@root}#{format_path(path)}"
  Dropbox::parse_response(response)
end

#metadata(path, file_limit = 25000, list = true, hash = nil, rev = nil, include_deleted = false, include_media_info = false, include_membership = false) ⇒ Object

Retrives metadata for a file or folder

Arguments:

  • path: The path to the file or folder.

  • list: Whether to list all contained files (only applies when path refers to a folder).

  • file_limit: The maximum number of file entries to return within a folder. If the number of files in the directory exceeds this limit, an exception is raised. The server will return at max 25,000 files within a folder.

  • hash: Every directory listing has a hash parameter attached that can then be passed back into this function later to save on bandwidth. Rather than returning an unchanged folder’s contents, if the hash matches a DropboxNotModified exception is raised.

  • rev: Optional. The revision of the file to retrieve the metadata for. This parameter only applies for files. If omitted, you’ll receive the most recent revision metadata.

  • include_deleted: Specifies whether to include deleted files in metadata results.

  • include_media_info: Specifies to include media info, such as time_taken for photos

Returns:



1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
 
# File 'lib/dropbox_sdk.rb', line 1111

def metadata(path, file_limit=25000, list=true, hash=nil, rev=nil, include_deleted=false, include_media_info=false, include_membership=false)
  params = {
    "file_limit" => file_limit.to_s,
    "list" => list.to_s,
    "include_deleted" => include_deleted.to_s,
    "hash" => hash,
    "rev" => rev,
    "include_media_info" => include_media_info,
    "include_membership" => include_membership
  }

  response = @session.do_get "/metadata/#{@root}#{format_path(path)}", params
  if response.kind_of? Net::HTTPRedirection
    raise DropboxNotModified.new("metadata not modified")
  end
  Dropbox::parse_response(response)
end

#partial_chunked_upload(data, upload_id = nil, offset = nil) ⇒ Object

:nodoc



931
932
933
934
935
936
937
938
 
# File 'lib/dropbox_sdk.rb', line 931

def partial_chunked_upload(data, upload_id=nil, offset=nil)  #:nodoc
  params = {
    'upload_id' => upload_id,
    'offset' => offset,
  }
  headers = {'Content-Type' => "application/octet-stream"}
  @session.do_put '/chunked_upload', params, headers, data, :content
end

#preview(path, rev = nil) ⇒ Object

Download a PDF or HTML preview for a file.

Arguments:

  • path: The path to the file to be previewed.

  • rev: Optional. The revision of the file to retrieve the metadata for. If omitted, you’ll get the most recent version.

Returns:

  • The preview data



1241
1242
1243
1244
1245
1246
 
# File 'lib/dropbox_sdk.rb', line 1241

def preview(path, rev=nil)
  path = "/previews/#{@root}#{format_path(path)}"
  params = { 'rev' => rev }
  response = @session.do_get path, params, :content
  Dropbox::parse_response(response, raw=true)
end

#put_file(to_path, file_obj, overwrite = false, parent_rev = nil) ⇒ Object

Uploads a file to a server. This uses the HTTP PUT upload method for simplicity

Args:

  • to_path: The directory path to upload the file to. If the destination directory does not yet exist, it will be created.

  • file_obj: A file-like object to upload. If you would like, you can pass a string as file_obj.

  • overwrite: Whether to overwrite an existing file at the given path. [default is False] If overwrite is False and a file already exists there, Dropbox will rename the upload to make sure it doesn’t overwrite anything. You must check the returned metadata to know what this new name is. This field should only be True if your intent is to potentially clobber changes to a file that you don’t know about.

  • parent_rev: The rev field from the ‘parent’ of this upload. [optional] If your intent is to update the file at the given path, you should pass the parent_rev parameter set to the rev value from the most recent metadata you have of the existing file at that path. If the server has a more recent version of the file at the specified path, it will automatically rename your uploaded file, spinning off a conflict. Using this parameter effectively causes the overwrite parameter to be ignored. The file will always be overwritten if you send the most-recent parent_rev, and it will never be overwritten you send a less-recent one.

Returns:

  • a Hash containing the metadata of the newly uploaded file. The file may have a different name if it conflicted.

Simple Example

client = DropboxClient(oauth2_access_token)
#session is a DropboxSession I've already authorized
client.put_file('/test_file_on_dropbox', open('/tmp/test_file'))

This will upload the “/tmp/test_file” from my computer into the root of my App’s app folder and call it “test_file_on_dropbox”. The file will not overwrite any pre-existing file.



815
816
817
818
819
820
821
822
823
824
825
826
 
# File 'lib/dropbox_sdk.rb', line 815

def put_file(to_path, file_obj, overwrite=false, parent_rev=nil)
  path = "/files_put/#{@root}#{format_path(to_path)}"
  params = {
    'overwrite' => overwrite.to_s,
    'parent_rev' => parent_rev,
  }

  headers = {"Content-Type" => "application/octet-stream"}
  response = @session.do_put path, params, headers, file_obj, :content

  Dropbox::parse_response(response)
end

#restore(path, rev) ⇒ Object

Restore a file to a previous revision.

Arguments:

  • path: The file to restore. Note that folders can’t be restored.

  • rev: A previous rev value of the file to be restored to.

Returns:



1186
1187
1188
1189
1190
1191
1192
1193
 
# File 'lib/dropbox_sdk.rb', line 1186

def restore(path, rev)
  params = {
    'rev' => rev.to_s
  }

  response = @session.do_post "/restore/#{@root}#{format_path(path)}", params
  Dropbox::parse_response(response)
end

#revisions(path, rev_limit = 1000) ⇒ Object

Retrive revisions of a file

Arguments:

  • path: The file to fetch revisions for. Note that revisions are not available for folders.

  • rev_limit: The maximum number of file entries to return within a folder. The server will return at max 1,000 revisions.

Returns:



1167
1168
1169
1170
1171
1172
1173
1174
 
# File 'lib/dropbox_sdk.rb', line 1167

def revisions(path, rev_limit=1000)
  params = {
    'rev_limit' => rev_limit.to_s
  }

  response = @session.do_get "/revisions/#{@root}#{format_path(path)}", params
  Dropbox::parse_response(response)
end

#save_url(to_path, url) ⇒ Object

Save a file from the specified URL into Dropbox. If the given path already exists, the file will be renamed to avoid the conflict (e.g. myfile (1).txt).

Args:

  • to_path: The path in Dropbox where the file will be saved (e.g. /folder/file.ext).

  • url: The URL to be fetched.

Returns:

  • A dictionary with a status and job. The status is as defined in the

/save_url_job documentation. The job field gives a job ID that can be used with the /save_url_job endpoint to check the job’s status. Check www.dropbox.com/developers/core/docs#save-url for more info.

{"status": "PENDING", "job": "PEiuxsfaISEAAAAAAADwzg"}



1430
1431
1432
1433
1434
1435
 
# File 'lib/dropbox_sdk.rb', line 1430

def save_url(to_path, url)
  params = { 'url' => url }

  response = @session.do_post "/save_url/auto#{format_path(to_path, true)}", params
  Dropbox::parse_response(response)
end

#save_url_job(job_id) ⇒ Object

Check the status of a save URL job.

Args:

  • job_id: A job ID returned from /save_url.

Returns: *A dictionary with a status field with one of the following values: PENDING, DOWNLOADING, COMPLETE, FAILED Check www.dropbox.com/developers/core/docs#save-url for more info.

{"status": "FAILED", "error": "Job timed out"}



1447
1448
1449
1450
 
# File 'lib/dropbox_sdk.rb', line 1447

def save_url_job(job_id)
  response = @session.do_get "/save_url_job/#{job_id}"
  Dropbox::parse_response(response)
end

#search(path, query, file_limit = 1000, include_deleted = false) ⇒ Object

Search directory for filenames matching query

Arguments:

  • path: The directory to search within

  • query: The query to search on (3 character minimum)

  • file_limit: The maximum number of file entries to return/ If the number of files exceeds this limit, an exception is raised. The server will return at max 1,000

  • include_deleted: Whether to include deleted files in search results

Returns:



1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
 
# File 'lib/dropbox_sdk.rb', line 1143

def search(path, query, file_limit=1000, include_deleted=false)
  params = {
    'query' => query,
    'file_limit' => file_limit.to_s,
    'include_deleted' => include_deleted.to_s
  }

  response = @session.do_get "/search/#{@root}#{format_path(path)}", params
  Dropbox::parse_response(response)
end

#shares(path, short_url = true) ⇒ Object

Get a URL to share a media file Shareable links created on Dropbox are time-limited, but don’t require any authentication, so they can be given out freely. The time limit should allow at least a day of shareability, though users have the ability to disable a link from their account if they like.

Arguments:

  • path: The file to share.

  • short_url: When true (default), the url returned will be shortened using the Dropbox url shortener. If false, the url will link directly to the file’s preview page.

Returns:

  • A Hash object that looks like the following example:

    {'url': 'https://db.tt/c0mFuu1Y', 'expires': 'Tue, 01 Jan 2030 00:00:00 +0000'}

    For a detailed description of what this call returns, visit:

    https://www.dropbox.com/developers/reference/api#shares



1228
1229
1230
1231
 
# File 'lib/dropbox_sdk.rb', line 1228

def shares(path, short_url=true)
  response = @session.do_get "/shares/#{@root}#{format_path(path)}", {"short_url"=>short_url}
  Dropbox::parse_response(response)
end

#thumbnail(from_path, size = 'large') ⇒ Object

Download a thumbnail for an image.

Arguments:

  • from_path: The path to the file to be thumbnailed.

  • size: A string describing the desired thumbnail size. At this time, ‘small’ (32x32), ‘medium’ (64x64), ‘large’ (128x128), ‘s’ (64x64), ‘m’ (128x128), ‘l’ (640x640), and ‘xl’ (1024x1024) are officially supported sizes. Check www.dropbox.com/developers/reference/api#thumbnails for more details. [defaults to large]

Returns:

  • The thumbnail data



1259
1260
1261
1262
 
# File 'lib/dropbox_sdk.rb', line 1259

def thumbnail(from_path, size='large')
  response = thumbnail_impl(from_path, size)
  Dropbox::parse_response(response, raw=true)
end

#thumbnail_and_metadata(from_path, size = 'large') ⇒ Object

Download a thumbnail for an image along with the image’s metadata.

Arguments:

  • from_path: The path to the file to be thumbnailed.

  • size: A string describing the desired thumbnail size. See thumbnail() for details.

Returns:

  • The thumbnail data

  • The metadata for the image as a hash



1273
1274
1275
1276
1277
1278
 
# File 'lib/dropbox_sdk.rb', line 1273

def thumbnail_and_metadata(from_path, size='large')
  response = thumbnail_impl(from_path, size)
  parsed_response = Dropbox::parse_response(response, raw=true)
  metadata = parse_metadata(response)
  return parsed_response, metadata
end