Class: Spaceship::PortalClient

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

Constant Summary

Constants inherited from Client

Client::PROTOCOL_VERSION, Client::USER_AGENT

Instance Attribute Summary

Attributes inherited from Client

#client, #logger, #user

Init and Login collapse

Apps collapse

App Groups collapse

Devices collapse

Certificates collapse

Provisioning Profiles collapse

Methods inherited from Client

#UI, #cookie, #initialize, login, #login, #page_size, #paging, #with_retry

Constructor Details

This class inherits a constructor from Spaceship::Client

Class Method Details

.hostname ⇒ Object 



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

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



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

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

  landing_url = "https://developer.apple.com/membercenter/index.action"
  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]
    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 



202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/spaceship/portal/portal_client.rb', line 202

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 



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

def associate_groups_with_app(app, groups)
  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 



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

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 



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
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/spaceship/portal/portal_client.rb', line 154

def create_app!(type, name, bundle_id, mac: false)
  ident_params = case type.to_sym
                 when :explicit
                   {
                     type: 'explicit',
                     explicitIdentifier: bundle_id,
                     appIdentifierString: bundle_id,
                     push: 'on',
                     inAppPurchase: 'on',
                     gameCenter: 'on'
                   }
                 when :wildcard
                   {
                     type: 'wildcard',
                     wildcardIdentifier: bundle_id,
                     appIdentifierString: bundle_id
                   }
                 end

  params = {
    appIdName: name,
    teamId: team_id
  }

  params.merge!(ident_params)

  if csrf_tokens.count == 0
    # If we directly create a new app without querying anything before
    # we don't have a valid csrf token, that's why we have to do at least one request
    apps
  end

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

#create_app_group!(name, group_id) ⇒ Object 



214
215
216
217
218
219
220
221
 
# File 'lib/spaceship/portal/portal_client.rb', line 214

def create_app_group!(name, group_id)
  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 



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

def create_certificate!(type, csr, app_id = nil)
  if csrf_tokens.count == 0
    # If we directly create a new certificate without querying anything before
    # we don't have a valid csrf token, that's why we have to do at least one request
    certificates([Certificate::CERTIFICATE_TYPE_IDS.keys.first])
  end

  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 



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

def create_device!(device_name, device_id, mac: false)
  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) ⇒ Object 



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

def create_provisioning_profile!(name, distribution_method, app_id, certificate_ids, device_ids, mac: false)
  if csrf_tokens.count == 0
    # If we directly create a new profile without querying anything before
    # we don't have a valid csrf token, that's why we have to do at least one request
    provisioning_profiles
  end

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

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



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

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



223
224
225
226
227
228
229
 
# File 'lib/spaceship/portal/portal_client.rb', line 223

def delete_app_group!(app_group_id)
  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 



379
380
381
382
383
384
385
 
# File 'lib/spaceship/portal/portal_client.rb', line 379

def delete_provisioning_profile!(profile_id, mac: false)
  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 



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

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 



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

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 



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

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(:post, "https://developer.apple.com/account/#{platform_slug(mac)}/certificate/certificateContentDownload.action", {
    teamId: team_id,
    displayId: 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 



366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/spaceship/portal/portal_client.rb', line 366

def download_provisioning_profile(profile_id, mac: false)
  r = request(:get, "https://developer.apple.com/account/#{platform_slug(mac)}/profile/profileContentDownload.action", {
    teamId: team_id,
    displayId: 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 



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

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 



387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/spaceship/portal/portal_client.rb', line 387

def repair_provisioning_profile!(profile_id, name, distribution_method, app_id, certificate_ids, device_ids, mac: false)
  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 



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

def revoke_certificate!(certificate_id, type, mac: false)
  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 



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
 
# File 'lib/spaceship/portal/portal_client.rb', line 33

def (user, password)
  response = request(:post, "https://idmsa.apple.com/IDMSWebAuth/authenticate", {
    appleId: user,
    accountPassword: password,
    appIdKey: api_key
  })

  if (response.body || "").include?("Your Apple ID or password was entered incorrectly")
    # User Credentials are wrong
    raise InvalidUserCredentialsError.new, "Invalid username and password combination. Used '#{user}' as the username."
  elsif (response.body || "").include?("Verify your identity")
    raise "spaceship / fastlane doesn't support 2 step enabled accounts yet. Please temporary disable 2 step verification until spaceship was updated."
  end

  case response.status
  when 302
    return response
  when 200
    raise InvalidUserCredentialsError.new, "Invalid username and password combination. Used '#{user}' as the username."
  else
    # Something went wrong. Was it invalid credentials or server issue
    info = [response.body, response['Set-Cookie']]
    raise UnexpectedResponse.new, info.join("\n")
  end
end

#team_id ⇒ String

Returns The currently selected Team ID.

Returns:

  • (String) —

    The currently selected Team ID



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

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
  @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



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

def teams
  req = request(:post, "https://developerservices2.apple.com/services/QH65B2/listTeams.action")
  parse_response(req, 'teams')
end

#update_service_for_app(app, service) ⇒ Object 



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

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

  details_for_app(app)
end