google-spreadsheet-ruby 0.1.1 → 0.1.2

data/lib/google_spreadsheet.rb

@@ -8,7 +8,8 @@ require "open-uri"
 require "cgi"
 require "uri"
 require "rubygems"
-require "hpricot"
+require 'nokogiri'
+
 require "oauth"
 Net::HTTP.version_1_2
 
@@ -98,14 +99,6 @@ module GoogleSpreadsheet
           return CGI.escapeHTML(str.to_s())
         end
         
-        def as_utf8(str)
-          if str.respond_to?(:force_encoding)
-            str.force_encoding("UTF-8")
-          else
-            str
-          end
-        end
-        
     end
     
     
@@ -142,11 +135,8 @@ module GoogleSpreadsheet
 
         # Restores session using return value of auth_tokens method of previous session.
         def initialize(auth_tokens = nil, oauth_token = nil)
-          if oauth_token
-            @oauth_token = oauth_token
-          else
-            @auth_tokens = auth_tokens
-          end
+          @oauth_token = oauth_token
+          @auth_tokens = auth_tokens || {}
         end
 
         # Authenticates with given +mail+ and +password+, and updates current session object
@@ -176,10 +166,11 @@ module GoogleSpreadsheet
         attr_accessor :on_auth_fail
         
         def auth_header(auth) #:nodoc:
-          if auth == :none
-            return {}
+          token = auth == :none ? nil : @auth_tokens[auth]
+          if token
+            return {"Authorization" => "GoogleLogin auth=#{token}"}
           else
-            return {"Authorization" => "GoogleLogin auth=#{@auth_tokens[auth]}"}
+            return {}
           end
         end
 
@@ -194,10 +185,10 @@ module GoogleSpreadsheet
           query = encode_query(params)
           doc = request(:get, "https://spreadsheets.google.com/feeds/spreadsheets/private/full?#{query}")
           result = []
-          for entry in doc.search("entry")
-            title = as_utf8(entry.search("title").text)
-            url = as_utf8(entry.search(
-              "link[@rel='http://schemas.google.com/spreadsheets/2006#worksheetsfeed']")[0]["href"])
+          doc.css("feed > entry").each() do |entry|
+            title = entry.css("title").text
+            url = entry.css(
+              "link[@rel='http://schemas.google.com/spreadsheets/2006#worksheetsfeed']")[0]["href"]
             result.push(Spreadsheet.new(self, url, title))
           end
           return result
@@ -260,68 +251,70 @@ module GoogleSpreadsheet
           EOS
 
           doc = request(:post, feed_url, :data => xml, :auth => :writely)
-          ss_url = as_utf8(doc.search(
-            "link[@rel='http://schemas.google.com/spreadsheets/2006#worksheetsfeed']")[0]["href"])
+          ss_url = doc.css(
+            "link[@rel='http://schemas.google.com/spreadsheets/2006#worksheetsfeed']").first['href']
           return Spreadsheet.new(self, ss_url, title)
         end
         
         def request(method, url, params = {}) #:nodoc:
           # Always uses HTTPS.
