Class: Spaceship::PortalClient

Inherits:
Client
  • Object
show all
Defined in:
lib/spaceship/portal/portal_client.rb

Overview

rubocop:disable Metrics/ClassLength

Constant Summary

Constants inherited from Client

Client::PROTOCOL_VERSION, Client::USER_AGENT

Instance Attribute Summary

Attributes inherited from Client

#client, #csrf_tokens, #logger, #user

Init and Login collapse

Apps collapse

App Groups collapse

Devices collapse

Certificates collapse

Provisioning Profiles collapse

Methods inherited from Client

#UI, #cookie, #handle_two_factor, #handle_two_step, #initialize, #itc_service_key, #load_session_from_env, #load_session_from_file, login, #login, #page_size, #paging, #persistent_cookie_path, #select_device, #send_shared_login_request, #store_cookie, #store_session, #with_retry

Constructor Details

This class inherits a constructor from Spaceship::Client

Class Method Details

.hostname ⇒ Object 



8
9
10
 
# File 'lib/spaceship/portal/portal_client.rb', line 8

def self.hostname
  "https://developer.apple.com/services-account/#{PROTOCOL_VERSION}/"
end

Instance Method Details

#api_key ⇒ Object

Fetches the latest API Key from the Apple Dev Portal



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/spaceship/portal/portal_client.rb', line 13

def api_key
  cache_path = File.expand_path("~/Library/Caches/spaceship_api_key.txt")
  begin
    cached = File.read(cache_path)
  rescue Errno::ENOENT
  end
  return cached if cached

  landing_url = "https://developer.apple.com/account/"
  logger.info("GET: " + landing_url)
  headers = @client.get(landing_url).headers
  results = headers['location'].match(/.*appIdKey=(\h+)/)
  if (results || []).length > 1
    api_key = results[1]
    FileUtils.mkdir_p(File.dirname(cache_path))
    File.write(cache_path, api_key) if api_key.length == 64
    return api_key
  else
    raise "Could not find latest API Key from the Dev Portal - the server might be slow right now"
  end
end

#app_groups ⇒ Object 



205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/spaceship/portal/portal_client.rb', line 205

def app_groups
  paging do |page_number|
    r = request(:post, 'account/ios/identifiers/listApplicationGroups.action', {
      teamId: team_id,
      pageNumber: page_number,
      pageSize: page_size,
      sort: 'name=asc'
    })
    parse_response(r, 'applicationGroupList')
  end
end

#apps(mac: false) ⇒ Object 



112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/spaceship/portal/portal_client.rb', line 112

def apps(mac: false)
  paging do |page_number|
    r = request(:post, "account/#{platform_slug(mac)}/identifiers/listAppIds.action", {
      teamId: team_id,
      pageNumber: page_number,
      pageSize: page_size,
      sort: 'name=asc'
    })
    parse_response(r, 'appIds')
  end
end

#associate_groups_with_app(app, groups) ⇒ Object 



145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/spaceship/portal/portal_client.rb', line 145

def associate_groups_with_app(app, groups)
  ensure_csrf(Spaceship::AppGroup)

  request(:post, 'account/ios/identifiers/assignApplicationGroupToAppId.action', {
    teamId: team_id,
    appIdId: app.app_id,
    displayId: app.app_id,
    applicationGroups: groups.map(&:app_group_id)
  })

  details_for_app(app)
end

#certificates(types, mac: false) ⇒ Object 



286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/spaceship/portal/portal_client.rb', line 286

def certificates(types, mac: false)
  paging do |page_number|
    r = request(:post, "account/#{platform_slug(mac)}/certificate/listCertRequests.action", {
      teamId: team_id,
      types: types.join(','),
      pageNumber: page_number,
      pageSize: page_size,
      sort: 'certRequestStatusCode=asc'
    })
    parse_response(r, 'certRequests')
  end
end

#create_app!(type, name, bundle_id, mac: false) ⇒ Object 



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/spaceship/portal/portal_client.rb', line 158

