dropbox_api 0.1.0

data/lib/dropbox_api/endpoints/files/list_folder_longpoll.rb

@@ -0,0 +1,36 @@
+module DropboxApi::Endpoints::Files
+  class ListFolderLongpoll < DropboxApi::Endpoints::RpcNotify
+    Method      = :post
+    Path        = "/2/files/list_folder/longpoll".freeze
+    ResultType  = DropboxApi::Results::ListFolderLongpollResult
+    ErrorType   = DropboxApi::Errors::ListFolderLongpollError
+
+    include DropboxApi::Endpoints::OptionsValidator
+
+    # @method list_folder_longpoll(path, options = {})
+    # A longpoll endpoint to wait for changes on an account. In conjunction
+    # with list_folder, this call gives you a low-latency way to monitor an
+    # account for file changes. The connection will block until there are
+    # changes available or a timeout occurs. This endpoint is useful mostly
+    # for client-side apps. If you're looking for server-side notifications,
+    # check out our webhooks documentation.
+    #
+    # @param cursor [String] A cursor as returned by list_folder or
+    #   list_folder_continue.
+    # @option timeout [Numeric] A timeout in seconds. The request will block
+    # for at most this length of time, plus up to 90 seconds of random jitter
+    # added to avoid the thundering herd problem. Care should be taken when
+    # using this parameter, as some network infrastructure does not support
+    # long timeouts. The default for this field is 30.
+    add_endpoint :list_folder_longpoll do |cursor, options = {}|
+      validate_options([
+        :timeout
+      ], options)
+      options[:timeout] ||= 30
+
+      perform_request options.merge({
+        :cursor => cursor
+      })
+    end
+  end
+end

data/lib/dropbox_api/endpoints/files/list_revisions.rb

@@ -0,0 +1,27 @@
+module DropboxApi::Endpoints::Files
+  class ListRevisions < DropboxApi::Endpoints::Rpc
+    Method      = :post
+    Path        = "/2/files/list_revisions".freeze
+    ResultType  = DropboxApi::Results::ListRevisionsResult
+    ErrorType   = DropboxApi::Errors::ListRevisionsError
+
+    include DropboxApi::Endpoints::OptionsValidator
+
+    # @method list_revisions(path, options = {})
+    # Return revisions of a file
+    #
+    # @param path [String] The path to file you want to see the revisions of.
+    # @option limit [Numeric] The maximum number of revision entries returned.
+    #   The default for this field is 10.
+    add_endpoint :list_revisions do |path, options = {}|
+      validate_options([
+        :limit
+      ], options)
+      options[:limit] ||= 10
+
+      perform_request options.merge({
+        :path => path
+      })
+    end
+  end
+end

data/lib/dropbox_api/endpoints/files/move.rb

@@ -0,0 +1,22 @@
+module DropboxApi::Endpoints::Files
+  class Move < DropboxApi::Endpoints::Rpc
+    Method      = :post
+    Path        = "/2/files/move".freeze
+    ResultType  = DropboxApi::Metadata::Resource
+    ErrorType   = DropboxApi::Errors::RelocationError
+
+    # @method move(from, to)
+    # Move a file or folder to a different location in the user's Dropbox.
+    #
+    # If the source path is a folder all its contents will be moved.
+    #
+    # @param from [String] Path in the user's Dropbox to be copied or moved.
+    # @param to [String] Path in the user's Dropbox that is the destination.
+    add_endpoint :move do |from, to|
+      perform_request({
+        :from_path => from,
+        :to_path => to
+      })
+    end
+  end
+end

data/lib/dropbox_api/endpoints/files/restore.rb

@@ -0,0 +1,20 @@
+module DropboxApi::Endpoints::Files
+  class Restore < DropboxApi::Endpoints::Rpc
+    Method      = :post
+    Path        = "/2/files/restore".freeze
+    ResultType  = DropboxApi::Metadata::File
+    ErrorType   = DropboxApi::Errors::RestoreError
+
+    # @method restore(path, rev)
+    # Restore a file to a specific revision
+    #
+    # @param path [String] The path to the file you want to restore.
+    # @param rev [String] The revision to restore for the file.
+    add_endpoint :restore do |path, rev|
+      perform_request({
+        :path => path,
+        :rev => rev
+      })
+    end
+  end
+end

data/lib/dropbox_api/endpoints/files/search.rb

