dropbox_api 0.1.16 → 0.1.17

data/Gemfile

@@ -4,6 +4,10 @@ gemspec
 
 group :development do
   # Documentation
-  gem 'yard-rspec', :git => "https://github.com/Jesus/yard-spec-plugin.git"
   gem 'redcarpet'
+  gem 'yard-rspec', :git => "https://github.com/Jesus/yard-spec-plugin.git"
+
+  # Code linting
+  gem 'rubocop', :require => false
+  gem 'rubocop-rspec', :require => false
 end

data/TODO.md

@@ -1,11 +1,20 @@
-# Short term goals
+# Immediate
 
-- Remove dependency on faraday.
+- Test all added classes since last release.
+  - Add scaffoldings for the new endpoints.
+  - Test all new paths to build errors & results.
+- Update coverage document.
+- Clear out Rubocop's TODO.
+- Release!
+- Update the guide to contribute, show how an endpoint is implemented and
+  documented.
+
+# Mid-term
+
+- Remove dependency on Faraday.
 - Complete full [API coverage](api_coverage.md).
 
-# Further on
+# Dreaming
 
-- Improve the  API reference page, help here:
-  http://gnuu.org/2009/11/18/customizing-yard-templates/
-- Supporting streams would be great.
-- Add a layer to handle pagination, use `Enumerable`.
+- Support streams.
+- Add a layer to handle pagination.

data/api_coverage.md

@@ -38,16 +38,16 @@ API call | Status
 API call | Status
 --- | :---:
 `/copy` | 🌕
-`/copy_batch` | 🌑
-`/copy_batch/check` | 🌑
+`/copy_batch` | 🌕
+`/copy_batch/check` | 🌕
 `/copy_reference/get` | 🌕
 `/copy_reference/save` | 🌕
 `/create_folder` | 🌕
-`/create_folder_batch` | 🌑
-`/create_folder_batch/check` | 🌑
+`/create_folder_batch` | 🌕
+`/create_folder_batch/check` | 🌕
 `/delete` | 🌕
-`/delete_batch` | 🌑
-`/delete_batch/check` | 🌑
+`/delete_batch` | 🌕
+`/delete_batch/check` | 🌕
 `/download` | 🌔
 `/download_zip` | 🌑
 `/get_metadata` | 🌕
@@ -131,7 +131,7 @@ API call | Status
 `/relinquish_folder_membership` | 🌑
 `/remove_file_member_2` | 🌑
 `/remove_folder_member` | 🌑
-`/revoke_shared_link` | 🌑
+`/revoke_shared_link` | 🌕
 `/set_access_inheritance` | 🌑
 `/share_folder` | 🌕
 `/transfer_folder` | 🌑

data/docs/DropboxApi.html

@@ -6,7 +6,7 @@
 <title>
   Module: DropboxApi
   
-    &mdash; Documentation by YARD 0.9.15
+    &mdash; Documentation by YARD 0.9.16
   
 </title>
 
@@ -109,7 +109,7 @@
         <dt id="VERSION-constant" class="">VERSION =
           
         </dt>
-        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>0.1.15</span><span class='tstring_end'>&#39;</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
+        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>0.1.16</span><span class='tstring_end'>&#39;</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
       
     </dl>
   
@@ -125,9 +125,9 @@
 </div>
 
       <div id="footer">
-  Generated on Fri Nov 16 09:02:01 2018 by
+  Generated on Sat Feb 16 18:39:17 2019 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.15 (ruby-2.3.3).
+  0.9.16 (ruby-2.3.3).
 </div>
 
     </div>

data/docs/DropboxApi/Authenticator.html

@@ -6,7 +6,7 @@
 <title>
   Class: DropboxApi::Authenticator
   
-    &mdash; Documentation by YARD 0.9.15
+    &mdash; Documentation by YARD 0.9.16
   
 </title>
 
@@ -207,9 +207,9 @@
 </div>
 
       <div id="footer">
-  Generated on Fri Nov 16 09:02:02 2018 by
+  Generated on Sat Feb 16 18:39:18 2019 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.15 (ruby-2.3.3).
+  0.9.16 (ruby-2.3.3).
 </div>
 
     </div>

