dropbox_api 0.1.20 → 0.1.21

data/docs/DropboxApi/ConnectionBuilder.html

@@ -103,6 +103,37 @@
 
 
 
+  <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
+  <ul class="summary">
+    
+      <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#namespace_id-instance_method" title="#namespace_id (instance method)">#<strong>namespace_id</strong>  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+    
+    
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'><p>Returns the value of attribute namespace_id.</p>
+</div></span>
+  
+</li>
+
+    
+  </ul>
+
 
 
 
@@ -139,7 +170,29 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(oauth_bearer)  &#x21d2; ConnectionBuilder </a>
+      <a href="#can_refresh_access_token%3F-instance_method" title="#can_refresh_access_token? (instance method)">#<strong>can_refresh_access_token?</strong>  &#x21d2; Boolean </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(oauth_bearer = nil, access_token: nil, on_token_refreshed: nil)  &#x21d2; ConnectionBuilder </a>
     
 
     
@@ -178,6 +231,28 @@
   
 
   
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#refresh_access_token-instance_method" title="#refresh_access_token (instance method)">#<strong>refresh_access_token</strong>  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
     <span class="summary_desc"><div class='inline'></div></span>
   
 </li>
@@ -192,7 +267,7 @@
     <div class="method_details first">
   <h3 class="signature first" id="initialize-instance_method">
   
-    #<strong>initialize</strong>(oauth_bearer)  &#x21d2; <tt><span class='object_link'><a href="" title="DropboxApi::ConnectionBuilder (class)">ConnectionBuilder</a></span></tt> 
+    #<strong>initialize</strong>(oauth_bearer = nil, access_token: nil, on_token_refreshed: nil)  &#x21d2; <tt><span class='object_link'><a href="" title="DropboxApi::ConnectionBuilder (class)">ConnectionBuilder</a></span></tt> 
   
 
   
@@ -208,6 +283,76 @@
 <div class="tags">
   
 
+</div>
+<table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+6
+7
+8
+9
+10
+11
+12
+13
+14
+15
+16
+17
+18
+19</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/dropbox_api/connection_builder.rb', line 6</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_oauth_bearer'>oauth_bearer</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>access_token:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>on_token_refreshed:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
+  <span class='kw'>if</span> <span class='id identifier rubyid_access_token'>access_token</span>
+    <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_access_token'>access_token</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>OAuth2</span><span class='op'>::</span><span class='const'>AccessToken</span><span class='rparen'>)</span>
+      <span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>access_token should be an OAuth2::AccessToken</span><span class='tstring_end'>&quot;</span></span>
+    <span class='kw'>end</span>
+
+    <span class='ivar'>@access_token</span> <span class='op'>=</span> <span class='id identifier rubyid_access_token'>access_token</span>
+    <span class='ivar'>@on_token_refreshed</span> <span class='op'>=</span> <span class='id identifier rubyid_on_token_refreshed'>on_token_refreshed</span>
+  <span class='kw'>elsif</span> <span class='id identifier rubyid_oauth_bearer'>oauth_bearer</span>
+    <span class='ivar'>@oauth_bearer</span> <span class='op'>=</span> <span class='id identifier rubyid_oauth_bearer'>oauth_bearer</span>
+  <span class='kw'>else</span>
+    <span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Either oauth_bearer or access_token should be set</span><span class='tstring_end'>&quot;</span></span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  
+</div>
+
+  <div id="instance_attr_details" class="attr_details">
+    <h2>Instance Attribute Details</h2>
+    
+      
+      <span id="namespace_id=-instance_method"></span>
+      <div class="method_details first">
+  <h3 class="signature first" id="namespace_id-instance_method">
+  
+    #<strong>namespace_id</strong>  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the value of attribute namespace_id.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
 </div>
 <table class="source_code">
   <tr>
@@ -222,15 +367,15 @@
     <td>
       <pre class="code"><span class="info file"># File 'lib/dropbox_api/connection_builder.rb', line 4</span>
 
-<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_oauth_bearer'>oauth_bearer</span><span class='rparen'>)</span>
-  <span class='ivar'>@oauth_bearer</span> <span class='op'>=</span> <span class='id identifier rubyid_oauth_bearer'>oauth_bearer</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_namespace_id'>namespace_id</span>
+  <span class='ivar'>@namespace_id</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
 </div>
-  
-</div>
+    
+  </div>
 
 
   <div id="instance_method_details" class="method_details_list">
@@ -253,24 +398,28 @@
       <pre class="lines">
 
 
-12
-13
-14
-15
-16
-17
-18
-19
-20</pre>
+44
+45
+46
+47
+48
+49
+50
+51
+52
+53
+54</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/dropbox_api/connection_builder.rb', line 12</span>
+      <pre class="code"><span class="info file"># File 'lib/dropbox_api/connection_builder.rb', line 44</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_build'>build</span><span class='lparen'>(</span><span class='id identifier rubyid_url'>url</span><span class='rparen'>)</span>
   <span class='const'>Faraday</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_url'>url</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_connection'>connection</span><span class='op'>|</span>
+    <span class='id identifier rubyid_connection'>connection</span><span class='period'>.</span><span class='id identifier rubyid_use'>use</span> <span class='const'><span class='object_link'><a href="../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="MiddleWare.html" title="DropboxApi::MiddleWare (module)">MiddleWare</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="MiddleWare/PathRoot.html" title="DropboxApi::MiddleWare::PathRoot (class)">PathRoot</a></span></span><span class='comma'>,</span> <span class='lbrace'>{</span>
+      <span class='label'>namespace_id:</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_namespace_id'>namespace_id</span>
+    <span class='rbrace'>}</span>
     <span class='id identifier rubyid_middleware'>middleware</span><span class='period'>.</span><span class='id identifier rubyid_apply'>apply</span><span class='lparen'>(</span><span class='id identifier rubyid_connection'>connection</span><span class='rparen'>)</span> <span class='kw'>do</span>
-      <span class='id identifier rubyid_connection'>connection</span><span class='period'>.</span><span class='id identifier rubyid_authorization'>authorization</span> <span class='symbol'>:Bearer</span><span class='comma'>,</span> <span class='ivar'>@oauth_bearer</span>
-
+      <span class='id identifier rubyid_connection'>connection</span><span class='period'>.</span><span class='id identifier rubyid_authorization'>authorization</span> <span class='symbol'>:Bearer</span><span class='comma'>,</span> <span class='id identifier rubyid_bearer'>bearer</span>
       <span class='kw'>yield</span> <span class='id identifier rubyid_connection'>connection</span>
     <span class='kw'>end</span>
   <span class='kw'>end</span>
@@ -278,6 +427,59 @@
     </td>
   </tr>
 </table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="can_refresh_access_token?-instance_method">
+  
+    #<strong>can_refresh_access_token?</strong>  &#x21d2; <tt>Boolean</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Boolean</tt>)</span>
+      
+      
+      
+    </li>
+  
+</ul>
+
+</div>
+<table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+25
+26
+27</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/dropbox_api/connection_builder.rb', line 25</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_can_refresh_access_token?'>can_refresh_access_token?</span>
+  <span class='ivar'>@access_token</span> <span class='op'>&amp;&amp;</span> <span class='ivar'>@access_token</span><span class='period'>.</span><span class='id identifier rubyid_refresh_token'>refresh_token</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
 </div>
     
       <div class="method_details ">
@@ -296,12 +498,12 @@
       <pre class="lines">
 
 
-8
-9
-10</pre>
+21
+22
+23</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/dropbox_api/connection_builder.rb', line 8</span>
+      <pre class="code"><span class="info file"># File 'lib/dropbox_api/connection_builder.rb', line 21</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_middleware'>middleware</span>
   <span class='ivar'>@middleware</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="MiddleWare.html" title="DropboxApi::MiddleWare (module)">MiddleWare</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="MiddleWare/Stack.html" title="DropboxApi::MiddleWare::Stack (class)">Stack</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="MiddleWare/Stack.html#initialize-instance_method" title="DropboxApi::MiddleWare::Stack#initialize (method)">new</a></span></span>
@@ -309,6 +511,39 @@
     </td>
   </tr>
 </table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="refresh_access_token-instance_method">
+  
+    #<strong>refresh_access_token</strong>  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</h3>
+<table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+29
+30
+31
+32</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/dropbox_api/connection_builder.rb', line 29</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_refresh_access_token'>refresh_access_token</span>
+  <span class='ivar'>@access_token</span> <span class='op'>=</span> <span class='ivar'>@access_token</span><span class='period'>.</span><span class='id identifier rubyid_refresh!'>refresh!</span>
+  <span class='ivar'>@on_token_refreshed</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='ivar'>@access_token</span><span class='period'>.</span><span class='id identifier rubyid_to_hash'>to_hash</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='ivar'>@on_token_refreshed</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
 </div>
     
   </div>
@@ -316,9 +551,9 @@
 </div>
 
       <div id="footer">
-  Generated on Sun Feb  7 11:51:55 2021 by
+  Generated on Wed Sep 29 23:44:25 2021 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.26 (ruby-2.5.1).
+  0.9.26 (ruby-2.6.5).
 </div>
 
     </div>

data/docs/DropboxApi/Endpoints/Auth/TokenRevoke.html

@@ -185,7 +185,7 @@
   
   
   <h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></h3>
-  <p class="inherited"><span class='object_link'><a href="../Rpc.html#build_request-instance_method" title="DropboxApi::Endpoints::Rpc#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../Rpc.html#initialize-instance_method" title="DropboxApi::Endpoints::Rpc#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="../Rpc.html#request_body-instance_method" title="DropboxApi::Endpoints::Rpc#request_body (method)">#request_body</a></span></p>
+  <p class="inherited"><span class='object_link'><a href="../Rpc.html#build_connection-instance_method" title="DropboxApi::Endpoints::Rpc#build_connection (method)">#build_connection</a></span>, <span class='object_link'><a href="../Rpc.html#build_request-instance_method" title="DropboxApi::Endpoints::Rpc#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../Rpc.html#request_body-instance_method" title="DropboxApi::Endpoints::Rpc#request_body (method)">#request_body</a></span></p>
 
   
   
@@ -196,11 +196,11 @@
   
   
   <h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
-  <p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span></p>
+  <p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span>, <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">#initialize</a></span></p>
 <div id="constructor_details" class="method_details_list">
   <h2>Constructor Details</h2>
   
-    <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Rpc.html#initialize-instance_method" title="DropboxApi::Endpoints::Rpc#initialize (method)">DropboxApi::Endpoints::Rpc</a></span></p>
+    <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">DropboxApi::Endpoints::Base</a></span></p>
   
 </div>
 
@@ -255,9 +255,9 @@
 </div>
 
       <div id="footer">
-  Generated on Sun Feb  7 11:51:57 2021 by
+  Generated on Wed Sep 29 23:44:26 2021 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.26 (ruby-2.5.1).
+  0.9.26 (ruby-2.6.5).
 </div>
 
     </div>

data/docs/DropboxApi/Endpoints/Auth.html

@@ -105,9 +105,9 @@
 </div>
 
       <div id="footer">
-  Generated on Sun Feb  7 11:51:55 2021 by
+  Generated on Wed Sep 29 23:44:24 2021 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.26 (ruby-2.5.1).
+  0.9.26 (ruby-2.6.5).
 </div>
 
     </div>

data/docs/DropboxApi/Endpoints/Base.html

@@ -142,7 +142,88 @@
       
     </ul>
   
+    <h2>
+      Instance Method Summary
+      <small><a href="#" class="summary_toggle">collapse</a></small>
+    </h2>
 
+    <ul class="summary">
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(builder)  &#x21d2; Base </a>
+    
+
+    
+  </span>
+  
+  
+    <span class="note title constructor">constructor</span>
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'><p>A new instance of Base.</p>
+</div></span>
+  
+</li>
+
+      
+    </ul>
+  
+
+<div id="constructor_details" class="method_details_list">
+  <h2>Constructor Details</h2>
+  
+    <div class="method_details first">
+  <h3 class="signature first" id="initialize-instance_method">
+  
+    #<strong>initialize</strong>(builder)  &#x21d2; <tt><span class='object_link'><a href="" title="DropboxApi::Endpoints::Base (class)">Base</a></span></tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns a new instance of Base.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div>
+<table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+4
+5
+6
+7</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/base.rb', line 4</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_builder'>builder</span><span class='rparen'>)</span>
+  <span class='ivar'>@builder</span> <span class='op'>=</span> <span class='id identifier rubyid_builder'>builder</span>
+  <span class='id identifier rubyid_build_connection'>build_connection</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  
+</div>
 
 
   <div id="class_method_details" class="method_details_list">
@@ -165,13 +246,13 @@
       <pre class="lines">
 
 
-4
-5
-6
-7</pre>
+9
+10
+11
+12</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/base.rb', line 4</span>
+      <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/base.rb', line 9</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_add_endpoint'>add_endpoint</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_define_method'>define_method</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
@@ -187,9 +268,9 @@
 </div>
 
       <div id="footer">
-  Generated on Sun Feb  7 11:51:55 2021 by
+  Generated on Wed Sep 29 23:44:25 2021 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.26 (ruby-2.5.1).
+  0.9.26 (ruby-2.6.5).
 </div>
 
     </div>