@@ -0,0 +1,44 @@
+module DropboxApi::Endpoints::Files
+  class Search < DropboxApi::Endpoints::Rpc
+    Method      = :post
+    Path        = "/2/files/search".freeze
+    ResultType  = DropboxApi::Results::SearchResult
+    ErrorType   = DropboxApi::Errors::SearchError
+
+    include DropboxApi::Endpoints::OptionsValidator
+
+    # @method search(query, path = "", options = {})
+    # Searches for files and folders.
+    #
+    # Note: Recent changes may not immediately be reflected in search results
+    # due to a short delay in indexing.
+    #
+    # @param query [String] The string to search for. The search string is
+    #   split on spaces into multiple tokens. For file name searching, the last
+    #   token is used for prefix matching (i.e. "bat c" matches "bat cave" but
+    #   not "batman car").
+    # @param path [String] The path in the user's Dropbox to search.
+    # @option start [Numeric] The starting index within the search results
+    #   (used for paging). The default for this field is 0.
+    # @option max_results [Numeric] The maximum number of search results to
+    #   return. The default for this field is 100.
+    # @option mode [:filename, :filename_and_content, :deleted_filename] The
+    #   search mode. Note that searching file content is only available for
+    #   Dropbox Business accounts. The default is filename.
+    add_endpoint :search do |query, path = "", options = {}|
+      validate_options([
+        :start,
+        :max_results,
+        :mode
+      ], options)
+      options[:start] ||= 0
+      options[:max_results] ||= 100
+      options[:mode] ||= :filename
+
+      perform_request options.merge({
+        :query => query,
+        :path => path
+      })
+    end
+  end
+end

data/lib/dropbox_api/endpoints/files/upload.rb

@@ -0,0 +1,26 @@
+module DropboxApi::Endpoints::Files
+  class Upload < DropboxApi::Endpoints::ContentUpload
+    Method      = :post
+    Path        = "/2/files/upload".freeze
+    ResultType  = DropboxApi::Metadata::File
+    ErrorType   = DropboxApi::Errors::UploadError
+
+    # @method upload(path)
+    # Create a new file with the contents provided in the request.
+    # Do not use this to upload a file larger than 150 MB. Instead, create an
+    # upload session with #upload_session_start().
+    #
+    # @param path [String] Path in the user's Dropbox to save the file.
+    # @option autorename [Boolean] If there's a conflict, as determined by
+    #   mode, have the Dropbox server try to autorename the file to avoid
+    #   conflict. The default for this field is False.
+    # @option mute [Boolean] Normally, users are made aware of any file
+    #   modifications in their Dropbox account via notifications in the client
+    #   software. If true, this tells the clients that this modification
+    #   shouldn't result in a user notification. The default for this field is
+    #   `false`.
+    add_endpoint :upload do |path, content, options = {}|
+      perform_request({:path => path}, content)
+    end
+  end
+end

data/lib/dropbox_api/endpoints/options_validator.rb

@@ -0,0 +1,11 @@
+module DropboxApi::Endpoints
+  module OptionsValidator
+    def validate_options(valid_option_keys, options)
+      options.keys.each do |key|
+        unless valid_option_keys.include? key.to_sym
+          raise ArgumentError, "Invalid option `#{key}`"
+        end
+      end
+    end
+  end
+end

data/lib/dropbox_api/endpoints/rpc.rb

@@ -0,0 +1,18 @@
+module DropboxApi::Endpoints
+  class Rpc < DropboxApi::Endpoints::Base
+    def initialize(builder)
+      @connection = builder.build("https://api.dropboxapi.com") do |c|
+        c.response :decode_result
+      end
+    end
+
+    def build_request(params)
+      body = JSON.dump(params)
+      headers = {
+        'content-type' => 'application/json'
+      }
+
+      return body, headers
+    end
+  end
+end

data/lib/dropbox_api/endpoints/rpc_notify.rb

@@ -0,0 +1,11 @@
+module DropboxApi::Endpoints
+  class RpcNotify < DropboxApi::Endpoints::Rpc
+    def initialize(builder)
+      @connection = builder.build("https://notify.dropboxapi.com") do |c|
+        c.headers.delete 'Authorization'
+
+        c.response :decode_result
+      end
+    end
+  end
+end

data/lib/dropbox_api/endpoints/sharing/add_folder_member.rb

