dropbox_api 0.1.10 → 0.1.11

data/lib/dropbox_api/metadata/member_action.rb

@@ -1,20 +1,23 @@
 module DropboxApi::Metadata
   # An action will be one of the following:
   #
-  # - +:leave_a_copy+: Allow the member to keep a copy of the folder when
+  # - `: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
+  # - `: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.
+  # - `:remove`: Remove the member from the folder.
   #
   # Example of a serialized {MemberAction} object:
-  #   {
-  #     ".tag": "leave_a_copy"
-  #   }
-  class MemberAction < DropboxApi::Metadata::Symbol
+  #
+  # ```json
+  # {
+  #   ".tag": "leave_a_copy"
+  # }
+  # ```
+  class MemberAction < DropboxApi::Metadata::Tag
     VALID_MEMBER_ACTIONS = [
       :leave_a_copy,
       :make_editor,

data/lib/dropbox_api/metadata/member_permission.rb

@@ -1,14 +1,17 @@
 module DropboxApi::Metadata
   # This is an example of a serialized {MemberPermission}:
-  #   {
-  #     "action": {
-  #       ".tag": "remove"
-  #     },
-  #     "allow": false,
-  #     "reason": {
-  #       ".tag": "target_is_self"
-  #     }
+  # 
+  # ```json
+  # {
+  #   "action": {
+  #     ".tag": "remove"
+  #   },
+  #   "allow": false,
+  #   "reason": {
+  #     ".tag": "target_is_self"
   #   }
+  # }
+  # ```
   #
   # This is normally contained in a {MemberPermissionList} object.
   class MemberPermission < Base

data/lib/dropbox_api/metadata/member_permission_list.rb

@@ -3,23 +3,25 @@ module DropboxApi::Metadata
   # shared file or folder.
   #
   # This is an example of a serialized {MemberActionList}:
-  #   [{
-  #     "action": {
-  #       ".tag": "remove"
-  #     },
-  #     "allow": false,
-  #     "reason": {
-  #       ".tag": "target_is_self"
-  #     }
-  #   }, {
-  #     "action": {
-  #       ".tag": "make_owner"
-  #     },
-  #     "allow": false,
-  #     "reason": {
-  #       ".tag": "target_is_self"
-  #     }
-  #   }]
+  # ```json
+  # [{
+  #   "action": {
+  #     ".tag": "remove"
+  #   },
+  #   "allow": false,
+  #   "reason": {
+  #     ".tag": "target_is_self"
+  #   }
+  # }, {
+  #   "action": {
+  #     ".tag": "make_owner"
+  #   },
+  #   "allow": false,
+  #   "reason": {
+  #     ".tag": "target_is_self"
+  #   }
+  # }]
+  # ```
   class MemberPermissionList < Array
     def initialize(list)
       super(list.map { |i| DropboxApi::Metadata::MemberPermission.new i })

data/lib/dropbox_api/metadata/name.rb

@@ -1,11 +1,14 @@
 module DropboxApi::Metadata
   # Example of a serialized {Name} object:
-  #   {
-  #       "given_name": "Franz",
-  #       "surname": "Ferdinand",
-  #       "familiar_name": "Franz",
-  #       "display_name": "Franz Ferdinand (Personal)"
-  #   }
+  #
+  # ```json
+  # {
+  #   "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/photo_metadata.rb

@@ -1,17 +1,20 @@
 module DropboxApi::Metadata
   # Example of a serialized {PhotoMetadata} object:
-  #   {
-  #     ".tag": "photo",
-  #     "dimensions": {
-  #       "height": 1500,
-  #       "width": 1500
-  #     },
-  #     "location": {
-  #       "latitude": 10.123456,
-  #       "longitude": 5.123456
-  #     }
-  #     "time_taken": "2016-09-04T17:00:27Z"
+  #
+  # ```json
+  # {
+  #   ".tag": "photo",
+  #   "dimensions": {
+  #     "height": 1500,
+  #     "width": 1500
+  #   },
+  #   "location": {
+  #     "latitude": 10.123456,
+  #     "longitude": 5.123456
   #   }
+  #   "time_taken": "2016-09-04T17:00:27Z"
+  # }
+  # ```
   class PhotoMetadata < Base
     field :dimensions, DropboxApi::Metadata::Dimensions, :optional
     field :location, DropboxApi::Metadata::Location, :optional

data/lib/dropbox_api/metadata/resource.rb

@@ -2,7 +2,7 @@ module DropboxApi::Metadata
   # This class is used as an adapter so we can create an object of the pertinent
   # class when we need to infer the type from the data.
   #
-  # For example, calling +Resource.new({".tag" => "file", :name => ...})+ will
+  # For example, calling `Resource.new({".tag" => "file", :name => ...})` will
   # instantiate a `File` object.
   #
   # So this could initalize an object of either `File`, `Folder` or `Deleted`.

data/lib/dropbox_api/metadata/shared_folder.rb

@@ -1,18 +1,21 @@
 module DropboxApi::Metadata
   # 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"
-  #   }
+  #
+  # ```json
+  # {
+  #   ".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,9 +1,12 @@
 module DropboxApi::Metadata
   # Example of a serialized {SharedFolderPolicy} object:
-  #   {
-  #     "acl_update_policy" => { ".tag" => "owner" },
-  #     "shared_link_policy" => { ".tag" => "anyone" }
-  #   }
+  #
+  # ```json
+  # {
+  #   "acl_update_policy" => { ".tag" => "owner" },
+  #   "shared_link_policy" => { ".tag" => "anyone" }
+  # }
+  # ```
   class SharedFolderPolicy < Base
     field :acl_update_policy, Symbol
     field :shared_link_policy, Symbol

data/lib/dropbox_api/metadata/shared_link.rb

@@ -1,26 +1,38 @@
 module DropboxApi::Metadata
-  # This class is used as an adapter so we can create an object of the pertinent
-  # class when we need to infer the type from the data.
-  #
-  # This same pattern is used in `DropboxApi::Metadata::Resource`
-  class SharedLink
-    class << self
-      def new(data)
-        class_for(data[".tag"].to_sym).new(data)
-      end
+  class SharedLink < Base
+    VALID_KEYS = [:url, :password]
+
+    def initialize(param)
+      @shared_link =
+        case param
+        when String
+          {:url => param}
+        when Hash
+          param
+        end
 
-      private
+      check_validity
+    end
+
+    def check_validity
+      if @shared_link[:url].nil?
+        raise ArgumentError, "Missing `:url` option"
+      end
 
-      def class_for(tag)
-        case tag
-        when :file
-          DropboxApi::Metadata::FileLink
-        when :folder
-          DropboxApi::Metadata::FolderLink
-        else
-          raise ArgumentError, "Unable to infer resource type for `#{tag}`"
+      @shared_link.keys.each do |key|
+        unless VALID_KEYS.include? key
+          raise ArgumentError, "Invalid option `#{key.inspect}`"
         end
       end
     end
+
+    def to_hash
+      @shared_link
+    end
+
+    private
+
+    def valid_keys
+    end
   end
 end

data/lib/dropbox_api/metadata/shared_link_metadata.rb

@@ -0,0 +1,26 @@
+module DropboxApi::Metadata
+  # This class is used as an adapter so we can create an object of the pertinent
+  # class when we need to infer the type from the data.
+  #
+  # This same pattern is used in `DropboxApi::Metadata::Resource`
+  class SharedLinkMetadata
+    class << self
+      def new(data)
+        class_for(data[".tag"].to_sym).new(data)
+      end
+
+      private
+
+      def class_for(tag)
+        case tag
+        when :file
+          DropboxApi::Metadata::FileLinkMetadata
+        when :folder
+          DropboxApi::Metadata::FolderLinkMetadata
+        else
+          raise ArgumentError, "Unable to infer resource type for `#{tag}`"
+        end
+      end
+    end
+  end
+end

data/lib/dropbox_api/metadata/space_allocation.rb

@@ -1,9 +1,12 @@
 module DropboxApi::Metadata
   # Example of a serialized {SpaceAllocation} object:
-  #   {
-  #     ".tag": "individual",
-  #     "allocated": 2147483648
-  #   }
+  #
+  # ```json
+  # {
+  #   ".tag": "individual",
+  #   "allocated": 2147483648
+  # }
+  # ```
   class SpaceAllocation < Base
     field :allocated, Integer
   end

data/lib/dropbox_api/metadata/space_usage.rb

@@ -1,12 +1,15 @@
 module DropboxApi::Metadata
   # Example of a serialized {SpaceUsage} object:
-  #   {
-  #     "used": 167685342,
-  #     "allocation": {
-  #       ".tag": "individual",
-  #       "allocated": 2147483648
-  #     }
+  #
+  # ```json
+  # {
+  #   "used": 167685342,
+  #   "allocation": {
+  #     ".tag": "individual",
+  #     "allocated": 2147483648
   #   }
+  # }
+  # ```
   class SpaceUsage < Base
     field :used, String
     field :allocation, DropboxApi::Metadata::SpaceAllocation

data/lib/dropbox_api/metadata/{symbol.rb → tag.rb}

@@ -1,5 +1,5 @@
 module DropboxApi::Metadata
-  class Symbol < DropboxApi::Metadata::Base
+  class Tag < DropboxApi::Metadata::Base
     def self.new(data)
       case data
       when ::Symbol

data/lib/dropbox_api/metadata/team_member_info.rb

@@ -1,13 +1,16 @@
 module DropboxApi::Metadata
   # Example of a serialized {TeamMemberInfo} object:
-  #   {
-  #     "team_info": {
-  #       "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I",
-  #       "name": "Acme, Inc."
-  #     },
-  #     "display_name": "Roger Rabbit",
-  #     "member_id": "dbmid:abcd1234"
-  #   }
+  #
+  # ```json
+  # {
+  #   "team_info": {
+  #     "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I",
+  #     "name": "Acme, Inc."
+  #   },
+  #   "display_name": "Roger Rabbit",
+  #   "member_id": "dbmid:abcd1234"
+  # }
+  # ```
   class TeamMemberInfo < Base
     field :team_info, DropboxApi::Metadata::Team
     field :display_name, String

data/lib/dropbox_api/metadata/thumbnail_batch_result_data.rb

@@ -0,0 +1,6 @@
+module DropboxApi::Metadata
+  class ThumbnailBatchResultData < Base
+    field :metadata, DropboxApi::Metadata::File
+    field :thumbnail, String
+  end
+end

data/lib/dropbox_api/metadata/thumbnail_batch_result_entry.rb

@@ -0,0 +1,23 @@
+module DropboxApi::Metadata
+  # This class is used as an adapter so we can create an object of the pertinent
+  # class when we need to infer the type from the data.
+  #
+  # This same pattern is used in `DropboxApi::Metadata::Resource`
+  #
+  # So this could initalize an object of either `ThumbnailBatchResultData`
+  # or `ThumbnailError`.
+  class ThumbnailBatchResultEntry
+    class << self
+      def new(data)
+        case data[".tag"].to_sym
+        when :success
+          DropboxApi::Metadata::ThumbnailBatchResultData.new(data)
+        when :failure
+          DropboxApi::Errors::ThumbnailError.build("Thumbnail generation failed", data["failure"])
+        else
+          raise NotImplementedError, "Unknown result type: #{data[".tag"]}"
+        end
+      end
+    end
+  end
+end

data/lib/dropbox_api/metadata/upload_session_cursor.rb

@@ -1,9 +1,12 @@
 module DropboxApi::Metadata
   # Example of a serialized {UploadSessionCursor} object:
-  #   {
-  #     "session_id": "AAAAAAAABCJ61k9yZZtn8Q",
-  #     "offset":9
-  #   }
+  #
+  # ```json
+  # {
+  #   "session_id": "AAAAAAAABCJ61k9yZZtn8Q",
+  #   "offset":9
+  # }
+  # ```
   class UploadSessionCursor < Base
     field :session_id, String
     field :offset, Integer

data/lib/dropbox_api/metadata/video_metadata.rb

@@ -1,18 +1,21 @@
 module DropboxApi::Metadata
   # Example of a serialized {MediaInfo} object:
-  #   {
-  #     ".tag": "video",
-  #     "dimensions": {
-  #       "height": 1500,
-  #       "width": 1500
-  #     },
-  #     "location": {
-  #       "latitude": 10.123456,
-  #       "longitude": 5.123456
-  #     }
-  #     "time_taken": "2016-09-04T17:00:27Z",
-  #     "duration": 6000
+  #
+  # ```json
+  # {
+  #   ".tag": "video",
+  #   "dimensions": {
+  #     "height": 1500,
+  #     "width": 1500
+  #   },
+  #   "location": {
+  #     "latitude": 10.123456,
+  #     "longitude": 5.123456
   #   }
+  #   "time_taken": "2016-09-04T17:00:27Z",
+  #   "duration": 6000
+  # }
+  # ```
   class VideoMetadata < Base
     field :dimensions, DropboxApi::Metadata::Dimensions, :optional
     field :location, DropboxApi::Metadata::Location, :optional