dropbox-sdk 1.6.1 → 1.6.2

data/CHANGELOG

@@ -1,3 +1,7 @@
+1.6.2 (2013-10-10)
+* Put params in body for POST requests (they were being put in the URL).
+  Fixes bug with /delta and really long cursors.
+
 1.6.1 (2013-07-08)
 * Fixed syntax error (Ruby 1.8.7 didn't mind, but Ruby 1.9 did).
 

data/lib/dropbox_sdk.rb

@@ -14,10 +14,24 @@ module Dropbox # :nodoc:
     WEB_SERVER = "www.dropbox.com"
     
     API_VERSION = 1
-    SDK_VERSION = "1.6.1"
+    SDK_VERSION = "1.6.2"
 
     TRUSTED_CERT_FILE = File.join(File.dirname(__FILE__), 'trusted-certs.crt')
 
+    def self.clean_params(params)
+        r = {}
+        params.each do |k,v|
+            r[k] = v.to_s if not v.nil?
+        end
+        r
+    end
+
+    def self.make_query_string(params)
+        clean_params(params).collect {|k,v|
+            CGI.escape(k) + "=" + CGI.escape(v)
+        }.join("&")
+    end
+
     def self.do_http(uri, request) # :nodoc:
         http = Net::HTTP.new(uri.host, uri.port)
 
@@ -81,6 +95,28 @@ end
 
 class DropboxSessionBase # :nodoc:
 
+    attr_writer :locale
+
+    def initialize(locale)
+        @locale = locale
+    end
+
+    private
+
+    def build_url(path, content_server)
+        port = 443
+        host = content_server ? Dropbox::API_CONTENT_SERVER : Dropbox::API_SERVER
+        full_path = "/#{Dropbox::API_VERSION}#{path}"
+        return URI::HTTPS.build({:host => host, :path => full_path})
+    end
+
+    def build_url_with_params(path, params, content_server) # :nodoc:
+        target = build_url(path, content_server)
+        params['locale'] = @locale
+        target.query = Dropbox::make_query_string(params)
+        return target
+    end
+
     protected
 
     def do_http(uri, request) # :nodoc:
@@ -90,19 +126,17 @@ class DropboxSessionBase # :nodoc:
 
     public
 
-    def do_get(url, headers=nil)  # :nodoc:
+    def do_get(path, params=nil, headers=nil, content_server=false)  # :nodoc:
+        params ||= {}
         assert_authorized
-        uri = URI.parse(url)
-        request = Net::HTTP::Get.new(uri.request_uri)
-        do_http(uri, request)
+        uri = build_url_with_params(path, params, content_server)
+        do_http(uri, Net::HTTP::Get.new(uri.request_uri))
     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)
+                request.set_form_data(Dropbox::clean_params(body))
             elsif body.respond_to?(:read)
                 if body.respond_to?(:length)
                     request["Content-Length"] = body.length.to_s
@@ -121,15 +155,18 @@ class DropboxSessionBase # :nodoc:
         do_http(uri, request)
     end
 
-    def do_post(url, headers=nil, body=nil)  # :nodoc:
+    def do_post(path, params=nil, headers=nil, content_server=false)  # :nodoc:
+        params ||= {}
         assert_authorized
-        uri = URI.parse(url)
-        do_http_with_body(uri, Net::HTTP::Post.new(uri.request_uri, headers), body)
+        uri = build_url(path, content_server)
+        params['locale'] = @locale
+        do_http_with_body(uri, Net::HTTP::Post.new(uri.request_uri, headers), params)
     end
 
-    def do_put(url, headers=nil, body=nil)  # :nodoc:
+    def do_put(path, params=nil, headers=nil, body=nil, content_server=false)  # :nodoc:
+        params ||= {}
         assert_authorized
-        uri = URI.parse(url)
+        uri = build_url_with_params(path, params, content_server)
         do_http_with_body(uri, Net::HTTP::Put.new(uri.request_uri, headers), body)
     end
 end
@@ -141,7 +178,8 @@ class DropboxSession < DropboxSessionBase  # :nodoc:
 
     # * consumer_key - Your Dropbox application's "app key".
     # * consumer_secret - Your Dropbox application's "app secret".
-    def initialize(consumer_key, consumer_secret)
+    def initialize(consumer_key, consumer_secret, locale=nil)
+        super(locale)
         @consumer_key = consumer_key
         @consumer_secret = consumer_secret
         @request_token = nil
@@ -304,7 +342,9 @@ end
 
 
 class DropboxOAuth2Session < DropboxSessionBase  # :nodoc:
