google-spreadsheet-ruby 0.0.8 → 0.0.9

data/README.rdoc

@@ -1,61 +1,63 @@
-This is a Ruby 1.8/1.9 library to read/write Google Spreadsheet.
-
-
-= How to install
-
-  $ gem sources -a http://gems.github.com
-  $ sudo gem install gimite-google-spreadsheet-ruby
-
-
-= How to use
-
-Example:
-  
-  require "rubygems"
-  require "google_spreadsheet"
-  
-  # Logs in.
-  session = GoogleSpreadsheet.login("username@gmail.com", "mypassword")
-  
-  # First worksheet of http://spreadsheets.google.com/ccc?key=pz7XtlQC-PYx-jrVMJErTcg&hl=en
-  ws = session.spreadsheet_by_key("pz7XtlQC-PYx-jrVMJErTcg").worksheets[0]
-  
-  # Gets content of A2 cell.
-  p ws[2, 1] #==> "hoge"
-  
-  # Changes content of cells. Changes are not sent to the server until you call ws.save().
-  ws[2, 1] = "foo"
-  ws[2, 2] = "bar"
-  ws.save()
-  
-  # Dumps all cells.
-  for row in 1..ws.num_rows
-    for col in 1..ws.num_cols
-      p ws[row, col]
-    end
-  end
-  
-  # Yet another way to do so.
-  p ws.rows #==> [["fuga", ""], ["foo", "bar]]
-  
-  # Reloads the worksheet to get changes by other clients.
-  ws.reload()
-
-API document: http://gimite.net/gimite/rubymess/google-spreadsheet-ruby/
-
-
-= Source code
-
-http://github.com/gimite/google-spreadsheet-ruby/tree/master
-
-The license of this source is "New BSD Licence"
-
-
-= Supported environments
-
-Ruby 1.8.x and Ruby 1.9.x. Checked with Ruby 1.8.7 and Ruby 1.9.1.
-
-
-= Author
-
-Hiroshi Ichikawa - http://gimite.net/en/index.php?Contact
+This is a Ruby 1.8/1.9 library to read/write Google Spreadsheet.
+
+
+= How to install
+
+  $ gem sources -a http://gemcutter.org
+  $ sudo gem install google-spreadsheet-ruby
+
+Note that gimite-google-spreadsheet-ruby at gems.github.com is no longer updated, because github stopped hosting it.
+
+
+= How to use
+
+Example:
+  
+  require "rubygems"
+  require "google_spreadsheet"
+  
+  # Logs in.
+  session = GoogleSpreadsheet.login("username@gmail.com", "mypassword")
+  
+  # First worksheet of http://spreadsheets.google.com/ccc?key=pz7XtlQC-PYx-jrVMJErTcg&hl=en
+  ws = session.spreadsheet_by_key("pz7XtlQC-PYx-jrVMJErTcg").worksheets[0]
+  
+  # Gets content of A2 cell.
+  p ws[2, 1] #==> "hoge"
+  
+  # Changes content of cells. Changes are not sent to the server until you call ws.save().
+  ws[2, 1] = "foo"
+  ws[2, 2] = "bar"
+  ws.save()
+  
+  # Dumps all cells.
+  for row in 1..ws.num_rows
+    for col in 1..ws.num_cols
+      p ws[row, col]
+    end
+  end
+  
+  # Yet another way to do so.
+  p ws.rows #==> [["fuga", ""], ["foo", "bar]]
+  
+  # Reloads the worksheet to get changes by other clients.
+  ws.reload()
+
+API document: http://gimite.net/gimite/rubymess/google-spreadsheet-ruby/
+
+
+= Source code
+
+http://github.com/gimite/google-spreadsheet-ruby/tree/master
+
+The license of this source is "New BSD Licence"
+
+
+= Supported environments
+
+Ruby 1.8.x and Ruby 1.9.x. Checked with Ruby 1.8.7 and Ruby 1.9.1.
+
+
+= Author
+
+Hiroshi Ichikawa - http://gimite.net/en/index.php?Contact

