dropbox-api 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e1474a34de5bf86752d2a0fc373aa9d556e80cc6
-  data.tar.gz: dc33512fa9132a5e9c12f36156328294309f2cb5
+  metadata.gz: 5c1d8914b2294e4ca594597d1d20589822ab8357
+  data.tar.gz: 1523fde081a4a3dc3a9d7b9a1db40f2d52d8ab26
 SHA512:
-  metadata.gz: ece9abc626bfcd3f8920614b8db8de0ead7004713e33c80190ae34b47f20740ea5d9800d3fb4abb19202b1712ba2b07a5a5a3118b690dba3971056119c41b215
-  data.tar.gz: 9ec8f8012d2a3b3967fa2d1973b9eb9dfc317abfb3f515439ed7ba3c1609468e6e365758ae2ccba5789dff1bd7855030c9e3067fbfbb94274ee290e97047a5fb
+  metadata.gz: f276d9a4e2684036681843c7eb62b46b374a745d3feb978714388510b52d2e5e12615dca50ff373f7b248a04bca314cd2f6e106a16757a841be1811d006fe14c
+  data.tar.gz: db0295a231b0cbc0ec80e26ff5c8fe7400d0b79e42842b0a7add9e2e1c0b5c4dfc7f5bbd2b18ff396e56f5b8f55d17d5abeb10f03d683020c73169fb9f21bf8c

data/Gemfile

@@ -1,10 +1,4 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in dropbox-api.gemspec
-gemspec
-
-gem "rspec"
-gem "rake"
-gem 'simplecov'
-gem "ruby-debug19"
-gem "yajl-ruby"
+gemspec

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2011 Marcin Bunsch, Future Simple Inc.
+Copyright (c) 2011-2014 Marcin Bunsch, Future Simple Inc.
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation
@@ -19,4 +19,4 @@ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
-OTHER DEALINGS IN THE SOFTWARE.
+OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -1,11 +1,11 @@
 Dropbox::API - Dropbox Ruby API client
 =========
 
-A Ruby client for the DropBox REST API.
+A Ruby client for the Dropbox REST API.
 
 Goal:
 
-To deliver a more Rubyesque experience when using the DropBox API.
+To deliver a more Rubyesque experience when using the Dropbox API.
 
 Current state:
 
@@ -14,11 +14,11 @@ First release, whole API covered.
 Important!!!
 ------------
 
-From version 0.2.0, Dropbox::API::File#delete and Dropbox::API::Dir#delete *are gone*!!
+From version 0.2.0, `Dropbox::API::File#delete` and `Dropbox::API::Dir#delete` *are gone*!!
 
 The reason is that it's based on Hashie::Mash and was screwing Hash#delete.
 
-It is replaced with Dropbox::API::File#destroy and Dropbox::API::Dir#destroy.
+It is replaced with `Dropbox::API::File#destroy` and `Dropbox::API::Dir#destroy`.
 
 Installation
 ------------
@@ -43,9 +43,10 @@ In order to use this client, you need to have an app created on https://www.drop
 Once you have it, put this configuration somewhere in your code, before you start working with the client.
 
 ```ruby
-Dropbox::API::Config.app_key    = YOUR_APP_TOKEN
+Dropbox::API::Config.app_key    = YOUR_APP_KEY
 Dropbox::API::Config.app_secret = YOUR_APP_SECRET
-Dropbox::API::Config.mode       = "sandbox" # if you have a single-directory app or "dropbox" if it has access to the whole dropbox
+Dropbox::API::Config.mode       = "sandbox" # if you have a single-directory app
+# Dropbox::API::Config.mode       = "dropbox" # if your app has access to the whole dropbox
 ```
 
 Dropbox::API::Client
@@ -54,6 +55,9 @@ Dropbox::API::Client
 The client is the base for all communication with the API and wraps around almost all calls
 available in the API.
 
+Web-based Authorization
+-----------------------
+
 In order to create a Dropbox::API::Client object, you need to have the configuration set up for OAuth.
 Second thing you need is to have the user authorize your app using OAuth. Here's a short intro
 on how to do this:
