Class: Spaceship::Tunes::Application

Inherits:
TunesBase show all
Defined in:
lib/spaceship/tunes/application.rb

Instance Attribute Summary collapse

Attributes inherited from Base

#client, #raw_data

Getting information collapse

Modifying collapse

Builds collapse

Submit for Review collapse

release collapse

General collapse

Testers collapse

Promo codes collapse

Class Method Summary collapse

Methods inherited from TunesBase

client

Methods inherited from Base

attr_accessor, attr_mapping, #attributes, attributes, #initialize, #inspect, mapping_module, method_missing, set_client, #to_s

Constructor Details

This class inherits a constructor from Spaceship::Base

Instance Attribute Details

#app_icon_preview_url ⇒ String

Returns The URL to a low resolution app icon of this app (340x340px). Might be nil.

Examples:

"https://is1-ssl.mzstatic.com/image/thumb/Purple7/v4/cd/a3/e2/cda3e2ac-4034-c6af-ee0c-3e4d9a0bafaa/pr_source.png/340x340bb-80.png"

nil



35
36
37
 
# File 'lib/spaceship/tunes/application.rb', line 35

def app_icon_preview_url
  @app_icon_preview_url
end

#apple_id ⇒ String

Returns The App identifier of this app, provided by iTunes Connect.

Examples:

"1013943394"



7
8
9
 
# File 'lib/spaceship/tunes/application.rb', line 7

def apple_id
  @apple_id
end

#bundle_id ⇒ String

Returns The bundle_id (app identifier) of your app.

Examples:

"com.krausefx.app"



22
23
24
 
# File 'lib/spaceship/tunes/application.rb', line 22

def bundle_id
  @bundle_id
end

#issues_count ⇒ Integer 



28
29
30
 
# File 'lib/spaceship/tunes/application.rb', line 28

def issues_count
  @issues_count
end

#last_modified ⇒ String 



25
26
27
 
# File 'lib/spaceship/tunes/application.rb', line 25

def last_modified
  @last_modified
end

#name ⇒ String

Returns The name you provided for this app (in the default language).

Examples:

"Spaceship App"



12
13
14
 
# File 'lib/spaceship/tunes/application.rb', line 12

def name
  @name
end

#vendor_id ⇒ String

Returns The Vendor ID provided by iTunes Connect.

Examples:

"1435592086"



17
18
19
 
# File 'lib/spaceship/tunes/application.rb', line 17

def vendor_id
  @vendor_id
end

#version_sets ⇒ Array 



38
39
40
 
# File 'lib/spaceship/tunes/application.rb', line 38

def version_sets
  @version_sets
end

Class Method Details

.all ⇒ Array 



58
59
60
 
# File 'lib/spaceship/tunes/application.rb', line 58

def all
  client.applications.map { |application| self.factory(application) }
end

.create!(name: nil, primary_language: nil, version: nil, sku: nil, bundle_id: nil, bundle_id_suffix: nil, company_name: nil) ⇒ Object

Creates a new application on iTunes Connect It cannot be changed after you create your first app.



82
83
84
85
86
87
88
89
90
 
# File 'lib/spaceship/tunes/application.rb', line 82

def create!(name: nil, primary_language: nil, version: nil, sku: nil, bundle_id: nil, bundle_id_suffix: nil, company_name: nil)
  client.create_application!(name: name,
                 primary_language: primary_language,
                          version: version,
                              sku: sku,
                        bundle_id: bundle_id,
                        bundle_id_suffix: bundle_id_suffix,
                        company_name: company_name)
end

.factory(attrs) ⇒ Object

Create a new object based on a hash. This is used to create a new object based on the server response.



53
54
55
 
# File 'lib/spaceship/tunes/application.rb', line 53

def factory(attrs)
  return self.new(attrs)
end

.find(identifier) ⇒ Spaceship::Tunes::Application 



64
65
66
67
68
 
# File 'lib/spaceship/tunes/application.rb', line 64

def find(identifier)
  all.find do |app|
    (app.apple_id == identifier.to_s or app.bundle_id == identifier)
  end
end

Instance Method Details

#add_all_testers! ⇒ Object

