google_drive 1.0.6 → 2.0.0.pre1

data/lib/google_drive/config.rb

@@ -4,34 +4,32 @@
 require 'json'
 
 module GoogleDrive
-    class Config #:nodoc:
-
-        FIELDS = %w(client_id client_secret scope refresh_token).freeze
-        attr_accessor(*FIELDS)
-
-        def initialize(config_path)
-          @config_path = config_path
-          if ::File.exist?(config_path)
-            JSON.parse(::File.read(config_path)).each do |key, value|
-              instance_variable_set("@#{key}", value) if FIELDS.include?(key)
-            end
-          end
-        end
-
-        def save
-          ::File.open(@config_path, 'w', 0600) { |f| f.write(to_json()) }
+  class Config #:nodoc:
+    FIELDS = %w(client_id client_secret scope refresh_token).freeze
+    attr_accessor(*FIELDS)
+
+    def initialize(config_path)
+      @config_path = config_path
+      if ::File.exist?(config_path)
+        JSON.parse(::File.read(config_path)).each do |key, value|
+          instance_variable_set("@#{key}", value) if FIELDS.include?(key)
         end
+      end
+    end
 
-      private
+    def save
+      ::File.open(@config_path, 'w', 0600) { |f| f.write(to_json) }
+    end
 
-        def to_json
-          hash = {}
-          FIELDS.each do |field|
-            value = __send__(field)
-            hash[field] = value if value
-          end
-          return JSON.pretty_generate(hash)
-        end
+    private
 
+    def to_json
+      hash = {}
+      FIELDS.each do |field|
+        value = __send__(field)
+        hash[field] = value if value
+      end
+      JSON.pretty_generate(hash)
     end
+  end
 end

data/lib/google_drive/error.rb

@@ -2,7 +2,7 @@
 # The license of this source is "New BSD Licence"
 
 module GoogleDrive
-    # Raised on errors in this library.
-    class Error < RuntimeError
-    end
+  # Raised on errors in this library.
+  class Error < RuntimeError
+  end
 end

data/lib/google_drive/file.rb

@@ -1,301 +1,243 @@
 # Author: Hiroshi Ichikawa <http://gimite.net/>
 # The license of this source is "New BSD Licence"
 
-require "cgi"
-require "forwardable"
-require "stringio"
-
-require "google_drive/util"
-require "google_drive/acl"
+require 'cgi'
+require 'forwardable'
+require 'stringio'
 
+require 'google_drive/util'
+require 'google_drive/acl'
 
 module GoogleDrive
-    
-    # A file in Google Drive, including Google Docs document/spreadsheet/presentation.
+  # 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.
+  #
+  # In addition to the methods below, properties defined here are also available as attributes:
+  # https://developers.google.com/drive/v3/reference/files#resource
+  #
+  # e.g.,
+  #   file.mime_type  # ==> "text/plain"
+  class File
+    include(Util)
+    extend(Forwardable)
+
+    def initialize(session, api_file) #:nodoc:
+      @session = session
+      @api_file = api_file
+      @acl = nil
+      delegate_api_methods(self, @api_file, [:title])
+    end
+
+    # Wrapped Google::APIClient::Schema::Drive::V3::File object.
+    attr_reader(:api_file)
+
+    # Reloads file metadata such as title and acl.
+    def reload_metadata
+      @api_file = @session.drive.get_file(id, fields: '*')
+      @acl = Acl.new(@session, self) if @acl
+    end
+
+    # Returns resource_type + ":" + id.
+    def resource_id
+      '%s:%s' % [resource_type, id]
+    end
+
+    # URL of feed used in the deprecated document list feed API.
+    def document_feed_url
+      'https://docs.google.com/feeds/default/private/full/' + CGI.escape(resource_id)
+    end
+
+    # Deprecated ACL feed URL of the file.
+    def acl_feed_url
+      document_feed_url + '/acl'
+    end
+
+    # The type of resourse. e.g. "document", "spreadsheet", "folder"
+    def resource_type
+      mime_type.slice(/^application\/vnd.google-apps.(.+)$/, 1) || 'file'
+    end
+
+    # Title of the file.
+    def title(params = {})
+      reload_metadata if params[:reload]
+      api_file.name
+    end
+
+    # URL to view/edit the file in a Web browser.
     #
