fastlane 2.13.0 → 2.14.0

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

@@ -0,0 +1,185 @@
+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
+
+      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
+
+      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
+      })
+
+      class << self
+        def factory(attrs)
+          return self.new(attrs)
+        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"]
+          }
+        end
+        return parsed_versions
+      end
+
+      # @return (Array) pricing intervals
+      # @example:
+      #  [
+      #    {
+      #      country: "WW",
+      #      begin_date: nil,
+      #      end_date: nil,
+      #      tier: 1
+      #    }
+      #  ]
+      def pricing_intervals
+        parsed_intervals = []
+        raw_data["pricingIntervals"].each do |interval|
+          parsed_intervals << {
+            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
+        return parsed_intervals
+      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
+
+      # 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
+                    }
+          }
+        end
+
+        raw_data.set(["versions"], [{ reviewNotes: @review_notes, details: { value: versions_array } }])
+
+        # transform pricingDetails
+        intervals_array = []
+        pricing_intervals.each do |interval|
+          intervals_array << {
+            value: {
+              tierStem: interval[:tier],
+              priceTierEffectiveDate: interval[:begin_date],
+              priceTierEndDate: interval[:end_date],
+              country: interval[:country] || "WW",
+              grandfathered: interval[:grandfathered]
+            }
+          }
+        end
+
+        if subscription_price_target
+          intervals_array = []
+          pricing_calculator = client.iap_subscription_pricing_target(app_id: application.apple_id, purchase_id: purchase_id, currency: subscription_price_target[:currency], tier: subscription_price_target[:tier])
+          pricing_calculator.each do |language_code, value|
+            intervals_array << {
+              value: {
+                tierStem: value["tierStem"],
+                priceTierEffectiveDate: value["priceTierEffectiveDate"],
+                priceTierEndDate: value["priceTierEndDate"],
+                country: language_code,
+                grandfathered: { value: "FUTURE_NONE" }
+              }
+            }
+          end
+
+        end
+
+        raw_data.set(["pricingIntervals"], intervals_array)
+
+        if @review_screenshot
+          # Upload Screenshot
+          upload_file = UploadFile.from_path @review_screenshot
+          screenshot_data = client.upload_purchase_review_screenshot(application.apple_id, upload_file)
+          new_screenshot = {
+            "value" => {
+              "assetToken" => screenshot_data["token"],
+              "sortOrder" => 0,
+              "type" => "SortedScreenShot",
+              "originalFileName" => upload_file.file_name,
+              "size" => screenshot_data["length"],
+              "height" => screenshot_data["height"],
+              "width" => screenshot_data["width"],
+              "checksum" => screenshot_data["md5"]
+            }
+          }
+
+          raw_data["versions"][0]["reviewScreenshot"] = new_screenshot
+        end
+        # Update the Purchase
+        client.update_iap!(app_id: application.apple_id, purchase_id: self.purchase_id, data: raw_data)
+      end
+
+      # Deletes In-App-Purchase
+      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_families.rb

@@ -0,0 +1,62 @@
+
+module Spaceship
+  module Tunes
+    class IAPFamilies < TunesBase
+      # @return (Spaceship::Tunes::Application) A reference to the application
+      attr_accessor :application
+
+      class << self
+        def factory(attrs)
+          return self.new(attrs)
+        end
+      end
+
+      # Create a new Purchase Family
+      # a freshly created family has to have atleast 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 families
+      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
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+
+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
+
+      attr_mapping({
+        'id' => :family_id,
+        'name.value' => :name
+      })
+
+      class << self
+        def factory(attrs)
+          return self.new(attrs)
+        end
+      end
+
+      # @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"]
+          }
+        end
+        return parsed_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 }
+                               }
+                            }
+        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,33 @@
+
+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
+      })
+
+      class << self
+        def factory(attrs)
+          return self.new(attrs)
+        end
+      end
+
+      # 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.factory(attrs)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,72 @@
+
+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_modfied_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_modfied_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
+      })
+
+      class << self
+        def factory(attrs)
+          return self.new(attrs)
+        end
+      end
+
+      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
+        Tunes::IAPDetail.factory(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,48 @@
+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"
+
+      # Get the iap status matching based on a string (given by iTunes 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
+        }
+
+        mapping.each do |itc_status, readable_status|
+          return readable_status if itc_status == text
+        end
+
+        return nil
+      end
+    end
+  end
+end