data/lib/google_spreadsheet.rb

@@ -6,6 +6,7 @@ require "set"
 require "net/https"
 require "open-uri"
 require "cgi"
+require "uri"
 require "rubygems"
 require "hpricot"
 Net::HTTP.version_1_2
@@ -142,39 +143,12 @@ module GoogleSpreadsheet
         # When this function returns +true+, it tries again.
         attr_accessor :on_auth_fail
         
-        def get(url, auth = :wise) #:nodoc:
-          response = http_request(:get, url, nil, auth)
-          return Hpricot.XML(response)
-        end
-
-        def get_raw(url, auth = :wise)
-          return http_request(:get, url, nil, auth)
-        end
-        
-        def post(url, data, auth = :wise) #:nodoc:
-          response = http_request(:post, url, data, auth, {"Content-Type" => "application/atom+xml"})
-          return Hpricot.XML(response)
-        end
-        
-        def put(url, data, auth = :wise) #:nodoc:
-          response = http_request(:put, url, data, auth, {"Content-Type" => "application/atom+xml"})
-          return Hpricot.XML(response)
-        end
-        
-        def delete(url, auth = :wise) #:nodoc:
-          response = http_request(:delete, url, nil, auth, {"Content-Type" => "application/atom+xml"})
-          return Hpricot.XML(response)
-        end
-
-        def upload(url, ods_file, name)
-          response = http_request(:post, url, ods_file, :writely,
-            {"Content-Type" => "application/x-vnd.oasis.opendocument.spreadsheet",
-             "Slug" => name})
-          return Hpricot.XML(response)
-        end
-        
-        def auth_header auth #:nodoc:
-          return {"Authorization" => "GoogleLogin auth=#{@auth_tokens[auth]}"}
+        def auth_header(auth) #:nodoc:
+          if auth == :none
+            return {}
+          else
+            return {"Authorization" => "GoogleLogin auth=#{@auth_tokens[auth]}"}
+          end
         end
 
         # Returns list of spreadsheets for the user as array of GoogleSpreadsheet::Spreadsheet.
@@ -186,7 +160,7 @@ module GoogleSpreadsheet
         #   session.spreadsheets("title" => "hoge")
         def spreadsheets(params = {})
           query = encode_query(params)
-          doc = get("http://spreadsheets.google.com/feeds/spreadsheets/private/full?#{query}")
+          doc = request(:get, "http://spreadsheets.google.com/feeds/spreadsheets/private/full?#{query}")
           result = []
           for entry in doc.search("entry")
             title = as_utf8(entry.search("title").text)
@@ -245,45 +219,38 @@ module GoogleSpreadsheet
         def create_spreadsheet(
             title = "Untitled",
             feed_url = "http://docs.google.com/feeds/documents/private/full")
-
           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>#{title}</atom:title>
+              <atom:title>#{h(title)}</atom:title>
             </atom:entry>
           EOS
 
-          doc = post(feed_url, xml, :writely)
+          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"])
           return Spreadsheet.new(self, ss_url, title)
         end
         
-      private
-        
-        def authenticate(mail, password, auth)
-          params = {
-            "accountType" => "HOSTED_OR_GOOGLE",
-            "Email" => mail,
-            "Passwd" => password,
-            "service" => auth.to_s(),
-            "source" => "Gimite-RubyGoogleSpreadsheet-1.00",
-          }
-          response = http_request(:post,
-            "https://www.google.com/accounts/ClientLogin", encode_query(params), nil)
-          @auth_tokens[auth] = response.slice(/^Auth=(.*)$/, 1)
-        end
-        
-        def http_request(method, url, data, auth, add_header = {})
+        def request(method, url, params = {}) #:nodoc:
           uri = URI.parse(url)
