Class: Spaceship::ConnectAPI::App

Inherits:
Object
  • Object
show all
Includes:
Model
Defined in:
spaceship/lib/spaceship/connect_api/models/app.rb

Defined Under Namespace

Modules: ContentRightsDeclaration, DistributionType, EducationDiscountType

Constant Summary collapse

ESSENTIAL_INCLUDES = 
[
  "appStoreVersions",
  "prices"
].join(",")

Instance Attribute Summary collapse

Attributes included from Model

#id, #reverse_attr_map

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Model

#attr_mapping, included, #initialize, #reverse_attr_mapping, #to_json, #update_attributes

Instance Attribute Details

#app_store_versions ⇒ Object

Returns the value of attribute app_store_versions.



18
19
20
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 18

def app_store_versions
  @app_store_versions
end

#available_in_new_territories ⇒ Object

Returns the value of attribute available_in_new_territories.



16
17
18
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 16

def available_in_new_territories
  @available_in_new_territories
end

#bundle_id ⇒ Object

Returns the value of attribute bundle_id.



10
11
12
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 10

def bundle_id
  @bundle_id
end

#content_rights_declaration ⇒ Object

Returns the value of attribute content_rights_declaration.



17
18
19
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 17

def content_rights_declaration
  @content_rights_declaration
end

#distribution_type ⇒ Object

Only available with Apple ID auth



22
23
24
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 22

def distribution_type
  @distribution_type
end

#educationDiscountType ⇒ Object

Returns the value of attribute educationDiscountType.



23
24
25
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 23

def educationDiscountType
  @educationDiscountType
end

#is_aag ⇒ Object

Returns the value of attribute is_aag.



15
16
17
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 15

def is_aag
  @is_aag
end

#is_opted_in_to_distribute_ios_app_on_mac_app_store ⇒ Object

Returns the value of attribute is_opted_in_to_distribute_ios_app_on_mac_app_store.



13
14
15
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 13

def is_opted_in_to_distribute_ios_app_on_mac_app_store
  @is_opted_in_to_distribute_ios_app_on_mac_app_store
end

#name ⇒ Object

Returns the value of attribute name.



9
10
11
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 9

def name
  @name
end

#prices ⇒ Object

Returns the value of attribute prices.



19
20
21
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 19

def prices
  @prices
end

#primary_locale ⇒ Object

Returns the value of attribute primary_locale.



12
13
14
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 12

def primary_locale
  @primary_locale
end

#removed ⇒ Object

Returns the value of attribute removed.



14
15
16
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 14

def removed
  @removed
end

#sku ⇒ Object

Returns the value of attribute sku.



11
12
13
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 11

def sku
  @sku
end

Class Method Details

.all(client: nil, filter: {}, includes: ESSENTIAL_INCLUDES, limit: nil, sort: nil) ⇒ Object

Apps



72
73
74
75
76
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 72

def self.all(client: nil, filter: {}, includes: ESSENTIAL_INCLUDES, limit: nil, sort: nil)
  client ||= Spaceship::ConnectAPI
  resps = client.get_apps(filter: filter, includes: includes, limit: limit, sort: sort).all_pages
  return resps.flat_map(&:to_models)
end

.create(client: nil, name: nil, version_string: nil, sku: nil, primary_locale: nil, bundle_id: nil, platforms: nil, company_name: nil) ⇒ Object 



85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 85

def self.create(client: nil, name: nil, version_string: nil, sku: nil, primary_locale: nil, bundle_id: nil, platforms: nil, company_name: nil)
  client ||= Spaceship::ConnectAPI
  client.post_app(
    name: name,
    version_string: version_string,
    sku: sku,
    primary_locale: primary_locale,
    bundle_id: bundle_id,
    platforms: platforms,
    company_name: company_name
  )
end

.find(bundle_id, client: nil) ⇒ Object 



78
79
80
81
82
83
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 78

def self.find(bundle_id, client: nil)
  client ||= Spaceship::ConnectAPI
  return all(client: client, filter: { bundleId: bundle_id }).find do |app|
    app.bundle_id == bundle_id
  end
end

.get(client: nil, app_id: nil, includes: "appStoreVersions") ⇒ Object 



98
99
100
101
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 98

