fastlane_hotfix 2.187.0

data/spaceship/lib/spaceship/tunes/build_details.rb

@@ -0,0 +1,184 @@
+require_relative 'tunes_base'
+
+module Spaceship
+  module Tunes
+    # Represents the details of a build
+    class BuildDetails < TunesBase
+      # @return (String) The App identifier of this app, provided by App Store Connect
+      # @example
+      #   '1013943394'
+      attr_accessor :apple_id
+
+      # @return (Integer) Upload date of build as UNIX timestamp
+      # @example 1563813377000
+      attr_accessor :upload_date
+
+      # @return (String) State of the build/binary
+      # @example 'ITC.apps.preReleaseBuildStatus.Validated'
+      attr_accessor :binary_state
+
+      # @return (String) Name of uploaded file
+      # @example 'MyApp.ipa'
+      attr_accessor :file_name
+
+      # @return (String) SDK used to build app
+      # @example '13A340'
+      attr_accessor :build_sdk
+
+      # @return (String) Platform
+      # @example '13A340'
+      attr_accessor :build_platform
+
+      # @return (String) Bundle ID of build
+      # @example 'com.sample.app'
+      attr_accessor :bundle_id
+
+      # @return (String) Name of app
+      # @example 'Test App'
+      attr_accessor :app_name
+
+      # @return (String) Supported architectures of the build
+      # @example 'armv7, arm64'
+      attr_accessor :supported_architectures
+
+      # @return (String) Localizations of the build
+      # @example 'English'
+      attr_accessor :localizations
+
+      # @return (Boolean) Is this a Newsstand app?
+      # @example false
+      attr_accessor :newsstand_app
+
+      # @return (Boolean) Does the build contain an app icon?
+      # @example true
+      attr_accessor :prerendered_icon_flag
+
+      # @return [Hash] containing all entitlements for all targets
+      # @example 'Sample.app/Sample: {'com.apple.developer.team-identifier': 'ABC123DEF456'}'
+      attr_accessor :entitlements
+
+      # @return (String) Platform of the app
+      # @example 'ios'
+      attr_accessor :app_plattform
+
+      # @return (String) Device Requirements / Device Protocols
+      attr_accessor :device_protocols
+
+      # @return (String) Version code of the build
+      # @example '4'
+      attr_accessor :cf_bundle_version
+
+      # @return (String) Version code of the build train
+      # @example '1.6'
+      attr_accessor :cf_bundle_short_version
+
+      # @return (String) Minimum iOS Version
+      # @example '9.3'
+      attr_accessor :min_os_version
+
+      # @return (String) Enabled Device Family
+      # @example 'iPhone / iPod touch, iPad''
+      attr_accessor :device_families
+
+      # @return (String) Required Capabilities
+      # @example 'armv7'
+      attr_accessor :capabilities
+
+      # @return (Int) Compressed File Size in bytes
+      # @example '9365224'
+      attr_accessor :size_in_bytes
+
+      # @return (Hash) Estimated App Store file sizes for all devices in bytes
+      attr_accessor :sizes_in_bytes
+
+      # @return (Hash) Estimated App Store file sizes for all devices in bytes
+      attr_accessor :sizes_in_bytes_with_device_loc
+
+      # @return (Boolean) Contains On Demand Resources
+      # @example false
+      attr_accessor :contains_odr
+
+      # @return (Integer) Number of Asset packs
+      # @example 0
+      attr_accessor :number_of_asset_packs
+
+      # @return (Boolean) Includes Symbols
+      # @example true
+      attr_accessor :include_symbols
+
+      # @return (Boolean) App Uses Non-Exempt Encryption (Optional)
+      # @example null
+      attr_accessor :use_encryption_in_plist
+
+      # @return (Boolean) App Encryption Export Compliance Code (Optional)
+      # @example null
+      attr_accessor :export_compliance_code_value_in_plist
+
+      # @return (Boolean) Includes Stickers
+      # @example false
+      attr_accessor :has_stickers
+
+      # @return (Boolean) Includes iMessage App
+      # @example false
+      attr_accessor :has_messages_extension
+
+      # @return (Boolean) // Not sure what this is for
+      # @example false
+      attr_accessor :launch_prohibited
+
+      # @return (Boolean) Uses SiriKit
+      # @example false
+      attr_accessor :uses_synapse
+
+      # @return (Boolean) App uses Location Services
+      # @example false
+      attr_accessor :uses_location_background_mode
+
+      # @return (String) Link to the dSYM file (not always available)
+      # @example build/***.****.*****.*****-1.0.0-2647.dSYM.zip
+      attr_accessor :dsym_url
+
+      # @return (Boolean) Watch-Only App
+      # @example false
+      attr_accessor :watch_only
+
+      attr_mapping(
+        'apple_id' => :apple_id,
+        'uploadDate' => :upload_date,
+        'binaryState' => :binary_state,
+        'fileName' => :file_name,
+        'buildSdk' => :build_sdk,
+        'buildPlatform' => :build_platform,
+        'bundleId' => :bundle_id,
+        'appName' => :app_name,
+        'supportedArchitectures' => :supported_architectures,
+        'localizations' => :localizations,
+        'newsstandApp' => :newsstand_app,
+        'prerenderedIconFlag' => :prerendered_icon_flag,
+        'entitlements' => :entitlements,
+        'appPlatform' => :app_platform,
+        'deviceProtocols' => :device_protocols,
+        'cfBundleVersion' => :cf_bundle_version,
+        'cfBundleShortVersion' => :cf_bundle_short_version,
+        'minOsVersion' => :min_os_version,
+        'deviceFamilies' => :device_families,
+        'capabilities' => :capabilities,
+        'sizeInBytes' => :size_in_bytes,
+        'sizesInBytes' => :sizes_in_bytes,
+        'sizesInBytesWithDeviceLoc' => :sizes_in_bytes_with_device_loc,
+        'containsODR' => :contains_odr,
+        'numberOfAssetPacks' => :number_of_asset_packs,
+        'includesSymbols' => :include_symbols,
+        'useEncryptionInPlist' => :use_encryption_in_plist,
+        'exportComplianceCodeValueInPlist' => :export_compliance_code_value_in_plist,
+        'hasStickers' => :has_stickers,
+        'hasMessagesExtension' => :has_messages_extension,
+        'launchProhibited' => :launch_prohibited,
+        'usesSynapse' => :uses_synapse,
+        'usesLocationBackgroundMode' => :uses_location_background_mode,
+        'dsymurl' => :dsym_url,
+        'watchOnly' => :watch_only
+      )
+    end
+  end
+end