+          data = params[:data]
+          auth = params[:auth] || :wise
+          if params[:header]
+            add_header = params[:header]
+          else
+            add_header = data ? {"Content-Type" => "application/atom+xml"} : {}
+          end
+          response_type = params[:response_type] || :xml
+          
           http = Net::HTTP.new(uri.host, uri.port)
           http.use_ssl = uri.scheme == "https"
           http.verify_mode = OpenSSL::SSL::VERIFY_NONE
           http.start() do
             while true
               path = uri.path + (uri.query ? "?#{uri.query}" : "")
-              header = (auth ? auth_header(auth) : {}).merge(add_header)
+              header = auth_header(auth).merge(add_header)
               if method == :delete || method == :get
                 response = http.__send__(method, path, header)
               else
@@ -298,11 +265,34 @@ module GoogleSpreadsheet
                   "Response code #{response.code} for #{method} #{url}: " +
                   CGI.unescapeHTML(response.body))
               end
-              return response.body
+              case response_type
+                when :xml
+                  return Hpricot.XML(response.body)
+                when :raw
+                  return response.body
+                else
+                  raise("unknown params[:response_type]: %s" % response_type)
+              end
             end
           end
         end
         
+      private
+        
+        def authenticate(mail, password, auth)
+          params = {
+            "accountType" => "HOSTED_OR_GOOGLE",
+            "Email" => mail,
+            "Passwd" => password,
+            "service" => auth.to_s(),
+            "source" => "Gimite-RubyGoogleSpreadsheet-1.00",
+          }
+          response = request(:post,
+            "https://www.google.com/accounts/ClientLogin",
+            :data => encode_query(params), :auth => :none, :header => {}, :response_type => :raw)
+          @auth_tokens[auth] = response.slice(/^Auth=(.*)$/, 1)
+        end
+        
     end
     
     
@@ -338,23 +328,40 @@ module GoogleSpreadsheet
         def tables_feed_url
           return "http://spreadsheets.google.com/feeds/#{self.key}/tables"
         end
-
+        
+        # URL of feed used in document list feed API.
+        def document_feed_url
+          return "http://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 ||= "Copy of " + @title
+          new_name ||= (@title ? "Copy of " + @title : "Untitled")
           get_url = "http://spreadsheets.google.com/feeds/download/spreadsheets/Export?key=#{key}&exportFormat=ods"
-          ods = @session.get_raw(get_url)
+          ods = @session.request(:get, get_url, :response_type => :raw)
           
           url = "http://docs.google.com/feeds/documents/private/full"
-
-          doc = @session.upload(url, ods, new_name)
+          header = {
+            "Content-Type" => "application/x-vnd.oasis.opendocument.spreadsheet",
+            "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"])
           return Spreadsheet.new(@session, ss_url, title)
         end
         
+        # If +permanent+ is +false+, moves the spreadsheet to the trash.
+        # If +permanent+ is +true+, deletes the spreadsheet permanently.
+        def delete(permanent = false)
+          @session.request(:delete,
+            self.document_feed_url + (permanent ? "?delete=true" : ""),
+            :auth => :writely, :header => {"If-Match" => "*"})
+        end
+        
         # Returns worksheets of the spreadsheet as array of GoogleSpreadsheet::Worksheet.
         def worksheets
-          doc = @session.get(@worksheets_feed_url)
+          doc = @session.request(:get, @worksheets_feed_url)
           result = []
           for entry in doc.search("entry")
             title = as_utf8(entry.search("title").text)
@@ -375,7 +382,7 @@ module GoogleSpreadsheet
               <gs:colCount>#{h(max_cols)}</gs:colCount>
             </entry>
           EOS
-          doc = @session.post(@worksheets_feed_url, xml)
+          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"])
           return Worksheet.new(@session, self, url, title)
@@ -383,7 +390,7 @@ module GoogleSpreadsheet
         
         # Returns list of tables in the spreadsheet.
         def tables
