fastlane 2.150.0.rc1 → 2.150.0.rc6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a0da99338a957f184c8f61225f84bbea77cf2e295f9a7fc21918095ec2967e3
-  data.tar.gz: '0998f1c0adaa75fcabb51584113223c552268c9f86c844771bdc27b1f74f10d1'
+  metadata.gz: 87c0c26f1a8fc4baab70230ea4478de1303401d512bce5564c7963f7d52aeee9
+  data.tar.gz: 7093929e2f5d402e0623b5e2873a8178a8fcc74a711595ed9d038ca1e9f39e0d
 SHA512:
-  metadata.gz: 49d0496a16e951b91d512f972d8e5a5f4af1bae7bc68f8a71f32d328b3e1868e0d3b5dfa948723e7c82414f3c2672a6ec73a99884822ccec740aabd2ef1632a7
-  data.tar.gz: 508186460c3e7e4c13bef4f3ad019a5f81374ddaffd32844aa079e02c2165dbb2c454aa2441e150c865aa3c42f526af7dbf494d53911ebfe99cbc02ae2cf5d3d
+  metadata.gz: f836a09c447b7b4ae447f6a78163a978620e104e06bf5f9b46fcbcbcad49baa089e153ab60aec1312d366a55e11369cc149de680d72f8e51582612c471b6f167
+  data.tar.gz: cf0dd78f7208ce467c1be9fa1bd5bb5b9be1ffa8587ad0d9191c0370d41cc3aa8f1e8e92001fbcf7d7ee2e450d074c31111e6fde2eb23a500ced56cff87f34fc

data/deliver/lib/deliver/download_screenshots.rb

@@ -1,4 +1,5 @@
 require_relative 'module'
+require 'spaceship'
 require 'open-uri'
 
 module Deliver
@@ -13,35 +14,56 @@ module Deliver
     end
 
     def self.download(options, folder_path)
-      v = options[:use_live_version] ? options[:app].live_version(platform: options[:platform]) : options[:app].latest_version(platform: options[:platform])
-
-      v.screenshots.each do |language, screenshots|
-        screenshots.each do |screenshot|
-          file_name = [screenshot.sort_order, screenshot.device_type, screenshot.sort_order].join("_")
-          original_file_extension = File.basename(screenshot.original_file_name)
-          file_name += "." + original_file_extension
-
-          UI.message("Downloading existing screenshot '#{file_name}' for language '#{language}'")
-
-          # If the screen shot is for an appleTV we need to store it in a way that we'll know it's an appleTV
-          # screen shot later as the screen size is the same as an iPhone 6 Plus in landscape.
-          if screenshot.device_type == "appleTV"
-            containing_folder = File.join(folder_path, "appleTV", screenshot.language)
-          else
-            containing_folder = File.join(folder_path, screenshot.language)
-          end
+      legacy_app = options[:app]
+      app_id = legacy_app.apple_id
+      app = Spaceship::ConnectAPI::App.get(app_id: app_id)
 
-          if screenshot.is_imessage
-            containing_folder = File.join(folder_path, "iMessage", screenshot.language)
-          end
+      platform = Spaceship::ConnectAPI::Platform.map(options[:platform])
+      if options[:use_live_version]
+        version = app.get_live_app_store_version(platform: platform)
+        UI.user_error!("Could not find a live version on App Store Connect. Try using '--use_live_version false'") if version.nil?
+      else
+        version = app.get_edit_app_store_version(platform: platform)
+        UI.user_error!("Could not find an edit version on App Store Connect. Try using '--use_live_version true'") if version.nil?
+      end
+
+      localizations = version.get_app_store_version_localizations
+      localizations.each do |localization|
+        screenshot_sets = localization.get_app_screenshot_sets
+        screenshot_sets.each do |screenshot_set|
+          screenshot_set.app_screenshots.each_with_index do |screenshot, index|
+            url = screenshot.image_asset_url
+            next if url.nil?
+
+            file_name = [index, screenshot_set.screenshot_display_type, index].join("_")
+            original_file_extension = File.basename(screenshot.file_name)
+            file_name += "." + original_file_extension
+
+            language = localization.locale
+
+            UI.message("Downloading existing screenshot '#{file_name}' for language '#{language}'")
+
+            # If the screen shot is for an appleTV we need to store it in a way that we'll know it's an appleTV
+            # screen shot later as the screen size is the same as an iPhone 6 Plus in landscape.
+            if screenshot_set.apple_tv?
+              containing_folder = File.join(folder_path, "appleTV", language)
+            else
+              containing_folder = File.join(folder_path, language)
+            end
+
+            if screenshot_set.imessage?
+              containing_folder = File.join(folder_path, "iMessage", language)
+            end
+
+            begin
+              FileUtils.mkdir_p(containing_folder)
+            rescue
+              # if it's already there
+            end
 
