Class: Spaceship::PortalClient

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

Overview

rubocop:disable Metrics/ClassLength

Init and Login collapse

PROTOCOL_VERSION = 
Spaceship::Client::PROTOCOL_VERSION

Constants inherited from Client

Client::AUTH_TYPES, Client::AccessForbiddenError, Client::AppleTimeoutError, Client::BadGatewayError, Client::BasicPreferredInfoError, Client::GatewayTimeoutError, Client::InsufficientPermissions, Client::InternalServerError, Client::InvalidUserCredentialsError, Client::NoUserCredentialsError, Client::ProgramLicenseAgreementUpdated, Client::TooManyRequestsError, Client::USER_AGENT, Client::UnauthorizedAccessError, Client::UnexpectedResponse

Instance Attribute Summary

Attributes inherited from Client

#additional_headers, #client, #csrf_tokens, #logger, #provider, #user, #user_email

Init and Login collapse

Apps collapse

Passbook collapse

Website Push collapse

Merchant collapse

App Groups collapse

Cloud Containers collapse

Team collapse

Devices collapse

Certificates collapse

Provisioning Profiles collapse

Keys collapse

Methods inherited from Client

#UI, #ask_for_2fa_code, #choose_phone_number, client_with_authorization_from, #cookie, #detect_most_common_errors_and_raise_exceptions, #do_sirp, #exit_with_session_state, #fastlane_user_dir, #fetch_hashcash, #fetch_olympus_session, #fetch_program_license_agreement_messages, #handle_two_factor, #handle_two_step, #handle_two_step_for_device, #handle_two_step_or_factor, #has_valid_session, #initialize, #itc_service_key, #load_session_from_env, #load_session_from_file, #login, login, #match_phone_to_masked_phone, #page_size, #paging, #parse_response, #pbkdf2, #perform_login_method, #persistent_cookie_path, #phone_id_from_masked_number, #phone_id_from_number, #push_mode_from_masked_number, #push_mode_from_number, #raise_insufficient_permission_error!, #request, #request_two_factor_code_from_phone, #request_two_factor_code_from_phone_choose, #send_shared_login_request, #sms_automatically_sent, #sms_fallback, spaceship_session_env, #store_cookie, #store_session, #team_name, #to_byte, #to_hex, #try_upgrade_2fa_later, #update_request_headers, #user_details_data, #with_retry

Constructor Details

This class inherits a constructor from Spaceship::Client

Class Method Details

.hostname ⇒ Object 



24
25
26
 
# File 'spaceship/lib/spaceship/portal/portal_client.rb', line 24

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

Instance Method Details

#app_groups ⇒ Object 



372
373
374
375
376
377
378
379
380
381
382
 
# File 'spaceship/lib/spaceship/portal/portal_client.rb', line 372

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 



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

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_cloud_containers_with_app(app, containers) ⇒ Object 



167
168
169
170
171
172
173
174
175
176
177
 
# File 'spaceship/lib/spaceship/portal/portal_client.rb', line 167

def associate_cloud_containers_with_app(app, containers)
  ensure_csrf(Spaceship::Portal::CloudContainer)

  request(:post, 'account/ios/identifiers/assignCloudContainerToAppId.action', {
      teamId: team_id,
      appIdId: app.app_id,
      cloudContainers: containers.map(&:cloud_container)
  })

  details_for_app(app)
end

#associate_groups_with_app(app, groups) ⇒ Object 



154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'spaceship/lib/spaceship/portal/portal_client.rb', line 154

