dropbox_api 0.1.1 → 0.1.3

data/lib/dropbox_api/metadata/deleted.rb

@@ -1,12 +1,11 @@
 module DropboxApi::Metadata
-  # NOTE: We should have a test to cover the initialization of this object.
-  # Sample:
-  # {
-  #   ".tag": "deleted",
-  #   "name": "file.txt",
-  #   "path_lower": "/file.txt",
-  #   "path_display": "/file.txt"
-  # }
+  # Example of a serialized {Deleted} object:
+  #   {
+  #     ".tag": "deleted",
+  #     "name": "file.txt",
+  #     "path_lower": "/file.txt",
+  #     "path_display": "/file.txt"
+  #   }
   class Deleted < Base
     field :name, String
     field :path_lower, String

data/lib/dropbox_api/metadata/field.rb

@@ -6,7 +6,8 @@ module DropboxApi::Metadata
     end
 
     def cast(object)
-      if object.nil? && @options.include?(:optional)
+      if object.nil?
+        raise ArgumentError unless @options.include? :optional
         nil
       else
         force_cast object
@@ -27,7 +28,7 @@ module DropboxApi::Metadata
       elsif @type.ancestors.include? DropboxApi::Metadata::Base
         @type.new(object)
       else
-        raise NotImplementedError, "Can't cast `#{type}`"
+        raise NotImplementedError, "Can't cast `#{@type}`"
       end
     end
   end

data/lib/dropbox_api/metadata/file.rb

@@ -1,22 +1,21 @@
 module DropboxApi::Metadata
-  # NOTE: We should have a test to cover the initialization of this object.
-  # Sample:
-  # {
-  #   ".tag": "file",
-  #   "name": "Prime_Numbers.txt",
-  #   "path_lower": "/homework/math/prime_numbers.txt",
-  #   "path_display": "/Homework/math/Prime_Numbers.txt",
-  #   "id": "id:a4ayc_80_OEAAAAAAAAAXw",
-  #   "client_modified": "2015-05-12T15:50:38Z",
-  #   "server_modified": "2015-05-12T15:50:38Z",
-  #   "rev": "a1c10ce0dd78",
-  #   "size": 7212,
-  #   "sharing_info": {
-  #     "read_only": true,
-  #     "parent_shared_folder_id": "84528192421",
-  #     "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc"
+  # Example of a serialized {File} object:
+  #   {
+  #     ".tag": "file",
+  #     "name": "Prime_Numbers.txt",
+  #     "path_lower": "/homework/math/prime_numbers.txt",
+  #     "path_display": "/Homework/math/Prime_Numbers.txt",
+  #     "id": "id:a4ayc_80_OEAAAAAAAAAXw",
+  #     "client_modified": "2015-05-12T15:50:38Z",
+  #     "server_modified": "2015-05-12T15:50:38Z",
+  #     "rev": "a1c10ce0dd78",
+  #     "size": 7212,
+  #     "sharing_info": {
+  #       "read_only": true,
+  #       "parent_shared_folder_id": "84528192421",
+  #       "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc"
+  #     }
   #   }
-  # }
   class File < Base
     field :name, String
     field :path_lower, String
@@ -26,5 +25,9 @@ module DropboxApi::Metadata
     field :server_modified, Time
     field :rev, String
     field :size, Integer
+
+    def to_hash
+      super.merge(".tag" => "file")
+    end
   end
 end

data/lib/dropbox_api/metadata/file_link.rb

@@ -1,34 +1,33 @@
 module DropboxApi::Metadata
-  # NOTE: We should have a test to cover the initialization of this object.
-  # Sample:
-  # {
-  #   ".tag": "file",
-  #   "url": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0",
-  #   "name": "Prime_Numbers.txt",
-  #   "link_permissions": {
-  #     "can_revoke": false,
-  #     "resolved_visibility": {
-  #       ".tag": "public"
+  # Example of a serialized {FileLink} object:
+  #   {
+  #     ".tag": "file",
+  #     "url": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0",
+  #     "name": "Prime_Numbers.txt",
+  #     "link_permissions": {
+  #       "can_revoke": false,
+  #       "resolved_visibility": {
+  #         ".tag": "public"
+  #       },
+  #       "revoke_failure_reason": {
+  #         ".tag": "owner_only"
+  #       }
   #     },