data/spaceship/lib/spaceship/tunes/build_train.rb

@@ -0,0 +1,181 @@
+require_relative 'tunes_base'
+require_relative 'errors'
+require_relative 'build'
+
+module Spaceship
+  module Tunes
+    # Represents a build train of builds from App Store Connect
+    # A build train is all builds for a given version number with different build numbers
+    class BuildTrain < TunesBase
+      # @return (Spaceship::Tunes::Application) A reference to the application this train is for
+      attr_accessor :application
+
+      # @return (Spaceship::Tunes::VersionSet) A reference to the version set
+      #   this train is for
+      attr_accessor :version_set
+
+      # @return (Array) An array of all builds that are inside this train (Spaceship::Tunes::Build)
+      attr_reader :builds
+
+      # @return (String) The version number of this train
+      attr_reader :version_string
+
+      # @return (String) Platform (e.g. "ios")
+      attr_reader :platform
+
+      # @return (Bool) Is external beta testing enabled for this train? Only one train can have enabled testing.
+      attr_reader :external_testing_enabled
+
+      # @return (Bool) Is internal beta testing enabled for this train? Only one train can have enabled testing.
+      attr_reader :internal_testing_enabled
+
+      # @return (Array) An array of all processing builds that are inside this train (Spaceship::Tunes::Build)
+      # Does not include invalid builds.
+      #  I never got this to work to properly try and debug this
+      attr_reader :processing_builds
+
+      # @return (Array) An array of all invalid builds that are inside this train
+      attr_reader :invalid_builds
+
+      attr_mapping(
+        'application' => 'application',
+        'versionString' => :version_string,
+        'platform' => :platform,
+        'externalTesting.value' => :external_testing_enabled,
+        'internalTesting.value' => :internal_testing_enabled
+      )
+
+      class << self
+        # @param application (Spaceship::Tunes::Application) The app this train is for
+        # @param app_id (String) The unique Apple ID of this app
+        def all(application, app_id, platform: nil)
+          trains = []
+          trains += client.build_trains(app_id, 'internal', platform: platform)['trains']
+          trains += client.build_trains(app_id, 'external', platform: platform)['trains']
+
+          result = {}
+          trains.each do |attrs|
+            attrs[:application] = application
+            current = self.factory(attrs)
+            if (!platform.nil? && current.platform == platform) || platform.nil?
+              result[current.version_string] = current
+            end
+          end
+          result
+        end
+      end
+
+      # Setup all the builds and processing builds
+      def setup
+        super
+
+        @builds = (self.raw_data['builds'] || []).collect do |attrs|
+          attrs[:build_train] = self
+          Tunes::Build.factory(attrs)
+        end
+
+        @invalid_builds = @builds.select do |build|
+          build.processing_state == 'processingFailed' || build.processing_state == 'invalidBinary'
+        end
+
+        # This step may not be necessary anymore - it seems as if every processing build will be caught by the
+        # @builds.each below, but not every processing build makes it to buildsInProcessing, so this is redundant
+        @processing_builds = (self.raw_data['buildsInProcessing'] || []).collect do |attrs|
+          attrs[:build_train] = self
+          Tunes::Build.factory(attrs)
+        end
+
+        # since buildsInProcessing appears empty, fallback to also including processing state from @builds
+        @builds.each do |build|
+          # What combination of attributes constitutes which state is pretty complicated. The table below summarizes
+          # what I've observed, but there's no reason to believe there aren't more states I just haven't seen yet.
+          # The column headers are qualitative states of a given build, and the first column is the observed attributes
+          # of that build.
+          # NOTE: Some of the builds in the build_trains.json fixture do not follow these rules. I don't know if that is
+          # because those examples are older, and the iTC API has changed, or if their format is still a possibility.
+          # The second part of the OR clause in the line below exists so that those suspicious examples continue to be
+          # accepted for unit tests.
+          # +---------------------+-------------------+-------------------+-----------------+--------------------+---------+
+          # |                     | just after upload | normal processing | invalid binary  | processing failed  | success |
+          # +---------------------+-------------------+-------------------+-----------------+--------------------+---------+
+          # |  build.processing = | true              | true              | true            | true               | false   |
+          # |       build.valid = | false             | true              | false           | true               | true    |
+          # | .processing_state = | "processing"      | "processing"      | "invalidBinary" | "processingFailed" | nil     |
+          # +---------------------+-------------------+-------------------+-----------------+--------------------+---------+
+          if build.processing_state == 'processing' || (build.processing && build.processing_state != 'invalidBinary' && build.processing_state != 'processingFailed')
+            @processing_builds << build
+          end
+        end
+
+        self.version_set = self.application.version_set_for_platform(self.platform)
+      end
+
+      # @return (Spaceship::Tunes::Build) The latest build for this train, sorted by upload time.
+      def latest_build
+        @builds.max_by(&:upload_date)
+      end
+
+      # @param (testing_type) internal or external
+      def update_testing_status!(new_value, testing_type, build = nil)
+        build ||= latest_build if testing_type == 'external'
+        platform = build ? build.platform : self.application.platform
+        testing_key = "#{testing_type}Testing"
+
+        data = client.build_trains(self.application.apple_id, testing_type, platform: platform)
+
+        # Delete the irrelevant trains and update the relevant one to enable testing
+        data['trains'].delete_if do |train|
+          if train['versionString'] != version_string
+            true
+          else
+            train[testing_key]['value'] = new_value
+
+            # also update the builds
+            train['builds'].delete_if do |b|
+              if b[testing_key].nil?
+                true
+              elsif build && b["buildVersion"] == build.build_version
+                b[testing_key]['value'] = new_value
+                false
+              elsif b[testing_key]['value'] == true
+                b[testing_key]['value'] = false
+                false
+              else
+                true
+              end
+            end
+
+            false
+          end
+        end
+
+        begin
+          result = client.update_build_trains!(application.apple_id, testing_type, data)
+        rescue Spaceship::Tunes::Error => ex
+          if ex.to_s.include?("You must provide an answer for this question")
+            # This is a very common error message that's raised by TestFlight
+            # We want to show a nicer error message with instructions on how
+            # to resolve the underlying issue
+            # https://github.com/fastlane/fastlane/issues/1873
+            # https://github.com/fastlane/fastlane/issues/4002
+            error_message = [""] # to have a nice new-line in the beginning
+            error_message << "TestFlight requires you to provide the answer to the encryption question"
+            error_message << "to provide the reply, please add the following to your Info.plist file"
+            error_message << ""
+            error_message << "<key>ITSAppUsesNonExemptEncryption</key><false/>"
+            error_message << ""
+            error_message << "Afterwards re-build your app and try again"
+            error_message << "App Store Connect reported: '#{ex}'"
+            raise error_message.join("\n")
+          else
+            raise ex
+          end
+        end
+        self.internal_testing_enabled = new_value if testing_type == 'internal'
+        self.external_testing_enabled = new_value if testing_type == 'external'
+
+        result
+      end
+    end
+  end
+end