def self.get(client: nil, app_id: nil, includes: "appStoreVersions")
  client ||= Spaceship::ConnectAPI
  return client.get_app(app_id: app_id, includes: includes).first
end

.type ⇒ Object 



64
65
66
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 64

def self.type
  return "apps"
end

Instance Method Details

#add_users(client: nil, user_ids: nil) ⇒ Object

Users



420
421
422
423
424
425
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 420

def add_users(client: nil, user_ids: nil)
  client ||= Spaceship::ConnectAPI
  user_ids.each do |user_id|
    client.add_user_visible_apps(user_id: user_id, app_ids: [id])
  end
end

#create_beta_group(client: nil, group_name: nil, public_link_enabled: false, public_link_limit: 10_000, public_link_limit_enabled: false) ⇒ Object 



388
389
390
391
392
393
394
395
396
397
398
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 388

def create_beta_group(client: nil, group_name: nil, public_link_enabled: false, public_link_limit: 10_000, public_link_limit_enabled: false)
  client ||= Spaceship::ConnectAPI
  resps = client.create_beta_group(
    app_id: id,
    group_name: group_name,
    public_link_enabled: public_link_enabled,
    public_link_limit: public_link_limit,
    public_link_limit_enabled: public_link_limit_enabled
  ).all_pages
  return resps.flat_map(&:to_models).first
end

#disable_b2b ⇒ Object

B2B



308
309
310
311
312
313
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 308

def disable_b2b
  update(attributes: {
    distributionType: DistributionType::APP_STORE,
    education_discount_type: EducationDiscountType::NOT_DISCOUNTED
  })
end

#disable_educational_discount ⇒ Object

Education



404
405
406
407
408
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 404

def disable_educational_discount
  update(attributes: {
    education_discount_type: EducationDiscountType::NOT_DISCOUNTED
  })
end

#enable_b2b ⇒ Object 



315
316
317
318
319
320
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 315

def enable_b2b
  update(attributes: {
    distributionType: App::DistributionType::CUSTOM,
    education_discount_type: EducationDiscountType::NOT_APPLICABLE
  })
end

#enable_educational_discount ⇒ Object 



410
411
412
413
414
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 410

def enable_educational_discount
  update(attributes: {
    education_discount_type: EducationDiscountType::DISCOUNTED
  })
end

#ensure_version!(version_string, platform: nil, client: 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

Returns:

  • (Bool) —

    Was something changed?



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 204

def ensure_version!(version_string, platform: nil, client: nil)
  client ||= Spaceship::ConnectAPI
  app_store_version = get_edit_app_store_version(platform: platform)

  if app_store_version
    if version_string != app_store_version.version_string
      attributes = { versionString: version_string }
      app_store_version.update(client: client, attributes: attributes)
      return true
    end
    return false
  else
    attributes = { versionString: version_string, platform: platform }
    client.post_app_store_version(app_id: id, attributes: attributes)

    return true
  end
end

#fetch_app_prices(client: nil, filter: {}, includes: "priceTier", limit: nil, sort: nil) ⇒ Object

App Pricing



168
169
170
171
172
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 168

def fetch_app_prices(client: nil, filter: {}, includes: "priceTier", limit: nil, sort: nil)
  client ||= Spaceship::ConnectAPI
  resp = client.get_app_prices(app_id: id, filter: filter, includes: includes, limit: limit, sort: sort)
  return resp.to_models
end

#fetch_available_territories(client: nil, filter: {}, includes: nil, limit: nil, sort: nil) ⇒ Object

Available Territories



157
158
159
160
161
162
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 157

def fetch_available_territories(client: nil, filter: {}, includes: nil, limit: nil, sort: nil)
  client ||= Spaceship::ConnectAPI
  filter ||= {}
  resps = client.get_available_territories(app_id: id, filter: filter, includes: includes, limit: limit, sort: sort).all_pages
  return resps.flat_map(&:to_models)
end

#fetch_edit_app_info(client: nil, includes: Spaceship::ConnectAPI::AppInfo::ESSENTIAL_INCLUDES) ⇒ Object 



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 130

