Class: Fastlane::Actions::CreateGoogleDriveFolderAction

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

Class Method Summary collapse

Class Method Details

.authors ⇒ Object 



124
125
126
 
# File 'lib/fastlane/plugin/google_drive/actions/create_google_drive_folder_action.rb', line 124

def self.authors
  ['Bumsoo Kim (@bskim45)', 'Kohki Miki (@giginet)']
end

.available_options ⇒ Object 



52
53
54
55
56
57
58
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
 
# File 'lib/fastlane/plugin/google_drive/actions/create_google_drive_folder_action.rb', line 52

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: :folder_id,
      env_name: "GDRIVE_UPLOAD_FOLDER_ID",
      description: "Upload target folder id",
      optional: false,
      type: String,
      verify_block: proc do |value|
        UI.user_error!("No target `folder_id` was provided. Pass it using `folder_id: 'some_id'`") unless value and !value.empty?
      end
    ),
    FastlaneCore::ConfigItem.new(
      key: :folder_title,
      env_name: "GDRIVE_FOLDER_NAME",
      description: "Folder title of new one",
      optional: false,
      type: String,
      verify_block: proc do |value|
        UI.user_error!("No folder title given") if value.nil? || value.empty?
      end
    )
  ]
end

.description ⇒ Object 



41
42
43
 
# File 'lib/fastlane/plugin/google_drive/actions/create_google_drive_folder_action.rb', line 41

def self.description
  'Create new folder on Google Drive'
end

.details ⇒ Object 



45
46
47
48
49
50
 
# File 'lib/fastlane/plugin/google_drive/actions/create_google_drive_folder_action.rb', line 45

def self.details
  [
    'Create new folder on Google Drive',
    '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) 


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

def self.is_supported?(platform)
  true
end

.output ⇒ Object 



113
114
115
116
117
118
 
# File 'lib/fastlane/plugin/google_drive/actions/create_google_drive_folder_action.rb', line 113

def self.output
  [
    ['GDRIVE_CREATED_FOLDER_ID', 'ID of the created folder'],
    ['GDRIVE_CREATED_FOLDER_URL', 'Link to the created folder']
  ]
end

.return_value ⇒ Object 



120
121
122
 
# File 'lib/fastlane/plugin/google_drive/actions/create_google_drive_folder_action.rb', line 120

def self.return_value
  '`GoogleDrive::Collection` object which indicates the created folder.'
end

.run(params) ⇒ Object 



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
 
# File 'lib/fastlane/plugin/google_drive/actions/create_google_drive_folder_action.rb', line 12

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]
  )

  folder = Helper::GoogleDriveHelper.file_by_id(
    session: session, fid: params[:folder_id]
  )

  title = params[:folder_title]
  UI.message('------------------')
  UI.important("Creating #{title}")
  new_folder = Helper::GoogleDriveHelper.create_subcollection(root_folder: folder, title: title)
  UI.success('Success')
  UI.message('------------------')

  folder_id = new_folder.resource_id.split(':').last
  Actions.lane_context[SharedValues::GDRIVE_CREATED_FOLDER_ID] = folder_id
  Actions.lane_context[SharedValues::GDRIVE_CREATED_FOLDER_URL] = new_folder.human_url

  new_folder
end