Add all testers (internal and external) to the current app list



355
356
357
358
 
# File 'lib/spaceship/tunes/application.rb', line 355

def add_all_testers!
  Tunes::Tester.external.add_all_to_app!(self.apple_id)
  Tunes::Tester.internal.add_all_to_app!(self.apple_id)
end

#add_external_tester!(email: nil, first_name: nil, last_name: nil) ⇒ Object

Add external tester to the current app list, if it doesn’t exist will be created



388
389
390
391
392
393
394
395
 
# File 'lib/spaceship/tunes/application.rb', line 388

def add_external_tester!(email: nil, first_name: nil, last_name: nil)
  raise "Tester is already on #{self.name} betatesters" if find_external_tester(email)

  tester = Tunes::Tester.external.find(email) || Tunes::Tester.external.create!(email: email,
                                                                           first_name: first_name,
                                                                            last_name: last_name)
  tester.add_to_app!(self.apple_id)
end

#all_build_train_numbers(platform: nil) ⇒ Array

The numbers of all build trains that were uploaded



249
250
251
252
253
 
# File 'lib/spaceship/tunes/application.rb', line 249

def all_build_train_numbers(platform: nil)
  client.all_build_trains(app_id: self.apple_id, platform: platform).fetch("trains").collect do |current|
    current["versionString"]
  end
end

#all_builds_for_train(train: nil, platform: nil) ⇒ Object

Receive the build details for a specific build useful if the app is not listed in the TestFlight build list which might happen if you don’t use TestFlight This is used to receive dSYM files from Apple



259
260
261
262
263
264
 
# File 'lib/spaceship/tunes/application.rb', line 259

def all_builds_for_train(train: nil, platform: nil)
  client.all_builds_for_train(app_id: self.apple_id, train: train, platform: platform).fetch("items", []).collect do |attrs|
    attrs[:apple_id] = self.apple_id
    Tunes::Build.factory(attrs)
  end
end

#all_invalid_builds(platform: nil) ⇒ Array 



267
268
269
270
271
272
273
274
275
 
# File 'lib/spaceship/tunes/application.rb', line 267

def all_invalid_builds(platform: nil)
  builds = []

  self.build_trains(platform: platform).values.each do |train|
    builds.concat(train.invalid_builds)
  end

  return builds
end

#all_processing_builds(platform: nil) ⇒ Array 



279
280
281
282
283
284
285
286
287
 
# File 'lib/spaceship/tunes/application.rb', line 279

def all_processing_builds(platform: nil)
  builds = []

  self.build_trains(platform: platform).each do |version_number, train|
    builds.concat(train.processing_builds)
  end

  return builds
end

#build_trains(platform: nil) ⇒ Hash

TestFlight: A reference to all the build trains



243
244
245
 
# File 'lib/spaceship/tunes/application.rb', line 243

def build_trains(platform: nil)
  Tunes::BuildTrain.all(self, self.apple_id, platform: platform)
end

#builds(platform: nil) ⇒ Object

Get all builds that are already processed for all build trains You can either use the return value (array) or pass a block



291
292
293
294
295
296
297
298
299
300
 
# File 'lib/spaceship/tunes/application.rb', line 291

def builds(platform: nil)
  all_builds = []
  self.build_trains(platform: platform).each do |version_number, train|
    train.builds.each do |build|
      yield(build) if block_given?
      all_builds << build unless block_given?
    end
  end
  all_builds
end

#cancel_all_testflight_submissions! ⇒ Object

Cancels all ongoing TestFlight beta submission for this application



316
317
318
319
320
321
322
323
324
325
 
# File 'lib/spaceship/tunes/application.rb', line 316

def cancel_all_testflight_submissions!
  self.builds do |build|
    begin
      build.cancel_beta_review!
    rescue
      # We really don't care about any errors here
    end
  end
  true
end

#create_submission ⇒ Object 



306
307
308
309
310
311
312
313
 
# File 'lib/spaceship/tunes/application.rb', line 306

def create_submission
  version = self.latest_version
  if version.nil?
    raise "Could not find a valid version to submit for review"
  end

  Spaceship::AppSubmission.create(self, version)
