fastlane_iac_publish 0.1.0

data/spaceship/lib/spaceship/tunes/app_details.rb

@@ -0,0 +1,147 @@
+require_relative 'errors'
+require_relative 'language_item'
+require_relative 'tunes_base'
+
+module Spaceship
+  module Tunes
+    class AppDetails < TunesBase
+      attr_accessor :application
+
+      ####
+      # Localized values
+      ####
+
+      # @return (Array) Raw access the all available languages. You shouldn't use it probbaly
+      attr_accessor :languages
+
+      # @return (Hash) A hash representing the app name in all languages
+      attr_reader :name
+
+      # @return (Hash) A hash representing the subtitle in all languages
+      attr_reader :subtitle
+
+      # @return (Hash) A hash representing the privacy URL in all languages
+      attr_reader :privacy_url
+
+      # @return (Hash) A hash prepresenting the privacy URL in all languages for Apple TV
+      attr_reader :apple_tv_privacy_policy
+
+      # Categories (e.g. MZGenre.Business)
+      attr_accessor :primary_category
+
+      attr_accessor :primary_first_sub_category
+
+      attr_accessor :primary_second_sub_category
+
+      attr_accessor :secondary_category
+
+      attr_accessor :secondary_first_sub_category
+
+      attr_accessor :secondary_second_sub_category
+
+      attr_accessor :primary_locale_code
+
+      attr_accessor :available_primary_locale_codes
+
+      attr_mapping(
+        'localizedMetadata.value' => :languages,
+        'primaryCategory.value' => :primary_category,
+        'primaryFirstSubCategory.value' => :primary_first_sub_category,
+        'primarySecondSubCategory.value' => :primary_second_sub_category,
+        'secondaryCategory.value' => :secondary_category,
+        'secondaryFirstSubCategory.value' => :secondary_first_sub_category,
+        'secondarySecondSubCategory.value' => :secondary_second_sub_category,
+        'primaryLocaleCode.value' => :primary_locale_code,
+        'availablePrimaryLocaleCodes' => :available_primary_locale_codes
+      )
+
+      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)
+          obj = self.new(attrs)
+          obj.unfold_languages
+
+          return obj
+        end
+      end
+
+      # Prefill name, privacy url
+      def unfold_languages
+        {
+          name: :name,
+          subtitle: :subtitle,
+          privacyPolicyUrl: :privacy_url,
+          privacyPolicy: :apple_tv_privacy_policy
+        }.each do |json, attribute|
+          instance_variable_set("@#{attribute}".to_sym, LanguageItem.new(json, languages))
+        end
+      end
+
+      # Push all changes that were made back to App Store Connect
+      def save!
+        client.update_app_details!(application.apple_id, raw_data)
+      rescue Spaceship::Tunes::Error => ex
+        if ex.to_s == "operation_failed"
+          # That's alright, we get this error message if nothing has changed
+        else
+          raise ex
+        end
+      end
+
+      # Custom Setters
+      #
+      def primary_category=(value)
+        value = prefix_apps(value)
+        value = prefix_mzgenre(value)
+        super(value)
+      end
+
+      def primary_first_sub_category=(value)
+        value = prefix_apps(value)
+        value = prefix_mzgenre(value)
+        super(value)
+      end
+
+      def primary_second_sub_category=(value)
+        value = prefix_apps(value)
+        value = prefix_mzgenre(value)
+        super(value)
+      end
+
+      def secondary_category=(value)
+        value = prefix_apps(value)
+        value = prefix_mzgenre(value)
+        super(value)
+      end
+
+      def secondary_first_sub_category=(value)
+        value = prefix_apps(value)
+        value = prefix_mzgenre(value)
+        super(value)
+      end
+
+      def secondary_second_sub_category=(value)
+        value = prefix_apps(value)
+        value = prefix_mzgenre(value)
+        super(value)
+      end
+
+      #####################################################
+      # @!group General
+      #####################################################
+      def setup; end
+
+      private
+
+      def prefix_mzgenre(value)
+        value.include?("MZGenre") ? value : "MZGenre.#{value}"
+      end
+
+      def prefix_apps(value)
+        return value unless value.include?("Stickers")
+        value.include?("Apps") ? value : "Apps.#{value}"
+      end
+    end
+  end
+end