-          doc = @session.get(self.tables_feed_url)
+          doc = @session.request(:get, self.tables_feed_url)
           return doc.search("entry").map(){ |e| Table.new(@session, e) }.freeze()
         end
         
@@ -418,12 +425,12 @@ module GoogleSpreadsheet
               #{fields}
             </entry>
           EOS
-          @session.post(@records_url, xml)
+          @session.request(:post, @records_url, :data => xml)
         end
         
         # Returns records in the table.
         def records
-          doc = @session.get(@records_url)
+          doc = @session.request(:get, @records_url)
           return doc.search("entry").map(){ |e| Record.new(@session, e) }
         end
         
@@ -542,6 +549,7 @@ module GoogleSpreadsheet
         # Updates number of rows.
         # Note that update is not sent to the server until you call save().
         def max_rows=(rows)
+          reload() if !@cells
           @max_rows = rows
           @meta_modified = true
         end
@@ -555,6 +563,7 @@ module GoogleSpreadsheet
         # Updates number of columns.
         # Note that update is not sent to the server until you call save().
         def max_cols=(cols)
+          reload() if !@cells
           @max_cols = cols
           @meta_modified = true
         end
@@ -568,6 +577,7 @@ module GoogleSpreadsheet
         # 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
@@ -591,10 +601,10 @@ module GoogleSpreadsheet
         # Reloads content of the worksheets from the server.
         # Note that changes you made by []= is discarded if you haven't called save().
         def reload()
-          doc = @session.get(@cells_feed_url)
+          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("title").text)
+          @title = as_utf8(doc.search("/feed/title").text)
           
           @cells = {}
           @input_values = {}
@@ -616,7 +626,7 @@ module GoogleSpreadsheet
           
           if @meta_modified
             
-            ws_doc = @session.get(self.worksheet_feed_url)
+            ws_doc = @session.request(:get, self.worksheet_feed_url)
             edit_url = ws_doc.search("link[@rel='edit']")[0]["href"]
             xml = <<-"EOS"
               <entry xmlns='http://www.w3.org/2005/Atom'
@@ -627,7 +637,7 @@ module GoogleSpreadsheet
               </entry>
             EOS
             
-            @session.put(edit_url, xml)
+            @session.request(:put, edit_url, :data => xml)
             
             @meta_modified = false
             sent = true
@@ -643,7 +653,7 @@ module GoogleSpreadsheet
             cols = @modified.map(){ |r, c| c }
             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.get(url)
+            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()
@@ -680,7 +690,7 @@ module GoogleSpreadsheet
                 </feed>
               EOS
             
-              result = @session.post("#{@cells_feed_url}/batch", xml)
+              result = @session.request(:post, "#{@cells_feed_url}/batch", :data => xml)
               for entry in result.search("atom:entry")
                 interrupted = entry.search("batch:interrupted")[0]
                 if interrupted
@@ -709,10 +719,10 @@ module GoogleSpreadsheet
         end
         
         # Deletes this worksheet. Deletion takes effect right away without calling save().
-        def delete
-          ws_doc = @session.get(self.worksheet_feed_url)
+        def delete()
+          ws_doc = @session.request(:get, self.worksheet_feed_url)
           edit_url = ws_doc.search("link[@rel='edit']")[0]["href"]
-          @session.delete(edit_url)
+          @session.request(:delete, edit_url)
         end
         
         # Returns true if you have changes made by []= which haven't been saved.
@@ -742,7 +752,7 @@ module GoogleSpreadsheet
             </entry>
           EOS
 
-          result = @session.post(self.spreadsheet.tables_feed_url, xml)
+          result = @session.request(:post, self.spreadsheet.tables_feed_url, :data => xml)
           return Table.new(@session, result)
         end
         

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: google-spreadsheet-ruby
 version: !ruby/object:Gem::Version 
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors: 
 - Hiroshi Ichikawa
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-06 00:00:00 +09:00
+date: 2010-01-11 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency