Class: Spaceship::Portal::App

Inherits:
Spaceship::PortalBase show all
Defined in:
lib/spaceship/portal/app.rb

Overview

Represents an App ID from the Developer Portal

Instance Attribute Summary collapse

Attributes inherited from Base

#raw_data

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Spaceship::PortalBase

client

Methods inherited from Base

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

Constructor Details

This class inherits a constructor from Spaceship::Base

Instance Attribute Details

#app_groups_count ⇒ Fixnum

Returns Number of associated app groups.

Returns:

  • (Fixnum) —

    Number of associated app groups



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

def app_groups_count
  @app_groups_count
end

#app_id ⇒ String

Returns The identifier of this app, provided by the Dev Portal.

Examples:

"RGAWZGXSAA"

Returns:

  • (String) —

    The identifier of this app, provided by the Dev Portal



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

def app_id
  @app_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



29
30
31
 
# File 'lib/spaceship/portal/app.rb', line 29

def bundle_id
  @bundle_id
end

#cloud_containers_count ⇒ Fixnum

Returns Number of associated cloud containers.

Returns:

  • (Fixnum) —

    Number of associated cloud containers



50
51
52
 
# File 'lib/spaceship/portal/app.rb', line 50

def cloud_containers_count
  @cloud_containers_count
end

#dev_push_enabled ⇒ Bool

Returns Development Push Enabled?.

Returns:

  • (Bool) —

    Development Push Enabled?



41
42
43
 
# File 'lib/spaceship/portal/app.rb', line 41

def dev_push_enabled
  @dev_push_enabled
end

#enabled_features ⇒ Array

Returns List of enabled features.

Returns:

  • (Array) —

    List of enabled features



38
39
40
 
# File 'lib/spaceship/portal/app.rb', line 38

def enabled_features
  @enabled_features
end

#features ⇒ Hash

Returns Feature details.

Returns:

  • (Hash) —

    Feature details



35
36
37
 
# File 'lib/spaceship/portal/app.rb', line 35

def features
  @features
end

#identifiers_count ⇒ Fixnum

Returns Number of associated identifiers.

Returns:

  • (Fixnum) —

    Number of associated identifiers



53
54
55
 
# File 'lib/spaceship/portal/app.rb', line 53

def identifiers_count
  @identifiers_count
end

#is_wildcard ⇒ Bool

Returns Is this app a wildcard app (e.g. com.krausefx.*).

Returns:

  • (Bool) —

    Is this app a wildcard app (e.g. com.krausefx.*)



32
33
34
 
# File 'lib/spaceship/portal/app.rb', line 32

def is_wildcard
  @is_wildcard
end

#name ⇒ String

Returns The name you provided for this app.

Examples:

"Spaceship"

Returns:

  • (String) —

    The name you provided for this app



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

def name
  @name
end

#platform ⇒ String

Returns the supported platform of this app.

Examples:

"ios"

Returns:

  • (String) —

    the supported platform of this app



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

def platform
  @platform
end

#prefix ⇒ Object

Prefix provided by the Dev Portal

Examples:

"5A997XSHK2"


24
25
26
 
# File 'lib/spaceship/portal/app.rb', line 24

def prefix
  @prefix
end

#prod_push_enabled ⇒ Bool

Returns Production Push Enabled?.

Returns:

  • (Bool) —

    Production Push Enabled?



44
45
46
 
# File 'lib/spaceship/portal/app.rb', line 44

def prod_push_enabled
  @prod_push_enabled
end

Class Method Details

.all ⇒ Array

Returns all apps available for this account

Returns:

  • (Array) —

    Returns all apps available for this account



79
80
81
 
# File 'lib/spaceship/portal/app.rb', line 79

def all
  client.apps.map { |app| self.factory(app) }
end

.create!(bundle_id: nil, name: nil) ⇒ App

Creates a new App ID on the Apple Dev Portal

if bundle_id ends with ‘*’ then it is a wildcard id otherwise, it is an explicit id

Parameters:

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

    the bundle id (app_identifier) of the app associated with this provisioning profile

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

    the name of the App

Returns:

  • (App) —

    The app you just created



89
90
91
92
93
94
95
96
97
98
 
# File 'lib/spaceship/portal/app.rb', line 89

def create!(bundle_id: nil, name: nil)
  if bundle_id.end_with?('*')
    type = :wildcard
  else
    type = :explicit
  end

  new_app = client.create_app!(type, name, bundle_id)
  self.new(new_app)
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.



74
75
76
 
# File 'lib/spaceship/portal/app.rb', line 74

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

.find(bundle_id) ⇒ App

Find a specific App ID based on the bundle_id

Returns:

  • (App) —

    The app you’re looking for. This is nil if the app can’t be found.



102
103
104
105
106
 
# File 'lib/spaceship/portal/app.rb', line 102

def find(bundle_id)
  all.find do |app|
    app.bundle_id == bundle_id
  end
end

Instance Method Details

#delete! ⇒ App

Delete this App ID. This action will most likely fail if the App ID is already in the store or there are active profiles

Returns:

  • (App) —

    The app you just deletd



112
113
114
115
 
# File 'lib/spaceship/portal/app.rb', line 112

def delete!
  client.delete_app!(app_id)
  self
end

#details ⇒ App

Fetch a specific App ID details based on the bundle_id

Returns:

  • (App) —

    The app you’re looking for. This is nil if the app can’t be found.



119
120
121
122
 
# File 'lib/spaceship/portal/app.rb', line 119

def details
  app = client.details_for_app(self)
  self.class.factory(app)
end