data/spaceship/lib/spaceship/tunes/app_image.rb

@@ -0,0 +1,51 @@
+require_relative 'tunes_base'
+
+module Spaceship
+  module Tunes
+    # Represents an image hosted on App Store Connect. Used for icons, screenshots, etc
+    class AppImage < TunesBase
+      HOST_URL = "https://is1-ssl.mzstatic.com/image/thumb"
+
+      attr_accessor :asset_token
+
+      attr_accessor :sort_order
+
+      attr_accessor :original_file_name
+
+      attr_accessor :url
+
+      attr_accessor :is_imessage
+
+      attr_mapping(
+        'assetToken' => :asset_token,
+        'sortOrder' => :sort_order,
+        'url' => :url,
+        'originalFileName' => :original_file_name
+      )
+
+      def reset!(attrs = {})
+        update_raw_data!(
+          {
+            asset_token: nil,
+            original_file_name: nil,
+            sort_order: nil,
+            url: nil
+          }.merge(attrs)
+        )
+      end
+
+      def setup
+        # Since September 2015 we don't get the url any more, so we have to manually build it
+        self.url = "#{HOST_URL}/#{self.asset_token}/0x0ss.jpg"
+      end
+
+      private
+
+      def update_raw_data!(hash)
+        hash.each do |k, v|
+          self.send("#{k}=", v)
+        end
+      end
+    end
+  end
+end

data/spaceship/lib/spaceship/tunes/app_ratings.rb

@@ -0,0 +1,58 @@
+require_relative 'app_review'
+
+module Spaceship
+  module Tunes
+    # Represents app ratings from App Store Connect
+    class AppRatings < TunesBase
+      # @return (Spaceship::Tunes::Application) A reference to the application
+      #   this version is for
+      attr_accessor :application
+
+      # @return (Integer) total number of ratings recevied
+      attr_accessor :rating_count
+
+      # @return (Integer) total number of one star ratings recevied
+      attr_accessor :one_star_rating_count
+
+      # @return (Integer) total number of two star ratings recevied
+      attr_accessor :two_star_rating_count
+
+      # @return (Integer) total number of three star ratings recevied
+      attr_accessor :three_star_rating_count
+
+      # @return (Integer) total number of four star ratings recevied
+      attr_accessor :four_star_rating_count
+
+      # @return (Integer) total number of five star ratings recevied
+      attr_accessor :five_star_rating_count
+
+      attr_mapping({
+        'reviewCount' => :review_count,
+        'ratingCount' => :rating_count,
+        'ratingOneCount' => :one_star_rating_count,
+        'ratingTwoCount' => :two_star_rating_count,
+        'ratingThreeCount' => :three_star_rating_count,
+        'ratingFourCount' => :four_star_rating_count,
+        'ratingFiveCount' => :five_star_rating_count
+      })
+
+      # @return (Float) the average rating for this summary (rounded to 2 decimal places)
+      def average_rating
+        ((one_star_rating_count +
+          (two_star_rating_count * 2) +
+          (three_star_rating_count * 3) +
+          (four_star_rating_count * 4) +
+          (five_star_rating_count * 5)) / rating_count.to_f).round(2)
+      end
+
+      # @return (Array) of Review Objects
+      def reviews(store_front = '', version_id = '', upto_date = nil)
+        raw_reviews = client.get_reviews(application.apple_id, application.platform, store_front, version_id, upto_date)
+        raw_reviews.map do |review|
+          review["value"]["application"] = self.application
+          AppReview.factory(review["value"])
+        end
+      end
+    end
+  end
+end

data/spaceship/lib/spaceship/tunes/app_review.rb