-          begin
-            FileUtils.mkdir_p(containing_folder)
-          rescue
-            # if it's already there
+            path = File.join(containing_folder, file_name)
+            File.binwrite(path, open(url).read)
           end
-          path = File.join(containing_folder, file_name)
-          File.binwrite(path, open(screenshot.url).read)
         end
       end
     end

data/deliver/lib/deliver/runner.rb

@@ -114,9 +114,6 @@ module Deliver
       # Assign "default" values to all languages
       upload_metadata.assign_defaults(options)
 
-      # Handle app icon / watch icon
-      prepare_app_icons(options)
-
       # Validate
       validate_html(screenshots)
 
@@ -126,20 +123,6 @@ module Deliver
       UploadPriceTier.new.upload(options)
     end
 
-    # If options[:app_icon]/options[:apple_watch_app_icon]
-    # is supplied value/path will be used.
-    # If it is unset files (app_icon/watch_icon) exists in
-    # the fastlane/metadata/ folder, those will be used
-    def prepare_app_icons(options = {})
-      return unless options[:metadata_path]
-
-      default_app_icon_path = Dir[File.join(options[:metadata_path], "app_icon.{png,jpg}")].first
-      options[:app_icon] ||= default_app_icon_path if default_app_icon_path && File.exist?(default_app_icon_path)
-
-      default_watch_icon_path = Dir[File.join(options[:metadata_path], "watch_icon.{png,jpg}")].first
-      options[:apple_watch_app_icon] ||= default_watch_icon_path if default_watch_icon_path && File.exist?(default_watch_icon_path)
-    end
-
     # Upload the binary to App Store Connect
     def upload_binary
       UI.message("Uploading binary to App Store Connect")

data/deliver/lib/deliver/submit_for_review.rb

@@ -59,57 +59,93 @@ module Deliver
 
     def update_export_compliance(options, app, build)
       submission_information = options[:submission_information] || {}
+      submission_information = submission_information.collect { |k, v| [k.to_sym, v] }.to_h
+
       uses_encryption = submission_information[:export_compliance_uses_encryption]
 
-      UI.verbose("Updating build for export compliance status of '#{uses_encryption}'")
       if build.uses_non_exempt_encryption.nil?
+        UI.verbose("Updating build for export compliance status of '#{uses_encryption}'")
+
+        if uses_encryption.to_s.empty?
+          message = [
+            "Export compliance is required to submit",
+            "Add information to the :submission_information option...",
+            "  Docs: http://docs.fastlane.tools/actions/deliver/#compliance-and-idfa-settings",
+            "  Example: submission_information: { export_compliance_uses_encryption: false }",
+            "  Example CLI:",
+            "    --submission_information \"{\\\"export_compliance_uses_encryption\\\": false}\"",
+            "This can also be set in your Info.plist with key 'ITSAppUsesNonExemptEncryption'"
+          ].join("\n")
+          UI.user_error!(message)
+        end
+
         build = build.update(attributes: {
           usesNonExemptEncryption: uses_encryption
         })
+
+        UI.verbose("Successfully updated build for export compliance status of '#{build.uses_non_exempt_encryption}' on App Store Connect")
       end
-      UI.verbose("Updated build for export compliance status of '#{build.uses_non_exempt_encryption}'")
     end
 
     def update_idfa(options, app, version)
       submission_information = options[:submission_information] || {}
