dropbox-sdk 1.0.beta → 1.1

data/CHANGELOG

@@ -1,3 +1,9 @@
+1.1 (2011-10-17)
+* Various bug fixes found during beta period
+* Improved documentation
+* Improved module structure
+* Removed dependency on the oauth module, using plaintext authentication over https
+
 1.0 (2011-8-16)
 * Backwards compatibility broken
    - Changed interface

data/cli_example.rb

@@ -10,8 +10,8 @@ require 'pp'
 
 # You must use your Dropbox App key and secret to use the API.
 # Find this at https://www.dropbox.com/developers
-APP_KEY = ""
-APP_SECRET = ""
+APP_KEY = ''
+APP_SECRET = ''
 ACCESS_TYPE = :app_folder #The two valid values here are :app_folder and :dropbox
                           #The default is :app_folder, but your application might be
                           #set to have full :dropbox access.  Check your app at
@@ -46,7 +46,7 @@ class DropboxCLI
             @session.get_request_token
 
             authorize_url = @session.get_authorize_url
-            puts "Got a request token.  Your request token key is #{@session.token} and your token secret is #{@session.secret}"
+            puts "Got a request token.  Your request token key is #{@session.request_token.key} and your token secret is #{@session.request_token.secret}"
 
             # make the user log in and authorize this token
             puts "AUTHORIZING", authorize_url, "Please visit that web page and hit 'Allow', then hit Enter here."
@@ -56,7 +56,7 @@ class DropboxCLI
             @session.get_access_token
 
         end
-        puts "You are logged in.  Your access token key is #{@session.token} your secret is #{@session.secret}"
+        puts "You are logged in.  Your access token key is #{@session.access_token.key} your secret is #{@session.access_token.secret}"
         @client = DropboxClient.new(@session, ACCESS_TYPE)
     end
 
@@ -95,7 +95,7 @@ class DropboxCLI
         end
     end
 
-    def logout
+    def logout(command)
         @session.clear_access_token
         puts "You are logged out."
         @client = nil

data/lib/dropbox_sdk.rb

@@ -1,56 +1,142 @@
 require 'rubygems'
-require 'oauth'
-require 'json'
 require 'uri'
+require 'net/https'
+require 'cgi'
+require 'json'
 require 'yaml'
 
-DROPBOX_API_SERVER = "api.dropbox.com"
-DROPBOX_API_CONTENT_SERVER = "api-content.dropbox.com"
+module Dropbox
+    API_SERVER = "api.dropbox.com"
+    API_CONTENT_SERVER = "api-content.dropbox.com"
+    WEB_SERVER = "www.dropbox.com"
 
-API_VERSION = 1
+    API_VERSION = 1
+    SDK_VERSION = "1.1"
+end
 
 # DropboxSession is responsible for holding OAuth information.  It knows how to take your consumer key and secret
 # and request an access token, an authorize url, and get an access token.  You just need to pass it to
 # DropboxClient after its been authorized.
 class DropboxSession
-    def initialize(key, secret)
-        @consumer_key = key
-        @consumer_secret = secret
-        @oauth_conf = {
-            :site => "https://" + DROPBOX_API_SERVER,
-            :scheme => :header,
-            :http_method => :post,
-            :request_token_url => "/#{API_VERSION}/oauth/request_token",
-            :access_token_url => "/#{API_VERSION}/oauth/access_token",
-            :authorize_url => "/#{API_VERSION}/oauth/authorize",
-        }
 
-        @consumer = OAuth::Consumer.new(@consumer_key, @consumer_secret, @oauth_conf)
-        @access_token = nil
+    def initialize(consumer_key, consumer_secret)
+        @consumer_key = consumer_key
+        @consumer_secret = consumer_secret
         @request_token = nil
+        @access_token = nil
     end
 
