google_drive 2.1.8 → 2.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a307d368da1d8c3aaddcc80fce8e3ab842e31fbc
-  data.tar.gz: f638dfeb91a08128bfca2e547973efd2b1172a42
+  metadata.gz: 865c482b6edbfefd86f4a5e9658b9487e70b99c6
+  data.tar.gz: da516192ff4de976a61327eaa61602dc1df51dd5
 SHA512:
-  metadata.gz: f6ead9f1d7cedf6efedd25b88b0d36d8599c63824ed616d3401eebaf9d0431c29e4d41ef6e4ec1cfa1754de76dc47c23754946c17334bcd264929e37ffd1e40a
-  data.tar.gz: 56a2e06379ea4a54efbc2c2ac53d65c1f93b89ab7036f6989ce79b143c45b3d43dee68d1fe9d9102b1133a5aab82f94d6d1ce8332475eafd2e2b55c65be4e87b
+  metadata.gz: a31cb6ce83639300b5e182b36146dbb4132ce182cd520a44dd1474f105d81e54eeb9cea4522b7b205a57c7530eefcb2e9c872a0766e1aa021232d72cd15c9c0d
+  data.tar.gz: 81986aea9ec0ebd102808fa49c82ae9910ea9bb31b9e7c135e34eb66a1218222a5a09071254a1606839cfd013edfe432dd5f82ec1a00429289d198f84df1cf2b

data/lib/google_drive.rb

@@ -18,13 +18,18 @@ module GoogleDrive
       config = ENV['HOME'] + '/.ruby_google_drive.token',
       proxy = nil,
       client_id = nil,
-      client_secret = nil)
+      client_secret = nil
+  )
     if proxy
-      fail(
+      raise(
         ArgumentError,
-        'Specifying a proxy object is no longer supported. Set ENV["http_proxy"] instead.')
+        'Specifying a proxy object is no longer supported. ' \
+        'Set ENV["http_proxy"] instead.'
+      )
     end
 
-    Session.from_config(config, client_id: client_id, client_secret: client_secret)
+    Session.from_config(
+      config, client_id: client_id, client_secret: client_secret
+    )
   end
 end

data/lib/google_drive/acl.rb

@@ -21,14 +21,15 @@ module GoogleDrive
       @session = session
       @file = file
       api_permissions = @session.drive.list_permissions(@file.id, fields: '*')
-      @entries = api_permissions.permissions.map { |perm| AclEntry.new(perm, self) }
+      @entries =
+        api_permissions.permissions.map { |perm| AclEntry.new(perm, self) }
     end
 
     def_delegators(:@entries, :size, :[], :each)
 
-    # Adds a new entry. +entry+ is either a GoogleDrive::AclEntry or a Hash with keys
-    # +:type+, +:email_address+, +:domain+, +:role+ and +:allow_file_discovery+.
-    # See GoogleDrive::AclEntry#type and
+    # Adds a new entry. +entry+ is either a GoogleDrive::AclEntry or a Hash with
+    # keys +:type+, +:email_address+, +:domain+, +:role+ and
+    # +:allow_file_discovery+. See GoogleDrive::AclEntry#type and
     # GoogleDrive::AclEntry#role for the document of the fields.
     #
     # Also you can pass the second hash argument +options+, which specifies
@@ -37,9 +38,9 @@ module GoogleDrive
     # * :email_message  -- A custom message to include in notification emails
     # * :send_notification_email  -- Whether to send notification emails
     #   when sharing to users or groups. (Default: true)
-    # * :transfer_ownership  -- Whether to transfer ownership to the specified user
-    #   and downgrade the current owner to a writer. This parameter is required as an
-    #   acknowledgement of the side effect. (Default: false)
+    # * :transfer_ownership  -- Whether to transfer ownership to the specified
+    #   user and downgrade the current owner to a writer. This parameter is
+    #   required as an acknowledgement of the side effect. (Default: false)
     #
     # e.g.
     #   # A specific user can read or write.