-      return unless submission_information.include?(:add_id_info_uses_idfa)
+      submission_information = submission_information.collect { |k, v| [k.to_sym, v] }.to_h
 
       uses_idfa = submission_information[:add_id_info_uses_idfa]
+
       idfa_declaration = begin
                            version.fetch_idfa_declaration
                          rescue
                            nil
                          end
 
-      UI.verbose("Updating app store version for IDFA status of '#{uses_idfa}'")
-      version = version.update(attributes: {
-        usesIdfa: uses_idfa
-      })
-      UI.verbose("Updated app store version for IDFA status of '#{version.uses_idfa}'")
+      updated_idfa = false
+
+      # Set IDFA on version
+      unless uses_idfa.nil?
+        UI.verbose("Updating app store version for IDFA status of '#{uses_idfa}'")
+        version = version.update(attributes: {
+          usesIdfa: uses_idfa
+        })
+        UI.verbose("Updated app store version for IDFA status of '#{version.uses_idfa}'")
+        updated_idfa = true
+      end
+
+      # Error if uses_idfa not set
+      if version.uses_idfa.nil?
+        message = [
+          "Use of Advertising Identifier (IDFA) is required to submit",
+          "Add information to the :submission_information option...",
+          "  Docs: http://docs.fastlane.tools/actions/deliver/#compliance-and-idfa-settings",
+          "  Example: submission_information: { add_id_info_uses_idfa: false }",
+          "  Example: submission_information: {",
+          "    add_id_info_uses_idfa: true,",
+          "    add_id_info_limits_tracking: false,",
+          "    add_id_info_serves_ads: false,",
+          "    add_id_info_uses_idfa: false,",
+          "    add_id_info_tracks_install: false",
+          "  }",
+          "  Example CLI:",
+          "    --submission_information \"{\\\"add_id_info_uses_idfa\\\": false}\""
+        ].join("\n")
+        UI.user_error!(message)
+      end
 
+      # Create, update, or delete IDFA declaration
       if uses_idfa == false
         if idfa_declaration
           UI.verbose("Deleting IDFA delcaration")
           idfa_declaration.delete!
+          updated_idfa = true
           UI.verbose("Deleted IDFA delcaration")
         end
-      else
-        attributes = {}
-        if submission_information.include?(:add_id_info_limits_tracking)
-          attributes[:honorsLimitedAdTracking] = submission_information[:add_id_info_limits_tracking]
-        end
-
-        if submission_information.include?(:add_id_info_serves_ads)
-          attributes[:servesAds] = submission_information[:add_id_info_serves_ads]
-        end
-
-        if submission_information.include?(:add_id_info_tracks_install)
-          attributes[:attributesAppInstallationToPreviousAd] = submission_information[:add_id_info_tracks_install]
-        end
-
-        if submission_information.include?(:add_id_info_tracks_action)
-          attributes[:attributesActionWithPreviousAd] = submission_information[:add_id_info_tracks_action]
-        end
+      elsif uses_idfa == true
+        attributes = {
+          honorsLimitedAdTracking: !!submission_information[:add_id_info_limits_tracking],
+          servesAds: !!submission_information[:add_id_info_serves_ads],
+          attributesAppInstallationToPreviousAd: !!submission_information[:add_id_info_tracks_install],
+          attributesActionWithPreviousAd: !!submission_information[:add_id_info_tracks_action]
+        }
 
         if idfa_declaration
           UI.verbose("Updating IDFA delcaration")
@@ -120,29 +156,37 @@ module Deliver
           version.create_idfa_declaration(attributes: attributes)
           UI.verbose("Created IDFA delcaration")
         end
+
+        updated_idfa = true
       end
 
-      UI.success("Successfully updated IDFA delcarations")
+      UI.success("Successfully updated IDFA delcarations on App Store Connect") if updated_idfa
     end
 
     def update_submission_information(options, app)
       submission_information = options[:submission_information] || {}
