fastlane 1.111.0 → 2.0.1

data/spaceship/lib/spaceship/tunes/build.rb

@@ -0,0 +1,269 @@
+module Spaceship
+  module Tunes
+    # Represents a build which is inside the build train
+    class Build < TunesBase
+      #####################################################
+      # @!group General metadata
+      #####################################################
+
+      # @return (String) The App identifier of this app, provided by iTunes Connect
+      # @example
+      #   "1013943394"
+      attr_accessor :apple_id
+
+      # @return (Spaceship::Tunes::BuildTrain) A reference to the build train this build is contained in
+      attr_accessor :build_train
+
+      # @return (Integer) The ID generated by iTunes Connect
+      attr_accessor :id
+
+      # @return (Boolean)
+      attr_accessor :valid
+
+      # @return (String) The build version (not the version number), but also is named `build number`
+      attr_accessor :build_version
+
+      # @return (String) The version number (e.g. 1.3)
+      attr_accessor :train_version
+
+      # @return (Boolean) Is this build currently processing?
+      attr_accessor :processing
+
+      # @return (String) The build processing state, may be nil
+      # @example "invalidBinary"
+      # @example "processingFailed"
+      attr_accessor :processing_state
+
+      # @return (Integer) The number of ticks since 1970 (e.g. 1413966436000)
+      attr_accessor :upload_date
+
+      # @return (String) URL to the app icon of this build (150x150px)
+      attr_accessor :icon_url
+
+      # @return (String) The name of the app this build is for
+      attr_accessor :app_name
+
+      # @return (String) The platform of this build (e.g. 'ios')
+      attr_accessor :platform
+
+      # @return (Integer) When is this build going to be invalid
+      attr_accessor :internal_expiry_date
+
+      # @return (Integer): When is the external build going to expire?
+      attr_accessor :external_expiry_date
+
+      # @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 (String) The status of internal testflight testing for this build. One of active, submitForReview, approvedInactive, waiting
+      attr_reader :external_testing_status
+
+      # @return (Bool) Does this build support WatchKit?
+      attr_accessor :watch_kit_enabled
+
+      # @return (Bool):
+      attr_accessor :ready_to_install
+
+      #####################################################
+      # @!group Analytics
+      #####################################################
+
+      # @return (Integer) Number of installs of this build
+      attr_accessor :install_count
+
+      # @return (Integer) Number of installs for this build that come from internal users
+      attr_accessor :internal_install_count
+
+      # @return (Integer) Number of installs for this build that come from external users
+      attr_accessor :external_install_count
+
+      # @return (Integer) Might be nil. The number of sessions for this build
+      attr_accessor :session_count
+
+      # @return (Integer) Might be nil. The number of crashes of this build
+      attr_accessor :crash_count
+
+      attr_mapping(
+        'uploadDate' => :upload_date,
+        'iconUrl' => :icon_url,
+        'buildVersion' => :build_version,
+        'trainVersion' => :train_version,
+        'appName' => :app_name,
+        'platform' => :platform,
+        'id' => :id,
+        'valid' => :valid,
+        'processing' => :processing,
+        'processingState' => :processing_state,
+
+        'installCount' => :install_count,
+        'internalInstallCount' => :internal_install_count,
+        'externalInstallCount' => :external_install_count,
+        'sessionCount' => :session_count,
+        'crashCount' => :crash_count,
+        'internalExpiry' => :internal_expiry_date,
+        'externalExpiry' => :external_expiry_date,
+        'watchKitEnabled' => :watch_kit_enabled,
+        'readyToInstall' => :ready_to_install,
+        'internalTesting.value' => :internal_testing_enabled,
+        'externalTesting.value' => :external_testing_enabled,
+        'buildTestInformationTO.externalStatus' => :external_testing_status
+      )
+
+      class << self
+        # Create a new object based on a hash.
+        # This is used to create a new object based on the server response.
+        def factory(attrs)
+          self.new(attrs)
+        end
+      end
+
+      def setup
+        super
+
+        self.external_expiry_date ||= 0
+        self.internal_expiry_date ||= 0
+      end
+
+      def details
+        response = client.build_details(app_id: self.apple_id,
+                                         train: self.train_version,
+                                  build_number: self.build_version,
+                                      platform: self.platform)
+        response['apple_id'] = self.apple_id
+        BuildDetails.factory(response)
+      end
+
+      def apple_id
+        return @apple_id if @apple_id
+        return self.build_train.application.apple_id
+      end
+
+      def update_build_information!(whats_new: nil,
+                                    description: nil,
+                                    feedback_email: nil)
+        parameters = {
+          app_id: self.apple_id,
+          train: self.train_version,
+          build_number: self.build_version,
+          platform: self.platform
+        }.merge({
+          whats_new: whats_new,
+          description: description,
+          feedback_email: feedback_email
+        })
+        client.update_build_information!(parameters)
+      end
+
+      # This will submit this build for TestFlight beta review
+      # @param metadata [Hash] A hash containing the following information (keys must be symbols):
+      #  {
+      #    # Required Metadata:
+      #     changelog: "Changelog",
+      #     description: "Your Description",
+      #     feedback_email: "Email Address for Feedback",
+      #     marketing_url: "https://marketing.com",
+      #     first_name: "Felix",
+      #     last_name: "Krause",
+      #     review_email: "Contact email address for Apple",
+      #     phone_number: "0128383383",
+      #     review_notes: "Review notes"
+      #
+      #   # Optional Metadata:
+      #     privacy_policy_url: nil,
+      #     review_notes: nil,
+      #     review_user_name: nil,
+      #     review_password: nil,
+      #     encryption: false
+      #  }
+      # Note that iTC will pull a lot of this information from previous builds or the app store information,
+      # all of the required values must be set either in this hash or automatically for this to work
+      def submit_for_beta_review!(metadata)
+        parameters = {
+          app_id: self.apple_id,
+          train: self.train_version,
+          build_number: self.build_version,
+          platform: self.platform
+        }.merge(metadata)
+
+        client.submit_testflight_build_for_review!(parameters)
+
+        return parameters
+      end
+
+      # @return [String] A nicely formatted string about the state of this build
+      # @examples:
+      #   External, Internal, Inactive, Expired
+      def testing_status
+        testing ||= "External" if self.external_testing_enabled
+        testing ||= "Internal" if self.internal_testing_enabled
+
+        if Time.at(self.internal_expiry_date / 1000) > Time.now
+          testing ||= "Inactive"
+        else
+          testing = "Expired"
+        end
+
+        return testing
+      end
+
+      # This will cancel the review process for this TestFlight build
+      def cancel_beta_review!
+        client.remove_testflight_build_from_review!(app_id: self.apple_id,
+                                                     train: self.train_version,
+                                              build_number: self.build_version,
+                                                  platform: self.platform)
+      end
+    end
+  end
+end
+
+# Example Response
+# {"sectionErrorKeys"=>[],
+#  "sectionInfoKeys"=>[],
+#  "sectionWarningKeys"=>[],
+#  "buildVersion"=>"1",
+#  "trainVersion"=>"1.0",
+#  "uploadDate"=>1441975590000,
+#  "iconUrl"=>
+#   "https://is2-ssl.mzstatic.com/image/thumb/Newsstand3/v4/a9/f9/8b/a9f98b23-592d-af2e-6e10-a04873bed5df/Icon-76@2x.png.png/150x150bb-80.png",
+#  "iconAssetToken"=>
+#   "Newsstand3/v4/a9/f9/8b/a9f98b23-592d-af2e-6e10-a04873bed5df/Icon-76@2x.png.png",
+#  "appName"=>"Updated by fastlane",
+#  "platform"=>"ios",
+#  "betaEntitled"=>true,
+#  "exceededFileSizeLimit"=>false,
+#  "wentLiveWithVersion"=>false,
+#  "processing"=>false,
+#  "processingState": nil,
+#  "id"=>5298023,
+#  "valid"=>true,
+#  "missingExportCompliance"=>false,
+#  "waitingForExportComplianceApproval"=>false,
+#  "addedInternalUsersCount"=>0,
+#  "addedExternalUsersCount"=>0,
+#  "invitedExternalUsersCount"=>0,
+#  "invitedInternalUsersCount"=>0,
+#  "acceptedInternalUsersCount"=>1,
+#  "acceptedExternalUsersCount"=>0,
+#  "installCount"=>0,
+#  "internalInstallCount"=>0,
+#  "externalInstallCount"=>0,
+#  "sessionCount"=>0,
+#  "internalSessionCount"=>0,
+#  "externalSessionCount"=>0,
+#  "crashCount"=>0,
+#  "internalCrashCount"=>0,
+#  "externalCrashCount"=>0,
+#  "promotedVersion"=>nil,
+#  "internalState"=>"inactive",
+#  "betaState"=>"submitForReview",
+#  "internalExpiry"=>1444567590000,
+#  "externalExpiry"=>0,
+#  "watchKitEnabled"=>false,
+#  "readyToInstall"=>true,
+#  "sdkBuildWhitelisted"=>true,
+#  "internalTesting"=>{"value"=>false, "isEditable"=>true, "isRequired"=>false, "errorKeys"=>nil},
+#  "externalTesting"=>{"value"=>false, "isEditable"=>true, "isRequired"=>false, "errorKeys"=>nil}

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

