google_drive 0.3.11 → 1.0.0.pre1

data/lib/google_drive/worksheet.rb

@@ -1,7 +1,9 @@
 # Author: Hiroshi Ichikawa <http://gimite.net/>
 # The license of this source is "New BSD Licence"
 
+require "cgi"
 require "set"
+require "uri"
 
 require "google_drive/util"
 require "google_drive/error"
@@ -17,13 +19,11 @@ module GoogleDrive
 
         include(Util)
 
-        def initialize(session, spreadsheet, cells_feed_url, title = nil, updated = nil) #:nodoc:
+        def initialize(session, spreadsheet, worksheet_feed_entry) #:nodoc:
           
           @session = session
           @spreadsheet = spreadsheet
-          @cells_feed_url = cells_feed_url
-          @title = title
-          @updated = updated
+          set_worksheet_feed_entry(worksheet_feed_entry)
 
           @cells = nil
           @input_values = nil
@@ -33,31 +33,63 @@ module GoogleDrive
           
         end
 
+        # Nokogiri::XML::Element object of the <entry> element in a worksheets feed.
+        attr_reader(:worksheet_feed_entry)
+
+        # Title of the worksheet (shown as tab label in Web interface).
+        attr_reader(:title)
+
+        # Time object which represents the time the worksheet was last updated.
+        attr_reader(:updated)
+
         # URL of cell-based feed of the worksheet.
-        attr_reader(:cells_feed_url)
+        def cells_feed_url
+          return @worksheet_feed_entry.css(
+              "link[rel='http://schemas.google.com/spreadsheets/2006#cellsfeed']")[0]["href"]
+        end
 
         # URL of worksheet feed URL of the worksheet.
         def worksheet_feed_url
