dropbox-api 0.1.0

data/lib/dropbox-api/client/raw.rb

@@ -0,0 +1,48 @@
+module Dropbox
+  module API
+
+    class Raw
+
+      attr_accessor :connection
+
+      def initialize(options = {})
+        @connection = options[:connection]
+      end
+
+      def self.add_method(method, action, options = {})
+        # Add the default root bit, but allow it to be disabled by a config option
+        root = options[:root] == false ? '' : "options[:root] ||= '#{Dropbox::API::Config.mode}'"
+        self.class_eval <<-STR
+          def #{options[:as] || action}(options = {})
+            #{root}
+            request(:#{options[:endpoint] || 'main'}, :#{method}, "#{action}", options)
+          end
+        STR
+      end
+
+      def request(endpoint, method, action, data = {})
+        action.sub! ':root', data.delete(:root) if action.match ':root'
+        action.sub! ':path', data.delete(:path) if action.match ':path'
+        connection.send(method, endpoint, action, data)
+      end
+
+      add_method :get,  "/account/info",           :as => 'account', :root => false
+
+      add_method :get,  "/metadata/:root/:path",   :as => 'metadata'
+      add_method :get,  "/revisions/:root/:path",  :as => 'revisions'
+      add_method :post, "/restore/:root/:path",    :as => 'restore'
+      add_method :get,  "/search/:root/:path",     :as => 'search'
+      add_method :post, "/shares/:root/:path",     :as => 'shares'
+      add_method :post, "/media/:root/:path",      :as => 'media'
+
+      add_method :get_raw, "/thumbnails/:root/:path", :as => 'thumbnails', :endpoint => :content
+
+      add_method :post, "/fileops/copy",           :as => "copy"
+      add_method :post, "/fileops/create_folder",  :as => "create_folder"
+      add_method :post, "/fileops/delete",         :as => "delete"
+      add_method :post, "/fileops/move",           :as => "move"
+
+    end
+
+  end
+end

data/lib/dropbox-api/connection.rb

@@ -0,0 +1,34 @@
+require "dropbox-api/connection/requests"
+
+module Dropbox
+  module API
+
+    class Connection
+
+      include Dropbox::API::Connection::Requests
+
+      attr_accessor :consumers
+      attr_accessor :tokens
+
+      def initialize(options = {})
+        @options   = options
+        @consumers = {}
+        @tokens    = {}
+        Dropbox::API::Config.endpoints.each do |endpoint, url|
+          @consumers[endpoint] = Dropbox::API::OAuth.consumer(endpoint)
+          @tokens[endpoint]    = Dropbox::API::OAuth.access_token(@consumers[endpoint], options)
+        end
+      end
+
+      def consumer(endpoint = :main)
+        @consumers[endpoint]
+      end
+
+      def token(endpoint = :main)
+        @tokens[endpoint]
+      end
+
+    end
+
+  end
+end

data/lib/dropbox-api/connection/requests.rb

@@ -0,0 +1,63 @@
+module Dropbox
+  module API
+
+    class Connection
+
+      module Requests
+
+        def request(options = {})
+          response = yield
+          raise Dropbox::API::Error::ConnectionFailed if !response
+          status = response.code.to_i
+          case status
+            when 401
+              raise Dropbox::API::Error::Unauthorized
+            when 403
+              parsed = Yajl::Parser.parse(response.body)
+              raise Dropbox::API::Error::Forbidden.new(parsed["error"])
+            when 404
+              raise Dropbox::API::Error::NotFound
+            when 400, 406
+              parsed = Yajl::Parser.parse(response.body)
+              raise Dropbox::API::Error.new(parsed["error"])
+            when 300..399
+              raise Dropbox::API::Error::Redirect
+            when 500..599
+              raise Dropbox::API::Error
+            else
+              options[:raw] ? response.body : Yajl::Parser.parse(response.body)
+          end
+        end
+
+        def get_raw(endpoint, path, data = {}, headers = {})
+          query = Dropbox::API::Util.query(data)
+          request(:raw => true) do
+            token(endpoint).get "#{Dropbox::API::Config.prefix}#{URI.parse(URI.encode(path))}?#{URI.parse(URI.encode(query))}", headers
+          end
+        end
+
+        def get(endpoint, path, data = {}, headers = {})
+          query = Dropbox::API::Util.query(data)
+          request do
+            token(endpoint).get "#{Dropbox::API::Config.prefix}#{URI.parse(URI.encode(path))}?#{URI.parse(URI.encode(query))}", headers
+          end
+        end
+
+        def post(endpoint, path, data = {}, headers = {})
+          request do
+            token(endpoint).post "#{Dropbox::API::Config.prefix}#{URI.parse(URI.encode(path))}", data, headers
+          end
+        end
+
+        def put(endpoint, path, data = {}, headers = {})
+          request do
+            token(endpoint).put "#{Dropbox::API::Config.prefix}#{URI.parse(URI.encode(path))}", data, headers
+          end
+        end
+
+      end
+
+    end
+
+  end
+end

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

@@ -0,0 +1,20 @@
+module Dropbox
+  module API
+
+    class Dir < Dropbox::API::Object
+
+      include Dropbox::API::Fileops
+
+      def ls(path_to_list = '')
+        data = client.raw.metadata :path => path + path_to_list
+        if data['is_dir']
+          Dropbox::API::Object.convert(data.delete('contents') || [], client)
+        else
+          [Dropbox::API::Object.convert(data, client)]
+        end
+      end
+
+    end
+
+  end
+end

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

@@ -0,0 +1,39 @@
+module Dropbox
+  module API
+
+    class File < Dropbox::API::Object
+
+      include Dropbox::API::Fileops
+
+      def revisions(options = {})
+        response = client.raw.revisions({ :path => self.path }.merge(options))
+        Dropbox::API::Object.convert(response, client)
+      end
+
+      def restore(rev, options = {})
+        response = client.raw.restore({ :rev => rev, :path => self.path }.merge(options))
+        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
+
+      def download
+        client.download(self.path)
+      end
+
+    end
+
+  end
+end

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

@@ -0,0 +1,28 @@
+module Dropbox
+  module API
+
+    module Fileops
+
+      def copy(to, options = {})
+        response = client.raw.copy({ :from_path => self.path, :to_path => to }.merge(options))
+        self.update response
+      end
+
+      def move(to, options = {})
+        response = client.raw.move({ :from_path => self.path, :to_path => to }.merge(options))
+        self.update response
+      end
+
+      def delete(options = {})
+        response = client.raw.delete({ :path => self.path }.merge(options))
+        self.update response
+      end
+
+      def path
+        self['path'].sub(/^\//, '')
+      end
+
+    end
+
+  end
+end

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 consumer key: "
+            consumer_key = $stdin.gets.chomp
+            print "Enter consumer 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,16 @@
+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 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/util.rb

@@ -0,0 +1,17 @@
+module Dropbox
+  module API
+
+    module Util
+
+      class << self
+
+        def query(data)
+          data.inject([]) { |memo, entry| memo.push(entry.join('=')); memo }.join('&')
+        end
+
+      end
+
+    end
+
+  end
+end

data/lib/dropbox-api/version.rb

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

data/spec/connection.sample.yml

@@ -0,0 +1,4 @@
+app_key:    # CONSUMER KEY
+app_secret: # CONSUMER SECRET
+token:      # ACCESS TOKEN
+secret:     # ACCESS SECRET

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

@@ -0,0 +1,92 @@
+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 "#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
+      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  = "test/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 = "test/test-#{Dropbox::Spec.namespace}.txt"
+      response = @client.upload filename, "Some file"
+      response.path.should == filename
+      response.bytes.should == 9
+    end
+
+  end
+
+  describe "#search" do
+
+    it "finds a file" 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.size.should == 1
+      response.first.class.should == Dropbox::API::File
+    end
+
+  end
+
+  describe "#download" do
+
+    it "downloads a file from Dropbox" do
+      file = @client.download 'test/test.txt'
+      file.should == "Some file"
+    end
+
+    it "raises a 404 when a file is not found in Dropbox" do
+      lambda {
+        @client.download 'test/no.txt'
+      }.should raise_error(Dropbox::API::Error::NotFound)
+    end
+
+  end
+
+end