google_drive 1.0.0.pre1 → 1.0.0.pre2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 76b903fb2d84303774103ab6da528579367ce8a5
-  data.tar.gz: 04f591af34df950ba24d46a0ba0f6e099447f291
+  metadata.gz: 1d9ee76291f5aafbc59e093fe4e10d39e145f754
+  data.tar.gz: a0b8c073cc8aa484bdb7c0e7485272ac94c60991
 SHA512:
-  metadata.gz: e5253faaa7c32a502d296354cc1aa1728c79136d009f45fb05801c21b490b4f6ec81c6995d3486c5742b9ecf96f7408ced12d08b3b46d2c9a729ba1d3379a148
-  data.tar.gz: f52470706946884dd09e400b8fff2bd22af076947083910f58b92177566a80c96c8a9c833307c6f4ce9bc181ed7f6fa69723eff4a4e23faa31c0c91dd91a9c60
+  metadata.gz: 1d09a5b9cb38197481392383a56a37ca957e44676dc3d910d8832254cf1d4db8d03d287578be74a1adb6152596168aa4abe718adc5097dbb7e7989a4be559756
+  data.tar.gz: 5a24e7d09facd452ddd125ba6667c1307d848e3a813d71c7aa940025a1a936c0126e200cf87bee64efafa4dda2adfcefd88b63e176169d6d89a9d8a8e1daecb0

data/README.rdoc

@@ -1,8 +1,15 @@
-This is a Ruby 1.8/1.9/2.0 library to read/write files/spreadsheets in Google Drive/Docs.
+This is a Ruby 1.9/2.0 library to read/write files/spreadsheets in Google Drive/Docs.
 
 NOTE: This is NOT a library to create Google Drive App.
 
 
+= Incompatibility introduced in ver. 1.0.0
+
+Ver. 1.0.0 is not 100% backward compatible with 0.3.x. Some methods have been removed. Especially, GoogleDrive.login has been removed, and you must use GoogleDrive.login_with_oauth instead, as in the example code below.
+
+I recommend to switch to the new API. But if you somehow want to continue using the old API, you can keep using it by requiring "google_drive_v0" instead of "google_drive" and use GoogleDriveV0 class instead of GoogleDrive class. It should continue working at least until April 20, 2015 when Google stops support of Documents List API.
+
+
 = How to install
 
   $ sudo gem install google_drive
@@ -60,7 +67,7 @@ Example to read/write spreadsheets:
   # Same as the code above to get access_token...
   
   # Creates a session.
-  session = GoogleDrive.login(access_token)
+  session = GoogleDrive.login_with_oauth(access_token)
   
   # First worksheet of
   # https://docs.google.com/spreadsheet/ccc?key=pz7XtlQC-PYx-jrVMJErTcg

data/lib/google_drive/api_client_fetcher.rb

@@ -30,6 +30,9 @@ module GoogleDrive
 
         def initialize(client)
           @client = client
+          # Sets virtually infinite default timeout because some operations (e.g., uploading
+          # a large files/spreadsheets) can take very long.
+          @client.connection.options[:timeout] ||= 100000000
           @drive = @client.discovered_api("drive", "v2")
         end
 

data/lib/google_drive/authentication_error.rb

@@ -1,13 +1,13 @@
 # Author: Hiroshi Ichikawa <http://gimite.net/>
 # The license of this source is "New BSD Licence"
 
-require "google_drive/error"
+require "google_drive/response_code_error"
 
 
 module GoogleDrive
 
     # Raised when GoogleDrive.login has failed.
-    class AuthenticationError < GoogleDrive::Error
+    class AuthenticationError < GoogleDrive::ResponseCodeError
 
     end
     

data/lib/google_drive/error.rb

@@ -4,7 +4,7 @@
 
 module GoogleDrive
 
-    # Raised when spreadsheets.google.com has returned error.
+    # Raised on errors in this library.
     class Error < RuntimeError
 
     end

data/lib/google_drive/response_code_error.rb

