dropbox_api 0.1.14 → 0.1.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 993d8baa7d481473d21c140964ed25081b9ec4c7
-  data.tar.gz: 4838dcd2491bbcdcefea3bc3051fc1619dcbb43b
+SHA256:
+  metadata.gz: 9c59970ce358c1a706d47040336547ea3df770fe97194122011f5695d69a4bc9
+  data.tar.gz: caff55f6ba1ae50d6487450c2f12ac2df2a72a2cf3573ce6d8610664de404012
 SHA512:
-  metadata.gz: a625f2c0cb77ee6e0d907ad2091caf20d46406bb46a5d579ea91a06f1cfe55c2bdb6fd25232a605b35e48cac3de5c63c394f6647257439fa88fac28f2f227173
-  data.tar.gz: 53892103e31cd6afce2c9d443b394dc537aa4a44d183884904de03c0bee6facbb36c5e3e03940bd5a3be441afc99fc8c1ac9f6ba1c442987a845b95ec9f3e5f5
+  metadata.gz: 7fc4add7446cec7d25627719dffa3b293173c7ce02356d514c7ac49f17673207da670d563e63ba0bf2690376beec98325ce84fbb6843f4bedab0ec6ff1b000b9
+  data.tar.gz: 4d2a098c291bc47d501ba90dcce05ae43e42ab77fa1c5fe8ad83d329aec3408d1ac987d2b931fbf25fe64a1f8c51584620306b06c32e9ebe7d5bf7c0a0efc6a1

data/.gitignore

@@ -3,9 +3,9 @@
 /Gemfile.lock
 /_yardoc/
 /coverage/
-/doc/
 /pkg/
 /spec/reports/
 /tmp/
 .ruby-version
 .ruby-gemset
+.byebug_history

data/.rubocop.yml

@@ -0,0 +1,15 @@
+AllCops:
+  DisabledByDefault: true
+
+Style/HashSyntax:
+  Enabled: true
+  EnforcedStyle: 'ruby19'
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: always_true
+
+Style/RedundantFreeze:
+  Enabled: true
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes

data/.travis.yml

@@ -1,7 +1,6 @@
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.2.6
   - 2.3.3
   - 2.4.4
   - 2.5.1
+  - 2.6.1

data/.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

data/Gemfile

@@ -1,9 +1,14 @@
+# frozen_string_literal: true
 source 'https://rubygems.org'
 
 gemspec
 
 group :development do
   # Documentation
-  gem 'yard-rspec', :git => "https://github.com/Jesus/yard-spec-plugin.git"
   gem 'redcarpet'
+  gem 'yard-tests-rspec', git: 'https://github.com/Jesus/yard-spec-plugin.git'
+
+  # Code linting
+  gem 'rubocop', require: false
+  gem 'rubocop-rspec', require: false
 end

data/README.md

@@ -146,7 +146,7 @@ This gem depends on
 and
 [faraday](https://github.com/lostisland/faraday).
 
-It has official support for Ruby versions `1.9.x` and `2.x`.
+It has official support for Ruby versions `2.x`.
 
 ## Development
 
@@ -172,6 +172,11 @@ would be the procedure to do so:
     DROPBOX_OAUTH_BEARER=YOUR_AUTH_BEARER rake test:build_scaffold[list_folder]
     ```
 
+    Note that you'll have to type `rake test:build_scaffold\[list_folder\]`
+    if you use `zsh`.
+
+    You can build all available scaffolds with just `rake test:build_scaffold`.
+
  3. Run the tests and the cassettes will be written:
 
     ```text
@@ -182,7 +187,7 @@ The OAuth bearer shouldn't have been recorded in the cassette and it should've
 been filtered. However, you may want to double check before pushing your
 updates to Github.
 
-Tip: You can simply run `export DROPBOX_OAUTH_BEARER=YOUR_AUTH_BEARER` at
+Tip: you can simply run `export DROPBOX_OAUTH_BEARER=YOUR_AUTH_BEARER` at
 the beginning of your work session so you don't need to prefix it in every
 command line.
 

data/Rakefile

@@ -1,7 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 require File.expand_path('../spec/support/rake_tasks', __FILE__)
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/TODO.md

@@ -1,10 +1,20 @@
-# Short term goals
+# Immediate
 
-- Update faraday version.
-- Review coverage document.
-- Pick some endpoints to cover.
+- 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).
 
-# Worth looking at
-- Add a layer to handle pagination, use `Enumerable`.
+# Dreaming
+
+- 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` | 🌕
@@ -68,7 +68,7 @@ API call | Status
 `/restore` | 🌕
 `/save_url` | 🌕
 `/save_url/check_job_status` | 🌕
-`/search` | 🌔
+`/search_v2` | 🌔
 `/upload` | 🌕
 `/upload_session/append` | alias?
 `/upload_session/append_v2` | 🌕
@@ -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/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "dropbox_api"
+require 'bundler/setup'
+require 'dropbox_api'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "dropbox_api"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/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.19
+  
+</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.17</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 Fri May 31 17:53:31 2019 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.19 (ruby-2.6.2).
+</div>
+
+    </div>
+  </body>
+</html>

data/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.19
+  
+</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 Fri May 31 17:53:32 2019 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.19 (ruby-2.6.2).
+</div>
+
+    </div>
+  </body>
+</html>