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 



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

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 



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

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 



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

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 



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

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 



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

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 



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

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 



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

def create_certificate!(type, csr, app_id = nil)
  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 



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

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 



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

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 



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

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 



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

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 



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

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 



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

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 



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

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



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

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

#download_certificate(certificate_id, type) ⇒ Object 



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

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
  })
  parse_response(r)
end

#download_provisioning_profile(profile_id) ⇒ Object 



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

def download_provisioning_profile(profile_id)
  r = request(:get, 'https://developer.apple.com/account/ios/profile/profileContentDownload.action', {
    teamId: team_id,
    displayId: profile_id
  })
  parse_response(r)
end

#in_house? ⇒ Boolean

Is the current session from an Enterprise In House account?

Returns:

  • (Boolean) 


90
91
92
93
 
# File '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

#provisioning_profiles ⇒ Object 



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

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 



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

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 



292
293
294
295
296
297
298
299
 
# File 'lib/spaceship/portal/portal_client.rb', line 292

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



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

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
 
# 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."
    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



62
63
64
65
66
67
68
69
 
# 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
  @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 '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 'lib/spaceship/portal/portal_client.rb', line 83

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



56
57
58
59
 
# File 'lib/spaceship/portal/portal_client.rb', line 56

def teams
  r = request(:post, 'account/listTeams.action')
  parse_response(r, 'teams')
end

#update_service_for_app(app, service) ⇒ Object 



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

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