fastlane 1.111.0 → 2.0.1

data/spaceship/lib/spaceship/commands_generator.rb

@@ -0,0 +1,48 @@
+HighLine.track_eof = false
+
+require 'spaceship/playground'
+require 'spaceship/spaceauth_runner'
+
+module Spaceship
+  class CommandsGenerator
+    include Commander::Methods
+
+    def self.start
+      self.new.run
+    end
+
+    def run
+      program :name, 'spaceship'
+      program :version, Fastlane::VERSION
+      program :description, Spaceship::DESCRIPTION
+      program :help, 'Author', 'Felix Krause <spaceship@krausefx.com>'
+      program :help, 'Website', 'https://fastlane.tools'
+      program :help, 'GitHub', 'https://github.com/fastlane/fastlane/tree/master/spaceship'
+      program :help_formatter, :compact
+
+      global_option('-u', '--user USERNAME', 'Specify the Apple ID you want to log in with')
+
+      command :playground do |c|
+        c.syntax = 'spaceship playground'
+        c.description = 'Run an interactive shell that connects you to Apple web services'
+
+        c.action do |args, options|
+          Spaceship::Playground.new(username: options.user).run
+        end
+      end
+
+      command :spaceauth do |c|
+        c.syntax = 'spaceship spaceauth'
+        c.description = 'Authentication helper for spaceship/fastlane to work with Apple 2-Step/2FA'
+
+        c.action do |args, options|
+          Spaceship::SpaceauthRunner.new(username: options.user).run
+        end
+      end
+
+      default_command :playground
+
+      run!
+    end
+  end
+end

data/spaceship/lib/spaceship/du/du_client.rb

@@ -0,0 +1,122 @@
+module Spaceship
+  # This class is used to upload Digital files (Images, Videos, JSON files) onto the du-itc service.
+  # Its implementation is tied to the tunes module (in particular using +AppVersion+ instances)
+  class DUClient < Spaceship::Client #:nodoc:
+    #####################################################
+    # @!group Init and Login
+    #####################################################
+
+    def self.hostname
+      "https://du-itc.itunes.apple.com"
+    end
+
+    #####################################################
+    # @!group Images
+    #####################################################
+
+    def upload_screenshot(app_version, upload_file, content_provider_id, sso_token_for_image, device, is_messages)
+      upload_file(app_version, upload_file, '/upload/image', content_provider_id, sso_token_for_image, screenshot_picture_type(device, is_messages))
+    end
+
+    def upload_large_icon(app_version, upload_file, content_provider_id, sso_token_for_image)
+      upload_file(app_version, upload_file, '/upload/image', content_provider_id, sso_token_for_image, 'MZPFT.LargeApplicationIcon')
+    end
+
+    def upload_watch_icon(app_version, upload_file, content_provider_id, sso_token_for_image)
+      upload_file(app_version, upload_file, '/upload/image', content_provider_id, sso_token_for_image, 'MZPFT.GizmoAppIcon')
+    end
+
+    def upload_geojson(app_version, upload_file, content_provider_id, sso_token_for_image)
+      upload_file(app_version, upload_file, '/upload/geo-json', content_provider_id, sso_token_for_image)
+    end
+
+    def upload_trailer(app_version, upload_file, content_provider_id, sso_token_for_video)
+      upload_file(app_version, upload_file, '/upload/purple-video', content_provider_id, sso_token_for_video)
+    end
+
+    def upload_trailer_preview(app_version, upload_file, content_provider_id, sso_token_for_image)
+      upload_file(app_version, upload_file, '/upload/app-screenshot-image', content_provider_id, sso_token_for_image)
+    end
+
+    private
+
+    def upload_file(app_version, upload_file, path, content_provider_id, sso_token, du_validation_rule_set = nil)
+      raise "File #{upload_file.file_path} is empty" if upload_file.file_size == 0
+
+      version = app_version.version
+      app_id = app_version.application.apple_id
+      app_type = app_version.app_type
+
+      referrer = app_version.application.url
+
+      r = request(:post) do |req|
+        req.url "#{self.class.hostname}#{path}"
+        req.body = upload_file.bytes
+        req.headers['Accept'] = 'application/json, text/plain, */*'
+        req.headers['Content-Type'] = upload_file.content_type
+        req.headers['X-Apple-Upload-Referrer'] = referrer
+        req.headers['Referrer'] = referrer
+        req.headers['X-Apple-Upload-AppleId'] = app_id
+        req.headers['X-Apple-Jingle-Correlation-Key'] = "#{app_type}:AdamId=#{app_id}:Version=#{version}"
+        req.headers['X-Apple-Upload-itctoken'] = sso_token
+        req.headers['X-Apple-Upload-ContentProviderId'] = content_provider_id
+        req.headers['X-Original-Filename'] = upload_file.file_name
+        req.headers['X-Apple-Upload-Validation-RuleSets'] = du_validation_rule_set if du_validation_rule_set
+        req.headers['Content-Length'] = upload_file.file_size.to_s
+        req.headers['Connection'] = "keep-alive"
+      end
+
+      if r.status == 500 and r.body.include?("Server Error")
+        return upload_file(app_version, upload_file, path, content_provider_id, sso_token, du_validation_rule_set)
+      end
+
+      parse_upload_response(r)
+    end
+
+    # You can find this by uploading an image in iTunes connect
+    # then look for the X-Apple-Upload-Validation-RuleSets value
+    def picture_type_map
+      # rubocop:enable Style/ExtraSpacing
+      {
+        watch:        "MZPFT.SortedN27ScreenShot",
+        ipad:         "MZPFT.SortedTabletScreenShot",
+        ipadPro:      "MZPFT.SortedJ99ScreenShot",
+        iphone6:      "MZPFT.SortedN61ScreenShot",
+        iphone6Plus:  "MZPFT.SortedN56ScreenShot",
+        iphone4:      "MZPFT.SortedN41ScreenShot",
+        iphone35:     "MZPFT.SortedScreenShot",
+        appleTV:      "MZPFT.SortedATVScreenShot",
+        desktop:      "MZPFT.SortedDesktopScreenShot"
+      }
+    end
+
+    def messages_picture_type_map
+      # rubocop:enable Style/ExtraSpacing
+      {
+        ipad:         "MZPFT.SortedTabletMessagesScreenShot",
+        ipadPro:      "MZPFT.SortedJ99MessagesScreenShot",
+        iphone6:      "MZPFT.SortedN61MessagesScreenShot",
+        iphone6Plus:  "MZPFT.SortedN56MessagesScreenShot",
+        iphone4:      "MZPFT.SortedN41MessagesScreenShot"
+      }
+    end
+
+    def screenshot_picture_type(device, is_messages)
+      map = is_messages ? messages_picture_type_map : picture_type_map
+      device = device.to_sym
+      raise "Unknown picture type for device: #{device}" unless map.key? device
+      map[device]
+    end
+
+    def parse_upload_response(response)
+      content = response.body
+      if !content['statusCode'].nil? && content['statusCode'] != 200
+        error_codes = ""
+        error_codes = content['errorCodes'].join(',') unless content['errorCodes'].nil?
+        error_message = "[#{error_codes}] #{content['localizedMessage']}"
+        raise UnexpectedResponse.new, error_message
+      end
+      content
+    end
+  end
+end

