dropbox-api-kilgore5 0.3.3

data/lib/dropbox-api/util/config.rb

@@ -0,0 +1,29 @@
+module Dropbox
+  module API
+
+    module Config
+
+      class << self
+        attr_accessor :endpoints
+        attr_accessor :prefix
+        attr_accessor :app_key
+        attr_accessor :app_secret
+        attr_accessor :mode
+        attr_accessor :app_name
+      end
+
+      self.endpoints = {
+        :main      => "https://api.dropbox.com",
+        :content   => "https://api-content.dropbox.com",
+        :authorize => "https://www.dropbox.com"
+      }
+      self.prefix     = "/1"
+      self.app_key    = nil
+      self.app_secret = nil
+      self.mode       = 'sandbox'
+      self.app_name   = nil
+
+    end
+
+  end
+end

data/lib/dropbox-api/util/error.rb

@@ -0,0 +1,17 @@
+module Dropbox
+  module API
+
+    class Error < Exception
+
+      class ConnectionFailed < Exception; end
+      class Config < Exception; end
+      class Unauthorized < Exception; end
+      class Forbidden < Exception; end
+      class NotFound < Exception; end
+      class NotModified < Exception; end
+      class Redirect < Exception; end
+
+    end
+
+  end
+end

data/lib/dropbox-api/util/oauth.rb

@@ -0,0 +1,29 @@
+module Dropbox
+  module API
+
+    module OAuth
+
+      class << self
+
+        def consumer(endpoint)
+          if !Dropbox::API::Config.app_key or !Dropbox::API::Config.app_secret
+            raise Dropbox::API::Error::Config.new("app_key or app_secret not provided")
+          end
+          ::OAuth::Consumer.new(Dropbox::API::Config.app_key, Dropbox::API::Config.app_secret,
+            :site => Dropbox::API::Config.endpoints[endpoint],
+            :request_token_path => Dropbox::API::Config.prefix + "/oauth/request_token",
+            :authorize_path     => Dropbox::API::Config.prefix + "/oauth/authorize",
+            :access_token_path  => Dropbox::API::Config.prefix + "/oauth/access_token")
+        end
+
+        def access_token(consumer, options = {})
+          ::OAuth::AccessToken.new(consumer, options[:token], options[:secret])
+        end
+
+      end
+
+    end
+
+  end
+end
+

data/lib/dropbox-api/util/response.rb

@@ -0,0 +1,8 @@
+module Dropbox
+  module API
+    class Response
+      class NotModified  
+      end
+    end
+  end
+end

data/lib/dropbox-api/util/util.rb

@@ -0,0 +1,27 @@
+module Dropbox
+  module API
+
+    module Util
+
+      class << self
+
+        def escape(string)
+          string.gsub(/([^ a-zA-Z0-9\.\\\-\/\_]+)/) do
+            '%' + $1.unpack('H2' * $1.bytesize).join('%').upcase
+          end.gsub(' ', '%20')
+        end
+
+        def query(data)
+          data.inject([]) { |memo, entry| memo.push(entry.join('=')); memo }.join('&')
+        end
+
+        def remove_double_slashes(path)
+          path.gsub('//', '/')
+        end
+
+      end
+
+    end
+
+  end
+end

data/lib/dropbox-api/version.rb

@@ -0,0 +1,5 @@
+module Dropbox
+  module API
+    VERSION = "0.3.3"
+  end
+end

data/spec/connection.sample.yml

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

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

@@ -0,0 +1,201 @@
+# encoding: utf-8
+require "spec_helper"
+
+describe Dropbox::API::Client do
+
+  before do
+    # pending
+    @client = Dropbox::Spec.instance
+  end
+
+  describe "#initialize" do
+
+    it "has a handle to the connection" do
+      @client.connection.should be_an_instance_of(Dropbox::API::Connection)
+    end
+
+  end
+
+  describe "#account" do
+
+    it "retrieves the account object" do
+      response = @client.account
+      response.should be_an_instance_of(Dropbox::API::Object)
+    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.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.should be_an_instance_of(Dropbox::API::Dir)
+    end
+
+  end
+
+  describe "#ls" do
+
+    it "returns an array of files and dirs" do
+      result = @client.ls
+      result.should be_an_instance_of(Array)
+    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)
+    end
+
+  end
+
+  describe "#mkdir" do
+
+    it "returns an array of files and dirs" do
+      dirname  = "#{Dropbox::Spec.test_dir}/test-dir-#{Dropbox::Spec.namespace}"
+      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}"
+      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}"
+      response = @client.mkdir dirname
+      response.path.should == dirname
+      response.should be_an_instance_of(Dropbox::API::Dir)
+    end
+
+  end
+
+  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
+    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
+    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
+    end
+  end
+
+  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
+
+    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}"
+    end
+
+    it "works if leading slash is present in path" do
+      @response = @client.search term, :path => "/#{Dropbox::Spec.test_dir}"
+    end
+
+  end
+
+  describe "#copy_from_copy_ref" 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'      
+      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.size.should == 1
+      response.first.class.should == Dropbox::API::File
+    end
+
+  end
+
+  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"
+    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)
+    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"
+      @client.upload filename, 'Some file'
+      response = @client.delta
+      cursor, files = response.cursor, response.entries
+      cursor.should be_an_instance_of(String)
+      files.should be_an_instance_of(Array)
+      files.last.should be_an_instance_of(Dropbox::API::File)
+    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"
+      @client.upload delete_filename, 'Some file'
+      response = @client.delta
+      cursor, files = response.cursor, response.entries
+      files.last.path.should == delete_filename
+      files.last.destroy
+      @client.upload filename, 'Another file'
+      response = @client.delta(cursor)
+      cursor, files = response.cursor, response.entries
+      files.length.should == 2
+      files.first.is_deleted.should == true
+      files.first.path.should == delete_filename
+      files.last.path.should == filename
+    end
+  end
+
+end

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