def create_app!(type, name, bundle_id, mac: false)
  # We moved the ensure_csrf to the top of this method
  # as we got some users with issues around creating new apps
  # https://github.com/fastlane/fastlane/issues/5813
  ensure_csrf(Spaceship::App)

  ident_params = case type.to_sym
                 when :explicit
                   {
                     type: 'explicit',
                     identifier: bundle_id,
                     push: 'on',
                     inAppPurchase: 'on',
                     gameCenter: 'on'
                   }
                 when :wildcard
                   {
                     type: 'wildcard',
                     identifier: bundle_id
                   }
                 end

  params = {
    name: name,
    teamId: team_id
  }

  params.merge!(ident_params)

  r = request(:post, "account/#{platform_slug(mac)}/identifiers/addAppId.action", params)
  parse_response(r, 'appId')
end

#create_app_group!(name, group_id) ⇒ Object 



217
218
219
220
221
222
223
224
225
226
 
# File 'lib/spaceship/portal/portal_client.rb', line 217

def create_app_group!(name, group_id)
  ensure_csrf(Spaceship::AppGroup)

  r = request(:post, 'account/ios/identifiers/addApplicationGroup.action', {
    name: name,
    identifier: group_id,
    teamId: team_id
  })
  parse_response(r, 'applicationGroup')
end

#create_certificate!(type, csr, app_id = nil) ⇒ Object 



299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/spaceship/portal/portal_client.rb', line 299

def create_certificate!(type, csr, app_id = nil)
  ensure_csrf(Spaceship::Certificate)

  r = request(:post, 'account/ios/certificate/submitCertificateRequest.action', {
    teamId: team_id,
    type: type,
    csrContent: csr,
    appIdId: app_id # optional
  })
  parse_response(r, 'certRequest')
end

#create_device!(device_name, device_id, mac: false) ⇒ Object 



267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/spaceship/portal/portal_client.rb', line 267

def create_device!(device_name, device_id, mac: false)
  ensure_csrf(Spaceship::Device)

  req = request(:post) do |r|
    r.url "https://developerservices2.apple.com/services/#{PROTOCOL_VERSION}/#{platform_slug(mac)}/addDevice.action"
    r.params = {
      teamId: team_id,
      deviceNumber: device_id,
      name: device_name
    }
  end

  parse_response(req, 'device')
end

#create_provisioning_profile!(name, distribution_method, app_id, certificate_ids, device_ids, mac: false, sub_platform: nil) ⇒ Object 



355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/spaceship/portal/portal_client.rb', line 355

def create_provisioning_profile!(name, distribution_method, app_id, certificate_ids, device_ids, mac: false, sub_platform: nil)
  # Calling provisioning_profiles uses a different api end point than creating or deleting them so we
  # use a different entity to gather the csrf token
  ensure_csrf(Spaceship::App)

  params = {
    teamId: team_id,
    provisioningProfileName: name,
    appIdId: app_id,
    distributionType: distribution_method,
    certificateIds: certificate_ids,
    deviceIds: device_ids
  }
  params[:subPlatform] = sub_platform if sub_platform

  r = request(:post, "account/#{platform_slug(mac)}/profile/createProvisioningProfile.action", params)
  parse_response(r, 'provisioningProfile')
end

#delete_app!(app_id, mac: false) ⇒ Object 



191
192
193
194
195
196
197
198
199
 
# File 'lib/spaceship/portal/portal_client.rb', line 191

def delete_app!(app_id, mac: false)
  ensure_csrf(Spaceship::App)

  r = request(:post, "account/#{platform_slug(mac)}/identifiers/deleteAppId.action", {
    teamId: team_id,
    appIdId: app_id
  })
  parse_response(r)
end

#delete_app_group!(app_group_id) ⇒ Object 



228
229
230
231
232
233
234
235
236
 
# File 'lib/spaceship/portal/portal_client.rb', line 228

def delete_app_group!(app_group_id)
  ensure_csrf(Spaceship::AppGroup)

  r = request(:post, 'account/ios/identifiers/deleteApplicationGroup.action', {
    teamId: team_id,
    applicationGroup: app_group_id
  })
  parse_response(r)
end

#delete_provisioning_profile!(profile_id, mac: false) ⇒ Object 



391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/spaceship/portal/portal_client.rb', line 391

