dropbox_api 0.1.16 → 0.1.21

data/docs/index.html

@@ -6,15 +6,15 @@
 <title>
   File: README
   
-    &mdash; Documentation by YARD 0.9.15
+    &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 = "README";
   relpath = '';
 </script>
@@ -57,11 +57,11 @@
         <div class="clear"></div>
       </div>
 
-      <div id="content"><div id='filecontents'><h1>DropboxApi</h1>
+      <div id="content"><div id='filecontents'><h1 id="dropboxapi">DropboxApi</h1>
 
 <p>Library for communicating with Dropbox API v2.</p>
 
-<h2>Installation</h2>
+<h2 id="installation">Installation</h2>
 
 <p>Add this line to your application&#39;s Gemfile:</p>
 
@@ -78,7 +78,7 @@
 <pre class="code ruby"><code class="ruby">$ gem install dropbox_api
 </code></pre>
 
-<h2>Documentation</h2>
+<h2 id="documentation">Documentation</h2>
 
 <p>Please, refer to this gem&#39;s custom <a href="http://jesus.github.io/dropbox_api">Dropbox API
 documentation</a>.
@@ -96,9 +96,9 @@ an example of its usage.</li>
 use them.</li>
 </ul>
 
-<h2>Basic set up</h2>
+<h2 id="basic-set-up">Basic set up</h2>
 
-<h3>Authorize your application</h3>
+<h3 id="authorize-your-application">Authorize your application</h3>
 
 <p>Dropbox uses OAuth, in order to use this library from your application you&#39;ll
 have to get an authorization code.</p>
@@ -116,43 +116,111 @@ have to get an authorization code.</p>
 <span class='comment'>#=&gt; #&lt;DropboxApi::Client ...&gt;
 </span></code></pre>
 
-<p>Note that setting an ENV variable is only a feasible choice if you&#39;re only
-using one account.</p>
+<p>The official documentation on the process to get an authorization code is
+<a href="https://developers.dropbox.com/es-es/oauth-guide#implementing-oauth">here</a>,
+it describes the two options listed below.</p>
 
-<h4>Option A: Get your access token from the website</h4>
+<h4 id="option-a-get-your-access-token-from-the-website">Option A: Get your access token from the website</h4>
 
-<p>The easiest way to obtain an access token is to get it from the Dropbox website.
-You just need to log in to Dropbox and refer to the <em>developers</em> section, go to
-<em>My apps</em> and select your application, you may need to create one if you
-haven&#39;t done so yet.</p>
+<p>For a quick test, you can obtain an access token from the App Console in
+<a href="https://www.dropbox.com/developers/">Dropbox&#39;s website</a>. Select from
+<em>My apps</em> your application, you may need to create one if you
+haven&#39;t done so yet. Under your application settings, find section
+<em>OAuth 2</em>, there is a button to generate an access token.</p>
 
-<p>Under your application settings, find section <em>OAuth 2</em>. You&#39;ll find a button
-to generate an access token.</p>
+<h4 id="option-b-oauth2-code-flow">Option B: OAuth2 Code Flow</h4>
 
-<h4>Option B: Use <code>DropboxApi::Authenticator</code></h4>
+<p>This is typically what you will use in production, you can obtain an
+authorization code with a 3-step process:</p>
 
-<p>You can obtain an authorization code with this library:</p>
-
-<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_authenticator'>authenticator</span> <span class='op'>=</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="DropboxApi/Authenticator.html" title="DropboxApi::Authenticator (class)">Authenticator</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="DropboxApi/Authenticator.html#initialize-instance_method" title="DropboxApi::Authenticator#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='const'>CLIENT_ID</span><span class='comma'>,</span> <span class='const'>CLIENT_SECRET</span><span class='rparen'>)</span>
-<span class='id identifier rubyid_authenticator'>authenticator</span><span class='period'>.</span><span class='id identifier rubyid_authorize_url'>authorize_url</span> <span class='comment'>#=&gt; &quot;https://www.dropbox.com/...&quot;
+<pre class="code ruby"><code class="ruby"><span class='comment'># 1. Get an authorization URL.
+</span><span class='id identifier rubyid_authenticator'>authenticator</span> <span class='op'>=</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="DropboxApi/Authenticator.html" title="DropboxApi::Authenticator (class)">Authenticator</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="DropboxApi/Authenticator.html#initialize-instance_method" title="DropboxApi::Authenticator#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='const'>CLIENT_ID</span><span class='comma'>,</span> <span class='const'>CLIENT_SECRET</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_authenticator'>authenticator</span><span class='period'>.</span><span class='id identifier rubyid_auth_code'>auth_code</span><span class='period'>.</span><span class='id identifier rubyid_authorize_url'>authorize_url</span> <span class='comment'>#=&gt; &quot;https://www.dropbox.com/...&quot;
 </span>
