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

General collapse

Testers 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

Returns:

  • (String) —

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



40
41
42
 
# File 'lib/spaceship/tunes/application.rb', line 40

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"

Returns:

  • (String) —

    The App identifier of this app, provided by iTunes Connect



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"

Returns:

  • (String) —

    The bundle_id (app identifier) of your app



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

def bundle_id
  @bundle_id
end

#issues_count ⇒ Integer

Returns The number of issues provided by iTunes Connect.

Returns:

  • (Integer) —

    The number of issues provided by iTunes Connect



33
34
35
 
# File 'lib/spaceship/tunes/application.rb', line 33

def issues_count
  @issues_count
end

#last_modified ⇒ String

Returns Last modified.

Returns:



30
31
32
 
# File 'lib/spaceship/tunes/application.rb', line 30

def last_modified
  @last_modified
end

#name ⇒ String

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

Examples:

"Spaceship App"

Returns:

  • (String) —

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



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

def name
  @name
end

#platform ⇒ String

Returns the supported platform of this app.

Examples:

"ios"

Returns:

  • (String) —

    the supported platform of this app



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

def platform
  @platform
end

#vendor_id ⇒ String

Returns The Vendor ID provided by iTunes Connect.

Examples:

"1435592086"

Returns:

  • (String) —

    The Vendor ID provided by iTunes Connect



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

def vendor_id
  @vendor_id
end

Class Method Details

.all ⇒ Array

Returns all apps available for this account

Returns:

  • (Array) —

    Returns all apps available for this account



61
62
63
 
# File 'lib/spaceship/tunes/application.rb', line 61

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.

Parameters:

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

    : The name of your app as it will appear on the App Store. This can’t be longer than 255 characters.

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

    : If localized app information isn’t available in an App Store territory, the information from your primary language will be used instead.

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

    : The version number is shown on the App Store and should match the one you used in Xcode.

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

    : A unique ID for your app that is not visible on the App Store.

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

    : The bundle ID must match the one you used in Xcode. It can’t be changed after you submit your first build.

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

    : The company name or developer name to display on the App Store for your apps.



85
86
87
88
89
90
91
92
93
 
# File 'lib/spaceship/tunes/application.rb', line 85

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.



56
57
58
 
# File 'lib/spaceship/tunes/application.rb', line 56

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

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

Returns the application matching the parameter as either the App ID or the bundle identifier

Returns:



67
68
69
70
71
 
# File 'lib/spaceship/tunes/application.rb', line 67

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



286
287
288
289
 
# File 'lib/spaceship/tunes/application.rb', line 286

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

Parameters:

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

    (required): The email of the tester

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

    (optional): The first name of the tester (Ignored if user already exist)

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

    (optional): The last name of the tester (Ignored if user already exist)



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

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_processing_builds ⇒ Array

Returns This will return an array of all processing builds this include pre-processing or standard processing.

Returns:

  • (Array) —

    This will return an array of all processing builds this include pre-processing or standard processing



225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/spaceship/tunes/application.rb', line 225

def all_processing_builds
  builds = self.pre_processing_builds

  self.build_trains.each do |version_number, train|
    train.processing_builds.each do |build|
      builds << build
    end
  end

  return builds
end

#build_trains ⇒ Hash

A reference to all the build trains

Returns:

  • (Hash) —

    a hash, the version number being the key



203
204
205
 
# File 'lib/spaceship/tunes/application.rb', line 203

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

#builds ⇒ Object

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



239
240
241
242
243
244
245
246
247
248
 
# File 'lib/spaceship/tunes/application.rb', line 239

def builds
  all_builds = []
  self.build_trains.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



264
265
266
267
268
269
270
271
272
273
 
# File 'lib/spaceship/tunes/application.rb', line 264

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 



254
255
256
257
258
259
260
261
 
# File 'lib/spaceship/tunes/application.rb', line 254

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



158
159
160
161
162
163
164
165
166
 
# File 'lib/spaceship/tunes/application.rb', line 158

def create_version!(version_number)
  if edit_version
    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)

  # Future: implemented -reload method
end

#details ⇒ Object 



145
146
147
148
149
 
# File 'lib/spaceship/tunes/application.rb', line 145

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

#edit_version ⇒ Spaceship::AppVersion

Returns Receive the version that can fully be edited.

Returns:



114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/spaceship/tunes/application.rb', line 114

def edit_version
  if raw_data['versions'].count == 1
    v = raw_data['versions'].last

    # this only applies for the initial version
    unless ['Prepare for Upload', 'Developer Rejected', 'Rejected', 'prepareForUpload'].include?(v['state'])
      return nil # only live version, user should create a new version
    end
  end

  Spaceship::AppVersion.find(self, self.apple_id, false)
end

#ensure_version!(version_number) ⇒ 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