-    # Use GoogleDrive::Session#files or GoogleDrive::Session#file_by_title to
-    # get this object.
+    # e.g. "https://docs.google.com/file/d/xxxx/edit"
+    def human_url
+      api_file.web_view_link
+    end
+
+    # Content types you can specify in methods download_to_file, download_to_string,
+    # download_to_io .
     #
-    # In addition to the methods below, properties defined here are also available as attributes:
-    # https://developers.google.com/drive/v2/reference/files#resource
+    # This returns zero or one file type. You may be able to download the file in other formats using
+    # export_as_file, export_as_string, or export_to_io.
+    def available_content_types
+      api_file.download_url ? [api_file.mime_type] : []
+    end
+
+    # Downloads the file to a local file. e.g.
+    #   file.download_to_file("/path/to/hoge.txt")
     #
-    # e.g.,
-    #   file.mime_type  # ==> "text/plain"
-    class File
+    # To export the file in other formats, use export_as_file.
+    def download_to_file(path, params = {})
+      @session.drive.get_file(id, download_dest: path)
+    end
 
-        include(Util)
-        extend(Forwardable)
-        
-        def initialize(session, api_file) #:nodoc:
-          @session = session
-          @api_file = api_file
-          @acl = nil
-          delegate_api_methods(self, @api_file, ["title"])
-        end
+    # Downloads the file and returns as a String.
+    #
+    # To export the file in other formats, use export_as_string.
+    def download_to_string(params = {})
+      sio = StringIO.new
+      download_to_io(sio, params)
+      sio.string
+    end
 
-        # Wrapped Google::APIClient::Schema::Drive::V2::File object.
-        attr_reader(:api_file)
+    # Downloads the file and writes it to +io+.
+    #
+    # To export the file in other formats, use export_to_io.
+    def download_to_io(io, _params = {})
+      @session.drive.get_file(id, download_dest: io)
+    end
 
-        # Reloads file metadata such as title and acl.
-        def reload_metadata()
-          api_result = @session.execute!(
-            :api_method => @session.drive.files.get,
-            :parameters => { "fileId" => self.id })
-          @api_file = api_result.data
-          if @acl
-            @acl = Acl.new(@session, self)
-          end
-        end
+    # Export the file to +path+ in content type +format+.
+    # If +format+ is nil, it is guessed from the file name.
+    #
+    # e.g.,
+    #   spreadsheet.export_as_file("/path/to/hoge.csv")
+    #   spreadsheet.export_as_file("/path/to/hoge", "text/csv")
+    #
+    # If you want to download the file in the original format, use download_to_file instead.
+    def export_as_file(path, format = nil)
+      unless format
+        format = EXT_TO_CONTENT_TYPE[::File.extname(path).downcase]
+        unless format
+          fail(ArgumentError,
+               ("Cannot guess format from the file name: %s\n" \
+                'Specify format argument explicitly.') %
+               path)
+        end
+      end
+      export_to_dest(path, format)
+    end
 
-        # Returns resource_type + ":" + id.
-        def resource_id
-          return "%s:%s" % [self.resource_type, self.id]
-        end
+    # Export the file as String in content type +format+.
+    #
+    # e.g.,
+    #   spreadsheet.export_as_string("text/csv")
+    #
+    # If you want to download the file in the original format, use download_to_string instead.
+    def export_as_string(format)
+      sio = StringIO.new
+      export_to_dest(sio, format)
+      sio.string
+    end
 
-        # URL of feed used in the deprecated document list feed API.
-        def document_feed_url
-          return "https://docs.google.com/feeds/default/private/full/" + CGI.escape(self.resource_id)
-        end
+    # Export the file to +io+ in content type +format+.
+    #
+    # If you want to download the file in the original format, use download_to_io instead.
+    def export_to_io(io, format)
+      export_to_dest(io, format)
+    end
 