-    def initialize(oauth2_access_token)
+
+    def initialize(oauth2_access_token, locale=nil)
+        super(locale)
         if not oauth2_access_token.is_a?(String)
             raise "bad type for oauth2_access_token (expecting String)"
         end
@@ -340,25 +380,19 @@ class DropboxOAuth2FlowBase  # :nodoc:
     end
 
     def _get_authorize_url(redirect_uri, state)
-        params = {"client_id" => @consumer_key, "response_type" => "code"}
-        if not redirect_uri.nil?
-            params["redirect_uri"] = redirect_uri
-        end
-        if not state.nil?
-            params["state"] = state
-        end
-        if not @locale.nil?
-            params['locale'] = @locale
-        end
+        params = {
+            "client_id" => @consumer_key,
+            "response_type" => "code",
+            "redirect_uri" => redirect_uri,
+            "state" => state,
+            "locale" => @locale,
+        }
 
         host = Dropbox::WEB_SERVER
         path = "/#{Dropbox::API_VERSION}/oauth2/authorize"
 
         target = URI::Generic.new("https", nil, host, nil, nil, path, nil, nil, nil)
-
-        target.query = params.collect {|k,v|
-            CGI.escape(k) + "=" + CGI.escape(v)
-        }.join("&")
+        target.query = Dropbox::make_query_string(params)
 
         target.to_s
     end
@@ -378,18 +412,11 @@ class DropboxOAuth2FlowBase  # :nodoc:
         params = {
             "grant_type" => "authorization_code",
             "code" => code,
+            "redirect_uri" => original_redirect_uri,
+            "locale" => @locale,
         }
 
-        if not @locale.nil?
-            params['locale'] = @locale
-        end
-        if not original_redirect_uri.nil?
-            params['redirect_uri'] = original_redirect_uri
-        end
-
-        form_data = {}
-        params.each {|k,v| form_data[k.to_s] = v if !v.nil?}
-        request.set_form_data(form_data)
+        request.set_form_data(Dropbox::clean_params(params))
 
         response = Dropbox::do_http(uri, request)
 
@@ -653,10 +680,13 @@ class DropboxClient
     # * +locale+: The user's current locale (used to localize error messages).
     def initialize(oauth2_access_token, root="auto", locale=nil)
         if oauth2_access_token.is_a?(String)
-            @session = DropboxOAuth2Session.new(oauth2_access_token)
+            @session = DropboxOAuth2Session.new(oauth2_access_token, locale)
         elsif oauth2_access_token.is_a?(DropboxSession)
             @session = oauth2_access_token
             @session.get_access_token
+            if not locale.nil?
+                @session.locale = locale
+            end
         else
             raise ArgumentError.new("oauth2_access_token doesn't have a valid type")
         end
@@ -671,8 +701,6 @@ class DropboxClient
             #sandbox is the URL root component that indicates this
             @root = "sandbox"
         end
-
-        @locale = locale
     end
 
     # Returns some information about the current user's Dropbox account (the "current user"
@@ -681,7 +709,7 @@ class DropboxClient
     # For a detailed description of what this call returns, visit:
     # https://www.dropbox.com/developers/reference/api#account-info
     def account_info()
-        response = @session.do_get build_url("/account/info")
+        response = @session.do_get "/account/info"
         Dropbox::parse_response(response)
     end
 
@@ -720,16 +748,14 @@ class DropboxClient
     # 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 = {
-            'overwrite' => overwrite.to_s
+            'overwrite' => overwrite.to_s,
+            'parent_rev' => parent_rev,
         }
 
-        params['parent_rev'] = parent_rev unless parent_rev.nil?
-
-        response = @session.do_put(build_url(path, params, content_server=true),
-                                   {"Content-Type" => "application/octet-stream"},
-                                   file_obj)
+        headers = {"Content-Type" => "application/octet-stream"}
+        content_server = true
+        response = @session.do_put path, params, headers, file_obj, content_server
 
         Dropbox::parse_response(response)
     end
@@ -819,20 +845,24 @@ class DropboxClient
     end
 
     def commit_chunked_upload(to_path, upload_id, overwrite=false, parent_rev=nil)  #:nodoc
+        path = "/commit_chunked_upload/#{@root}#{format_path(to_path)}"
         params = {'overwrite' => overwrite.to_s,
                   'upload_id' => upload_id,
-                  'parent_rev' => parent_rev.to_s,
+                  'parent_rev' => parent_rev,
                 }
