fastlane_pricing_fix 2.212.1

data/spaceship/lib/spaceship/tunes/iap_detail.rb

@@ -0,0 +1,264 @@
+require_relative '../du/upload_file'
+require_relative 'iap_status'
+require_relative 'iap_type'
+require_relative 'tunes_base'
+
+module Spaceship
+  module Tunes
+    class IAPDetail < TunesBase
+      # @return (Spaceship::Tunes::Application) A reference to the application
+      attr_accessor :application
+
+      # @return (Integer) the IAP id
+      attr_accessor :purchase_id
+
+      # @return (Bool) if it is a news subscription
+      attr_accessor :is_news_subscription
+
+      # @return (String) the IAP Referencename
+      attr_accessor :reference_name
+
+      # @return (String) the IAP Product-Id
+      attr_accessor :product_id
+
+      # @return (String) free trial period
+      attr_accessor :subscription_free_trial
+
+      # @return (String) subscription duration
+      attr_accessor :subscription_duration
+
+      # @return (Bool) Cleared for sale flag
+      attr_accessor :cleared_for_sale
+
+      # @return (Hash) app store promotion image (optional)
+      attr_accessor :merch_screenshot
+
+      # @return (Hash) app review screenshot (required)
+      attr_accessor :review_screenshot
+
+      # @return (String) the notes for the review team
+      attr_accessor :review_notes
+
+      # @return (Hash) subscription pricing target
+      attr_accessor :subscription_price_target
+
+      # @return (Hash) Relevant only for recurring subscriptions. Holds pricing related data, such
+      # as subscription pricing, intro offers, etc.
+      attr_accessor :raw_pricing_data
+
+      attr_mapping({
+        'adamId' => :purchase_id,
+        'referenceName.value' => :reference_name,
+        'productId.value' => :product_id,
+        'isNewsSubscription' => :is_news_subscription,
+        'pricingDurationType.value' => :subscription_duration,
+        'freeTrialDurationType.value' => :subscription_free_trial,
+        'clearedForSale.value' => :cleared_for_sale
+      })
+
+      def setup
+        @raw_pricing_data = @raw_data["pricingData"]
+        @raw_data.delete("pricingData")
+
+        if @raw_pricing_data
+          @raw_data.set(["pricingIntervals"], @raw_pricing_data["subscriptions"])
+        end
+      end
+
+      # @return (Hash) Hash of languages
+      # @example: {
+      #   'de-DE': {
+      #     name: "Name shown in AppStore",
+      #     description: "Description of the In app Purchase"
+      #
+      #   }
+      # }
+      def versions
+        parsed_versions = {}
+        raw_versions = raw_data["versions"].first["details"]["value"]
+        raw_versions.each do |localized_version|
+          language = localized_version["value"]["localeCode"]
+          parsed_versions[language.to_sym] = {
+            name: localized_version["value"]["name"]["value"],
+            description: localized_version["value"]["description"]["value"],
+            id: localized_version["value"]["id"],
+            status: localized_version["value"]["status"]
+          }
+        end
+        return parsed_versions
+      end
+
+      # transforms user-set versions to iTC ones
+      def versions=(value = {})
+        if value.kind_of?(Array)
+          # input that comes from iTC api
+          return
+        end
+        new_versions = []
+        value.each do |language, current_version|
+          new_versions << {
+            "value" =>   {
+              "name" =>  { "value" => current_version[:name] },
+              "description" =>  { "value" => current_version[:description] },
+              "localeCode" => language.to_s,
+              "id" => current_version[:id]
+            }
+          }
+        end
+
+        raw_data.set(["versions"], [{ reviewNotes: { value: @review_notes }, "contentHosting" => raw_data['versions'].first['contentHosting'], "details" => { "value" => new_versions }, "id" => raw_data["versions"].first["id"], "reviewScreenshot" => { "value" => review_screenshot } }])
+      end
+
+      # transforms user-set intervals to iTC ones
+      def pricing_intervals=(value = [])
+        raw_pricing_intervals =
+          client.transform_to_raw_pricing_intervals(application.apple_id, self.purchase_id, value)
+        raw_data.set(["pricingIntervals"], raw_pricing_intervals)
+        @raw_pricing_data["subscriptions"] = raw_pricing_intervals if @raw_pricing_data
+      end
+
+      # @return (Array) pricing intervals
+      # @example:
+      #  [
+      #    {
+      #      country: "WW",
+      #      begin_date: nil,
+      #      end_date: nil,
+      #      tier: 1
+      #    }
+      #  ]
+      def pricing_intervals
+        @pricing_intervals ||= (raw_data["pricingIntervals"] || @raw_pricing_data["subscriptions"] || []).map do |interval|
+          {
+            tier: interval["value"]["tierStem"].to_i,
+            begin_date: interval["value"]["priceTierEffectiveDate"],
+            end_date: interval["value"]["priceTierEndDate"],
+            grandfathered: interval["value"]["grandfathered"],
+            country: interval["value"]["country"]
+          }
+        end
+      end
+
+      # @return (String) Human Readable type of the purchase
+      def type
+        Tunes::IAPType.get_from_string(raw_data["addOnType"])
+      end
+
+      # @return (String) Human Readable status of the purchase
+      def status
+        Tunes::IAPStatus.get_from_string(raw_data["versions"].first["status"])
+      end
+
+      # @return (Hash) Hash containing existing promotional image data
+      def merch_screenshot
+        return nil unless raw_data && raw_data["versions"] && raw_data["versions"].first && raw_data["versions"].first["merch"] && raw_data["versions"].first["merch"]["images"].first["image"]["value"]
+        raw_data["versions"].first["merch"]["images"].first["image"]["value"]
+      end
+
+      # @return (Hash) Hash containing existing review screenshot data
+      def review_screenshot
+        return nil unless raw_data && raw_data["versions"] && raw_data["versions"].first && raw_data["versions"].first["reviewScreenshot"] && raw_data['versions'].first["reviewScreenshot"]["value"]
+        raw_data['versions'].first['reviewScreenshot']['value']
+      end
+
+      # Saves the current In-App-Purchase
+      def save!
+        # Transform localization versions back to original format.
+        versions_array = []
+        versions.each do |language, value|
+          versions_array << {
+                    "value" =>  {
+                      "description" => { "value" => value[:description] },
+                      "name" => { "value" => value[:name] },
+                      "localeCode" => language.to_s,
+                      "id" => value[:id]
+                    }
+          }
+        end
+
+        raw_data.set(["versions"], [{ reviewNotes: { value: @review_notes }, contentHosting: raw_data['versions'].first['contentHosting'], "details" => { "value" => versions_array }, id: raw_data["versions"].first["id"], reviewScreenshot: { "value" => review_screenshot } }])
+
+        # transform pricingDetails
+        raw_pricing_intervals =
+          client.transform_to_raw_pricing_intervals(application.apple_id,
+                                                    self.purchase_id, pricing_intervals,
+                                                    subscription_price_target)
+        raw_data.set(["pricingIntervals"], raw_pricing_intervals)
+        @raw_pricing_data["subscriptions"] = raw_pricing_intervals if @raw_pricing_data
+
+        if @merch_screenshot
+          # Upload App Store Promotional image (Optional)
+          upload_file = UploadFile.from_path(@merch_screenshot)
+          merch_data = client.upload_purchase_merch_screenshot(application.apple_id, upload_file)
+          raw_data["versions"][0]["merch"] = merch_data
+        end
+
+        if @review_screenshot
+          # Upload Screenshot
+          upload_file = UploadFile.from_path(@review_screenshot)
+          screenshot_data = client.upload_purchase_review_screenshot(application.apple_id, upload_file)
+          raw_data["versions"][0]["reviewScreenshot"] = screenshot_data
+        end
+        # Update the Purchase
+        client.update_iap!(app_id: application.apple_id, purchase_id: self.purchase_id, data: raw_data)
+
+        # Update pricing for a recurring subscription.
+        if raw_data["addOnType"] == Spaceship::Tunes::IAPType::RECURRING
+          client.update_recurring_iap_pricing!(app_id: application.apple_id, purchase_id: self.purchase_id,
+                                               pricing_intervals: raw_data["pricingIntervals"])
+        end
+      end
+
+      # Deletes In-App-Purchase
+      def delete!
+        client.delete_iap!(app_id: application.apple_id, purchase_id: self.purchase_id)
+      end
+
+      # Retrieves the actual prices for an iap.
+      #
+      # @return ([]) An empty array
+      #   if the iap is not yet cleared for sale
+      # @return ([Spaceship::Tunes::PricingInfo]) An array of pricing infos from the same pricing tier
+      #   if the iap uses world wide pricing
+      # @return ([Spaceship::Tunes::IAPSubscriptionPricingInfo]) An array of pricing infos from multple subscription pricing tiers
+      #   if the iap uses territorial pricing
+      def pricing_info
+        return [] unless cleared_for_sale
+        return world_wide_pricing_info if world_wide_pricing?
+        territorial_pricing_info
+      end
+
+      private
+
+      # Checks wheather an iap uses world wide or territorial pricing.
+      #
+      # @return (true, false)
+      def world_wide_pricing?
+        pricing_intervals.fetch(0, {})[:country] == "WW"
+      end
+
+      # Maps a single pricing interval to pricing infos.
+      #
+      # @return ([Spaceship::Tunes::PricingInfo]) An array of pricing infos from the same tier
+      def world_wide_pricing_info
+        client
+          .pricing_tiers(application.apple_id)
+          .find { |p| p.tier_stem == pricing_intervals.first[:tier].to_s }
+          .pricing_info
+      end
+
+      # Maps pricing intervals to their respective subscription pricing infos.
+      #
+      # @return ([Spaceship::Tunes::IAPSubscriptionPricingInfo]) An array of subscription pricing infos
+      def territorial_pricing_info
+        pricing_matrix = client.subscription_pricing_tiers(application.apple_id)
+        pricing_intervals.map do |interval|
+          pricing_matrix
+            .find { |p| p.tier_stem == interval[:tier].to_s }
+            .pricing_info
+            .find { |i| i.country_code == interval[:country] }
+        end
+      end
+    end
+  end
+end