@@ -0,0 +1,55 @@
+require_relative 'developer_response'
+
+module Spaceship
+  module Tunes
+    class AppReview < TunesBase
+      attr_accessor :application
+      attr_reader :rating
+      attr_reader :id
+      attr_reader :title
+      attr_reader :review
+      attr_reader :nickname
+      attr_reader :store_front
+      attr_reader :app_version
+      attr_reader :last_modified
+      attr_reader :helpful_views
+      attr_reader :total_views
+      attr_reader :edited
+      attr_reader :raw_developer_response
+      attr_accessor :developer_response
+
+      attr_mapping({
+        'id' => :id,
+        'rating' => :rating,
+        'title' => :title,
+        'review' => :review,
+        'nickname' => :nickname,
+        'storeFront' => :store_front,
+        'appVersionString' => :app_version,
+        'lastModified' => :last_modified,
+        'helpfulViews' => :helpful_views,
+        'totalViews' => :total_views,
+        'edited' => :edited,
+        'developerResponse' => :raw_developer_response
+      })
+      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)
+          obj = self.new(attrs)
+          response_attrs = {}
+          response_attrs = obj.raw_developer_response if obj.raw_developer_response
+          response_attrs[:application] = obj.application
+          response_attrs[:review_id] = obj.id
+          obj.developer_response = DeveloperResponse.factory(response_attrs)
+          return obj
+        end
+      end
+
+      def responded?
+        return true if raw_developer_response
+        false
+      end
+    end
+  end
+end

data/spaceship/lib/spaceship/tunes/app_review_attachment.rb

@@ -0,0 +1,49 @@
+require_relative 'tunes_base'
+
+module Spaceship
+  module Tunes
+    # Represents an image hosted on App Store Connect. Used for app store review attachment file.
+    class AppReviewAttachment < TunesBase
+      HOST_URL = "https://iosapps-ssl.itunes.apple.com/itunes-assets"
+
+      attr_accessor :asset_token
+
+      attr_accessor :original_file_name
+
+      attr_accessor :url
+
+      attr_accessor :type_of_file
+
+      attr_mapping(
+        'assetToken' => :asset_token,
+        'fileType' => :type_of_file,
+        'url' => :url,
+        'name' => :original_file_name
+      )
+
+      def reset!(attrs = {})
+        update_raw_data!(
+          {
+            asset_token: nil,
+            type_of_file: nil,
+            url: nil,
+            original_file_name: nil
+          }.merge(attrs)
+        )
+      end
+
+      def setup
+        # Since September 2015 we don't get the url any more, so we have to manually build it
+        self.url = "#{HOST_URL}/#{self.asset_token}"
+      end
+
+      private
+
+      def update_raw_data!(hash)
+        hash.each do |k, v|
+          self.send("#{k}=", v)
+        end
+      end
+    end
+  end
+end

data/spaceship/lib/spaceship/tunes/app_screenshot.rb

@@ -0,0 +1,12 @@
+require_relative 'app_image'
+
+module Spaceship
+  module Tunes
+    # Represents a screenshot hosted on App Store Connect
+    class AppScreenshot < Spaceship::Tunes::AppImage
+      attr_accessor :device_type
+
+      attr_accessor :language
+    end
+  end
+end

data/spaceship/lib/spaceship/tunes/app_status.rb