-          # I don't know good way to get worksheet feed URL from cells feed URL.
-          # Probably it would be cleaner to keep worksheet feed URL and get cells feed URL
-          # from it.
-          if !(@cells_feed_url =~
-              %r{^https?://spreadsheets.google.com/feeds/cells/(.*)/(.*)/private/full((\?.*)?)$})
-            raise(GoogleDrive::Error,
-              "Cells feed URL is in unknown format: #{@cells_feed_url}")
-          end
-          return "https://spreadsheets.google.com/feeds/worksheets/#{$1}/private/full/#{$2}#{$3}"
+          return @worksheet_feed_entry.css("link[rel='self']")[0]["href"]
+        end
+
+        # URL to export the worksheet as CSV.
+        def csv_export_url
+          return @worksheet_feed_entry.css(
+              "link[rel='http://schemas.google.com/spreadsheets/2006#exportcsv']")[0]["href"]
+        end
+
+        # Exports the worksheet as String in CSV format.
+        def export_as_string()
+          api_result = @session.execute!(:uri => self.csv_export_url)
+          return api_result.body
+        end
+
+        # Exports the worksheet to +path+ in CSV format.
+        def export_as_file(path)
+          data = export_as_string()
+          open(path, "w:utf-8"){ |f| f.write(data) }
+        end
+
+        # gid of the worksheet.
+        def gid
+          # A bit tricky but couldn't find a better way.
+          return CGI.parse(URI.parse(self.csv_export_url).query)["gid"].last
+        end
+
+        # URL to view/edit the worksheet in a Web browser.
+        def human_url
+          return "%s\#gid=%s" % [self.spreadsheet.human_url, self.gid]
         end
 
         # GoogleDrive::Spreadsheet which this worksheet belongs to.
         def spreadsheet
           if !@spreadsheet
-            if !(@cells_feed_url =~
-                %r{^https?://spreadsheets.google.com/feeds/cells/(.*)/(.*)/private/full(\?.*)?$})
+            if !(self.worksheet_feed_url =~ %r{https?://spreadsheets\.google\.com/feeds/worksheets/(.*)/(.*)$})
               raise(GoogleDrive::Error,
-                "Cells feed URL is in unknown format: #{@cells_feed_url}")
+                  "Worksheet feed URL is in unknown format: #{self.worksheet_feed_url}")
             end
-            @spreadsheet = @session.spreadsheet_by_key($1)
+            @spreadsheet = @session.file_by_id($1)
           end
           return @spreadsheet
         end
@@ -85,7 +117,7 @@ module GoogleDrive
         def []=(*args)
           (row, col) = parse_cell_args(args[0...-1])
           value = args[-1].to_s()
-          reload() if !@cells
+          reload_cells() if !@cells
           @cells[[row, col]] = value
           @input_values[[row, col]] = value
           @numeric_values[[row, col]] = nil
@@ -122,7 +154,7 @@ module GoogleDrive
         #   worksheet.input_value(1, 3)  #=> "=RC[-2]+RC[-1]"
         def input_value(*args)
           (row, col) = parse_cell_args(args)
-          reload() if !@cells
+          reload_cells() if !@cells
           return @input_values[[row, col]] || ""
         end
 
@@ -141,13 +173,13 @@ module GoogleDrive
         # https://developers.google.com/google-apps/spreadsheets/#working_with_cell-based_feeds
         def numeric_value(*args)
           (row, col) = parse_cell_args(args)
-          reload() if !@cells
+          reload_cells() if !@cells
           return @numeric_values[[row, col]]
         end
         
         # Row number of the bottom-most non-empty row.
         def num_rows
-          reload() if !@cells
+          reload_cells() if !@cells
           # Memoizes it because this can be bottle-neck.
           # https://github.com/gimite/google-drive-ruby/pull/49
           return @num_rows ||= @input_values.select(){ |(r, c), v| !v.empty? }.map(){ |(r, c), v| r }.max || 0
@@ -155,7 +187,7 @@ module GoogleDrive
 
         # Column number of the right-most non-empty column.
         def num_cols
-          reload() if !@cells
+          reload_cells() if !@cells
           # Memoizes it because this can be bottle-neck.
           # https://github.com/gimite/google-drive-ruby/pull/49
           return @num_cols ||= @input_values.select(){ |(r, c), v| !v.empty? }.map(){ |(r, c), v| c }.max || 0
@@ -163,54 +195,41 @@ module GoogleDrive
 
         # Number of rows including empty rows.
         def max_rows
-          reload() if !@cells
+          reload_cells() if !@cells
           return @max_rows
         end
 
         # Updates number of rows.
         # Note that update is not sent to the server until you call save().
         def max_rows=(rows)
-          reload() if !@cells
+          reload_cells() if !@cells
           @max_rows = rows
           @meta_modified = true
         end
 
         # Number of columns including empty columns.
         def max_cols
-          reload() if !@cells
+          reload_cells() if !@cells
           return @max_cols
         end
 
         # Updates number of columns.
         # Note that update is not sent to the server until you call save().
         def max_cols=(cols)
-          reload() if !@cells
+          reload_cells() if !@cells
           @max_cols = cols
           @meta_modified = true
         end
 
-        # Title of the worksheet (shown as tab label in Web interface).
-        def title
-          reload() if !@title
-          return @title
-        end
-
-         # Date updated of the worksheet (shown as tab label in Web interface).
-        def updated
-          reload() if !@updated
-          return @updated
-        end
-
         # Updates title of the worksheet.
         # Note that update is not sent to the server until you call save().
         def title=(title)
-          reload() if !@cells
           @title = title
           @meta_modified = true
         end
 
         def cells #:nodoc:
-          reload() if !@cells
+          reload_cells() if !@cells
           return @cells
         end
 
@@ -229,31 +248,9 @@ module GoogleDrive
         # Reloads content of the worksheets from the server.
         # Note that changes you made by []= etc. is discarded if you haven't called save().
         def reload()
-          
-          doc = @session.request(:get, @cells_feed_url)
-          @max_rows = doc.css("gs|rowCount").text.to_i()
-          @max_cols = doc.css("gs|colCount").text.to_i()
-          @title = doc.css("feed > title")[0].text
-
-          @num_cols = nil
-          @num_rows = nil
-
-          @cells = {}
-          @input_values = {}
-          @numeric_values = {}
-          doc.css("feed > entry").each() do |entry|
-            cell = entry.css("gs|cell")[0]
-            row = cell["row"].to_i()
-            col = cell["col"].to_i()
-            @cells[[row, col]] = cell.inner_text
-            @input_values[[row, col]] = cell["inputValue"] || cell.inner_text
-            numeric_value = cell["numericValue"]
-            @numeric_values[[row, col]] = numeric_value ? numeric_value.to_f() : nil
-          end
-          @modified.clear()
-          @meta_modified = false
+          set_worksheet_feed_entry(@session.request(:get, self.worksheet_feed_url).root)
+          reload_cells()
           return true
-          
         end
 
         # Saves your changes made by []=, etc. to the server.
@@ -263,8 +260,7 @@ module GoogleDrive
 
           if @meta_modified
 
-            ws_doc = @session.request(:get, self.worksheet_feed_url)
-            edit_url = ws_doc.css("link[rel='edit']")[0]["href"]
+            edit_url = @worksheet_feed_entry.css("link[rel='edit']")[0]["href"]
             xml = <<-"EOS"
               <entry xmlns='http://www.w3.org/2005/Atom'
                      xmlns:gs='http://schemas.google.com/spreadsheets/2006'>
@@ -274,11 +270,11 @@ module GoogleDrive
               </entry>
             EOS
 
-            @session.request(
+            result = @session.request(
                 :put, edit_url, :data => xml,
                 :header => {"Content-Type" => "application/atom+xml;charset=utf-8", "If-Match" => "*"})
+            set_worksheet_feed_entry(result.root)
 
-            @meta_modified = false
             sent = true
 
           end
@@ -290,7 +286,7 @@ module GoogleDrive
             cell_entries = {}
             rows = @modified.map(){ |r, c| r }
             cols = @modified.map(){ |r, c| c }
-            url = concat_url(@cells_feed_url,
+            url = concat_url(self.cells_feed_url,
                 "?return-empty=true&min-row=#{rows.min}&max-row=#{rows.max}" +
                 "&min-col=#{cols.min}&max-col=#{cols.max}")
             doc = @session.request(:get, url)
@@ -309,7 +305,7 @@ module GoogleDrive
                 <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(@cells_feed_url)}</id>
+                  <id>#{h(self.cells_feed_url)}</id>
               EOS
               for row, col in chunk
                 value = @cells[[row, col]]
@@ -331,9 +327,13 @@ module GoogleDrive
                 </feed>
               EOS
 
-              batch_url = concat_url(@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("atom|entry")
+              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" %
@@ -341,7 +341,7 @@ module GoogleDrive
                 end
                 if !(entry.css("batch|status").first["code"] =~ /^2/)
                   raise(GoogleDrive::Error, "Updating cell %s has failed: %s" %
-                    [entry.css("atom|id").text, entry.css("batch|status")[0]["reason"]])
+                    [entry.css("id").text, entry.css("batch|status")[0]["reason"]])
                 end
               end
 
@@ -424,11 +424,7 @@ module GoogleDrive
 
         # List feed URL of the worksheet.
         def list_feed_url
-          # Gets the worksheets metafeed.
-          entry = @session.request(:get, self.worksheet_feed_url)
-
-          # Gets the URL of list-based feed for the given spreadsheet.
-          return entry.css(
+          return @worksheet_feed_entry.css(
             "link[rel='http://schemas.google.com/spreadsheets/2006#listfeed']")[0]["href"]
         end
         
@@ -477,6 +473,38 @@ module GoogleDrive
         
       private
 
+        def set_worksheet_feed_entry(entry)
+          @worksheet_feed_entry = entry
+          @title = entry.css("title").text
+          @updated = Time.parse(entry.css("updated").text)
+          @meta_modified = false
+        end
+
+        def reload_cells()
+          
+          doc = @session.request(:get, self.cells_feed_url)
+          @max_rows = doc.css("gs|rowCount").text.to_i()
+          @max_cols = doc.css("gs|colCount").text.to_i()
+
+          @num_cols = nil
+          @num_rows = nil
+
+          @cells = {}
+          @input_values = {}
+          @numeric_values = {}
+          doc.css("feed > entry").each() do |entry|
+            cell = entry.css("gs|cell")[0]
+            row = cell["row"].to_i()
+            col = cell["col"].to_i()
+            @cells[[row, col]] = cell.inner_text
+            @input_values[[row, col]] = cell["inputValue"] || cell.inner_text
+            numeric_value = cell["numericValue"]
+            @numeric_values[[row, col]] = numeric_value ? numeric_value.to_f() : nil
+          end
+          @modified.clear()
+
+        end
+
         def parse_cell_args(args)
           if args.size == 1 && args[0].is_a?(String)
             return cell_name_to_row_col(args[0])

data/lib/google_drive.rb

@@ -1,76 +1,84 @@
 # Author: Hiroshi Ichikawa <http://gimite.net/>
 # The license of this source is "New BSD Licence"
 
-require "rubygems"
-require "google/api_client"
 require "json"
+require "google/api_client"
 
 require "google_drive/session"
 
 
 module GoogleDrive
 
-    # Authenticates with given +mail+ and +password+, and returns GoogleDrive::Session
-    # if succeeds. Raises GoogleDrive::AuthenticationError if fails.
-    # Google Apps account is supported.
-    #
-    # +proxy+ is deprecated, and will be removed in the next version.
-    def self.login(mail, password, proxy = nil)
-      return Session.login(mail, password, proxy)
-    end
-
     # Authenticates with given OAuth2 token.
     #
-    # +access_token+ can be either OAuth2 access_token string or OAuth2::AccessToken.
-    # Specifying OAuth::AccessToken is deprecated, and will not work in the next version.
-    #
-    # +proxy+ is deprecated, and will be removed in the next version.
+    # +access_token+ can be either OAuth2 access_token string, or OAuth2::AccessToken.
     #
-    # OAuth2 code example:
+    # OAuth2 code example for Web apps:
     #
-    #   client = OAuth2::Client.new(
-    #       your_client_id, your_client_secret,
-    #       :site => "https://accounts.google.com",
-    #       :token_url => "/o/oauth2/token",
-    #       :authorize_url => "/o/oauth2/auth")
-    #   auth_url = client.auth_code.authorize_url(
-    #       :redirect_uri => "http://example.com/",
-    #       :scope =>
-    #           "https://docs.google.com/feeds/ " +
-    #           "https://docs.googleusercontent.com/ " +
-    #           "https://spreadsheets.google.com/feeds/")
+    #   require "rubygems"
+    #   require "google/api_client"
+    #   client = Google::APIClient.new
+    #   auth = client.authorization
+    #   # Follow "Create a client ID and client secret" in
+    #   # https://developers.google.com/drive/web/auth/web-server] to get a client ID and client secret.
+    #   auth.client_id = "YOUR CLIENT ID"
+    #   auth.client_secret = "YOUR CLIENT SECRET"
+    #   auth.scope =
+    #       "https://www.googleapis.com/auth/drive " +
+    #       "https://spreadsheets.google.com/feeds/"
+    #   auth.redirect_uri = "http://example.com/redirect"
+    #   auth_url = auth.authorization_uri
     #   # 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 = GoogleDrive.login_with_oauth(auth_token.token)
+    #   auth.code = authorization_code
+    #   auth.fetch_access_token!
+    #   session = GoogleDrive.login_with_oauth(auth.access_token)
     #
-    # Or, from existing refresh token:
+    # auth.access_token expires in 1 hour. If you want to restore a session afterwards, you can store
+    # auth.refresh_token somewhere after auth.fetch_access_token! above, and use this code:
     #
-    #   auth_token = OAuth2::AccessToken.from_hash(client,
-    #       {:refresh_token => refresh_token, :expires_at => expires_at})
-    #   auth_token = auth_token.refresh!
-    #   session = GoogleDrive.login_with_oauth(auth_token.token)
+    #   require "rubygems"
+    #   require "google/api_client"
+    #   client = Google::APIClient.new
+    #   auth = client.authorization
+    #   # Follow "Create a client ID and client secret" in
+    #   # https://developers.google.com/drive/web/auth/web-server] to get a client ID and client secret.
+    #   auth.client_id = "YOUR CLIENT ID"
+    #   auth.client_secret = "YOUR CLIENT SECRET"
+    #   auth.scope =
+    #       "https://www.googleapis.com/auth/drive " +
+    #       "https://spreadsheets.google.com/feeds/"
+    #   auth.redirect_uri = "http://example.com/redirect"
+    #   auth.refresh_token = refresh_token
+    #   auth.fetch_access_token!
+    #   session = GoogleDrive.login_with_oauth(auth.access_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.
+    # OAuth2 code example for command-line apps:
     #
-    # See these documents for details:
+    #   require "rubygems"
+    #   require "google/api_client"
+    #   client = Google::APIClient.new
+    #   auth = client.authorization
+    #   # Follow "Create a client ID and client secret" in
+    #   # https://developers.google.com/drive/web/auth/web-server] to get a client ID and client secret.
+    #   auth.client_id = "YOUR CLIENT ID"
+    #   auth.client_secret = "YOUR CLIENT SECRET"
+    #   auth.scope =
+    #       "https://www.googleapis.com/auth/drive " +
+    #       "https://spreadsheets.google.com/feeds/"
+    #   auth.redirect_uri = "urn:ietf:wg:oauth:2.0:oob"
+    #   print("1. Open this page:\n%s\n\n" % auth.authorization_uri)
+    #   print("2. Enter the authorization code shown in the page: ")
+    #   auth.code = $stdin.gets.chomp
+    #   auth.fetch_access_token!
+    #   session = GoogleDrive.login_with_oauth(auth.access_token)
     #
-    # - https://github.com/intridea/oauth2
-    # - http://code.google.com/apis/accounts/docs/OAuth2.html
-    # - http://oauth.rubyforge.org/
-    # - http://code.google.com/apis/accounts/docs/OAuth.html
-    def self.login_with_oauth(access_token, proxy = nil)
-      return Session.login_with_oauth(access_token, proxy)
-    end
-
-    # Restores session using return value of auth_tokens method of previous session.
+    # See this document for details:
     #
-    # See GoogleDrive.login for description of parameter +proxy+.
-    def self.restore_session(auth_tokens, proxy = nil)
-      return Session.restore_session(auth_tokens, proxy)
+    # - https://developers.google.com/drive/web/about-auth
+    def self.login_with_oauth(client_or_access_token, proxy = nil)
+      return Session.new(client_or_access_token, proxy)
     end
-    
+
     # Restores GoogleDrive::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.
@@ -111,16 +119,14 @@ module GoogleDrive
 
       client = Google::APIClient.new(
           :application_name => "google_drive Ruby library",
-          :application_version => "0.3.11"
+          :application_version => "0.4.0"
       )
       auth = client.authorization
       auth.client_id = client_id
       auth.client_secret = client_secret
       auth.scope =
           "https://www.googleapis.com/auth/drive " +
-          "https://spreadsheets.google.com/feeds/ " +
-          "https://docs.google.com/feeds/ " +
-          "https://docs.googleusercontent.com/"
+          "https://spreadsheets.google.com/feeds/"
       auth.redirect_uri = "urn:ietf:wg:oauth:2.0:oob"
 
       if token_data
@@ -141,8 +147,8 @@ module GoogleDrive
 
       end
 
-      return GoogleDrive.login_with_oauth(auth.access_token)
+      return GoogleDrive.login_with_oauth(client)
 
     end
-
+    
 end

data/lib/google_drive_v1/acl.rb

@@ -0,0 +1,115 @@
+# Author: Guy Boertje <https://github.com/guyboertje>
+# Author: David R. Albrecht <https://github.com/eldavido>
+# Author: Hiroshi Ichikawa <http://gimite.net/>
+# The license of this source is "New BSD Licence"
+
+require "google_drive_v1/acl_entry"
+
+module GoogleDriveV1
+
+    # ACL (access control list) of a spreadsheet.
+    #
+    # Use GoogleDriveV1::Spreadsheet#acl to get GoogleDriveV1::Acl object.
+    # See GoogleDriveV1::Spreadsheet#acl for usage example.
+    #
+    # This code is based on https://github.com/guyboertje/gdata-spreadsheet-ruby .
+    class Acl
+
+        include(Util)
+        extend(Forwardable)
+
+        def initialize(session, acls_feed_url) #:nodoc:
+          @session = session
+          @acls_feed_url = acls_feed_url
+          header = {"GData-Version" => "3.0"}
+          doc = @session.request(:get, @acls_feed_url, :header => header, :auth => :writely)
+          @acls = doc.css("entry").map(){ |e| AclEntry.new(entry_to_params(e)) }
+        end
+
+        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.
+        #
+        # NOTE: This sends email to the new people.
+        #
+        # e.g.
+        #   # A specific user can read or write.
+        #   spreadsheet.acl.push(
+        #       {:scope_type => "user", :scope => "example2@gmail.com", :role => "reader"})
+        #   spreadsheet.acl.push(
+        #       {:scope_type => "user", :scope => "example3@gmail.com", :role => "writer"})
+        #   # Publish on the Web.
+        #   spreadsheet.acl.push(
+        #       {:scope_type => "default", :role => "reader"})
+        #   # Anyone who knows the link can read.
+        #   spreadsheet.acl.push(
+        #       {:scope_type => "default", :with_key => true, :role => "reader"})
+        def push(entry)
+
+          entry = AclEntry.new(entry) if entry.is_a?(Hash)
+
+          header = {"GData-Version" => "3.0", "Content-Type" => "application/atom+xml;charset=utf-8"}
+          doc = @session.request(
+              :post, @acls_feed_url, :data => entry.to_xml(), :header => header, :auth => :writely)
+
+          entry.params = entry_to_params(doc.root)
+          @acls.push(entry)
+          return entry
+
+        end
+
+        # Deletes an ACL entry.
+        #
+        # e.g.
+        #   spreadsheet.acl.delete(spreadsheet.acl[1])
+        def delete(entry)
+          header = {"GData-Version" => "3.0"}
+          @session.request(:delete, entry.edit_url_internal, :header => header, :auth => :writely)
+          @acls.delete(entry)
+        end
+
+        def update_role(entry) #:nodoc:
+
+          header = {"GData-Version" => "3.0", "Content-Type" => "application/atom+xml;charset=utf-8"}
+          doc = @session.request(
+              :put, entry.edit_url_internal, :data => entry.to_xml(), :header => header, :auth => :writely)
+
+          entry.params = entry_to_params(doc.root)
+          return entry
+
+        end
+
+        def inspect
+          return "\#<%p %p>" % [self.class, @acls]
+        end
+
+      private
+
+        def entry_to_params(entry)
+          
+          if !entry.css("gAcl|withKey").empty?
+            with_key = true
+            role = entry.css("gAcl|withKey gAcl|role")[0]["value"]
+          else
+            with_key = false
+            role = entry.css("gAcl|role")[0]["value"]
+          end
+
+          return {
+            :acl => self,
+            :scope_type => entry.css("gAcl|scope")[0]["type"],
+            :scope => entry.css("gAcl|scope")[0]["value"],
+            :with_key => with_key,
+            :role => role,
+            :title => entry.css("title").text,
+            :edit_url => entry.css("link[rel='edit']")[0]["href"],
+            :etag => entry["etag"],
+          }
+          
+        end
+
+    end
+
+end