data/spaceship/lib/spaceship/tunes/iap_families.rb

@@ -0,0 +1,68 @@
+require_relative 'iap_family_list'
+
+module Spaceship
+  module Tunes
+    class IAPFamilies < TunesBase
+      # @return (Spaceship::Tunes::Application) A reference to the application
+      attr_accessor :application
+
+      # Create a new Purchase Family
+      # a freshly created family has to have at least one product.
+      # the product will be created, and versions/pricing_intervals and so on
+      # should be set by subsequent edit.
+      # @param name (String) Familyname
+      # @param product_id (String) New Product's id
+      # @param reference_name (String) Reference name of the new product
+      # @param versions (Hash) Localized Familie names
+      # @example
+      #  versions: {
+      #  'de-DE': {
+      #    subscription_name: "Subname German",
+      #    name: 'App Name German',
+      #  },
+      #  'da': {
+      #    subscription_name: "Subname DA",
+      #    name: 'App Name DA',
+      #  }
+      # }
+
+      def create!(name: nil, product_id: nil, reference_name: nil, versions: {})
+        versions_array = []
+        versions.each do |language_code, value|
+          versions_array << {
+                    value: {
+                      subscriptionName: { value: value[:subscription_name] },
+                      name: { value: value[:name] },
+                      localeCode: { value: language_code.to_s }
+                    }
+          }
+        end
+        client.create_iap_family(app_id: self.application.apple_id, name: name, product_id: product_id, reference_name: reference_name, versions: versions_array)
+      end
+
+      # returns a list of all available subscription groups/families of the current In-App-Purchase
+      def all
+        r = client.iap_families(app_id: self.application.apple_id)
+        return_families = []
+        r.each do |family|
+          attrs = family
+          attrs[:application] = self.application
+          loaded_family = Tunes::IAPFamilyList.factory(attrs)
+          return_families << loaded_family
+        end
+        return_families
+      end
+
+      # find a specific family
+      # @param family_id (String) Family Id
+      def find(family_id)
+        all.each do |family|
+          if family.family_id == family_id
+            return family
+          end
+        end
+        return nil
+      end
+    end
+  end
+end

