dropbox_api 0.1.16 → 0.1.19

data/lib/dropbox_api/errors/write_error.rb

@@ -1,11 +1,12 @@
+# frozen_string_literal: true
 module DropboxApi::Errors
   class WriteError < BasicError
     ErrorSubtypes = {
-      :malformed_path => MalformedPathError,
-      :conflict => WriteConflictError,
-      :no_write_permission => NoWritePermissionError,
-      :insufficient_space => InsufficientSpaceError,
-      :disallowed_name => DisallowedNameError
+      malformed_path: MalformedPathError,
+      conflict: WriteConflictError,
+      no_write_permission: NoWritePermissionError,
+      insufficient_space: InsufficientSpaceError,
+      disallowed_name: DisallowedNameError
     }
   end
 end

data/lib/dropbox_api/metadata/access_level.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi::Metadata
   # Example of a serialized {AccessLevel} object:
   #

data/lib/dropbox_api/metadata/add_file_member_result.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi::Metadata
   # Example of a {AddFileMemberResult}:
   #

data/lib/dropbox_api/metadata/add_member.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi::Metadata
   # Examples of serialized {AddMember} objects:
   #
@@ -25,8 +26,8 @@ module DropboxApi::Metadata
     class << self
       def build_from_string(member, access_level = :editor)
         new({
-          "member" => Member.new(member),
-          "access_level" => access_level
+          'member' => Member.new(member),
+          'access_level' => access_level
         })
       end
     end

data/lib/dropbox_api/metadata/base.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi::Metadata
   class Base
     class << self
@@ -46,7 +47,7 @@ module DropboxApi::Metadata
       value = send field_name
       case value
       when Time
-        value.utc.strftime("%FT%TZ")
+        value.utc.strftime('%FT%TZ')
       when DropboxApi::Metadata::Base
         value.to_hash
       else

data/lib/dropbox_api/metadata/basic_account.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi::Metadata
   # Example of a serialized {BasicAccount} object:
   #

data/lib/dropbox_api/metadata/commit_info.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi::Metadata
   class CommitInfo < Base
     field :path, String
@@ -36,7 +37,7 @@ module DropboxApi::Metadata
       end
 
       def build_client_modified(client_modified)
-        client_modified.utc.strftime("%FT%TZ")
+        client_modified.utc.strftime('%FT%TZ')
       end
     end
   end

data/lib/dropbox_api/metadata/deleted.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi::Metadata
   # Example of a serialized {Deleted} object:
   #

data/lib/dropbox_api/metadata/dimensions.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi::Metadata
   class Dimensions < Base
     field :height, Integer

data/lib/dropbox_api/metadata/field.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi::Metadata
   class Field
     def initialize(type, options = [])
@@ -24,13 +25,15 @@ module DropboxApi::Metadata
       elsif @type == Float
         object.to_f
       elsif @type == Symbol
-        object[".tag"].to_sym
+        object['.tag'].to_sym
       elsif @type == :boolean
-        object.to_s == "true"
-      elsif @type.ancestors.include? DropboxApi::Metadata::Base
+        object.to_s == 'true'
+      elsif @type.ancestors.include?(DropboxApi::Metadata::Base) ||
+            @type.ancestors.include?(Array) ||
+            @type == DropboxApi::Metadata::Resource
         @type.new(object)
       else
-        raise NotImplementedError, "Can't cast `#{@type}`"
+        raise NotImplementedError, "Can't cast #{object} to `#{@type}`"
       end
     end
   end

data/lib/dropbox_api/metadata/file.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi::Metadata
   # Example of a serialized {File} object:
   #
@@ -33,7 +34,7 @@ module DropboxApi::Metadata
     field :has_explicit_shared_members, :boolean, :optional
 
     def to_hash
-      super.merge(".tag" => "file")
+      super.merge('.tag' => 'file')
     end
   end
 end

data/lib/dropbox_api/metadata/file_categories_list.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module DropboxApi::Metadata
+  class FileCategoriesList < Array
+    def initialize(list)
+      super(list.map { |c| DropboxApi::Metadata::FileCategory.new c })
+    end
+  end
+end

