Class: Fastlane::Actions::FindGoogleDriveFileByTitleAction

Inherits:
Action
  • Object
show all
Defined in:
lib/fastlane/plugin/google_drive/actions/find_google_drive_file_by_title_action.rb

Class Method Summary collapse

Class Method Details

.authors ⇒ Object 



132
133
134
 
# File 'lib/fastlane/plugin/google_drive/actions/find_google_drive_file_by_title_action.rb', line 132

def self.authors
  ['Bumsoo Kim (@bskim45)']
end

.available_options ⇒ Object 



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/fastlane/plugin/google_drive/actions/find_google_drive_file_by_title_action.rb', line 59

def self.available_options
  [
    FastlaneCore::ConfigItem.new(
      key: :drive_keyfile,
      env_names: ['GDRIVE_KEY_FILE', 'GOOGLE_APPLICATION_CREDENTIALS'],
      description: 'Path to the JSON keyfile',
      conflicting_options: [:drive_key_json],
      type: String,
      optional: true,
      verify_block: proc do |value|
        UI.user_error!("Couldn't find config keyfile at path '#{value}'") unless File.exist?(value)
        UI.user_error!("'#{value}' doesn't seem to be a valid JSON keyfile") unless FastlaneCore::Helper.json_file?(value)
      end
    ),
    FastlaneCore::ConfigItem.new(
      key: :drive_key_json,
      env_name: 'GDRIVE_KEY_JSON',
      description: 'Credential key in stringified JSON format',
      optional: true,
      conflicting_options: [:drive_keyfile],
      type: String,
      sensitive: true,
      verify_block: proc do |value|
        begin
          JSON.parse(value)
        rescue JSON::ParserError
          UI.user_error!("Provided credential key is not a valid JSON")
        end
      end
    ),
    FastlaneCore::ConfigItem.new(
      key: :service_account,
      env_name: 'GDRIVE_SERVICE_ACCOUNT',
      description: 'true if the credential is for a service account, false otherwise',
      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

.description ⇒ Object 



48
49
50
 
# File 'lib/fastlane/plugin/google_drive/actions/find_google_drive_file_by_title_action.rb', line 48

def self.description
  'Find a Google Drive file or folder by title'
end

.details ⇒ Object 



52
53
54
55
56
57
 
# File 'lib/fastlane/plugin/google_drive/actions/find_google_drive_file_by_title_action.rb', line 52

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

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


136
137
138
 
# File 'lib/fastlane/plugin/google_drive/actions/find_google_drive_file_by_title_action.rb', line 136

def self.is_supported?(platform)
  true
end

.output ⇒ Object 



120
121
122
123
124
125
126
 
# File 'lib/fastlane/plugin/google_drive/actions/find_google_drive_file_by_title_action.rb', line 120

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

.return_value ⇒ Object 



128
129
130
 
# File 'lib/fastlane/plugin/google_drive/actions/find_google_drive_file_by_title_action.rb', line 128

def self.return_value
  # nothing
end

.run(params) ⇒ Object 



10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/fastlane/plugin/google_drive/actions/find_google_drive_file_by_title_action.rb', line 10

def self.run(params)
  unless params[:drive_keyfile].nil?
    UI.message("Using credential file: #{params[:drive_keyfile]}")
  end

  session = Helper::GoogleDriveHelper.setup(
    keyfile: params[:drive_keyfile],
    key_json: params[:drive_key_json],
    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