Module: Spaceship::Portal

Defined in:
spaceship/lib/spaceship/portal/app.rb,
spaceship/lib/spaceship/portal/key.rb,
spaceship/lib/spaceship/portal/device.rb,
spaceship/lib/spaceship/portal/invite.rb,
spaceship/lib/spaceship/portal/person.rb,
spaceship/lib/spaceship/portal/persons.rb,
spaceship/lib/spaceship/portal/merchant.rb,
spaceship/lib/spaceship/portal/passbook.rb,
spaceship/lib/spaceship/portal/app_group.rb,
spaceship/lib/spaceship/portal/spaceship.rb,
spaceship/lib/spaceship/portal/app_service.rb,
spaceship/lib/spaceship/portal/certificate.rb,
spaceship/lib/spaceship/portal/website_push.rb,
spaceship/lib/spaceship/portal/provisioning_profile.rb,
spaceship/lib/spaceship/portal/provisioning_profile_template.rb

Defined Under Namespace

Classes: App, AppGroup, AppService, Certificate, Device, Invite, Key, Merchant, Passbook, Person, Persons, ProvisioningProfile, ProvisioningProfileTemplate, WebsitePush

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.client ⇒ Object

This client stores the default client when using the lazy syntax Spaceship.app instead of using the spaceship launcher



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

def client
  @client
end

Class Method Details

.app ⇒ Class

Returns Access the apps for the spaceship.

Returns:

  • (Class) —

    Access the apps for the spaceship



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

def app
  Spaceship::Portal::App.set_client(@client)
end

.app_group ⇒ Class

Returns Access the app groups for the spaceship.

Returns:

  • (Class) —

    Access the app groups for the spaceship



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

def app_group
  Spaceship::Portal::AppGroup.set_client(@client)
end

.app_service ⇒ Class

Returns Access app services for the spaceship.

Returns:

  • (Class) —

    Access app services for the spaceship



66
67
68
 
# File 'spaceship/lib/spaceship/portal/spaceship.rb', line 66

def app_service
  Spaceship::Portal::AppService
end

.certificate ⇒ Class

Returns Access the certificates for the spaceship.

Returns:

  • (Class) —

    Access the certificates for the spaceship



76
77
78
 
# File 'spaceship/lib/spaceship/portal/spaceship.rb', line 76

def certificate
  Spaceship::Portal::Certificate.set_client(@client)
end

.device ⇒ Class

Returns Access the devices for the spaceship.

Returns:

  • (Class) —

    Access the devices for the spaceship



71
72
73
 
# File 'spaceship/lib/spaceship/portal/spaceship.rb', line 71

def device
  Spaceship::Portal::Device.set_client(@client)
end

.login(user = nil, password = nil) ⇒ Spaceship::Portal::Client

Authenticates with Apple’s web services. This method has to be called once to generate a valid session. The session will automatically be used from then on.

This method will automatically use the username from the Appfile (if available) and fetch the password from the Keychain (if available)

Parameters:

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

    (optional): The username (usually the email address)

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

    (optional): The password

Returns:

  • (Spaceship::Portal::Client) —

    The client the login method was called for

Raises:

  • InvalidUserCredentialsError: raised if authentication failed



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

def (user = nil, password = nil)
  @client = PortalClient.(user, password)
end

.merchant ⇒ Class

Returns Access the merchants for the spaceship.

Returns:

  • (Class) —

    Access the merchants for the spaceship



86
87
88
 
# File 'spaceship/lib/spaceship/portal/spaceship.rb', line 86

def merchant
  Spaceship::Portal::Merchant.set_client(@client)
end

.passbook ⇒ Class

Returns Access the pass types for the spaceship.

Returns:

  • (Class) —

    Access the pass types for the spaceship



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

def passbook
  Spaceship::Portal::Passbook.set_client(@client)
end

.provisioning_profile ⇒ Class

Returns Access the provisioning profiles for the spaceship.

Returns:

  • (Class) —

    Access the provisioning profiles for the spaceship



81
82
83
 
# File 'spaceship/lib/spaceship/portal/spaceship.rb', line 81

def provisioning_profile
  Spaceship::Portal::ProvisioningProfile.set_client(@client)
end

.select_team ⇒ String

Open up the team selection for the user (if necessary).

If the user is in multiple teams, a team selection is shown. The user can then select a team by entering the number

Additionally, the team ID is shown next to each team name so that the user can use the environment variable ‘FASTLANE_TEAM_ID` for future user.

Returns:

  • (String) —

    The ID of the select team. You also get the value if the user is only in one team.



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

def select_team
  @client.select_team
end

.website_push ⇒ Class

Returns Access the website pushes for the spaceship.

Returns:

  • (Class) —

    Access the website pushes for the spaceship



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

def website_push
  Spaceship::Portal::WebsitePush.set_client(@client)
end