data/lib/dropbox_api/metadata/file_category.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module DropboxApi::Metadata
+  class FileCategory < DropboxApi::Metadata::Tag
+    VALID_VALUES = %i[
+      image
+      document
+      pdf
+      spreadsheet
+      presentation
+      audio
+      video
+      folder
+      paper
+      others
+    ].freeze
+
+    def self.valid_values
+      VALID_VALUES
+    end
+  end
+end

data/lib/dropbox_api/metadata/file_extensions_list.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module DropboxApi::Metadata
+  class FileExtensionsList < Array
+    def initialize(data)
+      if !data.is_a?(Array) || data.any? { |v| !v.is_a? String }
+        raise ArgumentError, "Invalid extension list: #{data.inspect}."
+      end
+
+      super(data)
+    end
+  end
+end

data/lib/dropbox_api/metadata/file_link_metadata.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi::Metadata
   # Example of a serialized {FileLinkMetadata} object:
   #

data/lib/dropbox_api/metadata/file_member_action.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi::Metadata
   # Example of a serialized FileMemberAction:
   #
@@ -12,7 +13,7 @@ module DropboxApi::Metadata
   class FileMemberAction < Base
     class << self
       def new(data)
-        tag = data[".tag"]
+        tag = data['.tag']
         class_for(tag.to_sym).new(data[tag])
       end
 

data/lib/dropbox_api/metadata/file_request.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi::Metadata
   # Example of a serialized {FileRequest} object:
   #

data/lib/dropbox_api/metadata/file_status.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module DropboxApi::Metadata
+  class FileStatus < DropboxApi::Metadata::Tag
+    VALID_VALUES = %i[
+      active
+      deleted
+    ].freeze
+
+    def self.valid_values
+      VALID_VALUES
+    end
+  end
+end

data/lib/dropbox_api/metadata/folder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi::Metadata
   # Example of a serialized {Folder} object:
   #
@@ -17,7 +18,7 @@ module DropboxApi::Metadata
     field :sharing_info, DropboxApi::Metadata::FolderSharingInfo, :optional
 
     def to_hash
-      super.merge(".tag" => "folder")
+      super.merge('.tag' => 'folder')
     end
   end
 end

data/lib/dropbox_api/metadata/folder_link_metadata.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi::Metadata
   class FolderLinkMetadata < Base
     field :url, String

data/lib/dropbox_api/metadata/folder_sharing_info.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi::Metadata
   # Example of a serialized {FolderSharingInfo} object:
   #

data/lib/dropbox_api/metadata/link_permissions.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi::Metadata
   # Example of a serialized {LinkPermissions} object:
   #

data/lib/dropbox_api/metadata/location.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi::Metadata
   class Location < Base
     field :latitude, Float

data/lib/dropbox_api/metadata/media_info.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi::Metadata
   # Example of a serialized {MediaInfo} object:
   #

data/lib/dropbox_api/metadata/media_metadata.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi::Metadata
   # Example of a serialized {MediaInfo} object:
   # 

data/lib/dropbox_api/metadata/member.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi::Metadata
   # Examples of serialized {AddMember} objects:
   #
@@ -33,7 +34,7 @@ module DropboxApi::Metadata
     private
 
     def hash_from_email_or_dropbox_id(email_or_id)
-      if email_or_id.start_with? "dbid:"
+      if email_or_id.start_with? 'dbid:'
         hash_from_dropbox_id email_or_id
       elsif email_or_id =~ /\A[^@\s]+@[^@\s]+\z/
         hash_from_email email_or_id
@@ -44,15 +45,15 @@ module DropboxApi::Metadata
 
     def hash_from_dropbox_id(dropbox_id)
       {
-        :".tag" => :dropbox_id,
-        :dropbox_id => dropbox_id
+        ".tag": :dropbox_id,
+        dropbox_id: dropbox_id
       }
     end
 
     def hash_from_email(email)
       {
-        :".tag" => :email,
-        :email => email
+        ".tag": :email,
+        email: email
       }
     end
   end

data/lib/dropbox_api/metadata/member_action.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi::Metadata
   # An action will be one of the following:
   #

data/lib/dropbox_api/metadata/member_action_list.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi::Metadata
   class MemberActionList < Array
     # Builds a list of actions for a shared folder.

data/lib/dropbox_api/metadata/member_permission.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi::Metadata
   # This is an example of a serialized {MemberPermission}:
   # 

