dropbox_api 0.1.18 → 0.1.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a3a1a2bc289cebba02099f33f564a26f5534a2103621f8533e1eec22fd12ad6
-  data.tar.gz: b1a9743de1947243db1a0cb17da1d410dcb61a9b196c80ed9fe5f8c617bb7067
+  metadata.gz: 9c59970ce358c1a706d47040336547ea3df770fe97194122011f5695d69a4bc9
+  data.tar.gz: caff55f6ba1ae50d6487450c2f12ac2df2a72a2cf3573ce6d8610664de404012
 SHA512:
-  metadata.gz: 5c691510ae44d46099d87cf75d822381fe006ae9b77f45b4c08a6f0d7b2db884c6fdf504acf2df930c344ee0b19b664b4fa6b726c15c21c7117452a8dfcd5c13
-  data.tar.gz: 047bb7cf238a161d4572d23b126c9ba50b35ffaf9a588a2846c613a5c4b317df11e94fb1c16f91a74d30093f37b8452d6ff15c5fbee46b7a2465b93dec28e4b5
+  metadata.gz: 7fc4add7446cec7d25627719dffa3b293173c7ce02356d514c7ac49f17673207da670d563e63ba0bf2690376beec98325ce84fbb6843f4bedab0ec6ff1b000b9
+  data.tar.gz: 4d2a098c291bc47d501ba90dcce05ae43e42ab77fa1c5fe8ad83d329aec3408d1ac987d2b931fbf25fe64a1f8c51584620306b06c32e9ebe7d5bf7c0a0efc6a1

data/.rubocop.yml

@@ -1,14 +1,15 @@
-inherit_from: .rubocop_todo.yml
+AllCops:
+  DisabledByDefault: true
 
 Style/HashSyntax:
   Enabled: true
-  EnforcedStyle: 'hash_rockets'
+  EnforcedStyle: 'ruby19'
 
-Style/ClassAndModuleChildren:
-  Enabled: false
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: always_true
 
-Style/Documentation:
-  Enabled: false
+Style/RedundantFreeze:
+  Enabled: true
 
-Naming/ConstantName:
-  Enabled: false
+Style/StringLiterals:
+  EnforcedStyle: single_quotes

data/.travis.yml

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

data/Gemfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 source 'https://rubygems.org'
 
 gemspec
@@ -5,9 +6,9 @@ gemspec
 group :development do
   # Documentation
   gem 'redcarpet'
-  gem 'yard-tests-rspec', :git => "https://github.com/Jesus/yard-spec-plugin.git"
+  gem 'yard-tests-rspec', git: 'https://github.com/Jesus/yard-spec-plugin.git'
 
   # Code linting
-  gem 'rubocop', :require => false
-  gem 'rubocop-rspec', :require => false
+  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/api_coverage.md

