Class: Spaceship::Tunes::Application
- Defined in:
- spaceship/lib/spaceship/tunes/application.rb
Instance Attribute Summary collapse
-
#app_icon_preview_url ⇒ String
The URL to a low resolution app icon of this app (340x340px).
-
#apple_id ⇒ String
The App identifier of this app, provided by App Store Connect.
-
#bundle_id ⇒ String
The bundle_id (app identifier) of your app.
-
#issues_count ⇒ Integer
The number of issues provided by App Store Connect.
-
#last_modified ⇒ String
Last modified.
-
#name ⇒ String
The name you provided for this app (in the default language).
-
#vendor_id ⇒ String
The Vendor ID provided by App Store Connect.
-
#version_sets ⇒ Array
An array of all versions sets.
Attributes inherited from Base
Getting information collapse
- #analytics ⇒ Object
- #details ⇒ Object
-
#edit_version(platform: nil) ⇒ Spaceship::Tunes::AppVersion
Receive the version that can fully be edited.
-
#latest_version(platform: nil) ⇒ Spaceship::Tunes::AppVersion
This will return the ‘edit_version` if available and fallback to the `live_version`.
-
#live_version(platform: nil) ⇒ Spaceship::Tunes::AppVersion
Receive the version that is currently live on the App Store.
-
#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.
- #platforms ⇒ Object
- #ratings(version_id: '', storefront: '') ⇒ Object
-
#resolution_center ⇒ Hash
Contains the reason for rejection.
- #type ⇒ Object
-
#url ⇒ String
An URL to this specific resource.
- #version_set_for_platform(platform) ⇒ Object
- #versions_history ⇒ Object
Modifying collapse
-
#availability ⇒ Object
The current availability.
-
#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.
-
#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.
-
#price_tier ⇒ Object
The current price tier.
- #reject_version_if_possible! ⇒ Object
-
#update_availability!(availability) ⇒ Object
set the availability.
-
#update_price_tier!(price_tier) ⇒ Object
set the price tier.
in_app_purchases collapse
-
#in_app_purchases ⇒ Object
Get base In-App-Purchases object.
Builds collapse
-
#all_build_train_numbers(platform: nil) ⇒ Array
The numbers of all build trains that were uploaded.
-
#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.
-
#all_processing_builds(platform: nil) ⇒ Array
This will return an array of all processing builds this include pre-processing or standard processing.
-
#build_trains(platform: nil) ⇒ Hash
TestFlight: A reference to all the build trains.
-
#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.
- #tunes_all_build_trains(app_id: nil, platform: nil) ⇒ Object
- #tunes_all_builds_for_train(train: nil, platform: nil) ⇒ Object
- #tunes_build_details(train: nil, build_number: nil, platform: nil) ⇒ Object
Submit for Review collapse
-
#cancel_all_testflight_submissions! ⇒ Object
Cancels all ongoing TestFlight beta submission for this application.
- #create_submission ⇒ Object
release collapse
General collapse
Testers collapse
Promo codes collapse
-
#ensure_not_a_bundle ⇒ Object
private to module.
- #promocodes ⇒ Object
- #promocodes_history ⇒ Object
Class Method Summary collapse
-
.all ⇒ Array
Returns all apps available for this account.
-
.create!(name: nil, primary_language: nil, version: nil, sku: nil, bundle_id: nil, bundle_id_suffix: nil, company_name: nil, platform: nil, itunes_connect_users: nil) ⇒ Object
Creates a new application on App Store Connect It cannot be changed after you create your first app.
-
.find(identifier, mac: false) ⇒ Spaceship::Tunes::Application
Returns the application matching the parameter as either the App ID or the bundle identifier.
Methods inherited from TunesBase
Methods inherited from Base
attr_accessor, attr_mapping, attributes, #attributes, factory, #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.
49 50 51 |
# File 'spaceship/lib/spaceship/tunes/application.rb', line 49 def app_icon_preview_url @app_icon_preview_url end |
#apple_id ⇒ String
Returns The App identifier of this app, provided by App Store Connect.
21 22 23 |
# File 'spaceship/lib/spaceship/tunes/application.rb', line 21 def apple_id @apple_id end |
#bundle_id ⇒ String
Returns The bundle_id (app identifier) of your app.
36 37 38 |
# File 'spaceship/lib/spaceship/tunes/application.rb', line 36 def bundle_id @bundle_id end |
#issues_count ⇒ Integer
Returns The number of issues provided by App Store Connect.
42 43 44 |
# File 'spaceship/lib/spaceship/tunes/application.rb', line 42 def issues_count @issues_count end |
#last_modified ⇒ String
Returns Last modified.
39 40 41 |
# File 'spaceship/lib/spaceship/tunes/application.rb', line 39 def last_modified @last_modified end |
#name ⇒ String
Returns The name you provided for this app (in the default language).
26 27 28 |
# File 'spaceship/lib/spaceship/tunes/application.rb', line 26 def name @name end |
#vendor_id ⇒ String
Returns The Vendor ID provided by App Store Connect.
31 32 33 |
# File 'spaceship/lib/spaceship/tunes/application.rb', line 31 def vendor_id @vendor_id end |
#version_sets ⇒ Array
Returns An array of all versions sets.
52 53 54 |
# File 'spaceship/lib/spaceship/tunes/application.rb', line 52 def version_sets @version_sets end |
Class Method Details
.all ⇒ Array
Returns all apps available for this account
66 67 68 |
# File 'spaceship/lib/spaceship/tunes/application.rb', line 66 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, platform: nil, itunes_connect_users: nil) ⇒ Object
Creates a new application on App Store Connect It cannot be changed after you create your first app.
94 95 96 97 98 99 100 101 102 103 104 |
# File 'spaceship/lib/spaceship/tunes/application.rb', line 94 def create!(name: nil, primary_language: nil, version: nil, sku: nil, bundle_id: nil, bundle_id_suffix: nil, company_name: nil, platform: nil, itunes_connect_users: nil) puts("The `version` parameter is deprecated. Use `ensure_version!` method instead") if version client.create_application!(name: name, primary_language: primary_language, sku: sku, bundle_id: bundle_id, bundle_id_suffix: bundle_id_suffix, company_name: company_name, platform: platform, itunes_connect_users: itunes_connect_users) end |
.find(identifier, mac: false) ⇒ Spaceship::Tunes::Application
Returns the application matching the parameter as either the App ID or the bundle identifier
72 73 74 75 76 77 |
# File 'spaceship/lib/spaceship/tunes/application.rb', line 72 def find(identifier, mac: false) all.find do |app| ((app.apple_id && app.apple_id.casecmp(identifier.to_s) == 0) || (app.bundle_id && app.bundle_id.casecmp(identifier.to_s) == 0)) && app.version_sets.any? { |v| (mac ? ["osx"] : ["ios", "appletvos"]).include?(v.platform) } end end |
Instance Method Details
#all_build_train_numbers(platform: nil) ⇒ Array
The numbers of all build trains that were uploaded
302 303 304 |
# File 'spaceship/lib/spaceship/tunes/application.rb', line 302 def all_build_train_numbers(platform: nil) return self.build_trains(platform: platform || self.platform).versions 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
310 311 312 |
# File 'spaceship/lib/spaceship/tunes/application.rb', line 310 def all_builds_for_train(train: nil, platform: nil) return TestFlight::Build.builds_for_train(app_id: self.apple_id, platform: platform || self.platform, train_version: train) end |
#all_processing_builds(platform: nil) ⇒ Array
Returns This will return an array of all processing builds this include pre-processing or standard processing.
316 317 318 |
# File 'spaceship/lib/spaceship/tunes/application.rb', line 316 def all_processing_builds(platform: nil) return TestFlight::Build.all_processing_builds(app_id: self.apple_id, platform: platform || self.platform) end |
#analytics ⇒ Object
140 141 142 143 144 145 146 147 148 |
# File 'spaceship/lib/spaceship/tunes/application.rb', line 140 def analytics if self.live_version.nil? raise 'Analytics are only available for live apps.' end attrs = {} attrs[:apple_id] = self.apple_id Spaceship::Tunes::AppAnalytics.factory(attrs) end |
#availability ⇒ Object
The current availability.
276 277 278 |
# File 'spaceship/lib/spaceship/tunes/application.rb', line 276 def availability client.availability(self.apple_id) end |
#build_trains(platform: nil) ⇒ Hash
TestFlight: A reference to all the build trains
296 297 298 |
# File 'spaceship/lib/spaceship/tunes/application.rb', line 296 def build_trains(platform: nil) TestFlight::BuildTrains.all(app_id: self.apple_id, platform: platform || self.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
346 347 348 349 350 |
# File 'spaceship/lib/spaceship/tunes/application.rb', line 346 def builds(platform: nil) all = TestFlight::Build.all(app_id: self.apple_id, platform: platform || self.platform) return all unless block_given? all.each { |build| yield(build) } end |
#cancel_all_testflight_submissions! ⇒ Object
Cancels all ongoing TestFlight beta submission for this application
366 367 368 369 370 371 372 373 374 375 |
# File 'spaceship/lib/spaceship/tunes/application.rb', line 366 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
356 357 358 359 360 361 362 363 |
# File 'spaceship/lib/spaceship/tunes/application.rb', line 356 def create_submission version = self.latest_version if version.nil? raise "Could not find a valid version to submit for review" end Spaceship::Tunes::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
222 223 224 225 226 227 228 229 230 |
# File 'spaceship/lib/spaceship/tunes/application.rb', line 222 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 |
#default_external_group ⇒ Object
404 405 406 |
# File 'spaceship/lib/spaceship/tunes/application.rb', line 404 def default_external_group TestFlight::Group.default_external_group(app_id: self.apple_id) end |
#details ⇒ Object
200 201 202 203 204 |
# File 'spaceship/lib/spaceship/tunes/application.rb', line 200 def details attrs = client.app_details(apple_id) attrs[:application] = self Tunes::AppDetails.factory(attrs) end |
#edit_version(platform: nil) ⇒ Spaceship::Tunes::AppVersion
Returns Receive the version that can fully be edited.
125 126 127 |
# File 'spaceship/lib/spaceship/tunes/application.rb', line 125 def edit_version(platform: nil) Spaceship::Tunes::AppVersion.find(self, self.apple_id, false, platform: platform) end |
#ensure_not_a_bundle ⇒ Object
private to module
426 427 428 429 |
# File 'spaceship/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
236 237 238 239 240 241 242 243 244 245 246 247 248 249 |
# File 'spaceship/lib/spaceship/tunes/application.rb', line 236 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 |
#in_app_purchases ⇒ Object
Get base In-App-Purchases object
284 285 286 287 288 |
# File 'spaceship/lib/spaceship/tunes/application.rb', line 284 def in_app_purchases attrs = {} attrs[:application] = self Tunes::IAP.factory(attrs) end |
#latest_version(platform: nil) ⇒ Spaceship::Tunes::AppVersion
Returns This will return the ‘edit_version` if available and fallback to the `live_version`. Use this to just access the latest data.
131 132 133 |
# File 'spaceship/lib/spaceship/tunes/application.rb', line 131 def latest_version(platform: nil) edit_version(platform: platform) || live_version(platform: platform) end |
#live_version(platform: nil) ⇒ Spaceship::Tunes::AppVersion
Returns Receive the version that is currently live on the App Store. You can’t modify all values there, so be careful.
120 121 122 |
# File 'spaceship/lib/spaceship/tunes/application.rb', line 120 def live_version(platform: nil) Spaceship::Tunes::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
187 188 189 190 191 192 193 194 195 196 197 198 |
# File 'spaceship/lib/spaceship/tunes/application.rb', line 187 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
163 164 165 166 167 168 169 |
# File 'spaceship/lib/spaceship/tunes/application.rb', line 163 def platforms platforms = [] version_sets.each do |version_set| platforms << version_set.platform end platforms end |
#price_tier ⇒ Object
The current price tier
266 267 268 |
# File 'spaceship/lib/spaceship/tunes/application.rb', line 266 def price_tier client.price_tier(self.apple_id) end |
#promocodes ⇒ Object
411 412 413 414 415 416 |
# File 'spaceship/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 'spaceship/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(version_id: '', storefront: '') ⇒ Object
157 158 159 160 161 |
# File 'spaceship/lib/spaceship/tunes/application.rb', line 157 def (version_id: '', storefront: '') attrs = client.(apple_id, platform, version_id, storefront) attrs[:application] = self Tunes::AppRatings.new(attrs) end |
#reject_version_if_possible! ⇒ Object
251 252 253 254 255 256 257 258 |
# File 'spaceship/lib/spaceship/tunes/application.rb', line 251 def reject_version_if_possible! can_reject = edit_version.can_reject_version if can_reject client.reject!(apple_id, edit_version.version_id) end return can_reject end |
#release! ⇒ Object
381 382 383 384 385 386 387 |
# File 'spaceship/lib/spaceship/tunes/application.rb', line 381 def release! version = self.edit_version if version.nil? raise "Could not find a valid version to release" end version.release! 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”=>[]}`.
153 154 155 |
# File 'spaceship/lib/spaceship/tunes/application.rb', line 153 def resolution_center client.get_resolution_center(apple_id, platform) end |
#setup ⇒ Object
392 393 394 395 396 397 398 |
# File 'spaceship/lib/spaceship/tunes/application.rb', line 392 def setup super @version_sets = (self.raw_data['versionSets'] || []).map do |attrs| attrs[:application] = self Tunes::VersionSet.factory(attrs) end end |
#tunes_all_build_trains(app_id: nil, platform: nil) ⇒ Object
320 321 322 323 324 325 326 327 |
# File 'spaceship/lib/spaceship/tunes/application.rb', line 320 def tunes_all_build_trains(app_id: nil, platform: nil) resp = client.all_build_trains(app_id: apple_id, platform: platform) trains = resp["trains"] or [] trains.map do |attrs| attrs['application'] = self Tunes::BuildTrain.factory(attrs) end end |
#tunes_all_builds_for_train(train: nil, platform: nil) ⇒ Object
329 330 331 332 333 334 335 336 |
# File 'spaceship/lib/spaceship/tunes/application.rb', line 329 def tunes_all_builds_for_train(train: nil, platform: nil) resp = client.all_builds_for_train(app_id: apple_id, train: train, platform: platform) items = resp["items"] or [] items.map do |attrs| attrs['apple_id'] = apple_id Tunes::Build.factory(attrs) end end |
#tunes_build_details(train: nil, build_number: nil, platform: nil) ⇒ Object
338 339 340 341 342 |
# File 'spaceship/lib/spaceship/tunes/application.rb', line 338 def tunes_build_details(train: nil, build_number: nil, platform: nil) resp = client.build_details(app_id: apple_id, train: train, build_number: build_number, platform: platform) resp['apple_id'] = apple_id Tunes::BuildDetails.factory(resp) end |
#type ⇒ Object
171 172 173 174 175 176 177 178 179 180 181 |
# File 'spaceship/lib/spaceship/tunes/application.rb', line 171 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_availability!(availability) ⇒ Object
set the availability. This method doesn’t require ‘save` to be called
271 272 273 |
# File 'spaceship/lib/spaceship/tunes/application.rb', line 271 def update_availability!(availability) client.update_availability!(self.apple_id, availability) end |
#update_price_tier!(price_tier) ⇒ Object
set the price tier. This method doesn’t require ‘save` to be called
261 262 263 |
# File 'spaceship/lib/spaceship/tunes/application.rb', line 261 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.
136 137 138 |
# File 'spaceship/lib/spaceship/tunes/application.rb', line 136 def url "https://itunesconnect.apple.com/WebObjects/iTunesConnect.woa/ra/ng/app/#{self.apple_id}" end |
#version_set_for_platform(platform) ⇒ Object
111 112 113 114 115 116 |
# File 'spaceship/lib/spaceship/tunes/application.rb', line 111 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
206 207 208 209 210 211 212 213 |
# File 'spaceship/lib/spaceship/tunes/application.rb', line 206 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 |