dropbox_api 0.1.16 → 0.1.21

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/team_root_info.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+module DropboxApi::Metadata
+  class TeamRootInfo < Base
+    field :root_namespace_id, String
+    field :home_namespace_id, String
+    field :home_path, String
+  end
+end

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/user_root_info.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+module DropboxApi::Metadata
+  class UserRootInfo < Base
+    field :root_namespace_id, String
+    field :home_namespace_id, String
+  end
+end

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
 

data/lib/dropbox_api/middleware/decode_result.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi::MiddleWare
   class DecodeResult < Faraday::Middleware
     def call(rq_env)
@@ -14,7 +15,7 @@ module DropboxApi::MiddleWare
       # Dropbox may send a response with the string 'null' in its body, this
       # would be a void result. `add_folder_member` is an example of an
       # endpoint without return values.
-      if json == "null"
+      if json == 'null'
         {}
       else
         JSON.parse json
@@ -22,5 +23,5 @@ module DropboxApi::MiddleWare
     end
   end
 
-  Faraday::Response.register_middleware :decode_result => DecodeResult
+  Faraday::Response.register_middleware decode_result: DecodeResult
 end

data/lib/dropbox_api/middleware/path_root.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+module DropboxApi::MiddleWare
+  class PathRoot < Faraday::Middleware
+    HEADER_NAME = 'Dropbox-API-Path-Root'
+
+    def initialize(app, options = {})
+      super(app)
+      @options = options
+    end
+
+    def namespace_id
+      if @options[:namespace_id].nil?
+        return nil
+      else
+        return @options[:namespace_id]
+      end
+    end
+
+    def namespace_id_header_value
+      JSON.dump(
+        DropboxApi::Metadata::NamespaceId.new({
+          'namespace_id' => namespace_id
+        }).to_hash
+      )
+    end
+
+    def call(env)
+      if !namespace_id.nil?
+        env[:request_headers][HEADER_NAME] ||= namespace_id_header_value
+      end
+
+      @app.call env
+    end
+  end
+end

data/lib/dropbox_api/middleware/stack.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi::MiddleWare
   class Stack
     def initialize

data/lib/dropbox_api/options_validator.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi
   module OptionsValidator
     # Takes in a list of valid option keys and a hash of options. If one of the

data/lib/dropbox_api/result_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi
   class ResultBuilder
     def initialize(response_data)
@@ -5,11 +6,11 @@ module DropboxApi
     end
 
     def error_summary
-      @response_data["error_summary"] if @response_data.is_a? Hash
+      @response_data['error_summary'] if @response_data.is_a? Hash
     end
 
     def error
-      @response_data["error"]
+      @response_data['error']
     end
 
     def has_error?

data/lib/dropbox_api/results/add_file_member_result_list.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi::Results
   # Example of a result of the `add_file_member` endpoint:
   #   [{

data/lib/dropbox_api/results/base.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi::Results
   class Base
     def initialize(result_data)

data/lib/dropbox_api/results/basic_account_batch.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi::Results
   class BasicAccountBatch < Array
     def initialize(accounts)

data/lib/dropbox_api/results/copy_batch_result.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+module DropboxApi::Results
+  class CopyBatchResult < DropboxApi::Results::Base
+    def self.new(result_data)
+      case result_data['.tag']
+      when 'async_job_id'
+        result_data['async_job_id']
+      when 'complete'
+        RelocationBatchResult.new(result_data)
+      else
+        raise NotImplementedError, "Unknown result type: #{result_data['.tag']}"
+      end
+    end
+  end
+end

data/lib/dropbox_api/results/create_folder_batch_result.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+module DropboxApi::Results
+  # Result returned by {Client#create_folder_batch} that may either launch an
+  # asynchronous job or complete synchronously.
+  #
+  # The value will be either a job id or a list of job statuses.
+  class CreateFolderBatchResult < DropboxApi::Results::Base
+    def self.new(result_data)
+      case result_data['.tag']
+      when 'async_job_id'
+        result_data
+      when 'complete'
+        result_data['entries'].map do |entry|
+          DropboxApi::Results::CreateFolderBatchResultEntry.new(entry)
+        end
+      else
+        raise NotImplementedError, "Unknown result type: #{result_data['.tag']}"
+      end
+    end
+  end
+end

