dropbox_api 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c0eede08a0f815d30642620662824beb4772cd27
-  data.tar.gz: ffcd6a73b9f84613db886767ea931d86c23189b4
+  metadata.gz: 7b389b70a2387d0fdb49c3fdb6f2eee7f668c8a6
+  data.tar.gz: d3e52de1f131820d0bef5ceef1317d3e27f87bf7
 SHA512:
-  metadata.gz: 9135f8db610192f4ec44b63b9133a61d06d0610f8c070732f8164e00f27ecb2a68c27b5aaf2b1092c44cb97cff980aaa2afca322146cbc07b9f6d86afff1a8c3
-  data.tar.gz: cc47310f7f6007517a1074137c5872c51c4f8da491f1ef09391c7a7d3678ae102e37c336af9cdaeddcb6f39da1601363b4f4f25ebf5c71285422f73086543d0c
+  metadata.gz: 3a6069d423d4a9166875aaaa13d7a10147eddc28035eaa46e330bf63e05ed9c88d3397ca42085a1135aaccf12f7059cb3f8b27ae5fa8af000c3e0085e3e2873f
+  data.tar.gz: 5a589ff7f10403e2dca274742b2e22f27f1ab370094f47168f6f16b543b569d92b0dd8da40e45cb33043b74a6319a4caa1eabbba098a190ce0047372ad25b59b

data/.yardopts

@@ -1,8 +1,9 @@
---load yardoc/endpoint_handler.rb
---load yardoc/rspec.rb
---load yardoc/helpers/html_helper.rb
+--load ./yardoc/endpoint_handler.rb
+--plugin rspec
 lib/**/*.rb
 spec/endpoints/**/*_spec.rb
+--markup=markdown
+--markup-provider=redcarpet
 -
 api_coverage.md
 rails_setup.md

data/Gemfile

@@ -1,3 +1,7 @@
 source 'https://rubygems.org'
 
 gemspec
+
+# Documentation
+gem 'yard-rspec', :git => "https://github.com/Jesus/yard-spec-plugin.git"
+gem 'redcarpet'

data/README.md

@@ -18,7 +18,23 @@ Or install it yourself as:
 
     $ gem install dropbox_api
 