@@ -66,9 +70,11 @@ session[:token] = request_token.token
 session[:token_secret] = request_token.secret
 request_token.authorize_url(:oauth_callback => 'http://yoursite.com/callback')
 # Here the user goes to Dropbox, authorizes the app and is redirected
+# This would be typically run in a Rails controller
 hash = { oauth_token: session[:token], oauth_token_secret: session[:token_secret]}
 request_token  = OAuth::RequestToken.from_hash(consumer, hash)
-result = request_token.get_access_token(:oauth_verifier => oauth_token)
+oauth_verifier = params[:oauth_verifier]
+result = request_token.get_access_token(:oauth_verifier => oauth_verifier)
 ```
 
 Now that you have the oauth token and secret, you can create a new instance of the Dropbox::API::Client, like this:
@@ -85,19 +91,20 @@ Dropbox::API supplies you with a helper rake which will authorize a single clien
 In order to have this rake available, put this on your Rakefile:
 
 ```ruby
+require "dropbox-api"
 require "dropbox-api/tasks"
 Dropbox::API::Tasks.install
 ```
 
 You will notice that you have a new rake task - dropbox:authorize
 
-When you call this Rake task, it will ask you to provide the consumer key and secret. Afterwards it will present you with an authorize url on Dropbox.
+When you call this Rake task, it will ask you to provide the app key and app secret. Afterwards it will present you with an authorize url on Dropbox.
 
 Simply go to that url, authorize the app, then press enter in the console.
 
 The rake task will output valid ruby code which you can use to create a client.
 
-What differs this from the DropBox Ruby SDK?
+What differs this from the Dropbox Ruby SDK?
 --------------------------------------------
 
 A few things:
@@ -240,6 +247,15 @@ delta.cursor # => 'abc123'
 delta.entries # => [#<Dropbox::API::File>, #<Dropbox::API::Dir>]
 ```
 
