fastlane_iac_publish 0.1.0

data/spaceship/lib/spaceship/tunes/availability.rb

@@ -0,0 +1,132 @@
+require_relative 'territory'
+require_relative 'b2b_user'
+module Spaceship
+  module Tunes
+    class Availability < TunesBase
+      # @return (Bool) Are future territories included?
+      attr_accessor :include_future_territories
+
+      # @return (Array of Spaceship::Tunes::Territory objects) A list of the territories
+      attr_accessor :territories
+
+      # @return (Bool) Cleared for preorder
+      attr_accessor :cleared_for_preorder
+
+      # @return (String) App available date in format of "YYYY-MM-DD"
+      attr_accessor :app_available_date
+
+      # @return (Bool) app enabled for b2b users
+      attr_accessor :b2b_app_enabled
+
+      # @return (Bool) app enabled for educational discount
+      attr_accessor :educational_discount
+
+      # @return (Bool) b2b available for distribution
+      attr_accessor :b2b_unavailable
+
+      # @return (Array of Spaceship::Tunes::B2bUser objects) A list of users
+      attr_accessor :b2b_users
+
+      attr_mapping(
+        'theWorld' => :include_future_territories,
+        'preOrder.clearedForPreOrder.value' => :cleared_for_preorder,
+        'preOrder.appAvailableDate.value' => :app_available_date,
+        'b2BAppFlagDisabled' => :b2b_unavailable
+      )
+
+      # Create a new object based on a set of territories.
+      # This will override any values already set for cleared_for_preorder, app_available_date, b2b_unavailable,
+      # b2b_app_enabled, and educational_discount
+      # @param territories (Array of String or Spaceship::Tunes::Territory objects): A list of the territories
+      # @param params (Hash): Optional parameters (include_future_territories (Bool, default: true) Are future territories included?)
+      def self.from_territories(territories = [], params = {})
+        # Initializes the DataHash with our preOrder structure so values
+        # that are being modified will be saved
+        #
+        # Note: A better solution for this in the future might be to improve how
+        # Base::DataHash sets values for paths that don't exist
+        obj = self.new(
+          'preOrder' => {
+            'clearedForPreOrder' => {
+              'value' => false
+            },
+            'appAvailableDate' => {
+              'value' => nil
+            }
+          }
+        )
+
+        # Detect if the territories attribute is an array of Strings and convert to Territories
+        obj.territories =
+          if territories[0].kind_of?(String)
+            territories.map { |territory| Spaceship::Tunes::Territory.from_code(territory) }
+          else
+            territories
+          end
+        obj.include_future_territories = params.fetch(:include_future_territories, true)
+        obj.cleared_for_preorder = params.fetch(:cleared_for_preorder, false)
+        obj.app_available_date = params.fetch(:app_available_date, nil)
+        obj.b2b_unavailable =  params.fetch(:b2b_unavailable, false)
+        obj.b2b_app_enabled =  params.fetch(:b2b_app_enabled, false)
+        obj.educational_discount = params.fetch(:educational_discount, true)
+        return obj
+      end
+
+      def territories
+        @territories ||= raw_data['countries'].map { |info| Territory.new(info) }
+      end
+
+      def b2b_users
+        @b2b_users || raw_data['b2bUsers'].map { |user| B2bUser.new(user) }
+      end
+
+      def b2b_app_enabled
+        @b2b_app_enabled.nil? ? raw_data['b2bAppEnabled'] : @b2b_app_enabled
+      end
+
+      def educational_discount
+        @educational_discount.nil? ? raw_data['educationalDiscount'] : @educational_discount
+      end
+
+      def cleared_for_preorder
+        super || false
+      end
+
+      # Sets `b2b_app_enabled` to true and `educational_discount` to false
+      # Requires users to be added with `add_b2b_users` otherwise `update_availability` will error
+      def enable_b2b_app!
+        raise "Not possible to enable b2b on this app" if b2b_unavailable
+        @b2b_app_enabled = true
+        # need to set the educational discount to false
+        @educational_discount = false
+        return self
+      end
+
+      # Adds users for b2b enabled apps
+      def add_b2b_users(user_list = [])
+        raise "Cannot add b2b users if b2b is not enabled" unless b2b_app_enabled
+        @b2b_users = user_list.map { |user| B2bUser.from_username(user) }
+        return self
+      end
+
+      # Updates users for b2b enabled apps
+      def update_b2b_users(user_list = [])
+        raise "Cannot add b2b users if b2b is not enabled" unless b2b_app_enabled
+
+        added_users = b2b_users.map(&:ds_username)
+
+        # Returns if list is unchanged
+        return self if (added_users - user_list) == (user_list - added_users)
+
+        users_to_add = user_list.reject { |user| added_users.include?(user) }
+        users_to_remove = added_users.reject { |user| user_list.include?(user) }
+
+        @b2b_users = b2b_users.reject { |user| users_to_remove.include?(user.ds_username) }
+        @b2b_users.concat(users_to_add.map { |user| B2bUser.from_username(user) })
+        @b2b_users.concat(users_to_remove.map { |user| B2bUser.from_username(user, is_add_type: false) })
+
+        return self
+      end
+    end
+  end
+end

data/spaceship/lib/spaceship/tunes/b2b_user.rb

@@ -0,0 +1,30 @@
+require_relative 'tunes_base'
+module Spaceship
+  module Tunes
+    class B2bUser < TunesBase
+      # @return (Bool) add the user to b2b list
+      attr_accessor :add
+
+      # @return (Bool) delete the user to b2b list
+      attr_accessor :delete
+
+      # @return (String) b2b username
+      attr_accessor :ds_username
+
+      attr_mapping(
+        'value.add' => :add,
+        'value.delete' => :delete,
+        'value.dsUsername' => :ds_username
+      )
+
+      def self.from_username(username, is_add_type: true)
+        self.new({ 'value' => { 'add' => is_add_type, 'delete' => !is_add_type, 'dsUsername' => username } })
+      end
+
+      # equality check for the two objects
+      def ==(other)
+        add == other.add && delete == other.delete && ds_username == other.ds_username
+      end
+    end
+  end
+end

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

@@ -0,0 +1,263 @@
+require_relative 'build_details'
+
+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 App Store 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 App Store 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
+      )
+
+      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,42 @@
+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 (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
+      )
+    end
+  end
+end