@@ -64,8 +65,11 @@ module GoogleDrive
     # See here for parameter detais:
     # https://developers.google.com/drive/v3/reference/permissions/create
     def push(params_or_entry, options = {})
-      entry = params_or_entry.is_a?(AclEntry) ? params_or_entry : AclEntry.new(params_or_entry)
-      api_permission = @session.drive.create_permission(@file.id, entry.params, {fields: '*'}.merge(options))
+      entry = params_or_entry.is_a?(AclEntry) ?
+        params_or_entry : AclEntry.new(params_or_entry)
+      api_permission = @session.drive.create_permission(
+        @file.id, entry.params, { fields: '*' }.merge(options)
+      )
       new_entry = AclEntry.new(api_permission, self)
       @entries.push(new_entry)
       new_entry
@@ -83,13 +87,14 @@ module GoogleDrive
     # @api private
     def update_role(entry)
       api_permission = @session.drive.update_permission(
-        @file.id, entry.id, {role: entry.role}, fields: '*')
+        @file.id, entry.id, { role: entry.role }, fields: '*'
+      )
       entry.api_permission = api_permission
       entry
     end
 
     def inspect
-      "\#<%p %p>" % [self.class, @entries]
+      format("\#<%p %p>", self.class, @entries)
     end
   end
 end

data/lib/google_drive/acl_entry.rb

@@ -54,7 +54,7 @@ module GoogleDrive
       @params ? @params[:type] : @api_permission.type
     end
 
-    alias_method :scope_type, :type
+    alias scope_type type
 
     def additional_roles
       @params ? @params[:additionalRoles] : @api_permission.additional_roles
@@ -81,8 +81,6 @@ module GoogleDrive
           @params[:email_address]
         when 'domain'
           @params[:domain]
-        else
-          nil
         end
       else
         case @api_permission.type
@@ -90,18 +88,17 @@ module GoogleDrive
           @api_permission.email_address
         when 'domain'
           @api_permission.domain
-        else
-          nil
         end
       end
     end
 
-    alias_method :scope, :value
+    alias scope value
 
     # If +false+, the file is shared only with people who know the link.
     # Only used for type "anyone".
     def allow_file_discovery
-      @params ? @params[:allow_file_discovery] : @api_permission.allow_file_discovery
+      @params ?
+        @params[:allow_file_discovery] : @api_permission.allow_file_discovery
     end
 
     # If +true+, the file is shared only with people who know the link.
@@ -110,7 +107,7 @@ module GoogleDrive
       allow_file_discovery == false
     end
 
-    alias_method :with_key, :with_link
+    alias with_key with_link
 
     # Changes the role of the scope.
     #
@@ -128,17 +125,22 @@ module GoogleDrive
     def inspect
       case type
       when 'user', 'group'
-        "\#<%p type=%p, email_address=%p, role=%p>" %
-          [self.class, type, email_address, role]
+        format(
+          "\#<%p type=%p, email_address=%p, role=%p>",
+          self.class, type, email_address, role
+        )
       when 'domain'
-        "\#<%p type=%p, domain=%p, role=%p>" %
-          [self.class, type, domain, role]
+        format(
+          "\#<%p type=%p, domain=%p, role=%p>",
+          self.class, type, domain, role
+        )
       when 'anyone'
-        "\#<%p type=%p, role=%p, allow_file_discovery=%p>" %
-          [self.class, type, role, allow_file_discovery]
+        format(
+          "\#<%p type=%p, role=%p, allow_file_discovery=%p>",
+          self.class, type, role, allow_file_discovery
+        )
       else
-        "\#<%p type=%p, role=%p>" %
-          [self.class, type, role]
+        format("\#<%p type=%p, role=%p>", self.class, type, role)
       end
     end
 

data/lib/google_drive/api_client_fetcher.rb

@@ -21,10 +21,10 @@ module GoogleDrive
       @drive = Google::Apis::DriveV3::DriveService.new
       @drive.authorization = authorization
 
-      # Make the timeout virtually infinite because some of the operations (e.g., uploading a large file)
-      # can take very long.
+      # Make the timeout virtually infinite because some of the operations
+      # (e.g., uploading a large file) can take very long.
       # This value is the maximal allowed timeout in seconds on JRuby.
-      t = (2 ** 31 - 1) / 1000
+      t = (2**31 - 1) / 1000
       @drive.client_options.open_timeout_sec = t
       @drive.client_options.read_timeout_sec = t
       @drive.client_options.send_timeout_sec = t

data/lib/google_drive/collection.rb

@@ -8,8 +8,10 @@ require 'google_drive/spreadsheet'
 module GoogleDrive
   # Represents a folder in Google Drive.
   #
-  # Use GoogleDrive::Session#root_collection, GoogleDrive::Collection#subcollections,
-  # or GoogleDrive::Session#collection_by_url to get GoogleDrive::Collection object.
+  # Use GoogleDrive::Session#root_collection,
+  # GoogleDrive::Collection#subcollections,
+  # or GoogleDrive::Session#collection_by_url to get GoogleDrive::Collection
+  # object.
   class Collection < GoogleDrive::File
     include(Util)
 
@@ -17,26 +19,33 @@ module GoogleDrive
 
     # Adds the given GoogleDrive::File to the folder.
     def add(file)
-      @session.drive.update_file(file.id, add_parents: self.id, fields: '', supports_team_drives: true)
+      @session.drive.update_file(
+        file.id, add_parents: id, fields: '', supports_team_drives: true
+      )
       nil
     end
 
     # Removes the given GoogleDrive::File from the folder.
     def remove(file)
-      @session.drive.update_file(file.id, remove_parents: self.id, fields: '', supports_team_drives: true)
+      @session.drive.update_file(
+        file.id, remove_parents: id, fields: '', supports_team_drives: true
+      )
     end
 
-    # Creates a sub-folder with given title. Returns GoogleDrive::Collection object.
+    # Creates a sub-folder with given title. Returns GoogleDrive::Collection
+    # object.
     def create_subcollection(title)
       file_metadata = {
         name: title,
         mime_type: 'application/vnd.google-apps.folder',
-        parents: [self.id],
+        parents: [id]
       }
-      file = @session.drive.create_file(file_metadata, fields: '*', supports_team_drives: true)
+      file = @session.drive.create_file(
+        file_metadata, fields: '*', supports_team_drives: true
+      )
       @session.wrap_api_file(file)
     end
-    
+
     alias create_subfolder create_subcollection
 
     # Returns true if this is a root folder.
@@ -44,8 +53,8 @@ module GoogleDrive
       !api_file.parents || api_file.parents.empty?
     end
 
-    # Returns all the files (including spreadsheets, documents, subfolders) in the folder.
-    # You can specify parameters documented at
+    # Returns all the files (including spreadsheets, documents, subfolders) in
+    # the folder. You can specify parameters documented at
     # https://developers.google.com/drive/v3/web/search-parameters
     #
     # e.g.
@@ -59,73 +68,74 @@ module GoogleDrive
     #   # Same as above with a placeholder.
     #   collection.files(q: ["name = ?", "hoge"])
     #
-    # By default, it returns the first 100 files. See document of GoogleDrive::Session#files method
-    # for how to get all files.
+    # By default, it returns the first 100 files. See document of
+    # GoogleDrive::Session#files method for how to get all files.
     def files(params = {}, &block)
       files_with_type(nil, params, &block)
     end
 
     # Uploads a file to this folder. See Session#upload_from_file for details.
     def upload_from_file(path, title = nil, params = {})
-      params = {parents: [self.id]}.merge(params)
+      params = { parents: [id] }.merge(params)
       @session.upload_from_file(path, title, params)
     end
 
     # Uploads a file to this folder. See Session#upload_from_io for details.
     def upload_from_io(io, title = 'Untitled', params = {})