-        # Deprecated ACL feed URL of the file.
-        def acl_feed_url
-          return self.document_feed_url + "/acl"
-        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
 
-        # The type of resourse. e.g. "document", "spreadsheet", "folder"
-        def resource_type
-          return self.mime_type.slice(/^application\/vnd.google-apps.(.+)$/, 1) || "file"
-        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 = {})
+      # Somehow it doesn't work if I specify the file name directly as upload_source.
+      open(path, 'rb') do |f|
+        update_from_io(f, params)
+      end
+      nil
+    end
 
-        # Title of the file.
-        def title(params = {})
-          reload_metadata() if params[:reload]
-          return self.api_file.title
-        end
-        
-        # 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.alternate_link
-        end
-        
-        # Content types you can specify in methods download_to_file, download_to_string,
-        # download_to_io .
-        #
-        # This returns zero or one file type. You may be able to download the file in other formats using
-        # export_as_file, export_as_string, or export_to_io. Use export_links method to get available formats
-        # in these methods.
-        def available_content_types
-          if self.api_file.download_url
-            return [self.api_file.mime_type]
-          else
-            return []
-          end
-        end
-        
-        # Downloads the file to a local file. e.g.
-        #   file.download_to_file("/path/to/hoge.txt")
-        #
-        # To export the file in other formats, use export_as_file.
-        def download_to_file(path, params = {})
-          open(path, "wb") do |f|
-            download_to_io(f, params)
-          end
-        end
-        
-        # Downloads the file and returns as a String.
-        #
-        # To export the file in other formats, use export_as_string.
-        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+.
-        #
-        # To export the file in other formats, use export_to_io.
-        def download_to_io(io, params = {})
-          if !self.api_file.download_url
-            raise(GoogleDrive::Error, "Downloading is not supported for this file.")
-          end
-          # TODO Use streaming if possible.
-          api_result = @session.execute!(:uri => self.api_file.download_url)
-          io.write(api_result.body)
-        end
+    # Reads content from +io+ and updates the file with the content.
+    def update_from_io(io, params = {})
+      params = { upload_source: io }.merge(params)
+      @session.drive.update_file(id, nil, params)
+      nil
+    end
 
-        # Export the file to +path+ in content type +format+.
-        # If +format+ is nil, it is guessed from the file name.
-        #
-        # e.g.,
-        #   spreadsheet.export_as_file("/path/to/hoge.csv")
-        #   spreadsheet.export_as_file("/path/to/hoge", "text/csv")
-        #
-        # If you want to download the file in the original format, use download_to_file instead.
-        def export_as_file(path, format = nil)
-          if !format
-            format = EXT_TO_CONTENT_TYPE[::File.extname(path).downcase]
-            if !format
-              raise(ArgumentError,
-                  ("Cannot guess format from the file name: %s\n" +
-                   "Specify format argument explicitly.") %
-                  path)
-            end
-          end
-          open(path, "wb") do |f|
-            export_to_io(f, format)
-          end
-        end
-        
-        # Export the file as String in content type +format+.
-        #
-        # e.g.,
-        #   spreadsheet.export_as_string("text/csv")
-        #
-        # If you want to download the file in the original format, use download_to_string instead.
-        def export_as_string(format)
-          sio = StringIO.new()
-          export_to_io(sio, format)
-          return sio.string
-        end
+    # If +permanent+ is +false+, moves the file to the trash.
+    # If +permanent+ is +true+, deletes the file permanently.
+    def delete(permanent = false)
+      if permanent
+        @session.drive.delete_file(id)
+      else
+        @session.drive.update_file(id, { trashed: true }, {})
+      end
+      nil
+    end
 
