dropbox_api 0.1.19 → 0.1.20

data/docs/top-level-namespace.html

@@ -6,15 +6,15 @@
 <title>
   Top Level Namespace
   
-    &mdash; Documentation by YARD 0.9.19
+    &mdash; Documentation by YARD 0.9.26
   
 </title>
 
-  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="css/style.css" type="text/css" />
 
-  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" />
 
-<script type="text/javascript" charset="utf-8">
+<script type="text/javascript">
   pathId = "";
   relpath = '';
 </script>
@@ -102,9 +102,9 @@
 </div>
 
       <div id="footer">
-  Generated on Fri May 31 17:53:31 2019 by
+  Generated on Sun Feb  7 11:51:54 2021 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.19 (ruby-2.6.2).
+  0.9.26 (ruby-2.5.1).
 </div>
 
     </div>

data/lib/dropbox_api/authenticator.rb

@@ -3,15 +3,11 @@ require 'oauth2'
 
 module DropboxApi
   class Authenticator < OAuth2::Client
-    extend Forwardable
-
     def initialize(client_id, client_secret)
-      @auth_code = OAuth2::Client.new(client_id, client_secret, {
+      super(client_id, client_secret, {
         authorize_url: 'https://www.dropbox.com/oauth2/authorize',
         token_url: 'https://api.dropboxapi.com/oauth2/token'
-      }).auth_code
+      })
     end
-
-    def_delegators :@auth_code, :authorize_url, :get_token
   end
 end

data/lib/dropbox_api/client.rb

@@ -1,14 +1,35 @@
 # frozen_string_literal: true
 module DropboxApi
   class Client
-    def initialize(oauth_bearer = ENV['DROPBOX_OAUTH_BEARER'])
-      @connection_builder = ConnectionBuilder.new(oauth_bearer)
+    def initialize(
+      oauth_bearer = ENV['DROPBOX_OAUTH_BEARER'],
+      access_token: nil,
+      on_token_refreshed: nil
+    )
+      if access_token
+        @connection_builder = ConnectionBuilder.new(
+          access_token: access_token,
+          on_token_refreshed: on_token_refreshed
+        )
+      elsif oauth_bearer
+        @connection_builder = ConnectionBuilder.new(oauth_bearer)
+      else
+        raise ArgumentError, "Either oauth_bearer or access_token should be set"
+      end
     end
 
     def middleware
       @connection_builder.middleware
     end
 
+    def namespace_id=(value)
+      @connection_builder.namespace_id = value
+    end
+
+    def namespace_id
+      @connection_builder.namespace_id
+    end
+
     # @!visibility private
     def self.add_endpoint(name, endpoint)
       define_method(name) do |*args, &block|

data/lib/dropbox_api/connection_builder.rb

@@ -1,19 +1,53 @@
 # frozen_string_literal: true
 module DropboxApi
   class ConnectionBuilder
-    def initialize(oauth_bearer)
-      @oauth_bearer = oauth_bearer
+    attr_accessor :namespace_id
+
+    def initialize(oauth_bearer = nil, access_token: nil, on_token_refreshed: nil)
+      if access_token
+        if !access_token.is_a?(OAuth2::AccessToken)
+          raise ArgumentError, "access_token should be an OAuth2::AccessToken"
+        end
+
+        @access_token = access_token
+        @on_token_refreshed = on_token_refreshed
+      elsif oauth_bearer
+        @oauth_bearer = oauth_bearer
+      else
+        raise ArgumentError, "Either oauth_bearer or access_token should be set"
+      end
     end
 
     def middleware
       @middleware ||= MiddleWare::Stack.new
     end
 
+    def can_refresh_access_token?
+      @access_token && @access_token.refresh_token
+    end
+
+    def refresh_access_token
+      @access_token = @access_token.refresh!
+      @on_token_refreshed.call(@access_token.to_hash) if @on_token_refreshed
+    end
+
+    private def bearer
+      @oauth_bearer or oauth_bearer_from_access_token
+    end
+
+    private def oauth_bearer_from_access_token
+      refresh_access_token if @access_token.expired?
+
+      @access_token.token
+    end
+
     def build(url)
       Faraday.new(url) do |connection|