data/spaceship/lib/spaceship/tunes/iap_family_details.rb

@@ -0,0 +1,90 @@
+require_relative 'tunes_base'
+
+module Spaceship
+  module Tunes
+    class IAPFamilyDetails < TunesBase
+      # @return (Spaceship::Tunes::Application) A reference to the application
+      attr_accessor :application
+
+      # @return (String) the family name
+      attr_accessor :name
+
+      # @return (Intger) the family id
+      attr_accessor :family_id
+
+      # @return (Array) all linked in-app purchases of this family
+      attr_accessor :linked_iaps
+
+      # @return (Intger) amount of linked in-app purchases of this family (read-only)
+      attr_accessor :iap_count
+
+      # @return (Array) of all in-app purchase family details
+      attr_accessor :family_details
+
+      attr_mapping({
+        'id' => :family_id,
+        'name.value' => :name,
+        'activeAddOns' => :linked_iaps,
+        'totalActiveAddOns' => :iap_count,
+        'details.value' => :family_details
+      })
+
+      # @return (Hash) localized names
+      def versions
+        parsed_versions = {}
+        raw_versions = raw_data["details"]["value"]
+        raw_versions.each do |version|
+          language = version["value"]["localeCode"]["value"]
+          parsed_versions[language.to_sym] = {
+            subscription_name: version["value"]["subscriptionName"]["value"],
+            name: version["value"]["name"]["value"],
+            id: version["value"]["id"],
+            status: version["value"]["status"]
+          }
+        end
+        return parsed_versions
+      end
+
+      # transforms user-set versions to iTC ones
+      def versions=(value = {})
+        if value.kind_of?(Array)
+          # input that comes from iTC api
+          return
+        end
+        new_versions = []
+        value.each do |language, current_version|
+          new_versions << {
+            "value" =>   {
+              "subscriptionName" =>  { "value" => current_version[:subscription_name] },
+              "name" =>  { "value" => current_version[:name] },
+              "localeCode" => { "value" => language },
+              "id" => current_version[:id]
+            }
+          }
+        end
+
+        raw_data.set(["details"], { "value" => new_versions })
+      end
+
+      # modify existing family
+      def save!
+        # Transform localization versions back to original format.
+        versions_array = []
+        versions.each do |language_code, value|
+          versions_array << {
+                               "value" => {
+                                 "subscriptionName" => { "value" => value[:subscription_name] },
+                                 "name" => { "value" => value[:name] },
+                                 "localeCode" => { "value" => language_code.to_s },
+                                 "id" => value[:id]
+                               }
+                            }
+        end
+
+        raw_data.set(["details"], { "value" => versions_array })
+
+        client.update_iap_family!(app_id: application.apple_id, family_id: self.family_id, data: raw_data)
+      end
+    end
+  end
+end

