google_drive 0.3.1 → 0.3.2

data/lib/google_drive/acl.rb

@@ -5,9 +5,8 @@
 
 require "google_drive/acl_entry"
 
-
 module GoogleDrive
-    
+
     # ACL (access control list) of a spreadsheet.
     #
     # Use GoogleDrive::Spreadsheet#acl to get GoogleDrive::Acl object.
@@ -15,10 +14,10 @@ module GoogleDrive
     #
     # 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
@@ -26,9 +25,9 @@ module GoogleDrive
           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 GoogleDrive::AclEntry or a Hash with keys
         # :scope_type, :scope and :role. See GoogleDrive::AclEntry#scope_type and
         # GoogleDrive::AclEntry#role for the document of the fields.
@@ -36,35 +35,31 @@ module GoogleDrive
         # 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"}
-          value_attr = entry.scope ? "value='#{h(entry.scope)}'" : ""
-          xml = <<-EOS
-            <entry
-                xmlns='http://www.w3.org/2005/Atom'
-                xmlns:gAcl='http://schemas.google.com/acl/2007'>
-              <category scheme='http://schemas.google.com/g/2005#kind'
-                  term='http://schemas.google.com/acl/2007#accessRule'/>
-              <gAcl:role value='#{h(entry.role)}'/>
-              <gAcl:scope type='#{h(entry.scope_type)}' #{value_attr}/>
-            </entry>
-          EOS
           doc = @session.request(
-              :post, @acls_feed_url, :data => xml, :header => header, :auth => :writely)
-          
+              :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.
@@ -74,51 +69,47 @@ module GoogleDrive
           @session.request(:delete, entry.edit_url, :header => header, :auth => :writely)
           @acls.delete(entry)
         end
-        
+
         def update_role(entry, role) #:nodoc:
-          
+
           header = {"GData-Version" => "3.0", "Content-Type" => "application/atom+xml"}