-## Usage
+## Documentation
+
+Please, refer to this gem's custom [Dropbox API
+documentation](http://jesus.github.io/dropbox_api).
+Most of the time you'll be checking the [available
+endpoints](http://jesus.github.io/dropbox_api/DropboxApi/Client.html).
+
+Unfortunately, the documentation at [RubyDoc.info](http://www.rubydoc.info) is
+disrecommended because it lacks some nice features that have been added with
+YARD plugins:
+
+- Each endpoint includes its tests right below the description, this works as
+  an example of its usage.
+- All endpoints are shown as methods of the `Client` class, just as you will
+  use them.
+
+## Basic set up
 
 ### Authorize your application
 
@@ -76,7 +92,7 @@ Dropbox's [OAuth guide]
 (https://www.dropbox.com/developers/reference/oauth-guide#oauth-2-on-the-web).
 
 If you have a Rails application, you might be interested in this [setup
-guide](http://www.rubydoc.info/gems/dropbox_api/file/rails_setup.md).
+guide](http://jesus.github.io/dropbox_api/file.rails_setup.html).
 
 ### Performing API calls
 
@@ -100,32 +116,17 @@ result.has_more?
 
 The instance of `Client` we've initialized is the one you'll be using to
 perform API calls. You can check the class' documentation to find
-[all available endpoints]
-(http://www.rubydoc.info/gems/dropbox_api/DropboxApi/Client)
-
-## Dependencies
-
-### Network adapter
-
-This gem uses [faraday](https://github.com/lostisland/faraday#faraday).
-So it should work on any network library.
+[all available endpoints](http://jesus.github.io/dropbox_api/DropboxApi/Client.html)
 
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run
 `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To
-release a new version, update the version number in `version.rb`, and then run
-`bundle exec rake release` to create a git tag for the version, push git
-commits and tags, and push the `.gem` file to
-[rubygems.org](https://rubygems.org).
-
 ## Contributing
 
 Any help will be much appreciated. The easiest way to help is to implement one
-or more of the [endpoints that are still pending]
-(http://www.rubydoc.info/gems/dropbox_api/file/api_coverage.md). To see how the
+or more of the [endpoints that are still pending](http://jesus.github.io/dropbox_api/file.api_coverage.html). To see how the
 endpoints are implemented, check out the `lib/dropbox_api/endpoints` folder.
 
 If you want to help but you're unsure how to get started, please get in touch

data/Rakefile

@@ -1,5 +1,6 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require File.expand_path('../spec/support/rake_tasks', __FILE__)
 
 RSpec::Core::RakeTask.new(:spec)
 

data/TODO.md

@@ -1,3 +1,8 @@
+# TODO now!
+
+- Rebuild spec fixtures for `list_folder`.
+- Add documentation on how to rebuild spec fixtures.
+
 # Upcoming
 
 TOKEN: VofXAX8DO1sAAAAAAAAEEyqrmzbYmFVaDQKj48yVUfhyhfOomXiG8emqP1xQGRnJ
@@ -24,8 +29,6 @@ TOKEN: VofXAX8DO1sAAAAAAAAEEyqrmzbYmFVaDQKj48yVUfhyhfOomXiG8emqP1xQGRnJ
 
 # Further on
 
-- Improve the  API reference page, help here:
-  http://gnuu.org/2009/11/18/customizing-yard-templates/
 - Supporting streams would be great.
 - Add a layer to handle pagination, use `Enumerable`.
 
@@ -40,3 +43,7 @@ Release process:
 3. `git fetch`
 4. `gem build dropbox_api.gemspec`
 5. `gem push dropbox_api-version.gem`
+
+## Publish doc
+
+1.

data/api_coverage.md

@@ -89,7 +89,7 @@ API call | Status
 `/share_folder` | 🌕
 `/transfer_folder` | 🌑
 `/unmount_folder` | 🌑
-`/unshare_file` | 🌑
+`/unshare_file` | 🌕
 `/unshare_folder` | 🌑
 `/update_folder_member` | 🌑
 `/update_folder_policy` | 🌑

data/lib/dropbox_api.rb

@@ -78,6 +78,7 @@ require 'dropbox_api/errors/upload_session_lookup_error'
 require 'dropbox_api/errors/upload_session_finish_error'
 require 'dropbox_api/errors/upload_write_failed_error'
 require 'dropbox_api/errors/upload_error'
+require 'dropbox_api/errors/unshare_file_error'
 require 'dropbox_api/errors/poll_error'
 require 'dropbox_api/errors/add_file_member_error'
 require 'dropbox_api/errors/add_folder_member_error'
@@ -140,6 +141,7 @@ require 'dropbox_api/endpoints/sharing/list_folder_members'
 require 'dropbox_api/endpoints/sharing/share_folder'
 require 'dropbox_api/endpoints/sharing/list_shared_links'
 require 'dropbox_api/endpoints/sharing/create_shared_link_with_settings'
+require 'dropbox_api/endpoints/sharing/unshare_file'
 require 'dropbox_api/endpoints/users/get_account'
 require 'dropbox_api/endpoints/users/get_account_batch'
 require 'dropbox_api/endpoints/users/get_current_account'

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

@@ -31,7 +31,7 @@ module DropboxApi::Endpoints::Files
 
       DropboxApi::Metadata::UploadSessionCursor.new({
         "session_id" => session.session_id,
-        "offset" => content.size
+        "offset" => content.bytesize
       })
     end
   end

data/lib/dropbox_api/endpoints/sharing/unshare_file.rb

@@ -0,0 +1,19 @@
+module DropboxApi::Endpoints::Sharing
+  class UnshareFile < DropboxApi::Endpoints::Rpc
+    Method      = :post
+    Path        = "/2/sharing/unshare_file".freeze
+    ResultType  = DropboxApi::Results::VoidResult
+    ErrorType   = DropboxApi::Errors::UnshareFileError
+
+    # Remove all members from this file. Does not remove inherited members.
+    #
+    # A successful response indicates that the file was unshared.
+    #
+    # @param file [String] Path or ID of the file in the user's Dropbox to unshare.
+    add_endpoint :unshare_file do |file|
+      perform_request({
+        :file => file
+      })
+    end
+  end
+end

data/lib/dropbox_api/errors/unshare_file_error.rb

@@ -0,0 +1,8 @@
+module DropboxApi::Errors
+  class UnshareFileError < BasicError
+    ErrorSubtypes = {
+      :user_error => SharingUserError,
+      :access_error => SharingFileAccessError
+    }.freeze
+  end
+end

data/lib/dropbox_api/metadata/file.rb

@@ -25,6 +25,7 @@ module DropboxApi::Metadata
     field :server_modified, Time
     field :rev, String
     field :size, Integer
+    field :content_hash, String, :optional
 
     def to_hash
       super.merge(".tag" => "file")

data/lib/dropbox_api/version.rb

@@ -1,3 +1,3 @@
 module DropboxApi
-  VERSION = '0.1.5'.freeze
+  VERSION = '0.1.6'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dropbox_api
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Jesús Burgos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-14 00:00:00.000000000 Z
+date: 2017-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -173,6 +173,7 @@ files:
 - lib/dropbox_api/endpoints/sharing/list_folder_members.rb
 - lib/dropbox_api/endpoints/sharing/list_shared_links.rb
 - lib/dropbox_api/endpoints/sharing/share_folder.rb
+- lib/dropbox_api/endpoints/sharing/unshare_file.rb
 - lib/dropbox_api/endpoints/users/get_account.rb
 - lib/dropbox_api/endpoints/users/get_account_batch.rb
 - lib/dropbox_api/endpoints/users/get_current_account.rb
@@ -209,6 +210,7 @@ files:
 - lib/dropbox_api/errors/sharing_file_access_error.rb
 - lib/dropbox_api/errors/sharing_user_error.rb
 - lib/dropbox_api/errors/too_many_requests_error.rb
+- lib/dropbox_api/errors/unshare_file_error.rb
 - lib/dropbox_api/errors/upload_error.rb
 - lib/dropbox_api/errors/upload_session_finish_error.rb
 - lib/dropbox_api/errors/upload_session_lookup_error.rb