@@ -0,0 +1,54 @@
+module DropboxApi::Endpoints::Sharing
+  class AddFolderMember < DropboxApi::Endpoints::Rpc
+    Method      = :post
+    Path        = "/2/sharing/add_folder_member".freeze
+    ResultType  = DropboxApi::Results::VoidResult
+    ErrorType   = DropboxApi::Errors::AddFolderMemberError
+
+    include DropboxApi::Endpoints::OptionsValidator
+
+    # @method add_folder_member(folder_id, members, options)
+    # Allows an owner or editor (if the ACL update policy allows) of a shared
+    # folder to add another member.
+    #
+    # For the new member to get access to all the functionality for this folder,
+    # you will need to call mount_folder on their behalf.
+    #
+    # Apps must have full Dropbox access to use this endpoint.
+    #
+    # @param folder_id [String] The ID for the shared folder.
+    # @param members [Array<AddMember,String>] The intended list of members to
+    #   add. Added members will receive invites to join the shared folder.
+    # @option quiet [Boolean] Whether added members should be notified via
+    #   email and device notifications of their invite. The default for this
+    #   field is False.
+    # @option custom_message [String] Optional message to display to added
+    #   members in their invitation. This field is optional.
+    add_endpoint :add_folder_member do |folder_id, members, options = {}|
+      # TODO: It should be possible to take an email (String) as the argument.
+      validate_options([:quiet, :custom_message], options)
+      options[:quiet] ||= false
+      options[:custom_message] ||= nil
+
+      perform_request options.merge({
+        :shared_folder_id => folder_id,
+        :members => build_members_param(members)
+      })
+    end
+
+    private
+
+    def build_members_param(members)
+      members.map do |member|
+        case member
+        when String
+          DropboxApi::Metadata::AddMember.new member
+        when DropboxApi::Metadata::AddMember
+          member
+        else
+          raise ArgumentError, "Invalid argument type `#{member.class.name}`"
+        end
+      end.map(&:to_hash)
+    end
+  end
+end

data/lib/dropbox_api/endpoints/sharing/create_shared_link_with_settings.rb

@@ -0,0 +1,23 @@
+module DropboxApi::Endpoints::Sharing
+  class CreateSharedLinkWithSettings < DropboxApi::Endpoints::Rpc
+    Method      = :post
+    Path        = "/2/sharing/create_shared_link_with_settings".freeze
+    ResultType  = DropboxApi::Metadata::SharedLink
+    ErrorType   = DropboxApi::Errors::CreateSharedLinkWithSettingsError
+
+    # @method create_shared_link_with_settings(path, settings = {})
+    # Create a shared link with custom settings. If no settings are given then
+    # the default visibility is :public. (The resolved
+    # visibility, though, may depend on other aspects such as team and shared
+    # folder settings).
+    #
+    # @param path [String]
+    # @option settings [SharedLinkSettings]
+    # @return [DropboxApi::Metadata::SharedLink]
+    add_endpoint :create_shared_link_with_settings do |path, settings = {}|
+      # NOTE: This endpoint accepts an additional option `settings` which
+      #       hasn't been implemented.
+      perform_request :path => path
+    end
+  end
+end

data/lib/dropbox_api/endpoints/sharing/list_folder_members.rb

@@ -0,0 +1,31 @@
+module DropboxApi::Endpoints::Sharing
+  class ListFolderMembers < DropboxApi::Endpoints::Rpc
+    Method      = :post
+    Path        = "/2/sharing/list_folder_members".freeze
+    ResultType  = DropboxApi::Results::SharedFolderMembers
+    ErrorType   = DropboxApi::Errors::SharedFolderAccessError
+
+    include DropboxApi::Endpoints::OptionsValidator
+
+    # @method list_folder_members(folder_id, actions, options)
+    # Returns shared folder membership by its folder ID.
+    #
+    # Apps must have full Dropbox access to use this endpoint.
+    #
+    # @param folder_id [String] The ID for the shared folder.
+    # @option limit [Numeric] The maximum number of results that include
+    #   members, groups and invitees to return per request. The default for
+    #   this field is 1000.
+    # @return [SharedFolderMembers] Shared folder user and group membership.
+    add_endpoint :list_folder_members do |folder_id, options = {}|
+      # NOTE: This endpoint accepts an additional option `actions` which hasn't
+      #       been implemented.
+      validate_options([:limit], options)
+      options[:limit] ||= 100
+
+      perform_request options.merge({
+        :shared_folder_id => folder_id
+      })
+    end
+  end
+end

