dropbox_api 0.1.12 → 0.1.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e7c47a22dce4e23deadb2344e7398865ff747c4
-  data.tar.gz: 29cb9bbbece2ff2fa58fe029b380660e13e79023
+  metadata.gz: 780f513dd7b43f5cc1756a6b85273eff0aed6fa4
+  data.tar.gz: 785c3510ce4fe958bc2d37be4558d0f04d49a313
 SHA512:
-  metadata.gz: 5f532b00a80f97e888b6b4913a0b57a25eb53b183a4a97a8e64255463924b57e79487b655784f7a332cad27bdb93694515f6166939929b197329eef3062b542c
-  data.tar.gz: 96be7b099622bff41b42186885dd9f4e0f89437042331e9f1500bd0a7e49afa827f691612df0280ca11113e722743995c86cfea792869a7dd236c22237c36a92
+  metadata.gz: 4bda74f73cd828bb31b3af641bd015848bafda4d6af67345f992c1a341e4b3b344da028e688db77769b1718aa2bc055187f89c5f632eb27b77511e274e6f9f27
+  data.tar.gz: 055adc5d1f0fb2d5b7d0c5aa597a48a9fde4429d776fda6d23707216c858b22be50939c5be0885cddc2c74b654defaac08c2ca7611f006f550796d909b23579f

data/.travis.yml

@@ -1,7 +1,7 @@
 language: ruby
 rvm:
-  # - 1.8.7
-  # - 1.9.3
+  - 1.9.3
   - 2.2.6
   - 2.3.3
-  - 2.4.0
+  - 2.4.4
+  - 2.5.1

data/Gemfile

@@ -2,6 +2,8 @@ source 'https://rubygems.org'
 
 gemspec
 
-# Documentation
-gem 'yard-rspec', :git => "https://github.com/Jesus/yard-spec-plugin.git"
-gem 'redcarpet'
+group :development do
+  # Documentation
+  gem 'yard-rspec', :git => "https://github.com/Jesus/yard-spec-plugin.git"
+  gem 'redcarpet'
+end

data/README.md

