dropbox-api-alt 0.4.7

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

@@ -0,0 +1,39 @@
+module Dropbox
+  module API
+
+    class Object < Hashie::Mash
+      attr_accessor :client
+
+      def self.init(response, client)
+        instance = self.new(response)
+        instance.client = client
+        instance
+      end
+
+      def self.resolve_class(hash)
+        hash['is_dir'] == true ? Dropbox::API::Dir : Dropbox::API::File
+      end
+
+      def self.convert(array_or_object, client)
+        if array_or_object.is_a?(Array)
+          array_or_object.collect do |item|
+            resolve_class(item).init(item, client)
+          end
+        else
+          resolve_class(array_or_object).init(array_or_object, client)
+        end
+      end
+
+      # Kill off the ability for recursive conversion
+      def deep_update(other_hash)
+        other_hash.each_pair do |k,v|
+          key = convert_key(k)
+          regular_writer(key, convert_value(v, true))
+        end
+        self
+      end
+
+    end
+
+  end
+end

data/lib/dropbox-api/tasks.rb

@@ -0,0 +1,48 @@
+module Dropbox
+  module API
+
+    class Tasks
+
+      extend Rake::DSL if defined? Rake::DSL
+
+      def self.install
+
+        namespace :dropbox do
+          desc "Authorize wizard for Dropbox API"
+          task :authorize do
+            require "dropbox-api"
+            require "cgi"
+            print "Enter dropbox app key: "
+            consumer_key = $stdin.gets.chomp
+            print "Enter dropbox app secret: "
+            consumer_secret = $stdin.gets.chomp
+
+            Dropbox::API::Config.app_key    = consumer_key
+            Dropbox::API::Config.app_secret = consumer_secret
+
+            consumer = Dropbox::API::OAuth.consumer(:authorize)
+            request_token = consumer.get_request_token
+            puts "\nGo to this url and click 'Authorize' to get the token:"
+            puts request_token.authorize_url
+            query  = request_token.authorize_url.split('?').last
+            params = CGI.parse(query)
+            token  = params['oauth_token'].first
+            print "\nOnce you authorize the app on Dropbox, press enter... "
+            $stdin.gets.chomp
+
+            access_token  = request_token.get_access_token(:oauth_verifier => token)
+
+            puts "\nAuthorization complete!:\n\n"
+            puts "  Dropbox::API::Config.app_key    = '#{consumer.key}'"
+            puts "  Dropbox::API::Config.app_secret = '#{consumer.secret}'"
+            puts "  client = Dropbox::API::Client.new(:token  => '#{access_token.token}', :secret => '#{access_token.secret}')"
+            puts "\n"
+          end
+        end
+
+      end
+
+    end
+
+  end
+end

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

@@ -0,0 +1,27 @@
+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
+      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'
+
+    end
+
+  end
+end

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

@@ -0,0 +1,20 @@
+module Dropbox
+  module API
+
+    class Error < StandardError
+
+      class BadInput < Error; end
+      class ConnectionFailed < Error; end
+      class Config < Error; end
+      class Unauthorized < Error; end
+      class Forbidden < Error; end
+      class NotFound < Error; end
+      class Redirect < Error; end
+      class WrongMethod < Error; end
+      class RateLimit < Error; end
+      class StorageQuota < Error; 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/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.4.7"
+  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,259 @@
+# encoding: utf-8
+require "spec_helper"
+require "tempfile"
+
+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 "#chunked_upload" do
+
+    before do
+      @size = 5*1024*1024 # 5MB, to test the 4MB chunk size
+      @file = File.open("/tmp/dropbox-api-test", "w") {|f| f.write "a"*@size}
+    end
+
+    it "puts a 5MB file in dropbox" do
+      filename = "#{Dropbox::Spec.test_dir}/test-#{Dropbox::Spec.namespace}.txt"
+      response = @client.chunked_upload filename, File.open("/tmp/dropbox-api-test")
+      response.path.should == filename
+      response.bytes.should == @size
+    end
+
+    after do
+      FileUtils.rm "/tmp/dropbox-api-test"
+    end
+
+  end
+
+  describe "#destroy" do
+
+    before do
+      @client = Dropbox::Spec.instance
+      @filename = "#{Dropbox::Spec.test_dir}/spec-test-#{Time.now.to_i}.txt"
+      @file = @client.upload @filename, "spec file"
+    end
+
+    it "destroys the file properly" do
+      file = @client.destroy(@filename)
+      file.is_deleted.should == true
+    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
+
+    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