+Optionally, you can set additional parameters, e.g. **path_prefix**. You can find all available parameters in the [Dropbox API documentation](https://www.dropbox.com/developers/core/docs#delta).
+
+```ruby
+delta = client.delta 'abc123', path_prefix: '/Path/To/My/Folder'
+delta.cursor # => 'abc123'
+delta.entries # => [#<Dropbox::API::File>, #<Dropbox::API::Dir>]
+```
+
+
 Dropbox::API::File and Dropbox::API::Dir methods
 ----------------------------
 

data/dropbox-api.gemspec

@@ -8,14 +8,24 @@ Gem::Specification.new do |s|
   s.authors     = ["Marcin Bunsch"]
   s.email       = ["marcin@futuresimple.com"]
   s.homepage    = "http://github.com/futuresimple/dropbox-api"
-  s.summary     = "A Ruby client for the DropBox REST API."
-  s.description = "To deliver a more Rubyesque experience when using the DropBox API."
+  s.summary     = "A Ruby client for the Dropbox REST API."
+  s.description = "To deliver a more Rubyesque experience when using the Dropbox API."
+  s.license     = 'MIT'
 
   s.rubyforge_project = "dropbox-api"
 
-  s.add_dependency 'multi_json'
-  s.add_dependency 'oauth'
-  s.add_dependency 'hashie'
+  s.add_dependency 'multi_json', '~> 1.7.9'
+  s.add_dependency 'oauth', '~> 0.4.7'
+  s.add_dependency 'hashie', '~> 2.0.5'
+
+  s.add_development_dependency 'rspec','2.14.1'
+  s.add_development_dependency 'rake', '10.1.0'
+  s.add_development_dependency 'simplecov', '~> 0.8.2'
+  s.add_development_dependency 'yajl-ruby', '~> 1.2.0'
+
+  if RUBY_VERSION < "1.9"
+    s.add_development_dependency 'ruby-debug19' 
+  end
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/dropbox-api/client.rb

@@ -44,10 +44,10 @@ module Dropbox
         Dropbox::API::Object.convert(results, self)
       end
 
-      def delta(cursor=nil)
+      def delta(cursor=nil, options={})
         entries  = []
         has_more = true
-        params   = cursor ? {:cursor => cursor} : {}
+        params   = cursor ? options.merge(:cursor => cursor) : options
         while has_more
           response        = raw.delta(params)
           params[:cursor] = response['cursor']

data/lib/dropbox-api/tasks.rb

@@ -12,9 +12,9 @@ module Dropbox
           task :authorize do
             require "dropbox-api"
             require "cgi"
-            print "Enter consumer key: "
+            print "Enter dropbox app key: "
             consumer_key = $stdin.gets.chomp
-            print "Enter consumer secret: "
+            print "Enter dropbox app secret: "
             consumer_secret = $stdin.gets.chomp
 
             Dropbox::API::Config.app_key    = consumer_key

data/lib/dropbox-api/version.rb

@@ -1,5 +1,5 @@
 module Dropbox
   module API
-    VERSION = "0.4.2"
+    VERSION = "0.4.3"
   end
 end

data/spec/lib/dropbox-api/client_spec.rb

@@ -143,10 +143,10 @@ describe Dropbox::API::Client do
     it "copies a file from a copy_ref" do
       filename = "test/searchable-test-#{Dropbox::Spec.namespace}.txt"
       @client.upload filename, "Some file"
-      response = @client.search "searchable-test-#{Dropbox::Spec.namespace}", :path => 'test'      
+      response = @client.search "searchable-test-#{Dropbox::Spec.namespace}", :path => 'test'
       ref = response.first.copy_ref['copy_ref']
       @client.copy_from_copy_ref ref, "#{filename}.copied"
-      response = @client.search "searchable-test-#{Dropbox::Spec.namespace}.txt.copied", :path => 'test'   
+      response = @client.search "searchable-test-#{Dropbox::Spec.namespace}.txt.copied", :path => 'test'
       response.size.should == 1
       response.first.class.should == Dropbox::API::File
     end
@@ -196,6 +196,28 @@ describe Dropbox::API::Client do
       files.first.path.should == delete_filename
       files.last.path.should == filename
     end
+
+    context "with extra params" do
+
+      let(:response) do
+        {
+          'cursor' => nil,
+          'has_more' => false,
+          'entries' => []
+        }
+      end
+
+      let(:params) do
+        { :path_prefix => 'my_path' }
+
+      end
+
+      it "passes them to raw delta" do
+        @client.raw.should_receive(:delta).with(params).and_return(response)
+        @client.delta nil, params
+      end
+
+    end
   end
 
 end

data/spec/lib/dropbox-api/file_spec.rb

@@ -21,7 +21,7 @@ describe Dropbox::API::File do
     end
 
   end
-  
+
   describe "#move" do
 
     it "moves the file properly" do
@@ -85,22 +85,22 @@ describe Dropbox::API::File do
 
       result = @file.share_url
       result.should be_an_instance_of(Dropbox::API::Object)
-      result.keys.sort.should == ['expires', 'url']
+      result.keys.sort.should == ['expires', 'url', 'visibility']
 
     end
 
   end
 
   describe "#copy_ref" do
-    
+
     it "returns a copy_ref object" do
-      
+
       result = @file.copy_ref
       result.should be_an_instance_of(Dropbox::API::Object)
       result.keys.sort.should == ['copy_ref', 'expires']
-      
+
     end
-    
+
   end
 
   describe "#direct_url" do

metadata

@@ -1,66 +1,122 @@
 --- !ruby/object:Gem::Specification
 name: dropbox-api
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - Marcin Bunsch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-10 00:00:00.000000000 Z
+date: 2014-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.7.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.7.9
 - !ruby/object:Gem::Dependency
   name: oauth
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.4.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.4.7
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: To deliver a more Rubyesque experience when using the DropBox API.
+        version: 2.0.5
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+description: To deliver a more Rubyesque experience when using the Dropbox API.
 email:
 - marcin@futuresimple.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
 - Gemfile
 - LICENSE
 - README.markdown
@@ -95,7 +151,8 @@ files:
 - spec/support/config.rb
 - spec/support/jpeg.rb
 homepage: http://github.com/futuresimple/dropbox-api
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -103,20 +160,20 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: dropbox-api
-rubygems_version: 2.0.5
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: A Ruby client for the DropBox REST API.
+summary: A Ruby client for the Dropbox REST API.
 test_files:
 - spec/connection.sample.yml
 - spec/fixtures/dropbox.jpg
@@ -129,4 +186,3 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/config.rb
 - spec/support/jpeg.rb
-has_rdoc: