dropbox_api 0.1.10 → 0.1.11

data/lib/dropbox_api/metadata/add_member.rb

@@ -1,23 +1,26 @@
 module DropboxApi::Metadata
   # Examples of serialized {AddMember} objects:
-  #   {
-  #     "member": {
-  #       ".tag": "email",
-  #       "email": "justin@example.com"
-  #     },
-  #     "access_level": {
-  #       ".tag": "editor"
-  #     }
+  #
+  # ```json
+  # {
+  #   "member": {
+  #     ".tag": "email",
+  #     "email": "justin@example.com"
   #   },
-  #   {
-  #     "member": {
-  #       ".tag": "dropbox_id",
-  #       "dropbox_id": "dbid:AAEufNrMPSPe0dMQijRP0N_aZtBJRm26W4Q"
-  #     },
-  #     "access_level": {
-  #       ".tag": "viewer"
-  #     }
+  #   "access_level": {
+  #     ".tag": "editor"
   #   }
+  # },
+  # {
+  #   "member": {
+  #     ".tag": "dropbox_id",
+  #     "dropbox_id": "dbid:AAEufNrMPSPe0dMQijRP0N_aZtBJRm26W4Q"
+  #   },
+  #   "access_level": {
+  #     ".tag": "viewer"
+  #   }
+  # }
+  # ```
   class AddMember < Base
     class << self
       def build_from_string(member, access_level = :editor)

data/lib/dropbox_api/metadata/basic_account.rb

@@ -1,20 +1,23 @@
 module DropboxApi::Metadata
   # 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"
-  #   }
+  #
+  # ```json
+  # {
+  #   "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

data/lib/dropbox_api/metadata/commit_info.rb

@@ -1,9 +1,43 @@
 module DropboxApi::Metadata
   class CommitInfo < Base
     field :path, String
-    field :mode, DropboxApi::Metadata::WriteMode
+    field :mode, DropboxApi::Metadata::WriteMode, :optional
     field :autorename, :boolean, :optional
     field :client_modified, Time, :optional
     field :mute, :boolean, :optional
+
+    class << self
+      def build_from_options(options)
+        options = Hash[options.map do |key, value|
+          case key
+          when :mode
+            [key.to_s, build_write_mode(value)]
+          when :client_modified
+            [key.to_s, build_client_modified(value)]
+          when :path, :autorename, :mute
+            [key.to_s, value]
+          end
+        end.compact]
+
+        new(options)
+      end
+
+      private
+
+      def build_write_mode(write_mode)
+        case write_mode
+        when String, Symbol
+          DropboxApi::Metadata::WriteMode.new write_mode
+        when DropboxApi::Metadata::WriteMode
+          write_mode
+        else
+          raise ArgumentError, "Invalid write mode: #{write_mode.inspect}"
+        end.to_hash
+      end
+
+      def build_client_modified(client_modified)
+        client_modified.utc.strftime("%FT%TZ")
+      end
+    end
   end
 end

data/lib/dropbox_api/metadata/deleted.rb

@@ -1,11 +1,14 @@
 module DropboxApi::Metadata
   # Example of a serialized {Deleted} object:
-  #   {
-  #     ".tag": "deleted",
-  #     "name": "file.txt",
-  #     "path_lower": "/file.txt",
-  #     "path_display": "/file.txt"
-  #   }
+  #
+  # ```json
+  # {
+  #   ".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/file.rb

@@ -1,21 +1,24 @@
 module DropboxApi::Metadata
   # 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"
-  #     }
+  #
+  # ```json
+  # {
+  #   ".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

data/lib/dropbox_api/metadata/file_link_metadata.rb

@@ -0,0 +1,48 @@
+module DropboxApi::Metadata
+  # Example of a serialized {FileLinkMetadata} object:
+  #
+  # ```json
+  # {
+  #   ".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"
+  #     }
+  #   },
+  #   "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 FileLinkMetadata < Base
+    field :url, String
+    field :name, String
+    field :link_permissions, DropboxApi::Metadata::LinkPermissions
+    field :client_modified, Time
+    field :server_modified, Time
+    field :rev, String
+    field :size, Integer
+    field :id, String, :optional
+    field :expires, Time, :optional
+    field :path_lower, String, :optional
+    field :team_member_info, DropboxApi::Metadata::TeamMemberInfo, :optional
+    field :content_owner_team_info, DropboxApi::Metadata::Team, :optional
+  end
+end

data/lib/dropbox_api/metadata/file_member_action.rb

@@ -1,11 +1,14 @@
 module DropboxApi::Metadata
   # Example of a serialized FileMemberAction:
-  #   {
-  #     ".tag": "success",
-  #     "success": {
-  #       ".tag": "viewer"
-  #     }
+  #
+  # ```json
+  # {
+  #   ".tag": "success",
+  #   "success": {
+  #     ".tag": "viewer"
   #   }
