dropbox-api-petems 0.4.2 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5579887689aae6d9cd0627331ed6bc316cf716db
+  data.tar.gz: 92ba58dd36d5563a5ef7ee365c39e58c7762ae4d
+SHA512:
+  metadata.gz: 899c18b56ef26a3a02e7f8aeb45be847926880b8a3a21e89db9b6c44367a08dd5c2627c7823fd9a994ef22f26ff309007a8a53de14cc5d1d1ccee29a953538ba
+  data.tar.gz: b4d6bc59570bf29e6dc2432840183181f73a5818b5255ee1539689d2439540ada2b49dc8fb7e18356cd0b62a991a7acb4bfd00a722698b920ecce8600fa9761b

data/.travis.yml

@@ -0,0 +1,5 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0

data/README.markdown

@@ -1,11 +1,11 @@
 Dropbox::API - Dropbox Ruby API client (PeteMS fork...)
 =========
 
-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:
@@ -85,19 +89,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:

data/Rakefile

@@ -1,4 +1,9 @@
 require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
 
 require "dropbox-api/tasks"
 Dropbox::API::Tasks.install

data/dropbox-api.gemspec

@@ -11,20 +11,21 @@ Gem::Specification.new do |s|
   s.summary     = "A Ruby client for the DropBox REST API (Originally by marcinbunsch, forked by petems)"
   s.description = "To deliver a more Rubyesque experience when using the DropBox API (forked by petems)."
 
-  s.rubyforge_project = "dropbox-api"
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
 
   s.add_dependency 'multi_json', '1.7.9'
   s.add_dependency 'oauth', '0.4.7'
   s.add_dependency 'hashie', '2.0.5'
+  s.add_dependency 'backports', '3.6.0'
 
   s.add_development_dependency 'rspec','2.14.1'
   s.add_development_dependency 'rake', '10.1.0'
-  s.add_development_dependency 'simplecov', '0.7.1'
-  s.add_development_dependency 'ruby-debug19', '0.11.6'
-  s.add_development_dependency 'yajl-ruby', '1.1.0'
+  s.add_development_dependency 'simplecov', '~> 0.8.2'
+  s.add_development_dependency 'yajl-ruby', '~> 1.2.0'
 
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
+  s.add_development_dependency 'webmock', '~> 1.15.0'
+  s.add_development_dependency 'vcr', '~> 2.8.0'
 end

data/lib/dropbox-api.rb

@@ -1,6 +1,7 @@
 require "oauth"
 require "multi_json"
 require "hashie"
+require 'backports'
 
 module Dropbox
   module API

data/lib/dropbox-api/objects/dir.rb

@@ -14,6 +14,11 @@ module Dropbox
         end
       end
 
+      def direct_url(options = {})
+        response = client.raw.shares({ :path => self.path, :short_url => false }.merge(options))
+        Dropbox::API::Object.init(response, client)
+      end
+
     end
 
   end

data/lib/dropbox-api/objects/file.rb

@@ -15,16 +15,6 @@ module Dropbox
         self.update response
       end
 
-      def share_url(options = {})
-        response = client.raw.shares({ :path => self.path }.merge(options))
-        Dropbox::API::Object.init(response, client)
-      end
-
-      def direct_url(options = {})
-        response = client.raw.media({ :path => self.path }.merge(options))
-        Dropbox::API::Object.init(response, client)
-      end
-
       def thumbnail(options = {})
         client.raw.thumbnails({ :path => self.path }.merge(options))
       end
@@ -38,6 +28,11 @@ module Dropbox
         client.download(self.path)
       end
 
+      def direct_url(options = {})
+        response = client.raw.media({ :path => self.path }.merge(options))
+        Dropbox::API::Object.init(response, client)
+      end
+
     end
 
   end

data/lib/dropbox-api/objects/fileops.rb