-          uri = URI.parse(url.gsub(%r{^http://}, "https://"))
+          url = url.gsub(%r{^http://}, "https://")
           data = params[:data]
           auth = params[:auth] || :wise
           if params[:header]
-            add_header = params[:header]
+            extra_header = params[:header]
+          elsif data
+            extra_header = {"Content-Type" => "application/atom+xml"}
           else
-            add_header = data ? {"Content-Type" => "application/atom+xml"} : {}
+            extra_header = {}
           end
           response_type = params[:response_type] || :xml
           
+          while true
+            response = request_raw(method, url, data, extra_header, auth)
+            if response.code == "401" && @on_auth_fail && @on_auth_fail.call()
+              next
+            end
+            if !(response.code =~ /^2/)
+              raise(
+                response.code == "401" ? AuthenticationError : GoogleSpreadsheet::Error,
+                "Response code #{response.code} for #{method} #{url}: " +
+                CGI.unescapeHTML(response.body))
+            end
+            return convert_response(response, response_type)
+          end
+        end
+        
+      private
+        
+        def request_raw(method, url, data, extra_header, auth)
           if @oauth_token
-            
             if method == :delete || method == :get
-              response = @oauth_token.__send__(method, url, add_header)
+              return @oauth_token.__send__(method, url, extra_header)
             else
-              response = @oauth_token.__send__(method, url, data, add_header)
+              return @oauth_token.__send__(method, url, data, extra_header)
             end
-            return convert_response(response, response_type)
-            
           else
-            
+            uri = URI.parse(url)
             http = Net::HTTP.new(uri.host, uri.port)
             http.use_ssl = true
             http.verify_mode = OpenSSL::SSL::VERIFY_NONE
             http.start() do
-              while true
-                path = uri.path + (uri.query ? "?#{uri.query}" : "")
-                header = auth_header(auth).merge(add_header)
-                if method == :delete || method == :get
-                  response = http.__send__(method, path, header)
-                else
-                  response = http.__send__(method, path, data, header)
-                end
-                if response.code == "401" && @on_auth_fail && @on_auth_fail.call()
-                  next
-                end
-                if !(response.code =~ /^2/)
-                  raise(
-                    response.code == "401" ? AuthenticationError : GoogleSpreadsheet::Error,
-                    "Response code #{response.code} for #{method} #{url}: " +
-                    CGI.unescapeHTML(response.body))
-                end
-                return convert_response(response, response_type)
+              path = uri.path + (uri.query ? "?#{uri.query}" : "")
+              header = auth_header(auth).merge(extra_header)
+              if method == :delete || method == :get
+                return http.__send__(method, path, header)
+              else
+                return http.__send__(method, path, data, header)
               end
             end
-            
           end
         end
         
-      private
-        
         def convert_response(response, response_type)
           case response_type
             when :xml
-              return Hpricot.XML(response.body)
+              return Nokogiri.XML(response.body)
             when :raw
               return response.body
             else
@@ -337,9 +330,10 @@ module GoogleSpreadsheet
             "service" => auth.to_s(),
             "source" => "Gimite-RubyGoogleSpreadsheet-1.00",
           }
+          header = {"Content-Type" => "application/x-www-form-urlencoded"}
           response = request(:post,
             "https://www.google.com/accounts/ClientLogin",
-            :data => encode_query(params), :auth => :none, :header => {}, :response_type => :raw)
+            :data => encode_query(params), :auth => :none, :header => header, :response_type => :raw)
           @auth_tokens[auth] = response.slice(/^Auth=(.*)$/, 1)
         end
         
@@ -378,12 +372,12 @@ module GoogleSpreadsheet
         def tables_feed_url
           return "https://spreadsheets.google.com/feeds/#{self.key}/tables"
         end
-        
+
         # URL of feed used in document list feed API.
         def document_feed_url
           return "https://docs.google.com/feeds/documents/private/full/spreadsheet%3A#{self.key}"
         end
-        
+
         # Creates copy of this spreadsheet with the given name.
         def duplicate(new_name = nil)
           new_name ||= (@title ? "Copy of " + @title : "Untitled")
@@ -396,8 +390,8 @@ module GoogleSpreadsheet
             "Slug" => URI.encode(new_name),
           }
           doc = @session.request(:post, url, :data => ods, :auth => :writely, :header => header)
-          ss_url = as_utf8(doc.search(
-            "link[@rel='http://schemas.google.com/spreadsheets/2006#worksheetsfeed']")[0]["href"])
+          ss_url = doc.css(
+            "link[@rel='http://schemas.google.com/spreadsheets/2006#worksheetsfeed']").first['href']
           return Spreadsheet.new(@session, ss_url, title)
         end
         
@@ -409,14 +403,32 @@ module GoogleSpreadsheet
             :auth => :writely, :header => {"If-Match" => "*"})
         end
         
+        # Renames title of the spreadsheet.
+        def rename(title)
+          doc = @session.request(:get, self.document_feed_url)
+          edit_url = doc.css("link[@rel='edit']").first['href']
+          xml = <<-"EOS"
+            <atom:entry
+                xmlns:atom="http://www.w3.org/2005/Atom"
+                xmlns:docs="http://schemas.google.com/docs/2007">
+              <atom:category
+                scheme="http://schemas.google.com/g/2005#kind"
+                term="http://schemas.google.com/docs/2007#spreadsheet" label="spreadsheet"/>
+              <atom:title>#{h(title)}</atom:title>
+            </atom:entry>
+          EOS
+
+          @session.request(:put, edit_url, :data => xml)
+        end
+        
         # Returns worksheets of the spreadsheet as array of GoogleSpreadsheet::Worksheet.
         def worksheets
           doc = @session.request(:get, @worksheets_feed_url)
           result = []
-          for entry in doc.search("entry")
-            title = as_utf8(entry.search("title").text)
-            url = as_utf8(entry.search(
-              "link[@rel='http://schemas.google.com/spreadsheets/2006#cellsfeed']")[0]["href"])
+          doc.css('entry').each() do |entry|
+            title = entry.css('title').text
+            url = entry.css(
+              "link[@rel='http://schemas.google.com/spreadsheets/2006#cellsfeed']").first['href']
             result.push(Worksheet.new(@session, self, url, title))
           end
           return result.freeze()
@@ -433,15 +445,15 @@ module GoogleSpreadsheet
             </entry>
           EOS
           doc = @session.request(:post, @worksheets_feed_url, :data => xml)
-          url = as_utf8(doc.search(
-            "link[@rel='http://schemas.google.com/spreadsheets/2006#cellsfeed']")[0]["href"])
+          url = doc.css(
+            "link[@rel='http://schemas.google.com/spreadsheets/2006#cellsfeed']").first['href']
           return Worksheet.new(@session, self, url, title)
         end
         
         # Returns list of tables in the spreadsheet.
         def tables
           doc = @session.request(:get, self.tables_feed_url)
-          return doc.search("entry").map(){ |e| Table.new(@session, e) }.freeze()
+          return doc.css('entry').map(){ |e| Table.new(@session, e) }.freeze()
         end
         
     end
@@ -454,8 +466,9 @@ module GoogleSpreadsheet
 
         def initialize(session, entry) #:nodoc:
           @columns = {}
-          @worksheet_title = as_utf8(entry.search("gs:worksheet")[0]["name"])
-          @records_url = as_utf8(entry.search("content")[0]["src"])
+          @worksheet_title = entry.css('gs|worksheet').first['name']
+          @records_url = entry.css("content")[0]["src"]
+          @edit_url = entry.css("link[@rel='edit']")[0]['href']
           @session = session
         end
         
@@ -465,7 +478,7 @@ module GoogleSpreadsheet
         # Adds a record.
         def add_record(values)
           fields = ""
-          values.each do |name, value|
+          values.each() do |name, value|
             fields += "<gs:field name='#{h(name)}'>#{h(value)}</gs:field>"
           end
           xml =<<-EOS
@@ -481,18 +494,24 @@ module GoogleSpreadsheet
         # Returns records in the table.
         def records
           doc = @session.request(:get, @records_url)
-          return doc.search("entry").map(){ |e| Record.new(@session, e) }
+          return doc.css('entry').map(){ |e| Record.new(@session, e) }
+        end
+        
+        # Deletes this table. Deletion takes effect right away without calling save().
+        def delete
+          @session.request(:delete, @edit_url, :header => {"If-Match" => "*"})
         end
         
     end
     
     # Use GoogleSpreadsheet::Table#records to get GoogleSpreadsheet::Record objects.
     class Record < Hash
+        include(Util)
         
         def initialize(session, entry) #:nodoc:
           @session = session
-          for field in entry.search("gs:field")
-            self[as_utf8(field["name"])] = as_utf8(field.inner_text)
+          entry.css('gs|field').each() do |field|
+            self[field["name"]] = field.inner_text
           end
         end
         
@@ -652,18 +671,19 @@ module GoogleSpreadsheet
         # Note that changes you made by []= is discarded if you haven't called save().
         def reload()
           doc = @session.request(:get, @cells_feed_url)
-          @max_rows = doc.search("gs:rowCount").text.to_i()
-          @max_cols = doc.search("gs:colCount").text.to_i()
-          @title = as_utf8(doc.search("/feed/title").text)
+          @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
           
           @cells = {}
           @input_values = {}
-          for entry in doc.search("entry")
-            cell = entry.search("gs:cell")[0]
+          doc.css('feed > entry').each() do |entry|
+            cell = entry.css('gs|cell').first
             row = cell["row"].to_i()
             col = cell["col"].to_i()
-            @cells[[row, col]] = as_utf8(cell.inner_text)
-            @input_values[[row, col]] = as_utf8(cell["inputValue"])
+            @cells[[row, col]] = cell.inner_text
+            @input_values[[row, col]] = cell["inputValue"]
+            
           end
           @modified.clear()
           @meta_modified = false
@@ -677,7 +697,7 @@ module GoogleSpreadsheet
           if @meta_modified
             
             ws_doc = @session.request(:get, self.worksheet_feed_url)
-            edit_url = ws_doc.search("link[@rel='edit']")[0]["href"]
+            edit_url = ws_doc.css("link[@rel='edit']").first['href']
             xml = <<-"EOS"
               <entry xmlns='http://www.w3.org/2005/Atom'
                      xmlns:gs='http://schemas.google.com/spreadsheets/2006'>
@@ -704,9 +724,10 @@ module GoogleSpreadsheet
             url = "#{@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)
-            for entry in doc.search("entry")
-              row = entry.search("gs:cell")[0]["row"].to_i()
-              col = entry.search("gs:cell")[0]["col"].to_i()
+
+            doc.css('entry').each() do |entry|
+              row = entry.css('gs|cell').first['row'].to_i
+              col = entry.css('gs|cell').first['col'].to_i
               cell_entries[[row, col]] = entry
             end
             
@@ -723,8 +744,8 @@ module GoogleSpreadsheet
               for row, col in chunk
                 value = @cells[[row, col]]
                 entry = cell_entries[[row, col]]
-                id = entry.search("id").text
-                edit_url = entry.search("link[@rel='edit']")[0]["href"]
+                id = entry.css('id').text
+                edit_url = entry.css("link[@rel='edit']").first['href']
                 xml << <<-EOS
                   <entry>
                     <batch:id>#{h(row)},#{h(col)}</batch:id>
@@ -741,15 +762,15 @@ module GoogleSpreadsheet
               EOS
             
               result = @session.request(:post, "#{@cells_feed_url}/batch", :data => xml)
-              for entry in result.search("atom:entry")
-                interrupted = entry.search("batch:interrupted")[0]
+              result.css('atom|entry').each() do |entry|
+                interrupted = entry.css('batch|interrupted').first
                 if interrupted
                   raise(GoogleSpreadsheet::Error, "Update has failed: %s" %
                     interrupted["reason"])
                 end
-                if !(entry.search("batch:status")[0]["code"] =~ /^2/)
+                if !(entry.css('batch|status').first['code'] =~ /^2/)
                   raise(GoogleSpreadsheet::Error, "Updating cell %s has failed: %s" %
-                    [entry.search("atom:id").text, entry.search("batch:status")[0]["reason"]])
+                    [entry.css('atom|id').text, entry.css('batch|status').first['reason']])
                 end
               end
               