def fetch_edit_app_info(client: nil, includes: Spaceship::ConnectAPI::AppInfo::ESSENTIAL_INCLUDES)
  client ||= Spaceship::ConnectAPI
  states = [
    Spaceship::ConnectAPI::AppInfo::AppStoreState::PREPARE_FOR_SUBMISSION,
    Spaceship::ConnectAPI::AppInfo::AppStoreState::DEVELOPER_REJECTED,
    Spaceship::ConnectAPI::AppInfo::AppStoreState::REJECTED,
    Spaceship::ConnectAPI::AppInfo::AppStoreState::METADATA_REJECTED,
    Spaceship::ConnectAPI::AppInfo::AppStoreState::WAITING_FOR_REVIEW,
    Spaceship::ConnectAPI::AppInfo::AppStoreState::INVALID_BINARY
  ]

  resp = client.get_app_infos(app_id: id, includes: includes)
  return resp.to_models.select do |model|
    states.include?(model.app_store_state)
  end.first
end

#fetch_latest_app_info(client: nil, includes: Spaceship::ConnectAPI::AppInfo::ESSENTIAL_INCLUDES) ⇒ Object 



147
148
149
150
151
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 147

def fetch_latest_app_info(client: nil, includes: Spaceship::ConnectAPI::AppInfo::ESSENTIAL_INCLUDES)
  client ||= Spaceship::ConnectAPI
  resp = client.get_app_infos(app_id: id, includes: includes)
  return resp.to_models.first
end

#fetch_live_app_info(client: nil, includes: Spaceship::ConnectAPI::AppInfo::ESSENTIAL_INCLUDES) ⇒ Object

App Info



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 113

def fetch_live_app_info(client: nil, includes: Spaceship::ConnectAPI::AppInfo::ESSENTIAL_INCLUDES)
  client ||= Spaceship::ConnectAPI
  states = [
    Spaceship::ConnectAPI::AppInfo::AppStoreState::READY_FOR_SALE,
    Spaceship::ConnectAPI::AppInfo::AppStoreState::PENDING_APPLE_RELEASE,
    Spaceship::ConnectAPI::AppInfo::AppStoreState::PENDING_DEVELOPER_RELEASE,
    Spaceship::ConnectAPI::AppInfo::AppStoreState::PROCESSING_FOR_APP_STORE,
    Spaceship::ConnectAPI::AppInfo::AppStoreState::IN_REVIEW,
    Spaceship::ConnectAPI::AppInfo::AppStoreState::DEVELOPER_REMOVED_FROM_SALE
  ]

  resp = client.get_app_infos(app_id: id, includes: includes)
  return resp.to_models.select do |model|
    states.include?(model.app_store_state)
  end.first
end

#get_app_store_versions(client: nil, filter: {}, includes: Spaceship::ConnectAPI::AppStoreVersion::ESSENTIAL_INCLUDES, limit: nil, sort: nil) ⇒ Object 



293
294
295
296
297
298
299
300
301
302
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 293

def get_app_store_versions(client: nil, filter: {}, includes: Spaceship::ConnectAPI::AppStoreVersion::ESSENTIAL_INCLUDES, limit: nil, sort: nil)
  client ||= Spaceship::ConnectAPI
  if limit.nil?
    resps = client.get_app_store_versions(app_id: id, filter: filter, includes: includes, limit: limit, sort: sort).all_pages
    return resps.flat_map(&:to_models)
  else
    resp = client.get_app_store_versions(app_id: id, filter: filter, includes: includes, limit: limit, sort: sort)
    return resp.to_models
  end
end

#get_beta_app_localizations(client: nil, filter: {}, includes: nil, limit: nil, sort: nil) ⇒ Object 



370
371
372
373
374
375
376
377
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 370

def get_beta_app_localizations(client: nil, filter: {}, includes: nil, limit: nil, sort: nil)
  client ||= Spaceship::ConnectAPI
  filter ||= {}
  filter[:app] = id

  resps = client.get_beta_app_localizations(filter: filter, includes: includes, limit: limit, sort: sort).all_pages
  return resps.flat_map(&:to_models)
end

#get_beta_feedback(client: nil, filter: {}, includes: "tester,build,screenshots", limit: nil, sort: nil) ⇒ Object

Beta Feedback



326
327
328
329
330
331
332
333
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 326

