google_drive 0.3.0 → 0.3.1

data/README.rdoc

@@ -1,5 +1,7 @@
 This is a Ruby 1.8/1.9 library to read/write files/spreadsheets in Google Drive/Docs.
 
+NOTE: This is NOT a library to create Google Drive App.
+
 
 = How to install
 

data/lib/google_drive.rb

@@ -29,7 +29,10 @@ module GoogleDrive
     #       :authorize_url => "/o/oauth2/auth")
     #   auth_url = client.auth_code.authorize_url(
     #       :redirect_uri => "http://example.com/",
-    #       "scope" => "https://spreadsheets.google.com/feeds https://docs.google.com/feeds/")
+    #       :scope =>
+    #           "https://docs.google.com/feeds/ " +
+    #           "https://docs.googleusercontent.com/ " +
+    #           "https://spreadsheets.google.com/feeds/")
     #   # 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/")
@@ -42,6 +45,9 @@ module GoogleDrive
     #   access_token = access_token.refresh!
     #   session = GoogleDrive.login_with_oauth(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.
+    #
     # OAuth1 code example:
     #
     # 1) First generate OAuth consumer object with key and secret for your site by registering site

data/lib/google_drive/collection.rb

@@ -8,21 +8,45 @@ require "google_drive/spreadsheet"
 
 module GoogleDrive
 
-    # Use GoogleDrive::Session#collection_by_url to get GoogleDrive::Collection object.
-    class Collection
+    # Use GoogleDrive::Session#root_collection, GoogleDrive::Collection#subcollections,
+    # or GoogleDrive::Session#collection_by_url to get GoogleDrive::Collection object.
+    class Collection < GoogleDrive::File
 
         include(Util)
         
-        def initialize(session, collection_feed_url) #:nodoc:
-          @session = session
-          @collection_feed_url = collection_feed_url
+        #:nodoc:
+        ROOT_URL = "#{DOCS_BASE_URL}/folder%3Aroot"
+
+        alias collection_feed_url document_feed_url
+        
+        def contents_url
+          if self.root?
+            # The root collection doesn't have document feed.
+            return concat_url(ROOT_URL, "/contents")
+          else
+            return self.document_feed_entry.css(
+                "content[type='application/atom+xml;type=feed']")[0]["src"]
+          end
         end
         
-        attr_reader(:collection_feed_url)
+        # Title of the collection.
+        #
+        # Set <tt>params[:reload]</tt> to true to force reloading the title.
+        def title(params = {})
+          if self.root?
+            # The root collection doesn't have document feed.
+            return nil
+          else
+            return super
+          end
+        end
+
+        def resource_id
+          return self.root? ? nil : super
+        end
         
         # Adds the given GoogleDrive::File to the collection.
         def add(file)
-          contents_url = concat_url(@collection_feed_url, "/contents")
           header = {"GData-Version" => "3.0", "Content-Type" => "application/atom+xml"}
           xml = <<-"EOS"
             <entry xmlns="http://www.w3.org/2005/Atom">
@@ -30,25 +54,87 @@ module GoogleDrive
             </entry>
           EOS
           @session.request(
-              :post, contents_url, :data => xml, :header => header, :auth => :writely)
+              :post, self.contents_url, :data => xml, :header => header, :auth => :writely)
           return nil
         end
 
-        # Returns all the files in the collection.
-        def files
-          contents_url = concat_url(@collection_feed_url, "/contents")
+        # Creates a sub-collection with given title. Returns GoogleDrive::Collection object.
+        def create_subcollection(title)
           header = {"GData-Version" => "3.0", "Content-Type" => "application/atom+xml"}
-          doc = @session.request(:get, contents_url, :header => header, :auth => :writely)
-          return doc.css("feed > entry").map(){ |e| @session.entry_element_to_file(e) }
+          xml = <<-EOS
+            <entry xmlns="http://www.w3.org/2005/Atom">
+              <category scheme="http://schemas.google.com/g/2005#kind"
+                term="http://schemas.google.com/docs/2007#folder"/>
+              <title>#{h(title)}</title>
+            </entry>
+          EOS
+          doc = @session.request(
+              :post, contents_url, :data => xml, :header => header, :auth => :writely)
+          return @session.entry_element_to_file(doc)
         end