@@ -771,7 +792,7 @@ module GoogleSpreadsheet
         # Deletes this worksheet. Deletion takes effect right away without calling save().
         def delete()
           ws_doc = @session.request(:get, self.worksheet_feed_url)
-          edit_url = ws_doc.search("link[@rel='edit']")[0]["href"]
+          edit_url = ws_doc.css("link[@rel='edit']").first['href']
           @session.request(:delete, edit_url)
         end
         
@@ -783,9 +804,12 @@ module GoogleSpreadsheet
         # Creates table for the worksheet and returns GoogleSpreadsheet::Table.
         # See this document for details:
         # http://code.google.com/intl/en/apis/spreadsheets/docs/3.0/developers_guide_protocol.html#TableFeeds
-        def add_table(table_title, summary, columns)
+        def add_table(table_title, summary, columns, options)
+          default_options = { :header_row => 1, :num_rows => 0, :start_row => 2}
+          options = default_options.merge(options)
+          
           column_xml = ""
-          columns.each do |index, name|
+          columns.each() do |index, name|
             column_xml += "<gs:column index='#{h(index)}' name='#{h(name)}'/>\n"
           end
 
@@ -795,8 +819,8 @@ module GoogleSpreadsheet
               <title type='text'>#{h(table_title)}</title>
               <summary type='text'>#{h(summary)}</summary>
               <gs:worksheet name='#{h(self.title)}' />