@@ -0,0 +1,24 @@
+# Author: Hiroshi Ichikawa <http://gimite.net/>
+# The license of this source is "New BSD Licence"
+
+require "cgi"
+
+require "google_drive/error"
+
+
+module GoogleDrive
+
+    # Raised when an HTTP request has returned an unexpected response code.
+    class ResponseCodeError < GoogleDrive::Error
+
+        def initialize(code, body, method, url) #:nodoc:#
+          @code = code
+          @body = body
+          super("Response code %s for %s %s: %s" % [code, method, url, CGI.unescapeHTML(body)])
+        end
+
+        attr_reader(:code, :body)
+
+    end
+    
+end

data/lib/google_drive/session.rb

@@ -14,6 +14,7 @@ require "google_drive/util"
 require "google_drive/api_client_fetcher"
 require "google_drive/error"
 require "google_drive/authentication_error"
+require "google_drive/response_code_error"
 require "google_drive/spreadsheet"
 require "google_drive/worksheet"
 require "google_drive/collection"
@@ -419,11 +420,9 @@ module GoogleDrive
             if response.code == "401" && @on_auth_fail && @on_auth_fail.call()
               next
             end
-            if !(response.code =~ /^[23]/)
-              raise(
-                response.code == "401" ? AuthenticationError : GoogleDrive::Error,
-                "Response code #{response.code} for #{method} #{url}: " +
-                CGI.unescapeHTML(response.body))
+            if !(response.code =~ /^2/)
+              raise((response.code == "401" ? AuthenticationError : ResponseCodeError).
+                  new(response.code, response.body, method, url))
             end
             return convert_response(response, response_type)
           end

data/lib/google_drive/worksheet.rb

@@ -297,54 +297,48 @@ module GoogleDrive
               cell_entries[[row, col]] = entry
             end
 
-            # Updates cell values using batch operation.
-            # If the data is large, we split it into multiple operations, otherwise batch may fail.
-            @modified.each_slice(25) do |chunk|
-
-              xml = <<-EOS
-                <feed xmlns="http://www.w3.org/2005/Atom"
-                      xmlns:batch="http://schemas.google.com/gdata/batch"
-                      xmlns:gs="http://schemas.google.com/spreadsheets/2006">
-                  <id>#{h(self.cells_feed_url)}</id>
-              EOS
-              for row, col in chunk
-                value = @cells[[row, col]]
-                entry = cell_entries[[row, col]]
-                id = entry.css("id").text
-                edit_url = entry.css("link[rel='edit']")[0]["href"]
-                xml << <<-EOS
-                  <entry>
-                    <batch:id>#{h(row)},#{h(col)}</batch:id>
-                    <batch:operation type="update"/>
-                    <id>#{h(id)}</id>
-                    <link rel="edit" type="application/atom+xml"
-                      href="#{h(edit_url)}"/>
-                    <gs:cell row="#{h(row)}" col="#{h(col)}" inputValue="#{h(value)}"/>
-                  </entry>
-                EOS
-              end
-              xml << <<-"EOS"
-                </feed>
+            xml = <<-EOS
+              <feed xmlns="http://www.w3.org/2005/Atom"
+                    xmlns:batch="http://schemas.google.com/gdata/batch"
+                    xmlns:gs="http://schemas.google.com/spreadsheets/2006">
+                <id>#{h(self.cells_feed_url)}</id>
+            EOS
+            for row, col in @modified
+              value = @cells[[row, col]]
+              entry = cell_entries[[row, col]]
+              id = entry.css("id").text
+              edit_url = entry.css("link[rel='edit']")[0]["href"]
+              xml << <<-EOS
+                <entry>
+                  <batch:id>#{h(row)},#{h(col)}</batch:id>
+                  <batch:operation type="update"/>
+                  <id>#{h(id)}</id>
+                  <link rel="edit" type="application/atom+xml"
+                    href="#{h(edit_url)}"/>
+                  <gs:cell row="#{h(row)}" col="#{h(col)}" inputValue="#{h(value)}"/>
+                </entry>
               EOS