-  #     "revoke_failure_reason": {
-  #       ".tag": "owner_only"
+  #     "client_modified": "2015-05-12T15:50:38Z",
+  #     "server_modified": "2015-05-12T15:50:38Z",
+  #     "rev": "a1c10ce0dd78",
+  #     "size": 7212,
+  #     "id": "id:a4ayc_80_OEAAAAAAAAAXw",
+  #     "path_lower": "/homework/math/prime_numbers.txt",
+  #     "team_member_info": {
+  #       "team_info": {
+  #         "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I",
+  #         "name": "Acme, Inc."
+  #       },
+  #       "display_name": "Roger Rabbit",
+  #       "member_id": "dbmid:abcd1234"
   #     }
-  #   },
-  #   "client_modified": "2015-05-12T15:50:38Z",
-  #   "server_modified": "2015-05-12T15:50:38Z",
-  #   "rev": "a1c10ce0dd78",
-  #   "size": 7212,
-  #   "id": "id:a4ayc_80_OEAAAAAAAAAXw",
-  #   "path_lower": "/homework/math/prime_numbers.txt",
-  #   "team_member_info": {
-  #     "team_info": {
-  #       "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I",
-  #       "name": "Acme, Inc."
-  #     },
-  #     "display_name": "Roger Rabbit",
-  #     "member_id": "dbmid:abcd1234"
   #   }
-  # }
   class FileLink < Base
     field :url, String
     field :name, String

data/lib/dropbox_api/metadata/file_member_action.rb

@@ -0,0 +1,30 @@
+module DropboxApi::Metadata
+  # Example of a serialized FileMemberAction:
+  #   {
+  #     ".tag": "success",
+  #     "success": {
+  #       ".tag": "viewer"
+  #     }
+  #   }
+  class FileMemberAction < Base
+    class << self
+      def new(data)
+        tag = data[".tag"]
+        class_for(tag.to_sym).new(data[tag])
+      end
+
+      private
+
+      def class_for(tag)
+        case tag
+        when :success
+          DropboxApi::Metadata::AccessLevel
+        when :member_error
+          DropboxApi::Errors::FileMemberActionError
+        else
+          raise ArgumentError, "Unable to build individual result with `#{tag}`"
+        end
+      end
+    end
+  end
+end

data/lib/dropbox_api/metadata/folder.rb

@@ -1,17 +1,20 @@
 module DropboxApi::Metadata
-  # NOTE: We should have a test to cover the initialization of this object.
-  # Sample:
-  # {
-  #   "name": "arizona_baby",
-  #   "path_lower": "/arizona_baby",
-  #   "path_display": "/arizona_baby",
-  #   "id": "id:7eWkV5hcfzAAAAAAAAAAAQ"
-  # }
+  # Example of a serialized {Folder} object:
+  #   {
+  #     "name": "arizona_baby",
+  #     "path_lower": "/arizona_baby",
+  #     "path_display": "/arizona_baby",
+  #     "id": "id:7eWkV5hcfzAAAAAAAAAAAQ"
+  #   }
   class Folder < Base
     field :name, String
     field :path_lower, String
     field :path_display, String
     field :id, String
     field :sharing_info, DropboxApi::Metadata::FolderSharingInfo, :optional
+
+    def to_hash
+      super.merge(".tag" => "folder")
+    end
   end
 end

data/lib/dropbox_api/metadata/folder_sharing_info.rb

@@ -1,10 +1,9 @@
 module DropboxApi::Metadata