data/spaceship/lib/spaceship/du/upload_file.rb

@@ -0,0 +1,56 @@
+require 'fileutils'
+
+module Spaceship
+  # a wrapper around the concept of file required to make uploads to DU
+  class UploadFile
+    attr_reader :file_path
+    attr_reader :file_name
+    attr_reader :file_size
+    attr_reader :content_type
+    attr_reader :bytes
+
+    class << self
+      def from_path(path)
+        raise "Image must exists at path: #{path}" unless File.exist?(path)
+
+        # md5 from original. keeping track of md5s allows to skip previously uploaded in deliver
+        content_md5 = Spaceship::Utilities.md5digest(path)
+        path = remove_alpha_channel(path) if File.extname(path).casecmp('.png').zero?
+
+        content_type = Utilities.content_type(path)
+        self.new(
+          file_path: path,
+          file_name: 'ftl_' + content_md5 + '_' + File.basename(path),
+          file_size: File.size(path),
+          content_type: content_type,
+          bytes: File.read(path)
+        )
+      end
+
+      # As things like screenshots and app icon shouldn't contain the alpha channel
+      # This will copy the image into /tmp to remove the alpha channel there
+      # That's done to not edit the original image
+      def remove_alpha_channel(original)
+        path = "/tmp/#{Digest::MD5.hexdigest(original)}.png"
+        FileUtils.copy(original, path)
+        if mac? # sips is only available on macOS
+          `sips -s format bmp '#{path}' &> /dev/null` # &> /dev/null since there is warning because of the extension
+          `sips -s format png '#{path}'`
+        end
+        return path
+      end
+
+      def mac?
+        (/darwin/ =~ RUBY_PLATFORM) != nil
+      end
+    end
+
+    private
+
+    def initialize(args)
+      args.each do |k, v|
+        instance_variable_set("@#{k}", v) unless v.nil?
+      end
+    end
+  end
+end

data/spaceship/lib/spaceship/du/utilities.rb