data/lib/dropbox_api/metadata/member_permission_list.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi::Metadata
   # This represents a collection of permissions on allowed on a
   # shared file or folder.

data/lib/dropbox_api/metadata/metadata_v2.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module DropboxApi::Metadata
+  class MetadataV2 < Base
+    field :metadata, DropboxApi::Metadata::Resource
+  end
+end

data/lib/dropbox_api/metadata/name.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi::Metadata
   # Example of a serialized {Name} object:
   #

data/lib/dropbox_api/metadata/parent_folder_access_info.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi::Metadata
   class ParentFolderAccessInfo < Base
     field :folder_name, String

data/lib/dropbox_api/metadata/photo_metadata.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi::Metadata
   # Example of a serialized {PhotoMetadata} object:
   #

data/lib/dropbox_api/metadata/resource.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 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.
@@ -9,7 +10,7 @@ module DropboxApi::Metadata
   class Resource
     class << self
       def new(data)
-        class_for(data[".tag"].to_sym).new(data)
+        class_for(data['.tag'].to_sym).new(data)
       end
 
       private

data/lib/dropbox_api/metadata/search_match_field_options.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module DropboxApi::Metadata
+  class SearchMatchFieldOptions < Base
+    # Whether to include highlight span from file title. The default for
+    # this field is False.
+    field :include_highlights, :boolean, :optional
+  end
+end

data/lib/dropbox_api/metadata/search_match_type_v2.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module DropboxApi::Metadata
+  class SearchMatchTypeV2 < DropboxApi::Metadata::Tag
+    VALID_VALUES = %i[
+      filename
+      file_content
+      filename_and_content
+      image_content
+    ].freeze
+
+    def self.valid_values
+      VALID_VALUES
+    end
+  end
+end

data/lib/dropbox_api/metadata/search_match_v2.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module DropboxApi::Metadata
+  class SearchMatchV2 < Base
+    # The metadata for the matched file or folder.
+    field :metadata, DropboxApi::Metadata::MetadataV2
+
+    # The type of the match. This field is optional.
+    field :match_type, SearchMatchTypeV2
+
+    def resource
+      # for some strange reason, v2 of this search endpoint doesn't have
+      # the `resource` field anymore and file metadata is wrapped in a
+      # metadata/metadata field...
+      metadata.metadata
+    end
+  end
+end

data/lib/dropbox_api/metadata/search_options.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module DropboxApi::Metadata
+  class SearchOptions < Base
+    # Scopes the search to a path in the user's Dropbox. Searches the entire
+    # Dropbox if not specified. This field is optional.
+    field :path, String, :optional
+
+    # The maximum number of search results to return. The default for this
+    # field is 100.
+    field :max_results, Integer, :optional
+
+    # Specified property of the order of search results. By default, results
+    # are sorted by relevance. This field is optional.
+    field :order_by, DropboxApi::Metadata::SearchOrderBy, :optional
+
+    # Restricts search to the given file status. The default for this union
+    # is active.
+    field :file_status, DropboxApi::Metadata::FileStatus, :optional
+
+    # Restricts search to only match on filenames. The default for this field
+    # is false.
+    field :filename_only, :boolean, :optional
+
+    # Restricts search to only the extensions specified. Only supported for
+    # active file search. This field is optional.
+    field :file_extensions, DropboxApi::Metadata::FileExtensionsList, :optional
+
+    # Restricts search to only the file categories specified. Only supported
+    # for active file search. This field is optional.
+    field :file_categories, DropboxApi::Metadata::FileCategoriesList, :optional
+  end
+end

data/lib/dropbox_api/metadata/search_order_by.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module DropboxApi::Metadata
+  class SearchOrderBy < DropboxApi::Metadata::Tag
+    VALID_VALUES = %i[
+      relevance
+      last_modified_time
+    ].freeze
+
+    def self.valid_values
+      VALID_VALUES
+    end
+  end
+end

data/lib/dropbox_api/metadata/shared_folder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi::Metadata
   # Example of a serialized {SharedFolder} object:
   #

data/lib/dropbox_api/metadata/shared_folder_policy.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi::Metadata
   # Example of a serialized {SharedFolderPolicy} object:
   #