data/spaceship/lib/spaceship/tunes/iap_family_list.rb

@@ -0,0 +1,28 @@
+require_relative 'iap_family_details'
+
+module Spaceship
+  module Tunes
+    class IAPFamilyList < TunesBase
+      # @return (Spaceship::Tunes::Application) A reference to the application
+      attr_accessor :application
+
+      # @return (String) the family name
+      attr_accessor :name
+
+      # @return (Intger) the Family Id
+      attr_accessor :family_id
+
+      attr_mapping({
+        'id' => :family_id,
+        'name.value' => :name
+      })
+
+      # return a editable family object
+      def edit
+        attrs = client.load_iap_family(app_id: application.apple_id, family_id: self.family_id)
+        attrs[:application] = application
+        Tunes::IAPFamilyDetails.new(attrs)
+      end
+    end
+  end
+end

data/spaceship/lib/spaceship/tunes/iap_list.rb

@@ -0,0 +1,76 @@
+require_relative 'iap_detail'
+require_relative 'iap_status'
+require_relative 'iap_type'
+
+module Spaceship
+  module Tunes
+    class IAPList < TunesBase
+      # @return (Spaceship::Tunes::Application) A reference to the application
+      attr_accessor :application
+
+      # @return (String) the IAP Referencename
+      attr_accessor :reference_name
+
+      # @return (String) the IAP Product-Id
+      attr_accessor :product_id
+
+      # @return (String) Family Reference Name
+      attr_accessor :family_reference_name
+
+      attr_accessor :duration_days
+      attr_accessor :versions
+      attr_accessor :purple_apple_id
+      attr_accessor :last_modified_date
+      attr_accessor :is_news_subscription
+      attr_accessor :number_of_codes
+      attr_accessor :maximum_number_of_codes
+      attr_accessor :app_maximum_number_of_codes
+      attr_accessor :is_editable
+      attr_accessor :is_required
+      attr_accessor :can_delete_addon
+
+      attr_mapping({
+        'adamId' => :purchase_id,
+        'referenceName' => :reference_name,
+        'familyReferenceName' => :family_reference_name,
+        'vendorId' => :product_id,
+        'durationDays' => :duration_days,
+        'versions' => :versions,
+        'purpleSoftwareAdamIds' => :purple_apple_id,
+        'lastModifiedDate' => :last_modified_date,
+        'isNewsSubscription' => :is_news_subscription,
+        'numberOfCodes' => :number_of_codes,
+        'maximumNumberOfCodes' => :maximum_number_of_codes,
+        'appMaximumNumberOfCodes' => :app_maximum_number_of_codes,
+        'isEditable' => :is_editable,
+        'isRequired' => :is_required,
+        'canDeleteAddOn' => :can_delete_addon
+      })
+
+      def type
+        Tunes::IAPType.get_from_string(raw_data["addOnType"])
+      end
+
+      def status
+        Tunes::IAPStatus.get_from_string(raw_data["iTunesConnectStatus"])
+      end
+
+      def edit
+        attrs = client.load_iap(app_id: application.apple_id, purchase_id: self.purchase_id)
+        attrs[:application] = application
+
+        if attrs["addOnType"] == Spaceship::Tunes::IAPType::RECURRING
+          raw_pricing_data = client.load_recurring_iap_pricing(app_id: application.apple_id,
+                                                               purchase_id: self.purchase_id)
+          attrs["pricingData"] = raw_pricing_data
+        end
+
+        Tunes::IAPDetail.new(attrs)
+      end
+
+      def delete!
+        client.delete_iap!(app_id: application.apple_id, purchase_id: self.purchase_id)
+      end
+    end
+  end
+end

