Class: Fastlane::Actions::S3UploadAction

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

Class Method Summary collapse

Class Method Details

.authors ⇒ Object 



32
33
34
 
# File 'lib/fastlane/plugin/s3_actions/actions/s3_upload_action.rb', line 32

def self.authors
  ["Fernando Saragoca"]
end

.available_options ⇒ Object 



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
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
 
# File 'lib/fastlane/plugin/s3_actions/actions/s3_upload_action.rb', line 36

def self.available_options
  [
    FastlaneCore::ConfigItem.new(key: :access_key_id,
                            env_name: "S3_ACTIONS_ACCESS_KEY_ID",
                         description: "AWS Access Key",
                            optional: false,
                                type: String),
    FastlaneCore::ConfigItem.new(key: :secret_access_key,
                            env_name: "S3_ACTIONS_SECRET_ACCESS_KEY",
                         description: "AWS Secret Access Key",
                            optional: false,
                                type: String),
    FastlaneCore::ConfigItem.new(key: :bucket,
                            env_name: "S3_ACTIONS_BUCKET",
                         description: "S3 Bucket",
                            optional: false,
                                type: String),
    FastlaneCore::ConfigItem.new(key: :access_control,
                            env_name: "S3_ACTIONS_UPLOAD_ACCESS_CONTROL",
                         description: "File ACL: :public_read or :private",
                            optional: false,
                       default_value: :private,
                                type: String),
    FastlaneCore::ConfigItem.new(key: :content_path,
                            env_name: "S3_ACTIONS_UPLOAD_CONTENT_PATH",
                         description: "Path for file to upload",
                            optional: false,
                                type: String,
                        verify_block: proc do |value|
                                        if value.nil? || value.empty?
                                          UI.user_error!("No content path for S3_upload action given, pass using `content_path: 'path/to/file.txt'`")
                                        elsif File.file?(value) == false
                                          UI.user_error!("File for path '#{value}' not found")
                                        end
                                      end),
    FastlaneCore::ConfigItem.new(key: :name,
                            env_name: "S3_ACTIONS_FILE_NAME",
                         description: "File name",
                            optional: true,
                                type: String)
  ]
end

.description ⇒ Object 



28
29
30
 
# File 'lib/fastlane/plugin/s3_actions/actions/s3_upload_action.rb', line 28

def self.description
  "Upload a file to AWS S3"
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


79
80
81
 
# File 'lib/fastlane/plugin/s3_actions/actions/s3_upload_action.rb', line 79

def self.is_supported?(platform)
  true
end

.run(params) ⇒ Object 



6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
 
# File 'lib/fastlane/plugin/s3_actions/actions/s3_upload_action.rb', line 6

def self.run(params)
  Actions.verify_gem!('s3')

  service = S3::Service.new(access_key_id: params[:access_key_id],
                        secret_access_key: params[:secret_access_key])

  bucket_name = params[:bucket]
  bucket = service.buckets.find(bucket_name)
  if bucket.nil?
    UI.user_error! "Bucket '#{bucket_name}' not found, please verify bucket and credentials 🚫"
  end

  file_name = params[:name] || File.basename(params[:content_path])

  object = bucket.objects.build(file_name)
  object.content = open(params[:content_path])
  object.acl = params[:access_control]

  UI.important("Uploading file to '#{bucket_name}/#{file_name}' 📤")
  object.save
end