dropbox_api 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5dde8e23c02270cb1b1cc29c059d03ae27b9160f
-  data.tar.gz: d398b3b9c4fc2edc3f190bea2a35e9dbaf4ae0fd
+  metadata.gz: a62250d1f36ff29c61f2afcd4090bf14413e96f1
+  data.tar.gz: 5e7ada2b458307e520178183156239dc3a65647f
 SHA512:
-  metadata.gz: 4f174851e2e863c779082a8d5fdfa39b46ac62effb31215514a01f0ed34d5bfabe33da4fd0a7df06b331c4999e8f3683c57e712757e1a49e31ced9176d7ad4cc
-  data.tar.gz: 28efd74cffc713594babe9a55318c447d541fad2ac5d8c1c3acde120b1f034fa16ecb6264c90545c9ef506e6daf6d3f26d7bdb95424c6193d5eea15771ad2a72
+  metadata.gz: 7b092abd284615e06589ebecadb8858f2cbb5b8bc0507a42a01b477fe90d07d6be89550b31ff30f5b626622c1ea12cf868d70ad1743d89e0ef45a23cfbc8fd1d
+  data.tar.gz: dfd330a56e1773929a6121947ef48f29974b134daf112fb7195cb74e3846a9c808066e4e436a3483f737c43c145fc3dc4e3ac52673a11201984da4f33aa504b3

data/.yardopts

@@ -2,6 +2,7 @@
 --plugin rspec
 lib/**/*.rb
 spec/endpoints/**/*_spec.rb
+spec/support/dropbox_scaffold_builder.rb
 --markup=markdown
 --markup-provider=redcarpet
 -

data/README.md

@@ -123,6 +123,39 @@ perform API calls. You can check the class' documentation to find
 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.
 
+### Testing
+
+I recommend you to use a test account other than your main one.
+
+We use VCR to record the HTTP calls to Dropbox, however we sometimes need to
+regenerate the cassettes. Let's take `list_folder` as an example to show what
+would be the procedure to do so:
+
+ 1. Manually delete the existing cassettes in
+    `spec/fixtures/vcr_cassettes/list_folder/*.yml`.
+
+ 2. Run the task to build the scaffolding in your Dropbox account so the tests
+    will pass. If it doesn't exist you may need to write it yourself, check
+    the `DropboxScaffoldBuilder` class to find all existing scaffold builders.
+
+    ```text
+    DROPBOX_OAUTH_BEARER=YOUR_AUTH_BEARER rake test:build_scaffold[list_folder]
+    ```
+
+ 3. Run the tests and the cassettes will be written:
+
+    ```text
+    DROPBOX_OAUTH_BEARER=YOUR_AUTH_BEARER rspec spec/endpoints/files/list_folder_spec.rb
+    ```
+
+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
+the beginning of your work session so you don't need to prefix it in every
+command line.
+
 ## Contributing
 
 Any help will be much appreciated. The easiest way to help is to implement one

data/TODO.md

@@ -7,7 +7,8 @@
 
 # Upcoming
 
-TOKEN: VofXAX8DO1sAAAAAAAAEEyqrmzbYmFVaDQKj48yVUfhyhfOomXiG8emqP1xQGRnJ
+TOKEN: f0QNQhb3tLAAAAAAAAAACtK5eS9DgRPDzDSLcrIrkbY07buAw-sMRP9tjZeoOP08
+Old token: VofXAX8DO1sAAAAAAAAEEyqrmzbYmFVaDQKj48yVUfhyhfOomXiG8emqP1xQGRnJ
 
 - Create website with comparison with other libraries.
 - Implement PermissionDeniedReason

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

@@ -13,8 +13,21 @@ module DropboxApi::Endpoints::Files
     #
     # A single request should not upload more than 150 MB of file contents.
     #
+    # Calling this method may update the cursor received. In particular, the
+    # offset variable will be increased to match the new position. This allows
+    # you to make subsequent calls to the endpoint using the same `cursor`, as
+    # you can see in the example.
+    #
+    # @example
+    #   # Rely on the offset position updated by `upload_session_append_v2`
+    #   client = DropboxApi::Client.new
+    #   cursor = client.upload_session_start('abc')      # cursor.offset => 3
+    #   client.upload_session_append_v2(cursor, 'def')   # cursor.offset => 6
+    #   client.upload_session_append_v2(cursor, 'ghi')   # cursor.offset => 9
+    #   client.upload_session_finish(...)
     # @param cursor [DropboxApi::Metadata::UploadSessionCursor] Contains the
-    #   upload session ID and the offset.
+    #   upload session ID and the offset. This cursor will have its offset
+    #   updated after a successful call.
     # @option options close [Boolean] If +true+, the current session will be
     #   closed, at which point you won't be able to call
     #   {Client#upload_session_append_v2} anymore with the current session.
@@ -28,6 +41,8 @@ module DropboxApi::Endpoints::Files
       perform_request(options.merge({
         :cursor => cursor.to_hash
       }), content)
+
+      cursor.offset += content.bytesize
     end
   end
 end

data/lib/dropbox_api/metadata/upload_session_cursor.rb

@@ -7,5 +7,9 @@ module DropboxApi::Metadata
   class UploadSessionCursor < Base
     field :session_id, String
     field :offset, Integer
+
+    def offset=(n)
+      self[:offset] = n
+    end
   end
 end

data/lib/dropbox_api/version.rb

@@ -1,3 +1,3 @@
 module DropboxApi
-  VERSION = '0.1.7'.freeze
+  VERSION = '0.1.8'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dropbox_api
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Jesús Burgos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-10 00:00:00.000000000 Z
+date: 2017-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -306,7 +306,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Library for communicating with Dropbox API v2