data/lib/dropbox_api/results/create_folder_batch_result_entry.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+module DropboxApi::Results
+  class CreateFolderBatchResultEntry < DropboxApi::Results::Base
+    def self.new(result_data)
+      case result_data['.tag']
+      when 'success'
+        DropboxApi::Metadata::Folder.new result_data['metadata']
+      when 'failure'
+        # At the moment, this is a `CreateFolderEntryError` which is an open
+        # union that can only be a `WriteError`. In the future, more errors
+        # could be added to the API which means we'd have to implement the
+        # actual `CreateFolderEntryError` class.
+        DropboxApi::Errors::WriteError
+          .build('Folder operation failed', result_data['failure']['path'])
+      else
+        raise NotImplementedError, "Unknown result type: #{result_data['.tag']}"
+      end
+    end
+  end
+end

data/lib/dropbox_api/results/delete_batch_result.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+module DropboxApi::Results
+  # Result returned by {Client#delete_batch} that may either launch an
+  # asynchronous job or complete synchronously.
+  #
+  # The value will be either a job id or a list of job statuses.
+  class DeleteBatchResult < DropboxApi::Results::Base
+    def self.new(result_data)
+      case result_data['.tag']
+      when 'async_job_id'
+        result_data
+      when 'complete'
+        result_data['entries'].map do |entry|
+          DropboxApi::Results::DeleteBatchResultEntry.new(entry)
+        end
+      else
+        raise NotImplementedError, "Unknown result type: #{result_data[".tag"]}"
+      end
+    end
+  end
+end

data/lib/dropbox_api/results/delete_batch_result_entry.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+module DropboxApi::Results
+  class DeleteBatchResultEntry < DropboxApi::Results::Base
+    def self.new(result_data)
+      case result_data['.tag']
+      when 'success'
+        DropboxApi::Metadata::Resource.new result_data['metadata']
+      when 'failure'
+        DropboxApi::Errors::DeleteError
+          .build('Delete operation failed', result_data['failure'])
+      else
+        raise NotImplementedError, "Unknown result type: #{result_data['.tag']}"
+      end
+    end
+  end
+end

data/lib/dropbox_api/results/get_copy_reference_result.rb

@@ -1,20 +1,21 @@
+# frozen_string_literal: true
 module DropboxApi::Results
   class GetCopyReferenceResult < DropboxApi::Results::Base
     # Metadata of the file or folder.
     def resource
-      @resource ||= DropboxApi::Metadata::Resource.new @data["metadata"]
+      @resource ||= DropboxApi::Metadata::Resource.new @data['metadata']
     end
 
     # A copy reference to the file or folder.
     def copy_reference
-      @copy_reference ||= @data["copy_reference"]
+      @copy_reference ||= @data['copy_reference']
     end
 
     # The expiration date of the copy reference.
     # This value is currently set to be far enough in the future
     # so that expiration is effectively not an issue.
     def expires
-      @expires ||= Time.parse(@data["expires"])
+      @expires ||= Time.parse(@data['expires'])
     end
   end
 end

data/lib/dropbox_api/results/get_temporary_link_result.rb

@@ -1,11 +1,12 @@
+# frozen_string_literal: true
 module DropboxApi::Results
   class GetTemporaryLinkResult < DropboxApi::Results::Base
     def file
-      @file ||= DropboxApi::Metadata::File.new(@data["metadata"])
+      @file ||= DropboxApi::Metadata::File.new(@data['metadata'])
     end
 
     def link
-      @data["link"]
+      @data['link']
     end
   end
 end

data/lib/dropbox_api/results/get_thumbnail_batch_result.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 module DropboxApi::Results
   class GetThumbnailBatchResult < DropboxApi::Results::Base
     def entries
-      @entries ||= @data["entries"].map do |entry|
+      @entries ||= @data['entries'].map do |entry|
         DropboxApi::Metadata::ThumbnailBatchResultEntry.new entry
       end
     end

data/lib/dropbox_api/results/list_folder_get_latest_cursor_result.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 module DropboxApi::Results
   class ListFolderGetLatestCursorResult < DropboxApi::Results::Base
     def cursor
-      @data["cursor"]
+      @data['cursor']
     end
   end
 end

data/lib/dropbox_api/results/list_folder_longpoll_result.rb

@@ -1,15 +1,16 @@
+# frozen_string_literal: true
 module DropboxApi::Results
   class ListFolderLongpollResult < DropboxApi::Results::Base
     # Indicates whether new changes are available. If true, call
     # `list_folder_continue` to retrieve the changes.
     def changes