def delete_provisioning_profile!(profile_id, mac: false)
  # Calling provisioning_profiles uses a different api end point than creating or deleting them so we
  # use a different entity to gather the csrf token
  ensure_csrf(Spaceship::App)

  r = request(:post, "account/#{platform_slug(mac)}/profile/deleteProvisioningProfile.action", {
    teamId: team_id,
    provisioningProfileId: profile_id
  })
  parse_response(r)
end

#details_for_app(app) ⇒ Object 



124
125
126
127
128
129
130
 
# File 'lib/spaceship/portal/portal_client.rb', line 124

def details_for_app(app)
  r = request(:post, "account/#{platform_slug(app.mac?)}/identifiers/getAppIdDetail.action", {
    teamId: team_id,
    appIdId: app.app_id
  })
  parse_response(r, 'appId')
end

#devices(mac: false) ⇒ Object 



242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/spaceship/portal/portal_client.rb', line 242

def devices(mac: false)
  paging do |page_number|
    r = request(:post, "account/#{platform_slug(mac)}/device/listDevices.action", {
      teamId: team_id,
      pageNumber: page_number,
      pageSize: page_size,
      sort: 'name=asc'
    })
    parse_response(r, 'devices')
  end
end

#devices_by_class(device_class) ⇒ Object 



254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/spaceship/portal/portal_client.rb', line 254

def devices_by_class(device_class)
  paging do |page_number|
    r = request(:post, 'account/ios/device/listDevices.action', {
      teamId: team_id,
      pageNumber: page_number,
      pageSize: page_size,
      sort: 'name=asc',
      deviceClasses: device_class
    })
    parse_response(r, 'devices')
  end
end

#download_certificate(certificate_id, type, mac: false) ⇒ Object 



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/spaceship/portal/portal_client.rb', line 311

def download_certificate(certificate_id, type, mac: false)
  { type: type, certificate_id: certificate_id }.each { |k, v| raise "#{k} must not be nil" if v.nil? }

  r = request(:get, "account/#{platform_slug(mac)}/certificate/downloadCertificateContent.action", {
    teamId: team_id,
    certificateId: certificate_id,
    type: type
  })
  a = parse_response(r)
  if r.success? && a.include?("Apple Inc")
    return a
  else
    raise UnexpectedResponse.new, "Couldn't download certificate, got this instead: #{a}"
  end
end

#download_provisioning_profile(profile_id, mac: false) ⇒ Object 



374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/spaceship/portal/portal_client.rb', line 374

def download_provisioning_profile(profile_id, mac: false)
  # Calling provisioning_profiles uses a different api end point than creating or deleting them so we
  # use a different entity to gather the csrf token
  ensure_csrf(Spaceship::App)

  r = request(:get, "account/#{platform_slug(mac)}/profile/downloadProfileContent", {
    teamId: team_id,
    provisioningProfileId: profile_id
  })
  a = parse_response(r)
  if r.success? && a.include?("DOCTYPE plist PUBLIC")
    return a
  else
    raise UnexpectedResponse.new, "Couldn't download provisioning profile, got this instead: #{a}"
  end
end

#in_house? ⇒ Boolean

Is the current session from an Enterprise In House account?

Returns:

  • (Boolean) 


94
95
96
97
 
# File 'lib/spaceship/portal/portal_client.rb', line 94

def in_house?
  return @in_house unless @in_house.nil?
  @in_house = (team_information['type'] == 'In-House')
end

#provisioning_profiles(mac: false) ⇒ Object 



342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/spaceship/portal/portal_client.rb', line 342

def provisioning_profiles(mac: false)
  req = request(:post) do |r|
    r.url "https://developerservices2.apple.com/services/#{PROTOCOL_VERSION}/#{platform_slug(mac)}/listProvisioningProfiles.action"
    r.params = {
      teamId: team_id,
      includeInactiveProfiles: true,
      onlyCountLists: true
    }
  end

  parse_response(req, 'provisioningProfiles')
end

#repair_provisioning_profile!(profile_id, name, distribution_method, app_id, certificate_ids, device_ids, mac: false) ⇒ Object 