data/spaceship/lib/spaceship/tunes/developer_response.rb

@@ -0,0 +1,23 @@
+require_relative 'tunes_base'
+
+module Spaceship
+  module Tunes
+    class DeveloperResponse < TunesBase
+      attr_reader :id
+      attr_reader :response
+      attr_reader :last_modified
+      attr_reader :hidden
+      attr_reader :state
+      attr_accessor :application
+      attr_accessor :review_id
+
+      attr_mapping({
+        'responseId' => :id,
+        'response' => :response,
+        'lastModified' => :last_modified,
+        'isHidden' => :hidden,
+        'pendingState' => :state
+      })
+    end
+  end
+end

data/spaceship/lib/spaceship/tunes/device_type.rb

@@ -0,0 +1,17 @@
+require_relative "display_family"
+
+module Spaceship
+  module Tunes
+    # identifiers of devices that App Store Connect accepts screenshots for
+    class DeviceType
+      def self.types
+        warn("Spaceship::Tunes::DeviceType has been deprecated, use Spaceship::Tunes::DisplayFamily instead. (https://github.com/fastlane/fastlane/pull/14574).")
+        return DisplayFamily.all.map(&:name)
+      end
+
+      def self.exists?(type)
+        types.include?(type)
+      end
+    end
+  end
+end