-<span class='comment'># Now you need to open the authorization URL in your browser,
-</span><span class='comment'># authorize the application and copy your code.
+<span class='comment'># 2. Log into Dropbox and authorize your app. You need to open the
+</span><span class='comment'># authorization URL in your browser.
 </span>
-<span class='id identifier rubyid_auth_bearer'>auth_bearer</span> <span class='op'>=</span> <span class='id identifier rubyid_authenticator'>authenticator</span><span class='period'>.</span><span class='id identifier rubyid_get_token'>get_token</span><span class='lparen'>(</span><span class='const'>CODE</span><span class='rparen'>)</span> <span class='comment'>#=&gt; #&lt;OAuth2::AccessToken ...&gt;`
-</span><span class='id identifier rubyid_auth_bearer'>auth_bearer</span><span class='period'>.</span><span class='id identifier rubyid_token'>token</span> <span class='comment'>#=&gt; &quot;VofXAX8D...&quot;
-</span><span class='comment'># Keep this token, you&#39;ll need it to initialize a `DropboxApi::Client` object
-</span></code></pre>
+<span class='comment'># 3. Exchange the authorization code for a reusable access token (not visible
+</span><span class='comment'>#    to the user).
+</span><span class='id identifier rubyid_access_token'>access_token</span> <span class='op'>=</span> <span class='id identifier rubyid_authenticator'>authenticator</span><span class='period'>.</span><span class='id identifier rubyid_auth_code'>auth_code</span><span class='period'>.</span><span class='id identifier rubyid_get_token'>get_token</span><span class='lparen'>(</span><span class='const'>CODE</span><span class='rparen'>)</span> <span class='comment'>#=&gt; #&lt;OAuth2::AccessToken ...&gt;`
+</span><span class='id identifier rubyid_access_token'>access_token</span><span class='period'>.</span><span class='id identifier rubyid_token'>token</span> <span class='comment'>#=&gt; &quot;VofXAX8D...&quot;
+</span>
+<span class='comment'># Keep this token, you&#39;ll need it to initialize a `DropboxApi::Client` object:
+</span><span class='id identifier rubyid_client'>client</span> <span class='op'>=</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="DropboxApi/Client.html" title="DropboxApi::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="DropboxApi/Client.html#initialize-instance_method" title="DropboxApi::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>access_token:</span> <span class='id identifier rubyid_access_token'>access_token</span><span class='rparen'>)</span>
 
-<h4>Standard OAuth 2 flow</h4>
+<span class='comment'># For backwards compatibility, the following also works:
+</span><span class='id identifier rubyid_client'>client</span> <span class='op'>=</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="DropboxApi/Client.html" title="DropboxApi::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="DropboxApi/Client.html#initialize-instance_method" title="DropboxApi::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_access_token'>access_token</span><span class='period'>.</span><span class='id identifier rubyid_token'>token</span><span class='rparen'>)</span>
+</code></pre>
 
-<p>This is what many web applications will use. The process is described in
-Dropbox&#39;s <a href="https://www.dropbox.com/developers/reference/oauth-guide#oauth-2-on-the-web">OAuth guide</a>.</p>
+<h5 id="integration-with-rails">Integration with Rails</h5>
 
 <p>If you have a Rails application, you might be interested in this <a href="http://jesus.github.io/dropbox_api/file.rails_setup.html">setup
 guide</a>.</p>
 
