dropbox_api 0.1.1 → 0.1.3

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

@@ -7,7 +7,7 @@ module DropboxApi::Endpoints::Sharing
 
     include DropboxApi::Endpoints::OptionsValidator
 
-    # @method add_folder_member(folder_id, members, options)
+    # @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.
     #
@@ -16,16 +16,19 @@ module DropboxApi::Endpoints::Sharing
     #
     # Apps must have full Dropbox access to use this endpoint.
     #
+    # The +members+ parameter must be an Array. Each item in the array could
+    # be either a String or a {Metadata::AddMember} object.
+    #
     # @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.
+    # @option options quiet [Boolean] Whether added members should be notified
+    #   via email and device notifications of their invite. The default for
+    #   this field is False.
+    # @option options custom_message [String] Optional message to display to
+    #   added members in their invitation. This field is optional.
+    # @see DropboxApi::Metadata::Member
     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
@@ -42,7 +45,7 @@ module DropboxApi::Endpoints::Sharing
       members.map do |member|
         case member
         when String
-          DropboxApi::Metadata::AddMember.new member
+          DropboxApi::Metadata::AddMember.build_from_string member
         when DropboxApi::Metadata::AddMember
           member
         else

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

@@ -7,24 +7,34 @@ module DropboxApi::Endpoints::Sharing
 
     include DropboxApi::Endpoints::OptionsValidator
 
-    # @method list_folder_members(folder_id, actions, options)
+    # @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.
     #
+    # @example List folder members.
+    #   client.list_folder_members "1231273663"
+    #
+    # @example List folder members, with detail of permission to make owner.
+    #   client.list_folder_members "1231273663", [:make_owner]
+    #
     # @param folder_id [String] The ID for the shared folder.
-    # @option limit [Numeric] The maximum number of results that include
+    # @param actions [Array]
+    #   This is an optional list of actions. The permissions for the actions
+    #   requested will be included in the result.
+    # @option options
+    #   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.
+    # @see DropboxApi::Metadata::MemberActionCollection
+    add_endpoint :list_folder_members do |folder_id, actions = [], options = {}|
       validate_options([:limit], options)
       options[:limit] ||= 100
 
       perform_request options.merge({
-        :shared_folder_id => folder_id
+        :shared_folder_id => folder_id,
+        :actions => DropboxApi::Metadata::MemberActionCollection.new(actions)
       })
     end
   end

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

@@ -0,0 +1,19 @@
+module DropboxApi::Endpoints::Users
+  class GetAccountBatch < DropboxApi::Endpoints::Rpc
+    Method      = :post
+    Path        = "/2/users/get_account_batch".freeze
+    ResultType  = DropboxApi::Results::BasicAccountBatch
+    ErrorType   = DropboxApi::Errors::GetAccountError
+
+    # @method get_account_batch(account_ids)
+    # Get information about multiple user accounts. At most 300 accounts may
+    # be queried per request.
+    #
+    # @param account_ids [Array<String>] List of user account identifiers. Should not
+    #   contain any duplicate account IDs.
+    # @return [Array<BasicAccount>] Basic information about any account.
+    add_endpoint :get_account_batch do |account_ids|
+      perform_request :account_ids => account_ids
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module DropboxApi::Endpoints::Users
+  class GetCurrentAccount < DropboxApi::Endpoints::Rpc
+    Method      = :post
+    Path        = "/2/users/get_current_account".freeze
+    ResultType  = DropboxApi::Metadata::BasicAccount
+    ErrorType   = nil
+
+    # @method get_current_account
+    # Get information about the current user's account.
+    #
+    # @return [BasicAccount] Detailed information about the current user's account.
+    add_endpoint :get_current_account do
+      perform_request nil
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module DropboxApi::Endpoints::Users
+  class GetSpaceUsage < DropboxApi::Endpoints::Rpc
+    Method      = :post
+    Path        = "/2/users/get_space_usage".freeze
+    ResultType  = DropboxApi::Metadata::SpaceUsage
+    ErrorType   = nil
+
+    # @method get_space_usage
+    # Get the space usage information for the current user's account.
+    #
+    # @return [SpaceUsage] Information about a user's space usage and quota.
+    add_endpoint :get_space_usage do
+      perform_request nil
+    end
+  end
+end

data/lib/dropbox_api/errors/add_file_member_error.rb

@@ -0,0 +1,6 @@
+module DropboxApi::Errors
+  class AddFileMemberError < BasicError
+    ErrorSubtypes = {
+    }.freeze
+  end
+end

data/lib/dropbox_api/errors/basic_error.rb

@@ -52,12 +52,15 @@ module DropboxApi::Errors
   class InvalidCursorError < BasicError; end
   class InvalidDropboxIdError < BasicError; end
   class InvalidEmailError < BasicError; end
+  class InvalidFileError < BasicError; end
   class InvalidIdError < BasicError; end
