Class: Sigh::DeveloperCenter

Inherits:

Object

• Object
• Sigh::DeveloperCenter

Includes:

Capybara::DSL

Defined in:

lib/sigh/developer_center.rb

Defined Under Namespace

Classes: DeveloperCenterGeneralError, DeveloperCenterLoginError

Constant Summary

APPSTORE =

Types of certificates

"AppStore"

ADHOC =

"AdHoc"

DEVELOPMENT =

"Development"

DEVELOPER_CENTER_URL =

"https://developer.apple.com/devcenter/ios/index.action"

PROFILES_URL =

"https://developer.apple.com/account/ios/profile/profileList.action?type=production"

PROFILES_URL_DEV =

"https://developer.apple.com/account/ios/profile/profileList.action?type=limited"

Instance Method Summary

• #create_profile(app_identifier, type) ⇒ Object
• #download_profile(profile_id) ⇒ Object
• #initialize ⇒ DeveloperCenter constructor

  A new instance of DeveloperCenter.

• #login(user = nil, password = nil) ⇒ bool

  Loggs in a user with the given login data on the Dev Center Frontend.

• #maintain_app_certificate(app_identifier, type) ⇒ Object
• #renew_profile(profile_id, type) ⇒ Object
• #run(app_identifier, type, cert_name = nil) ⇒ Object
• #select_team ⇒ Object

Constructor Details

#initialize ⇒ DeveloperCenter

Returns a new instance of DeveloperCenter.

# File 'lib/sigh/developer_center.rb', line 31

def initialize
  FileUtils.mkdir_p TMP_FOLDER
  
  Capybara.run_server = false
  Capybara.default_driver = :poltergeist
  Capybara.javascript_driver = :poltergeist
  Capybara.current_driver = :poltergeist
  Capybara.app_host = DEVELOPER_CENTER_URL

  # Since Apple has some SSL errors, we have to configure the client properly:
  # https://github.com/ariya/phantomjs/issues/11239
  Capybara.register_driver :poltergeist do |a|
    conf = ['--debug=no', '--ignore-ssl-errors=yes', '--ssl-protocol=TLSv1']
    Capybara::Poltergeist::Driver.new(a, {
      phantomjs_options: conf,
      phantomjs_logger: File.open("#{TMP_FOLDER}/poltergeist_log.txt", "a"),
      js_errors: false
    })
  end

  page.driver.headers = { "Accept-Language" => "en" }

  self.login
end

Instance Method Details

#create_profile(app_identifier, type) ⇒ Object

# File 'lib/sigh/developer_center.rb', line 245

def create_profile(app_identifier, type)
  Helper.log.info "Creating new profile for app '#{app_identifier}' for type '#{type}'.".yellow
  certificate = code_signing_certificate(type)

  create_url = "https://developer.apple.com/account/ios/profile/profileCreate.action"
  visit create_url

  # 1) Select the profile type (AppStore, Adhoc)
  enterprise = false

  begin
    wait_for_elements('#type-production')
  rescue => ex
    wait_for_elements('#type-inhouse') # enterprise accounts
    enterprise = true
  end

  value = (enterprise ? 'inhouse' : 'store')
  value = 'limited' if type == DEVELOPMENT
  value = 'adhoc' if type == ADHOC

  first(:xpath, "//input[@type='radio' and @value='#{value}']").click
  click_next

  # 2) Select the App ID
  while not page.has_content?"Select App ID" do sleep 1 end
  # example: <option value="RGAWZGXSY4">ABP (5A997XSHK2.net.sunapps.34)</option>
  identifiers = all(:xpath, "//option[contains(text(), '.#{app_identifier})')]")
  if identifiers.count == 0
    puts "Couldn't find App ID '#{app_identifier}'\nonly found the following bundle identifiers:".red
    all(:xpath, "//option").each do |current|
      puts "\t- #{current.text}".yellow
    end
    raise "Could not find Apple ID '#{app_identifier}'.".red
  else
    identifiers.first.select_option
  end
  click_next

  # 3) Select the certificate
  while not page.has_content?"Select certificates" do sleep 1 end
  sleep 3
  Helper.log.info "Using certificate ID '#{certificate['certificateId']}' from '#{certificate['ownerName']}'"

  # example: <input type="radio" name="certificateIds" class="validate" value="[XC5PH8D47H]"> (production)
  id = certificate["certificateId"]
  certs = all(:xpath, "//input[@type='radio' and @value='[#{id}]']") if type != DEVELOPMENT # production uses radio and has a [] around the value
  certs = all(:xpath, "//input[@type='checkbox' and @value='#{id}']") if type == DEVELOPMENT # development uses a checkbox and has no [] around the value
  if certs.count != 1
    Helper.log.info "Looking for certificate: #{certificate}. Found: #{certs.count}"
    raise "Could not find certificate in the list of available certificates."
  end
  certs.first.click
  click_next

  if type != APPSTORE
    # 4) Devices selection
    wait_for_elements('.selectAll.column')
    sleep 3

    first(:xpath, "//div[@class='selectAll column']/input").click # select all the devices
    click_next
  end

  # 5) Choose a profile name
  wait_for_elements('.distributionType')
  profile_name = [app_identifier, type].join(' ')
  fill_in "provisioningProfileName", with: profile_name
  click_next
  wait_for_elements('.row-details')