def get_beta_feedback(client: nil, filter: {}, includes: "tester,build,screenshots", limit: nil, sort: nil)
  client ||= Spaceship::ConnectAPI
  filter ||= {}
  filter["build.app"] = id

  resps = client.get_beta_feedback(filter: filter, includes: includes, limit: limit, sort: sort).all_pages
  return resps.flat_map(&:to_models)
end

#get_beta_groups(client: nil, filter: {}, includes: nil, limit: nil, sort: nil) ⇒ Object 



379
380
381
382
383
384
385
386
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 379

def get_beta_groups(client: nil, filter: {}, includes: nil, limit: nil, sort: nil)
  client ||= Spaceship::ConnectAPI
  filter ||= {}
  filter[:app] = id

  resps = client.get_beta_groups(filter: filter, includes: includes, limit: limit, sort: sort).all_pages
  return resps.flat_map(&:to_models)
end

#get_beta_testers(client: nil, filter: {}, includes: nil, limit: nil, sort: nil) ⇒ Object

Beta Testers



339
340
341
342
343
344
345
346
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 339

def get_beta_testers(client: nil, filter: {}, includes: nil, limit: nil, sort: nil)
  client ||= Spaceship::ConnectAPI
  filter ||= {}
  filter[:apps] = id

  resps = client.get_beta_testers(filter: filter, includes: includes, limit: limit, sort: sort).all_pages
  return resps.flat_map(&:to_models)
end

#get_build_deliveries(client: nil, filter: {}, includes: nil, limit: nil, sort: nil) ⇒ Object 



361
362
363
364
365
366
367
368
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 361

def get_build_deliveries(client: nil, filter: {}, includes: nil, limit: nil, sort: nil)
  client ||= Spaceship::ConnectAPI
  filter ||= {}
  filter[:app] = id

  resps = client.get_build_deliveries(filter: filter, includes: includes, limit: limit, sort: sort).all_pages
  return resps.flat_map(&:to_models)
end

#get_builds(client: nil, filter: {}, includes: nil, limit: nil, sort: nil) ⇒ Object

Builds



352
353
354
355
356
357
358
359
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 352

def get_builds(client: nil, filter: {}, includes: nil, limit: nil, sort: nil)
  client ||= Spaceship::ConnectAPI
  filter ||= {}
  filter[:app] = id

  resps = client.get_builds(filter: filter, includes: includes, limit: limit, sort: sort).all_pages
  return resps.flat_map(&:to_models)
end

#get_edit_app_store_version(client: nil, platform: nil, includes: Spaceship::ConnectAPI::AppStoreVersion::ESSENTIAL_INCLUDES) ⇒ Object 



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 249

def get_edit_app_store_version(client: nil, platform: nil, includes: Spaceship::ConnectAPI::AppStoreVersion::ESSENTIAL_INCLUDES)
  client ||= Spaceship::ConnectAPI
  platform ||= Spaceship::ConnectAPI::Platform::IOS
  filter = {
    appStoreState: [
      Spaceship::ConnectAPI::AppStoreVersion::AppStoreState::PREPARE_FOR_SUBMISSION,
      Spaceship::ConnectAPI::AppStoreVersion::AppStoreState::DEVELOPER_REJECTED,
      Spaceship::ConnectAPI::AppStoreVersion::AppStoreState::REJECTED,
      Spaceship::ConnectAPI::AppStoreVersion::AppStoreState::METADATA_REJECTED,
      Spaceship::ConnectAPI::AppStoreVersion::AppStoreState::WAITING_FOR_REVIEW,
      Spaceship::ConnectAPI::AppStoreVersion::AppStoreState::INVALID_BINARY
    ].join(","),
    platform: platform
  }

  # Get the latest version
  return get_app_store_versions(client: client, filter: filter, includes: includes)
         .sort_by { |v| Gem::Version.new(v.version_string) }
         .last
end

#get_in_review_app_store_version(client: nil, platform: nil, includes: Spaceship::ConnectAPI::AppStoreVersion::ESSENTIAL_INCLUDES) ⇒ Object 



270
271
272
273
274
275
276
277
278
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 270

