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

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

#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(filter: {}, includes: ESSENTIAL_INCLUDES, limit: nil, sort: nil) ⇒ Object

Apps



55
56
57
58
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 55

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

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



66
67
68
69
70
71
72
73
74
75
76
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 66

def self.create(name: nil, version_string: nil, sku: nil, primary_locale: nil, bundle_id: nil, platforms: nil, company_name: nil)
  Spaceship::ConnectAPI.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) ⇒ Object 



60
61
62
63
64
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 60

def self.find(bundle_id)
  return all(filter: { bundleId: bundle_id }).find do |app|
    app.bundle_id == bundle_id
  end
end

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



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

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

.type ⇒ Object 



47
48
49
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 47

def self.type
  return "apps"
end

Instance Method Details

#add_users(user_ids: nil) ⇒ Object

Users



330
331
332
333
334
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 330

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

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



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

def create_beta_group(group_name: nil, public_link_enabled: false, public_link_limit: 10_000, public_link_limit_enabled: false)
  resps = Spaceship::ConnectAPI.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

#ensure_version!(version_string, 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

Returns:

  • (Bool) —

    Was something changed?



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 170

def ensure_version!(version_string, platform: nil)
  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(attributes: attributes)
      return true
    end
    return false
  else
    attributes = { versionString: version_string, platform: platform }
    Spaceship::ConnectAPI.post_app_store_version(app_id: id, attributes: attributes)

    return true
  end
end

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

App Pricing



136
137
138
139
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 136

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

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

Available Territories



126
127
128
129
130
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 126

def fetch_available_territories(filter: {}, includes: nil, limit: nil, sort: nil)
  filter ||= {}
  resps = Spaceship::ConnectAPI.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(includes: Spaceship::ConnectAPI::AppInfo::ESSENTIAL_INCLUDES) ⇒ Object 



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 106

def fetch_edit_app_info(includes: Spaceship::ConnectAPI::AppInfo::ESSENTIAL_INCLUDES)
  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 = Spaceship::ConnectAPI.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_live_app_info(includes: Spaceship::ConnectAPI::AppInfo::ESSENTIAL_INCLUDES) ⇒ Object

App Info



91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 91

def fetch_live_app_info(includes: Spaceship::ConnectAPI::AppInfo::ESSENTIAL_INCLUDES)
  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
  ]

  resp = Spaceship::ConnectAPI.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(filter: {}, includes: Spaceship::ConnectAPI::AppStoreVersion::ESSENTIAL_INCLUDES, limit: nil, sort: nil) ⇒ Object 



250
251
252
253
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 250

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

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



299
300
301
302
303
304
305
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 299

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

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

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

Beta Feedback



259
260
261
262
263
264
265
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 259

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

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

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



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

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

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

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

Beta Testers



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

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

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

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



291
292
293
294
295
296
297
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 291

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

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

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

Builds



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

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

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

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



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 209

def get_edit_app_store_version(platform: nil, includes: Spaceship::ConnectAPI::AppStoreVersion::ESSENTIAL_INCLUDES)
  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(filter: filter, includes: includes)
         .sort_by { |v| Gem::Version.new(v.version_string) }
         .last
end

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



229
230
231
232
233
234
235
236
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 229

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

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



188
189
190
191
192
193
194
195
196
197
198
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 188

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

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

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



200
201
202
203
204
205
206
207
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 200

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

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



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

def get_pending_release_app_store_version(platform: nil, includes: Spaceship::ConnectAPI::AppStoreVersion::ESSENTIAL_INCLUDES)
  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(filter: filter, includes: includes).first
end

#reject_version_if_possible!(platform: nil) ⇒ Object

App Store Versions



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 145

def reject_version_if_possible!(platform: nil)
  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(filter: filter, includes: "appStoreVersionSubmission")
            .sort_by { |v| Gem::Version.new(v.version_string) }
            .last

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

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



82
83
84
85
 
# File 'spaceship/lib/spaceship/connect_api/models/app.rb', line 82

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