-<h3>Performing API calls</h3>
+<h5 id="using-refresh-tokens">Using refresh tokens</h5>
+
+<p>Access tokens are short-lived by default (as of September 30th, 2021),
+applications that require long-lived access to the API without additional
+interaction with the user should use refresh tokens.</p>
+
+<p>The process is similar but a token refresh might seamlessly occur as you
+perform API calls. When this happens you&#39;ll need to store the
+new token hash if you want to continue using this session, you can use the
+<code>on_token_refreshed</code> callback to do this.</p>
+
+<pre class="code ruby"><code class="ruby"><span class='comment'># 1. Get an authorization URL, requesting offline access type.
+</span><span class='id identifier rubyid_authenticator'>authenticator</span> <span class='op'>=</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="DropboxApi/Authenticator.html" title="DropboxApi::Authenticator (class)">Authenticator</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="DropboxApi/Authenticator.html#initialize-instance_method" title="DropboxApi::Authenticator#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='const'>CLIENT_ID</span><span class='comma'>,</span> <span class='const'>CLIENT_SECRET</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_authenticator'>authenticator</span><span class='period'>.</span><span class='id identifier rubyid_auth_code'>auth_code</span><span class='period'>.</span><span class='id identifier rubyid_authorize_url'>authorize_url</span><span class='lparen'>(</span><span class='label'>token_access_type:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>offline</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+
+<span class='comment'># 2. Log into Dropbox and authorize your app. You need to open the
+</span><span class='comment'>#    authorization URL in your browser.
+</span>
+<span class='comment'># 3. Exchange the authorization code for a reusable access token
+</span><span class='id identifier rubyid_access_token'>access_token</span> <span class='op'>=</span> <span class='id identifier rubyid_authenticator'>authenticator</span><span class='period'>.</span><span class='id identifier rubyid_auth_code'>auth_code</span><span class='period'>.</span><span class='id identifier rubyid_get_token'>get_token</span><span class='lparen'>(</span><span class='const'>CODE</span><span class='rparen'>)</span> <span class='comment'>#=&gt; #&lt;OAuth2::AccessToken ...&gt;`
+</span>
+<span class='comment'># You can now use the access token to initialize a DropboxApi::Client, you
+</span><span class='comment'># should also provide a callback function to store the updated access token
+</span><span class='comment'># whenever it&#39;s refreshed.
+</span><span class='id identifier rubyid_client'>client</span> <span class='op'>=</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="DropboxApi/Client.html" title="DropboxApi::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="DropboxApi/Client.html#initialize-instance_method" title="DropboxApi::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span>
+  <span class='label'>access_token:</span> <span class='id identifier rubyid_access_token'>access_token</span><span class='comma'>,</span>
+  <span class='label'>on_token_refreshed:</span> <span class='id identifier rubyid_lambda'>lambda</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_new_token_hash'>new_token_hash</span><span class='op'>|</span>
+    <span class='comment'># token_hash is a serializable Hash, something like this:
+</span>    <span class='comment'># {
+</span>    <span class='comment'>#   &quot;uid&quot;=&gt;&quot;440&quot;,
+</span>    <span class='comment'>#   &quot;token_type&quot;=&gt;&quot;bearer&quot;,
+</span>    <span class='comment'>#   &quot;scope&quot;=&gt;&quot;account_info.read account_info.write...&quot;,
+</span>    <span class='comment'>#   &quot;account_id&quot;=&gt;&quot;dbid:AABOLtA1rT6rRK4vajKZ...&quot;,
+</span>    <span class='comment'>#   :access_token=&gt;&quot;sl.A5Ez_CBsqJILhDawHlmXSoZEhLZ4nuLFVRs6AJ...&quot;,
+</span>    <span class='comment'>#   :refresh_token=&gt;&quot;iMg4Me_oKYUAAAAAAAAAAapQixCgwfXOxuubCuK_...&quot;,
+</span>    <span class='comment'>#   :expires_at=&gt;1632948328
+</span>    <span class='comment'># }
+</span>    <span class='const'>SomewhereSafe</span><span class='period'>.</span><span class='id identifier rubyid_save'>save</span><span class='lparen'>(</span><span class='id identifier rubyid_new_token_hash'>new_token_hash</span><span class='rparen'>)</span>
+  <span class='rbrace'>}</span>
+<span class='rparen'>)</span>
+</code></pre>
+
+<p>Once you&#39;ve gone through the process above, you can skip the steps that require
+user interaction in subsequent initializations of <code>DropboxApi::Client</code>. For
+example:</p>
+
+<pre class="code ruby"><code class="ruby"><span class='comment'># 1. Initialize an authenticator
+</span><span class='id identifier rubyid_authenticator'>authenticator</span> <span class='op'>=</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="DropboxApi/Authenticator.html" title="DropboxApi::Authenticator (class)">Authenticator</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="DropboxApi/Authenticator.html#initialize-instance_method" title="DropboxApi::Authenticator#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='const'>CLIENT_ID</span><span class='comma'>,</span> <span class='const'>CLIENT_SECRET</span><span class='rparen'>)</span>
+
+<span class='comment'># 2. Retrieve the token hash you previously stored somewhere safe, you can use
+</span><span class='comment'>#    it to build a new access token.
+</span><span class='id identifier rubyid_access_token'>access_token</span> <span class='op'>=</span> <span class='const'>OAuth2</span><span class='op'>::</span><span class='const'>AccessToken</span><span class='period'>.</span><span class='id identifier rubyid_from_hash'>from_hash</span><span class='lparen'>(</span><span class='id identifier rubyid_authenticator'>authenticator</span><span class='comma'>,</span> <span class='id identifier rubyid_token_hash'>token_hash</span><span class='rparen'>)</span>
+
+<span class='comment'># 3. You now have an access token, so you can initialize a client like you
+</span><span class='comment'>#    would normally:
+</span><span class='id identifier rubyid_client'>client</span> <span class='op'>=</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="DropboxApi/Client.html" title="DropboxApi::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="DropboxApi/Client.html#initialize-instance_method" title="DropboxApi::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span>
+  <span class='label'>access_token:</span> <span class='id identifier rubyid_access_token'>access_token</span><span class='comma'>,</span>
+  <span class='label'>on_token_refreshed:</span> <span class='id identifier rubyid_lambda'>lambda</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_new_token_hash'>new_token_hash</span><span class='op'>|</span>
+    <span class='const'>SomewhereSafe</span><span class='period'>.</span><span class='id identifier rubyid_save'>save</span><span class='lparen'>(</span><span class='id identifier rubyid_new_token_hash'>new_token_hash</span><span class='rparen'>)</span>
+  <span class='rbrace'>}</span>
+<span class='rparen'>)</span>
+</code></pre>
+
+<h3 id="performing-api-calls">Performing API calls</h3>
 
 <p>Once you&#39;ve initialized a client, for example:</p>
 