+        connection.use DropboxApi::MiddleWare::PathRoot, {
+          namespace_id: self.namespace_id
+        }
         middleware.apply(connection) do
-          connection.authorization :Bearer, @oauth_bearer
-
+          connection.authorization :Bearer, bearer
           yield connection
         end
       end

data/lib/dropbox_api/endpoints/base.rb

@@ -1,6 +1,11 @@
 # frozen_string_literal: true
 module DropboxApi::Endpoints
   class Base
+    def initialize(builder)
+      @builder = builder
+      build_connection
+    end
+
     def self.add_endpoint(name, &block)
       define_method(name, block)
       DropboxApi::Client.add_endpoint(name, self)
@@ -10,6 +15,14 @@ module DropboxApi::Endpoints
 
     def perform_request(params)
       process_response(get_response(params))
+    rescue DropboxApi::Errors::ExpiredAccessTokenError => e
+      if @builder.can_refresh_access_token?
+        @builder.refresh_access_token
+        build_connection
+        process_response(get_response(params))
+      else
+        raise e
+      end
     end
 
     def get_response(*args)
@@ -24,6 +37,11 @@ module DropboxApi::Endpoints
         # Status code 409 is "Endpoint-specific error". We need to look at
         # the response body to build an exception.
         build_result(raw_response.env[:api_result])
