google_drive 0.3.0

data/lib/google_drive/authentication_error.rb

@@ -0,0 +1,14 @@
+# Author: Hiroshi Ichikawa <http://gimite.net/>
+# The license of this source is "New BSD Licence"
+
+require "google_drive/error"
+
+
+module GoogleDrive
+
+    # Raised when GoogleDrive.login has failed.
+    class AuthenticationError < GoogleDrive::Error
+
+    end
+    
+end

data/lib/google_drive/client_login_fetcher.rb

@@ -0,0 +1,56 @@
+# Author: Hiroshi Ichikawa <http://gimite.net/>
+# The license of this source is "New BSD Licence"
+
+require "net/https"
+require "uri"
+Net::HTTP.version_1_2
+
+
+module GoogleDrive
+
+    class ClientLoginFetcher #:nodoc:
+        
+        def initialize(auth_tokens, proxy)
+          @auth_tokens = auth_tokens
+          if proxy
+            @proxy = proxy
+          elsif ENV["http_proxy"] && !ENV["http_proxy"].empty?
+            proxy_url = URI.parse(ENV["http_proxy"])
+            @proxy = Net::HTTP.Proxy(proxy_url.host, proxy_url.port)
+          else
+            @proxy = Net::HTTP
+          end
+        end
+        
+        attr_accessor(:auth_tokens)
+        
+        def request_raw(method, url, data, extra_header, auth)
+          uri = URI.parse(url)
+          http = @proxy.new(uri.host, uri.port)
+          http.use_ssl = true
+          http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+          http.start() do
+            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
+        
+      private
+        
+        def auth_header(auth)
+          token = auth == :none ? nil : @auth_tokens[auth]
+          if token
+            return {"Authorization" => "GoogleLogin auth=#{token}"}
+          else
+            return {}
+          end
+        end
+
+    end
+    
+end

data/lib/google_drive/collection.rb