-      if submission_information.include?(:content_rights_contains_third_party_content)
-        value = if submission_information[:content_rights_contains_third_party_content]
+      submission_information = submission_information.collect { |k, v| [k.to_sym, v] }.to_h
+
+      content_rights = submission_information[:content_rights_contains_third_party_content]
+
+      unless content_rights.nil?
+        value = if content_rights
                   Spaceship::ConnectAPI::App::ContentRightsDeclaration::USES_THIRD_PARTY_CONTENT
                 else
                   Spaceship::ConnectAPI::App::ContentRightsDeclaration::DOES_NOT_USE_THIRD_PARTY_CONTENT
                 end
 
-        UI.success("Updating contents rights declaration on App Store Connect")
+        UI.verbose("Updating contents rights declaration on App Store Connect")
         app.update(attributes: {
           contentRightsDeclaration: value
         })
+        UI.success("Successfully updated contents rights declaration on App Store Connect")
       end
     end
 
     def wait_for_build_processing_to_be_complete(app: nil, platform: nil, options: nil)
       app_version = options[:app_version]
+
       app_version ||= FastlaneCore::IpaFileAnalyser.fetch_app_version(options[:ipa]) if options[:ipa]
       app_version ||= FastlaneCore::PkgFileAnalyser.fetch_app_version(options[:pkg]) if options[:pkg]
 
@@ -156,11 +200,14 @@ module Deliver
         build_version: app_build,
         poll_interval: 15,
         return_when_build_appears: false,
-        return_spaceship_testflight_build: false
+        return_spaceship_testflight_build: false,
+        select_latest: true
       )
 
-      unless latest_build.app_version == app_version && latest_build.version == app_build
-        UI.important("Uploaded app #{app_version} - #{app_build}, but received build #{latest_build.app_version} - #{latest_build.version}.")
+      if !app_version.nil? && !app_build.nil?
+        unless latest_build.app_version == app_version && latest_build.version == app_build
+          UI.important("Uploaded app #{app_version} - #{app_build}, but received build #{latest_build.app_version} - #{latest_build.version}.")
+        end
       end
 
       return latest_build

data/deliver/lib/deliver/upload_metadata.rb

@@ -192,26 +192,82 @@ module Deliver
       # Update categories
       app_info = app.fetch_edit_app_info
       if app_info