data/lib/dropbox_api/metadata/shared_link.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi::Metadata
   class SharedLink < Base
     VALID_KEYS = [:url, :password]
@@ -6,7 +7,7 @@ module DropboxApi::Metadata
       @shared_link =
         case param
         when String
-          {:url => param}
+          {url: param}
         when Hash
           param
         end
@@ -16,7 +17,7 @@ module DropboxApi::Metadata
 
     def check_validity
       if @shared_link[:url].nil?
-        raise ArgumentError, "Missing `:url` option"
+        raise ArgumentError, 'Missing `:url` option'
       end
 
       @shared_link.keys.each do |key|

data/lib/dropbox_api/metadata/shared_link_metadata.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 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.
@@ -6,7 +7,7 @@ module DropboxApi::Metadata
   class SharedLinkMetadata
     class << self
       def new(data)
-        class_for(data[".tag"].to_sym).new(data)
+        class_for(data['.tag'].to_sym).new(data)
       end
 
       private

data/lib/dropbox_api/metadata/space_allocation.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi::Metadata
   # Example of a serialized {SpaceAllocation} object:
   #

data/lib/dropbox_api/metadata/space_usage.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi::Metadata
   # Example of a serialized {SpaceUsage} object:
   #

data/lib/dropbox_api/metadata/tag.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi::Metadata
   class Tag < DropboxApi::Metadata::Base
     def self.new(data)
@@ -5,7 +6,7 @@ module DropboxApi::Metadata
       when ::Symbol
         validate(data)
       when Hash
-        new(data[".tag"].to_sym)
+        new(data['.tag'].to_sym)
       when String
         new(data.to_sym)
       else

data/lib/dropbox_api/metadata/team.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi::Metadata
   class Team < Base
     field :id, String

data/lib/dropbox_api/metadata/team_member_info.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi::Metadata
   # Example of a serialized {TeamMemberInfo} object:
   #

data/lib/dropbox_api/metadata/thumbnail_batch_result_data.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi::Metadata
   class ThumbnailBatchResultData < Base
     field :metadata, DropboxApi::Metadata::File

data/lib/dropbox_api/metadata/thumbnail_batch_result_entry.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 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.
@@ -9,11 +10,11 @@ module DropboxApi::Metadata
   class ThumbnailBatchResultEntry
     class << self
       def new(data)
-        case data[".tag"].to_sym
+        case data['.tag'].to_sym
         when :success
           DropboxApi::Metadata::ThumbnailBatchResultData.new(data)
         when :failure
-          DropboxApi::Errors::ThumbnailError.build("Thumbnail generation failed", data["failure"])
+          DropboxApi::Errors::ThumbnailError.build('Thumbnail generation failed', data['failure'])
         else
           raise NotImplementedError, "Unknown result type: #{data[".tag"]}"
         end

data/lib/dropbox_api/metadata/upload_session_cursor.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi::Metadata
   # Example of a serialized {UploadSessionCursor} object:
   #

data/lib/dropbox_api/metadata/video_metadata.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi::Metadata
   # Example of a serialized {MediaInfo} object:
   #

data/lib/dropbox_api/metadata/write_mode.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi::Metadata
   # Your intent when writing a file to some path. This is used to determine
   # what constitutes a conflict and what the autorename strategy is.
@@ -48,22 +49,22 @@ module DropboxApi::Metadata
         @write_mode = write_mode
       when String, ::Symbol
         @write_mode = {
-          ".tag" => write_mode
+          '.tag' => write_mode
         }
         @write_mode[write_mode.to_s] = options unless options.nil?
       end
-      @write_mode[".tag"] = @write_mode[".tag"].to_sym
+      @write_mode['.tag'] = @write_mode['.tag'].to_sym
 
       check_validity
     end
 
     def check_validity
-      unless valid_mode? @write_mode[".tag"]
+      unless valid_mode? @write_mode['.tag']
         raise ArgumentError, "Invalid write mode: #{@write_mode[".tag"]}"
       end
 
-      if @write_mode[".tag"] == :update && @write_mode["update"].nil?
-        raise ArgumentError, "Mode `:update` expects a `rev` number"
+      if @write_mode['.tag'] == :update && @write_mode['update'].nil?
+        raise ArgumentError, 'Mode `:update` expects a `rev` number'
       end
     end