+      when 401
+        raise DropboxApi::Errors::ExpiredAccessTokenError.build(
+          raw_response.env[:api_result]['error_summary'],
+          raw_response.env[:api_result]['error']
+        )
       when 429
         error = DropboxApi::Errors::TooManyRequestsError.build(
           raw_response.env[:api_result]['error_summary'],
@@ -52,7 +70,12 @@ module DropboxApi::Endpoints
     end
 
     def run_request(body, headers)
-      @connection.run_request(self.class::Method, self.class::Path, body, headers)
+      @connection.run_request(
+        self.class::Method,
+        self.class::Path,
+        body,
+        headers
+      )
     end
   end
 end

data/lib/dropbox_api/endpoints/content_download.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 module DropboxApi::Endpoints
   class ContentDownload < DropboxApi::Endpoints::Base
-    def initialize(builder)
-      @connection = builder.build('https://content.dropboxapi.com') do |c|
+    def build_connection
+      @connection = @builder.build('https://content.dropboxapi.com') do |c|
         c.response :decode_result
       end
     end

data/lib/dropbox_api/endpoints/content_upload.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 module DropboxApi::Endpoints
   class ContentUpload < DropboxApi::Endpoints::Base
-    def initialize(builder)
-      @connection = builder.build('https://content.dropboxapi.com') do |c|
+    def build_connection
+      @connection = @builder.build('https://content.dropboxapi.com') do |c|
         c.response :decode_result
       end
     end

data/lib/dropbox_api/endpoints/files/search_continue.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+module DropboxApi::Endpoints::Files
+  class SearchContinue < DropboxApi::Endpoints::Rpc
+    Method      = :post
+    Path        = '/2/files/search/continue_v2'
+    ResultType  = DropboxApi::Results::SearchV2Result
+    ErrorType   = DropboxApi::Errors::SearchError
+
+    include DropboxApi::OptionsValidator
+
+    # Fetches the next page of search results returned from search:2.
+    # Note: search:2 along with search/continue:2 can only be used to retrieve a maximum of 10,000 matches.
+    # Recent changes may not immediately be reflected in search results due to a short delay in indexing. 
+    # Duplicate results may be returned across pages. Some results may not be returned.
+
+
+    # @param cursor [String] The cursor returned by your last call to 
+    # search:2. Used to fetch the next page of results.
+    add_endpoint :search_continue do |cursor|
+      perform_request cursor: cursor
+    end
+  end
+end

data/lib/dropbox_api/endpoints/rpc.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 module DropboxApi::Endpoints
   class Rpc < DropboxApi::Endpoints::Base
-    def initialize(builder)
-      @connection = builder.build('https://api.dropboxapi.com') do |c|
+    def build_connection
+      @connection = @builder.build('https://api.dropboxapi.com') do |c|
         c.response :decode_result
       end
     end

data/lib/dropbox_api/endpoints/rpc_content.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 module DropboxApi::Endpoints
   class RpcContent < DropboxApi::Endpoints::Rpc
-    def initialize(builder)
-      @connection = builder.build('https://content.dropboxapi.com') do |c|
+    def build_connection
+      @connection = @builder.build('https://content.dropboxapi.com') do |c|
         c.response :decode_result
       end
     end

data/lib/dropbox_api/endpoints/rpc_notify.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 module DropboxApi::Endpoints
   class RpcNotify < DropboxApi::Endpoints::Rpc
-    def initialize(builder)
-      @connection = builder.build('https://notify.dropboxapi.com') do |c|
+    def build_connection
+      @connection = @builder.build('https://notify.dropboxapi.com') do |c|
         c.headers.delete 'Authorization'
 
         c.response :decode_result

data/lib/dropbox_api/errors/expired_access_token_error.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+module DropboxApi::Errors
+  class ExpiredAccessTokenError < BasicError
+  end
+end

data/lib/dropbox_api/metadata/basic_account.rb

@@ -16,7 +16,12 @@ module DropboxApi::Metadata
   #   "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"
+  #   "team_member_id": "dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU",
+  #   "root_info": {
+  #     root_namespace_id: 7,
+  #     home_namespace_id: 1,
+  #     home_path: "/Franz Ferdinand"
+  #   }
   # }
   # ```
   class BasicAccount < Base
@@ -28,5 +33,6 @@ module DropboxApi::Metadata
     field :is_teammate, :boolean, :optional
     field :profile_photo_url, String, :optional
     field :team_member_id, :boolean, :optional
+    field :root_info, DropboxApi::Metadata::RootInfo, :optional
   end
 end

data/lib/dropbox_api/metadata/namespace_id.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+module DropboxApi::Metadata
+  class NamespaceId < Base
+    field :namespace_id, String
+
+    def to_hash
+      super.merge({".tag": 'namespace_id'})
+    end
+  end
+end

data/lib/dropbox_api/metadata/root_info.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+module DropboxApi::Metadata
+  # Example of a serialized {RootInfo} object:
+  #
+  # ```json
+  # {
+  #   ".tag":"user",
+  #   "root_namespace_id":"42",
+  #   "home_namespace_id":"42"
+  # }
+  # ```
+  class RootInfo < Base
+    class << self
+      def new(data)
+        class_for(data['.tag'].to_sym).new(data)
+      end
+
+      private
+
+      def class_for(tag)
+        case tag
+        when :user
+          DropboxApi::Metadata::UserRootInfo
+        when :team
+          DropboxApi::Metadata::TeamRootInfo
+        else
+          raise ArgumentError, "Unable to infer type for `#{tag}`"
+        end
+      end
+    end
+  end
+end

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/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/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/results/search_v2_result.rb

@@ -11,11 +11,10 @@ module DropboxApi::Results
     # Used for paging. If true, indicates there is another page of results
     # available that can be fetched by calling search again.
     def has_more?
-      @data['more'].to_s == 'true'
+      @data['has_more'].to_s == 'true'
     end
 
-    # Pass the cursor into #search_continue to fetch the next page of results
-    # (not yet implemented).
+    # Pass the cursor into #search_continue to fetch the next page of results.
     # This field is optional.
     def cursor
       @data['cursor']

data/lib/dropbox_api/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module DropboxApi
-  VERSION = '0.1.19'
+  VERSION = '0.1.20'
 end

data/lib/dropbox_api.rb

@@ -7,12 +7,14 @@ require 'faraday'
 
 require 'dropbox_api/authenticator'
 
+require 'dropbox_api/metadata/base'
+require 'dropbox_api/metadata/field'
+require 'dropbox_api/metadata/namespace_id'
+
 require 'dropbox_api/middleware/decode_result'
+require 'dropbox_api/middleware/path_root'
 require 'dropbox_api/middleware/stack'
 
-require 'dropbox_api/metadata/field'
-require 'dropbox_api/metadata/base'
-
 require 'dropbox_api/metadata/tag'
 require 'dropbox_api/metadata/access_level'
 require 'dropbox_api/metadata/member_action'
@@ -32,6 +34,9 @@ require 'dropbox_api/metadata/member_permission'
 require 'dropbox_api/metadata/member_permission_list'
 require 'dropbox_api/metadata/add_file_member_result'
 require 'dropbox_api/metadata/parent_folder_access_info'
+require 'dropbox_api/metadata/team_root_info'
+require 'dropbox_api/metadata/user_root_info'
+require 'dropbox_api/metadata/root_info'
 require 'dropbox_api/metadata/basic_account'
 require 'dropbox_api/metadata/link_permissions'
 require 'dropbox_api/metadata/team'
@@ -86,6 +91,7 @@ require 'dropbox_api/errors/create_folder_batch_error'
 require 'dropbox_api/errors/create_folder_error'
 require 'dropbox_api/errors/create_shared_link_with_settings_error'
 require 'dropbox_api/errors/download_error'
+require 'dropbox_api/errors/expired_access_token_error'
 require 'dropbox_api/errors/sharing_file_access_error'
 require 'dropbox_api/errors/sharing_user_error'
 require 'dropbox_api/errors/file_member_action_error'
@@ -183,6 +189,7 @@ require 'dropbox_api/endpoints/files/restore'
 require 'dropbox_api/endpoints/files/save_url'
 require 'dropbox_api/endpoints/files/save_url_check_job_status'
 require 'dropbox_api/endpoints/files/search'
+require 'dropbox_api/endpoints/files/search_continue'
 require 'dropbox_api/endpoints/files/upload'
 require 'dropbox_api/endpoints/files/upload_session_start'
 require 'dropbox_api/endpoints/files/upload_session_append_v2'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dropbox_api
 version: !ruby/object:Gem::Version
-  version: 0.1.19
+  version: 0.1.20
 platform: ruby
 authors:
 - Jesús Burgos
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-07 00:00:00.000000000 Z
+date: 2021-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -324,9 +324,13 @@ files:
 - docs/DropboxApi/Metadata/Dimensions.html
 - docs/DropboxApi/Metadata/Field.html
 - docs/DropboxApi/Metadata/File.html
+- docs/DropboxApi/Metadata/FileCategoriesList.html
+- docs/DropboxApi/Metadata/FileCategory.html
+- docs/DropboxApi/Metadata/FileExtensionsList.html
 - docs/DropboxApi/Metadata/FileLinkMetadata.html
 - docs/DropboxApi/Metadata/FileMemberAction.html
 - docs/DropboxApi/Metadata/FileRequest.html
+- docs/DropboxApi/Metadata/FileStatus.html
 - docs/DropboxApi/Metadata/Folder.html
 - docs/DropboxApi/Metadata/FolderLinkMetadata.html
 - docs/DropboxApi/Metadata/FolderSharingInfo.html
@@ -339,10 +343,16 @@ files:
 - docs/DropboxApi/Metadata/MemberActionList.html
 - docs/DropboxApi/Metadata/MemberPermission.html
 - docs/DropboxApi/Metadata/MemberPermissionList.html
+- docs/DropboxApi/Metadata/MetadataV2.html
 - docs/DropboxApi/Metadata/Name.html
 - docs/DropboxApi/Metadata/ParentFolderAccessInfo.html
 - docs/DropboxApi/Metadata/PhotoMetadata.html
 - docs/DropboxApi/Metadata/Resource.html
+- docs/DropboxApi/Metadata/SearchMatchFieldOptions.html
+- docs/DropboxApi/Metadata/SearchMatchTypeV2.html
+- docs/DropboxApi/Metadata/SearchMatchV2.html
+- docs/DropboxApi/Metadata/SearchOptions.html
+- docs/DropboxApi/Metadata/SearchOrderBy.html
 - docs/DropboxApi/Metadata/SharedFolder.html
 - docs/DropboxApi/Metadata/SharedFolderPolicy.html
 - docs/DropboxApi/Metadata/SharedLink.html
@@ -387,6 +397,7 @@ files:
 - docs/DropboxApi/Results/Search.html
 - docs/DropboxApi/Results/Search/Match.html
 - docs/DropboxApi/Results/SearchResult.html
+- docs/DropboxApi/Results/SearchV2Result.html
 - docs/DropboxApi/Results/ShareFolderLaunch.html
 - docs/DropboxApi/Results/SharedFileMembers.html
 - docs/DropboxApi/Results/SharedFolderMembers.html
@@ -448,6 +459,7 @@ files:
 - lib/dropbox_api/endpoints/files/save_url.rb
 - lib/dropbox_api/endpoints/files/save_url_check_job_status.rb
 - lib/dropbox_api/endpoints/files/search.rb
+- lib/dropbox_api/endpoints/files/search_continue.rb
 - lib/dropbox_api/endpoints/files/upload.rb
 - lib/dropbox_api/endpoints/files/upload_session_append_v2.rb
 - lib/dropbox_api/endpoints/files/upload_session_finish.rb
@@ -481,6 +493,7 @@ files:
 - lib/dropbox_api/errors/create_shared_link_with_settings_error.rb
 - lib/dropbox_api/errors/delete_error.rb
 - lib/dropbox_api/errors/download_error.rb
+- lib/dropbox_api/errors/expired_access_token_error.rb
 - lib/dropbox_api/errors/file_member_action_error.rb
 - lib/dropbox_api/errors/get_account_error.rb
 - lib/dropbox_api/errors/get_copy_reference_error.rb
@@ -550,9 +563,11 @@ files:
 - lib/dropbox_api/metadata/member_permission_list.rb
 - lib/dropbox_api/metadata/metadata_v2.rb
 - lib/dropbox_api/metadata/name.rb
+- lib/dropbox_api/metadata/namespace_id.rb
 - lib/dropbox_api/metadata/parent_folder_access_info.rb
 - lib/dropbox_api/metadata/photo_metadata.rb
 - lib/dropbox_api/metadata/resource.rb
+- lib/dropbox_api/metadata/root_info.rb
 - lib/dropbox_api/metadata/search_match_field_options.rb
 - lib/dropbox_api/metadata/search_match_type_v2.rb
 - lib/dropbox_api/metadata/search_match_v2.rb
@@ -567,12 +582,15 @@ files:
 - lib/dropbox_api/metadata/tag.rb
 - lib/dropbox_api/metadata/team.rb
 - lib/dropbox_api/metadata/team_member_info.rb
+- lib/dropbox_api/metadata/team_root_info.rb
 - lib/dropbox_api/metadata/thumbnail_batch_result_data.rb
 - lib/dropbox_api/metadata/thumbnail_batch_result_entry.rb
 - lib/dropbox_api/metadata/upload_session_cursor.rb
+- lib/dropbox_api/metadata/user_root_info.rb
 - lib/dropbox_api/metadata/video_metadata.rb
 - lib/dropbox_api/metadata/write_mode.rb
 - lib/dropbox_api/middleware/decode_result.rb
+- lib/dropbox_api/middleware/path_root.rb
 - lib/dropbox_api/middleware/stack.rb
 - lib/dropbox_api/options_validator.rb
 - lib/dropbox_api/result_builder.rb
@@ -633,7 +651,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.9
+rubygems_version: 3.0.6
 signing_key:
 specification_version: 4
 summary: Library for communicating with Dropbox API v2