@@ -0,0 +1,82 @@
+require "spec_helper"
+
+describe Dropbox::API::Connection do
+
+  before do
+    @connection = Dropbox::API::Connection.new(:token  => Dropbox::Spec.token,
+                                               :secret => Dropbox::Spec.secret)
+  end
+
+  describe "#request" do
+
+    it "returns a parsed response when the response is a 200" do
+      response = mock :code => 200, :body => '{ "a":1}'
+      response = @connection.request { response }
+      response.should be_an_instance_of(Hash)
+    end
+
+    it "raises a Dropbox::API::Error::Unauthorized when the response is a 401" do
+      response = mock :code => 401, :body => '{ "a":1}'
+      lambda do
+        @connection.request { response }
+      end.should raise_error(Dropbox::API::Error::Unauthorized)
+    end
+
+    it "raises a Dropbox::API::Error::Forbidden when the response is a 403" do
+      response = mock :code => 403, :body => '{ "a":1}'
+      lambda do
+        @connection.request { response }
+      end.should raise_error(Dropbox::API::Error::Forbidden)
+    end
+
+    it "raises a Dropbox::API::Error::NotFound when the response is a 404" do
+      response = mock :code => 404, :body => '{ "a":1}'
+      lambda do
+        @connection.request { response }
+      end.should raise_error(Dropbox::API::Error::NotFound)
+    end
+
+    it "raises a Dropbox::API::Error when the response is a 3xx" do
+      response = mock :code => 301, :body => '{ "a":1}'
+      lambda do
+        @connection.request { response }
+      end.should raise_error(Dropbox::API::Error::Redirect)
+    end
+
+    it "raises a Dropbox::API::Error when the response is a 5xx" do
+      response = mock :code => 500, :body => '{ "a":1}'
+      lambda do
+        @connection.request { response }
+      end.should raise_error(Dropbox::API::Error)
+    end
+
+    it "raises a Dropbox::API::Error when the response is a 400" do
+      response = mock :code => 400, :body => '{ "error": "bad request" }'
+      lambda do
+        @connection.request { response }
+      end.should raise_error(Dropbox::API::Error)
+    end
+
+    it "raises a Dropbox::API::Error when the response is a 406" do
+      response = mock :code => 406, :body => '{ "error": "bad request" }'
+      lambda do
+        @connection.request { response }
+      end.should raise_error(Dropbox::API::Error)
+    end
+
+    it "returns the raw response if :raw => true is provided" do
+      response = mock :code => 200, :body => '{ "something": "more" }'
+      response = @connection.request(:raw => true) { response }
+      response.should == '{ "something": "more" }'
+    end
+
+  end
+
+  describe "#consumer" do
+
+    it "returns an appropriate consumer object" do
+      @connection.consumer(:main).should be_a(::OAuth::Consumer)
+    end
+
+  end
+end

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

@@ -0,0 +1,44 @@
+require "spec_helper"
+
+describe Dropbox::API::Dir do
+
+  before do
+    @client = Dropbox::Spec.instance
+    @dirname = "#{Dropbox::Spec.test_dir}/spec-dir-test-#{Time.now.to_i}"
+    @dir = @client.mkdir @dirname
+  end
+
+  after do
+    # @dir.delete
+  end
+
+  describe "#copy" do
+
+    it "copies the dir properly" do
+      new_dirname = @dirname + "-copied"
+      @dir.copy new_dirname
+      @dir.path.should == new_dirname
+    end
+
+  end
+
+  describe "#move" do
+
+    it "moves the dir properly" do
+      new_dirname = @dirname + "-copied"
+      @dir.move new_dirname
+      @dir.path.should == new_dirname
+    end
+
+  end
+
+  describe "#destroy" do
+
+    it "destroys the dir properly" do
+      @dir.destroy
+      @dir.is_deleted.should == true
+    end
+
+  end
+
+end