def get_in_review_app_store_version(client: nil, platform: nil, includes: Spaceship::ConnectAPI::AppStoreVersion::ESSENTIAL_INCLUDES)
  client ||= Spaceship::ConnectAPI
  platform ||= Spaceship::ConnectAPI::Platform::IOS
  filter = {
    appStoreState: Spaceship::ConnectAPI::AppStoreVersion::AppStoreState::IN_REVIEW,
    platform: platform
  }
  return get_app_store_versions(client: client, filter: filter, includes: includes).first
end

#get_latest_app_store_version(client: nil, platform: nil, includes: nil) ⇒ Object 



223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 223

def get_latest_app_store_version(client: nil, platform: nil, includes: nil)
  client ||= Spaceship::ConnectAPI
  platform ||= Spaceship::ConnectAPI::Platform::IOS
  filter = {
    platform: platform
  }

  # Get the latest version
  return get_app_store_versions(client: client, filter: filter, includes: includes)
         .sort_by { |v| Date.parse(v.created_date) }
         .last
end

#get_live_app_store_version(client: nil, platform: nil, includes: Spaceship::ConnectAPI::AppStoreVersion::ESSENTIAL_INCLUDES) ⇒ Object 



236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 236

def get_live_app_store_version(client: nil, platform: nil, includes: Spaceship::ConnectAPI::AppStoreVersion::ESSENTIAL_INCLUDES)
  client ||= Spaceship::ConnectAPI
  platform ||= Spaceship::ConnectAPI::Platform::IOS
  filter = {
    appStoreState: [
      Spaceship::ConnectAPI::AppStoreVersion::AppStoreState::READY_FOR_SALE,
      Spaceship::ConnectAPI::AppStoreVersion::AppStoreState::DEVELOPER_REMOVED_FROM_SALE
    ].join(","),
    platform: platform
  }
  return get_app_store_versions(client: client, filter: filter, includes: includes).first
end

#get_pending_release_app_store_version(client: nil, platform: nil, includes: Spaceship::ConnectAPI::AppStoreVersion::ESSENTIAL_INCLUDES) ⇒ Object 



280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 280

def get_pending_release_app_store_version(client: nil, platform: nil, includes: Spaceship::ConnectAPI::AppStoreVersion::ESSENTIAL_INCLUDES)
  client ||= Spaceship::ConnectAPI
  platform ||= Spaceship::ConnectAPI::Platform::IOS
  filter = {
    appStoreState: [
      Spaceship::ConnectAPI::AppStoreVersion::AppStoreState::PENDING_APPLE_RELEASE,
      Spaceship::ConnectAPI::AppStoreVersion::AppStoreState::PENDING_DEVELOPER_RELEASE
    ].join(','),
    platform: platform
  }
  return get_app_store_versions(client: client, filter: filter, includes: includes).first
end

#reject_version_if_possible!(client: nil, platform: nil) ⇒ Object

App Store Versions



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 178

def reject_version_if_possible!(client: nil, platform: nil)
  client ||= Spaceship::ConnectAPI
  platform ||= Spaceship::ConnectAPI::Platform::IOS
  filter = {
    appStoreState: [
      Spaceship::ConnectAPI::AppStoreVersion::AppStoreState::PENDING_APPLE_RELEASE,
      Spaceship::ConnectAPI::AppStoreVersion::AppStoreState::PENDING_DEVELOPER_RELEASE,
      Spaceship::ConnectAPI::AppStoreVersion::AppStoreState::IN_REVIEW,
      Spaceship::ConnectAPI::AppStoreVersion::AppStoreState::WAITING_FOR_REVIEW
    ].join(","),
    platform: platform
  }

  # Get the latest version
  version = get_app_store_versions(client: client, filter: filter, includes: "appStoreVersionSubmission")
            .sort_by { |v| Gem::Version.new(v.version_string) }
            .last

  return false if version.nil?
  return version.reject!
end

#update(client: nil, attributes: nil, app_price_tier_id: nil, territory_ids: nil) ⇒ Object 



103
104
105
106
107
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 103

def update(client: nil, attributes: nil, app_price_tier_id: nil, territory_ids: nil)
  client ||= Spaceship::ConnectAPI
  attributes = reverse_attr_mapping(attributes)
  return client.patch_app(app_id: id, attributes: attributes, app_price_tier_id: app_price_tier_id, territory_ids: territory_ids)
end