data/spaceship/lib/spaceship/tunes/display_family.rb

@@ -0,0 +1,84 @@
+require_relative "../module"
+
+module Spaceship
+  module Tunes
+    # A definition of different styled displays used by devices
+    # that App Store Connect supports storing screenshots.
+    # Display styles often only vary based on screen resolution
+    # however other aspects of a displays physical appearance are
+    # also factored (i.e if the home indicator is provided via
+    # a hardware button or a software interface).
+    class DisplayFamily
+      # The display family name from the App Store Connect API that
+      # is used when uploading or listing screenshots. This value is
+      # then assigned to the
+      # Spaceship::Tunes::AppScreenshot#device_type attribute.
+      attr_accessor :name
+
+      # The user friendly name of this definition.
+      #
+      # Source: Media Manager in App Store Connect.
+      attr_accessor :friendly_name
+
+      # The user friendly category for this definition (i.e iPhone,
+      # Apple TV or Desktop).
+      attr_accessor :friendly_category_name
+
+      # An array of supported screen resolutions (in pixels) that are
+      # supported for the associated device.
+      #
+      # Source: https://help.apple.com/app-store-connect/#/devd274dd925
+      attr_accessor :screenshot_resolutions
+
+      # An internal identifier for the same device definition used
+      # in the DUClient.
+      #
+      # Source: You can find this by uploading an image in App Store
+      # Connect using your browser and then look for the
+      # X-Apple-Upload-Validation-RuleSets value in the uploads
+      # request headers.
+      attr_accessor :picture_type
+
+      # Similar to `picture_type`, but for iMessage screenshots.
+      attr_accessor :messages_picture_type
+
+      # Identifies if the device definition supports iMessage screenshots.
+      def messages_supported?
+        true unless messages_picture_type.nil?
+      end
+
+      # Finds a DisplayFamily definition.
+      #
+      # @param name (Symbol|String) The name of the display family being searched for.
+      # @return DisplayFamily object matching the given name.
+      def self.find(name)
+        name = name.to_sym if name.kind_of?(String)
+        lookup[name]
+      end
+
+      # All DisplayFamily types currently supported by App Store Connect.
+      def self.all
+        lookup.values
+      end
+
+      private_class_method
+
+      def self.lookup
+        return @lookup if defined?(@lookup)
+        display_families = JSON.parse(File.read(File.join(Spaceship::ROOT, "lib", "assets", "displayFamilies.json")))
+        @lookup ||= display_families.map { |data| [data["name"].to_sym, DisplayFamily.new(data)] }.to_h
+      end
+
+      private
+
+      def initialize(data)
+        @name = data["name"]
+        @friendly_name = data["friendly_name"]
+        @friendly_category_name = data["friendly_category_name"]
+        @screenshot_resolutions = data["screenshot_resolutions"]
+        @picture_type = data["picture_type"]
+        @messages_picture_type = data["messages_picture_type"]
+      end
+    end
+  end
+end