@@ -174,7 +242,7 @@ guide</a>.</p>
 perform API calls. You can check the class&#39; documentation to find
 <a href="http://jesus.github.io/dropbox_api/DropboxApi/Client.html">all available endpoints</a>.</p>
 
-<h3>Large file uploads</h3>
+<h3 id="large-file-uploads">Large file uploads</h3>
 
 <p>If you need to upload files larger than 150MB the default <code>#upload</code> endpoint
 won&#39;t work. Instead, you need to start a upload session and upload
@@ -194,21 +262,39 @@ example:</p>
 <a href="http://www.xuuso.com/dropbox_api/DropboxApi/Client.html#upload_by_chunks-instance_method">method documentation</a>
 to find out all available options.</p>
 
-<h2>Dependencies</h2>
+<h3 id="accessing-team-folders">Accessing Team Folders</h3>
+
+<p>In order to access your team scope you need to add the namespace_id to you request headers.
+This can be done using the middlewere layer as per the below:</p>
+
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_client'>client</span> <span class='op'>=</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="DropboxApi/Client.html" title="DropboxApi::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="DropboxApi/Client.html#initialize-instance_method" title="DropboxApi::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>VofXAX8D...</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
+<span class='comment'>#=&gt; #&lt;DropboxApi::Client ...&gt;
+</span><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_namespace_id'>namespace_id</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_get_current_account'>get_current_account</span><span class='period'>.</span><span class='id identifier rubyid_root_info'>root_info</span><span class='period'>.</span><span class='id identifier rubyid_root_namespace_id'>root_namespace_id</span>
+
+<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_list_folder'>list_folder</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+<span class='comment'>#=&gt; Now returns the team folders
+</span></code></pre>
+
+<p>You could unset the namespace ID at any point afterwards with just:</p>
+
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_namespace_id'>namespace_id</span> <span class='op'>=</span> <span class='kw'>nil</span>
+</code></pre>
+
+<h2 id="dependencies">Dependencies</h2>
 
 <p>This gem depends on
 <a href="https://github.com/oauth-xx/oauth2">oauth2</a>
 and
 <a href="https://github.com/lostisland/faraday">faraday</a>.</p>
 
-<p>It has official support for Ruby versions <code>1.9.x</code> and <code>2.x</code>.</p>
+<p>It has official support for Ruby versions <code>2.x</code>.</p>
 
-<h2>Development</h2>
+<h2 id="development">Development</h2>
 
 <p>After checking out the repo, run <code>bin/setup</code> to install dependencies. Then, run
 <code>bin/console</code> for an interactive prompt that will allow you to experiment.</p>
 