@@ -0,0 +1,63 @@
+module Spaceship
+  module Tunes
+    # Defines the different states of the app
+    #
+    # As specified by Apple: https://developer.apple.com/library/ios/documentation/LanguagesUtilities/Conceptual/iTunesConnect_Guide/Chapters/ChangingAppStatus.html
+    module AppStatus
+      # You can edit this version, upload new binaries and more
+      PREPARE_FOR_SUBMISSION = "Prepare for Submission"
+
+      # App is currently live in the App Store
+      READY_FOR_SALE = "Ready for Sale"
+
+      # Waiting for Apple's Review
+      WAITING_FOR_REVIEW = "Waiting For Review"
+
+      # Currently in Review
+      IN_REVIEW = "In Review"
+
+      # App rejected for whatever reason
+      REJECTED = "Rejected"
+
+      # The developer took the app from the App Store
+      DEVELOPER_REMOVED_FROM_SALE = "Developer Removed From Sale"
+
+      # Developer rejected this version/binary
+      DEVELOPER_REJECTED = "Developer Rejected"
+
+      # You have to renew your Apple account to keep using App Store Connect
+      PENDING_CONTRACT = "Pending Contract"
+
+      UPLOAD_RECEIVED = "Upload Received"
+      PENDING_DEVELOPER_RELEASE = "Pending Developer Release"
+      PROCESSING_FOR_APP_STORE = "Processing for App Store"
+      # WAITING_FOR_EXPORT_COMPLIANCE = "Waiting For Export Compliance"
+      METADATA_REJECTED = "Metadata Rejected"
+      REMOVED_FROM_SALE = "Removed From Sale"
+      # INVALID_BINARY = "Invalid Binary"
+
+      # Get the app status matching based on a string (given by App Store Connect)
+      def self.get_from_string(text)
+        mapping = {
+          'readyForSale' => READY_FOR_SALE,
+          'prepareForUpload' => PREPARE_FOR_SUBMISSION,
+          'devRejected' => DEVELOPER_REJECTED,
+          'pendingContract' => PENDING_CONTRACT,
+          'developerRemovedFromSale' => DEVELOPER_REMOVED_FROM_SALE,
+          'waitingForReview' => WAITING_FOR_REVIEW,
+          'inReview' => IN_REVIEW,
+          'rejected' => REJECTED,
+          'pendingDeveloperRelease' => PENDING_DEVELOPER_RELEASE,
+          'metadataRejected' => METADATA_REJECTED,
+          'removedFromSale' => REMOVED_FROM_SALE
+        }
+
+        mapping.each do |k, v|
+          return v if k == text
+        end
+
+        return nil
+      end
+    end
+  end
+end

data/spaceship/lib/spaceship/tunes/app_submission.rb