+  class InvalidMemberError < BasicError; end
   class InvalidPathError < BasicError; end
   class InvalidRevisionError < BasicError; end
   class InvalidSettingsError < BasicError; end
   class IsAppFolderError < BasicError; end
   class IsFileError < BasicError; end
+  class IsFolderError < BasicError; end
   class IsOsxPackageError < BasicError; end
   class IsPublicFolderError < BasicError; end
   class MalformedPathError < BasicError; end

data/lib/dropbox_api/errors/file_member_action_error.rb

@@ -0,0 +1,10 @@
+module DropboxApi::Errors
+  class FileMemberActionError < BasicError
+    ErrorSubtypes = {
+      :invalid_member => InvalidMemberError,
+      :no_permission => NoPermissionError,
+      :access_error => SharingFileAccessError,
+      :no_explicit_access => DropboxApi::Metadata::ParentFolderAccessInfo
+    }.freeze
+  end
+end

data/lib/dropbox_api/errors/sharing_file_access_error.rb

@@ -0,0 +1,11 @@
+module DropboxApi::Errors
+  class SharingFileAccessError < BasicError
+    ErrorSubtypes = {
+      :no_permission => NoPermissionError,
+      :invalid_file => InvalidFileError,
+      :is_folder => IsFolderError,
+      :inside_public_folder => InsidePublicFolderError,
+      :inside_osx_package => InsideOsxPackageError
+    }.freeze
+  end
+end

data/lib/dropbox_api/errors/too_many_requests_error.rb

@@ -0,0 +1,19 @@
+module DropboxApi::Errors
+  class TooManyRequestsError < BasicError; end
+  class TooManyWriteOperationsError < TooManyRequestsError; end
+
+  class TooManyRequestsError
+    attr_accessor :retry_after
+
+    def self.build(message, metadata)
+      subtype, metadata = find_subtype metadata
+
+      subtype.new(message, metadata)
+    end
+
+    ErrorSubtypes = {
+      :too_many_requests => TooManyRequestsError,
+      :too_many_write_operations => TooManyWriteOperationsError
+    }
+  end
+end

data/lib/dropbox_api/metadata/access_level.rb

@@ -0,0 +1,18 @@
+module DropboxApi::Metadata
+  # Example of a serialized {AccessLevel} object:
+  #   {
+  #     ".tag": "viewer"
+  #   }
+  class AccessLevel < Base
+    def self.new(data)
+      case data
+      when Symbol
+        data
+      when Hash
+        data[".tag"].to_sym
+      else
+        raise ArgumentError, "Invalid value for AccessLevel: #{data.inspect}."
+      end
+    end
+  end
+end

data/lib/dropbox_api/metadata/add_file_member_result.rb

@@ -0,0 +1,19 @@
+module DropboxApi::Metadata
+  # Example of a {AddFileMemberResult}:
+  #   {
+  #     "member":{
+  #       ".tag": "email",
+  #       "email": "somebody@test.com"
+  #     },
+  #     "result": {
+  #       ".tag": "success",
+  #       "success": {
+  #         ".tag": "viewer"
+  #       }
+  #     }
+  #   }
+  class AddFileMemberResult < Base
+    field :member, DropboxApi::Metadata::Member
+    field :result, DropboxApi::Metadata::FileMemberAction
+  end
+end

data/lib/dropbox_api/metadata/add_member.rb

@@ -1,62 +1,34 @@
 module DropboxApi::Metadata
-  # Examples of serialized `AddMember` objects:
-  #
-  # {
-  #   "member": {
-  #     ".tag": "email",
-  #     "email": "justin@example.com"
+  # Examples of serialized {AddMember} objects:
+  #   {
+  #     "member": {
+  #       ".tag": "email",
+  #       "email": "justin@example.com"
+  #     },
+  #     "access_level": {
+  #       ".tag": "editor"
+  #     }
   #   },
-  #   "access_level": {
-  #     ".tag": "editor"
+  #   {
+  #     "member": {
+  #       ".tag": "dropbox_id",
+  #       "dropbox_id": "dbid:AAEufNrMPSPe0dMQijRP0N_aZtBJRm26W4Q"
+  #     },
+  #     "access_level": {
+  #       ".tag": "viewer"
+  #     }
   #   }
-  # },
-  # {
-  #   "member": {
-  #     ".tag": "dropbox_id",
-  #     "dropbox_id": "dbid:AAEufNrMPSPe0dMQijRP0N_aZtBJRm26W4Q"
-  #   },
-  #   "access_level": {
-  #     ".tag": "viewer"
-  #   }
-  # }
-  class AddMember
-    # Builds an AddMember object that can be used as an argument for
-    # `add_folder_member`.
-    #
-    # @param member [String] Email address or Dropbox ID.
-    # @param acl [:editor, :viewer] Access level, defaults to :editor.
-    def initialize(member, acl = :editor)
-      @member = member
-      @acl = acl
-    end
-
-    def to_hash
-      {
-        :member => member_to_hash,
-        :access_level => acl_to_hash
-      }
-    end
-
-    private
-
-    def member_to_hash
-      if @member.start_with? "dbid:"
-        {
-          :".tag" => :dropbox_id,
-          :dropbox_id => @member
-        }
-      else
-        {
-          :".tag" => :email,
-          :email => @member
-        }
+  class AddMember < Base
+    class << self
+      def build_from_string(member, access_level = :editor)
+        new({
+          "member" => Member.build_from_email_or_dropbox_id(member),
+          "access_level" => access_level
+        })
       end
     end
 