-    # This gets a request token. Callbacks are excluded, and any arguments provided are passed on
-    # to the oauth gem's get_request_token call.
-    def get_request_token(*args)
-        begin
-            @request_token ||= @consumer.get_request_token({:exclude_callback => true}, *args)
-        rescue OAuth::Unauthorized => e
-            raise DropboxAuthError.new("Could not get request token, unauthorized.  Is your app key and secret correct? #{e}")
+    private
+
+    def do_http(uri, auth_token, request) # :nodoc:
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true
+
+        request.add_field('Authorization', build_auth_header(auth_token))
+
+        #We use this to better understand how developers are using our SDKs.
+        request['User-Agent'] =  "OfficialDropboxRubySDK/#{Dropbox::SDK_VERSION}"
+
+        http.request(request)
+    end
+
+    def build_auth_header(token) # :nodoc:
+        header = "OAuth oauth_version=\"1.0\", oauth_signature_method=\"PLAINTEXT\", " +
+            "oauth_consumer_key=\"#{URI.escape(@consumer_key)}\", "
+        if token
+            key = URI.escape(token.key)
+            secret = URI.escape(token.secret)
+            header += "oauth_token=\"#{key}\", oauth_signature=\"#{URI.escape(@consumer_secret)}&#{secret}\""
+        else
+            header += "oauth_signature=\"#{URI.escape(@consumer_secret)}&\""
+        end
+        header
+    end
+
+    def do_get_with_token(url, token, headers=nil) # :nodoc:
+        uri = URI.parse(url)
+        do_http(uri, token, Net::HTTP::Get.new(uri.request_uri))
+    end
+
+    public
+
+    def do_get(url, headers=nil)  # :nodoc:
+        assert_authorized
+        do_get_with_token(url, @access_token)
+    end
+
+    def do_http_with_body(uri, request, body)
+        if body != nil
+            if body.is_a?(Hash)
+                form_data = {}
+                body.each {|k,v| form_data[k.to_s] = v if !v.nil?}
+                request.set_form_data(form_data)
+            elsif body.respond_to?(:read)
+                if body.respond_to?(:length)
+                    request["Content-Length"] = body.length.to_s
+                elsif body.respond_to?(:stat) && body.stat.respond_to?(:size)
+                    request["Content-Length"] = body.stat.size.to_s
+                else
+                    raise ArgumentError, "Don't know how to handle 'body' (responds to 'read' but not to 'length' or 'stat.size')."
+                end
+                request.body_stream = body
+            else
+                s = body.to_s
+                request["Content-Length"] = s.length
+                request.body = s
+            end
+        end
+        do_http(uri, @access_token, request)
+    end
+
+    def do_post(url, headers=nil, body=nil)  # :nodoc:
+        assert_authorized
+        uri = URI.parse(url)
+        do_http_with_body(uri, Net::HTTP::Post.new(uri.request_uri, headers), body)
+    end
+
+    def do_put(url, headers=nil, body=nil)  # :nodoc:
+        assert_authorized
+        uri = URI.parse(url)
+        do_http_with_body(uri, Net::HTTP::Put.new(uri.request_uri, headers), body)
+    end
+
+
+    def get_token(url_end, input_token, error_message_prefix) #: nodoc:
+        response = do_get_with_token("https://#{Dropbox::API_SERVER}:443/#{Dropbox::API_VERSION}/oauth#{url_end}", input_token)
+        if not response.kind_of?(Net::HTTPSuccess) # it must be a 200
+            raise DropboxAuthError.new("#{error_message_prefix}  Server returned #{response.code}: #{response.message}.", response)
+        end
+        parts = CGI.parse(response.body)
+        if !parts.has_key? "oauth_token" and parts["oauth_token"].length != 1
+            raise DropboxAuthError.new("Invalid response from #{url_end}: missing \"oauth_token\" parameter: #{response.body}", response)
         end
+        if !parts.has_key? "oauth_token_secret" and parts["oauth_token_secret"].length != 1
+            raise DropboxAuthError.new("Invalid response from #{url_end}: missing \"oauth_token\" parameter: #{response.body}", response)
+        end
+
+        OAuthToken.new(parts["oauth_token"][0], parts["oauth_token_secret"][0])
+    end
+
+    # This returns a request token.  Requests one from the dropbox server using the provided application key and secret if nessecary.
+    def get_request_token()
+        @request_token ||= get_token("/request_token", nil, "Error getting request token.  Is your app key and secret correctly set?")
     end
 
     # This returns a URL that your user must visit to grant
     # permissions to this application.