def associate_groups_with_app(app, groups)
  ensure_csrf(Spaceship::Portal::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

#associate_merchants_with_app(app, merchants, mac) ⇒ Object 



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

def associate_merchants_with_app(app, merchants, mac)
  ensure_csrf(Spaceship::Portal::Merchant)

  request(:post, "account/#{platform_slug(mac)}/identifiers/assignOMCToAppId.action", {
    teamId: team_id,
    appIdId: app.app_id,
    omcIds: merchants.map(&:merchant_id)
  })

  details_for_app(app)
end

#certificates(types, mac: false) ⇒ Object 



578
579
580
581
582
583
584
585
586
587
588
589
 
# File 'spaceship/lib/spaceship/portal/portal_client.rb', line 578

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

#cloud_containers ⇒ Object 



409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
 
# File 'spaceship/lib/spaceship/portal/portal_client.rb', line 409

def cloud_containers
  paging do |page_number|
    r = request(:post, 'account/cloudContainer/listCloudContainers.action', {
        teamId: team_id,
        pageNumber: page_number,
        pageSize: page_size,
        sort: 'name=asc'
    })
    result = parse_response(r, 'cloudContainerList')

    csrf_cache[Spaceship::Portal::CloudContainer] = self.csrf_tokens

    result
  end
end

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



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'spaceship/lib/spaceship/portal/portal_client.rb', line 203

def create_app!(type, name, bundle_id, mac: false, enable_services: {})
  # 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::Portal::App)

  ident_params = case type.to_sym
                 when :explicit
                   {
                     type: 'explicit',
                     identifier: bundle_id,
                     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)
  enable_services.each do |k, v|
    params[v.service_id.to_sym] = v.value
  end
  r = request(:post, "account/#{platform_slug(mac)}/identifiers/addAppId.action", params)
  parse_response(r, 'appId')
end

#create_app_group!(name, group_id) ⇒ Object 



384
385
386
387
388
389
390
391
392
393
 
# File 'spaceship/lib/spaceship/portal/portal_client.rb', line 384

def create_app_group!(name, group_id)
  ensure_csrf(Spaceship::Portal::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, mac = false) ⇒ Object 



591
592
593
594
595
596
597
598
599
600
601
602
 
# File 'spaceship/lib/spaceship/portal/portal_client.rb', line 591

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

  r = request(:post, "account/#{platform_slug(mac)}/certificate/submitCertificateRequest.action", {
    teamId: team_id,
    type: type,
    csrContent: csr,
    appIdId: app_id, # optional
    specialIdentifierDisplayId: app_id, # For requesting Web Push certificates
  })
  parse_response(r, 'certRequest')
end

#create_cloud_container!(name, identifier) ⇒ Object 



425
426
427
428
429
430
431
432
433
434
 
# File 'spaceship/lib/spaceship/portal/portal_client.rb', line 425

def create_cloud_container!(name, identifier)
  ensure_csrf(Spaceship::Portal::CloudContainer)

  r = request(:post, 'account/cloudContainer/addCloudContainer.action', {
      name: valid_name_for(name),
      identifier: identifier,
      teamId: team_id
  })
  parse_response(r, 'cloudContainer')
end

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

Raises:



538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
 
# File 'spaceship/lib/spaceship/portal/portal_client.rb', line 538

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

  req = request(:post, "account/#{platform_slug(mac)}/device/addDevices.action", {
    teamId: team_id,
    deviceClasses: mac ? 'mac' : 'iphone',
    deviceNumbers: device_id,
    deviceNames: device_name,
    register: 'single'
  })

  devices = parse_response(req, 'devices')
  return devices.first unless devices.empty?

  validation_messages = parse_response(req, 'validationMessages').map { |message| message["validationUserMessage"] }.compact.uniq

  raise UnexpectedResponse.new, validation_messages.join('\n') unless validation_messages.empty?
  raise UnexpectedResponse.new, "Couldn't register new device, got this: #{parse_response(req)}"
end

#create_key!(name: nil, service_configs: nil) ⇒ Object 



781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
 
# File 'spaceship/lib/spaceship/portal/portal_client.rb', line 781

def create_key!(name: nil, service_configs: nil)
  fetch_csrf_token_for_keys

  service_configs_requests = (service_configs || {}).map do |service_id, configs|
    if service_id == Spaceship::Portal::Key::MUSIC_KIT_ID
      {
        serviceId: service_id,
        isNew: true,
        identifiers: configs[:identifiers] || {}
      }
    elsif service_id == Spaceship::Portal::Key::DEVICE_CHECK_ID
      {
        serviceId: service_id,
        isNew: true,
        identifiers: configs[:identifiers] || {}
      }
    elsif service_id == Spaceship::Portal::Key::APNS_ID
      {
        serviceId: service_id,
        isNew: true,
        identifiers: configs[:identifiers] || {},
        environment: configs[:environment] || "all",
        scope: configs[:scope] || "team"
      }
    else
      raise "Unknown service id: #{service_id}"
    end
  end

  params = {
    name: name,
    serviceConfigurationsRequests: service_configs_requests,
    teamId: team_id
  }

  response = request(:post, 'account/auth/key/v2/create') do |req|
    req.headers['Content-Type'] = 'application/json'
    req.body = params.to_json
  end

  # response contains a list of keys with 1 item
  parse_response(response, 'keys').first
end

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



347
348
349
350
351
352
353
354
355
356
 
# File 'spaceship/lib/spaceship/portal/portal_client.rb', line 347

def create_merchant!(name, bundle_id, mac: false)
  ensure_csrf(Spaceship::Portal::Merchant)

  r = request(:post, "account/#{platform_slug(mac)}/identifiers/addOMC.action", {
      name: name,
      identifier: bundle_id,
      teamId: team_id
  })
  parse_response(r, 'omcId')
end

#create_passbook!(name, bundle_id) ⇒ Object 



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

def create_passbook!(name, bundle_id)
  ensure_csrf(Spaceship::Portal::Passbook)

  r = request(:post, "account/ios/identifiers/addPassTypeId.action", {
      name: name,
      identifier: bundle_id,
      teamId: team_id
  })
  parse_response(r, 'passTypeId')
end

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



685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
 
# File 'spaceship/lib/spaceship/portal/portal_client.rb', line 685

def create_provisioning_profile!(name, distribution_method, app_id, certificate_ids, device_ids, mac: false, sub_platform: nil, template_name: nil)
  ensure_csrf(Spaceship::Portal::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

  # if `template_name` is nil, Default entitlements will be used
  params[:template] = template_name if template_name

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

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



310
311
312
313
314
315
316
317
318
319
 
# File 'spaceship/lib/spaceship/portal/portal_client.rb', line 310

def create_website_push!(name, bundle_id, mac: false)
  ensure_csrf(Spaceship::Portal::WebsitePush)

  r = request(:post, "account/#{platform_slug(mac)}/identifiers/addWebsitePushId.action", {
      name: name,
      identifier: bundle_id,
      teamId: team_id
  })
  parse_response(r, 'websitePushId')
end

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



236
237
238
239
240
241
242
243
244
 
# File 'spaceship/lib/spaceship/portal/portal_client.rb', line 236

def delete_app!(app_id, mac: false)
  ensure_csrf(Spaceship::Portal::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 



395
396
397
398
399
400
401
402
403
 
# File 'spaceship/lib/spaceship/portal/portal_client.rb', line 395

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

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

#delete_merchant!(merchant_id, mac: false) ⇒ Object 



358
359
360
361
362
363
364
365
366
 
# File 'spaceship/lib/spaceship/portal/portal_client.rb', line 358

def delete_merchant!(merchant_id, mac: false)
  ensure_csrf(Spaceship::Portal::Merchant)

  r = request(:post, "account/#{platform_slug(mac)}/identifiers/deleteOMC.action", {
      teamId: team_id,
      omcId: merchant_id
  })
  parse_response(r)
end

#delete_passbook!(passbook_id) ⇒ Object 



284
285
286
287
288
289
290
291
292
 
# File 'spaceship/lib/spaceship/portal/portal_client.rb', line 284

def delete_passbook!(passbook_id)
  ensure_csrf(Spaceship::Portal::Passbook)

  r = request(:post, "account/ios/identifiers/deletePassTypeId.action", {
      teamId: team_id,
      passTypeId: passbook_id
  })
  parse_response(r)
end

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



724
725
726
727
728
729
730
731
 
# File 'spaceship/lib/spaceship/portal/portal_client.rb', line 724

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

#delete_website_push!(website_id, mac: false) ⇒ Object 



321
322
323
324
325
326
327
328
329
 
# File 'spaceship/lib/spaceship/portal/portal_client.rb', line 321

def delete_website_push!(website_id, mac: false)
  ensure_csrf(Spaceship::Portal::WebsitePush)

  r = request(:post, "account/#{platform_slug(mac)}/identifiers/deleteWebsitePushId.action", {
      teamId: team_id,
      websitePushId: website_id
  })
  parse_response(r)
end

#details_for_app(app) ⇒ Object 



133
134
135
136
137
138
139
 
# File 'spaceship/lib/spaceship/portal/portal_client.rb', line 133

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 



507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
 
# File 'spaceship/lib/spaceship/portal/portal_client.rb', line 507

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
    })
    result = parse_response(r, 'devices')

    csrf_cache[Spaceship::Portal::Device] = self.csrf_tokens

    result
  end
end

#devices_by_class(device_class, include_disabled: false) ⇒ Object 



524
525
526
527
528
529
530
531
532
533
534
535
536
 
# File 'spaceship/lib/spaceship/portal/portal_client.rb', line 524

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 



558
559
560
561
562
563
 
# File 'spaceship/lib/spaceship/portal/portal_client.rb', line 558

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 



604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
 
# File 'spaceship/lib/spaceship/portal/portal_client.rb', line 604

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_key(id: nil) ⇒ Object 



776
777
778
779
 
# File 'spaceship/lib/spaceship/portal/portal_client.rb', line 776

def download_key(id: nil)
  response = request(:get, 'account/auth/key/download', { teamId: team_id, keyId: id })
  parse_response(response)
end

#download_provisioning_profile(profile_id, mac: false) ⇒ Object 



707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
 
# File 'spaceship/lib/spaceship/portal/portal_client.rb', line 707

def download_provisioning_profile(profile_id, mac: false)
  ensure_csrf(Spaceship::Portal::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 



565
566
567
568
569
570
571
572
 
# File 'spaceship/lib/spaceship/portal/portal_client.rb', line 565

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

#get_key(id: nil) ⇒ Object 



770
771
772
773
774
 
# File 'spaceship/lib/spaceship/portal/portal_client.rb', line 770

def get_key(id: nil)
  response = request(:post, 'account/auth/key/get', { teamId: team_id, keyId: id })
  # response contains a list of keys with 1 item
  parse_response(response, 'keys').first
end

#in_house? ⇒ Boolean

Is the current session from an Enterprise In House account?

Returns:

  • (Boolean) 


90
91
92
93
 
# File 'spaceship/lib/spaceship/portal/portal_client.rb', line 90

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

#list_keys ⇒ Object 



758
759
760
761
762
763
764
765
766
767
768
 
# File 'spaceship/lib/spaceship/portal/portal_client.rb', line 758

def list_keys
  paging do |page_number|
    response = request(:post, 'account/auth/key/list', {
      teamId: team_id,
      pageNumber: page_number,
      pageSize: page_size,
      sort: 'name=asc'
    })
    parse_response(response, 'keys')
  end
end

#list_pending_agreements(language: "en") ⇒ Object 



104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'spaceship/lib/spaceship/portal/portal_client.rb', line 104

def list_pending_agreements(language: "en")
  r = request(:post) do |req|
    req.url("account/listPendingAgreements")
    req.body = {
      teamId: team_id,
      languageIsoCode: language
    }.to_json
    req.headers['Content-Type'] = 'application/json'
  end

  return parse_response(r)
end

#merchants(mac: false) ⇒ Object 



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

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

#passbooks ⇒ Object 



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

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

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



677
678
679
680
681
682
683
 
# File 'spaceship/lib/spaceship/portal/portal_client.rb', line 677

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 



635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
 
# File 'spaceship/lib/spaceship/portal/portal_client.rb', line 635

def provisioning_profiles(mac: false)
  paging do |page_number|
    req = request(:post, "account/#{platform_slug(mac)}/profile/listProvisioningProfiles.action", {
      teamId: team_id,
      pageNumber: page_number,
      pageSize: page_size,
      sort: 'name=asc',
      includeInactiveProfiles: true,
      onlyCountLists: true
    })

    result = parse_response(req, 'provisioningProfiles')

    csrf_cache[Spaceship::Portal::ProvisioningProfile] = self.csrf_tokens

    result
  end
end

#provisioning_profiles_via_xcode_api(mac: false) ⇒ Object

this endpoint is used by Xcode to fetch provisioning profiles. The response is an xml plist but has the added benefit of containing the appId of each provisioning profile.

Use this method over provisioning_profiles if possible because no secondary API calls are necessary to populate the ProvisioningProfile data model.



659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
 
# File 'spaceship/lib/spaceship/portal/portal_client.rb', line 659

def provisioning_profiles_via_xcode_api(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,
      includeExpiredProfiles: true,
      onlyCountLists: true
    }
  end

  result = parse_response(req, 'provisioningProfiles')

  csrf_cache[Spaceship::Portal::ProvisioningProfile] = self.csrf_tokens

  result
end

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



733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
 
# File 'spaceship/lib/spaceship/portal/portal_client.rb', line 733

def repair_provisioning_profile!(profile_id, name, distribution_method, app_id, certificate_ids, device_ids, mac: false, sub_platform: nil, template_name: nil)
  fetch_csrf_token_for_provisioning

  params = {
      teamId: team_id,
      provisioningProfileId: profile_id,
      provisioningProfileName: name,
      appIdId: app_id,
      distributionType: distribution_method,
      certificateIds: certificate_ids.join(','),
      deviceIds: device_ids
  }
  params[:subPlatform] = sub_platform if sub_platform
  # if `template_name` is nil, Default entitlements will be used
  params[:template] = template_name if template_name

  r = request(:post, "account/#{platform_slug(mac)}/profile/regenProvisioningProfile.action", params)

  parse_response(r, 'provisioningProfile')
end

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



620
621
622
623
624
625
626
627
628
629
 
# File 'spaceship/lib/spaceship/portal/portal_client.rb', line 620

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

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

#revoke_key!(id: nil) ⇒ Object 



825
826
827
828
829
 
# File 'spaceship/lib/spaceship/portal/portal_client.rb', line 825

def revoke_key!(id: nil)
  fetch_csrf_token_for_keys
  response = request(:post, 'account/auth/key/revoke', { teamId: team_id, keyId: id })
  parse_response(response)
end

#select_team(team_id: nil, team_name: nil) ⇒ Object

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

Parameters:

  • team_id (String) (defaults to: nil) —

    (optional): The ID of a Developer Portal team

  • team_name (String) (defaults to: nil) —

    (optional): The name of a Developer Portal team



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

def select_team(team_id: nil, team_name: nil)
  @current_team_id = self.UI.select_team(team_id: team_id, team_name: team_name)
end

#send_login_request(user, password) ⇒ Object 



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

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 App Store Connect
  # For 2 step verification we use the App Store 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



55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'spaceship/lib/spaceship/portal/portal_client.rb', line 55

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



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

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



83
84
85
86
87
 
# File 'spaceship/lib/spaceship/portal/portal_client.rb', line 83

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

#team_invite(email, role) ⇒ Object 



488
489
490
491
492
493
494
495
496
497
498
499
500
501
 
# File 'spaceship/lib/spaceship/portal/portal_client.rb', line 488

def team_invite(email, role)
  ensure_csrf(Spaceship::Portal::Persons)
  response = request(:post) do |req|
    req.url("/services-account/#{PROTOCOL_VERSION}/account/sendInvites")
    req.body = {
      invites: [
        { recipientEmail: email, recipientRole: role }
      ],
      teamId: team_id
    }.to_json
    req.headers['Content-Type'] = 'application/json'
  end
  parse_response(response)
end

#team_invited ⇒ Object 



450
451
452
453
454
455
456
457
458
459
 
# File 'spaceship/lib/spaceship/portal/portal_client.rb', line 450

def team_invited
  response = request(:post) do |req|
    req.url("/services-account/#{PROTOCOL_VERSION}/account/getInvites")
    req.body = {
      teamId: team_id
    }.to_json
    req.headers['Content-Type'] = 'application/json'
  end
  parse_response(response)
end

#team_members ⇒ Object 



439
440
441
442
443
444
445
446
447
448
 
# File 'spaceship/lib/spaceship/portal/portal_client.rb', line 439

def team_members
  response = request(:post) do |req|
    req.url("/services-account/#{PROTOCOL_VERSION}/account/getTeamMembers")
    req.body = {
      teamId: team_id
    }.to_json
    req.headers['Content-Type'] = 'application/json'
  end
  parse_response(response)
end

#team_remove_member!(team_member_id) ⇒ Object 



475
476
477
478
479
480
481
482
483
484
485
486
 
# File 'spaceship/lib/spaceship/portal/portal_client.rb', line 475

def team_remove_member!(team_member_id)
  ensure_csrf(Spaceship::Portal::Persons)
  response = request(:post) do |req|
    req.url("/services-account/#{PROTOCOL_VERSION}/account/removeTeamMembers")
    req.body = {
      teamId: team_id,
      teamMemberIds: [team_member_id]
    }.to_json
    req.headers['Content-Type'] = 'application/json'
  end
  parse_response(response)
end

#team_set_role(team_member_id, role) ⇒ Object 



461
462
463
464
465
466
467
468
469
470
471
472
473
 
# File 'spaceship/lib/spaceship/portal/portal_client.rb', line 461

def team_set_role(team_member_id, role)
  ensure_csrf(Spaceship::Portal::Persons)
  response = request(:post) do |req|
    req.url("/services-account/#{PROTOCOL_VERSION}/account/setTeamMemberRoles")
    req.body = {
      teamId: team_id,
      role: role,
      teamMemberIds: [team_member_id]
    }.to_json
    req.headers['Content-Type'] = 'application/json'
  end
  parse_response(response)
end

#teams ⇒ Array

Returns A list of all available teams.

Returns:

  • (Array) —

    A list of all available teams



43
44
45
46
47
48
49
50
51
52
 
# File 'spaceship/lib/spaceship/portal/portal_client.rb', line 43

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

#update_app_name!(app_id, name, mac: false) ⇒ Object 



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

def update_app_name!(app_id, name, mac: false)
  ensure_csrf(Spaceship::Portal::App)

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

#update_service_for_app(app, service) ⇒ Object 



141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'spaceship/lib/spaceship/portal/portal_client.rb', line 141

def update_service_for_app(app, service)
  ensure_csrf(Spaceship::Portal::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 



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

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

#website_push(mac: false) ⇒ Object 



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

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