-        @session.do_post(build_url("/commit_chunked_upload/#{@root}#{format_path(to_path)}", params, content_server=true))
+        headers = nil
+        content_server = true
+        @session.do_post path, params, headers, content_server
     end
 
     def partial_chunked_upload(data, upload_id=nil, offset=nil)  #:nodoc
-        params = {}
-        params['upload_id'] = upload_id.to_s if upload_id
-        params['offset'] = offset.to_s if offset
-        @session.do_put(build_url('/chunked_upload', params, content_server=true),
-                                {'Content-Type' => "application/octet-stream"},
-                                data)
+        params = {
+            'upload_id' => upload_id,
+            'offset' => offset,
+        }
+        headers = {'Content-Type' => "application/octet-stream"}
+        content_server = true
+        @session.do_put '/chunked_upload', params, headers, data, content_server
     end
 
     # Download a file
@@ -873,11 +903,13 @@ class DropboxClient
     # Returns:
     # * The HTTPResponse for the file download request.
     def get_file_impl(from_path, rev=nil) # :nodoc:
-        params = {}
-        params['rev'] = rev.to_s if rev
-
         path = "/files/#{@root}#{format_path(from_path)}"
-        @session.do_get build_url(path, params, content_server=true)
+        params = {
+            'rev' => rev,
+        }
+        headers = nil
+        content_server = true
+        @session.do_get path, params, headers, content_server
     end
     private :get_file_impl
 
@@ -920,7 +952,7 @@ class DropboxClient
             "from_path" => format_path(from_path, false),
             "to_path" => format_path(to_path, false),
         }
-        response = @session.do_post build_url("/fileops/copy", params)
+        response = @session.do_post "/fileops/copy", params
         Dropbox::parse_response(response)
     end
 
@@ -938,7 +970,7 @@ class DropboxClient
             "root" => @root,
             "path" => format_path(path, false),
         }
-        response = @session.do_post build_url("/fileops/create_folder", params)
+        response = @session.do_post "/fileops/create_folder", params
 
         Dropbox::parse_response(response)
     end
@@ -957,7 +989,7 @@ class DropboxClient
             "root" => @root,
             "path" => format_path(path, false),
         }
-        response = @session.do_post build_url("/fileops/delete", params)
+        response = @session.do_post "/fileops/delete", params
         Dropbox::parse_response(response)
     end
 
@@ -978,7 +1010,7 @@ class DropboxClient
             "from_path" => format_path(from_path, false),
             "to_path" => format_path(to_path, false),
         }
-        response = @session.do_post build_url("/fileops/move", params)
+        response = @session.do_post "/fileops/move", params
         Dropbox::parse_response(response)
     end
 
@@ -1009,15 +1041,14 @@ class DropboxClient
         params = {
             "file_limit" => file_limit.to_s,
             "list" => list.to_s,
-            "include_deleted" => include_deleted.to_s
+            "include_deleted" => include_deleted.to_s,
+            "hash" => hash,
+            "rev" => rev,
         }
 
-        params["hash"] = hash if hash
-        params["rev"] = rev if rev
-
-        response = @session.do_get build_url("/metadata/#{@root}#{format_path(path)}", params=params)
+        response = @session.do_get "/metadata/#{@root}#{format_path(path)}", params
         if response.kind_of? Net::HTTPRedirection
-                raise DropboxNotModified.new("metadata not modified")
+            raise DropboxNotModified.new("metadata not modified")
         end
         Dropbox::parse_response(response)
     end
@@ -1043,7 +1074,7 @@ class DropboxClient
             'include_deleted' => include_deleted.to_s
         }
 
-        response = @session.do_get build_url("/search/#{@root}#{format_path(path)}", params)
+        response = @session.do_get "/search/#{@root}#{format_path(path)}", params
         Dropbox::parse_response(response)
     end
 
@@ -1061,14 +1092,12 @@ class DropboxClient
     #   For a detailed description of what this call returns, visit:
     #   https://www.dropbox.com/developers/reference/api#revisions
     def revisions(path, rev_limit=1000)
-
         params = {
             'rev_limit' => rev_limit.to_s
         }
 
-        response = @session.do_get build_url("/revisions/#{@root}#{format_path(path)}", params)
+        response = @session.do_get "/revisions/#{@root}#{format_path(path)}", params
         Dropbox::parse_response(response)
-
     end
 
     # Restore a file to a previous revision.
@@ -1086,7 +1115,7 @@ class DropboxClient
             'rev' => rev.to_s
         }
 