-          value_attr = entry.scope ? "value='#{h(entry.scope)}'" : ""
-          xml = <<-EOS
-            <entry
-                xmlns='http://www.w3.org/2005/Atom'
-                xmlns:gAcl='http://schemas.google.com/acl/2007'
-                xmlns:gd='http://schemas.google.com/g/2005'
-                gd:etag='#{h(entry.etag)}'>
-              <category
-                  scheme='http://schemas.google.com/g/2005#kind'
-                  term='http://schemas.google.com/acl/2007#accessRule'/>
-              <gAcl:role value='#{h(role)}'/>
-              <gAcl:scope type='#{h(entry.scope_type)}' #{value_attr}/>
-            </entry>
-          EOS
           doc = @session.request(
-              :put, entry.edit_url, :data => xml, :header => header, :auth => :writely)
-          
+              :put, entry.edit_url, :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)
-          # TODO Support with-link roles.
+          
+          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"],
-            :role => entry.css("gAcl|role")[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

data/lib/google_drive/acl_entry.rb

@@ -1,44 +1,44 @@
 # Author: Guy Boertje <https://github.com/guyboertje>
 # Author: David R. Albrecht <https://github.com/eldavido>
 # Author: Hiroshi Ichikawa <http://gimite.net/>
+# Author: Phuogn Nguyen <https://github.com/phuongnd08>
 # The license of this source is "New BSD Licence"
 
-# acl.rb, derived from https://github.com/guyboertje/gdata-spreadsheet-ruby/blob/master/lib/document.rb
-# more frankensteining of the original library
-
 module GoogleDrive
-    
+
     # An entry of an ACL (access control list) of a spreadsheet.
     #
     # Use GoogleDrive::Acl#[] to get GoogleDrive::AclEntry object.
     #
     # This code is based on https://github.com/guyboertje/gdata-spreadsheet-ruby .
     class AclEntry
-        
+
         include(Util)
-        
-        PARAM_NAMES = [:acl, :scope_type, :scope, :role, :title, :edit_url, :etag]  #:nodoc:
-        
+
+        PARAM_NAMES = [:acl, :scope_type, :scope, :with_key, :role, :title, :edit_url, :etag]  #:nodoc:
+
         # +params+ is a Hash object with keys +:scope_type+, +:scope+ and +:role+.
         # See scope_type and role for the document of the fields.
         def initialize(params)
           @params = {:role => "reader"}
           for name, value in params
-            if !PARAM_NAMES.include?(name)
+            if !name.is_a?(Symbol)
+              raise(ArgumentError, "Key must be Symbol, but is %p" % name)
+            elsif !PARAM_NAMES.include?(name)
               raise(ArgumentError, "Invalid key: %p" % name)
             end
             @params[name] = value
           end
         end
-        
+
         attr_accessor(:params)  #:nodoc:
-        
+
         PARAM_NAMES.each() do |name|
           define_method(name) do
             return @params[name]
           end
         end
-        
+
         # Changes the role of the scope.
         #
         # e.g.
@@ -46,13 +46,44 @@ module GoogleDrive
         def role=(role)
           @params[:acl].update_role(self, role)
         end
-        
+
         def inspect
-          return "\#<%p scope_type=%p, scope=%p, role=%p>" %
-              [self.class, @params[:scope_type], @params[:scope], @params[:role]]
+          return "\#<%p scope_type=%p, scope=%p, with_key=%p, role=%p>" %
+              [self.class, @params[:scope_type], @params[:scope], @params[:with_key], @params[:role]]
         end
-        
+
+        def to_xml()  #:nodoc:
+          
+          etag_attr = self.etag ? "gd:etag='#{h(self.etag)}'" : ""
+          value_attr = self.scope ? "value='#{h(self.scope)}'" : ""
+          if self.with_key
+            role_tag = <<-EOS
+                <gAcl:withKey key='[ACL KEY]'>
+                  <gAcl:role value='#{h(self.role)}'/>
+                </gAcl:withKey>
+            EOS
+          else
+            role_tag = <<-EOS
+              <gAcl:role value='#{h(self.role)}'/>
+            EOS
+          end
+          
+          return <<-EOS
+            <entry
+                xmlns='http://www.w3.org/2005/Atom'
+                xmlns:gAcl='http://schemas.google.com/acl/2007'
+                xmlns:gd='http://schemas.google.com/g/2005'
+                #{etag_attr}>
+              <category scheme='http://schemas.google.com/g/2005#kind'
+                  term='http://schemas.google.com/acl/2007#accessRule'/>
+              #{role_tag}
+              <gAcl:scope type='#{h(self.scope_type)}' #{value_attr}/>
+            </entry>
+          EOS
+          
+        end
+
     end
-    
+
 end
 

data/lib/google_drive/file.rb

@@ -34,7 +34,7 @@ module GoogleDrive
             # 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)]
+            @document_feed_url = "%s/%s?v=3" % [DOCS_BASE_URL, CGI.escape(self.resource_id)]
           end
           @acl = nil
         end
@@ -193,9 +193,7 @@ module GoogleDrive
 
         # Renames title of the file.
         def rename(title)
-          
-          doc = @session.request(:get, self.document_feed_url, :auth => :writely)
-          edit_url = doc.css("link[rel='edit']").first["href"]
+          edit_url = self.document_feed_entry.css("link[rel='edit']").first["href"]
           xml = <<-"EOS"
             <atom:entry
                 xmlns:atom="http://www.w3.org/2005/Atom"
@@ -203,11 +201,8 @@ module GoogleDrive
               <atom:title>#{h(title)}</atom:title>
             </atom:entry>
           EOS
-          
-          @session.request(
-              :put, edit_url, :data => xml, :auth => :writely,
-              :header => {"Content-Type" => "application/atom+xml", "If-Match" => "*"})
-          
+          header = {"Content-Type" => "application/atom+xml", "If-Match" => "*"}
+          @session.request(:put, edit_url, :data => xml, :auth => :writely, :header => header)
         end
         
         alias title= rename

data/lib/google_drive/list.rb

@@ -110,7 +110,7 @@ module GoogleDrive
         def key_to_col(key)
           key = key.to_s()
           col = (1..@worksheet.num_cols).find(){ |c| @worksheet[1, c] == key }
-          raise(GoogleDrive::Error, "Colunm doesn't exist: %p" % key) if !col
+          raise(GoogleDrive::Error, "Column doesn't exist: %p" % key) if !col
           return col
         end
         

data/lib/google_drive/session.rb

@@ -132,12 +132,12 @@ module GoogleDrive
         end
 
         # Returns list of spreadsheets for the user as array of GoogleDrive::Spreadsheet.
-        # You can specify query parameters described at
-        # http://code.google.com/apis/spreadsheets/docs/2.0/reference.html#Parameters
+        # You can specify query parameters e.g. "title", "title-exact".
         #
         # e.g.
         #   session.spreadsheets
         #   session.spreadsheets("title" => "hoge")
+        #   session.spreadsheets("title" => "hoge", "title-exact" => "true")
         def spreadsheets(params = {})
           query = encode_query(params)
           doc = request(
@@ -189,7 +189,7 @@ module GoogleDrive
         # Returns nil if not found. If multiple spreadsheets with the +title+ are found, returns
         # one of them.
         def spreadsheet_by_title(title)
-          return spreadsheets({"title" => title})[0]
+          return spreadsheets({"title" => title, "title-exact" => "true"})[0]
         end
         
         # Returns GoogleDrive::Worksheet with given +url+.
@@ -282,6 +282,10 @@ module GoogleDrive
         #   # Uploads without conversion:
         #   session.upload_from_string(
         #       "Hello world.", "Hello", :content_type => "text/plain", :convert => false)
+        #   
+        #   # Uploads and converts to a Google Spreadsheet:
+        #   session.upload_from_string("hoge\tfoo\n", "Hoge", :content_type => "text/tab-separated-values")
+        #   session.upload_from_string("hoge,foo\n", "Hoge", :content_type => "text/tsv")
         def upload_from_string(content, title = "Untitled", params = {})
           return upload_from_io(StringIO.new(content), title, params)
         end
@@ -290,7 +294,7 @@ module GoogleDrive
         # Returns a GoogleSpreadsheet::File object.
         #
         # e.g.
-        #   # Uploads and converts to a Google Docs document:
+        #   # Uploads a text file and converts to a Google Docs document:
         #   session.upload_from_file("/path/to/hoge.txt")
         #   
         #   # Uploads without conversion:
@@ -298,6 +302,12 @@ module GoogleDrive
         #   
         #   # Uploads with explicit content type:
         #   session.upload_from_file("/path/to/hoge", "Hoge", :content_type => "text/plain")
+        #   
+        #   # Uploads a text file and converts to a Google Spreadsheet:
+        #   session.upload_from_file("/path/to/hoge.tsv", "Hoge")
+        #   session.upload_from_file("/path/to/hoge.csv", "Hoge")
+        #   session.upload_from_file("/path/to/hoge", "Hoge", :content_type => "text/tab-separated-values")
+        #   session.upload_from_file("/path/to/hoge", "Hoge", :content_type => "text/tsv")
         def upload_from_file(path, title = nil, params = {})
           file_name = ::File.basename(path)
           params = {:file_name => file_name}.merge(params)
@@ -351,20 +361,28 @@ module GoogleDrive
               :response_type => :response)
           upload_url = initial_response["location"]
           
-          sent_bytes = 0
-          while data = io.read(UPLOAD_CHUNK_SIZE)
-            content_range = "bytes %d-%d/%d" % [
-                sent_bytes,
-                sent_bytes + data.bytesize - 1,
-                total_bytes,
-            ]
+          if total_bytes > 0
+            sent_bytes = 0
+            while data = io.read(UPLOAD_CHUNK_SIZE)
+              content_range = "bytes %d-%d/%d" % [
+                  sent_bytes,
+                  sent_bytes + data.bytesize - 1,
+                  total_bytes,
+              ]
+              upload_header = {
+                  "Content-Type" => content_type,
+                  "Content-Range" => content_range,
+              }
+              doc = request(
+                  :put, upload_url, :header => upload_header, :data => data, :auth => :writely)
+              sent_bytes += data.bytesize
+            end
+          else
             upload_header = {
                 "Content-Type" => content_type,
-                "Content-Range" => content_range,
             }
             doc = request(
-                :put, upload_url, :header => upload_header, :data => data, :auth => :writely)
-            sent_bytes += data.bytesize
+                :put, upload_url, :header => upload_header, :data => "", :auth => :writely)
           end
           
           return entry_element_to_file(doc.root)

data/lib/google_drive/util.rb

@@ -59,7 +59,8 @@ module GoogleDrive
         end
 
         def h(str)
-          return CGI.escapeHTML(str.to_s())
+          # Should also escape "\n" to keep it in cell contents.
+          return CGI.escapeHTML(str.to_s()).gsub(/\n/, '
')
         end
         
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google_drive
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-01 00:00:00.000000000 Z
+date: 2012-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -87,6 +87,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A library to read/write files/spreadsheets in Google Drive/Docs.
 email:
 - gimite+github@gmail.com