data/docs/DropboxApi/ChunkedUploader.html

@@ -6,7 +6,7 @@
 <title>
   Class: DropboxApi::ChunkedUploader
   
-    &mdash; Documentation by YARD 0.9.15
+    &mdash; Documentation by YARD 0.9.16
   
 </title>
 
@@ -401,9 +401,9 @@
 </div>
 
       <div id="footer">
-  Generated on Fri Nov 16 09:02:02 2018 by
+  Generated on Sat Feb 16 18:39:18 2019 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.15 (ruby-2.3.3).
+  0.9.16 (ruby-2.3.3).
 </div>
 
     </div>

data/docs/DropboxApi/Client.html

@@ -6,7 +6,7 @@
 <title>
   Class: DropboxApi::Client
   
-    &mdash; Documentation by YARD 0.9.15
+    &mdash; Documentation by YARD 0.9.16
   
 </title>
 
@@ -306,6 +306,29 @@
     <span class="summary_desc"><div class='inline'><p>List shared links of this user.</p>
 </div></span>
   
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#revoke_shared_link-instance_method" title="#revoke_shared_link (instance method)">#<strong>revoke_shared_link</strong>(url)  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'><p>Revoke a shared link.</p>
+</div></span>
+  
 </li>
 
       
@@ -2488,6 +2511,9 @@ the default visibility is :public. (The resolved
 visibility, though, may depend on other aspects such as team and shared
 folder settings).</p>
 
+<p>NOTE: The <code>settings</code> parameter will only work for pro, business or
+enterprise accounts. It will return no permission error otherwise.</p>
+
 
   </div>
 </div>
@@ -2530,6 +2556,58 @@ created shared link This field is optional.</p>
   
 </ul>
 
+  
+    
+    
+    
+    
+    <p class="tag_title">Options Hash (<tt>settings</tt>):</p>
+    <ul class="option">
+      
+        <li>
+          <span class="name">requested_visibility</span>
+          <span class="type">(<tt>Object</tt>)</span>
+          <span class="default">
+            
+          </span>
+          
+            &mdash; <div class='inline'><p>The requested access for this
+shared link. This field is optional. Must be one of &quot;public&quot;,
+&quot;team_only&quot; or &quot;password&quot;.</p>
+</div>
+          
+        </li>
+      
+        <li>
+          <span class="name">link_password</span>
+          <span class="type">(<tt>Object</tt>)</span>
+          <span class="default">
+            
+          </span>
+          
+            &mdash; <div class='inline'><p>If requested_visibility is
+&quot;password&quot; this is needed to specify the password to access the link.
+This field is optional.</p>
+</div>
+          
+        </li>
+      
+        <li>
+          <span class="name">expires</span>
+          <span class="type">(<tt>Object</tt>)</span>
+          <span class="default">
+            
+          </span>
+          
+            &mdash; <div class='inline'><p>Expiration time of the shared link. By default
+the link won&#39;t expire. This field is optional.</p>
+</div>
+          
+        </li>
+      
+    </ul>
+  
+
 <p class="tag_title">Returns:</p>
 <ul class="return">
   
@@ -2551,19 +2629,39 @@ created shared link This field is optional.</p>
       <pre class="lines">
 
 
-17
-18
-19
-20
-21</pre>
+31
+32
+33
+34
+35
+36
+37
+38
+39
+40
+41
+42
+43
+44
+45</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/sharing/create_shared_link_with_settings.rb', line 17</span>
+      <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/sharing/create_shared_link_with_settings.rb', line 31</span>
 
 <span class='id identifier rubyid_add_endpoint'>add_endpoint</span> <span class='symbol'>:create_shared_link_with_settings</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='id identifier rubyid_settings'>settings</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='op'>|</span>
-  <span class='comment'># NOTE: This endpoint accepts an additional option `settings` which
-</span>  <span class='comment'>#       hasn&#39;t been implemented.
-</span>  <span class='id identifier rubyid_perform_request'>perform_request</span> <span class='symbol'>:path</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_path'>path</span>
+  <span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span>
+    <span class='symbol'>:requested_visibility</span><span class='comma'>,</span>
+    <span class='symbol'>:link_password</span><span class='comma'>,</span>
+    <span class='symbol'>:expires</span>
+  <span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_settings'>settings</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_settings'>settings</span><span class='lbracket'>[</span><span class='symbol'>:requested_visibility</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>public</span><span class='tstring_end'>&#39;</span></span>
+  <span class='id identifier rubyid_settings'>settings</span><span class='lbracket'>[</span><span class='symbol'>:link_password</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>nil</span>
+  <span class='id identifier rubyid_settings'>settings</span><span class='lbracket'>[</span><span class='symbol'>:expires</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>nil</span>
+
+  <span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+    <span class='symbol'>:path</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_path'>path</span><span class='comma'>,</span>
+    <span class='symbol'>:settings</span><span class='op'>=&gt;</span> <span class='id identifier rubyid_settings'>settings</span>
+  <span class='rbrace'>}</span><span class='rparen'>)</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -2672,7 +2770,7 @@ deleting a folder. If the given &quot;rev&quot; doesn&#39;t match, a
       </li>
     
       <li>
-        wont&#39; delete the file if `parent_rev` doesn&#39;t match
+        won&#39;t delete the file if `parent_rev` doesn&#39;t match
         <table class="source_code test_code">
           <tr>
             <td>
@@ -4817,6 +4915,21 @@ is set for photo and video. The default for this field is <code>false</code>.</p
 returned for deleted file or folder, otherwise
 <span class='object_link'><a href="Errors/NotFoundError.html" title="DropboxApi::Errors::NotFoundError (class)">Errors::NotFoundError</a></span>
 will be raised. The default for this field is <code>false</code>.</p>
+</div>
+          
+        </li>
+      
+        <li>
+          <span class="name">limit</span>
+          <span class="type">(<tt>Numeric</tt>)</span>
+          <span class="default">
+            
+          </span>
+          
+            &mdash; <div class='inline'><p>If present, will specify max number of
+results per request (Note:
+<a href="https://www.dropbox.com/developers/documentation/http/documentation#files-list_folder" target="_parent" title="Dropbox docs">Dropbox docs</a> indicate
+this is &quot;approximate&quot;, and more may be returned)</p>
 </div>
           
         </li>
@@ -4843,7 +4956,7 @@ will be raised. The default for this field is <code>false</code>.</p>
 9</pre>
             </td>
             <td>
-              <pre class="code"><span class="info file"># File 'spec/endpoints/files/list_folder_spec.rb', line 24</span>
+              <pre class="code"><span class="info file"># File 'spec/endpoints/files/list_folder_spec.rb', line 28</span>
 
 <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list_folder'>list_folder</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span>
 
@@ -4866,7 +4979,7 @@ will be raised. The default for this field is <code>false</code>.</p>
 15</pre>
             </td>
             <td>
-              <pre class="code"><span class="info file"># File 'spec/endpoints/files/list_folder_spec.rb', line 24</span>
+              <pre class="code"><span class="info file"># File 'spec/endpoints/files/list_folder_spec.rb', line 28</span>
 
 <span class='id identifier rubyid_expect'>expect</span> <span class='lbrace'>{</span>
   <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list_folder'>list_folder</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/unexisting_folder</span><span class='tstring_end'>&quot;</span></span>
@@ -4891,7 +5004,7 @@ will be raised. The default for this field is <code>false</code>.</p>
 23</pre>
             </td>
             <td>
-              <pre class="code"><span class="info file"># File 'spec/endpoints/files/list_folder_spec.rb', line 24</span>
+              <pre class="code"><span class="info file"># File 'spec/endpoints/files/list_folder_spec.rb', line 28</span>
 
 <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list_folder'>list_folder</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span>
 
@@ -4920,7 +5033,7 @@ will be raised. The default for this field is <code>false</code>.</p>
 33</pre>
             </td>
             <td>
-              <pre class="code"><span class="info file"># File 'spec/endpoints/files/list_folder_spec.rb', line 24</span>
+              <pre class="code"><span class="info file"># File 'spec/endpoints/files/list_folder_spec.rb', line 28</span>
 
 <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list_shared_links'>list_shared_links</span><span class='lparen'>(</span><span class='symbol'>:path</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/shared_folder</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
 <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list_folder'>list_folder</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>shared_link:</span> <span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_links'>links</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_url'>url</span>
@@ -4947,7 +5060,7 @@ will be raised. The default for this field is <code>false</code>.</p>
 39</pre>
             </td>
             <td>
-              <pre class="code"><span class="info file"># File 'spec/endpoints/files/list_folder_spec.rb', line 24</span>
+              <pre class="code"><span class="info file"># File 'spec/endpoints/files/list_folder_spec.rb', line 28</span>
 
 <span class='id identifier rubyid_expect'>expect</span> <span class='lbrace'>{</span>
   <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list_folder'>list_folder</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/img.png</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='symbol'>:invalid_arg</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>value</span><span class='tstring_end'>&quot;</span></span>
@@ -4966,10 +5079,6 @@ will be raised. The default for this field is <code>false</code>.</p>
       <pre class="lines">
 
 
-24
-25
-26
-27
 28
 29
 30
@@ -4982,10 +5091,16 @@ will be raised. The default for this field is <code>false</code>.</p>
 37
 38
 39
-40</pre>
+40
+41
+42
+43
+44
+45
+46</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/list_folder.rb', line 24</span>
+      <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/list_folder.rb', line 28</span>
 
 <span class='id identifier rubyid_add_endpoint'>add_endpoint</span> <span class='symbol'>:list_folder</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='op'>|</span>
   <span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span>
@@ -4993,13 +5108,15 @@ will be raised. The default for this field is <code>false</code>.</p>
     <span class='symbol'>:include_media_info</span><span class='comma'>,</span>
     <span class='symbol'>:include_deleted</span><span class='comma'>,</span>
     <span class='symbol'>:shared_link</span><span class='comma'>,</span>
-    <span class='symbol'>:include_has_explicit_shared_members</span>
+    <span class='symbol'>:include_has_explicit_shared_members</span><span class='comma'>,</span>
+    <span class='symbol'>:limit</span>
   <span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:recursive</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>false</span>
   <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:include_media_info</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>false</span>
   <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:include_deleted</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>false</span>
   <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:shared_link</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_build_shared_link_param'>build_shared_link_param</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:shared_link</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:shared_link</span><span class='rbracket'>]</span>
-
+  <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:limit</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:limit</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:limit</span><span class='rbracket'>]</span>
+  
   <span class='id identifier rubyid_perform_request'>perform_request</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span>
     <span class='symbol'>:path</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_path'>path</span>
   <span class='rbrace'>}</span><span class='rparen'>)</span>
