drive_v3 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 882a97d3563d0c5565e00ae57c230fbef5fcd94b233dfe4281cfbaaa81ed4bbe
-  data.tar.gz: 215a903e2c6f89652ae2da0e8a3ad55ad0294a170982206e9525f1c572fc8ab0
+  metadata.gz: eb569b1ffaa8be00b9f846624af85f93e8d09739fa9d0ea2c10c0a7854fd4952
+  data.tar.gz: 75a30ae59c88404277a8e0c904887d1f7799e1e62afdade7ba8268840c5b941b
 SHA512:
-  metadata.gz: 42a1dca40e3e0fcd85c679ffd90b906bd0ef0cc3e384b0aa5121999b5122dc174fd0c379bb3d2aafcabca14b5984246dde28a4cf53023e9de79ba423232f9916
-  data.tar.gz: 54a99a6bf6b9751914def5bece84593e1423045867a40e126d8c9bc749a79adcb2288d8f7f42a3d3ed46a90f0dfa96910047e255409a81551a452b4bfefaf005
+  metadata.gz: ecad9653b07257b4895e277d9f5558e71a68db4ae68c0fc193404b525695f137381263314c304e8231e70e86b355afbb9fb900c2072286a49948b37fb1929c42
+  data.tar.gz: 86113a5a2ce266cbbca8e9bc4005ee2c8c3e9c02d8dd2ab416edb580f1e7e935de25225a8b2e33059838b3f9ad74e9e7de0a7e0c921aa1c89992d9fd6d123b63

data/CHANGELOG.md

@@ -4,6 +4,15 @@ Changes for each release are listed in this file.
 
 This project adheres to [Semantic Versioning](https://semver.org/) for its releases.
 
+## v0.2.1 (2023-12-05)
+
+[Full Changelog](https://github.com/main-branch/drive_v3/compare/v0.2.0..v0.2.1)
+
+Changes since v0.2.0:
+
+* f1b82bd Update examples to include the supports_all_drives parameter (#6)
+* b26f1fa Release v0.2.0 (#5)
+
 ## v0.2.0 (2023-12-04)
 
 [Full Changelog](https://github.com/main-branch/drive_v3/compare/v0.1.0..v0.2.0)

data/examples/README.md

@@ -4,53 +4,52 @@ Annotated examples written in Ruby.
 
 Checked (✅︎) topics are completed. Topics without a check still need to be added.
 
-* [Getting started](#getting-started)
-  * [✅︎ Creating a Google API service account](#︎-creating-a-google-api-service-account)
-  * [✅︎ Creating a DriveService instance](#︎-creating-a-driveservice-instance)
-  * [✅︎ Batching DriveService requests](#︎-batching-driveservice-requests)
-* [Files and folders](#files-and-folders)
-  * [✅︎ Search for files](#︎-search-for-files)
-  * [✅︎ Get file](#︎-get-file)
-  * [✅︎ Create an empty data file](#︎-create-an-empty-data-file)
-  * [✅︎ Create a folder](#︎-create-a-folder)
-  * [✅︎ Create a spreadsheet, document, or presentation](#︎-create-a-spreadsheet-document-or-presentation)
-  * [✅︎ Upload file data](#︎-upload-file-data)
-  * [✅︎ Download file data](#︎-download-file-data)
-  * [✅︎ Export file](#︎-export-file)
-  * [✅︎ Send file to trash](#︎-send-file-to-trash)
-  * [✅︎ Recover file from trash](#︎-recover-file-from-trash)
-  * [✅︎ Delete a file](#︎-delete-a-file)
-* [Share files, folders, and drives](#share-files-folders-and-drives)
-  * [✅︎ Create permission](#︎-create-permission)
-  * [✅︎ List permissions](#︎-list-permissions)
-  * [✅︎ Update permission](#︎-update-permission)
-  * [✅︎ Delete permission](#︎-delete-permission)
-* [Shortcuts](#shortcuts)
-  * [Create a shortcut to a file](#create-a-shortcut-to-a-file)
-  * [Search for shortcuts](#search-for-shortcuts)
-* [Other](#other)
-  * [File revisions](#file-revisions)
-  * [Store application-specific data](#store-application-specific-data)
-  * [Manage file metadata](#manage-file-metadata)
-  * [Manage comments and replies](#manage-comments-and-replies)
-  * [Add custom file properties](#add-custom-file-properties)
-  * [Create a shortcut to a Drive file](#create-a-shortcut-to-a-drive-file)
-  * [Create a shortcut to app content](#create-a-shortcut-to-app-content)
-  * [Protect file content from modification](#protect-file-content-from-modification)
-  * [Access link-shared files using resource keys](#access-link-shared-files-using-resource-keys)
-* [Handle changes](#handle-changes)
-  * [Identify which change log to track](#identify-which-change-log-to-track)
-  * [Track changes for users and shared drives](#track-changes-for-users-and-shared-drives)
-  * [Retrieve changes](#retrieve-changes)
-  * [Receive notifications for resource changes](#receive-notifications-for-resource-changes)
-* [Manage labels](#manage-labels)
-  * [Manage labels](#manage-labels-1)
-  * [Set label field](#set-label-field)
-  * [Unset label field](#unset-label-field)
-  * [Remove label](#remove-label)
-  * [List labels from file](#list-labels-from-file)
-  * [Return specific labels from a file](#return-specific-labels-from-a-file)
-  * [Search by label or field](#search-by-label-or-field)
+* [Google Drive Examples](#google-drive-examples)
+  * [Getting started](#getting-started)
+    * [✅︎ Creating a Google API service account](#︎-creating-a-google-api-service-account)
+    * [✅︎ Creating a DriveService instance](#︎-creating-a-driveservice-instance)
+    * [✅︎ Batching DriveService requests](#︎-batching-driveservice-requests)
+  * [Files and folders](#files-and-folders)
+    * [✅︎ Search for files](#︎-search-for-files)
+    * [✅︎ Get file](#︎-get-file)
+    * [✅︎ Create a file](#︎-create-a-file)
+    * [✅︎ Upload file data](#︎-upload-file-data)
+    * [✅︎ Download file data](#︎-download-file-data)
+    * [✅︎ Export file](#︎-export-file)
+    * [✅︎ Send file to trash](#︎-send-file-to-trash)
+    * [✅︎ Recover file from trash](#︎-recover-file-from-trash)
+    * [✅︎ Delete a file](#︎-delete-a-file)
+  * [Share files, folders, and drives](#share-files-folders-and-drives)
+    * [✅︎ Create permission](#︎-create-permission)
+    * [✅︎ List permissions](#︎-list-permissions)
+    * [✅︎ Update permission](#︎-update-permission)
+    * [✅︎ Delete permission](#︎-delete-permission)
+  * [Shortcuts](#shortcuts)
+    * [Create a shortcut to a file](#create-a-shortcut-to-a-file)
+    * [Search for shortcuts](#search-for-shortcuts)
+  * [Other](#other)
+    * [File revisions](#file-revisions)
+    * [Store application-specific data](#store-application-specific-data)
+    * [Manage file metadata](#manage-file-metadata)
+    * [Manage comments and replies](#manage-comments-and-replies)
+    * [Add custom file properties](#add-custom-file-properties)
+    * [Create a shortcut to a Drive file](#create-a-shortcut-to-a-drive-file)
+    * [Create a shortcut to app content](#create-a-shortcut-to-app-content)
+    * [Protect file content from modification](#protect-file-content-from-modification)
+    * [Access link-shared files using resource keys](#access-link-shared-files-using-resource-keys)
+  * [Handle changes](#handle-changes)
+    * [Identify which change log to track](#identify-which-change-log-to-track)
+    * [Track changes for users and shared drives](#track-changes-for-users-and-shared-drives)
+    * [Retrieve changes](#retrieve-changes)
+    * [Receive notifications for resource changes](#receive-notifications-for-resource-changes)
+  * [Manage labels](#manage-labels)
+    * [Manage labels](#manage-labels-1)
+    * [Set label field](#set-label-field)
+    * [Unset label field](#unset-label-field)
+    * [Remove label](#remove-label)
+    * [List labels from file](#list-labels-from-file)
+    * [Return specific labels from a file](#return-specific-labels-from-a-file)
+    * [Search by label or field](#search-by-label-or-field)
 
 ## Getting started
 
@@ -109,42 +108,37 @@ shows how to get a
 [File](https://github.com/googleapis/google-api-ruby-client/blob/main/generated/google-apis-drive_v3/lib/google/apis/drive_v3/classes.rb)
 from the drive and controlling which fields are returned.
 
-### ✅︎ Create an empty data file
+### ✅︎ Create a file
 
-To create a file that contains no metadata or content, use the `drive_service.create_file`
-method with no parameters. The file is given a kind of drive.file, an id, a name of
-"Untitled," and a mimeType of application/octet-stream.
+Using the `drive_service.create_file` with no parameters creates an empty data file
+with the following attributes:
+* `kind` is set to "drive.file",
+* `id` is set to a unique id
+* `name` is set to "Untitled"
+* `mime_type` of application/octet-stream.
 
-Use the `:parents` parameter to give the id of the folder that should contain the
-file. Omitting this parameter or passing an empty array will place the new file
-in the user's `My Drive` root folder.
-
-[examples/file_create](https://github.com/main-branch/drive_v3/blob/main/examples/file_create)
-shows how to create an empty data file and write data to it.
-
-### ✅︎ Create a folder
+The `mime_type` parameter defines the type of file to create or to create a folder.
+See [Google Workspace & Google Drive supported MIME types](https://developers.google.com/drive/api/guides/mime-types)
+for a list of supported MIME types.
 
-[examples/file_create_folder](https://github.com/main-branch/drive_v3/blob/main/examples/file_create_folder)
-shows how to create a folder by setting the appropriate mime-type.
+Google Apps files (document, spreadsheet, or presentation) may be created by specifying
+their specific `mime-type`:
+* **Google Docs**: application/vnd.google-apps.document
+* **Google Sheets**: application/vnd.google-apps.spreadsheet
+* **Google Slides**: application/vnd.google-apps.presentation
+* See [Google Workspace & Google Drive supported MIME types](https://developers.google.com/drive/api/guides/mime-types)
+  for a complete list.
 
 See [Create and populate folders](https://developers.google.com/drive/api/guides/folder#create-folder)
-for more information.
-
-### ✅︎ Create a spreadsheet, document, or presentation
+for more about creating a folder. A folder is a file with a `mime_type` of
+"application/vnd.google-apps.folder".
 
-[examples/file_create_spreadsheet](https://github.com/main-branch/drive_v3/blob/main/examples/file_create_spreadsheet)
-shows how to create a blank spreadsheet by setting the appropriate mime-type.
-
-See [Create a spreadsheet](https://developers.google.com/sheets/api/guides/create#work_with_folders)
-for more information.
-
-Use the following mime-types for Google apps:
-* Spreadsheet: **application/vnd.google-apps.spreadsheet**
-* Document: **application/vnd.google-apps.document**
-* Presentation: **application/vnd.google-apps.presentation**
+Use the `:parents` parameter to give the id of the folder that should contain the
+file. Omitting this parameter or passing an empty array will place the new file
+in the user's `My Drive` root folder.
 
-See [Google Workspace & Google Drive supported MIME types](https://developers.google.com/drive/api/guides/mime-types)
-for a comprehensive list of MIME types supported by Google Drive.
+[examples/file_create](https://github.com/main-branch/drive_v3/blob/main/examples/file_create)
+shows how to create a file specifying name, mime-type, parent, and initial data.
 
 ### ✅︎ Upload file data
 

data/examples/drive_service_batch

@@ -51,6 +51,12 @@ permission = Google::Apis::DriveV3::Permission.new(
   role: 'writer'
 )
 
+# Indicate that this application supports files in shared drives. An error will
+# result if this is false (or omitted) AND you are trying to update the permissions
+# on a file in a shared drive.
+#
+supports_all_drives = true
+
 begin
   results = [].tap do |request_results|
     drive_service.batch do |service|
@@ -59,7 +65,7 @@ begin
         #
         # Collect the result (or error if there is one) in the block passed to
         # `create_permission`
-        service.create_permission(spreadsheet_id, permission) do |res, err|
+        service.create_permission(spreadsheet_id, permission, supports_all_drives:) do |res, err|
           request_results << (res || err.message)
         end
       end

data/examples/file_create

@@ -1,35 +1,143 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
+# Create a file or folder in a Google Drive
+
+require 'optparse'
+
+# Parse the command line
+#
+# @example Create a file in a Google Drive
+#   file-create \
+#     [NAME] \
+#     [--parent ID] \
+#     [--mime-type MIME_TYPE] \
+#     [--content FILE_NAME [--content-type MIME_TYPE]]
+#
+# @example Create a new empty file with default title and mimetype in the user's My Drive
+#   file-create
+#
+# @example Create a file name 'My Data File' in the user's My Drive
+#   file-create 'My Data File'
+#
+# @example Create a file in a specific folder
+#   file-create 'My Data File' --parent '1V6RS_7_YgJmLDH-BDw3dpD8Np60Oi9ET'
+#
+# @example Create a specific kind of file (data file)
+#   file-create 'My Data File' --mime-type 'text/plain'
+#
+# @example Create a specific kind of file (spreadsheet)
+#   file-create 'My Data File' --mime-type 'application/vnd.google-apps.spreadsheet'
+#
+# @example Create a specific kind of file (document)
+#   file-create 'My Data File' --mime-type 'application/vnd.google-apps.document'
+#
+# @example Create a folder
+#   file-create 'My New Folder' --mime-type 'application/vnd.google-apps.folder'
+#
+# @example Create a file and load it with data from a file
+#   file-create 'My Data File' --content 'data.csv' --content-type 'text/csv'
+#
+# @example For a anyone
+#   permission-create FILE_ID \
+#     --type anyone \
+#     --role ROLE \
+#     [--expiration TIME] \
+#     [{--allow-file-discovery | --no-allow-file-discovery}]
+#
+class ParseCommandLine
+  def initialize(argv)
+    @argv = argv.dup
+    default_options
+    parser.parse!(@argv)
+    @name = @argv.shift
+    validate(@argv)
+  end
+
+  attr_reader :name, :parent_id, :mime_type, :content, :content_type
+
+  def banner = <<~BANNER
+    Usage:
+
+      #{$PROGRAM_NAME} [NAME] [options]
+
+    Creates a file in a Google Drive and displays the JSON properties
+    of that file.
+
+    WARNING: Omitting NAME will create a file named 'Untitled'.
+
+    Options:
+  BANNER
+
+  def parser
+    @parser ||= OptionParser.new(banner) do |opts|
+      option_definitions.each { |option_definition| opts.on(*option_definition) }
+    end
+  end
+
+  def help
+    puts parser
+    exit
+  end
+
+  def option_definitions
+    [
+      help_definition,
+      parent_definition, mime_type_definition,
+      content_definition, content_type_definition
+    ].freeze
+  end
+
+  def help_definition = ['-h', '--help', '', ->(_value) { help }]
+  def parent_definition = ['--parent=ID', ->(value) { @parent_id = value }]
+  def mime_type_definition = ['--mime-type=MIME_TYPE', ->(value) { @mime_type = value }]
+  def content_definition = ['--content=FILE_NAME', ->(value) { @content = value }]
+  def content_type_definition = ['--content_type=MIME_TYPE', ->(value) { @content_type = value }]
+
+  def default_options; end
+
+  def validate(argv)
+    raise "Extra command line arguments: #{argv}" unless argv.empty?
+  end
+end
+
 # Create a data file
 #
 # When creating a data file, upload_source should be an IO object that
 # responds to `read` and `size` (e.g. StringIO) or a string that names
 # an existing file to upload.
 
+options = ParseCommandLine.new(ARGV)
+
 require 'drive_v3'
 require 'json'
 
 drive_service = DriveV3.drive_service
 
-# If name is not specified as part of a create request, the file name is named
-# 'Untitled'.
-name = 'My data file'
+# If name is not specified as part of a create request (or it is nil), the file name
+# is named 'Untitled'.
+name = options.name
 
 # If parents not specified as part of a create request or is an empty array, the
 # file is placed directly in the user's My Drive folder
 #
 # parents = ['id1', 'id2']
-parents = ['1V6RS_7_YgJmLDH-BDw3dpD8Np60Oi9ET']
+parents = []
+parents << options.parent_id if options.parent_id
 
 # The MIME type of the file. Drive will attempt to automatically detect an
 # appropriate value from uploaded content if no value is provided. The value
 # cannot be changed unless a new revision is uploaded.
 #
+# See
+# [Google Workspace & Google Drive supported MIME types](https://developers.google.com/drive/api/guides/mime-types)
+# for a list of supported MIME types.
+#
 # The default MIME type is 'text/plain'
 #
+#
 # mime_type = nil
-mime_type = 'application/vnd.google-apps.spreadsheet'
+mime_type = options.mime_type
 
 file_metadata = { name:, parents:, mime_type: }
 
@@ -47,7 +155,7 @@ fields = '*'
 # data file.
 #
 # upload_source = StringIO.new("This is my letter to the World\nThat never wrote to Me")
-upload_source = StringIO.new("1,2,3\n4,5,6\n7,8,9")
+upload_source = options.content
 
 # Content type indicates the MIME type of the upload_source. If not specified,
 # the content type will be determined by calling MIME::Types.of with the
@@ -56,10 +164,21 @@ upload_source = StringIO.new("1,2,3\n4,5,6\n7,8,9")
 # content_type = 'text/plain'
 # CSV content type
 # content_type = nil
-content_type = 'text/csv'
+content_type = options.content_type
+
+# Indicate that this application supports files in shared drives. An error will result if
+# this is false (or omitted) AND `create_file` tries to create a file in a shared drive.
+#
+supports_all_drives = true
 
 begin
-  file = drive_service.create_file(file_metadata, fields:, upload_source:, content_type:)
+  file = drive_service.create_file(
+    file_metadata,
+    fields:,
+    upload_source:,
+    content_type:,
+    supports_all_drives:
+  )
   puts JSON.pretty_generate(file.to_h)
 rescue StandardError => e
   puts "An error occurred: #{e.message}"

data/examples/file_delete

@@ -14,10 +14,15 @@ drive_service = DriveV3.drive_service
 file_id = ARGV[0] || ENV.fetch('FILE_ID', nil)
 raise 'Missing file_id' unless file_id
 
+# Indicate that this application supports files in shared drives. An error will result if
+# this is false (or omitted) AND `delete_file` tries to create a spreadsheet in a shared drive.
+#
+supports_all_drives = true
+
 begin
   print 'Delete file...'
   # Does not return anything
-  drive_service.delete_file(file_id)
+  drive_service.delete_file(file_id, supports_all_drives:)
   puts 'Success'
 rescue StandardError => e
   puts "An error occurred: #{e.message}"

data/examples/file_download_content

@@ -17,10 +17,15 @@ raise 'Missing file_id' unless file_id
 # to.
 download_dest = StringIO.new
 
+# Indicate that this application supports files in shared drives. An error will result if
+# this is false (or omitted) AND `get_file` tries to get a file from s shared drive.
+#
+supports_all_drives = true
+
 # Read content from file
 #
 begin
-  drive_service.get_file(file_id, download_dest:)
+  drive_service.get_file(file_id, download_dest:, supports_all_drives:)
   puts JSON.pretty_generate(download_dest.string)
 rescue StandardError => e
   puts "An error occurred: #{e.message}"

data/examples/file_export_spreadsheet

@@ -14,6 +14,15 @@ require 'json'
 
 drive_service = DriveV3.drive_service
 
+# Indicate that this application supports files in shared drives. An error will
+# result if this is false (or omitted) AND you try to do something with a file or
+# folder in a shared drive.
+#
+# Note that the `export_file` method does not require this parameter to export
+# a file from a shared drive.
+#
+supports_all_drives = true
+
 # First create a spreadsheet, populating with some data.
 # Then get the file id of the spreadsheet.
 
@@ -25,7 +34,13 @@ fields = 'id, name'
 upload_source = StringIO.new("1,2,3\n4,5,6\n7,8,9")
 content_type = 'text/csv'
 begin
-  file = drive_service.create_file(file_metadata, fields:, upload_source:, content_type:)
+  file = drive_service.create_file(
+    file_metadata,
+    fields:,
+    upload_source:,
+    content_type:,
+    supports_all_drives:
+  )
   puts JSON.pretty_generate(file.to_h)
 rescue StandardError => e
   puts "An error occurred: #{e.message}"
@@ -39,7 +54,12 @@ mime_type = 'application/pdf'
 download_dest = "#{file.name}.pdf"
 
 begin
-  drive_service.export_file(file_id, mime_type, download_dest:)
+  drive_service.export_file(
+    file_id,
+    mime_type,
+    download_dest:,
+    supports_all_drives:
+  )
 rescue StandardError => e
   puts "An error occurred: #{e.message}"
   exit 1

data/examples/file_recover_from_trash

@@ -14,10 +14,19 @@ drive_service = DriveV3.drive_service
 file_id = ARGV[0] || ENV.fetch('FILE_ID', nil)
 raise 'Missing file_id' unless file_id
 
+# Indicate that this application supports files in shared drives. An error will result if
+# this is false (or omitted) AND you are trying to update a file in a shared drive.
+#
+supports_all_drives = true
+
 begin
   print 'Recovering trashed file...'
   file_object = { trashed: false }
-  file = drive_service.update_file(file_id, file_object)
+  file = drive_service.update_file(
+    file_id,
+    file_object,
+    supports_all_drives:
+  )
   puts "update_file result:\n#{file.to_h.pretty_inspect}"
 rescue StandardError => e
   puts "An error occurred: #{e.message}"

data/examples/file_search

@@ -71,9 +71,17 @@ fields = '*'
 #
 include_items_from_all_drives = true
 
+# Indicate that this application supports files in shared drives. An error will result if
+# this is false (or omitted) AND `list_files` returns a file from a shared drive.
+#
+supports_all_drives = true
+
 loop do
   file_list = @drive_service.list_files(
-    q:, fields:, include_items_from_all_drives:,
+    q:,
+    fields:,
+    include_items_from_all_drives:,
+    supports_all_drives:,
     page_token:, page_size:
   )
   files += file_list.files.map(&:to_h)
@@ -84,3 +92,4 @@ end
 # Print as JSON with links to each file and its parents
 
 puts JSON.pretty_generate(files)
+# puts files.count

data/examples/file_send_to_trash

@@ -14,10 +14,15 @@ drive_service = DriveV3.drive_service
 file_id = ARGV[0] || ENV.fetch('FILE_ID', nil)
 raise 'Missing file_id' unless file_id
 
+# Indicate that this application supports files in shared drives. An error will result if
+# this is false (or omitted) AND you are trying to update a file in a shared drive.
+#
+supports_all_drives = true
+
 begin
   print 'Trash file...'
   file_object = { trashed: true }
-  file = drive_service.update_file(file_id, file_object)
+  file = drive_service.update_file(file_id, file_object, supports_all_drives:)
   puts "update_file result:\n#{file.to_h.pretty_inspect}"
 rescue StandardError => e
   puts "An error occurred: #{e.message}"

data/examples/file_upload_content

@@ -15,10 +15,15 @@ raise 'Missing file_id' unless file_id
 #
 upload_source = StringIO.new('This is the content that replaced the original content')
 
+# Indicate that this application supports files in shared drives. An error will result if
+# this is false (or omitted) AND you are trying to update a file in a shared drive.
+#
+supports_all_drives = true
+
 # Replace the content of an existing file
 #
 begin
-  file = drive_service.update_file(file_id, upload_source:)
+  file = drive_service.update_file(file_id, upload_source:, supports_all_drives:)
   puts JSON.pretty_generate(file.to_h)
 rescue StandardError => e
   puts "An error occurred: #{e.message}"

data/examples/permission_create

@@ -155,8 +155,19 @@ drive_service = DriveV3.drive_service
 options = PermissionCreateCli.new(ARGV)
 fields = '*'
 
+# Indicate that this application supports files in shared drives. An error will
+# result if this is false (or omitted) AND you are trying to update the permissions
+# on a file in a shared drive.
+#
+supports_all_drives = true
+
 begin
-  result = drive_service.create_permission(options.file_id, options.permission, fields:)
+  result = drive_service.create_permission(
+    options.file_id,
+    options.permission,
+    fields:,
+    supports_all_drives:
+  )
   # The result.id is 'anyoneWithLink' if type=anyone
   # The result.id is of the existing permission if it already exists
   puts JSON.pretty_generate(result.to_h)

data/examples/permission_delete

@@ -15,8 +15,14 @@ raise "Extra arguments: #{ARGV}" unless ARGV.empty?
 
 drive_service = DriveV3.drive_service
 
+# Indicate that this application supports files in shared drives. An error will
+# result if this is false (or omitted) AND you are trying to delete the permissions
+# on a file in a shared drive.
+#
+supports_all_drives = true
+
 begin
-  drive_service.delete_permission(file_id, permission_id)
+  drive_service.delete_permission(file_id, permission_id, supports_all_drives:)
 rescue StandardError => e
   puts "An error occurred: #{e.message}"
 end

data/examples/permission_list

@@ -39,8 +39,20 @@ page_token = nil
 # fields = 'nextPageToken, files(id, name, parents, web_view_link)'
 fields = '*'
 
+# Indicate that this application supports files in shared drives. An error will
+# result if this is false (or omitted) AND you are trying to list the permissions
+# on a file in a shared drive.
+#
+supports_all_drives = true
+
 loop do
-  permission_list = drive_service.list_permissions(file_id, fields:, page_token:, page_size:)
+  permission_list = drive_service.list_permissions(
+    file_id,
+    fields:,
+    page_token:,
+    page_size:,
+    supports_all_drives:
+  )
   permissions += permission_list.permissions.map(&:to_h)
   # Stop looping if there are no more pages
   break unless (page_token = permission_list.next_page_token)

data/examples/permission_update

@@ -126,8 +126,21 @@ permission = options.permission
 remove_expiration = options.remove_expiration
 fields = '*'
 
+# Indicate that this application supports files in shared drives. An error will
+# result if this is false (or omitted) AND you are trying to update permissions
+# on a file in a shared drive.
+#
+supports_all_drives = true
+
 begin
-  result = drive_service.update_permission(file_id, permission_id, permission, remove_expiration:, fields:)
+  result = drive_service.update_permission(
+    file_id,
+    permission_id,
+    permission,
+    remove_expiration:,
+    fields:,
+    supports_all_drives:
+  )
   puts "Permission updated: #{result.to_h.pretty_inspect}"
 rescue StandardError => e
   puts "An error occurred: #{e.message}"

data/lib/drive_v3/version.rb

@@ -2,5 +2,5 @@
 
 module DriveV3
   # The version of this gem
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: drive_v3
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - James Couball
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-05 00:00:00.000000000 Z
+date: 2023-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler-audit
@@ -259,8 +259,6 @@ files:
 - examples/README.md
 - examples/drive_service_batch
 - examples/file_create
-- examples/file_create_folder
-- examples/file_create_spreadsheet
 - examples/file_delete
 - examples/file_download_content
 - examples/file_export_spreadsheet
@@ -300,7 +298,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.14
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Unofficial helpers and extensions for the Google Drive V3 API

data/examples/file_create_folder

@@ -1,46 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-# Create a folder
-#
-# When creating a Google Drive folder, you create a file with a MIME type of
-# 'application/vnd.google-apps.folder' and a name. You can also specify the
-# folder's parent folder(s) and other metadata.
-
-require 'drive_v3'
-require 'json'
-
-drive_service = DriveV3.drive_service
-
-# If name is not specified as part of a create request, the file name is named
-# 'Untitled'.
-name = 'My New Folder'
-
-# If parents not specified as part of a create request or is an empty array, the
-# folder is placed directly in the user's My Drive folder
-#
-# parents = ['id1', 'id2']
-parents = []
-
-# The MIME type of the file. Drive will attempt to automatically detect an
-# appropriate value from uploaded content if no value is provided. The value
-# cannot be changed unless a new revision is uploaded.
-#
-# A folder MIME type is 'application/vnd.google-apps.folder'
-#
-mime_type = 'application/vnd.google-apps.folder'
-
-# If fields is not specified, the following default fields are returned:
-# id, name, kind, and mime_type. '*' can by used to return all fields.
-# See https://developers.google.com/drive/api/v3/reference/files#resource
-#
-fields = '*'
-
-file_metadata = { name:, parents:, mime_type: }
-
-begin
-  file = drive_service.create_file(file_metadata, fields:)
-  puts JSON.pretty_generate(file.to_h)
-rescue StandardError => e
-  puts "An error occurred: #{e.message}"
-end

data/examples/file_create_spreadsheet

@@ -1,70 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-# Create a Google Sheets spreadsheet in Google Drive
-#
-# When creating a spreadsheet, you create a file with a MIME type of
-# 'application/vnd.google-apps.spreadsheet' and a name. You can also specify the
-# spreadsheet's parent folder and other metadata.
-#
-# The file_create method allows loading an Excel spreadheet or a sheet of data
-# from CSV or TSV data. Specify the data to load using `upload_source` and
-# `content_type` parameters. If `upload_source` is not specified, the file will
-# be created as an empty spreadsheet.
-
-require 'drive_v3'
-require 'json'
-
-drive_service = DriveV3.drive_service
-
-# If name is not specified as part of a create request, the file name is named
-# 'Untitled'.
-name = 'My spreadsheet file'
-
-# If parents not specified as part of a create request or is an empty array, the
-# file is placed directly in the user's My Drive folder
-#
-# parents = ['id1', 'id2']
-parents = []
-
-# The MIME type of the file. Drive will attempt to automatically detect an
-# appropriate value from uploaded content if no value is provided. The value
-# cannot be changed unless a new revision is uploaded.
-#
-# The default MIME type is 'text/plain'
-#
-# mime_type = nil
-mime_type = 'application/vnd.google-apps.spreadsheet'
-
-file_metadata = { name:, parents:, mime_type: }
-
-# If fields is not specified, the following default fields are returned:
-# id, name, kind, and mime_type. '*' can by used to return all fields.
-# See https://developers.google.com/drive/api/v3/reference/files#resource
-#
-fields = '*'
-
-# When creating the data file, upload_source should be an IO object that
-# responds to `read` and `size` (e.g. StringIO) or a string that names
-# an existing file to upload.
-#
-# If upload_source is not specified, the file will be created as an empty
-# data file.
-#
-upload_source = StringIO.new("1,2,3\n4,5,6\n7,8,9")
-
-# Content type indicates the MIME type of `upload_source`. If not specified,
-# the content type will be determined by calling MIME::Types.of with the
-# upload_source's filename.
-#
-# content_type = 'text/plain'
-# CSV content type
-# content_type = nil
-content_type = 'text/csv'
-
-begin
-  file = drive_service.create_file(file_metadata, fields:, upload_source:, content_type:)
-  puts JSON.pretty_generate(file.to_h)
-rescue StandardError => e
-  puts "An error occurred: #{e.message}"
-end