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/cloud_container.rb,
spaceship/lib/spaceship/portal/provisioning_profile.rb,
spaceship/lib/spaceship/portal/provisioning_profile_template.rb

Defined Under Namespace

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

Class Attribute Summary

• .client ⇒ Object

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

Class Method Summary

• .app ⇒ Class

  Access the apps for the spaceship.

• .app_group ⇒ Class

  Access the app groups for the spaceship.

• .app_service ⇒ Class

  Access app services for the spaceship.

• .certificate ⇒ Class

  Access the certificates for the spaceship.

• .cloud_container ⇒ Class

  Access the iCloud Containers for the spaceship.

• .device ⇒ Class

  Access the devices for the spaceship.

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

  Authenticates with Apple’s web services.

• .merchant ⇒ Class

  Access the merchants for the spaceship.

• .passbook ⇒ Class

  Access the pass types for the spaceship.

• .provisioning_profile ⇒ Class

  Access the provisioning profiles for the spaceship.

• .select_team(team_id: nil, team_name: nil) ⇒ String

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

• .website_push ⇒ Class

  Access the website pushes for the spaceship.

Class Attribute Details

.client ⇒ Object

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

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

def client
  @client
end

Class Method Details

.app ⇒ Class

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

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

.app_group ⇒ Class

# File 'spaceship/lib/spaceship/portal/spaceship.rb', line 64

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

.app_service ⇒ Class

# File 'spaceship/lib/spaceship/portal/spaceship.rb', line 69

def app_service
  Spaceship::Portal::AppService
end

.certificate ⇒ Class

# File 'spaceship/lib/spaceship/portal/spaceship.rb', line 84

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

.cloud_container ⇒ Class

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

def cloud_container
  Spaceship::Portal::CloudContainer.set_client(@client)
end

.device ⇒ Class

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

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)

Raises:

• InvalidUserCredentialsError: raised if authentication failed

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

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

.merchant ⇒ Class

# File 'spaceship/lib/spaceship/portal/spaceship.rb', line 94

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

.passbook ⇒ Class

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

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

.provisioning_profile ⇒ Class

# File 'spaceship/lib/spaceship/portal/spaceship.rb', line 89

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

.select_team(team_id: nil, team_name: nil) ⇒ 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.

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

def select_team(team_id: nil, team_name: nil)
  @client.select_team(team_id: team_id, team_name: team_name)
end

.website_push ⇒ Class

# File 'spaceship/lib/spaceship/portal/spaceship.rb', line 59

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