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

Instance Attribute Summary

Attributes inherited from Client

#client, #cookie, #logger, #user

Init and Login collapse

Apps collapse

App Groups collapse

Devices collapse

Certificates collapse

Provisioning Profiles collapse

Methods inherited from Client

#UI, #initialize, login, #login, #page_size, #paging, #session?, #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 



185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/spaceship/portal/portal_client.rb', line 185

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 ⇒ Object 



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

def apps
  paging do |page_number|
    r = request(:post, 'account/ios/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 



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

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) ⇒ Object 



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

def certificates(types)
  paging do |page_number|
    r = request(:post, 'account/ios/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) ⇒ Object 



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

def create_app!(type, name, bundle_id)
  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)

  r = request(:post, 'account/ios/identifiers/addAppId.action', params)
  parse_response(r, 'appId')
end

#create_app_group!(name, group_id) ⇒ Object 



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

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 



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

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) ⇒ Object 



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

def create_device!(device_name, device_id)
  req = request(:post) do |r|
    r.url "https://developerservices2.apple.com/services/#{PROTOCOL_VERSION}/ios/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) ⇒ Object 



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

def create_provisioning_profile!(name, distribution_method, app_id, certificate_ids, device_ids)
  r = request(:post, 'account/ios/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) ⇒ Object 



173
174
175
176
177
178
179
 
# File 'lib/spaceship/portal/portal_client.rb', line 173

def delete_app!(app_id)
  r = request(:post, 'account/ios/identifiers/deleteAppId.action', {
    teamId: team_id,
    appIdId: app_id
  })
  parse_response(r)
end

#delete_app_group!(app_group_id) ⇒ Object 



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

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) ⇒ Object 



356
357
358
359
360
361
362
 
# File 'lib/spaceship/portal/portal_client.rb', line 356

def delete_provisioning_profile!(profile_id)
  r = request(:post, 'account/ios/profile/deleteProvisioningProfile.action', {
    teamId: team_id,
    provisioningProfileId: profile_id
  })
  parse_response(r)
end

#details_for_app(app) ⇒ Object 



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

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

#devices ⇒ Object 



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

def devices
  paging do |page_number|
    r = request(:post, 'account/ios/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 



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

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) ⇒ Object 



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

def download_certificate(certificate_id, type)
  { 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/ios/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) ⇒ Object 



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

def download_provisioning_profile(profile_id)
  r = request(:get, 'https://developer.apple.com/account/ios/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) 


92
93
94
95
 
# File 'lib/spaceship/portal/portal_client.rb', line 92

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

#provisioning_profiles ⇒ Object 



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

def provisioning_profiles
  req = request(:post) do |r|
    r.url "https://developerservices2.apple.com/services/#{PROTOCOL_VERSION}/ios/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) ⇒ Object 



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

def repair_provisioning_profile!(profile_id, name, distribution_method, app_id, certificate_ids, device_ids)
  r = request(:post, 'account/ios/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) ⇒ Object 



305
306
307
308
309
310
311
312
 
# File 'lib/spaceship/portal/portal_client.rb', line 305

def revoke_certificate!(certificate_id, type)
  r = request(:post, 'account/ios/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



75
76
77
 
# File 'lib/spaceship/portal/portal_client.rb', line 75

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
 
# 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['Set-Cookie'] =~ /myacinfo=(\w+);/
    @cookie = "myacinfo=#{$1};"
    return @client
  else
    # Something went wrong. Was it invalid credentials or server issue
    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."
    else
      info = [response.body, response['Set-Cookie']]
      raise UnexpectedResponse.new, info.join("\n")
    end
  end
end

#team_id ⇒ String

Returns The currently selected Team ID.

Returns:

  • (String) —

    The currently selected Team ID



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

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



80
81
82
 
# File 'lib/spaceship/portal/portal_client.rb', line 80

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



85
86
87
88
89
 
# File 'lib/spaceship/portal/portal_client.rb', line 85

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



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

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 



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

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