+            end
+            xml << <<-"EOS"
+              </feed>
+            EOS
 
-              batch_url = concat_url(self.cells_feed_url, "/batch")
-              result = @session.request(
-                  :post,
-                  batch_url,
-                  :data => xml,
-                  :header => {"Content-Type" => "application/atom+xml;charset=utf-8", "If-Match" => "*"})
-              for entry in result.css("entry")
-                interrupted = entry.css("batch|interrupted")[0]
-                if interrupted
-                  raise(GoogleDrive::Error, "Update has failed: %s" %
-                    interrupted["reason"])
-                end
-                if !(entry.css("batch|status").first["code"] =~ /^2/)
-                  raise(GoogleDrive::Error, "Updating cell %s has failed: %s" %
-                    [entry.css("id").text, entry.css("batch|status")[0]["reason"]])
-                end
+            batch_url = concat_url(self.cells_feed_url, "/batch")
+            result = @session.request(
+                :post,
+                batch_url,
+                :data => xml,
+                :header => {"Content-Type" => "application/atom+xml;charset=utf-8", "If-Match" => "*"})
+            for entry in result.css("entry")
+              interrupted = entry.css("batch|interrupted")[0]
+              if interrupted
+                raise(GoogleDrive::Error, "Update has failed: %s" %
+                  interrupted["reason"])
+              end
+              if !(entry.css("batch|status").first["code"] =~ /^2/)
+                raise(GoogleDrive::Error, "Updating cell %s has failed: %s" %
+                  [entry.css("id").text, entry.css("batch|status")[0]["reason"]])
               end
-
             end
 
             @modified.clear()

data/lib/{google_drive_v1.rb → google_drive_v0.rb}

@@ -5,13 +5,13 @@ require "rubygems"
 require "google/api_client"
 require "json"
 
-require "google_drive_v1/session"
+require "google_drive_v0/session"
 
 
-module GoogleDriveV1
+module GoogleDriveV0
 
-    # Authenticates with given +mail+ and +password+, and returns GoogleDriveV1::Session
-    # if succeeds. Raises GoogleDriveV1::AuthenticationError if fails.
+    # Authenticates with given +mail+ and +password+, and returns GoogleDriveV0::Session
+    # if succeeds. Raises GoogleDriveV0::AuthenticationError if fails.
     # Google Apps account is supported.
     #
     # +proxy+ is deprecated, and will be removed in the next version.
@@ -42,14 +42,14 @@ module GoogleDriveV1
     #   # Redirect the user to auth_url and get authorization code from redirect URL.
     #   auth_token = client.auth_code.get_token(
     #       authorization_code, :redirect_uri => "http://example.com/")
-    #   session = GoogleDriveV1.login_with_oauth(auth_token.token)
+    #   session = GoogleDriveV0.login_with_oauth(auth_token.token)
     #
     # Or, from existing refresh token:
     #
     #   auth_token = OAuth2::AccessToken.from_hash(client,
     #       {:refresh_token => refresh_token, :expires_at => expires_at})
     #   auth_token = auth_token.refresh!
-    #   session = GoogleDriveV1.login_with_oauth(auth_token.token)
+    #   session = GoogleDriveV0.login_with_oauth(auth_token.token)
     #
     # If your app is not a Web app, use "urn:ietf:wg:oauth:2.0:oob" as redirect_url. Then
     # authorization code is shown after authorization.
@@ -66,12 +66,12 @@ module GoogleDriveV1
 
     # Restores session using return value of auth_tokens method of previous session.
     #
-    # See GoogleDriveV1.login for description of parameter +proxy+.
+    # See GoogleDriveV0.login for description of parameter +proxy+.
     def self.restore_session(auth_tokens, proxy = nil)
       return Session.restore_session(auth_tokens, proxy)
     end
     