@@ -0,0 +1,81 @@
+require 'fastimage'
+require "English"
+
+module Spaceship
+  # Set of utility methods useful to work with media files
+  module Utilities #:nodoc:
+    # Identifies the content_type of a file based on its file name extension.
+    # Supports all formats required by DU-UTC right now (video, images and json)
+    # @param path (String) the path to the file
+    def content_type(path)
+      path = path.downcase
+      return 'image/jpeg' if path.end_with?('.jpg')
+      return 'image/jpeg' if path.end_with?('.jpeg')
+      return 'image/png' if path.end_with?('.png')
+      return 'application/json' if path.end_with?('.geojson')
+      return 'video/quicktime' if path.end_with?('.mov')
+      return 'video/mp4' if path.end_with?('.m4v')
+      return 'video/mp4' if path.end_with?('.mp4')
+      raise "Unknown content-type for file #{path}"
+    end
+
+    # Identifies the resolution of a video or an image.
+    # Supports all video and images required by DU-UTC right now
+    # @param path (String) the path to the file
+    def resolution(path)
+      return FastImage.size(path) if content_type(path).start_with?("image")
+      return video_resolution(path) if content_type(path).start_with?("video")
+      raise "Cannot find resolution of file #{path}"
+    end
+
+    # Is the video or image in portrait mode ?
+    # Supports all video and images required by DU-UTC right now
+    # @param path (String) the path to the file
+    def portrait?(path)
+      resolution = resolution(path)
+      resolution[0] < resolution[1]
+    end
+
+    # Grabs a screenshot from the specified video at the specified timestamp using `ffmpeg`
+    # @param video_path (String) the path to the video file
+    # @param timestamp (String) the `ffmpeg` timestamp format (e.g. 00.00)
+    # @param dimensions (Array) the dimension of the screenshot to generate
+    # @return the path to the TempFile containing the generated screenshot
+    def grab_video_preview(video_path, timestamp, dimensions)
+      width, height = dimensions
+      require 'tempfile'
+      tmp = Tempfile.new(['video_preview', ".jpg"])
+      file = tmp.path
+      command = "ffmpeg -y -i \"#{video_path}\" -s #{width}x#{height} -ss \"#{timestamp}\" -vframes 1 \"#{file}\" 2>&1 >/dev/null"
+      # puts "COMMAND: #{command}"
+      `#{command}`
+      raise "Failed to grab screenshot at #{timestamp} from #{video_path} (using #{command})" unless $CHILD_STATUS.to_i == 0
+      tmp.path
+    end
+
+    # identifies the resolution of a video using `ffmpeg`
+    # @param video_path (String) the path to the video file
+    # @return [Array] the resolution of the video
+    def video_resolution(video_path)
+      command = "ffmpeg -i \"#{video_path}\" 2>&1"
+      # puts "COMMAND: #{command}"
+      output = `#{command}`
+      # Note: ffmpeg exits with 1 if no output specified
+      # raise "Failed to find video information from #{video_path} (using #{command})" unless $CHILD_STATUS.to_i == 0
+      output = output.force_encoding("BINARY")
+      video_infos = output.split("\n").select { |l| l =~ /Stream.*Video/ }
+      raise "Unable to find Stream Video information from ffmpeg output of #{command}" if video_infos.count == 0
+      video_info = video_infos[0]
+      res = video_info.match(/.* ([0-9]+)x([0-9]+),.*/)
+      raise "Unable to parse resolution information from #{video_info}" if res.count < 3
+      [res[1].to_i, res[2].to_i]
+    end
+
+    # @return (String) md5 checksum of given file
+    def md5digest(file_path)
+      Digest::MD5.hexdigest(File.read(file_path))
+    end
+
+    module_function :content_type, :grab_video_preview, :portrait?, :resolution, :video_resolution, :md5digest
+  end
+end

data/spaceship/lib/spaceship/helper/net_http_generic_request.rb

@@ -0,0 +1,14 @@
+require 'net/http'
+
+## monkey-patch Net::HTTP
+#
+# Certain apple endpoints return 415 responses if a Content-Type is supplied.
+# Net::HTTP will default a content-type if none is provided by faraday
+# This monkey-patch allows us to leave out the content-type if we do not specify one.
+module Net
+  class HTTPGenericRequest
+    def supply_default_content_type
+      return if content_type
+    end
+  end
+end

data/spaceship/lib/spaceship/helper/plist_middleware.rb

@@ -0,0 +1,15 @@
+require 'faraday_middleware/response_middleware'
+
+module FaradayMiddleware
+  class PlistMiddleware < ResponseMiddleware
+    dependency do
+      require 'plist' unless defined?(::Plist)
+    end
+
+    define_parser do |body|
+      Plist.parse_xml(body)
+    end
+  end
+end
+
+Faraday::Response.register_middleware(plist: FaradayMiddleware::PlistMiddleware)