-        
+
+        # Removes the given GoogleDrive::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" => "*"})
+        end
+
+        # Returns true if this is a root collection
+        def root?
+          self.document_feed_url == ROOT_URL
+        end
+
+        # Returns all the files (including spreadsheets, documents, subcollections) in the collection.
+        #
+        # You can specify query parameters described at
+        # https://developers.google.com/google-apps/documents-list/#getting_a_list_of_documents_and_files
+        #
+        # e.g.
+        #
+        #   # Gets all the files in collection, including subcollections.
+        #   collection.files
+        #   
+        #   # Gets only files with title "hoge".
+        #   collection.files("title" => "hoge", "title-exact" => "true")
+        def files(params = {})
+          return files_with_type(nil, params)
+        end
+
+        alias contents files
+
         # Returns all the spreadsheets in the collection.
-        def spreadsheets
-          return self.files.select(){ |f| f.is_a?(Spreadsheet) }
+        def spreadsheets(params = {})
+          return files_with_type("spreadsheet", params)
+        end
+        
+        # Returns all the Google Docs documents in the collection.
+        def documents(params = {})
+          return files_with_type("document", params)
+        end
+        
+        # Returns all its subcollections.
+        def subcollections(params = {})
+          return files_with_type("folder", params)
+        end
+        
+        # Returns its subcollection whose title exactly matches +title+ as GoogleDrive::Collection.
+        # Returns nil if not found. If multiple collections with the +title+ are found, returns
+        # one of them.
+        def subcollection_by_title(title)
+          return subcollections("title" => title, "title-exact" => "true")[0]
         end
         
-        # TODO Add other operations.
+      private
 
+        def files_with_type(type, params = {})
+          contents_url = self.contents_url
+          contents_url = concat_url(contents_url, "/-/#{type}") if type
+          contents_url = concat_url(contents_url, "?" + encode_query(params))
+          header = {"GData-Version" => "3.0", "Content-Type" => "application/atom+xml"}
+          doc = @session.request(:get, contents_url, :header => header, :auth => :writely)
+          return doc.css("feed > entry").map(){ |e| @session.entry_element_to_file(e) }
+        end
+        
     end
     
 end

data/lib/google_drive/file.rb

@@ -1,6 +1,7 @@
 # Author: Hiroshi Ichikawa <http://gimite.net/>
 # The license of this source is "New BSD Licence"
 
+require "cgi"
 require "stringio"
 
 require "google_drive/util"
@@ -17,11 +18,24 @@ module GoogleDrive
 
         include(Util)
         
-        def initialize(session, entry) #:nodoc:
+        def initialize(session, entry_or_url) #:nodoc:
           @session = session
-          @document_feed_entry = entry
-          @document_feed_url = entry ? entry.css("link[rel='self']")[0]["href"] : nil
-          @title = entry ? entry.css("title")[0].text : nil
+          if !entry_or_url
+            # TODO Delete this after editing spreadsheet.rb.
+            @document_feed_entry = nil
+            @document_feed_url = entry_or_url
+          elsif entry_or_url.is_a?(String)
+            @document_feed_entry = nil
+            @document_feed_url = entry_or_url
+          else
+            @document_feed_entry = entry_or_url
+            # This is usually equal to the URL in <link rel="self">. But the URL in
+            # <link rel="self"> in collection feed is e.g.
+            # https://docs.google.com/feeds/default/private/full/folder%3Aroot/contents/folder%3Axxx
+            # and deletion of the URL doesn't delete the file itself.
+            # So we construct the URL here using resource ID instead.
+            @document_feed_url = "%s/%s" % [DOCS_BASE_URL, CGI.escape(self.resource_id)]
+          end
           @acl = nil
         end
         
@@ -29,10 +43,32 @@ module GoogleDrive
         attr_reader(:document_feed_url)
         
         # <entry> element of document list feed as Nokogiri::XML::Element.
-        attr_reader(:document_feed_entry)
-        
+        #
+        # Set <tt>params[:reload]</tt> to true to force reloading the feed.
+        def document_feed_entry(params = {})
+          if !@document_feed_entry || params[:reload]
+            @document_feed_entry =
+                @session.request(:get, self.document_feed_url, :auth => :writely).css("entry")[0]
+          end
+          return @document_feed_entry
+        end
+
+        # Resource ID.
+        def resource_id
+          return self.document_feed_entry.css("gd|resourceId").text
+        end
+
+        # The type of resourse. e.g. "document", "spreadsheet", "folder"
+        def resource_type
+          return self.resource_id.split(/:/)[0]
+        end
+
         # Title of the file.