-        # Export the file to +io+ in content type +format+.
-        #
-        # If you want to download the file in the original format, use download_to_io instead.
-        def export_to_io(io, format)
-          mime_type = EXT_TO_CONTENT_TYPE["." + format] || format
-          if !self.export_links
-            raise(
-                GoogleDrive::Error,
-                "This file doesn't support exporting. You may still download the file in the " +
-                "original format using download_to_file, download_to_string or download_to_io.")
-          end
-          export_url = self.export_links[mime_type]
-          if !export_url
-            raise(
-                GoogleDrive::Error,
-                "This file doesn't support export with mime type %p. Supported mime types: %p" %
-                    [mime_type, self.export_links.to_hash().keys])
-          end
-          # TODO Use streaming if possible.
-          api_result = @session.execute!(:uri => export_url)
-          io.write(api_result.body)
-        end
-        
-        # Updates the file with +content+.
-        #
-        # e.g.
-        #   file.update_from_string("Good bye, world.")
-        def update_from_string(content, params = {})
-          media = new_upload_io(StringIO.new(content), params)
-          return update_from_media(media, params)
-        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 = {})
-          file_name = ::File.basename(path)
-          params = {:file_name => file_name}.merge(params)
-          media = new_upload_io(path, params)
-          return update_from_media(media, params)
-        end
+    # Renames title of the file.
+    def rename(title)
+      @session.drive.update_file(id, { name: title }, {})
+      nil
+    end
 
-        # Reads content from +io+ and updates the file with the content.
-        def update_from_io(io, params = {})
-          media = new_upload_io(io, params)
-          return update_from_media(media, params)
-        end
+    alias_method :title=, :rename
 
-        # Reads content from +media+ and updates the file with the content.
-        def update_from_media(media, params = {})
-          api_result = @session.execute!(
-              :api_method => @session.drive.files.update,
-              :media => media,
-              :parameters => {
-                "fileId" => self.id,
-                "uploadType" => "media",
-              })
-          return @session.wrap_api_file(api_result.data)
-        end
+    # Creates copy of this file with the given title.
+    def copy(title)
+      api_file = @session.drive.copy_file(id, { name: title }, {})
+      @session.wrap_api_file(api_file)
+    end
 
-        # If +permanent+ is +false+, moves the file to the trash.
-        # If +permanent+ is +true+, deletes the file permanently.
-        def delete(permanent = false)
-          if permanent
-            @session.execute!(
-                :api_method => @session.drive.files.delete,
-                :parameters => {"fileId" => self.id})
-          else
-            @session.execute!(
-                :api_method => @session.drive.files.trash,
-                :parameters => {"fileId" => self.id})
-          end
-          return nil
-        end
+    alias_method :duplicate, :copy
 
-        # Renames title of the file.
-        def rename(title)
-          api_result = @session.execute!(
-              :api_method => @session.drive.files.patch,
-              :body_object => {"title" => title},
-              :parameters => {"fileId" => self.id})
-          @api_file = api_result.data
-        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.
+    #
+    # e.g.
+    #   # Dumps people who have access:
+    #   for entry in file.acl
+    #     p [entry.type, entry.email_address, 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(
+    #       {type: "user", email_address: "example2@gmail.com", role: "reader"})
+    #   file.acl.push(
+    #       {type: "user", email_address: "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 = {})
+      @acl = Acl.new(@session, self) if !@acl || params[:reload]
+      @acl
+    end
 
-        # Creates copy of this file with the given title.
-        def copy(title)
-          copied_file = @session.drive.files.copy.request_schema.new({
-              "title" => title,
-          })
-          api_result = @session.execute!(
-              :api_method => @session.drive.files.copy,
-              :body_object => copied_file,
-              :parameters => {"fileId" => self.id})
-          return @session.wrap_api_file(api_result.data)
-        end
+    def inspect
+      "\#<%p id=%p title=%p>" % [self.class, id, title]
+    end
 
-        alias duplicate copy
-        
-        # 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.
-        #
-        # 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(
-        #       {:type => "user", :value => "example2@gmail.com", :role => "reader"})
-        #   file.acl.push(
-        #       {:type => "user", :value => "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)
-          end
-          return @acl
-        end
+    private
 
-        def inspect
-          return "\#<%p id=%p title=%p>" % [self.class, self.id, self.title]
-        end
-        
+    def export_to_dest(dest, format)
+      mime_type = EXT_TO_CONTENT_TYPE['.' + format] || format
+      @session.drive.export_file(id, mime_type, download_dest: dest)
+      nil
     end
-    
+  end
 end