Returns:

  • (Bool) —

    Was something changed?



172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/spaceship/tunes/application.rb', line 172

def ensure_version!(version_number)
  if (e = edit_version)
    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)
    return true
  end
end

#external_testers ⇒ Array

Returns all external testers available for this app

Returns:

  • (Array) —

    Returns all external testers available for this app



292
293
294
 
# File 'lib/spaceship/tunes/application.rb', line 292

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

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

Returns the external tester matching the parameter as either the Tester id or email

Parameters:

  • identifier (String) —

    (required): Value used to filter the tester

Returns:

  • (Spaceship::Tunes::Tester.external) —

    Returns the external tester matching the parameter as either the Tester id or email



304
305
306
 
# File 'lib/spaceship/tunes/application.rb', line 304

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

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

Returns the internal tester matching the parameter as either the Tester id or email

Parameters:

  • identifier (String) —

    (required): Value used to filter the tester

Returns:

  • (Spaceship::Tunes::Tester.internal) —

    Returns the internal tester matching the parameter as either the Tester id or email



311
312
313
 
# File 'lib/spaceship/tunes/application.rb', line 311

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

#internal_testers ⇒ Array

Returns all internal testers available for this app

Returns:

  • (Array) —

    Returns all internal testers available for this app



297
298
299
 
# File 'lib/spaceship/tunes/application.rb', line 297

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

#latest_version ⇒ Spaceship::AppVersion

Returns This will return the ‘edit_version` if available and fallback to the `edit_version`. Use this to just access the latest data.

Returns:

  • (Spaceship::AppVersion) —

    This will return the ‘edit_version` if available and fallback to the `edit_version`. Use this to just access the latest data



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

def latest_version
  edit_version || live_version
end

#live_version ⇒ Spaceship::AppVersion

Returns Receive the version that is currently live on the App Store. You can’t modify all values there, so be careful.

Returns:

  • (Spaceship::AppVersion) —

    Receive the version that is currently live on the App Store. You can’t modify all values there, so be careful.



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

def live_version
  if raw_data['versions'].count == 1
    v = raw_data['versions'].last
    if ['Prepare for Upload', 'prepareForUpload'].include?(v['state']) # this only applies for the initial version
      return nil
    end
  end

  Spaceship::AppVersion.find(self, self.apple_id, true)
end

#pre_processing_builds ⇒ Array

Returns A list of binaries which are not even yet processing based on the version These are all build that have no information except the upload date Those builds can also be the builds that are stuck on iTC.

Returns:

  • (Array) —

    A list of binaries which are not even yet processing based on the version These are all build that have no information except the upload date Those builds can also be the builds that are stuck on iTC.



210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/spaceship/tunes/application.rb', line 210

def pre_processing_builds
  data = client.build_trains(apple_id, 'internal') # we need to fetch all trains here to get the builds

  builds = data.fetch('processingBuilds', []).collect do |attrs|
    attrs.merge!(build_train: self)
    Tunes::ProcessingBuild.factory(attrs)
  end

  builds.delete_if { |a| a.state == "ITC.apps.betaProcessingStatus.InvalidBinary" }

  builds
end

#price_tier ⇒ Object

The current price tier



193
194
195
 
# File 'lib/spaceship/tunes/application.rb', line 193

def price_tier
  client.price_tier(self.apple_id)
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

Parameters:

  • identifier (String) —

    (required): Value used to filter the tester



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

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

Returns Contains the reason for rejection. if everything is alright, the result will be ‘“sectionInfoKeys”=>[], “sectionWarningKeys”=>[], “replyConstraints”=>{“minLength”=>1, “maxLength”=>4000, “appNotes”=>“threads”=>[], “betaNotes”=>“threads”=>[], “appMessages”=>“threads”=>[]}`.

Returns:

  • (Hash) —

    Contains the reason for rejection. if everything is alright, the result will be ‘“sectionInfoKeys”=>[], “sectionWarningKeys”=>[], “replyConstraints”=>{“minLength”=>1, “maxLength”=>4000, “appNotes”=>“threads”=>[], “betaNotes”=>“threads”=>[], “appMessages”=>“threads”=>[]}`



141
142
143
 
# File 'lib/spaceship/tunes/application.rb', line 141

def resolution_center
  client.get_resolution_center(apple_id)
end

#setup ⇒ Object 



278
279
 
# File 'lib/spaceship/tunes/application.rb', line 278

def setup
end

#update_price_tier!(price_tier) ⇒ Object

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



188
189
190
 
# File 'lib/spaceship/tunes/application.rb', line 188

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

#url ⇒ String

Returns An URL to this specific resource. You can enter this URL into your browser.

Returns:

  • (String) —

    An URL to this specific resource. You can enter this URL into your browser



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

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