-        attr_reader(:title)
+        #
+        # Set <tt>params[:reload]</tt> to true to force reloading the title.
+        def title(params = {})
+          return document_feed_entry(params).css("title").text
+        end
         
         # URL to view/edit the file in a Web browser.
         #
@@ -50,7 +86,7 @@ module GoogleDrive
               return orig_acl_feed_url
             when %r{^https?://docs.google.com/feeds/acl/private/full/([^\?]*)(\?.*)?$}
               # URL of old API version. Converts to v3 URL.
-              return "https://docs.google.com/feeds/default/private/full/#{$1}/acl"
+              return "#{DOCS_BASE_URL}/#{$1}/acl"
             else
               raise(GoogleDrive::Error,
                 "ACL feed URL is in unknown format: #{orig_acl_feed_url}")
@@ -149,8 +185,9 @@ module GoogleDrive
         # If +permanent+ is +false+, moves the file to the trash.
         # If +permanent+ is +true+, deletes the file permanently.
         def delete(permanent = false)
-          @session.request(:delete,
-            self.document_feed_url + (permanent ? "?delete=true" : ""),
+          url = to_v3_url(self.document_feed_url)
+          url = concat_url(url, "?delete=true") if permanent
+          @session.request(:delete, url,
             :auth => :writely, :header => {"If-Match" => "*"})
         end
 
@@ -180,7 +217,7 @@ module GoogleDrive
         # With the object, you can see and modify people who can access the file.
         # Modifications take effect immediately.
         #
-        # Set <tt>params[:reload]</tt> to true to force reloading the title.
+        # Set <tt>params[:reload]</tt> to true to force reloading the data.
         #
         # e.g.
         #   # Dumps people who have access:
@@ -209,7 +246,9 @@ module GoogleDrive
         end
 
         def inspect
-          return "\#<%p document_feed_url=%p>" % [self.class, self.document_feed_url]
+          fields = {:document_feed_url => self.document_feed_url}
+          fields[:title] = self.title if @document_feed_entry
+          return "\#<%p %s>" % [self.class, fields.map(){ |k, v| "%s=%p" % [k, v] }.join(", ")]
         end
         
     end

data/lib/google_drive/list.rb

@@ -97,6 +97,10 @@ module GoogleDrive
           return @worksheet[index + 2, key_to_col(key)]
         end
         
+        def numeric_value(index, key) #:nodoc:
+          return @worksheet.numeric_value(index + 2, key_to_col(key))
+        end
+        
         def set(index, key, value) #:nodoc:
           @worksheet[index + 2, key_to_col(key)] = value
         end

data/lib/google_drive/list_row.rb

@@ -29,6 +29,10 @@ module GoogleDrive
           return @list.get(@index, key)
         end
         
+        def numeric_value(key)
+          return @list.numeric_value(@index, key)
+        end
+        
         def []=(key, value)
           @list.set(@index, key, value)
         end

data/lib/google_drive/oauth2_fetcher.rb

@@ -35,9 +35,9 @@ module GoogleDrive
         
         def request_raw(method, url, data, extra_header, auth)
           if method == :delete || method == :get
-            raw_res = @oauth2_token.request(method, url, {:header => extra_header})
+            raw_res = @oauth2_token.request(method, url, {:headers => extra_header})
           else
-            raw_res = @oauth2_token.request(method, url, {:header => extra_header, :body => data})
+            raw_res = @oauth2_token.request(method, url, {:headers => extra_header, :body => data})
           end
           return Response.new(raw_res)
         end

data/lib/google_drive/session.rb

@@ -112,12 +112,14 @@ module GoogleDrive
         # You can specify query parameters described at
         # https://developers.google.com/google-apps/documents-list/#getting_a_list_of_documents_and_files
         #
+        # files doesn't return collections unless "showfolders" => true is specified.
+        #
         # e.g.
         #   session.files
         #   session.files("title" => "hoge", "title-exact" => "true")
         def files(params = {})
           url = concat_url(
-              "https://docs.google.com/feeds/default/private/full?v=3", "?" + encode_query(params))
+              "#{DOCS_BASE_URL}?v=3", "?" + encode_query(params))
           doc = request(:get, url, :auth => :writely)
           return doc.css("feed > entry").map(){ |e| entry_element_to_file(e) }
         end
@@ -200,7 +202,25 @@ module GoogleDrive
         def worksheet_by_url(url)
           return Worksheet.new(self, nil, url)
         end
-
+        
+        # Returns the root collection.
+        def root_collection
+          return Collection.new(self, Collection::ROOT_URL)
+        end
+        
+        # Returns the top-level collections (direct children of the root collection).
+        def collections
+          return self.root_collection.subcollections
+        end
+        
+        # Returns a top-level collection whose title exactly matches +title+ as
+        # GoogleDrive::Collection.
+        # Returns nil if not found. If multiple collections with the +title+ are found, returns
+        # one of them.
+        def collection_by_title(title)
+          return self.root_collection.subcollection_by_title(title)
+        end
+        
         # Returns GoogleDrive::Collection with given +url+.
         # You must specify either of:
         # - URL of the page you get when you go to https://docs.google.com/ with your browser and
@@ -219,7 +239,7 @@ module GoogleDrive
           if ["docs.google.com", "drive.google.com"].include?(uri.host) &&
               uri.fragment =~ /^folders\/(.+)$/
             # Looks like a URL of human-readable collection page. Converts to collection feed URL.
-            url = "https://docs.google.com/feeds/default/private/full/folder%3A#{$1}"
+            url = "#{DOCS_BASE_URL}/folder%3A#{$1}"
           end
           return Collection.new(self, url)
         end
@@ -289,7 +309,7 @@ module GoogleDrive
         # Uploads a file. Reads content from +io+.
         # Returns a GoogleSpreadsheet::File object.
         def upload_from_io(io, title = "Untitled", params = {})
-          doc = request(:get, "https://docs.google.com/feeds/default/private/full?v=3",
+          doc = request(:get, "#{DOCS_BASE_URL}?v=3",
               :auth => :writely)
           initial_url = doc.css(
               "link[rel='http://schemas.google.com/g/2005#resumable-create-media']")[0]["href"]
@@ -352,13 +372,17 @@ module GoogleDrive
         end
         
         def entry_element_to_file(entry) #:nodoc:
+          type, resource_id = entry.css("gd|resourceId").text.split(/:/)
           title = entry.css("title").text
-          worksheets_feed_link = entry.css(
-            "link[rel='http://schemas.google.com/spreadsheets/2006#worksheetsfeed']")[0]
-          if worksheets_feed_link
-            return Spreadsheet.new(self, worksheets_feed_link["href"], title)
-          else
-            return GoogleDrive::File.new(self, entry)
+          case type
+            when "folder"
+              return Collection.new(self, entry)
+            when "spreadsheet"
+              worksheets_feed_link = entry.css(
+                "link[rel='http://schemas.google.com/spreadsheets/2006#worksheetsfeed']")[0]
+              return Spreadsheet.new(self, worksheets_feed_link["href"], title)
+            else
+              return GoogleDrive::File.new(self, entry)
           end
         end
 

data/lib/google_drive/spreadsheet.rb

@@ -103,7 +103,6 @@ module GoogleDrive
         # Creates copy of this spreadsheet with the given title.
         def duplicate(new_title = nil)
           new_title ||= (self.title ? "Copy of " + self.title : "Untitled")
-          post_url = "https://docs.google.com/feeds/default/private/full/"
           header = {"GData-Version" => "3.0", "Content-Type" => "application/atom+xml"}
           xml = <<-"EOS"
             <entry xmlns='http://www.w3.org/2005/Atom'>
@@ -112,7 +111,7 @@ module GoogleDrive
             </entry>
           EOS
           doc = @session.request(
-              :post, post_url, :data => xml, :header => header, :auth => :writely)
+              :post, DOCS_BASE_URL, :data => xml, :header => header, :auth => :writely)
           ss_url = doc.css(
               "link[rel='http://schemas.google.com/spreadsheets/2006#worksheetsfeed']")[0]["href"]
           return Spreadsheet.new(@session, ss_url, new_title)

data/lib/google_drive/util.rb

@@ -7,6 +7,9 @@ require "cgi"
 module GoogleDrive
     
     module Util #:nodoc:
+
+        # The beginning of Doc List API URL that is used in all requests (version 3).
+        DOCS_BASE_URL = "https://docs.google.com/feeds/default/private/full"
         
         EXT_TO_CONTENT_TYPE = {
             ".csv" =>"text/csv",
@@ -45,7 +48,16 @@ module GoogleDrive
               (piece_base || "") +
               (result_query.empty? ? "" : "?#{result_query}")
         end
-        
+
+        # Returns a URL with added version parameter ("?v=3") if needed.
+        def to_v3_url(url)
+          if url =~ %r{docs.google.com/feeds/default/private/} && !(url =~ /[?&]v=3/)
+            return concat_url(url, "?v=3")
+          else
+            return url
+          end
+        end
+
         def h(str)
           return CGI.escapeHTML(str.to_s())
         end

data/lib/google_drive/worksheet.rb

@@ -26,6 +26,7 @@ module GoogleDrive
 
           @cells = nil
           @input_values = nil
+          @numeric_values = nil
           @modified = Set.new()
           @list = nil
           
@@ -86,6 +87,7 @@ module GoogleDrive
           reload() if !@cells
           @cells[[row, col]] = value
           @input_values[[row, col]] = value
+          @numeric_values[[row, col]] = nil
           @modified.add([row, col])
           self.max_rows = row if row > @max_rows
           self.max_cols = col if col > @max_cols
@@ -116,6 +118,25 @@ module GoogleDrive
           return @input_values[[row, col]] || ""
         end
 
+        # Returns the numeric value of the cell. Arguments must be either
+        # (row number, column number) or cell name. Top-left cell is [1, 1].
+        #
+        # e.g.
+        #   worksheet[1, 3]                #=> "3,0" # it depends on locale, currency...
+        #   worksheet.numeric_value(1, 3)  #=> 3.0
+        #
+        # Returns nil if the cell is empty or contains non-number.
+        #
+        # If you modify the cell, its numeric_value is nil until you call save() and reload().
+        #
+        # For details, see:
+        # 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
+          return @numeric_values[[row, col]]
+        end
+        
         # Row number of the bottom-most non-empty row.
         def num_rows
           reload() if !@cells
@@ -176,8 +197,9 @@ module GoogleDrive
         end
 
         # An array of spreadsheet rows. Each row contains an array of
-        # columns. Note that resulting array is 0-origin so
-        # worksheet.rows[0][0] == worksheet[1, 1].
+        # columns. Note that resulting array is 0-origin so:
+        #
+        #   worksheet.rows[0][0] == worksheet[1, 1]
         def rows(skip = 0)
           nc = self.num_cols
           result = ((1 + skip)..self.num_rows).map() do |row|
@@ -197,12 +219,15 @@ module GoogleDrive
 
           @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"]
+            numeric_value = cell["numericValue"]
+            @numeric_values[[row, col]] = numeric_value ? numeric_value.to_f() : nil
           end
           @modified.clear()
           @meta_modified = false
@@ -433,10 +458,15 @@ module GoogleDrive
           if args.size == 1 && args[0].is_a?(String)
             return cell_name_to_row_col(args[0])
           elsif args.size == 2 && args[0].is_a?(Integer) && args[1].is_a?(Integer)
-            return args
+            if args[0] >= 1 && args[1] >= 1
+              return args
+            else
+              raise(ArgumentError,
+                  "Row/col must be >= 1 (1-origin), but are %d/%d" % [args[0], args[1]])
+            end
           else
             raise(ArgumentError,
-                "Arguments must be either one String or two Integer's, but are %p" % args)
+                "Arguments must be either one String or two Integer's, but are %p" % [args])
           end
         end
         

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google_drive
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-29 00:00:00.000000000 Z
+date: 2012-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &77521180 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -27,10 +27,21 @@ dependencies:
         version: 1.5.2
   type: :runtime
   prerelease: false
-  version_requirements: *77521180
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.4
+    - - ! '!='
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+    - - ! '!='
+      - !ruby/object:Gem::Version
+        version: 1.5.2
 - !ruby/object:Gem::Dependency
   name: oauth
-  requirement: &77520430 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -38,10 +49,15 @@ dependencies:
         version: 0.3.6
   type: :runtime
   prerelease: false
-  version_requirements: *77520430
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.6
 - !ruby/object:Gem::Dependency
   name: oauth2
-  requirement: &77520090 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -49,10 +65,15 @@ dependencies:
         version: 0.5.0
   type: :runtime
   prerelease: false
-  version_requirements: *77520090
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &77519770 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -60,7 +81,12 @@ dependencies:
         version: 0.8.0
   type: :development
   prerelease: false
-  version_requirements: *77519770
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.0
 description: A library to read/write files/spreadsheets in Google Drive/Docs.
 email:
 - gimite+github@gmail.com
@@ -114,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A library to read/write files/spreadsheets in Google Drive/Docs.