-    def acl_to_hash
-      {
-        :".tag" => @acl
-      }
-    end
+    field :member, DropboxApi::Metadata::Member
+    field :access_level, DropboxApi::Metadata::AccessLevel
   end
 end

data/lib/dropbox_api/metadata/base.rb

@@ -1,22 +1,65 @@
 module DropboxApi::Metadata
   class Base
-    def self.field(name, type, *options)
-      @fields ||= {}
-      @fields[name] = DropboxApi::Metadata::Field.new(type, options)
+    class << self
+      attr_reader :fields
 
-      attr_reader name
-    end
+      def field(name, type, *options)
+        @fields ||= {}
+        @fields[name] = DropboxApi::Metadata::Field.new(type, options)
 
-    def self.each_field
-      @fields.each do |name, field|
-        yield name, field
+        attr_reader name
       end
     end
 
+    # Takes in a hash containing all the attributes required to initialize the
+    # object.
+    #
+    # Each hash entry should have a key which identifies a field and its value,
+    # so a valid call would be something like this:
+    #
+    #     DropboxApi::Metadata::File.new({
+    #       "name" => "a.jpg",
+    #       "path_lower" => "/a.jpg",
+    #       "path_display" => "/a.jpg",
+    #       "id" => "id:evvfE6q6cK0AAAAAAAAB2w",
+    #       "client_modified" => "2016-10-19T17:17:34Z",
+    #       "server_modified" => "2016-10-19T17:17:34Z",
+    #       "rev" => "28924061bdd",
+    #       "size" => 396317
+    #     })
+    #
+    # @raise [ArgumentError] If a required attribute is missing.
+    # @param metadata [Hash]
     def initialize(metadata)
-      self.class.each_field do |name, field|
-        instance_variable_set "@#{name}", field.cast(metadata[name.to_s])
+      self.class.fields.keys.each do |field_name|
+        self[field_name] = metadata[field_name.to_s]
       end
     end
+
+    def to_hash
+      Hash[self.class.fields.keys.map do |field_name|
+        [field_name.to_s, serialized_field(field_name)]
+      end.select { |k, v| !v.nil? }]
+    end
+
+    def serialized_field(field_name)
+      value = send field_name
+      case value
+      when Time
+        value.utc.strftime("%FT%TZ")
+      when DropboxApi::Metadata
+        value.to_hash
+      else
+        value
+      end
+    end
+
+    private
+
+    def []=(name, value)
+      instance_variable_set "@#{name}", self.class.fields[name].cast(value)
+    rescue ArgumentError
+      raise ArgumentError, "Invalid value for `#{name}`: #{value.inspect}."
+    end
   end
 end

data/lib/dropbox_api/metadata/basic_account.rb

@@ -1,29 +1,28 @@
 module DropboxApi::Metadata
-  # NOTE: We should have a test to cover the initialization of this object.
-  # Sample:
-  # {
-  #   "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc",
-  #   "name": {
-  #       "given_name": "Franz",
-  #       "surname": "Ferdinand",
-  #       "familiar_name": "Franz",
-  #       "display_name": "Franz Ferdinand (Personal)"
-  #   },
-  #   "email": "franz@dropbox.com",
-  #   "email_verified": true,
-  #   "disabled": false,
-  #   "is_teammate": true,
-  #   "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbid%3AAAH4f99T0taONIb-OurWxbNQ6ywGRopQngc?vers=1453416696524&size=128x128",
-  #   "team_member_id": "dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU"
-  # }
+  # Example of a serialized {BasicAccount} object:
+  #   {
+  #     "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc",
+  #     "name": {
+  #         "given_name": "Franz",
+  #         "surname": "Ferdinand",
+  #         "familiar_name": "Franz",
+  #         "display_name": "Franz Ferdinand (Personal)"
+  #     },
+  #     "email": "franz@dropbox.com",
+  #     "email_verified": true,
+  #     "disabled": false,
+  #     "is_teammate": true,
+  #     "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbid%3AAAH4f99T0taONIb-OurWxbNQ6ywGRopQngc?vers=1453416696524&size=128x128",
+  #     "team_member_id": "dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU"
+  #   }
   class BasicAccount < Base
     field :account_id, String
     field :name, DropboxApi::Metadata::Name
     field :email, String
     field :email_verified, :boolean
     field :disabled, :boolean
-    field :is_teammate, :boolean
-    field :profile_photo_url, String
-    field :team_member_id, :boolean
+    field :is_teammate, :boolean, :optional
+    field :profile_photo_url, String, :optional
+    field :team_member_id, :boolean, :optional
   end
 end