@@ -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` | 🌕

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/dropbox_api.gemspec

@@ -1,28 +1,29 @@
 # coding: utf-8
+# frozen_string_literal: true
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'dropbox_api/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "dropbox_api"
+  spec.name          = 'dropbox_api'
   spec.version       = DropboxApi::VERSION
-  spec.authors       = ["Jesús Burgos"]
-  spec.email         = ["jburmac@gmail.com"]
+  spec.authors       = ['Jesús Burgos']
+  spec.email         = ['jburmac@gmail.com']
 
-  spec.summary       = "Library for communicating with Dropbox API v2"
-  spec.homepage      = "https://github.com/Jesus/dropbox_api"
-  spec.license       = "MIT"
+  spec.summary       = 'Library for communicating with Dropbox API v2'
+  spec.homepage      = 'https://github.com/Jesus/dropbox_api'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
 
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", ">= 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "vcr"
-  spec.add_development_dependency "webmock"
+  spec.add_development_dependency 'bundler', '>= 1.7'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'webmock'
 
-  spec.add_dependency "faraday", "<= 1.0"
-  spec.add_dependency "oauth2", "~> 1.1"
+  spec.add_dependency 'faraday', '~> 1.0'
+  spec.add_dependency 'oauth2', '~> 1.1'
 end

data/lib/dropbox_api.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'dropbox_api/version'
 
 require 'time'
@@ -40,6 +41,16 @@ require 'dropbox_api/metadata/folder_sharing_info'
 require 'dropbox_api/metadata/folder'
 require 'dropbox_api/metadata/deleted'
 require 'dropbox_api/metadata/resource'
+require 'dropbox_api/metadata/metadata_v2'
+require 'dropbox_api/metadata/file_category'
+require 'dropbox_api/metadata/file_categories_list'
+require 'dropbox_api/metadata/file_extensions_list'
+require 'dropbox_api/metadata/search_order_by'
+require 'dropbox_api/metadata/file_status'
+require 'dropbox_api/metadata/search_options'
+require 'dropbox_api/metadata/search_match_type_v2'
+require 'dropbox_api/metadata/search_match_v2'
+require 'dropbox_api/metadata/search_match_field_options'
 require 'dropbox_api/metadata/shared_folder_policy'
 require 'dropbox_api/metadata/shared_folder'
 require 'dropbox_api/metadata/file_link_metadata'
@@ -125,8 +136,7 @@ require 'dropbox_api/results/list_folder_get_latest_cursor_result'
 require 'dropbox_api/results/list_shared_links_result'
 require 'dropbox_api/results/save_url_result'
 require 'dropbox_api/results/save_url_job_status'
-require 'dropbox_api/results/search/match'
-require 'dropbox_api/results/search_result'
+require 'dropbox_api/results/search_v2_result'
 require 'dropbox_api/results/share_folder_launch'
 require 'dropbox_api/results/shared_file_members'
 require 'dropbox_api/results/shared_folder_members'

data/lib/dropbox_api/authenticator.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'oauth2'
 
 module DropboxApi
@@ -6,8 +7,8 @@ module DropboxApi
 
     def initialize(client_id, client_secret)
       @auth_code = OAuth2::Client.new(client_id, client_secret, {
-        :authorize_url => 'https://www.dropbox.com/oauth2/authorize',
-        :token_url => 'https://api.dropboxapi.com/oauth2/token'
+        authorize_url: 'https://www.dropbox.com/oauth2/authorize',
+        token_url: 'https://api.dropboxapi.com/oauth2/token'
       }).auth_code
     end
 

data/lib/dropbox_api/chunked_uploader.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi
   class ChunkedUploader
     include DropboxApi::OptionsValidator
@@ -13,7 +14,7 @@ module DropboxApi
 
     def start
       chunk = @i_stream.read @chunk_size
-      chunk = "" if chunk.nil?
+      chunk = '' if chunk.nil?
 
       @cursor = @client.upload_session_start chunk
     end

data/lib/dropbox_api/client.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 module DropboxApi
   class Client
-    def initialize(oauth_bearer = ENV["DROPBOX_OAUTH_BEARER"])
+    def initialize(oauth_bearer = ENV['DROPBOX_OAUTH_BEARER'])
       @connection_builder = ConnectionBuilder.new(oauth_bearer)
     end
 

data/lib/dropbox_api/connection_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi
   class ConnectionBuilder
     def initialize(oauth_bearer)

data/lib/dropbox_api/endpoints/auth/token_revoke.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 module DropboxApi::Endpoints::Auth
   class TokenRevoke < DropboxApi::Endpoints::Rpc
     Method      = :post
-    Path        = "/2/auth/token/revoke".freeze
+    Path        = '/2/auth/token/revoke'
     ResultType  = DropboxApi::Results::VoidResult
     ErrorType   = nil
 

data/lib/dropbox_api/endpoints/base.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi::Endpoints
   class Base
     def self.add_endpoint(name, &block)
@@ -25,11 +26,11 @@ module DropboxApi::Endpoints
         build_result(raw_response.env[:api_result])
       when 429
         error = DropboxApi::Errors::TooManyRequestsError.build(
-          raw_response.env[:api_result]["error_summary"],
-          raw_response.env[:api_result]["error"]["reason"]
+          raw_response.env[:api_result]['error_summary'],
+          raw_response.env[:api_result]['error']['reason']
         )
 
-        error.retry_after = raw_response.headers["retry-after"].to_i
+        error.retry_after = raw_response.headers['retry-after'].to_i
 
         raise error
       else

data/lib/dropbox_api/endpoints/content_download.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 module DropboxApi::Endpoints
   class ContentDownload < DropboxApi::Endpoints::Base
     def initialize(builder)
-      @connection = builder.build("https://content.dropboxapi.com") do |c|
+      @connection = builder.build('https://content.dropboxapi.com') do |c|
         c.response :decode_result
       end
     end
@@ -20,14 +21,11 @@ module DropboxApi::Endpoints
       response = get_response(params)
       api_result = process_response response
 
-      # TODO: Stream response, current implementation will fail with very large
-      #       files.
+      # We just yield the whole response to the block, it'd be nice in the
+      # future to support an interface that streams the response in chunks.
       yield response.body if block_given?
 
       api_result
     end
   end
 end
-# TODO:
-#  1. Combine ContentDownload and ContentUpload to share its initialize method.
-#  2. Reorganize the methods which create the request.

data/lib/dropbox_api/endpoints/content_upload.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 module DropboxApi::Endpoints
   class ContentUpload < DropboxApi::Endpoints::Base
     def initialize(builder)
-      @connection = builder.build("https://content.dropboxapi.com") do |c|
+      @connection = builder.build('https://content.dropboxapi.com') do |c|
         c.response :decode_result
       end
     end

data/lib/dropbox_api/endpoints/file_requests/create_file_request.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 module DropboxApi::Endpoints::Files
   class CreateFileRequest < DropboxApi::Endpoints::Rpc
     Method      = :post
-    Path        = "/2/file_requests/create".freeze
+    Path        = '/2/file_requests/create'
     ResultType  = DropboxApi::Metadata::FileRequest
     ErrorType   = DropboxApi::Errors::CreateFileRequestError
 
@@ -13,8 +14,8 @@ module DropboxApi::Endpoints::Files
     #   this will be relative to the app folder.
     add_endpoint :create_file_request do |title, destination|
       perform_request({
-        :title => title,
-        :destination => destination
+        title: title,
+        destination: destination
       })
     end
   end

data/lib/dropbox_api/endpoints/files/copy.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 module DropboxApi::Endpoints::Files
   class Copy < DropboxApi::Endpoints::Rpc
     Method      = :post
-    Path        = "/2/files/copy".freeze
+    Path        = '/2/files/copy'
     ResultType  = DropboxApi::Metadata::Resource
     ErrorType   = DropboxApi::Errors::RelocationError
 
@@ -13,8 +14,8 @@ module DropboxApi::Endpoints::Files
     # @return The moved file.
     add_endpoint :copy do |from, to|
       perform_request({
-        :from_path => from,
-        :to_path => to
+        from_path: from,
+        to_path: to
       })
     end
   end

data/lib/dropbox_api/endpoints/files/copy_batch.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 module DropboxApi::Endpoints::Files
   class CopyBatch < DropboxApi::Endpoints::Rpc
     Method      = :post
-    Path        = "/2/files/copy_batch_v2".freeze
+    Path        = '/2/files/copy_batch_v2'
     ResultType  = DropboxApi::Results::CopyBatchResult
 
     include DropboxApi::OptionsValidator
@@ -28,7 +29,7 @@ module DropboxApi::Endpoints::Files
       options[:autorename] ||= false
 
       perform_request(options.merge({
-        :entries => entries
+        entries: entries
       }))
     end
   end

data/lib/dropbox_api/endpoints/files/copy_batch_check.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 module DropboxApi::Endpoints::Files
   class CopyBatchCheck < DropboxApi::Endpoints::Rpc
     Method      = :post
-    Path        = '/2/files/copy_batch/check_v2'.freeze
+    Path        = '/2/files/copy_batch/check_v2'
     ResultType  = DropboxApi::Results::RelocationBatchResult
     ErrorType   = DropboxApi::Errors::PollError
 
@@ -14,7 +15,7 @@ module DropboxApi::Endpoints::Files
     # @return [:in_progress, Array] This could be either the `:in_progress`
     #   flag or a list of job statuses.
     add_endpoint :copy_batch_check do |async_job_id|
-      perform_request :async_job_id => async_job_id
+      perform_request async_job_id: async_job_id
     end
   end
 end

data/lib/dropbox_api/endpoints/files/copy_reference_get.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 module DropboxApi::Endpoints::Files
   class CopyReferenceGet < DropboxApi::Endpoints::Rpc
     Method      = :post
-    Path        = "/2/files/copy_reference/get".freeze
+    Path        = '/2/files/copy_reference/get'
     ResultType  = DropboxApi::Results::GetCopyReferenceResult
     ErrorType   = DropboxApi::Errors::GetCopyReferenceError
 
@@ -14,7 +15,7 @@ module DropboxApi::Endpoints::Files
     # @return [DropboxApi::Results::GetCopyReferenceResult]
     add_endpoint :copy_reference_get do |path|
       perform_request({
-        :path => path
+        path: path
       })
     end
   end

data/lib/dropbox_api/endpoints/files/copy_reference_save.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 module DropboxApi::Endpoints::Files
   class CopyReferenceSave < DropboxApi::Endpoints::Rpc
     Method      = :post
-    Path        = "/2/files/copy_reference/save".freeze
+    Path        = '/2/files/copy_reference/save'
     ResultType  = DropboxApi::Results::SaveCopyReferenceResult
     ErrorType   = DropboxApi::Errors::SaveCopyReferenceError
 
@@ -14,8 +15,8 @@ module DropboxApi::Endpoints::Files
     # @return [DropboxApi::Results::SaveCopyReferenceResult]
     add_endpoint :copy_reference_save do |copy_reference, path|
       perform_request({
-        :copy_reference => copy_reference,
-        :path => path
+        copy_reference: copy_reference,
+        path: path
       })
     end
   end