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, #parse_response, #persistent_cookie_path, #request, #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

.hostnameObject


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

#app_groupsObject


194
195
196
197
198
199
200
201
202
203
204
# File 'lib/spaceship/portal/portal_client.rb', line 194

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


89
90
91
92
93
94
95
96
97
98
99
# File 'lib/spaceship/portal/portal_client.rb', line 89

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


122
123
124
125
126
127
128
129
130
131
132
133
# File 'lib/spaceship/portal/portal_client.rb', line 122

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


293
294
295
296
297
298
299
300
301
302
303
304
# File 'lib/spaceship/portal/portal_client.rb', line 293

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


147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
# File 'lib/spaceship/portal/portal_client.rb', line 147

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: valid_name_for(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


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

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

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

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


306
307
308
309
310
311
312
313
314
315
316
# File 'lib/spaceship/portal/portal_client.rb', line 306

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


258
259
260
261
262
263
264
265
266
267
268
269
270
271
# File 'lib/spaceship/portal/portal_client.rb', line 258

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


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

def create_provisioning_profile!(name, distribution_method, app_id, certificate_ids, device_ids, mac: false, sub_platform: nil)
  ensure_csrf(Spaceship::ProvisioningProfile) do
    fetch_csrf_token_for_provisioning
  end

  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


180
181
182
183
184
185
186
187
188
# File 'lib/spaceship/portal/portal_client.rb', line 180

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


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

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


406
407
408
409
410
411
412
413
414
415
416
# File 'lib/spaceship/portal/portal_client.rb', line 406

def delete_provisioning_profile!(profile_id, mac: false)
  ensure_csrf(Spaceship::ProvisioningProfile) do
    fetch_csrf_token_for_provisioning
  end

  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


101
102
103
104
105
106
107
# File 'lib/spaceship/portal/portal_client.rb', line 101

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, include_disabled: false) ⇒ Object


231
232
233
234
235
236
237
238
239
240
241
242
# File 'lib/spaceship/portal/portal_client.rb', line 231

def devices(mac: false, include_disabled: 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',
      includeRemovedDevices: include_disabled
    })
    parse_response(r, 'devices')
  end
end

#devices_by_class(device_class, include_disabled: false) ⇒ Object


244
245
246
247
248
249
250
251
252
253
254
255
256
# File 'lib/spaceship/portal/portal_client.rb', line 244

def devices_by_class(device_class, include_disabled: false)
  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,
      includeRemovedDevices: include_disabled
    })
    parse_response(r, 'devices')
  end
end

#disable_device!(device_id, device_udid, mac: false) ⇒ Object


273
274
275
276
277
278
# File 'lib/spaceship/portal/portal_client.rb', line 273

def disable_device!(device_id, device_udid, mac: false)
  request(:post, "https://developer.apple.com/services-account/#{PROTOCOL_VERSION}/account/#{platform_slug(mac)}/device/deleteDevice.action", {
    teamId: team_id,
    deviceId: device_id
  })
end

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


318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
# File 'lib/spaceship/portal/portal_client.rb', line 318

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


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

def download_provisioning_profile(profile_id, mac: false)
  ensure_csrf(Spaceship::ProvisioningProfile) do
    fetch_csrf_token_for_provisioning
  end

  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

#enable_device!(device_id, device_udid, mac: false) ⇒ Object


280
281
282
283
284
285
286
287
# File 'lib/spaceship/portal/portal_client.rb', line 280

def enable_device!(device_id, device_udid, mac: false)
  req = request(:post, "https://developer.apple.com/services-account/#{PROTOCOL_VERSION}/account/#{platform_slug(mac)}/device/enableDevice.action", {
      teamId: team_id,
      displayId: device_id,
      deviceNumber: device_udid
  })
  parse_response(req, 'device')
end

#fetch_csrf_token_for_provisioning(mac: false) ⇒ Object