-  # NOTE: We should have a test to cover the initialization of this object.
-  # Sample:
-  # {
-  #   "read_only": false,
-  #   "parent_shared_folder_id": "84528192421"
-  # }
+  # Example of a serialized {FolderSharingInfo} object:
+  #   {
+  #     "read_only": false,
+  #     "parent_shared_folder_id": "84528192421"
+  #   }
   class FolderSharingInfo < Base
     field :read_only, :boolean
     field :parent_shared_folder_id, String, :optional

data/lib/dropbox_api/metadata/link_permissions.rb

@@ -1,15 +1,14 @@
 module DropboxApi::Metadata
-  # NOTE: We should have a test to cover the initialization of this object.
-  # Sample:
-  # {
-  #   "can_revoke": false,
-  #   "resolved_visibility": {
-  #     ".tag": "public"
-  #   },
-  #   "revoke_failure_reason": {
-  #     ".tag": "owner_only"
+  # Example of a serialized {LinkPermissions} object:
+  #   {
+  #     "can_revoke": false,
+  #     "resolved_visibility": {
+  #       ".tag": "public"
+  #     },
+  #     "revoke_failure_reason": {
+  #       ".tag": "owner_only"
+  #     }
   #   }
-  # }
   class LinkPermissions < Base
     field :can_revoke, :boolean
     field :resolved_visibility, Symbol, :optional

data/lib/dropbox_api/metadata/member.rb

@@ -0,0 +1,47 @@
+module DropboxApi::Metadata
+  # Examples of serialized {AddMember} objects:
+  #   [
+  #     {
+  #       ".tag": "email",
+  #       "email": "justin@example.com"
+  #     },  {
+  #       ".tag": "dropbox_id",
+  #       "dropbox_id": "dbid:AAEufNrMPSPe0dMQijRP0N_aZtBJRm26W4Q"
+  #     }
+  #   ]
+  class Member < Base
+    class << self
+      def build_from_email_or_dropbox_id(email_or_id)
+        if email_or_id.start_with? "dbid:"
+          build_from_dropbox_id email_or_id
+        elsif email_or_id =~ /\A[^@\s]+@[^@\s]+\z/
+          build_from_email email_or_id
+        else
+          raise ArgumentError, "Invalid email or Dropbox ID: #{email_or_id}"
+        end
+      end
+
+      def build_from_dropbox_id(dropbox_id)
+        new({
+          :".tag" => :dropbox_id,
+          :dropbox_id => dropbox_id
+        })
+      end
+
+      def build_from_email(email)
+        new({
+          :".tag" => :email,
+          :email => email
+        })
+      end
+    end
+
+    def initialize(member)
+      @member = member
+    end
+
+    def to_hash
+      @member
+    end
+  end
+end

data/lib/dropbox_api/metadata/member_action_collection.rb

@@ -0,0 +1,44 @@
+module DropboxApi::Metadata
+  # This represents a collection of actions that may be taken on members of a
+  # shared folder. Each action will be one of the following:
+  #
+  # - leave_a_copy: Allow the member to keep a copy of the folder when removing.
+  # - make_editor: Make the member an editor of the folder.
+  # - make_owner: Make the member an owner of the folder.
+  # - make_viewer: Make the member a viewer of the folder.
+  # - make_viewer_no_comment: Make the member a viewer of the folder without commenting permissions.
+  # - remove: Remove the member from the folder.
+  #
+  # TODO: Split this object in two: MemberAction & MemberActionList,
+  #       DropboxApi::Metadata::MemberPermission will use it.
+  class MemberActionCollection < Array
+    ValidActions = [
+      :leave_a_copy,
+      :make_editor,
+      :make_owner,
+      :make_viewer,
+      :make_viewer_no_comment,
+      :remove
+    ]
+
+    def initialize(actions)
+      actions = symbolize actions
+      validate actions
+
+      super(actions)
+    end
+
+    private
+
+    def symbolize(actions)
+      actions.map &:to_sym
+    end
+
+    def validate(actions)
+      actions.each do |action|
+        raise ArgumentError,
+          "Invalid action: `#{action}`" unless ValidActions.include? action
+      end
+    end
+  end
+end