-        app_info.update_categories(
-          primary_category_id: Spaceship::ConnectAPI::AppCategory.map_category_from_itc(
-            options[:primary_category].to_s.strip
-          ),
-          secondary_category_id: Spaceship::ConnectAPI::AppCategory.map_category_from_itc(
-            options[:secondary_category].to_s.strip
-          ),
-          primary_subcategory_one_id: Spaceship::ConnectAPI::AppCategory.map_subcategory_from_itc(
-            options[:primary_first_sub_category].to_s.strip
-          ),
-          primary_subcategory_two_id: Spaceship::ConnectAPI::AppCategory.map_subcategory_from_itc(
-            options[:primary_second_sub_category].to_s.strip
-          ),
-          secondary_subcategory_one_id: Spaceship::ConnectAPI::AppCategory.map_subcategory_from_itc(
-            options[:secondary_first_sub_category].to_s.strip
-          ),
-          secondary_subcategory_two_id: Spaceship::ConnectAPI::AppCategory.map_subcategory_from_itc(
-            options[:secondary_second_sub_category].to_s.strip
+        category_id_map = {}
+
+        primary_category = options[:primary_category].to_s.strip
+        secondary_category = options[:secondary_category].to_s.strip
+        primary_first_sub_category = options[:primary_first_sub_category].to_s.strip
+        primary_second_sub_category = options[:primary_second_sub_category].to_s.strip
+        secondary_first_sub_category = options[:secondary_first_sub_category].to_s.strip
+        secondary_second_sub_category = options[:secondary_second_sub_category].to_s.strip
+
+        mapped_values = {}
+
+        # Only update primary and secondar category if explicitly set
+        unless primary_category.empty?
+          mapped = Spaceship::ConnectAPI::AppCategory.map_category_from_itc(
+            primary_category
+          )
+
+          mapped_values[primary_category] = mapped
+          category_id_map[:primary_category_id] = mapped
+        end
+        unless secondary_category.empty?
+          mapped = Spaceship::ConnectAPI::AppCategory.map_category_from_itc(
+            secondary_category
           )
-        )
+
+          mapped_values[secondary_category] = mapped
+          category_id_map[:secondary_category_id] = mapped
+        end
+
+        # Only set if primary category is going to be set
+        unless primary_category.empty?
+          mapped = Spaceship::ConnectAPI::AppCategory.map_subcategory_from_itc(
+            primary_first_sub_category
+          )
+
+          mapped_values[primary_first_sub_category] = mapped
+          category_id_map[:primary_subcategory_one_id] = mapped
+        end
+        unless primary_category.empty?
+          mapped = Spaceship::ConnectAPI::AppCategory.map_subcategory_from_itc(
+            primary_second_sub_category
+          )
+
+          mapped_values[primary_second_sub_category] = mapped
+          category_id_map[:primary_subcategory_two_id] = mapped
+        end
+
+        # Only set if secondary category is going to be set
+        unless secondary_category.empty?
+          mapped = Spaceship::ConnectAPI::AppCategory.map_subcategory_from_itc(
+            secondary_first_sub_category
+          )
+
+          mapped_values[secondary_first_sub_category] = mapped
+          category_id_map[:secondary_subcategory_one_id] = mapped
+        end
+        unless secondary_category.empty?
+          mapped = Spaceship::ConnectAPI::AppCategory.map_subcategory_from_itc(
+            secondary_second_sub_category
+          )
+
+          mapped_values[secondary_second_sub_category] = mapped
+          category_id_map[:secondary_subcategory_two_id] = mapped
+        end
+
+        # Print deprecation warnings if category was mapped
+        has_mapped_values = false
+        mapped_values.each do |k, v|
+          next if k.nil? || v.nil?
+          next if k == v
+          has_mapped_values = true
+          UI.deprecated("Category '#{k}' from iTunesConnect as been deprecated. Please replace with '#{v}'")
+        end
+        UI.deprecated("You can find more info at https://docs.fastlane.tools/actions/deliver/#reference") if has_mapped_values
+
+        app_info.update_categories(category_id_map: category_id_map)
       end
 
       # Update phased release
@@ -343,7 +399,7 @@ module Deliver
 
       localizations = app_info.get_app_info_localizations
 
-      languages = options[:languages] || []
+      languages = (options[:languages] || []).reject { |lang| lang == "default" }
       locales_to_enable = languages - localizations.map(&:locale)
 
       if locales_to_enable.count > 0
@@ -378,7 +434,7 @@ module Deliver
 
       localizations = version.get_app_store_version_localizations
 
-      languages = options[:languages] || []
+      languages = (options[:languages] || []).reject { |lang| lang == "default" }
       locales_to_enable = languages - localizations.map(&:locale)
 
       if locales_to_enable.count > 0
@@ -517,13 +573,28 @@ module Deliver
       UI.message("Setting the app's age rating...")
 
       # Maping from legacy ITC values to App Store Connect Values
+      mapped_values = {}
       attributes = {}
       json.each do |k, v|
         new_key = Spaceship::ConnectAPI::AgeRatingDeclaration.map_key_from_itc(k)
         new_value = Spaceship::ConnectAPI::AgeRatingDeclaration.map_value_from_itc(new_key, v)
+
+        mapped_values[k] = new_key
+        mapped_values[v] = new_value
+
         attributes[new_key] = new_value
       end
 
+      # Print deprecation warnings if category was mapped
+      has_mapped_values = false
+      mapped_values.each do |k, v|
+        next if k.nil? || v.nil?
+        next if k == v
+        has_mapped_values = true
+        UI.deprecated("Age rating '#{k}' from iTunesConnect as been deprecated. Please replace with '#{v}'")
+      end
+      UI.deprecated("You can find more info at https://docs.fastlane.tools/actions/deliver/#reference") if has_mapped_values
+
       age_rating_delcaration = version.fetch_age_rating_declaration
       age_rating_delcaration.update(attributes: attributes)
     end