end

#download_profile(profile_id) ⇒ Object

# File 'lib/sigh/developer_center.rb', line 340

def download_profile(profile_id)
  download_cert_url = "/account/ios/profile/profileContentDownload.action?displayId=#{profile_id}"

  return download_file(download_cert_url)
end

#login(user = nil, password = nil) ⇒ bool

Loggs in a user with the given login data on the Dev Center Frontend. You don’t need to pass a username and password. It will Automatically be fetched using the CredentialsManager::PasswordManager. This method will also automatically be called when triggering other actions like #open_app_page

Parameters:

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

  (optional) The username/email address

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

  (optional) The password

Returns:

• (bool) —

  true if everything worked fine

Raises:

• (DeveloperCenterGeneralError) —

  General error while executing this action

• (DeveloperCenterLoginError) —

  Login data is wrong

# File 'lib/sigh/developer_center.rb', line 67

def login(user = nil, password = nil)
  begin
    Helper.log.info "Login into iOS Developer Center"

    user ||= CredentialsManager::PasswordManager.shared_manager.username
    password ||= CredentialsManager::PasswordManager.shared_manager.password

    result = visit PROFILES_URL
    raise "Could not open Developer Center" unless result['status'] == 'success'

    if page.has_content?"Member Center"
      # Already logged in
      return true
    end

    (wait_for_elements(".button.blue").first.click rescue nil) # maybe already logged in

    (wait_for_elements('#accountpassword') rescue nil) # when the user is already logged in, this will raise an exception

    if page.has_content?"Member Center"
      # Already logged in
      return true
    end

    fill_in "accountname", with: user
    fill_in "accountpassword", with: password

    all(".button.large.blue.signin-button").first.click

    begin
      if page.has_content?"Select Team" # If the user is not on multiple teams
        select_team
      end
    rescue => ex
      Helper.log.debug ex
      raise DeveloperCenterLoginError.new("Error loggin in user #{user}. User is on multiple teams and we were unable to correctly retrieve them.")
    end

    begin
      wait_for_elements('.ios.profiles.gridList')
      visit PROFILES_URL # again, since after the login, the dev center loses the production GET value
    rescue => ex
      Helper.log.debug ex
      if page.has_content?"Getting Started"
        raise "There was no valid signing certificate found. Please log in and follow the 'Getting Started guide' on '#{current_url}'".red
      else
        raise DeveloperCenterLoginError.new("Error logging in user #{user} with the given password. Make sure you entered them correctly.")
      end
    end


    Helper.log.info "Login successful"
    
    true
  rescue => ex
    error_occured(ex)
  end
end

#maintain_app_certificate(app_identifier, type) ⇒ Object

# File 'lib/sigh/developer_center.rb', line 184