data/lib/dropbox_api/metadata/member_permission.rb

@@ -0,0 +1,7 @@
+module DropboxApi::Metadata
+  class MemberPermission < Base
+    field :action, String # This is actually a MemberAction object
+    field :allow, :boolean
+    field :reason, String # This is actually a PermissionDeniedReason object
+  end
+end

data/lib/dropbox_api/metadata/member_permission_list.rb

@@ -0,0 +1,7 @@
+module DropboxApi::Metadata
+  class MemberPermissionList < Array
+    def initialize(list)
+      super(list.map { |i| DropboxApi::Metadata::MemberPermission.new i })
+    end
+  end
+end

data/lib/dropbox_api/metadata/name.rb

@@ -1,12 +1,11 @@
 module DropboxApi::Metadata
-  # NOTE: We should have a test to cover the initialization of this object.
-  # Sample:
-  # {
-  #     "given_name": "Franz",
-  #     "surname": "Ferdinand",
-  #     "familiar_name": "Franz",
-  #     "display_name": "Franz Ferdinand (Personal)"
-  # },
+  # Example of a serialized {Name} object:
+  #   {
+  #       "given_name": "Franz",
+  #       "surname": "Ferdinand",
+  #       "familiar_name": "Franz",
+  #       "display_name": "Franz Ferdinand (Personal)"
+  #   }
   class Name < Base
     field :given_name, String
     field :surname, String

data/lib/dropbox_api/metadata/parent_folder_access_info.rb

@@ -0,0 +1,7 @@
+module DropboxApi::Metadata
+  class ParentFolderAccessInfo < Base
+    field :folder_name, String
+    field :shared_folder_id, String
+    field :permissions, DropboxApi::Metadata::MemberPermissionList
+  end
+end

data/lib/dropbox_api/metadata/shared_folder.rb

@@ -1,19 +1,18 @@
 module DropboxApi::Metadata
-  # NOTE: We should have a test to cover the initialization of this object.
-  # Sample:
-  # {
-  #   ".tag" => "complete",
-  #   "access_type" => {".tag"=>"owner"},
-  #   "is_team_folder" => false,
-  #   "policy" => {
-  #     "acl_update_policy" => { ".tag" => "owner" },
-  #     "shared_link_policy" => { ".tag" => "anyone" }
-  #   },
-  #   "path_lower" => "/folder_a",
-  #   "name" => "folder_a",
-  #   "shared_folder_id" => "1231266557",
-  #   "time_invited" => "2016-06-04T10:00:35Z"
-  # }
+  # Example of a serialized {SharedFolder} object:
+  #   {
+  #     ".tag" => "complete",
+  #     "access_type" => {".tag"=>"owner"},
+  #     "is_team_folder" => false,
+  #     "policy" => {
+  #       "acl_update_policy" => { ".tag" => "owner" },
+  #       "shared_link_policy" => { ".tag" => "anyone" }
+  #     },
+  #     "path_lower" => "/folder_a",
+  #     "name" => "folder_a",
+  #     "shared_folder_id" => "1231266557",
+  #     "time_invited" => "2016-06-04T10:00:35Z"
+  #   }
   class SharedFolder < Base
     field :access_type, String
     field :is_team_folder, :boolean

data/lib/dropbox_api/metadata/shared_folder_policy.rb

@@ -1,10 +1,9 @@
 module DropboxApi::Metadata
-  # NOTE: We should have a test to cover the initialization of this object.
-  # Sample:
-  # {
-  #   "acl_update_policy" => { ".tag" => "owner" },
-  #   "shared_link_policy" => { ".tag" => "anyone" }
-  # }
+  # Example of a serialized {SharedFolderPolicy} object:
+  #   {
+  #     "acl_update_policy" => { ".tag" => "owner" },
+  #     "shared_link_policy" => { ".tag" => "anyone" }
+  #   }
   class SharedFolderPolicy < Base
     field :acl_update_policy, Symbol
     field :shared_link_policy, Symbol