-    def get_authorize_url(callback=nil, *args)
-        get_request_token(*args)
+    def get_authorize_url(callback=nil)
+        get_request_token()
 
-        url = @request_token.authorize_url
+        url = "/#{Dropbox::API_VERSION}/oauth/authorize?oauth_token=#{URI.escape(@request_token.key)}"
         if callback
-            url +=  "&oauth_callback=" + URI.escape(callback)
+            url += "&oauth_callback=#{URI.escape(callback)}"
+        end
+        if @locale
+            url += "&locale=#{URI.escape(@locale)}"
         end
 
-        "https://www.dropbox.com" + url
+        "https://#{Dropbox::WEB_SERVER}#{url}"
     end
 
     # Clears the access_token
@@ -58,51 +144,48 @@ class DropboxSession
         @access_token = nil
     end
 
+    # Returns the request token, or nil if one hasn't been acquired yet.
+    def request_token
+        @request_token
+    end
+
+    # Returns the access token, or nil if one hasn't been acquired yet.
+    def access_token
+        @access_token
+    end
+
     # Given a saved request token and secret, set this location's token and secret
     # * token - this is the request token
     # * secret - this is the request token secret
     def set_request_token(key, secret)
-        @request_token = OAuth::RequestToken.new(@consumer, key, secret)
+        @request_token = OAuthToken.new(key, secret)
     end
 
     # Given a saved access token and secret, you set this Session to use that token and secret
     # * token - this is the access token
     # * secret - this is the access token secret
     def set_access_token(key, secret)
-        @access_token = OAuth::AccessToken.from_hash(@consumer, {:oauth_token => key, :oauth_token_secret => secret})
-    end
-
-    def check_authorized
-        ##this check is applied before the token and secret methods
-        raise DropboxError.new('Session does not yet have a request token') unless authorized?
-    end
-
-    # Returns the current oauth access or request token.
-    def token
-        (@access_token || @request_token).token
-    end
-
-    # Returns the current oauth access or request token secret.
-    def secret
-        (@access_token || @request_token).secret
+        @access_token = OAuthToken.new(key, secret)
     end
 
     # Returns the access token. If this DropboxSession doesn't yet have an access_token, it requests one
     # using the request_token generate from your app's token and secret.  This request will fail unless
-    # your user has got to the authorize_url and approved your request
+    # your user has gone to the authorize_url and approved your request
     def get_access_token
-        if @access_token.nil?
-            if @request_token.nil?
-                raise DropboxAuthError.new("No request token. You must set this or get an authorize url first.")
-            end
+        return @access_token if authorized?
 
-            begin
-                @access_token = @request_token.get_access_token
-            rescue OAuth::Unauthorized => e
-                raise DropboxAuthError.new("Could not get access token, unauthorized.  Did you go to authorize_url? #{e}")
-            end
+        if @request_token.nil?
+            raise DropboxAuthError.new("No request token. You must set this or get an authorize url first.")
+        end
+
+        @access_token = get_token("/access_token", @request_token,  "Couldn't get access token.")
+    end
+
+    # If we have an access token, then do nothing.  If not, throw a RuntimeError.
+    def assert_authorized
+        unless authorized?
+            raise RuntimeError.new('Session does not yet have a request token')
         end
-        @access_token
     end
 
     # Returns true if this Session has been authorized and has an access_token.
@@ -112,24 +195,24 @@ class DropboxSession
 
     # serialize the DropboxSession.
     # At DropboxSession's state is capture in three key/secret pairs.  Consumer, request, and access.
-    # This takes the form of an array that is then converted to yaml
+    # Serialize returns these in a YAML string, generated from a converted array of the form:
     # [consumer_key, consumer_secret, request_token.token, request_token.secret, access_token.token, access_token.secret]
     # access_token is only included if it already exists in the DropboxSesssion
     def serialize
         toreturn = []
         if @access_token
-            toreturn.push @access_token.secret, @access_token.token
+            toreturn.push @access_token.secret, @access_token.key
         end
 
-        get_request_token unless @request_token
+        get_request_token
 
-        toreturn.push @request_token.secret, @request_token.token
+        toreturn.push @request_token.secret, @request_token.key
         toreturn.push @consumer_secret, @consumer_key
 
         toreturn.to_yaml
     end
 
-    # Takes a serialized DropboxSession and returns a new DropboxSession object
+    # Takes a serialized DropboxSession YAML String and returns a new DropboxSession object
     def self.deserialize(ser)
         ser = YAML::load(ser)
         session = DropboxSession.new(ser.pop, ser.pop)
@@ -143,6 +226,22 @@ class DropboxSession
 end
 
 
+# A class that represents either an OAuth request token or an OAuth access token.
+class OAuthToken
+    def initialize(key, secret)
+        @key = key
+        @secret = secret
+    end
+
+    def key
+        @key
+    end
+
+    def secret
+        @secret
+    end
+end
+
 
 # This is the usual error raised on any Dropbox related Errors
 class DropboxError < RuntimeError
@@ -179,15 +278,7 @@ class DropboxClient
     # Initialize a new DropboxClient.  You need to get it a session which either has been authorized. See
     # documentation on DropboxSession for how to authorize it.
     def initialize(session, root="app_folder", locale=nil)
-        if not session.authorized?
-            begin
-                ## attempt to get an access token and authorize the session
-                session.get_access_token
-            rescue OAuth::Unauthorized => e
-                raise DropboxAuthError.new("Could not initialize. Failed to get access token from Session. Error was: #{ e.message }")
-                # If this was raised, the user probably didn't go to auth.get_authorize_url
-            end
-        end
+        session.get_access_token
 
         @root = root.to_s  # If they passed in a symbol, make it a string
 
@@ -196,15 +287,12 @@ class DropboxClient
         end
         if @root == "app_folder"
             #App Folder is the name of the access type, but for historical reasons
-            #sandbox is the URL root compontent that indicates this
+            #sandbox is the URL root component that indicates this
             @root = "sandbox"
         end
 
         @locale = locale
         @session = session
-        @token = session.get_access_token
-
-        #There's no gurantee that @token is still valid, so be sure to handle any DropboxAuthErrors that can be raised
     end
 
     # Parse response. You probably shouldn't be calling this directly.  This takes responses from the server
@@ -236,7 +324,6 @@ class DropboxClient
         rescue JSON::ParserError
             raise DropboxError.new("Unable to parse JSON response", response)
         end
-
     end
 
 
@@ -245,7 +332,7 @@ class DropboxClient
     # For a detailed description of what this call returns, visit:
     # https://www.dropbox.com/developers/docs#account-info
     def account_info()
-        response = @token.get build_url("/account/info")
+        response = @session.do_get build_url("/account/info")
         parse_response(response)
     end
 
@@ -254,7 +341,7 @@ class DropboxClient
     # Arguments:
     # * to_path: The directory path to upload the file to. If the destination
     #   directory does not yet exist, it will be created.
-    # * file_obj: A file-like object to upload. If you would like, you can 
+    # * file_obj: A file-like object to upload. If you would like, you can
     #   pass a string as file_obj.
     # * overwrite: Whether to overwrite an existing file at the given path. [default is False]
     #   If overwrite is False and a file already exists there, Dropbox
@@ -275,14 +362,13 @@ class DropboxClient
     # * a Hash containing the metadata of the newly uploaded file.  The file may have a different name if it conflicted.
     #
     # Simple Example
-    #  client = DropboxClient(session, "app_folder")
+    #  client = DropboxClient(session, :app_folder)
     #  #session is a DropboxSession I've already authorized
     #  client.put_file('/test_file_on_dropbox', open('/tmp/test_file'))
     # This will upload the "/tmp/test_file" from my computer into the root of my App's app folder
     # and call it "test_file_on_dropbox".
     # The file will not overwrite any pre-existing file.
     def put_file(to_path, file_obj, overwrite=false, parent_rev=nil)