end

#create_version!(version_number, platform: nil) ⇒ Object

Create a new version of your app Since we have stored the outdated raw_data, we need to refresh this object otherwise ‘edit_version` will return nil



198
199
200
201
202
203
204
205
206
 
# File 'lib/spaceship/tunes/application.rb', line 198

def create_version!(version_number, platform: nil)
  if edit_version(platform: platform)
    raise "Cannot create a new version for this app as there already is an `edit_version` available"
  end

  client.create_version!(apple_id, version_number, platform.nil? ? 'ios' : platform)

  # Future: implemented -reload method
end

#details ⇒ Object 



176
177
178
179
180
 
# File 'lib/spaceship/tunes/application.rb', line 176

def details
  attrs = client.app_details(apple_id)
  attrs[:application] = self
  Tunes::AppDetails.factory(attrs)
end

#edit_version(platform: nil) ⇒ Spaceship::AppVersion 



111
112
113
 
# File 'lib/spaceship/tunes/application.rb', line 111

def edit_version(platform: nil)
  Spaceship::AppVersion.find(self, self.apple_id, false, platform: platform)
end

#ensure_not_a_bundle ⇒ Object

private to module



426
427
428
429
 
# File 'lib/spaceship/tunes/application.rb', line 426

def ensure_not_a_bundle
  # we only support applications
  raise "We do not support BUNDLE types right now" if self.type == 'BUNDLE'
end

#ensure_version!(version_number, platform: nil) ⇒ Bool

Will make sure the current edit_version matches the given version number This will either create a new version or change the version number from an existing version



212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/spaceship/tunes/application.rb', line 212

def ensure_version!(version_number, platform: nil)
  if (e = edit_version(platform: platform))
    if e.version.to_s != version_number.to_s
      # Update an existing version
      e.version = version_number
      e.save!
      return true
    end
    return false
  else
    create_version!(version_number, platform: platform)
    return true
  end
end

#external_testers ⇒ Array 



361
362
363
 
# File 'lib/spaceship/tunes/application.rb', line 361

def external_testers
  Tunes::Tester.external.all_by_app(self.apple_id)
end

#find_external_tester(identifier) ⇒ Spaceship::Tunes::Tester.external 



373
374
375
 
# File 'lib/spaceship/tunes/application.rb', line 373

def find_external_tester(identifier)
  Tunes::Tester.external.find_by_app(self.apple_id, identifier)
end

#find_internal_tester(identifier) ⇒ Spaceship::Tunes::Tester.internal 



380
381
382
 
# File 'lib/spaceship/tunes/application.rb', line 380

def find_internal_tester(identifier)
  Tunes::Tester.internal.find_by_app(self.apple_id, identifier)
end

#internal_testers ⇒ Array 



366
367
368
 
# File 'lib/spaceship/tunes/application.rb', line 366

def internal_testers
  Tunes::Tester.internal.all_by_app(self.apple_id)
end

#latest_version(platform: nil) ⇒ Spaceship::AppVersion 



117
118
119
 
# File 'lib/spaceship/tunes/application.rb', line 117

def latest_version(platform: nil)
  edit_version(platform: platform) || live_version(platform: platform)
end

#live_version(platform: nil) ⇒ Spaceship::AppVersion 



106
107
108
 
# File 'lib/spaceship/tunes/application.rb', line 106

def live_version(platform: nil)
  Spaceship::AppVersion.find(self, self.apple_id, true, platform: platform)
end

#platform ⇒ Object

kept for backward compatibility tries to guess the platform of the currently submitted apps note that as ITC now supports multiple app types, this might break if your app supports more than one



163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/spaceship/tunes/application.rb', line 163

def platform
  if self.version_sets.nil?
    raise 'The application has no version sets and Spaceship does not know what to do here.'
  end

  if self.version_sets.length == 1
    version_sets[0].platform
  elsif self.platforms == %w(ios appletvos)
    'ios'
  end
  Spaceship::Tunes::AppVersionCommon.find_platform(raw_data['versionSets'])['platformString']
end

#platforms ⇒ Object 



139
140
141
142
143
144
145
 
# File 'lib/spaceship/tunes/application.rb', line 139

def platforms
  platforms = []
  version_sets.each do |version_set|
    platforms << version_set.platform
  end
  platforms
end

#price_tier ⇒ Object

The current price tier



233
234
235
 
# File 'lib/spaceship/tunes/application.rb', line 233

def price_tier
  client.price_tier(self.apple_id)
end

#promocodes ⇒ Object 



411
412
413
414
415
416
 
# File 'lib/spaceship/tunes/application.rb', line 411

def promocodes
  data = client.app_promocodes(app_id: self.apple_id)
  data.map do |attrs|
    Tunes::AppVersionPromocodes.factory(attrs)
  end
end

#promocodes_history ⇒ Object 



418
419
420
421
422
423
 
# File 'lib/spaceship/tunes/application.rb', line 418

def promocodes_history
  data = client.app_promocodes_history(app_id: self.apple_id)
  data.map do |attrs|
    Tunes::AppVersionGeneratedPromocodes.factory(attrs)
  end
end

#ratings ⇒ Object 



133
134
135
136
137
 
# File 'lib/spaceship/tunes/application.rb', line 133

def ratings
  attrs = client.get_rating_summary(apple_id, platform)
  attrs[:application] = self
  Tunes::AppRatings.factory(attrs)
end

#release! ⇒ Object 



331
332
333
334
335
336
337
 
# File 'lib/spaceship/tunes/application.rb', line 331

def release!
  version = self.edit_version
  if version.nil?
    raise "Could not find a valid version to release"
  end
  version.release!
end

#remove_external_tester!(identifier) ⇒ Object

Remove external tester from the current app list that matching the parameter

as either the Tester id or email



400
401
402
403
404
405
406
 
# File 'lib/spaceship/tunes/application.rb', line 400

def remove_external_tester!(identifier)
  tester = find_external_tester(identifier)

  raise "Tester is not on #{self.name} betatesters" unless tester

  tester.remove_from_app!(self.apple_id)
end

#resolution_center ⇒ Hash 



129
130
131
 
# File 'lib/spaceship/tunes/application.rb', line 129

def resolution_center
  client.get_resolution_center(apple_id, platform)
end

#setup ⇒ Object 



342
343
344
345
346
347
348
 
# File 'lib/spaceship/tunes/application.rb', line 342

def setup
  super
  @version_sets = (self.raw_data['versionSets'] || []).map do |attrs|
    attrs[:application] = self
    Tunes::VersionSet.factory(attrs)
  end
end

#type ⇒ Object 



147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/spaceship/tunes/application.rb', line 147

def type
  if self.version_sets.nil?
    raise 'The application has no version sets and Spaceship does not know what to do here.'
  end

  if self.version_sets.length == 1
    version_sets[0].platform
  end
  platform = Spaceship::Tunes::AppVersionCommon.find_platform(raw_data['versionSets'])
  platform['type']
end

#update_price_tier!(price_tier) ⇒ Object

set the price tier. This method doesn’t require ‘save` to be called



228
229
230
 
# File 'lib/spaceship/tunes/application.rb', line 228

def update_price_tier!(price_tier)
  client.update_price_tier!(self.apple_id, price_tier)
end

#url ⇒ String 



122
123
124
 
# File 'lib/spaceship/tunes/application.rb', line 122

def url
  "https://itunesconnect.apple.com/WebObjects/iTunesConnect.woa/ra/ng/app/#{self.apple_id}"
end

#version_set_for_platform(platform) ⇒ Object 



97
98
99
100
101
102
 
# File 'lib/spaceship/tunes/application.rb', line 97

def version_set_for_platform(platform)
  version_sets.each do |version_set|
    return version_set if version_set.platform == platform
  end
  nil
end

#versions_history ⇒ Object 



182
183
184
185
186
187
188
189
 
# File 'lib/spaceship/tunes/application.rb', line 182

def versions_history
  ensure_not_a_bundle
  versions = client.versions_history(apple_id, platform)
  versions.map do |attrs|
    attrs[:application] = self
    Tunes::AppVersionHistory.factory(attrs)
  end
end