-    # Restores GoogleDriveV1::Session from +path+ and returns it.
+    # Restores GoogleDriveV0::Session from +path+ and returns it.
     # If +path+ doesn't exist or authentication has failed, prompts the user to authorize the access,
     # stores the session to +path+ and returns it.
     #
@@ -141,7 +141,7 @@ module GoogleDriveV1
 
       end
 
-      return GoogleDriveV1.login_with_oauth(auth.access_token)
+      return GoogleDriveV0.login_with_oauth(auth.access_token)
 
     end
 

data/lib/{google_drive_v1 → google_drive_v0}/acl.rb

@@ -3,14 +3,14 @@
 # Author: Hiroshi Ichikawa <http://gimite.net/>
 # The license of this source is "New BSD Licence"
 
-require "google_drive_v1/acl_entry"
+require "google_drive_v0/acl_entry"
 
-module GoogleDriveV1
+module GoogleDriveV0
 
     # ACL (access control list) of a spreadsheet.
     #
-    # Use GoogleDriveV1::Spreadsheet#acl to get GoogleDriveV1::Acl object.
-    # See GoogleDriveV1::Spreadsheet#acl for usage example.
+    # Use GoogleDriveV0::Spreadsheet#acl to get GoogleDriveV0::Acl object.
+    # See GoogleDriveV0::Spreadsheet#acl for usage example.
     #
     # This code is based on https://github.com/guyboertje/gdata-spreadsheet-ruby .
     class Acl
@@ -28,9 +28,9 @@ module GoogleDriveV1
 
         def_delegators(:@acls, :size, :[], :each)
 
-        # Adds a new entry. +entry+ is either a GoogleDriveV1::AclEntry or a Hash with keys
-        # :scope_type, :scope and :role. See GoogleDriveV1::AclEntry#scope_type and
-        # GoogleDriveV1::AclEntry#role for the document of the fields.
+        # Adds a new entry. +entry+ is either a GoogleDriveV0::AclEntry or a Hash with keys
+        # :scope_type, :scope and :role. See GoogleDriveV0::AclEntry#scope_type and
+        # GoogleDriveV0::AclEntry#role for the document of the fields.
         #
         # NOTE: This sends email to the new people.
         #

data/lib/{google_drive_v1 → google_drive_v0}/acl_entry.rb

@@ -4,11 +4,11 @@
 # Author: Phuogn Nguyen <https://github.com/phuongnd08>
 # The license of this source is "New BSD Licence"
 
-module GoogleDriveV1
+module GoogleDriveV0
 
     # An entry of an ACL (access control list) of a spreadsheet.
     #
-    # Use GoogleDriveV1::Acl#[] to get GoogleDriveV1::AclEntry object.
+    # Use GoogleDriveV0::Acl#[] to get GoogleDriveV0::AclEntry object.
     #
     # This code is based on https://github.com/guyboertje/gdata-spreadsheet-ruby .
     class AclEntry
@@ -41,7 +41,7 @@ module GoogleDriveV1
 
         def edit_url
           warn(
-              "WARNING: GoogleDriveV1::AclEntry\#edit_url is deprecated and will be removed in the next version.")
+              "WARNING: GoogleDriveV0::AclEntry\#edit_url is deprecated and will be removed in the next version.")
           return self.edit_url_internal
         end
 

data/lib/{google_drive_v1 → google_drive_v0}/api_client_fetcher.rb

@@ -6,7 +6,7 @@ require "uri"
 Net::HTTP.version_1_2
 
 
-module GoogleDriveV1
+module GoogleDriveV0
 
     class ApiClientFetcher
         

data/lib/google_drive_v0/authentication_error.rb

@@ -0,0 +1,14 @@
+# Author: Hiroshi Ichikawa <http://gimite.net/>
+# The license of this source is "New BSD Licence"
+
+require "google_drive_v0/error"
+
+
+module GoogleDriveV0
+
+    # Raised when GoogleDriveV0.login has failed.
+    class AuthenticationError < GoogleDriveV0::Error
+
+    end
+    
+end