@@ -0,0 +1,48 @@
+module Spaceship
+  module Tunes
+    # Represents the details of a build
+    class BuildDetails < TunesBase
+      # @return (String) The App identifier of this app, provided by iTunes Connect
+      # @example
+      #   "1013943394"
+      attr_accessor :apple_id
+
+      # @return (String) Link to the dSYM file (not always available)
+      #     lol, it's unencrypted http
+      attr_accessor :dsym_url
+
+      # @return [Bool]
+      attr_accessor :include_symbols
+
+      # @return [Integer]
+      attr_accessor :number_of_asset_packs
+
+      # @return [Bool]
+      attr_accessor :contains_odr
+
+      # e.g. "13A340"
+      attr_accessor :build_sdk
+
+      # @return [String] e.g. "MyApp.ipa"
+      attr_accessor :file_name
+
+      attr_mapping(
+        'apple_id' => :apple_id,
+        'dsymurl' => :dsym_url,
+        'includesSymbols' => :include_symbols,
+        'numberOfAssetPacks' => :number_of_asset_packs,
+        'containsODR' => :contains_odr,
+        'buildSdk' => :build_sdk,
+        'fileName' => :file_name
+      )
+
+      class << self
+        # Create a new object based on a hash.
+        # This is used to create a new object based on the server response.
+        def factory(attrs)
+          self.new(attrs)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,182 @@
+module Spaceship
+  module Tunes
+    # Represents a build train of builds from iTunes 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(
+        'versionString' => :version_string,
+        'platform' => :platform,
+        'externalTesting.value' => :external_testing_enabled,
+        'internalTesting.value' => :internal_testing_enabled
+      )
+
+      class << self
+        # Create a new object based on a hash.
+        # This is used to create a new object based on the server response.
+        def factory(attrs)
+          self.new(attrs)
+        end
+
+        # @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::TunesClient::ITunesConnectError => 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 << "iTunes 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