-
         path = "/files_put/#{@root}#{format_path(to_path)}"
 
         params = {
@@ -291,9 +377,9 @@ class DropboxClient
 
         params['parent_rev'] = parent_rev unless parent_rev.nil?
 
-        response = @token.put(build_url(path, params, content_server=true),
-                              file_obj,
-                              "Content-Type" => "application/octet-stream")
+        response = @session.do_put(build_url(path, params, content_server=true),
+                                   {"Content-Type" => "application/octet-stream"},
+                                   file_obj)
 
         parse_response(response)
     end
@@ -311,7 +397,7 @@ class DropboxClient
         params['rev'] = rev.to_s if rev
 
         path = "/files/#{@root}#{format_path(from_path)}"
-        response = @token.get(build_url(path, params, content_server=true))
+        response = @session.do_get build_url(path, params, content_server=true)
 
         parse_response(response, raw=true)
     end
@@ -336,7 +422,7 @@ class DropboxClient
             "from_path" => format_path(from_path, false),
             "to_path" => format_path(to_path, false),
         }
-        response = @token.get(build_url("/fileops/copy", params))
+        response = @session.do_post build_url("/fileops/copy", params)
         parse_response(response)
     end
 
@@ -352,9 +438,9 @@ class DropboxClient
     def file_create_folder(path)
         params = {
             "root" => @root,
-            "path" => format_path(from_path, false),
+            "path" => format_path(path, false),
         }
-        response = @token.get(build_url("/fileops/create_folder", params))
+        response = @session.do_post build_url("/fileops/create_folder", params)
 
         parse_response(response)
     end
@@ -371,9 +457,9 @@ class DropboxClient
     def file_delete(path)
         params = {
             "root" => @root,
-            "path" => format_path(from_path, false),
+            "path" => format_path(path, false),
         }
-        response = @token.get(build_url("/fileops/delete", params))
+        response = @session.do_post build_url("/fileops/delete", params)
         parse_response(response)
     end
 
@@ -394,7 +480,7 @@ class DropboxClient
             "from_path" => format_path(from_path, false),
             "to_path" => format_path(to_path, false),
         }
-        response = @token.post(build_url("/fileops/move", params))
+        response = @session.do_post build_url("/fileops/move", params)
         parse_response(response)
     end
 
@@ -425,7 +511,7 @@ class DropboxClient
 
         params["hash"] = hash if hash
 
-        response = @token.get build_url("/metadata/#{@root}#{format_path(path)}", params=params)
+        response = @session.do_get build_url("/metadata/#{@root}#{format_path(path)}", params=params)
         if response.kind_of? Net::HTTPRedirection
                 raise DropboxNotModified.new("metadata not modified")
         end
@@ -447,16 +533,14 @@ class DropboxClient
     #   inside path.  For a detailed description of what this call returns, visit:
     #   https://www.dropbox.com/developers/docs#search
     def search(path, query, file_limit=10000, include_deleted=false)
-
         params = {
             'query' => query,
             'file_limit' => file_limit.to_s,
             'include_deleted' => include_deleted.to_s
         }
 
-        response = @token.get(build_url("/search/#{@root}#{format_path(path)}", params))
+        response = @session.do_get build_url("/search/#{@root}#{format_path(path)}", params)
         parse_response(response)
-
     end
 
     # Retrive revisions of a file
@@ -478,7 +562,7 @@ class DropboxClient
             'rev_limit' => rev_limit.to_s
         }
 
-        response = @token.get(build_url("/revisions/#{@root}#{format_path(path)}", params))
+        response = @session.do_get build_url("/revisions/#{@root}#{format_path(path)}", params)
         parse_response(response)
 
     end
@@ -498,7 +582,7 @@ class DropboxClient
             'rev' => rev.to_s
         }
 
-        response = @token.get(build_url("/restore/#{@root}#{format_path(path)}", params))
+        response = @session.do_post build_url("/restore/#{@root}#{format_path(path)}", params)
         parse_response(response)
     end
 