-              <gs:header row='1' />
-              <gs:data numRows='0' startRow='2'>
+              <gs:header row='#{options[:header_row]}' />
+              <gs:data numRows='#{options[:num_rows]}' startRow='#{options[:start_row]}'>
                 #{column_xml}
               </gs:data>
             </entry>
@@ -811,6 +835,16 @@ module GoogleSpreadsheet
           return self.spreadsheet.tables.select(){ |t| t.worksheet_title == self.title }
         end
 
+        # 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(
+            "link[@rel='http://schemas.google.com/spreadsheets/2006#listfeed']").first['href']
+        end
+
     end
     
     

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: google-spreadsheet-ruby
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  hash: 31
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Hiroshi Ichikawa
@@ -9,29 +15,42 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-31 00:00:00 +09:00
+date: 2010-09-24 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: hpricot
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  name: nokogiri
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: "0.3"
-    version: 
+        hash: 113
+        segments: 
+        - 1
+        - 4
+        - 3
+        - 1
+        version: 1.4.3.1
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: oauth
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 0
+        - 3
+        - 6
         version: 0.3.6
-    version: 
+  type: :runtime
+  version_requirements: *id002
 description: This is a library to read/write Google Spreadsheet.
 email: 
 - gimite+github@gmail.com
@@ -55,21 +74,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 2
 summary: This is a library to read/write Google Spreadsheet.