403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/spaceship/portal/portal_client.rb', line 403

def repair_provisioning_profile!(profile_id, name, distribution_method, app_id, certificate_ids, device_ids, mac: false)
  # Calling provisioning_profiles uses a different api end point than creating or deleting them so we
  # use a different entity to gather the csrf token
  ensure_csrf(Spaceship::App)

  r = request(:post, "account/#{platform_slug(mac)}/profile/regenProvisioningProfile.action", {
    teamId: team_id,
    provisioningProfileId: profile_id,
    provisioningProfileName: name,
    appIdId: app_id,
    distributionType: distribution_method,
    certificateIds: certificate_ids.join(','),
    deviceIds: device_ids
  })

  parse_response(r, 'provisioningProfile')
end

#revoke_certificate!(certificate_id, type, mac: false) ⇒ Object 



327
328
329
330
331
332
333
334
335
336
 
# File 'lib/spaceship/portal/portal_client.rb', line 327

def revoke_certificate!(certificate_id, type, mac: false)
  ensure_csrf(Spaceship::Certificate)

  r = request(:post, "account/#{platform_slug(mac)}/certificate/revokeCertificate.action", {
    teamId: team_id,
    certificateId: certificate_id,
    type: type
  })
  parse_response(r, 'certRequests')
end

#select_team ⇒ Object

Shows a team selection for the user in the terminal. This should not be called on CI systems



77
78
79
 
# File 'lib/spaceship/portal/portal_client.rb', line 77

def select_team
  @current_team_id = self.UI.select_team
end

#send_login_request(user, password) ⇒ Object 



35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/spaceship/portal/portal_client.rb', line 35

def (user, password)
  response = (user, password)
  return response if self.cookie.include?("myacinfo")

  # When the user has 2 step enabled, we might have to call this method again
  # This only occurs when the user doesn't have a team on iTunes Connect
  # For 2 step verification we use the iTunes Connect back-end
  # which is enough to get the DES... cookie, however we don't get a valid
  # myacinfo cookie at that point. That means, after getting the DES... cookie
  # we have to send the login request again. This will then get us a valid myacinfo
  # cookie, additionally to the DES... cookie
  return (user, password)
end

#team_id ⇒ String

Returns The currently selected Team ID.

Returns:

  • (String) —

    The currently selected Team ID



62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/spaceship/portal/portal_client.rb', line 62

def team_id
  return @current_team_id if @current_team_id

  if teams.count > 1
    puts "The current user is in #{teams.count} teams. Pass a team ID or call `select_team` to choose a team. Using the first one for now."
  end

  if teams.count == 0
    raise "User '#{user}' does not have access to any teams with an active membership"
  end
  @current_team_id ||= teams[0]['teamId']
end

#team_id=(team_id) ⇒ Object

Set a new team ID which will be used from now on



82
83
84
 
# File 'lib/spaceship/portal/portal_client.rb', line 82

def team_id=(team_id)
  @current_team_id = team_id
end

#team_information ⇒ Hash

Returns Fetches all information of the currently used team.

Returns:

  • (Hash) —

    Fetches all information of the currently used team



87
88
89
90
91
 
# File 'lib/spaceship/portal/portal_client.rb', line 87

def team_information
  teams.find do |t|
    t['teamId'] == team_id
  end
end

#teams ⇒ Array

Returns A list of all available teams.

Returns:

  • (Array) —

    A list of all available teams



50
51
52
53
54
55
56
57
58
59
 
# File 'lib/spaceship/portal/portal_client.rb', line 50

def teams
  return @teams if @teams
  req = request(:post, "https://developerservices2.apple.com/services/QH65B2/listTeams.action")
  @teams = parse_response(req, 'teams').sort_by do |team|
    [
      team['name'],
      team['teamId']
    ]
  end
end

#update_service_for_app(app, service) ⇒ Object 



132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/spaceship/portal/portal_client.rb', line 132

def update_service_for_app(app, service)
  ensure_csrf(Spaceship::App)

  request(:post, service.service_uri, {
    teamId: team_id,
    displayId: app.app_id,
    featureType: service.service_id,
    featureValue: service.value
  })

  details_for_app(app)
end