@@ -515,7 +599,7 @@ class DropboxClient
     # * A Hash object that looks like the following:
     #      {'url': 'https://dl.dropbox.com/0/view/wvxv1fw6on24qw7/file.mov', 'expires': 'Thu, 16 Sep 2011 01:01:25 +0000'}
     def media(path)
-        response = @token.get(build_url("/media/#{@root}#{format_path(path)}"))
+        response = @session.do_get build_url("/media/#{@root}#{format_path(path)}")
         parse_response(response)
     end
 
@@ -534,7 +618,7 @@ class DropboxClient
     #   For a detailed description of what this call returns, visit:
     #    https://www.dropbox.com/developers/docs#share
     def shares(path)
-        response = @token.get(build_url("/shares/#{@root}#{format_path(path)}"))
+        response = @session.do_get build_url("/shares/#{@root}#{format_path(path)}")
         parse_response(response)
     end
 
@@ -560,14 +644,14 @@ class DropboxClient
 
         url = build_url("/thumbnails/#{@root}#{from_path}", params, content_server=true)
 
-        response = @token.get(url)
+        response = @session.do_get url
         parse_response(response, raw=true)
     end
 
     def build_url(url, params=nil, content_server=false) # :nodoc:
         port = 443
-        host = content_server ? DROPBOX_API_CONTENT_SERVER : DROPBOX_API_SERVER
-        versioned_url = "/#{API_VERSION}#{url}"
+        host = content_server ? Dropbox::API_CONTENT_SERVER : Dropbox::API_SERVER
+        versioned_url = "/#{Dropbox::API_VERSION}#{url}"
 
         target = URI::Generic.new("https", nil, host, port, nil, versioned_url, nil, nil, nil)
 
@@ -585,23 +669,22 @@ class DropboxClient
 
         target.to_s
     end
-end
 
+    #From the oauth spec plus "/".  Slash should not be ecsaped
+    RESERVED_CHARACTERS = /[^a-zA-Z0-9\-\.\_\~\/]/
 
-#From the oauth spec plus "/".  Slash should not be ecsaped
-RESERVED_CHARACTERS = /[^a-zA-Z0-9\-\.\_\~\/]/
+    def format_path(path, escape=true) # :nodoc:
+        path = path.gsub(/\/+/,"/")
+        # replace multiple slashes with a single one
 
-def format_path(path, escape=true) # :nodoc:
-    path = path.gsub(/\/+/,"/")
-    # replace multiple slashes with a single one
+        path = path.gsub(/^\/?/,"/")
+        # ensure the path starts with a slash
 
-    path = path.gsub(/^\/?/,"/")
-    # ensure the path starts with a slash
+        path.gsub(/\/?$/,"")
+        # ensure the path doesn't end with a slash
 
-    path.gsub(/\/?$/,"")
-    # ensure the path doesn't end with a slash
+        return URI.escape(path, RESERVED_CHARACTERS) if escape
+        path
+    end
 
-    return URI.escape(path, RESERVED_CHARACTERS) if escape
-    path
 end
-

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: dropbox-sdk
 version: !ruby/object:Gem::Version 
-  hash: 31098137
-  prerelease: 4
+  hash: 13
+  prerelease: 
   segments: 
   - 1
-  - 0
-  - beta
-  version: 1.0.beta
+  - 1
+  version: "1.1"
 platform: ruby
 authors: 
 - Dropbox, Inc.
@@ -15,10 +14,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-28 00:00:00 Z
+date: 2011-10-28 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: oauth
+  name: json
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
@@ -31,20 +30,6 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: json
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :runtime
-  version_requirements: *id002
 description: "        A library that provides a plain function-call interface to the\n        Dropbox API web endpoints.\n"
 email: 
 - support-api@dropbox.com
@@ -82,14 +67,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version 
-      hash: 25
+      hash: 3
       segments: 
-      - 1
-      - 3
-      - 1
-      version: 1.3.1
+      - 0
+      version: "0"
 requirements: []
 
 rubyforge_project: