fastlane-plugin-google_drive 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6de403d0e5f2266e62059e359322a6babbb1d88905e3708130bae977d7078167
-  data.tar.gz: 4e94204d3832150ed389197b2fa3316c3cc2c44bc29ad5a9ca67fdb599831d64
+  metadata.gz: 538f68214b71146ef64f4a99e01bc75ccc2fd8b146837d966aa354bf932b4c9a
+  data.tar.gz: a93cc09b8149798b1cc0f8f5457aec6add54b3cb408f523c426d13cc1e26838f
 SHA512:
-  metadata.gz: 00f9a29bca7b319178aae13706bde63808e25fca4613fa5d626067966f5721bb2b39045bd4103c55bb57aa088b1dec88dc731a280268ad12f9ea8c0fe72dc4ef
-  data.tar.gz: 357df4c4b4bfdc0bd07c5fafa588533d98e5c11f02ae193d10e800de0330f58623d5fcab1f48326a019011eb0b91fa01e57e5f62faa4fc4031e027e1c56bf36e
+  metadata.gz: 902b3d02aabd9ef980767370367d906405acf6ceadfd01fc75035624810dce42434746e0a339e63e32257acf0d43521c0c55f709562b09d857fb5e91c01b5b51
+  data.tar.gz: 0162a8cc7f27baf481d49c0beaad418a518b9d02b7213ce8774b41756c6aad1d84912cb2d1615eed9f1212e6ee01d3c41dfa60fe922c5fdfe783f4c8be6a5c2d

data/README.md

@@ -50,6 +50,23 @@ update_google_drive_file(
 )
 ```
 
+Find the existing file or folder:
+
+```ruby
+# find the file or folder by ID
+find_google_drive_file_by_id(
+  drive_keyfile: 'drive_key.json',
+  file_id: 'file_or_folder_id'
+)
+
+# find the file or folder by title
+find_google_drive_file_by_title(
+  drive_keyfile: 'drive_key.json',
+  parent_folder_id: 'parent_folder_id',
+  file_title: 'file_or_folder_title'
+)
+```
+
 Download feature is not implemented yet. PR is always welcome.
 
 ## Example

data/lib/fastlane/plugin/google_drive/actions/create_google_drive_folder_action.rb

@@ -9,7 +9,7 @@ module Fastlane
     end
     class CreateGoogleDriveFolderAction < Action
       def self.run(params)
-        UI.message("Using config file: #{params[:drive_keyfile]}")
+        UI.message("Using credential file: #{params[:drive_keyfile]}")
 
         session = Helper::GoogleDriveHelper.setup(
           keyfile: params[:drive_keyfile],

data/lib/fastlane/plugin/google_drive/actions/find_google_drive_file_by_id_action.rb

@@ -0,0 +1,106 @@
+require 'fastlane/action'
+require_relative '../helper/google_drive_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      GDRIVE_FILE_ID = :GDRIVE_FILE_ID
+      GDRIVE_FILE_TITLE = :GDRIVE_FILE_TITLE
+      GDRIVE_FILE_URL = :GDRIVE_FILE_URL
+    end
+
+    class FindGoogleDriveFileByIdAction < Action
+      def self.run(params)
+        UI.message("Using credential file: #{params[:drive_keyfile]}")
+
+        session = Helper::GoogleDriveHelper.setup(
+          keyfile: params[:drive_keyfile],
+          service_account: params[:service_account]
+        )
+
+        # parameter validation
+        target_file_id = params[:file_id]
+
+        begin
+          file = Helper::GoogleDriveHelper.file_by_id(
+            session: session, fid: target_file_id
+          )
+        rescue FastlaneCore::Interface::FastlaneError
+          file = nil
+        end
+
+        if file.nil?
+          UI.error("No file or folder was found.")
+        else
+          Actions.lane_context[SharedValues::GDRIVE_FILE_ID] = file.resource_id.split(':').last
+          Actions.lane_context[SharedValues::GDRIVE_FILE_TITLE] = file.title
+          Actions.lane_context[SharedValues::GDRIVE_FILE_URL] = file.human_url
+        end
+      end
+
+      def self.description
+        'Find a Google Drive file or folder by ID'
+      end
+
+      def self.details
+        [
+          'Find a Google Drive file or folder by ID',
+          'See https://github.com/gimite/google-drive-ruby/blob/master/doc/authorization.md to get a keyfile'
+        ].join("\n")
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :drive_keyfile,
+            env_name: 'GDRIVE_KEY_FILE',
+            description: 'The path to the json keyfile',
+            type: String,
+            default_value: 'drive_key.json',
+            verify_block: proc do |value|
+              UI.user_error!("Couldn't find config keyfile at path '#{value}'") unless File.exist?(value)
+            end
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :service_account,
+            env_name: 'GDRIVE_SERVICE_ACCOUNT',
+            description: 'Whether the credential file is for the google service account',
+            optional: true,
+            is_string: false,
+            default_value: false
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :file_id,
+            env_name: 'GDRIVE_TARGET_FILE_ID',
+            description: 'Target file or folder ID to check the existence',
+            optional: false,
+            type: String,
+            verify_block: proc do |value|
+              UI.user_error!("No `file_id` was given. Pass it using `file_id: 'some_id'`") if value.nil? || value.empty?
+            end
+          )
+        ]
+      end
+
+      def self.output
+        [
+          ['GDRIVE_FILE_ID', 'The file ID of the file or folder.'],
+          ['GDRIVE_FILE_TITLE', 'The title of the file or folder.'],
+          ['GDRIVE_FILE_URL', 'The link to the file or folder.']
+        ]
+      end
+
+      def self.return_value
+        # nothing
+      end
+
+      def self.authors
+        ['Bumsoo Kim (@bskim45)']
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/google_drive/actions/find_google_drive_file_by_title_action.rb

@@ -0,0 +1,120 @@
+require 'fastlane/action'
+require_relative '../helper/google_drive_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+    end
+
+    class FindGoogleDriveFileByTitleAction < Action
+      def self.run(params)
+        UI.message("Using credential file: #{params[:drive_keyfile]}")
+
+        session = Helper::GoogleDriveHelper.setup(
+          keyfile: params[:drive_keyfile],
+          service_account: params[:service_account]
+        )
+
+        # parameter validation
+        parent_folder_id = params[:parent_folder_id]
+        file_title = params[:file_title]
+
+        parent_folder = Helper::GoogleDriveHelper.file_by_id(
+          session: session, fid: parent_folder_id
+        )
+
+        UI.abort_with_message!('The parent folder was not found.') if parent_folder.nil?
+
+        begin
+          file = Helper::GoogleDriveHelper.file_by_title(
+            root_folder: parent_folder, title: file_title
+          )
+        rescue FastlaneCore::Interface::FastlaneError
+          file = nil
+        end
+
+        if file.nil?
+          UI.error('No file or folder was found.')
+        else
+          Actions.lane_context[SharedValues::GDRIVE_FILE_ID] = file.resource_id.split(':').last
+          Actions.lane_context[SharedValues::GDRIVE_FILE_TITLE] = file.title
+          Actions.lane_context[SharedValues::GDRIVE_FILE_URL] = file.human_url
+        end
+      end
+
+      def self.description
+        'Find a Google Drive file or folder by title'
+      end
+
+      def self.details
+        [
+          'Find a Google Drive file or folder by title',
+          'See https://github.com/gimite/google-drive-ruby/blob/master/doc/authorization.md to get a keyfile'
+        ].join("\n")
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :drive_keyfile,
+            env_name: 'GDRIVE_KEY_FILE',
+            description: 'The path to the json keyfile',
+            type: String,
+            default_value: 'drive_key.json',
+            verify_block: proc do |value|
+              UI.user_error!("Couldn't find config keyfile at path '#{value}'") unless File.exist?(value)
+            end
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :service_account,
+            env_name: 'GDRIVE_SERVICE_ACCOUNT',
+            description: 'Whether the credential file is for the google service account',
+            optional: true,
+            is_string: false,
+            default_value: false
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :parent_folder_id,
+            env_name: 'GDRIVE_PARENT_FOLDER_ID',
+            description: 'The parent folder ID of the target file or folder to check the existence',
+            optional: false,
+            type: String,
+            verify_block: proc do |value|
+              UI.user_error!("No `parent_folder_id` was given. Pass it using `parent_folder_id: 'some_id'`") unless value and !value.empty?
+            end
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :file_title,
+            env_name: 'GDRIVE_TARGET_FILE_TITLE',
+            description: 'Target file or folder title to check the existence',
+            optional: false,
+            type: String,
+            verify_block: proc do |value|
+              UI.user_error!("No `file_title` was given. Pass it using `file_title: 'some_title'`") unless value and !value.empty?
+            end
+          ),
+        ]
+      end
+
+      def self.output
+        [
+          ['GDRIVE_FILE_ID', 'The file title of the file or folder'],
+          ['GDRIVE_FILE_TITLE', 'The title of the file or folder'],
+          ['GDRIVE_FILE_URL', 'The link to the file or folder']
+        ]
+      end
+
+      def self.return_value
+        # nothing
+      end
+
+      def self.authors
+        ['Bumsoo Kim (@bskim45)']
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/google_drive/actions/update_google_drive_file_action.rb

@@ -9,7 +9,7 @@ module Fastlane
     end
     class UpdateGoogleDriveFileAction < Action
       def self.run(params)
-        UI.message("Using config file: #{params[:drive_keyfile]}")
+        UI.message("Using credential file: #{params[:drive_keyfile]}")
 
         session = Helper::GoogleDriveHelper.setup(
           keyfile: params[:drive_keyfile],

data/lib/fastlane/plugin/google_drive/actions/upload_to_google_drive_action.rb

@@ -9,7 +9,7 @@ module Fastlane
     end
     class UploadToGoogleDriveAction < Action
       def self.run(params)
-        UI.message("Using config file: #{params[:drive_keyfile]}")
+        UI.message("Using credential file: #{params[:drive_keyfile]}")
 
         session = Helper::GoogleDriveHelper.setup(
           keyfile: params[:drive_keyfile],

data/lib/fastlane/plugin/google_drive/helper/google_drive_helper.rb

@@ -24,6 +24,14 @@ module Fastlane
         UI.user_error!("File with id '#{fid}' not found in Google Drive")
       end
 
+      def self.file_by_title(root_folder:, title:)
+        file = root_folder.file_by_title(title)
+        file
+      rescue Exception => e
+        UI.error(e.message)
+        UI.user_error!("File with title '#{title}' not found in Google Drive")
+      end
+
       def self.upload_file(file: nil, file_name: nil, title: nil)
         raise "Not Google Drive file" unless file.kind_of?(::GoogleDrive::File)
 

data/lib/fastlane/plugin/google_drive/version.rb

@@ -1,5 +1,5 @@
 module Fastlane
   module GoogleDrive
-    VERSION = "0.8.0"
+    VERSION = "0.9.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-google_drive
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Bumsoo Kim
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-17 00:00:00.000000000 Z
+date: 2022-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google_drive2
@@ -220,6 +220,8 @@ files:
 - README.md
 - lib/fastlane/plugin/google_drive.rb
 - lib/fastlane/plugin/google_drive/actions/create_google_drive_folder_action.rb
+- lib/fastlane/plugin/google_drive/actions/find_google_drive_file_by_id_action.rb
+- lib/fastlane/plugin/google_drive/actions/find_google_drive_file_by_title_action.rb
 - lib/fastlane/plugin/google_drive/actions/update_google_drive_file_action.rb
 - lib/fastlane/plugin/google_drive/actions/upload_to_google_drive_action.rb
 - lib/fastlane/plugin/google_drive/helper/google_drive_helper.rb