-      params = {parents: [self.id]}.merge(params)
+      params = { parents: [id] }.merge(params)
       @session.upload_from_io(io, title, params)
     end
 
     # Uploads a file to this folder. See Session#upload_from_string for details.
     def upload_from_string(content, title = 'Untitled', params = {})
-      params = {parents: [self.id]}.merge(params)
+      params = { parents: [id] }.merge(params)
       @session.upload_from_string(content, title, params)
     end
 
-    alias_method :contents, :files
+    alias contents files
 
     # Returns all the spreadsheets in the folder.
     #
-    # By default, it returns the first 100 spreadsheets. See document of GoogleDrive::Session#files method
-    # for how to get all spreadsheets.
+    # By default, it returns the first 100 spreadsheets. See document of
+    # GoogleDrive::Session#files method for how to get all spreadsheets.
     def spreadsheets(params = {}, &block)
       files_with_type('application/vnd.google-apps.spreadsheet', params, &block)
     end
 
     # Returns all the Google Docs documents in the folder.
     #
-    # By default, it returns the first 100 documents. See document of GoogleDrive::Session#files method
-    # for how to get all documents.
+    # By default, it returns the first 100 documents. See document of
+    # GoogleDrive::Session#files method for how to get all documents.
     def documents(params = {}, &block)
       files_with_type('application/vnd.google-apps.document', params, &block)
     end
 
     # Returns all its subfolders.
     #
-    # By default, it returns the first 100 subfolders. See document of GoogleDrive::Session#files method
-    # for how to get all subfolders.
+    # By default, it returns the first 100 subfolders. See document of
+    # GoogleDrive::Session#files method for how to get all subfolders.
     def subcollections(params = {}, &block)
       files_with_type('application/vnd.google-apps.folder', params, &block)
     end
-    
+
     alias subfolders subcollections
 
-    # Returns a file (can be a spreadsheet, document, subfolder or other files) in the
-    # folder which exactly matches +title+ as GoogleDrive::File.
-    # Returns nil if not found. If multiple folders with the +title+ are found, returns
-    # one of them.
+    # Returns a file (can be a spreadsheet, document, subfolder or other files)
+    # in the folder which exactly matches +title+ as GoogleDrive::File.
+    # Returns nil if not found. If multiple folders with the +title+ are found,
+    # returns one of them.
     #
     # If given an Array, does a recursive subfolder traversal.
     def file_by_title(title)
       file_by_title_with_type(title, nil)
     end
-    
+
     alias file_by_name file_by_title
 
-    # Returns its subfolder whose title exactly matches +title+ as GoogleDrive::Collection.
-    # Returns nil if not found. If multiple folders with the +title+ are found, returns
-    # one of them.
+    # Returns its subfolder whose title exactly matches +title+ as
+    # GoogleDrive::Collection.
+    # Returns nil if not found. If multiple folders with the +title+ are found,
+    # returns one of them.
     #
     # If given an Array, does a recursive subfolder traversal.
     def subcollection_by_title(title)
@@ -133,7 +143,7 @@ module GoogleDrive
     end
 
     alias subfolder_by_name subcollection_by_title
-    
+
     # Returns URL of the deprecated contents feed.
     def contents_url
       document_feed_url + '/contents'
@@ -154,7 +164,7 @@ module GoogleDrive
         files_with_type(type, q: ['name = ?', title], page_size: 1)[0]
       end
     end
-    
+
     alias file_by_name_with_type file_by_title_with_type
 
     private
@@ -162,15 +172,16 @@ module GoogleDrive
     def files_with_type(type, params = {}, &block)
       params = convert_params(params)
       query  = construct_and_query([
-        ['? in parents', id],
-        type ? ['mimeType = ?', type] : nil,
-        params[:q]
-      ])
+                                     ['? in parents', id],
+                                     type ? ['mimeType = ?', type] : nil,
+                                     params[:q]
+                                   ])
       params = params.merge(q: query)
-      # This is faster than calling children.list and then files.get for each file.
+      # This is faster than calling children.list and then files.get for each
+      # file.
       @session.files(params, &block)
     end
   end
-  
+
   Folder = Collection
 end

data/lib/google_drive/config.rb

@@ -6,7 +6,7 @@ require 'json'
 module GoogleDrive
   # @api private
   class Config
-    FIELDS = %w(client_id client_secret scope refresh_token type).freeze
+    FIELDS = %w[client_id client_secret scope refresh_token type].freeze
     attr_accessor(*FIELDS)
 
     def initialize(config_path)
@@ -19,7 +19,7 @@ module GoogleDrive
     end
 
     def save
-      ::File.open(@config_path, 'w', 0600) { |f| f.write(to_json) }
+      ::File.open(@config_path, 'w', 0o600) { |f| f.write(to_json) }
     end
 
     private

data/lib/google_drive/file.rb

@@ -9,12 +9,14 @@ 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 a Google Docs
+  # document/spreadsheet/presentation and a folder.
   #
   # 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:
+  # 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.,
@@ -36,18 +38,21 @@ module GoogleDrive
 
     # Reloads file metadata such as title and acl.
     def reload_metadata
-      @api_file = @session.drive.get_file(id, fields: '*', supports_team_drives: true)
+      @api_file = @session.drive.get_file(
+        id, fields: '*', supports_team_drives: true
+      )
       @acl = Acl.new(@session, self) if @acl
     end
 
     # Returns resource_type + ":" + id.
     def resource_id
-      '%s:%s' % [resource_type, id]
+      format('%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)
+      'https://docs.google.com/feeds/default/private/full/' +
+        CGI.escape(resource_id)
     end
 
     # Deprecated ACL feed URL of the file.
@@ -65,7 +70,7 @@ module GoogleDrive
       reload_metadata if params[:reload]
       api_file.name
     end
-    
+
     alias name title
 
     # URL to view/edit the file in a Web browser.
@@ -75,11 +80,11 @@ module GoogleDrive
       api_file.web_view_link
     end
 
-    # Content types you can specify in methods download_to_file, download_to_string,
-    # download_to_io .
+    # 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.
+    # 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.web_content_link ? [api_file.mime_type] : []
     end
@@ -90,8 +95,9 @@ module GoogleDrive
     # 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, supports_team_drives: true}.merge(params))
+        id,
+        { download_dest: path, supports_team_drives: true }.merge(params)
+      )
     end
 
     # Downloads the file and returns as a String.
@@ -108,8 +114,9 @@ module GoogleDrive
     # 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, supports_team_drives: true}.merge(params))
+        id,
+        { download_dest: io, supports_team_drives: true }.merge(params)
+      )
     end
 
     # Export the file to +path+ in content type +format+.
@@ -119,15 +126,15 @@ module GoogleDrive
     #   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.
+    # 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)
+          raise(ArgumentError,
+                format("Cannot guess format from the file name: %s\n" \
+                 'Specify format argument explicitly.', path))
         end
       end
       export_to_dest(path, format)
@@ -138,7 +145,8 @@ module GoogleDrive
     # e.g.,
     #   spreadsheet.export_as_string("text/csv")
     #
-    # If you want to download the file in the original format, use download_to_string instead.
+    # 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)
@@ -147,7 +155,8 @@ module GoogleDrive
 
     # 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.
+    # 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
@@ -165,7 +174,8 @@ module GoogleDrive
     # 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.
+      # 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
@@ -196,7 +206,7 @@ module GoogleDrive
       nil
     end
 
-    alias_method :title=, :rename
+    alias title= rename
 
     # Creates copy of this file with the given title.
     def copy(title)
@@ -204,7 +214,7 @@ module GoogleDrive
       @session.wrap_api_file(api_file)
     end
 
-    alias_method :duplicate, :copy
+    alias duplicate copy
 
     # Returns GoogleDrive::Acl object for the file.
     #
@@ -236,7 +246,7 @@ module GoogleDrive
     end
 
     def inspect
-      "\#<%p id=%p title=%p>" % [self.class, id, title]
+      format("\#<%p id=%p title=%p>", self.class, id, title)
     end
 
     private