@@ -0,0 +1,161 @@
+require_relative 'tunes_base'
+
+module Spaceship
+  module Tunes
+    # Represents a submission for review of an App Store Connect Application
+    # This class handles the submission of all review information and documents
+    class AppSubmission < TunesBase
+      # @return (Spaceship::Tunes::Application) A reference to the application
+      #   this submission is for
+      attr_accessor :application
+
+      # @return (AppVersion) The version to use for this submission
+      attr_accessor :version
+
+      # @return (String) The platform of the device. This is usually "ios"
+      # @example
+      #   "appletvos"
+      attr_accessor :platform
+
+      # @return (Boolean) Submitted for Review
+      attr_accessor :submitted_for_review
+
+      # To pass from the user
+
+      # @deprecated Setted automatically by <tt>add_id_info_uses_idfa</tt> usage
+      # @return (Boolean) Ad ID Info - Limits ads tracking
+      # <b>DEPRECATED:</b> Use <tt>add_id_info_uses_idfa</tt> instead.
+      attr_accessor :add_id_info_limits_tracking
+
+      # @return (Boolean) Ad ID Info - Serves ads
+      attr_accessor :add_id_info_serves_ads
+
+      # @return (Boolean) Ad ID Info - Tracks actions
+      attr_accessor :add_id_info_tracks_action
+
+      # @return (Boolean) Ad ID Info - Tracks installs
+      attr_accessor :add_id_info_tracks_install
+
+      # @return (Boolean) Ad ID Info - Uses idfa
+      attr_accessor :add_id_info_uses_idfa
+
+      # @return (Boolean) Content Rights - Contains third party content
+      attr_accessor :content_rights_contains_third_party_content
+
+      # @return (Boolean) Content Rights - Has rights of content
+      attr_accessor :content_rights_has_rights
+
+      # @return (Boolean) Export Compliance - Available on French Store
+      attr_accessor :export_compliance_available_on_french_store
+
+      # @return (Not Yet Implemented) Export Compliance - CCAT File
+      attr_accessor :export_compliance_ccat_file
+
+      # @return (Boolean) Export Compliance - Contains proprietary cryptography
+      attr_accessor :export_compliance_contains_proprietary_cryptography
+
+      # @return (Boolean) Export Compliance - Contains third-party cryptography
+      attr_accessor :export_compliance_contains_third_party_cryptography
+
+      # @return (Boolean) Export Compliance - Is exempt
+      attr_accessor :export_compliance_is_exempt
+
+      # @return (Boolean) Export Compliance - Uses encryption
+      attr_accessor :export_compliance_uses_encryption
+
+      # @return (String) Export Compliance - App type
+      attr_accessor :export_compliance_app_type
+
+      # @return (Boolean) Export Compliance - Encryption Updated
+      attr_accessor :export_compliance_encryption_updated
+
+      # @return (Boolean) Export Compliance - Compliance Required
+      attr_accessor :export_compliance_compliance_required
+
+      # @return (String) Export Compliance - Platform
+      attr_accessor :export_compliance_platform
+
+      attr_mapping({
+        # Ad ID Info Section
+        'adIdInfo.servesAds.value' => :add_id_info_serves_ads,
+        'adIdInfo.tracksAction.value' => :add_id_info_tracks_action,
+        'adIdInfo.tracksInstall.value' => :add_id_info_tracks_install,
+        'adIdInfo.usesIdfa.value' => :add_id_info_uses_idfa,
+
+        # Content Rights Section
+        'contentRights.containsThirdPartyContent.value' => :content_rights_contains_third_party_content,
+        'contentRights.hasRights.value' => :content_rights_has_rights,
+
+        # Export Compliance Section
+        'exportCompliance.availableOnFrenchStore.value' => :export_compliance_available_on_french_store,
+        'exportCompliance.ccatFile.value' => :export_compliance_ccat_file,
+        'exportCompliance.containsProprietaryCryptography.value' => :export_compliance_contains_proprietary_cryptography,
+        'exportCompliance.containsThirdPartyCryptography.value' => :export_compliance_contains_third_party_cryptography,
+        'exportCompliance.isExempt.value' => :export_compliance_is_exempt,
+        'exportCompliance.usesEncryption.value' => :export_compliance_uses_encryption,
+        'exportCompliance.appType' => :export_compliance_app_type,
+        'exportCompliance.encryptionUpdated.value' => :export_compliance_encryption_updated,
+        'exportCompliance.exportComplianceRequired' => :export_compliance_compliance_required,
+        'exportCompliance.platform' => :export_compliance_platform
+      })
+
+      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)
+          # fill content rights section if iTC returns nil
+          if attrs["contentRights"].nil?
+            attrs["contentRights"] = {
+              "containsThirdPartyContent" => {
+                "value" => nil
+              },
+              "hasRights" => {
+                "value" => nil
+              }
+            }
+          end
+
+          obj = self.new(attrs)
+          return obj
+        end
+
+        # @param application (Spaceship::Tunes::Application) The app this submission is for
+        def create(application, version, platform: nil)
+          attrs = client.prepare_app_submissions(application.apple_id, application.edit_version(platform: platform).version_id)
+          attrs[:application] = application
+          attrs[:version] = version
+          attrs[:platform] = platform
+
+          return self.factory(attrs)
+        end
+      end
+
+      # Save and complete the app submission
+      def complete!
+        raw_data_clone = raw_data.dup
+        if self.content_rights_has_rights.nil? || self.content_rights_contains_third_party_content.nil?
+          raw_data_clone.set(["contentRights"], nil)
+        end
+        raw_data_clone.delete(:version)
+        raw_data_clone.delete(:application)
+
+        # Check whether the application makes use of IDFA or not
+        # and automatically set the mandatory limitsTracking value in the request JSON accordingly.
+        if !self.add_id_info_uses_idfa.nil? && self.add_id_info_uses_idfa == true
+          # Application uses IDFA, before sending for submission limitsTracking key in the request JSON must be set to true (agreement).
+          raw_data_clone.set(
+            ["adIdInfo", "limitsTracking", "value"],
+            true
+          )
+        end
+
+        client.send_app_submission(application.apple_id, application.edit_version(platform: platform).version_id, raw_data_clone)
+        @submitted_for_review = true
+      end
+
+      def setup
+        @submitted_for_review = false
+      end
+    end
+  end
+end