-<h3>Testing</h3>
+<h3 id="testing">Testing</h3>
 
 <p>I recommend you to use a test account other than your main one.</p>
 
@@ -224,7 +310,12 @@ will pass. If it doesn&#39;t exist you may need to write it yourself, check
 the <code>DropboxScaffoldBuilder</code> class to find all existing scaffold builders.</p>
 
 <pre class="code text"><code class="text">DROPBOX_OAUTH_BEARER=YOUR_AUTH_BEARER rake test:build_scaffold[list_folder]
-</code></pre></li>
+</code></pre>
+
+<p>Note that you&#39;ll have to type <code>rake test:build_scaffold\[list_folder\]</code>
+if you use <code>zsh</code>.</p>
+
+<p>You can build all available scaffolds with just <code>rake test:build_scaffold</code>.</p></li>
 <li><p>Run the tests and the cassettes will be written:</p>
 
 <pre class="code text"><code class="text">DROPBOX_OAUTH_BEARER=YOUR_AUTH_BEARER rspec spec/endpoints/files/list_folder_spec.rb
@@ -235,11 +326,11 @@ the <code>DropboxScaffoldBuilder</code> class to find all existing scaffold buil
 been filtered. However, you may want to double check before pushing your
 updates to Github.</p>
 
-<p>Tip: You can simply run <code>export DROPBOX_OAUTH_BEARER=YOUR_AUTH_BEARER</code> at
+<p>Tip: you can simply run <code>export DROPBOX_OAUTH_BEARER=YOUR_AUTH_BEARER</code> at
 the beginning of your work session so you don&#39;t need to prefix it in every
 command line.</p>
 
-<h2>Contributing</h2>
+<h2 id="contributing">Contributing</h2>
 
 <p>Any help will be much appreciated. The easiest way to help is to implement one
 or more of the <a href="http://jesus.github.io/dropbox_api/file.api_coverage.html">endpoints that are still pending</a>. To see how the
@@ -247,9 +338,9 @@ endpoints are implemented, check out the <code>lib/dropbox_api/endpoints</code>
 </div></div>
 
       <div id="footer">
-  Generated on Fri Nov 16 09:02:01 2018 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.15 (ruby-2.3.3).
+  0.9.26 (ruby-2.6.5).
 </div>
 
     </div>

data/docs/js/app.js

@@ -171,6 +171,7 @@ function generateTOC() {
   var counter = 0;
   var tags = ['h2', 'h3', 'h4', 'h5', 'h6'];
   var i;
+  var curli;
   if ($('#filecontents h1').length > 1) tags.unshift('h1');
   for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
   var lastTag = parseInt(tags[0][1], 10);
@@ -190,15 +191,25 @@ function generateTOC() {
     }
     if (thisTag > lastTag) {
       for (i = 0; i < thisTag - lastTag; i++) {
-        var tmp = $('<ol/>'); toc.append(tmp); toc = tmp;
+        if ( typeof(curli) == "undefined" ) {
+          curli = $('<li/>');
+          toc.append(curli);
+        }
+        toc = $('<ol/>');
+        curli.append(toc);
+        curli = undefined;
       }
     }
     if (thisTag < lastTag) {
-      for (i = 0; i < lastTag - thisTag; i++) toc = toc.parent();
+      for (i = 0; i < lastTag - thisTag; i++) {
+        toc = toc.parent();
+        toc = toc.parent();
+      }
     }
     var title = $(this).attr('toc-title');
     if (typeof(title) == "undefined") title = $(this).text();
-    toc.append('<li><a href="#' + this.id + '">' + title + '</a></li>');
+    curli =$('<li><a href="#' + this.id + '">' + title + '</a></li>'); 
+    toc.append(curli);
     lastTag = thisTag;
   });
   if (!show) return;
@@ -275,6 +286,16 @@ function mainFocus() {
   setTimeout(function() { $('#main').focus(); }, 10);
 }
 
+function navigationChange() {
+  // This works around the broken anchor navigation with the YARD template.
+  window.onpopstate = function() {
+    var hash = window.location.hash;
+    if (hash !== '' && $(hash)[0]) {
+      $(hash)[0].scrollIntoView();
+    }
+  };
+}
+
 $(document).ready(function() {
   navResizer();
   navExpander();
@@ -287,6 +308,7 @@ $(document).ready(function() {
   constantSummaryToggle();
   generateTOC();
   mainFocus();
+  navigationChange();
 });
 
 })();