def maintain_app_certificate(app_identifier, type)
  begin
    if type == DEVELOPMENT 
      visit PROFILES_URL_DEV
    else
      visit PROFILES_URL
    end

    @list_certs_url = wait_for_variable('profileDataURL')
    # list_certs_url will look like this: "https://developer.apple.com/services-account/..../account/ios/profile/listProvisioningProfiles.action?content-type=application/x-www-form-urlencoded&accept=application/json&requestId=id&userLocale=en_US&teamId=xy&includeInactiveProfiles=true&onlyCountLists=true"
    Helper.log.info "Fetching all available provisioning profiles..."

    certs = post_ajax(@list_certs_url)

    Helper.log.info "Checking if profile is available. (#{certs['provisioningProfiles'].count} profiles found)"
    certs['provisioningProfiles'].each do |current_cert|
      if type == DEVELOPMENT
        if current_cert['type'] != "iOS Development"
          next
        end
      end

      if type != DEVELOPMENT
        if not ['iOS Distribution', 'iOS UniversalDistribution'].include?current_cert['type']
          next
        end
      end
      
      details = profile_details(current_cert['provisioningProfileId'])

      if details['provisioningProfile']['appId']['identifier'] == app_identifier
        if type == APPSTORE and details['provisioningProfile']['deviceCount'] > 0
          next # that's an Ad Hoc profile. I didn't find a better way to detect if it's one ... skipping it
        end
        if type != APPSTORE and details['provisioningProfile']['deviceCount'] == 0
          next # that's an App Store profile ... skipping it
        end

        # We found the correct certificate
        if current_cert['status'] == 'Active'
          return download_profile(details['provisioningProfile']['provisioningProfileId']) # this one is already finished. Just download it.
        elsif ['Expired', 'Invalid'].include?current_cert['status']
          renew_profile(current_cert['provisioningProfileId'], type) # This one needs to be renewed
          return maintain_app_certificate(app_identifier, type) # recursive
        end

        break
      end
    end

    Helper.log.info "Could not find existing profile. Trying to create a new one."
    # Certificate does not exist yet, we need to create a new one
    create_profile(app_identifier, type)
    # After creating the profile, we need to download it
    return maintain_app_certificate(app_identifier, type) # recursive

  rescue => ex
    error_occured(ex)
  end
end

#renew_profile(profile_id, type) ⇒ Object

# File 'lib/sigh/developer_center.rb', line 317

def renew_profile(profile_id, type)
  certificate = code_signing_certificate type

  details_url = "https://developer.apple.com/account/ios/profile/profileEdit.action?type=&provisioningProfileId=#{profile_id}"
  Helper.log.info "Renewing provisioning profile '#{profile_id}' using URL '#{details_url}'"
  visit details_url

  Helper.log.info "Using certificate ID '#{certificate['certificateId']}' from '#{certificate['ownerName']}'"
  wait_for_elements('.selectCertificates')

  certs = all(:xpath, "//input[@type='radio' and @value='#{certificate["certificateId"]}']")
  if certs.count == 1
    certs.first.click
    click_next

    wait_for_elements('.row-details')
    click_on "Done"
  else
    Helper.log.info "Looking for certificate: #{certificate}. Found: #{certs}"
    raise "Could not find certificate in the list of available certificates."
  end
end

#run(app_identifier, type, cert_name = nil) ⇒ Object

# File 'lib/sigh/developer_center.rb', line 170

def run(app_identifier, type, cert_name = nil)
  cert = maintain_app_certificate(app_identifier, type)

  type_name = type
  type_name = "Distribution" if type == APPSTORE # both enterprise and App Store
  cert_name ||= "#{type_name}_#{app_identifier}.mobileprovision" # default name
  cert_name += '.mobileprovision' unless cert_name.include?'mobileprovision'

  output_path = TMP_FOLDER + cert_name
  File.write(output_path, cert)

  return output_path
end

#select_team ⇒ Object

# File 'lib/sigh/developer_center.rb', line 127

def select_team
  team_id = ENV["SIGH_TEAM_ID"]
  team_id = nil if team_id.to_s.length == 0

  unless team_id
    Helper.log.info "You can store you preferred team using the environment variable `SIGH_TEAM_ID`".green
    Helper.log.info "Your ID belongs to the following teams:".green
  end
  
  available_options = []

  teams = find("div.input").all('.team-value') # Grab all the teams data
  teams.each_with_index do |val, index|
    current_team_id = '"' + val.find("input").value + '"'
    team_text = val.find(".label-primary").text
    description_text = val.find(".label-secondary").text
    description_text = "(#{description_text})" unless description_text.empty? # Include the team description if any
    index_text = (index + 1).to_s + "."

    available_options << [index_text, current_team_id, team_text, description_text].join(" ")
  end

  unless team_id
    puts available_options.join("\n").green
    team_index = ask("Please select the team number you would like to access: ".green)
    team_id = teams[team_index.to_i - 1].find(".radio").value
  end

  team_button = first(:xpath, "//input[@type='radio' and @value='#{team_id}']") # Select the desired team
  if team_button
    team_button.click
  else
    Helper.log.fatal "Could not find given Team. Available options: ".red
    puts available_options.join("\n").yellow
    raise DeveloperCenterLoginError.new("Error finding given team #{team_id}.".red)
  end

  all(".button.large.blue.submit").first.click

  result = visit PROFILES_URL
  raise "Could not open Developer Center" unless result['status'] == 'success'
end