google_drive 0.3.11 → 1.0.0.pre1

data/lib/google_drive_v1/session.rb

@@ -0,0 +1,522 @@
+# Author: Hiroshi Ichikawa <http://gimite.net/>
+# The license of this source is "New BSD Licence"
+
+require "cgi"
+require "stringio"
+
+require "rubygems"
+require "nokogiri"
+require "oauth"
+require "oauth2"
+
+require "google_drive_v1/util"
+require "google_drive_v1/client_login_fetcher"
+require "google_drive_v1/oauth1_fetcher"
+require "google_drive_v1/oauth2_fetcher"
+require "google_drive_v1/error"
+require "google_drive_v1/authentication_error"
+require "google_drive_v1/spreadsheet"
+require "google_drive_v1/worksheet"
+require "google_drive_v1/collection"
+require "google_drive_v1/file"
+
+
+module GoogleDriveV1
+
+    # Use GoogleDriveV1.login or GoogleDriveV1.saved_session to get
+    # GoogleDriveV1::Session object.
+    class Session
+
+        include(Util)
+        extend(Util)
+
+        UPLOAD_CHUNK_SIZE = 512 * 1024
+        
+        # DEPRECATED: Will be removed in the next version.
+        #
+        # The same as GoogleDriveV1.login.
+        def self.login(mail, password, proxy = nil)
+          warn(
+              "WARNING: GoogleDriveV1.login is deprecated and will be removed in the next version. " +
+              "Use GoogleDriveV1.login_with_oauth instead.")
+          session = Session.new(nil, ClientLoginFetcher.new({}, proxy))
+          session.login(mail, password)
+          return session
+        end
+
+        # The same as GoogleDriveV1.login_with_oauth.
+        def self.login_with_oauth(access_token, proxy = nil)
+          if proxy
+            warn(
+              "WARNING: Specifying a proxy object is deprecated and will not work in the next version. " +
+              "Set ENV[\"http_proxy\"] instead.")
+          end
+          case access_token
+            when OAuth::AccessToken
+              warn(
+                "WARNING: Authorization with OAuth1 is deprecated and will not work in the next version. " +
+                "Use OAuth2 instead.")
+              raise(GoogleDriveV1::Error, "proxy is not supported with OAuth1.") if proxy
+              fetcher = OAuth1Fetcher.new(access_token)
+            when OAuth2::AccessToken
+              fetcher = OAuth2Fetcher.new(access_token.token, proxy)
+            when String
+              fetcher = OAuth2Fetcher.new(access_token, proxy)
+            else
+              raise(GoogleDriveV1::Error,
+                  "access_token is neither String, OAuth2::Token nor OAuth::Token: %p" % access_token)
+          end
+          return Session.new(nil, fetcher)
+        end
+
+        # The same as GoogleDriveV1.restore_session.
+        def self.restore_session(auth_tokens, proxy = nil)
+          warn(
+              "WARNING: GoogleDriveV1.restore_session is deprecated and will be removed in the next version. " +
+              "Use GoogleDriveV1.login_with_oauth instead.")
+          return Session.new(auth_tokens, nil, proxy)
+        end
+        
+        # Creates a dummy GoogleDriveV1::Session object for testing.
+        def self.new_dummy()
+          return Session.new(nil, Object.new())
+        end
+
+        # DEPRECATED: Use GoogleDriveV1.restore_session instead.
+        def initialize(auth_tokens = nil, fetcher = nil, proxy = nil)
+          if fetcher
+            @fetcher = fetcher
+          else
+            @fetcher = ClientLoginFetcher.new(auth_tokens || {}, proxy)
+          end
+        end
+
+        # Authenticates with given +mail+ and +password+, and updates current session object
+        # if succeeds. Raises GoogleDriveV1::AuthenticationError if fails.
+        # Google Apps account is supported.
+        def login(mail, password)
+          if !@fetcher.is_a?(ClientLoginFetcher)
+            raise(GoogleDriveV1::Error,
+                "Cannot call login for session created by login_with_oauth.")
+          end
+          begin
+            @fetcher.auth_tokens = {
+              :wise => authenticate(mail, password, :wise),
+              :writely => authenticate(mail, password, :writely),
+            }
+          rescue GoogleDriveV1::Error => ex
+            return true if @on_auth_fail && @on_auth_fail.call()
+            raise(AuthenticationError, "Authentication failed for #{mail}: #{ex.message}")
+          end
+        end
+
+        # Authentication tokens.
+        def auth_tokens
+          warn(
+              "WARNING: GoogleDriveV1::Session\#auth_tokens is deprecated and will be removed in the next version.")
+          if !@fetcher.is_a?(ClientLoginFetcher)
+            raise(GoogleDriveV1::Error,
+                "Cannot call auth_tokens for session created by " +
+                "login_with_oauth.")
+          end
+          return @fetcher.auth_tokens
+        end
+
+        # Authentication token.
+        def auth_token(auth = :wise)
+          warn(
+              "WARNING: GoogleDriveV1::Session\#auth_token is deprecated and will be removed in the next version.")
+          return self.auth_tokens[auth]
+        end
+
+        # Proc or Method called when authentication has failed.
+        # When this function returns +true+, it tries again.
+        def on_auth_fail
+          warn(
+              "WARNING: GoogleDriveV1::Session\#on_auth_fail is deprecated and will be removed in the next version.")
+          return @on_auth_fail
+        end
+
+        def on_auth_fail=(func)
+          warn(
+              "WARNING: GoogleDriveV1::Session\#on_auth_fail is deprecated and will be removed in the next version.")
+          @on_auth_fail = func
+        end
+
+        # Returns list of files for the user as array of GoogleDriveV1::File or its subclass.
+        # 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(
+              "#{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
+        
+        # Returns GoogleDriveV1::File or its subclass whose title exactly matches +title+.
+        # Returns nil if not found. If multiple files with the +title+ are found, returns
+        # one of them.
+        #
+        # If given an Array, traverses collections by title. e.g.
+        #   session.file_by_title(["myfolder", "mysubfolder/even/w/slash", "myfile"])
+        def file_by_title(title)
+          if title.is_a?(Array)
+            return self.root_collection.file_by_title(title)
+          else
+            return files("title" => title, "title-exact" => "true")[0]
+          end
+        end
+
+        # Returns list of spreadsheets for the user as array of GoogleDriveV1::Spreadsheet.
+        # 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 = {})
+          url = concat_url(
+              "#{DOCS_BASE_URL}/-/spreadsheet?v=3", "?" + encode_query(params))
+          doc = request(:get, url, :auth => :writely)
+          # The API may return non-spreadsheets too when title-exact is specified.
+          # Probably a bug. For workaround, only returns Spreadsheet instances.
+          return doc.css("feed > entry").
+              map(){ |e| entry_element_to_file(e) }.
+              select(){ |f| f.is_a?(Spreadsheet) }
+        end
+
+        # Returns GoogleDriveV1::Spreadsheet with given +key+.
+        #
+        # e.g.
+        #   # http://spreadsheets.google.com/ccc?key=pz7XtlQC-PYx-jrVMJErTcg&hl=ja
+        #   session.spreadsheet_by_key("pz7XtlQC-PYx-jrVMJErTcg")
+        def spreadsheet_by_key(key)
+          url = "https://spreadsheets.google.com/feeds/worksheets/#{key}/private/full"
+          return Spreadsheet.new(self, url)
+        end
+
+        # Returns GoogleDriveV1::Spreadsheet with given +url+. You must specify either of:
+        # - URL of the page you open to access the spreadsheet in your browser
+        # - URL of worksheet-based feed of the spreadseet
+        #
+        # e.g.
+        #   session.spreadsheet_by_url(
+        #     "https://docs.google.com/spreadsheet/ccc?key=pz7XtlQC-PYx-jrVMJErTcg")
+        #   session.spreadsheet_by_url(
+        #     "https://spreadsheets.google.com/feeds/" +
+        #     "worksheets/pz7XtlQC-PYx-jrVMJErTcg/private/full")
+        def spreadsheet_by_url(url)
+          # Tries to parse it as URL of human-readable spreadsheet.
+          uri = URI.parse(url)
+          if ["spreadsheets.google.com", "docs.google.com"].include?(uri.host)
+            case uri.path
+              when /\/d\/([^\/]+)/
+                return spreadsheet_by_key($1)
+              when /\/ccc$/
+                if (uri.query || "").split(/&/).find(){ |s| s=~ /^key=(.*)$/ }
+                  return spreadsheet_by_key($1)
+                end
+            end
+          end
+          # Assumes the URL is worksheets feed URL.
+          return Spreadsheet.new(self, url)
+        end
+
+        # Returns GoogleDriveV1::Spreadsheet with given +title+.
+        # 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, "title-exact" => "true"})[0]
+        end
+        
+        # Returns GoogleDriveV1::Worksheet with given +url+.
+        # You must specify URL of cell-based feed of the worksheet.
+        #
+        # e.g.
+        #   session.worksheet_by_url(
+        #     "http://spreadsheets.google.com/feeds/" +
+        #     "cells/pz7XtlQC-PYxNmbBVgyiNWg/od6/private/full")
+        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
+        # GoogleDriveV1::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 GoogleDriveV1::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
+        #   open a collection
+        # - URL of collection (folder) feed
+        #
+        # e.g.
+        #   session.collection_by_url(
+        #     "https://drive.google.com/#folders/" +
+        #     "0B9GfDpQ2pBVUODNmOGE0NjIzMWU3ZC00NmUyLTk5NzEtYaFkZjY1MjAyxjMc")
+        #   session.collection_by_url(
+        #     "http://docs.google.com/feeds/default/private/full/folder%3A" +
+        #     "0B9GfDpQ2pBVUODNmOGE0NjIzMWU3ZC00NmUyLTk5NzEtYaFkZjY1MjAyxjMc")
+        def collection_by_url(url)
+          uri = URI.parse(url)
+          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 = "#{DOCS_BASE_URL}/folder%3A#{$1}"
+          end
+          return Collection.new(self, to_v3_url(url))
+        end
+
+        # Creates new spreadsheet and returns the new GoogleDriveV1::Spreadsheet.
+        #
+        # e.g.
+        #   session.create_spreadsheet("My new sheet")
+        def create_spreadsheet(
+            title = "Untitled",
+            feed_url = "https://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>#{h(title)}</atom:title>
+            </atom:entry>
+          EOS
+
+          doc = request(:post, feed_url, :data => xml, :auth => :writely)
+          ss_url = doc.css(
+            "link[rel='http://schemas.google.com/spreadsheets/2006#worksheetsfeed']")[0]["href"]
+          return Spreadsheet.new(self, ss_url, title)
+          
+        end
+        
+        # Uploads a file with the given +title+ and +content+.
+        # Returns a GoogleSpreadsheet::File object.
+        #
+        # e.g.
+        #   # Uploads and converts to a Google Docs document:
+        #   session.upload_from_string(
+        #       "Hello world.", "Hello", :content_type => "text/plain")
+        #   
+        #   # 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
+        
+        # Uploads a local file.
+        # Returns a GoogleSpreadsheet::File object.
+        #
+        # e.g.
+        #   # Uploads a text file and converts to a Google Docs document:
+        #   session.upload_from_file("/path/to/hoge.txt")
+        #   
+        #   # Uploads without conversion:
+        #   session.upload_from_file("/path/to/hoge.txt", "Hoge", :convert => false)
+        #   
+        #   # 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/csv")
+        def upload_from_file(path, title = nil, params = {})
+          file_name = ::File.basename(path)
+          params = {:file_name => file_name}.merge(params)
+          open(path, "rb") do |f|
+            return upload_from_io(f, title || file_name, params)
+          end
+        end
+        
+        # Uploads a file. Reads content from +io+.
+        # Returns a GoogleSpreadsheet::File object.
+        def upload_from_io(io, title = "Untitled", params = {})
+          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"]
+          entry = upload_raw(:post, initial_url, io, title, params)
+          return entry_element_to_file(entry)
+        end
+
+        def upload_raw(method, url, io, title = "Untitled", params = {}) #:nodoc:
+          
+          params = {:convert => true}.merge(params)
+          pos = io.pos
+          io.seek(0, IO::SEEK_END)
+          total_bytes = io.pos - pos
+          io.pos = pos
+          content_type = params[:content_type]
+          if !content_type && params[:file_name]
+            content_type = EXT_TO_CONTENT_TYPE[::File.extname(params[:file_name]).downcase]
+          end
+          if !content_type
+            content_type = "application/octet-stream"
+          end
+          
+          initial_xml = <<-"EOS"
+            <entry xmlns="http://www.w3.org/2005/Atom" 
+                xmlns:docs="http://schemas.google.com/docs/2007">
+              <title>#{h(title)}</title>
+            </entry>
+          EOS
+          
+          default_initial_header = {
+              "Content-Type" => "application/atom+xml;charset=utf-8",
+              "X-Upload-Content-Type" => content_type,
+              "X-Upload-Content-Length" => total_bytes.to_s(),
+          }
+          initial_full_url = concat_url(url, params[:convert] ? "?convert=true" : "?convert=false")
+          initial_response = request(method, initial_full_url,
+              :header => default_initial_header.merge(params[:header] || {}),
+              :data => initial_xml,
+              :auth => :writely,
+              :response_type => :response)
+          upload_url = initial_response["location"]
+          
+          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,
+            }
+            doc = request(
+                :put, upload_url, :header => upload_header, :data => "", :auth => :writely)
+          end
+          
+          return doc.root
+          
+        end
+        
+        def entry_element_to_file(entry) #:nodoc:
+          type, resource_id = entry.css("gd|resourceId").text.split(/:/)
+          title = entry.css("title").text
+          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 GoogleDriveV1::File.new(self, entry)
+          end
+        end
+
+        def request(method, url, params = {}) #:nodoc:
+          
+          # Always uses HTTPS.
+          url = url.gsub(%r{^http://}, "https://")
+          data = params[:data]
+          auth = params[:auth] || :wise
+          if params[:header]
+            extra_header = params[:header]
+          elsif data
+            extra_header = {"Content-Type" => "application/atom+xml;charset=utf-8"}
+          else
+            extra_header = {}
+          end
+          response_type = params[:response_type] || :xml
+
+          while true
+            response = @fetcher.request_raw(method, url, data, extra_header, auth)
+            if response.code == "401" && @on_auth_fail && @on_auth_fail.call()
+              next
+            end
+            if !(response.code =~ /^[23]/)
+              raise(
+                response.code == "401" ? AuthenticationError : GoogleDriveV1::Error,
+                "Response code #{response.code} for #{method} #{url}: " +
+                CGI.unescapeHTML(response.body))
+            end
+            return convert_response(response, response_type)
+          end
+          
+        end
+        
+        def inspect
+          return "#<%p:0x%x>" % [self.class, self.object_id]
+        end
+
+      private
+
+        def convert_response(response, response_type)
+          case response_type
+            when :xml
+              return Nokogiri.XML(response.body)
+            when :raw
+              return response.body
+            when :response
+              return response
+            else
+              raise(GoogleDriveV1::Error,
+                  "Unknown params[:response_type]: %s" % response_type)
+          end
+        end
+
+        def authenticate(mail, password, auth)
+          params = {
+            "accountType" => "HOSTED_OR_GOOGLE",
+            "Email" => mail,
+            "Passwd" => password,
+            "service" => auth.to_s(),
+            "source" => "Gimite-RubyGoogleDrive-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 => header,
+            :response_type => :raw)
+          return response.slice(/^Auth=(.*)$/, 1)
+        end
+
+    end
+
+end