@@ -139,7 +139,14 @@ Check out the
 [method documentation](http://www.xuuso.com/dropbox_api/DropboxApi/Client.html#upload_by_chunks-instance_method)
 to find out all available options.
 
+## Dependencies
 
+This gem depends on
+[oauth2](https://github.com/oauth-xx/oauth2)
+and
+[faraday](https://github.com/lostisland/faraday).
+
+It has official support for Ruby versions `1.9.x` and `2.x`.
 
 ## Development
 

data/TODO.md

@@ -1,7 +1,9 @@
 # Short term goals
 
 - Update faraday version.
-- Fix `@option` params in doc.
+- Review coverage document.
+- Pick some endpoints to cover.
+- Release!
 - Complete full [API coverage](api_coverage.md).
 
 # Worth looking at

data/api_coverage.md

@@ -1,7 +1,5 @@
 # @title API Implementation Coverage
 
-**IMPORTANT: This document is work in progress. Information isn't accurate.**
-
 The Dropbox API changes frequently, so you may find out that the feature that
 you need is missing. This document indicates what endpoints have been
 implemented.
@@ -10,63 +8,112 @@ Full moon means fully implemented. Half moon means that the basic functionality
 of the endpoint has been implemented but some options may be missing. Guess
 what new moon means.
 
-## Files namespace
+## File properties
+
+API call | Status
+--- | :---:
+`/properties/add` | 🌑
+`/properties/overwrite` | 🌑
+`/properties/remove` | 🌑
+`/properties/search` | 🌑
+`/properties/search/continue` | 🌑
+`/properties/update` | 🌑
+`/templates/add_for_user` | 🌑
+`/templates/get_for_user` | 🌑
+`/templates/list_for_user` | 🌑
+`/templates/remove_for_user` | 🌑
+`/templates/update_for_user` | 🌑
+
+## File requests
+
+API call | Status
+--- | :---:
+`/create` | 🌕
+`/get` | 🌑
+`/list` | 🌑
+`/update` | 🌑
+
+## Files
 
 API call | Status
 --- | :---:
 `/copy` | 🌕
+`/copy_batch` | 🌑
+`/copy_batch/check` | 🌑
 `/copy_reference/get` | 🌕
 `/copy_reference/save` | 🌕
 `/create_folder` | 🌕
+`/create_folder_batch` | 🌑
+`/create_folder_batch/check` | 🌑
 `/delete` | 🌕
+`/delete_batch` | 🌑
+`/delete_batch/check` | 🌑
 `/download` | 🌔
+`/download_zip` | 🌑
 `/get_metadata` | 🌕
 `/get_preview` | 🌕
 `/get_temporary_link` | 🌕
+`/get_temporary_upload_link` | 🌑
 `/get_thumbnail` | 🌕
+`/get_thumbnail_batch` | 🌑
 `/list_folder` | 🌕
 `/list_folder/continue` | 🌕
 `/list_folder/get_latest_cursor` | 🌕
 `/list_folder/longpoll` | 🌕
 `/list_revisions` | 🌕
 `/move` | 🌕
-`/permanently_delete` | 🌑
-`/properties/add` | 🌑
-`/properties/overwrite` | 🌑
-`/properties/remove` | 🌑
-`/properties/template/get` | 🌑
-`/properties/template/list` | 🌑
-`/properties/update` | 🌑
+`/move_batch` | 🌑
+`/move_batch/check` | 🌑
+`/permanently_delete` | 🌕
 `/restore` | 🌕
 `/save_url` | 🌕
 `/save_url/check_job_status` | 🌕
 `/search` | 🌔
 `/upload` | 🌕
-`/upload_session/append` | 🌑
+`/upload_session/append` | alias?
 `/upload_session/append_v2` | 🌕
 `/upload_session/finish` | 🌕
 `/upload_session/finish_batch` | 🌑
 `/upload_session/finish_batch/check` | 🌑
 `/upload_session/start` | 🌕
 
-## Sharing namespace
+## Paper
+
+API call | Status
+--- | :---:
+`/docs/archive` | 🌑
+`/docs/create` | 🌑
+`/docs/download` | 🌑
+`/docs/folder_users/list` | 🌑
+`/docs/folder_users/list/continue` | 🌑
+`/docs/get_folder_info` | 🌑
+`/docs/list` | 🌑
+`/docs/list/continue` | 🌑
+`/docs/permanently_delete` | 🌑
+`/docs/sharing_policy/get` | 🌑
+`/docs/sharing_policy/set` | 🌑
+`/docs/update` | 🌑
+`/docs/users/add` | 🌑
+`/docs/users/list` | 🌑
+`/docs/users/list/continue` | 🌑
+`/docs/users/remove` | 🌑
+
+## Sharing
+
 API call | Status
 --- | :---:
 `/add_file_member` | 🌕
 `/add_folder_member` | 🌕
-`/change_file_member_access` | 🌑
 `/check_job_status` | 🌑
 `/check_remove_member_job_status` | 🌑
 `/check_share_job_status` | 🌑
-`/create_shared_link` | 🌑
 `/create_shared_link_with_settings` | 🌓
 `/get_file_metadata` | 🌑
 `/get_file_metadata/batch` | 🌑
 `/get_folder_metadata` | 🌑
 `/get_shared_link_file` | 🌑
 `/get_shared_link_metadata` | 🌑
-`/get_shared_links` | 🌑
-`/list_file_members` | 🌑
+`/list_file_members` | 🌕
 `/list_file_members/batch` | 🌑
 `/list_file_members/continue` | 🌑
 `/list_folder_members` | 🌕
@@ -82,19 +129,20 @@ API call | Status
 `/mount_folder` | 🌑
 `/relinquish_file_membership` | 🌑
 `/relinquish_folder_membership` | 🌑
-`/remove_file_member` | 🌑
 `/remove_file_member_2` | 🌑
 `/remove_folder_member` | 🌑
 `/revoke_shared_link` | 🌑
+`/set_access_inheritance` | 🌑
 `/share_folder` | 🌕
 `/transfer_folder` | 🌑
 `/unmount_folder` | 🌑
 `/unshare_file` | 🌕
 `/unshare_folder` | 🌑
+`/update_file_member` | 🌑
 `/update_folder_member` | 🌑
 `/update_folder_policy` | 🌑
 
-## Users namespace
+## Users
 
 API call | Status
 --- | :---:
@@ -103,17 +151,8 @@ API call | Status
 `/get_current_account` | 🌕
 `/get_space_usage` | 🌕
 
-## File Requests namespace
-
-API call | Status
---- | :---:
-`/create` | 🌕
-`/get` | 🌑
-`/list` | 🌑
-`/update` | 🌑
-
-
 ## Dropbox Business API
+
 Unfortunately, none of the Dropbox Business endpoints have been implemented.
 If this is a problem for you, please [open an
 issue](https://github.com/Jesus/dropbox_api/issues/new).

data/dropbox_api.gemspec

@@ -25,6 +25,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "vcr"
   spec.add_development_dependency "webmock"
 
-  spec.add_dependency "oauth2", "~> 1.1"
-  spec.add_dependency "faraday", "~> 0.8", "~> 0.9"
+  spec.add_dependency "oauth2", ">= 1.1", "<= 1.4"
+  spec.add_dependency "faraday", ">= 0.8", "<= 0.15.2"
 end

data/lib/dropbox_api.rb

@@ -119,6 +119,7 @@ require 'dropbox_api/results/save_url_job_status'
 require 'dropbox_api/results/search/match'
 require 'dropbox_api/results/search_result'
 require 'dropbox_api/results/share_folder_launch'
+require 'dropbox_api/results/shared_file_members'
 require 'dropbox_api/results/shared_folder_members'
 require 'dropbox_api/results/void_result'
 require 'dropbox_api/results/upload_session_start'
@@ -164,6 +165,7 @@ require 'dropbox_api/endpoints/files/upload_session_append_v2'
 require 'dropbox_api/endpoints/files/upload_session_finish'
 
 require 'dropbox_api/endpoints/sharing/add_file_member'
+require 'dropbox_api/endpoints/sharing/list_file_members'
 require 'dropbox_api/endpoints/sharing/add_folder_member'
 require 'dropbox_api/endpoints/sharing/list_folder_members'
 require 'dropbox_api/endpoints/sharing/share_folder'

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

@@ -17,13 +17,21 @@ module DropboxApi::Endpoints::Files
     # @param path [String] The path of a file or folder on Dropbox.
     # @option options include_media_info [Boolean] If `true`, `media_info`
     #   is set for photo and video. The default for this field is `false`.
+    # @option options include_has_explicit_shared_members [Boolean] If `true`,
+    #   the results will include a flag for each file indicating whether or
+    #   not that file has any explicit members. The default for this field
+    #   is `false`.
     # @option options include_deleted [Boolean] If `true`,
     #   {DropboxApi::Metadata::Deleted} will be
     #   returned for deleted file or folder, otherwise
     #   {DropboxApi::Errors::NotFoundError}
     #   will be raised. The default for this field is `false`.
     add_endpoint :get_metadata do |path, options = {}|
-      validate_options([:include_media_info, :include_deleted], options)
+      validate_options([
+        :include_media_info,
+        :include_deleted,
+        :include_has_explicit_shared_members
+      ], options)
 
       perform_request(options.merge({
         :path => path

data/lib/dropbox_api/endpoints/rpc.rb

@@ -7,12 +7,20 @@ module DropboxApi::Endpoints
     end
 
     def build_request(params)
-      body = JSON.dump(params)
-      headers = {
+      request_headers = {
         'content-type' => 'application/json'
       }
 
-      return body, headers
+      return request_body(params), request_headers
+    end
+
+    def request_body(params)
+      # This check is only required for compatibility with old JSON serializers
+      if params.nil?
+        'null'
+      else
+        JSON.dump(params)
+      end
     end
   end
 end

data/lib/dropbox_api/endpoints/sharing/list_file_members.rb

@@ -0,0 +1,46 @@
+module DropboxApi::Endpoints::Sharing
+  class ListFileMembers < DropboxApi::Endpoints::Rpc
+    Method      = :post
+    Path        = "/2/sharing/list_file_members".freeze
+    ResultType  = DropboxApi::Results::SharedFileMembers
+    ErrorType   = DropboxApi::Errors::SharingFileAccessError
+
+    include DropboxApi::OptionsValidator
+
+    # Use to obtain the members who have been invited to a file, both
+    # inherited and uninherited members.
+    #
+    # Apps must have full Dropbox access to use this endpoint.
+    #
+    # @example List file members.
+    #   client.list_file_members "1231273663"
+    #
+    # @example List file members, with detail of permission to make owner.
+    #   client.list_file_members "1231273663", [:make_owner]
+    #
+    # @example List file members, using the path instead of file ID.
+    #   client.list_file_members "/my/file.pdf"
+    #
+    # @param file_id [String] The ID for the shared file.
+    # @param actions [Array]
+    #   This is an optional list of actions. The permissions for the actions
+    #   requested will be included in the result.
+    # @option options include_inherited [Boolean] Whether to include members
+    #   who only have access from a parent shared folder. The default for this
+    #   field is `true`.
+    # @option options limit [Numeric] The maximum number of results that
+    #   include members, groups and invitees to return per request. The default
+    #   for this field is 100.
+    # @return [SharedFileMembers] Shared file user and group membership.
+    # @see Metadata::MemberActionList
+    add_endpoint :list_file_members do |file_id, actions = [], options = {}|
+      validate_options([:limit, :include_inherited], options)
+      options[:limit] ||= 100
+
+      perform_request options.merge({
+        :file => file_id,
+        :actions => DropboxApi::Metadata::MemberActionList.new(actions)
+      })
+    end
+  end
+end

data/lib/dropbox_api/metadata/file.rb

@@ -30,6 +30,7 @@ module DropboxApi::Metadata
     field :size, Integer
     field :content_hash, String, :optional
     field :media_info, DropboxApi::Metadata::MediaInfo, :optional
+    field :has_explicit_shared_members, :boolean, :optional
 
     def to_hash
       super.merge(".tag" => "file")

data/lib/dropbox_api/results/shared_file_members.rb

@@ -0,0 +1,19 @@
+module DropboxApi::Results
+  class SharedFileMembers < DropboxApi::Results::Base
+    def users
+      @data["users"]
+    end
+
+    def groups
+      @data["groups"]
+    end
+
+    def invitees
+      @data["invitees"]
+    end
+
+    def cursor
+      @data["cursor"]
+    end
+  end
+end

data/lib/dropbox_api/version.rb

@@ -1,3 +1,3 @@
 module DropboxApi
-  VERSION = '0.1.12'.freeze
+  VERSION = '0.1.13'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dropbox_api
 version: !ruby/object:Gem::Version
-  version: 0.1.12
+  version: 0.1.13
 platform: ruby
 authors:
 - Jesús Burgos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-14 00:00:00.000000000 Z
+date: 2018-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -84,36 +84,42 @@ dependencies:
   name: oauth2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.1'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.1'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.8'
-    - - "~>"
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.15.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.8'
-    - - "~>"
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.15.2
 description: 
 email:
 - jburmac@gmail.com
@@ -178,6 +184,7 @@ files:
 - lib/dropbox_api/endpoints/sharing/add_file_member.rb
 - lib/dropbox_api/endpoints/sharing/add_folder_member.rb
 - lib/dropbox_api/endpoints/sharing/create_shared_link_with_settings.rb
+- lib/dropbox_api/endpoints/sharing/list_file_members.rb
 - lib/dropbox_api/endpoints/sharing/list_folder_members.rb
 - lib/dropbox_api/endpoints/sharing/list_shared_links.rb
 - lib/dropbox_api/endpoints/sharing/share_folder.rb
@@ -296,6 +303,7 @@ files:
 - lib/dropbox_api/results/search/match.rb
 - lib/dropbox_api/results/search_result.rb
 - lib/dropbox_api/results/share_folder_launch.rb
+- lib/dropbox_api/results/shared_file_members.rb
 - lib/dropbox_api/results/shared_folder_members.rb
 - lib/dropbox_api/results/upload_session_start.rb
 - lib/dropbox_api/results/void_result.rb