-      @data["changes"].to_s == "true"
+      @data['changes'].to_s == 'true'
     end
 
     # If present, backoff for at least this many seconds before calling
     # `list_folder_longpoll` again. This field is optional.
     def backoff
-      @data["backoff"]
+      @data['backoff']
     end
   end
 end

data/lib/dropbox_api/results/list_folder_result.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
 module DropboxApi::Results
   class ListFolderResult < DropboxApi::Results::Base
     # A collection of files and directories.
     def entries
-      @entries ||= @data["entries"].map do |entry|
+      @entries ||= @data['entries'].map do |entry|
         DropboxApi::Metadata::Resource.new entry
       end
     end
@@ -10,13 +11,13 @@ module DropboxApi::Results
     # Pass the cursor into `list_folder_continue` to see what's changed in the
     # folder since your previous query.
     def cursor
-      @data["cursor"]
+      @data['cursor']
     end
 
     # If true, then there are more entries available. Pass the cursor to
     # `list_folder_continue` to retrieve the rest.
     def has_more?
-      @data["has_more"].to_s == "true"
+      @data['has_more'].to_s == 'true'
     end
   end
 end

data/lib/dropbox_api/results/list_revisions_result.rb

@@ -1,14 +1,15 @@
+# frozen_string_literal: true
 module DropboxApi::Results
   class ListRevisionsResult < DropboxApi::Results::Base
     # A collection of files and directories.
     def entries
-      @entries ||= @data["entries"].map do |entry|
+      @entries ||= @data['entries'].map do |entry|
         DropboxApi::Metadata::File.new entry
       end
     end
 
     def is_deleted?
-      @data["is_deleted"] == true
+      @data['is_deleted'] == true
     end
   end
 end

data/lib/dropbox_api/results/list_shared_links_result.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
 module DropboxApi::Results
   class ListSharedLinksResult < DropboxApi::Results::Base
     #  Shared links applicable to the path argument.
     def links
-      @entries ||= @data["links"].map do |entry|
+      @entries ||= @data['links'].map do |entry|
         DropboxApi::Metadata::SharedLinkMetadata.new entry
       end
     end
@@ -10,13 +11,13 @@ module DropboxApi::Results
     # Pass the cursor into `list_folder_continue` to see what's changed in the
     # folder since your previous query.
     def cursor
-      @data["cursor"]
+      @data['cursor']
     end
 
     # If true, then there are more entries available. Pass the cursor to
     # `list_folder_continue` to retrieve the rest.
     def has_more?
-      @data["has_more"].to_s == "true"
+      @data['has_more'].to_s == 'true'
     end
   end
 end

data/lib/dropbox_api/results/relocation_batch_result.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+module DropboxApi::Results
+  # Result returned by {Client#copy_batch} or {Client#move_batch} that may
+  # either launch an asynchronous job or complete synchronously.
+  #
+  # The value will be either `:in_progress` or a list of job statuses.
+  class RelocationBatchResult < DropboxApi::Results::Base
+    def self.new(result_data)
+      case result_data['.tag']
+      when 'in_progress'
+        :in_progress
+      when 'complete'
+        result_data['entries'].map do |entry|
+          DropboxApi::Results::RelocationBatchResultEntry.new(entry)
+        end
+      else
+        raise NotImplementedError, "Unknown result type: #{result_data['.tag']}"
+      end
+    end
+  end
+end

data/lib/dropbox_api/results/relocation_batch_result_entry.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+module DropboxApi::Results
+  class RelocationBatchResultEntry < DropboxApi::Results::Base
+    def self.new(result_data)
+      case result_data['.tag']
+      when 'success'
+        DropboxApi::Metadata::Resource.new result_data['success']
+      when 'failure'
+        DropboxApi::Errors::RelocationBatchEntryError
+          .build('File or folder operation failed', result_data['failure'])
+      else
+        raise NotImplementedError, "Unknown result type: #{result_data['.tag']}"
+      end
+    end
+  end
+end

data/lib/dropbox_api/results/save_copy_reference_result.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
 module DropboxApi::Results
   class SaveCopyReferenceResult < DropboxApi::Results::Base
     # The saved file or folder in the user's Dropbox.
     def resource
-      @resource ||= DropboxApi::Metadata::Resource.new @data["metadata"]
+      @resource ||= DropboxApi::Metadata::Resource.new @data['metadata']
     end
   end
 end