We need a custom way to fetch the csrf token for the provisioning profile requests, since we use a separate API endpoint (host of Xcode API) to fetch the provisioning profiles All we do is fetch one profile (if exists) to get a valid csrf token with its time stamp This method is being called from all requests that modify, create or downloading provisioning profiles. Source github.com/fastlane/fastlane/issues/5903


442
443
444
445
446
447
448
449
450
451
452
453
454
455
# File 'lib/spaceship/portal/portal_client.rb', line 442

def fetch_csrf_token_for_provisioning(mac: false)
  req = request(:post) do |r|
    r.url "https://developer.apple.com/services-account/#{PROTOCOL_VERSION}/account/#{platform_slug(mac)}/profile/listProvisioningProfiles.action"
    r.params = {
      teamId: team_id,
      pageSize: 1,
      pageNumber: 1,
      sort: "name=asc"
    }
  end

  parse_response(req, 'provisioningProfiles')
  return nil
end

#in_house?Boolean

Is the current session from an Enterprise In House account?

Returns:

  • (Boolean)

71
72
73
74
# File 'lib/spaceship/portal/portal_client.rb', line 71

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

#provisioning_profile_details(provisioning_profile_id: nil, mac: false) ⇒ Object


362
363
364
365
366
367
368
# File 'lib/spaceship/portal/portal_client.rb', line 362

def provisioning_profile_details(provisioning_profile_id: nil, mac: false)
  r = request(:post, "account/#{platform_slug(mac)}/profile/getProvisioningProfile.action", {
    teamId: team_id,
    provisioningProfileId: provisioning_profile_id
  })
  parse_response(r, 'provisioningProfile')
end

#provisioning_profiles(mac: false) ⇒ Object


349
350
351
352
353
354
355
356
357
358
359
360
# File 'lib/spaceship/portal/portal_client.rb', line 349

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


418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
# File 'lib/spaceship/portal/portal_client.rb', line 418

def repair_provisioning_profile!(profile_id, name, distribution_method, app_id, certificate_ids, device_ids, mac: false)
  ensure_csrf(Spaceship::ProvisioningProfile) do
    fetch_csrf_token_for_provisioning
  end

  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


334
335
336
337
338
339
340
341
342
343
# File 'lib/spaceship/portal/portal_client.rb', line 334

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_teamObject

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


54
55
56
# File 'lib/spaceship/portal/portal_client.rb', line 54

def select_team
  @current_team_id = self.UI.select_team
end

#send_login_request(user, password) ⇒ Object


12
13
14
15
16
17
18
19
20
21
22
23
24
# File 'lib/spaceship/portal/portal_client.rb', line 12

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_idString

Returns The currently selected Team ID.

Returns:

  • (String)

    The currently selected Team ID


39
40
41
42
43
44
45
46
47
48
49
50
# File 'lib/spaceship/portal/portal_client.rb', line 39

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


59
60
61
# File 'lib/spaceship/portal/portal_client.rb', line 59

def team_id=(team_id)
  @current_team_id = team_id
end

#team_informationHash

Returns Fetches all information of the currently used team.

Returns:

  • (Hash)

    Fetches all information of the currently used team


64
65
66
67
68
# File 'lib/spaceship/portal/portal_client.rb', line 64

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

#teamsArray

Returns A list of all available teams.

Returns:

  • (Array)

    A list of all available teams


27
28
29
30
31
32
33
34
35
36
# File 'lib/spaceship/portal/portal_client.rb', line 27

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


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

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

#valid_name_for(input) ⇒ Object


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

def valid_name_for(input)
  latinized = input.to_slug.transliterate
  latinized = latinized.gsub(/[^0-9A-Za-z\d\s]/, '') # remove non-valid characters
  # Check if the input string was modified, since it might be empty now
  # (if it only contained non-latin symbols) or the duplicate of another app
  if latinized != input
    latinized << " "
    latinized << Digest::MD5.hexdigest(input)
  end
  latinized
end