@@ -0,0 +1,54 @@
+# Author: Hiroshi Ichikawa <http://gimite.net/>
+# The license of this source is "New BSD Licence"
+
+require "google_drive/util"
+require "google_drive/error"
+require "google_drive/spreadsheet"
+
+
+module GoogleDrive
+
+    # Use GoogleDrive::Session#collection_by_url to get GoogleDrive::Collection object.
+    class Collection
+
+        include(Util)
+        
+        def initialize(session, collection_feed_url) #:nodoc:
+          @session = session
+          @collection_feed_url = collection_feed_url
+        end
+        
+        attr_reader(:collection_feed_url)
+        
+        # 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">
+              <id>#{h(file.document_feed_url)}</id>
+            </entry>
+          EOS
+          @session.request(
+              :post, 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")
+          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
+        
+        # Returns all the spreadsheets in the collection.
+        def spreadsheets
+          return self.files.select(){ |f| f.is_a?(Spreadsheet) }
+        end
+        
+        # TODO Add other operations.
+
+    end
+    
+end

data/lib/google_drive/error.rb

@@ -0,0 +1,12 @@
+# Author: Hiroshi Ichikawa <http://gimite.net/>
+# The license of this source is "New BSD Licence"
+
+
+module GoogleDrive
+
+    # Raised when spreadsheets.google.com has returned error.
+    class Error < RuntimeError
+
+    end
+    
+end

data/lib/google_drive/file.rb

@@ -0,0 +1,217 @@
+# Author: Hiroshi Ichikawa <http://gimite.net/>
+# The license of this source is "New BSD Licence"
+
+require "stringio"
+
+require "google_drive/util"
+require "google_drive/acl"
+
+
+module GoogleDrive
+    
+    # A file in Google Drive, including Google Docs document/spreadsheet/presentation.
+    #
+    # Use GoogleDrive::Session#files or GoogleDrive::Session#file_by_title to
+    # get this object.
+    class File
+
+        include(Util)
+        
+        def initialize(session, entry) #: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
+          @acl = nil
+        end
+        
+        # URL of feed used in document list feed API.
+        attr_reader(:document_feed_url)
+        
+        # <entry> element of document list feed as Nokogiri::XML::Element.
+        attr_reader(:document_feed_entry)
+        
+        # Title of the file.
+        attr_reader(:title)
+        
+        # URL to view/edit the file in a Web browser.
+        #
+        # e.g. "https://docs.google.com/file/d/xxxx/edit"
+        def human_url
+          return self.document_feed_entry.css("link[rel='alternate']")[0]["href"]
+        end
+        
+        # ACL feed URL of the file.
+        def acl_feed_url
+          orig_acl_feed_url = self.document_feed_entry.css(
+              "gd|feedLink[rel='http://schemas.google.com/acl/2007#accessControlList']")[0]["href"]
+          case orig_acl_feed_url
+            when %r{^https?://docs.google.com/feeds/default/private/full/.*/acl(\?.*)?$}
+              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"
+            else
+              raise(GoogleDrive::Error,
+                "ACL feed URL is in unknown format: #{orig_acl_feed_url}")
+          end
+        end
+
+        # Content types you can specify in methods download_to_file, download_to_string,
+        # download_to_io .
+        def available_content_types
+          return self.document_feed_entry.css("content").map(){ |c| c["type"] }
+        end
+        
+        # Downloads the file to a local file.
+        #
+        # e.g.
+        #   file.download_to_file("/path/to/hoge.txt")
+        #   file.download_to_file("/path/to/hoge", :content_type => "text/plain")
+        def download_to_file(path, params = {})
+          params = params.dup()
+          if !params[:content_type]
+            params[:content_type] = EXT_TO_CONTENT_TYPE[::File.extname(path).downcase]
+            params[:content_type_is_hint] = true
+          end
+          open(path, "wb") do |f|
+            download_to_io(f, params)
+          end
+        end
+        
+        # Downloads the file and returns as a String.
+        #
+        # e.g.
+        #   file.download_to_string()                               #=> "Hello world."
+        #   file.download_to_string(:content_type => "text/plain")  #=> "Hello world."
+        def download_to_string(params = {})
+          sio = StringIO.new()
+          download_to_io(sio, params)
+          return sio.string
+        end
+        
+        # Downloads the file and writes it to +io+.
+        def download_to_io(io, params = {})
+          all_contents = self.document_feed_entry.css("content")
+          if params[:content_type] && (!params[:content_type_is_hint] || all_contents.size > 1)
+            contents = all_contents.select(){ |c| c["type"] == params[:content_type] }
+          else
+            contents = all_contents
+          end
+          if contents.size == 1
+            url = contents[0]["src"]
+          else
+            if contents.empty?
+              raise(GoogleDrive::Error,
+                  ("Downloading with content type %p not supported for this file. " +
+                   "Specify one of these to content_type: %p") %
+                  [params[:content_type], self.available_content_types])
+            else
+              raise(GoogleDrive::Error,
+                  ("Multiple content types are available for this file. " +
+                   "Specify one of these to content_type: %p") %
+                  [self.available_content_types])
+            end
+          end
+          # TODO Use streaming if possible.
+          body = @session.request(:get, url, :response_type => :raw, :auth => :writely)
+          io.write(body)
+        end
+        
+        # Updates the file with the content of the local file.
+        #
+        # e.g.
+        #   file.update_from_file("/path/to/hoge.txt")
+        def update_from_file(path, params = {})
+          params = {:file_name => ::File.basename(path)}.merge(params)
+          open(path, "rb") do |f|
+            update_from_io(f, params)
+          end
+        end
+        
+        # Updates the file with +content+.
+        #
+        # e.g.
+        #   file.update_from_string("Good bye, world.")
+        def update_from_string(content, params = {})
+          update_from_io(StringIO.new(content), params)
+        end
+        
+        # Reads content from +io+ and updates the file with the content.
+        def update_from_io(io, params = {})
+          params = {:header => {"If-Match" => "*"}}.merge(params)
+          initial_url = self.document_feed_entry.css(
+              "link[rel='http://schemas.google.com/g/2005#resumable-edit-media']")[0]["href"]
+          @document_feed_entry = @session.upload_raw(
+              :put, initial_url, io, self.title, params)
+        end
+        
+        # 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" : ""),
+            :auth => :writely, :header => {"If-Match" => "*"})
+        end
+
+        # 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"]
+          xml = <<-"EOS"
+            <atom:entry
+                xmlns:atom="http://www.w3.org/2005/Atom"
+                xmlns:docs="http://schemas.google.com/docs/2007">
+              <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" => "*"})
+          
+        end
+        
+        alias title= rename
+        
+        # Returns GoogleDrive::Acl object for the file.
+        #
+        # 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.
+        #
+        # e.g.
+        #   # Dumps people who have access:
+        #   for entry in file.acl
+        #     p [entry.scope_type, entry.scope, entry.role]
+        #     # => e.g. ["user", "example1@gmail.com", "owner"]
+        #   end
+        #   
+        #   # Shares the file with new people:
+        #   # NOTE: This sends email to the new people.
+        #   file.acl.push(
+        #       {:scope_type => "user", :scope => "example2@gmail.com", :role => "reader"})
+        #   file.acl.push(
+        #       {:scope_type => "user", :scope => "example3@gmail.com", :role => "writer"})
+        #   
+        #   # Changes the role of a person:
+        #   file.acl[1].role = "writer"
+        #   
+        #   # Deletes an ACL entry:
+        #   file.acl.delete(file.acl[1])
+        def acl(params = {})
+          if !@acl || params[:reload]
+            @acl = Acl.new(@session, self.acl_feed_url)
+          end
+          return @acl
+        end
+
+        def inspect
+          return "\#<%p document_feed_url=%p>" % [self.class, self.document_feed_url]
+        end
+        
+    end
+    
+end

data/lib/google_drive/list.rb

@@ -0,0 +1,115 @@
+# Author: Hiroshi Ichikawa <http://gimite.net/>
+# The license of this source is "New BSD Licence"
+
+require "google_drive/util"
+require "google_drive/error"
+require "google_drive/list_row"
+
+
+module GoogleDrive
+
+    # Provides access to cells using column names.
+    # Use GoogleDrive::Worksheet#list to get GoogleDrive::List object.
+    #--
+    # This is implemented as wrapper of GoogleDrive::Worksheet i.e. using cells
+    # feed, not list feed. In this way, we can easily provide consistent API as
+    # GoogleDrive::Worksheet using save()/reload().
+    class List
+        
+        include(Enumerable)
+        
+        def initialize(worksheet) #:nodoc:
+          @worksheet = worksheet
+        end
+        
+        # Number of non-empty rows in the worksheet excluding the first row.
+        def size
+          return @worksheet.num_rows - 1
+        end
+        
+        # Returns Hash-like object (GoogleDrive::ListRow) for the row with the
+        # index. Keys of the object are colum names (the first row).
+        # The second row has index 0.
+        #
+        # Note that updates to the returned object are not sent to the server until
+        # you call GoogleDrive::Worksheet#save().
+        def [](index)
+          return ListRow.new(self, index)
+        end
+        
+        # Updates the row with the index with the given Hash object.
+        # Keys of +hash+ are colum names (the first row).
+        # The second row has index 0.
+        #
+        # Note that update is not sent to the server until
+        # you call GoogleDrive::Worksheet#save().
+        def []=(index, hash)
+          self[index].replace(hash)
+        end
+        
+        # Iterates over Hash-like object (GoogleDrive::ListRow) for each row
+        # (except for the first row).
+        # Keys of the object are colum names (the first row).
+        def each(&block)
+          for i in 0...self.size
+            yield(self[i])
+          end
+        end
+        
+        # Column names i.e. the contents of the first row.
+        # Duplicates are removed.
+        def keys
+          return (1..@worksheet.num_cols).map(){ |i| @worksheet[1, i] }.uniq()
+        end
+        
+        # Updates column names i.e. the contents of the first row.
+        #
+        # Note that update is not sent to the server until
+        # you call GoogleDrive::Worksheet#save().
+        def keys=(ary)
+          for i in 1..ary.size
+            @worksheet[1, i] = ary[i - 1]
+          end
+          for i in (ary.size + 1)..@worksheet.num_cols
+            @worksheet[1, i] = ""
+          end
+        end
+        
+        # Adds a new row to the bottom.
+        # Keys of +hash+ are colum names (the first row).
+        # Returns GoogleDrive::ListRow for the new row.
+        #
+        # Note that update is not sent to the server until
+        # you call GoogleDrive::Worksheet#save().
+        def push(hash)
+          row = self[self.size]
+          row.update(hash)
+          return row
+        end
+        
+        # Returns all rows (except for the first row) as Array of Hash.
+        # Keys of Hash objects are colum names (the first row).
+        def to_hash_array()
+          return self.map(){ |r| r.to_hash() }
+        end
+        
+        def get(index, key) #:nodoc:
+          return @worksheet[index + 2, key_to_col(key)]
+        end
+        
+        def set(index, key, value) #:nodoc:
+          @worksheet[index + 2, key_to_col(key)] = value
+        end
+        
+      private
+        
+        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
+          return col
+        end
+        
+    end
+    
+end