Class: Fastlane::Actions::MailgunAction

Inherits:
Fastlane::Action show all
Defined in:
lib/fastlane/actions/mailgun.rb

Class Method Summary collapse

Methods inherited from Fastlane::Action

action_name, authors, details, output, return_value, sh, step_text

Class Method Details

.author ⇒ Object 



77
78
79
 
# File 'lib/fastlane/actions/mailgun.rb', line 77

def self.author
  "thiagolioy"
end

.available_options ⇒ Object 



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
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
 
# File 'lib/fastlane/actions/mailgun.rb', line 21

def self.available_options
  [
    # This is here just for while due to the transition, not needed anymore
    FastlaneCore::ConfigItem.new(key: :mailgun_sandbox_domain,
                                 env_name: "MAILGUN_SANDBOX_POSTMASTER",
                                 optional: true,
                                 description: "Mailgun sandbox domain postmaster for your mail. Please use postmaster instead"),
    # This is here just for while due to the transition, should use postmaster instead
    FastlaneCore::ConfigItem.new(key: :mailgun_sandbox_postmaster,
                                 env_name: "MAILGUN_SANDBOX_POSTMASTER",
                                 optional: true,
                                 description: "Mailgun sandbox domain postmaster for your mail. Please use postmaster instead"),
    # This is here just for while due to the transition, should use apikey instead
    FastlaneCore::ConfigItem.new(key: :mailgun_apikey,
                                 env_name: "MAILGUN_APIKEY",
                                 optional: true,
                                 description: "Mailgun apikey for your mail. Please use postmaster instead"),

    FastlaneCore::ConfigItem.new(key: :postmaster,
                                 env_name: "MAILGUN_SANDBOX_POSTMASTER",
                                 description: "Mailgun sandbox domain postmaster for your mail"),
    FastlaneCore::ConfigItem.new(key: :apikey,
                                 env_name: "MAILGUN_APIKEY",
                                 description: "Mailgun apikey for your mail"),
    FastlaneCore::ConfigItem.new(key: :to,
                                 env_name: "MAILGUN_TO",
                                 description: "Destination of your mail"),
    FastlaneCore::ConfigItem.new(key: :message,
                                 env_name: "MAILGUN_MESSAGE",
                                 description: "Message of your mail"),
    FastlaneCore::ConfigItem.new(key: :subject,
                                 env_name: "MAILGUN_SUBJECT",
                                 description: "Subject of your mail",
                                 optional: true,
                                 is_string: true,
                                 default_value: "fastlane build"),
    FastlaneCore::ConfigItem.new(key: :success,
                                env_name: "MAILGUN_SUCCESS",
                                description: "Was this build successful? (true/false)",
                                optional: true,
                                default_value: true,
                                is_string: false),
    FastlaneCore::ConfigItem.new(key: :app_link,
                                env_name: "MAILGUN_APP_LINK",
                                description: "App Release link",
                                optional: false,
                                is_string: true),
    FastlaneCore::ConfigItem.new(key: :ci_build_link,
                                env_name: "MAILGUN_CI_BUILD_LINK",
                                description: "CI Build Link",
                                optional: true,
                                is_string: true)

  ]
end

.description ⇒ Object 



17
18
19
 
# File 'lib/fastlane/actions/mailgun.rb', line 17

def self.description
  "Send a success/error message to an email group"
end

.handle_params_transition(options) ⇒ Object 



81
82
83
84
85
86
87
 
# File 'lib/fastlane/actions/mailgun.rb', line 81

def self.handle_params_transition(options)
  options[:postmaster] = options[:mailgun_sandbox_postmaster] if options[:mailgun_sandbox_postmaster]
  puts "\nUsing :mailgun_sandbox_postmaster is deprecated, please change to :postmaster".yellow if options[:mailgun_sandbox_postmaster]

  options[:apikey] = options[:mailgun_apikey] if options[:mailgun_apikey]
  puts "\nUsing :mailgun_apikey is deprecated, please change to :apikey".yellow if options[:mailgun_apikey]
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


7
8
9
 
# File 'lib/fastlane/actions/mailgun.rb', line 7

def self.is_supported?(platform)
  true
end

.mail_teplate(options) ⇒ Object 



99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/fastlane/actions/mailgun.rb', line 99

def self.mail_teplate(options)
  hash = {
    author: Actions.git_author_email,
    last_commit: Actions.last_git_commit_message,
    message: options[:message],
    app_link: options[:app_link]
  }
  hash[:success] = options[:success]
  hash[:ci_build_link] = options[:ci_build_link]
  Fastlane::ErbTemplateHelper.render(
    Fastlane::ErbTemplateHelper.load("mailgun_html_template"),
    hash
  )
end

.mailgunit(options) ⇒ Object 



89
90
91
92
93
94
95
96
97
 
# File 'lib/fastlane/actions/mailgun.rb', line 89

def self.mailgunit(options)
  sandbox_domain = options[:postmaster].split("@").last
  RestClient.post "https://api:#{options[:apikey]}@api.mailgun.net/v3/#{sandbox_domain}/messages",
                  from: "Mailgun Sandbox<#{options[:postmaster]}>",
                  to: "#{options[:to]}",
                  subject: options[:subject],
                  html: mail_teplate(options)
  mail_teplate(options)
end

.run(options) ⇒ Object 



11
12
13
14
15
 
# File 'lib/fastlane/actions/mailgun.rb', line 11

def self.run(options)
  Actions.verify_gem!('rest-client')
  handle_params_transition(options)
  mailgunit(options)
end