data/spaceship/lib/spaceship/launcher.rb

@@ -0,0 +1,94 @@
+module Spaceship
+  class Launcher
+    attr_accessor :client
+
+    # Launch a new spaceship, which can be used to maintain multiple instances of
+    # spaceship. You can call `.new` without any parameters, but you'll have to call
+    # `.login` at a later point. If you prefer, you can pass the login credentials
+    # here already.
+    #
+    # 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)
+    #
+    # @param user (String) (optional): The username (usually the email address)
+    # @param password (String) (optional): The password
+    #
+    # @raise InvalidUserCredentialsError: raised if authentication failed
+    def initialize(user = nil, password = nil)
+      @client = PortalClient.new
+
+      if user or password
+        @client.login(user, password)
+      end
+    end
+
+    #####################################################
+    # @!group Login Helper
+    #####################################################
+
+    # 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)
+    #
+    # @param user (String) (optional): The username (usually the email address)
+    # @param password (String) (optional): The password
+    #
+    # @raise InvalidUserCredentialsError: raised if authentication failed
+    #
+    # @return (Spaceship::Client) The client the login method was called for
+    def login(user, password)
+      @client.login(user, password)
+    end
+
+    # 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.
+    #
+    # @return (String) The ID of the select team. You also get the value if
+    #   the user is only in one team.
+    def select_team
+      @client.select_team
+    end
+
+    #####################################################
+    # @!group Helper methods for managing multiple instances of spaceship
+    #####################################################
+
+    # @return (Class) Access the apps for this spaceship
+    def app
+      Spaceship::App.set_client(@client)
+    end
+
+    # @return (Class) Access the app groups for this spaceship
+    def app_group
+      Spaceship::AppGroup.set_client(@client)
+    end
+
+    # @return (Class) Access the devices for this spaceship
+    def device
+      Spaceship::Device.set_client(@client)
+    end
+
+    # @return (Class) Access the certificates for this spaceship
+    def certificate
+      Spaceship::Certificate.set_client(@client)
+    end
+
+    # @return (Class) Access the provisioning profiles for this spaceship
+    def provisioning_profile
+      Spaceship::ProvisioningProfile.set_client(@client)
+    end
+  end
+end

data/spaceship/lib/spaceship/playground.rb

@@ -0,0 +1,72 @@
+require "colored"
+require "credentials_manager"
+
+module Spaceship
+  class Playground
+    def initialize(username: nil)
+      # Make sure the user has pry installed
+      begin
+        Gem::Specification.find_by_name("pry")
+      rescue Gem::LoadError
+        puts("Could not find gem 'pry'".red)
+        puts("")
+        puts("If you installed spaceship using `sudo gem install spaceship` run")
+        puts("  sudo gem install pry".yellow)
+        puts("to install the missing gem")
+        puts("")
+        puts("If you use a Gemfile add this to your Gemfile:")
+        puts("  gem 'pry'".yellow)
+        puts("and run " + "`bundle install`".yellow)
+
+        abort
+      end
+
+      require 'pry'
+
+      @username = username
+      @username ||= CredentialsManager::AppfileConfig.try_fetch_value(:apple_id)
+      @username ||= ask("Username: ")
+    end
+
+    def run
+      begin
+        puts "Logging into to iTunes Connect (#{@username})..."
+        Spaceship::Tunes.login(@username)
+        puts "Successfully logged in to iTunes Connect".green
+        puts ""
+      rescue
+        puts "Could not login to iTunes Connect...".red
+      end
+      begin
+        puts "Logging into the Developer Portal (#{@username})..."
+        Spaceship::Portal.login(@username)
+        puts "Successfully logged in to the Developer Portal".green
+        puts ""
+      rescue
+        puts "Could not login to the Developer Portal...".red
+      end
+
+      puts "---------------------------------------".green
+      puts "| Welcome to the spaceship playground |".green
+      puts "---------------------------------------".green
+      puts ""
+      puts "Enter #{'docs'.yellow} to open up the documentation"
+      puts "Enter #{'exit'.yellow} to exit the spaceship playground"
+      puts "Enter #{'_'.yellow} to access the return value of the last executed command"
+      puts ""
+      puts "Just enter the commands and confirm with Enter".green
+
+      # rubocop:disable Lint/Debugger
+      binding.pry(quiet: true)
+      # rubocop:enable Lint/Debugger
+
+      puts "" # Fixes https://github.com/fastlane/spaceship/issues/203
+    end
+
+    def docs
+      url = 'https://github.com/fastlane/fastlane/tree/master/spaceship/docs'
+      `open '#{url}'`
+      url
+    end
+  end
+end