data/spaceship/lib/spaceship/tunes/iap_status.rb

@@ -0,0 +1,56 @@
+module Spaceship
+  module Tunes
+    # Defines the different states of an in-app purchase
+    #
+    # As specified by Apple: https://developer.apple.com/library/content/documentation/LanguagesUtilities/Conceptual/iTunesConnectInAppPurchase_Guide/Chapters/WorkingWithYourProductsStatus.html
+    module IAPStatus
+      # IAP created, but missing screenshot/metadata
+      MISSING_METADATA = "Missing Metadata"
+
+      # You can edit the metadata, change screenshot and more. Need to submit.
+      READY_TO_SUBMIT = "Ready to Submit"
+
+      # Waiting for Apple's Review
+      WAITING_FOR_REVIEW = "Waiting For Review"
+
+      # Currently in Review
+      IN_REVIEW = "In Review"
+
+      # Approved (and currently available)
+      APPROVED = "Approved"
+
+      # Developer deleted
+      DELETED = "Deleted"
+
+      # In-app purchase rejected for whatever reason
+      REJECTED = "Rejected"
+
+      # The developer took the app from the App Store
+      DEVELOPER_REMOVED_FROM_SALE = "Developer Removed From Sale"
+
+      # In-app purchase need developer's action
+      DEVELOPER_ACTION_NEEDED = "Developer Action Needed"
+
+      # Get the iap status matching based on a string (given by App Store Connect)
+      def self.get_from_string(text)
+        mapping = {
+          'missingMetadata' => MISSING_METADATA,
+          'readyToSubmit' => READY_TO_SUBMIT,
+          'waitingForReview' => WAITING_FOR_REVIEW,
+          'inReview' => IN_REVIEW,
+          'readyForSale' => APPROVED,
+          'deleted' => DELETED,
+          'rejected' => REJECTED,
+          'developerRemovedFromSale' => DEVELOPER_REMOVED_FROM_SALE,
+          'developerActionNeeded' => DEVELOPER_ACTION_NEEDED
+        }
+
+        mapping.each do |itc_status, readable_status|
+          return readable_status if itc_status == text
+        end
+
+        return nil
+      end
+    end
+  end
+end