+  # }
+  # ```
   class FileMemberAction < Base
     class << self
       def new(data)

data/lib/dropbox_api/metadata/file_request.rb

@@ -0,0 +1,30 @@
+module DropboxApi::Metadata
+  # Example of a serialized {FileRequest} object:
+  #
+  # ```json
+  # {
+  #     "id": "oaCAVmEyrqYnkZX9955Y",
+  #     "url": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y",
+  #     "title": "Homework submission",
+  #     "created": "2015-10-05T17:00:00Z",
+  #     "is_open": true,
+  #     "file_count": 3,
+  #     "destination": "/File Requests/Homework",
+  #     "deadline": {
+  #         "deadline": "2020-10-12T17:00:00Z",
+  #         "allow_late_uploads": {
+  #             ".tag": "seven_days"
+  #         }
+  #     }
+  # }
+  # ```
+  class FileRequest < Base
+    field :id, String
+    field :url, String
+    field :title, String
+    field :created, Time
+    field :is_open, :boolean
+    field :file_count, Integer
+    field :destination, String
+  end
+end

data/lib/dropbox_api/metadata/folder.rb

@@ -1,11 +1,14 @@
 module DropboxApi::Metadata
   # Example of a serialized {Folder} object:
-  #   {
-  #     "name": "arizona_baby",
-  #     "path_lower": "/arizona_baby",
-  #     "path_display": "/arizona_baby",
-  #     "id": "id:7eWkV5hcfzAAAAAAAAAAAQ"
-  #   }
+  #
+  # ```json
+  # {
+  #   "name": "arizona_baby",
+  #   "path_lower": "/arizona_baby",
+  #   "path_display": "/arizona_baby",
+  #   "id": "id:7eWkV5hcfzAAAAAAAAAAAQ"
+  # }
+  # ```
   class Folder < Base
     field :name, String
     field :path_lower, String

data/lib/dropbox_api/metadata/{folder_link.rb → folder_link_metadata.rb}

@@ -1,5 +1,5 @@
 module DropboxApi::Metadata
-  class FolderLink < Base
+  class FolderLinkMetadata < Base
     field :url, String
     field :name, String
     field :link_permissions, DropboxApi::Metadata::LinkPermissions

data/lib/dropbox_api/metadata/folder_sharing_info.rb

@@ -1,9 +1,12 @@
 module DropboxApi::Metadata
   # Example of a serialized {FolderSharingInfo} object:
-  #   {
-  #     "read_only": false,
-  #     "parent_shared_folder_id": "84528192421"
-  #   }
+  #
+  # ```json
+  # {
+  #   "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,14 +1,17 @@
 module DropboxApi::Metadata
   # Example of a serialized {LinkPermissions} object:
-  #   {
-  #     "can_revoke": false,
-  #     "resolved_visibility": {
-  #       ".tag": "public"
-  #     },
-  #     "revoke_failure_reason": {
-  #       ".tag": "owner_only"
-  #     }
+  #
+  # ```json
+  # {
+  #   "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/media_info.rb

@@ -1,13 +1,20 @@
 module DropboxApi::Metadata
   # Example of a serialized {MediaInfo} object:
-  #   {
-  #     ".tag": "metadata",
-  #     "metadata": {...}
-  #   }
+  #
+  # ```json
+  # {
+  #   ".tag": "metadata",
+  #   "metadata": {...}
+  # }
+  # ```
+  #
   # or:
-  #   {
-  #     ".tag": "pending"
-  #   }
+  #
+  # ```json
+  # {
+  #   ".tag": "pending"
+  # }
+  # ```
   class MediaInfo < Base
     class << self
       def new(data)

data/lib/dropbox_api/metadata/media_metadata.rb

@@ -1,19 +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 MediaMetadata < Base
     class << self
       def new(data)

data/lib/dropbox_api/metadata/member.rb

@@ -1,14 +1,17 @@
 module DropboxApi::Metadata
   # Examples of serialized {AddMember} objects:
-  #   [
-  #     {
-  #       ".tag": "email",
-  #       "email": "justin@example.com"
-  #     },  {
-  #       ".tag": "dropbox_id",
-  #       "dropbox_id": "dbid:AAEufNrMPSPe0dMQijRP0N_aZtBJRm26W4Q"
-  #     }
-  #   ]
+  #
+  # ```json
+  # [
+  #   {
+  #     ".tag": "email",
+  #     "email": "justin@example.com"
+  #   },  {
+  #     ".tag": "dropbox_id",
+  #     "dropbox_id": "dbid:AAEufNrMPSPe0dMQijRP0N_aZtBJRm26W4Q"
+  #   }
+  # ]
+  # ```
   class Member < Base
     def initialize(member)
       @member_hash = case member