data/lib/{google_drive_v1 → google_drive_v0}/basic_fetcher.rb

@@ -6,7 +6,7 @@ require "uri"
 Net::HTTP.version_1_2
 
 
-module GoogleDriveV1
+module GoogleDriveV0
 
     class BasicFetcher #:nodoc:
         

data/lib/{google_drive_v1 → google_drive_v0}/client_login_fetcher.rb

@@ -1,10 +1,10 @@
 # Author: Hiroshi Ichikawa <http://gimite.net/>
 # The license of this source is "New BSD Licence"
 
-require "google_drive_v1/basic_fetcher"
+require "google_drive_v0/basic_fetcher"
 
 
-module GoogleDriveV1
+module GoogleDriveV0
 
     class ClientLoginFetcher < BasicFetcher #:nodoc:
         

data/lib/{google_drive_v1 → google_drive_v0}/collection.rb

@@ -1,16 +1,16 @@
 # Author: Hiroshi Ichikawa <http://gimite.net/>
 # The license of this source is "New BSD Licence"
 
-require "google_drive_v1/util"
-require "google_drive_v1/error"
-require "google_drive_v1/spreadsheet"
+require "google_drive_v0/util"
+require "google_drive_v0/error"
+require "google_drive_v0/spreadsheet"
 
 
-module GoogleDriveV1
+module GoogleDriveV0
 
-    # Use GoogleDriveV1::Session#root_collection, GoogleDriveV1::Collection#subcollections,
-    # or GoogleDriveV1::Session#collection_by_url to get GoogleDriveV1::Collection object.
-    class Collection < GoogleDriveV1::File
+    # Use GoogleDriveV0::Session#root_collection, GoogleDriveV0::Collection#subcollections,
+    # or GoogleDriveV0::Session#collection_by_url to get GoogleDriveV0::Collection object.
+    class Collection < GoogleDriveV0::File
 
         include(Util)
         
@@ -44,7 +44,7 @@ module GoogleDriveV1
           return self.root? ? nil : super
         end
         
-        # Adds the given GoogleDriveV1::File to the collection.
+        # Adds the given GoogleDriveV0::File to the collection.
         def add(file)
           header = {"GData-Version" => "3.0", "Content-Type" => "application/atom+xml;charset=utf-8"}
           xml = <<-"EOS"
@@ -57,7 +57,7 @@ module GoogleDriveV1
           return nil
         end
 
-        # Creates a sub-collection with given title. Returns GoogleDriveV1::Collection object.
+        # Creates a sub-collection with given title. Returns GoogleDriveV0::Collection object.
         def create_subcollection(title)
           header = {"GData-Version" => "3.0", "Content-Type" => "application/atom+xml;charset=utf-8"}
           xml = <<-EOS
@@ -72,7 +72,7 @@ module GoogleDriveV1
           return @session.entry_element_to_file(doc)
         end
 
-        # Removes the given GoogleDriveV1::File from the collection.
+        # Removes the given GoogleDriveV0::File from the collection.
         def remove(file)
           url = to_v3_url("#{contents_url}/#{file.resource_id}")
           @session.request(:delete, url, :auth => :writely, :header => {"If-Match" => "*"})
@@ -117,7 +117,7 @@ module GoogleDriveV1
         end
         
         # Returns a file (can be a spreadsheet, document, subcollection or other files) in the
-        # collection which exactly matches +title+ as GoogleDriveV1::File.
+        # collection which exactly matches +title+ as GoogleDriveV0::File.
         # Returns nil if not found. If multiple collections with the +title+ are found, returns
         # one of them.
         #
@@ -126,7 +126,7 @@ module GoogleDriveV1
           return file_by_title_with_type(title, nil)
         end
         
-        # Returns its subcollection whose title exactly matches +title+ as GoogleDriveV1::Collection.
+        # Returns its subcollection whose title exactly matches +title+ as GoogleDriveV0::Collection.
         # Returns nil if not found. If multiple collections with the +title+ are found, returns
         # one of them.
         #