data/spaceship/lib/spaceship/tunes/iap_subscription_pricing_info.rb

@@ -0,0 +1,46 @@
+require_relative 'tunes_base'
+
+module Spaceship
+  module Tunes
+    class IAPSubscriptionPricingInfo < TunesBase
+      # @return (String) country code, e.g. "US"
+      attr_accessor :country_code
+
+      # @return (String) currency symbol, e.g. "$"
+      attr_accessor :currency_symbol
+
+      # @return (String) currency code, e.g. "USD"
+      attr_accessor :currency_code
+
+      # @return (Number) net proceedings for the developer in the first year
+      attr_accessor :wholesale_price
+
+      # @return (Number) net proceedings for the developer after the first year
+      attr_accessor :wholesale_price2
+
+      # @return (Number) customer price
+      attr_accessor :retail_price
+
+      # @return (String) formatted customer price, e.g. "$0.00"
+      attr_accessor :f_retail_price
+
+      # @return (String) formatted net proceedings in the first year, e.g. "$0.00"
+      attr_accessor :f_wholesale_price
+
+      # @return (String) formatted net proceedings after the first year, e.g. "$0.00"
+      attr_accessor :f_wholesale_price2
+
+      attr_mapping(
+        "countryCode" => :country_code,
+        "currencySymbol" => :currency_symbol,
+        "currencyCode" => :currency_code,
+        "wholesalePrice" => :wholesale_price,
+        "wholesalePrice2" => :wholesale_price2,
+        "retailPrice" => :retail_price,
+        "fRetailPrice" => :f_retail_price,
+        "fWholesalePrice" => :f_wholesale_price,
+        "fWholesalePrice2" => :f_wholesale_price2
+      )
+    end
+  end
+end

data/spaceship/lib/spaceship/tunes/iap_subscription_pricing_tier.rb

@@ -0,0 +1,25 @@
+require_relative 'iap_subscription_pricing_info'
+
+module Spaceship
+  module Tunes
+    class IAPSubscriptionPricingTier < TunesBase
+      # @return (String) Number of the subscription price tier (e.g. "1" for Tier 1 )
+      attr_accessor :tier_stem
+
+      # @return (String) Name of the tier (e.g. "ITC.addons.pricing.tier.1" for Tier 1)
+      attr_accessor :tier_name
+
+      # @return ([Spaceship::Tunes::IAPSubscriptionPricingInfo]) A list of all prices for the respective countries
+      attr_accessor :pricing_info
+
+      attr_mapping(
+        "tierStem" => :tier_stem,
+        "tierName" => :tier_name
+      )
+
+      def pricing_info
+        @pricing_info ||= raw_data['pricingInfo'].map { |info| IAPSubscriptionPricingInfo.new(info) }
+      end
+    end
+  end
+end