data/lib/dropbox_api/endpoints/sharing/list_shared_links.rb

@@ -0,0 +1,31 @@
+module DropboxApi::Endpoints::Sharing
+  class ListSharedLinks < DropboxApi::Endpoints::Rpc
+    Method      = :post
+    Path        = "/2/sharing/list_shared_links".freeze
+    ResultType  = DropboxApi::Results::ListSharedLinksResult
+    ErrorType   = DropboxApi::Errors::ListSharedLinksError
+
+    include DropboxApi::Endpoints::OptionsValidator
+
+    # @method list_shared_links(options)
+    # List shared links of this user.
+    #
+    # If no path is given or the path is empty, returns a list of all shared
+    # links for the current user.
+    #
+    # If a non-empty path is given, returns a list of all shared links that
+    # allow access to the given path - direct links to the given path and
+    # links to parent folders of the given path. Links to parent folders can
+    # be suppressed by setting direct_only to true.
+    #
+    # @option path [String]
+    # @option cursor [String] The cursor returned by your last call.
+    # @option direct_only [Boolean]
+    # @return [ListSharedLinksResult]
+    add_endpoint :list_shared_links do |options = {}|
+      validate_options([:path, :cursor, :direct_only], options)
+
+      perform_request options
+    end
+  end
+end

data/lib/dropbox_api/endpoints/sharing/share_folder.rb

@@ -0,0 +1,58 @@
+module DropboxApi::Endpoints::Sharing
+  class ShareFolder < DropboxApi::Endpoints::Rpc
+    Method      = :post
+    Path        = "/2/sharing/share_folder".freeze
+    ResultType  = DropboxApi::Results::ShareFolderLaunch
+    ErrorType   = DropboxApi::Errors::ShareFolderError
+
+    include DropboxApi::Endpoints::OptionsValidator
+
+    # @method share_folder(path, options = {})
+    # Share a folder with collaborators.
+    #
+    # Most sharing will be completed synchronously. Large folders will be
+    # completed asynchronously. To make testing the async case repeatable, set
+    # `ShareFolderArg.force_async`.
+    #
+    # If a ShareFolderLaunch.async_job_id is returned, you'll need to call
+    # check_share_job_status until the action completes to get the metadata
+    # for the folder.
+    #
+    # Apps must have full Dropbox access to use this endpoint.
+    #
+    # @param path [String] The path to the folder to share. If it does not
+    #   exist, then a new one is created.
+    # @option member_policy [:anyone, :team] Who can be a member of this shared
+    #   folder. Only applicable if the current user is on a team. The default
+    #   is `:anyone`.
+    # @option acl_update_policy [:owner, :editors] Who can add and remove
+    #   members of this shared folder. The default is `:owner`.
+    # @option shared_link_policy [:anyone, :members] The policy to apply to
+    #   shared links created for content inside this shared folder. The
+    #   current user must be on a team to set this policy to `:members`.
+    #   The default is `anyone`.
+    # @option force_async [Boolean] Whether to force the share to happen
+    #   asynchronously. The default for this field is `false`.
+    # @return [ShareFolderLaunch] Shared folder metadata.
+    add_endpoint :share_folder do |path, options = {}|
+      validate_options([
+        :member_policy,
+        :acl_update_policy,
+        :shared_link_policy,
+        :force_async
+      ], options)
+      options[:member_policy] ||= :anyone
+      options[:acl_update_policy] ||= :owner
+      options[:shared_link_policy] ||= :anyone
+      options[:force_async] ||= false
+
+      begin
+        perform_request options.merge({
+          :path => path
+        })
+      rescue DropboxApi::Errors::AlreadySharedError => error
+        error.shared_folder
+      end
+    end
+  end
+end

data/lib/dropbox_api/endpoints/users/get_account.rb

@@ -0,0 +1,17 @@
+module DropboxApi::Endpoints::Users
+  class GetAccount < DropboxApi::Endpoints::Rpc
+    Method      = :post
+    Path        = "/2/users/get_account".freeze
+    ResultType  = DropboxApi::Metadata::BasicAccount
+    ErrorType   = DropboxApi::Errors::GetAccountError
+
+    # @method get_account(account_id)
+    # Get information about a user's account.
+    #
+    # @param account_id [String] A user's account identifier.
+    # @return [BasicAccount] Basic information about any account.
+    add_endpoint :get_account do |account_id|
+      perform_request :account_id => account_id
+    end
+  end
+end