Class: Fastlane::Actions::AppliveryAction

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

Class Method Summary collapse

Class Method Details

.authors ⇒ Object 



88
89
90
 
# File 'lib/fastlane/plugin/applivery/actions/applivery_action.rb', line 88

def self.authors
  ["Alejandro Jimenez", "Cesar Trigo"]
end

.available_options ⇒ Object 



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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/fastlane/plugin/applivery/actions/applivery_action.rb', line 92

def self.available_options
  [
    FastlaneCore::ConfigItem.new(key: :app_token,
      env_name: "APPLIVERY_APP_TOKEN",
      description: "Your application identifier",
      optional: false,
      type: String),

    FastlaneCore::ConfigItem.new(key: :name,
      env_name: "APPLIVERY_BUILD_NAME",
      description: "Your build name",
      optional: true,
      type: String),

    FastlaneCore::ConfigItem.new(key: :changelog,
      env_name: "APPLIVERY_BUILD_CHANGELOG",
      description: "Your build notes",
      default_value: "Uploaded automatically with fastlane plugin",
      optional: true,
      type: String),

    FastlaneCore::ConfigItem.new(key: :tags,
      env_name: "APPLIVERY_BUILD_TAGS",
      description: "Your build tags",
      optional: true,
      type: String),

    FastlaneCore::ConfigItem.new(key: :build_path,
      env_name: "APPLIVERY_BUILD_PATH",
      description: "Your build path",
      default_value: self.build_path,
      optional: true,
      type: String),

    FastlaneCore::ConfigItem.new(key: :notify_collaborators,
      env_name: "APPLIVERY_NOTIFY_COLLABORATORS",
      description: "Send an email to your App Collaborators",
      default_value: true,
      optional: true,
      is_string: false),

    FastlaneCore::ConfigItem.new(key: :notify_employees,
      env_name: "APPLIVERY_NOTIFY_EMPLOYEES",
      description: "Send an email to your App Employees",
      default_value: true,
      optional: true,
      is_string: false),

    FastlaneCore::ConfigItem.new(key: :notify_message,
      env_name: "APPLIVERY_NOTIFY_MESSAGE",
      description: "Notification message to be sent along with email notifications",
      default_value: "New version uploaded!",
      optional: true,
      type: String),
    
    FastlaneCore::ConfigItem.new(key: :filter,
      env_name: "APPLIVERY_FILTER",
      description: "List of groups that will be notified",
      optional: true,
      type: String),
  ]
end

.build_path ⇒ Object 



69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/fastlane/plugin/applivery/actions/applivery_action.rb', line 69

def self.build_path
  platform = Actions.lane_context[Actions::SharedValues::PLATFORM_NAME]
  ipa_path = Actions.lane_context[SharedValues::IPA_OUTPUT_PATH]
  aab_path = Actions.lane_context[Actions::SharedValues::GRADLE_AAB_OUTPUT_PATH]
  apk_path = Actions.lane_context[Actions::SharedValues::GRADLE_APK_OUTPUT_PATH]

  if platform == :ios
    return ipa_path
  elsif :android and !aab_path.nil?
    return aab_path
  else
    return apk_path
  end
end

.category ⇒ Object 



169
170
171
 
# File 'lib/fastlane/plugin/applivery/actions/applivery_action.rb', line 169

def self.category
  :beta
end

.description ⇒ Object 



84
85
86
 
# File 'lib/fastlane/plugin/applivery/actions/applivery_action.rb', line 84

def self.description
  "Upload new iOS or Android build to Applivery"
end

.example_code ⇒ Object 



173
174
175
176
177
 
# File 'lib/fastlane/plugin/applivery/actions/applivery_action.rb', line 173

def self.example_code
  [
    'applivery(app_token: "YOUR_APP_TOKEN")'
  ]
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


161
162
163
164
165
166
167
 
# File 'lib/fastlane/plugin/applivery/actions/applivery_action.rb', line 161

def self.is_supported?(platform)
  # Adjust this if your plugin only works for a particular platform (iOS vs. Android, for example)
  # See: https://github.com/fastlane/fastlane/blob/master/fastlane/docs/Platforms.md
  
  [:ios, :android].include?(platform)
  true
end

.output ⇒ Object 



155
156
157
158
159
 
# File 'lib/fastlane/plugin/applivery/actions/applivery_action.rb', line 155

def self.output
  [
    ['APPLIVERY_BUILD_ID', 'The id for the new build generated. You can open your build in https://dashboard.applivery.io/apps/apps/<YOUR_APP_SLUG>/builds?id=${APPLIVERY_BUILD_ID}']
  ]
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
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
 
# File 'lib/fastlane/plugin/applivery/actions/applivery_action.rb', line 12

def self.run(params)
  build_path = params[:build_path]
  build = Faraday::UploadIO.new(build_path, 'application/octet-stream') if build_path && File.exist?(build_path)

  conn = Faraday.new(url: 'https://api.applivery.io') do |faraday|
    faraday.request :multipart
    faraday.request :url_encoded
    # faraday.response :logger
    faraday.use FaradayMiddleware::ParseJson
    faraday.adapter :net_http
  end

  response = conn.post do |req|
    req.url '/v1/integrations/builds'
    req.headers['Content-Type'] = 'multipart/form-data'
    req.headers['Accept'] = 'application/json'
    req.headers['Authorization'] = "bearer #{params[:app_token]}"
    request_body = {
      changelog: params[:changelog],
      notifyCollaborators: params[:notify_collaborators],
      notifyEmployees: params[:notify_employees],
      notifyMessage: params[:notify_message],
      filter: params[:filter],
      build: build,
      deployer: {
        name: "fastlane",
        info: {
          buildNumber: Helper::AppliveryHelper.get_integration_number,
          branch: Helper::AppliveryHelper.git_branch,
          commit: Helper::AppliveryHelper.git_commit,
          commitMessage: Helper::AppliveryHelper.git_message,
          repositoryUrl: Helper::AppliveryHelper.add_git_remote,
          tag: Helper::AppliveryHelper.git_tag,
          triggerTimestamp: Time.now.getutc.to_i
        } 
      }
    }
    request_body[:versionName] = params[:name] if !params[:name].nil?
    request_body[:tags] = params[:tags] if !params[:tags].nil?

    req.body = request_body
    UI.message "Uploading to Applivery... 🛫"
    UI.verbose("Request Body: #{req.body}")
  end
  UI.verbose "Response Body: #{response.body}"
  status = response.body["status"]
  if status
    UI.success "Build uploaded succesfully! 💪"
    Actions.lane_context[SharedValues::APPLIVERY_BUILD_ID] = response.body["data"]["id"]
  else
    UI.error "Oops! Something went wrong.... 🔥"
    error = response.body["error"]
    Helper::AppliveryHelper.parse_error(error)
  end

end