@@ -22,6 +22,11 @@ module Dropbox
         self['path'].sub(/^\//, '')
       end
 
+      def share_url(options = {})
+        response = client.raw.shares({ :path => self.path }.merge(options))
+        Dropbox::API::Object.init(response, client)
+      end
+
     end
 
   end

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 = "1.0.0"
   end
 end

data/spec/connection.offline.yml

@@ -0,0 +1,5 @@
+app_key: '4h2z7bkqpoxnrk5'    # CONSUMER KEY
+app_secret: 'jm01iazkteh0iox' # CONSUMER SECRET
+token: 'uaq3brdzaspkyyel'      # ACCESS TOKEN
+secret: 'ttg5h86znfxxfgf'   # ACCESS SECRET
+mode: 'dropbox'   # 'sandbox' or 'dropbox'

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

@@ -2,10 +2,9 @@
 require "spec_helper"
 require "tempfile"
 
-describe Dropbox::API::Client do
+describe Dropbox::API::Client, :vcr => true do
 
   before do
-    # pending
     @client = Dropbox::Spec.instance
   end
 
@@ -22,29 +21,22 @@ describe Dropbox::API::Client do
     it "retrieves the account object" do
       response = @client.account
       response.should be_an_instance_of(Dropbox::API::Object)
+      response.email.should eql 'testman@example.com'
     end
 
   end
 
   describe "#find" do
 
-    before do
-      @filename = "#{Dropbox::Spec.test_dir}/spec-find-file-test-#{Time.now.to_i}.txt"
-      @file = @client.upload @filename, "spec file"
-
-      @dirname = "#{Dropbox::Spec.test_dir}/spec-find-dir-test-#{Time.now.to_i}"
-      @dir = @client.mkdir @dirname
-    end
-
     it "returns a single file" do
-      response = @client.find(@filename)
-      response.path.should == @file.path
+      response = @client.find('baz.txt')
+      response.path.should == 'baz.txt'
       response.should be_an_instance_of(Dropbox::API::File)
     end
 
     it "returns a single directory" do
-      response = @client.find(@dirname)
-      response.path.should == @dir.path
+      response = @client.find('awesome-tests')
+      response.path.should == 'awesome-tests'
       response.should be_an_instance_of(Dropbox::API::Dir)
     end
 
@@ -52,16 +44,30 @@ describe Dropbox::API::Client do
 
   describe "#ls" do
 
-    it "returns an array of files and dirs" do
-      result = @client.ls
-      result.should be_an_instance_of(Array)
+    context "no value" do
+
+      it "returns an array of files and dirs" do
+        result = @client.ls
+        result.should be_an_instance_of(Array)
+      end
     end
 
-    it "returns a single item array of if we ls a file" do
-      result     = @client.ls(Dropbox::Spec.test_dir)
-      first_file = result.detect { |f| f.class == Dropbox::API::File }
-      result     = @client.ls first_file.path
-      result.should be_an_instance_of(Array)
+    context "a single file" do
+      it "returns a single item array of if we ls a file" do
+        result     = @client.ls('foo.txt')
+        first_file = result.detect { |f| f.class == Dropbox::API::File }
+        result     = @client.ls first_file.path
+        result.should be_an_instance_of(Array)
+      end
+    end
+
+    context "a directory" do
+      it "returns an item array of directory contents" do
+        result     = @client.ls('foo.txt')
+        first_file = result.detect { |f| f.class == Dropbox::API::File }
+        result     = @client.ls first_file.path
+        result.should be_an_instance_of(Array)
+      end
     end
 
   end
@@ -69,21 +75,21 @@ describe Dropbox::API::Client do
   describe "#mkdir" do
 
     it "returns an array of files and dirs" do
-      dirname  = "#{Dropbox::Spec.test_dir}/test-dir-#{Dropbox::Spec.namespace}"
+      dirname  = "awesome-tests"
       response = @client.mkdir dirname
       response.path.should == dirname
       response.should be_an_instance_of(Dropbox::API::Dir)
     end
 
     it "creates dirs with tricky characters" do
-      dirname  = "#{Dropbox::Spec.test_dir}/test-dir |!@\#$%^&*{b}[].;'.,<>?: #{Dropbox::Spec.namespace}"
+      dirname  = "awesome-tests-|!@\#$%^&*{b}[].;'.,<>?:"
       response = @client.mkdir dirname
       response.path.should == dirname.gsub(/[\\\:\?\*\<\>\"\|]+/, '')
       response.should be_an_instance_of(Dropbox::API::Dir)
     end
 
     it "creates dirs with utf8 characters" do
-      dirname  = "#{Dropbox::Spec.test_dir}/test-dir łółą #{Dropbox::Spec.namespace}"
+      dirname  = "awesome-tests-łółą"
       response = @client.mkdir dirname
       response.path.should == dirname
       response.should be_an_instance_of(Dropbox::API::Dir)
@@ -93,26 +99,33 @@ describe Dropbox::API::Client do
 
   describe "#upload" do
 
-    it "puts the file in dropbox" do
-      filename = "#{Dropbox::Spec.test_dir}/test-#{Dropbox::Spec.namespace}.txt"
-      response = @client.upload filename, "Some file"
-      response.path.should == filename
-      response.bytes.should == 9
+    context "a simple file" do
+      it "is uploaded" do
+        filename = "test.txt"
+        response = @client.upload filename, "Some file"
+        response.path.should == filename
+        response.bytes.should == 9
+      end
     end
 
-    it "uploads the file with tricky characters" do
-      filename = "#{Dropbox::Spec.test_dir}/test ,|!@\#$%^&*{b}[].;'.,<>?:-#{Dropbox::Spec.namespace}.txt"
-      response = @client.upload filename, "Some file"
-      response.path.should == filename
-      response.bytes.should == 9
+    context "a file with tricky characters" do
+      it "is uploaded" do
+        filename = "test ,|!@\#$%^&*{b}[].;'.,<>?:.txt"
+        response = @client.upload filename, "Some file"
+        response.path.should == filename
+        response.bytes.should == 9
+      end
     end
 
-    it "uploads the file with utf8" do
-      filename = "#{Dropbox::Spec.test_dir}/test łołąó-#{Dropbox::Spec.namespace}.txt"
-      response = @client.upload filename, "Some file"
-      response.path.should == filename
-      response.bytes.should == 9
+    context "a file with utf8" do
+      it "is uploaded" do
+        filename = "test łołąó.txt"
+        response = @client.upload filename, "Some file"
+        response.path.should == filename
+        response.bytes.should == 9
+      end
     end
+
   end
 
   describe "#chunked_upload" do
@@ -123,14 +136,18 @@ describe Dropbox::API::Client do
       @file = File.open(@filename, "w") {|f| f.write "a"*@size}
     end
 
-    it "puts a 5MB file in dropbox" do
+    it "puts a 5MB file in dropbox", :vcr => { :match_requests_on => [:host] } do
       filename = "#{Dropbox::Spec.test_dir}/test-5MB-#{Dropbox::Spec.namespace}.txt"
       response = @client.chunked_upload filename, File.open(@filename)
-      response.path.should == filename
+      if ENV['RECORDING'] == 'true'
+        response.path.should == filename
+      else
+        response.path.should == 'test-1410120674/test-5MB-1410120674.txt'
+      end
       response.bytes.should == @size
     end
 
-    it "yields current offset and upload id" do
+    it "yields current offset and upload id", :vcr => { :match_requests_on => [:host] } do
       filename = "#{Dropbox::Spec.test_dir}/test-yield-#{Dropbox::Spec.namespace}.txt"
       log_offset = ""
       log_upload = ""
@@ -140,7 +157,11 @@ describe Dropbox::API::Client do
         log_upload += upload.inspect
         upload[:upload_id].length.should eq(22)
       end
-      response.path.should == filename
+      if ENV['RECORDING'] == 'true'
+        response.path.should == filename
+      else
+        response.path.should == 'test-1410121457/test-yield-1410121457.txt'
+      end
       response.bytes.should == @size
       log_offset.should match(/[\d]{7},[\d]{7},/)
       log_upload.should include("Dropbox::API::Object","upload_id=")
@@ -154,24 +175,30 @@ describe Dropbox::API::Client do
 
   describe "#search" do
 
-    let(:term) { "searchable-test-#{Dropbox::Spec.namespace}" }
-
-    before do
-      filename = "#{Dropbox::Spec.test_dir}/searchable-test-#{Dropbox::Spec.namespace}.txt"
-      @client.upload filename, "Some file"
-    end
+    let(:term) { "foo.txt" }
 
     after do
       @response.size.should == 1
       @response.first.class.should == Dropbox::API::File
     end
 
-    it "finds a file" do
-      @response = @client.search term, :path => "#{Dropbox::Spec.test_dir}"
+    context "with path" do
+      it "finds a file" do
+        @response = @client.search term, :path => "awesome-tests"
+      end
+    end
+
+    context "path with leading slash" do
+      it "finds the file" do
+        @response = @client.search term, :path => "/awesome-tests"
+      end
+
     end
 
-    it "works if leading slash is present in path" do
-      @response = @client.search term, :path => "/#{Dropbox::Spec.test_dir}"
+    context "no path given" do
+      it "finds the file if in root" do
+        @response = @client.search term
+      end
     end
 
   end
@@ -179,12 +206,12 @@ describe Dropbox::API::Client do
   describe "#copy_from_copy_ref" do
 
     it "copies a file from a copy_ref" do
-      filename = "test/searchable-test-#{Dropbox::Spec.namespace}.txt"
+      filename = "test/searchable-test-100.txt"
       @client.upload filename, "Some file"
-      response = @client.search "searchable-test-#{Dropbox::Spec.namespace}", :path => 'test'
+      response = @client.search "searchable-test-100", :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-100.txt.copied", :path => 'test'
       response.size.should == 1
       response.first.class.should == Dropbox::API::File
     end
@@ -193,23 +220,24 @@ describe Dropbox::API::Client do
 
   describe "#download" do
 
-    it "downloads a file from Dropbox" do
-      @client.upload "#{Dropbox::Spec.test_dir}/test.txt", "Some file"
-      file = @client.download "#{Dropbox::Spec.test_dir}/test.txt"
-      file.should == "Some file"
+    context "a file" do
+      it "downloads a file" do
+        file = @client.download "awesome-tests/foo.txt"
+        file.should == "Some file"
+      end
     end
 
-    it "raises a 404 when a file is not found in Dropbox" do
-      lambda {
-        @client.download "#{Dropbox::Spec.test_dir}/no.txt"
-      }.should raise_error(Dropbox::API::Error::NotFound)
+    context "a non-existant file" do
+      it "raises a 404" do
+        expect { @client.download "awesome-tests/no.txt"}.to raise_error(Dropbox::API::Error::NotFound)
+      end
     end
 
   end
 
   describe "#delta" do
     it "returns a cursor and list of files" do
-      filename = "#{Dropbox::Spec.test_dir}/delta-test-#{Dropbox::Spec.namespace}.txt"
+      filename = "awesome-tests/delta-test-foo.txt"
       @client.upload filename, 'Some file'
       response = @client.delta
       cursor, files = response.cursor, response.entries
@@ -219,8 +247,8 @@ describe Dropbox::API::Client do
     end
 
     it "returns the files that have changed since the cursor was made" do
-      filename = "#{Dropbox::Spec.test_dir}/delta-test-#{Dropbox::Spec.namespace}.txt"
-      delete_filename = "#{Dropbox::Spec.test_dir}/delta-test-delete-#{Dropbox::Spec.namespace}.txt"
+      filename = "awesome-tests/delta-test-bar.txt"
+      delete_filename = "awesome-tests/delta-test-baz.txt"
       @client.upload delete_filename, 'Some file'
       response = @client.delta
       cursor, files = response.cursor, response.entries