Updates docs, getting rid of gh-pages branch

Jesus · Nov 12, 2018 · 42b597f · 42b597f
1 parent c4ea6ed
commit 42b597f
Show file tree

Hide file tree

Showing 264 changed files with 68,511 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -3,7 +3,6 @@
 /Gemfile.lock
 /_yardoc/
 /coverage/
-/doc/
 /pkg/
 /spec/reports/
 /tmp/

diff --git a/.yardopts b/.yardopts
@@ -5,6 +5,7 @@ spec/endpoints/**/*_spec.rb
 spec/support/dropbox_scaffold_builder.rb
 --markup=markdown
 --markup-provider=redcarpet
+--output-dir docs
 -
 api_coverage.md
 rails_setup.md
diff --git a/docs/DropboxApi.html b/docs/DropboxApi.html
@@ -0,0 +1,135 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Module: DropboxApi
+
+    &mdash; Documentation by YARD 0.9.15
+
+</title>
+
+  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+
+  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+  pathId = "DropboxApi";
+  relpath = '';
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+
+    <a href="_index.html">Index (D)</a> &raquo;
+
+
+    <span class="title">DropboxApi</span>
+
+</div>
+
+        <div id="search">
+
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+
+</div>
+        <div class="clear"></div>
+      </div>
+
+      <div id="content"><h1>Module: DropboxApi
+
+
+
+</h1>
+<div class="box_info">
+
+
+
+
+
+
+
+
+
+
+
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/dropbox_api/client.rb<span class="defines">,<br />
+  lib/dropbox_api/version.rb,<br /> lib/dropbox_api/authenticator.rb,<br /> lib/dropbox_api/result_builder.rb,<br /> lib/dropbox_api/chunked_uploader.rb,<br /> lib/dropbox_api/errors/http_error.rb,<br /> lib/dropbox_api/options_validator.rb,<br /> lib/dropbox_api/connection_builder.rb,<br /> lib/dropbox_api/endpoints/virtual/upload_by_chunks.rb</span>
+</dd>
+  </dl>
+
+</div>
+
+<h2>Defined Under Namespace</h2>
+<p class="children">
+
+
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="DropboxApi/Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span>, <span class='object_link'><a href="DropboxApi/Errors.html" title="DropboxApi::Errors (module)">Errors</a></span>, <span class='object_link'><a href="DropboxApi/Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span>, <span class='object_link'><a href="DropboxApi/MiddleWare.html" title="DropboxApi::MiddleWare (module)">MiddleWare</a></span>, <span class='object_link'><a href="DropboxApi/OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span>, <span class='object_link'><a href="DropboxApi/Results.html" title="DropboxApi::Results (module)">Results</a></span>
+
+
+
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="DropboxApi/Authenticator.html" title="DropboxApi::Authenticator (class)">Authenticator</a></span>, <span class='object_link'><a href="DropboxApi/ChunkedUploader.html" title="DropboxApi::ChunkedUploader (class)">ChunkedUploader</a></span>, <span class='object_link'><a href="DropboxApi/Client.html" title="DropboxApi::Client (class)">Client</a></span>, <span class='object_link'><a href="DropboxApi/ConnectionBuilder.html" title="DropboxApi::ConnectionBuilder (class)">ConnectionBuilder</a></span>, <span class='object_link'><a href="DropboxApi/ResultBuilder.html" title="DropboxApi::ResultBuilder (class)">ResultBuilder</a></span>
+
+
+</p>
+
+
+    <h2>
+      Constant Summary
+      <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+    </h2>
+
+    <dl class="constants">
+
+        <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.14</span><span class='tstring_end'>&#39;</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
+
+    </dl>
+
+
+
+
+
+
+
+
+
+
+</div>
+
+      <div id="footer">
+  Generated on Mon Nov 12 20:42:55 2018 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.15 (ruby-2.3.3).
+</div>
+
+    </div>
+  </body>
+</html>
diff --git a/docs/DropboxApi/Authenticator.html b/docs/DropboxApi/Authenticator.html
@@ -0,0 +1,217 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Class: DropboxApi::Authenticator
+
+    &mdash; Documentation by YARD 0.9.15
+
+</title>
+
+  <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
+
+  <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+  pathId = "DropboxApi::Authenticator";
+  relpath = '../';
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="../class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+
+    <a href="../_index.html">Index (A)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span>
+     &raquo; 
+    <span class="title">Authenticator</span>
+
+</div>
+
+        <div id="search">
+
+    <a class="full_list_link" id="class_list_link"
+        href="../class_list.html">
+
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+
+</div>
+        <div class="clear"></div>
+      </div>
+
+      <div id="content"><h1>Class: DropboxApi::Authenticator
+
+
+
+</h1>
+<div class="box_info">
+
+  <dl>
+    <dt>Inherits:</dt>
+    <dd>
+      <span class="inheritName">OAuth2::Client</span>
+
+        <ul class="fullTree">
+          <li>Object</li>
+
+            <li class="next">OAuth2::Client</li>
+
+            <li class="next">DropboxApi::Authenticator</li>
+
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+
+    </dd>
+  </dl>
+
+
+
+
+  <dl>
+      <dt>Extended by:</dt>
+      <dd>Forwardable</dd>
+  </dl>
+
+
+
+
+
+
+
+
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/dropbox_api/authenticator.rb</dd>
+  </dl>
+
+</div>
+
+
+
+
+
+
+
+
+
+    <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>(client_id, client_secret)  &#x21d2; Authenticator </a>
+
+
+
+  </span>
+
+
+    <span class="note title constructor">constructor</span>
+
+
+
+
+
+
+
+
+    <span class="summary_desc"><div class='inline'><p>A new instance of Authenticator.</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>(client_id, client_secret)  &#x21d2; <tt><span class='object_link'><a href="" title="DropboxApi::Authenticator (class)">Authenticator</a></span></tt> 
+
+
+
+
+
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns a new instance of Authenticator</p>
+
+
+  </div>
+</div>
+<div class="tags">
+
+
+</div>
+<table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+7
+8
+9
+10
+11
+12</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/dropbox_api/authenticator.rb', line 7</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_client_id'>client_id</span><span class='comma'>,</span> <span class='id identifier rubyid_client_secret'>client_secret</span><span class='rparen'>)</span>
+  <span class='ivar'>@auth_code</span> <span class='op'>=</span> <span class='const'>OAuth2</span><span class='op'>::</span><span class='const'>Client</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_client_id'>client_id</span><span class='comma'>,</span> <span class='id identifier rubyid_client_secret'>client_secret</span><span class='comma'>,</span> <span class='lbrace'>{</span>
+    <span class='symbol'>:authorize_url</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>https://www.dropbox.com/oauth2/authorize</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
+    <span class='symbol'>:token_url</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>https://api.dropboxapi.com/oauth2/token</span><span class='tstring_end'>&#39;</span></span>
+  <span class='rbrace'>}</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_auth_code'>auth_code</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+
+</div>
+
+
+</div>
+
+      <div id="footer">
+  Generated on Mon Nov 12 20:42:56 2018 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.15 (ruby-2.3.3).
+</div>
+
+    </div>
+  </body>
+</html>