@@ -6485,6 +6602,75 @@ deleting a folder.</p>
     </td>
   </tr>
 </table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="revoke_shared_link-instance_method">
+  
+    #<strong>revoke_shared_link</strong>(url)  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Revoke a shared link.</p>
+
+<p>Note that even after revoking a shared link to a file, the file may be accessible
+if there are shared links leading to any of the file parent folders. </p>
+
+<p>A successful response indicates that the shared link was revoked.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>url</span>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>shared url which needs to be revoked.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+
+</div>
+<table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+17
+18
+19
+20
+21</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/sharing/revoke_shared_link.rb', line 17</span>
+
+<span class='id identifier rubyid_add_endpoint'>add_endpoint</span> <span class='symbol'>:revoke_shared_link</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_url'>url</span><span class='op'>|</span>
+  <span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+    <span class='symbol'>:url</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_url'>url</span>
+  <span class='rbrace'>}</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
 </div>
     
       <div class="method_details ">
@@ -8737,9 +8923,9 @@ that you can use to continue the upload afterwards.</p>
 </div>
 
       <div id="footer">
-  Generated on Fri Nov 16 09:02:02 2018 by
+  Generated on Sat Feb 16 18:39:18 2019 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.15 (ruby-2.3.3).
+  0.9.16 (ruby-2.3.3).
 </div>
 
     </div>