-        response = @session.do_post build_url("/restore/#{@root}#{format_path(path)}", params)
+        response = @session.do_post "/restore/#{@root}#{format_path(path)}", params
         Dropbox::parse_response(response)
     end
 
@@ -1101,9 +1130,9 @@ class DropboxClient
     #
     # Returns:
     # * 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'}
+    #      {'url': 'https://dl.dropboxusercontent.com/1/view/abcdefghijk/example', 'expires': 'Thu, 16 Sep 2011 01:01:25 +0000'}
     def media(path)
-        response = @session.do_get build_url("/media/#{@root}#{format_path(path)}")
+        response = @session.do_get "/media/#{@root}#{format_path(path)}"
         Dropbox::parse_response(response)
     end
 
@@ -1118,11 +1147,11 @@ class DropboxClient
     #
     # Returns:
     # * A Hash object that looks like the following example:
-    #      {'url': 'http://www.dropbox.com/s/m/a2mbDa2', 'expires': 'Thu, 16 Sep 2011 01:01:25 +0000'}
+    #      {'url': 'https://db.tt/c0mFuu1Y', 'expires': 'Tue, 01 Jan 2030 00:00:00 +0000'}
     #   For a detailed description of what this call returns, visit:
     #    https://www.dropbox.com/developers/reference/api#shares
     def shares(path)
-        response = @session.do_get build_url("/shares/#{@root}#{format_path(path)}")
+        response = @session.do_get "/shares/#{@root}#{format_path(path)}"
         Dropbox::parse_response(response)
     end
 
@@ -1203,12 +1232,11 @@ class DropboxClient
     # way.  To facilitate this, the _path_ strings above are lower-cased versions of
     # the actual path.  The _metadata_ dicts have the original, case-preserved path.
     def delta(cursor=nil)
-        params = {}
-        if cursor
-            params['cursor'] = cursor
-        end
+        params = {
+            'cursor' => cursor,
+        }
 
-        response = @session.do_post build_url("/delta", params)
+        response = @session.do_post "/delta", params
         Dropbox::parse_response(response)
     end
 
@@ -1222,15 +1250,13 @@ class DropboxClient
     # Returns:
     # * The HTTPResponse for the thumbnail request.
     def thumbnail_impl(from_path, size='large') # :nodoc:
-        from_path = format_path(from_path, true)
-
+        path = "/thumbnails/#{@root}#{format_path(from_path, true)}"
         params = {
             "size" => size
         }
-
-        url = build_url("/thumbnails/#{@root}#{from_path}", params, content_server=true)
-
-        @session.do_get url
+        headers = nil
+        content_server = true
+        @session.do_get path, params, headers, content_server
     end
     private :thumbnail_impl
 
@@ -1246,9 +1272,7 @@ class DropboxClient
     #      {"expires"=>"Fri, 31 Jan 2042 21:01:05 +0000", "copy_ref"=>"z1X6ATl6aWtzOGq0c3g5Ng"}
     def create_copy_ref(path)
         path = "/copy_ref/#{@root}#{format_path(path)}"
-
-        response = @session.do_get(build_url(path, {}))
-
+        response = @session.do_get path
         Dropbox::parse_response(response)
     end
 
@@ -1262,39 +1286,14 @@ class DropboxClient
     # Returns:
     # * A hash with the metadata of the new file.
     def add_copy_ref(to_path, copy_ref)
-        path = "/fileops/copy"
-
         params = {'from_copy_ref' => copy_ref,
                   'to_path' => "#{to_path}",
                   'root' => @root}
 
-        response = @session.do_post(build_url(path, params))
-
+        response = @session.do_post "/fileops/copy", params
         Dropbox::parse_response(response)
     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 = "/#{Dropbox::API_VERSION}#{url}"
-
-        target = URI::Generic.new("https", nil, host, port, nil, versioned_url, nil, nil, nil)
-
-        #add a locale param if we have one
-        #initialize a params object is we don't have one
-        if @locale
-            (params ||= {})['locale']=@locale
-        end
-
-        if params
-            target.query = params.collect {|k,v|
-                CGI.escape(k) + "=" + CGI.escape(v)
-            }.join("&")
-        end
-
-        target.to_s
-    end
-
     #From the oauth spec plus "/".  Slash should not be ecsaped
     RESERVED_CHARACTERS = /[^a-zA-Z0-9\-\.\_\~\/]/  # :nodoc:
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dropbox-sdk
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 1.6.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-08 00:00:00.000000000 Z
+date: 2013-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json