require 'spaceship/tunes/errors' require 'spaceship/tunes/iap_list' require 'spaceship/tunes/iap_detail' require 'spaceship/tunes/iap_status' require 'spaceship/tunes/iap_type' require 'spaceship/tunes/iap_family_list' require 'spaceship/tunes/iap_families' require 'spaceship/tunes/iap_family_details' require 'spaceship/tunes/iap_families' require 'spaceship/tunes/iap_subscription_pricing_tier' module Spaceship module Tunes class IAP < TunesBase # @return (Spaceship::Tunes::Application) A reference to the application attr_accessor :application # @return (Spaceship::Tunes::IAPFamilies) A reference to the family list def families attrs = {} attrs[:application] = self.application Tunes::IAPFamilies.new(attrs) end # Creates a new In-App-Purchase on App Store Connect # if the In-App-Purchase already exists an exception is raised. Spaceship::TunesClient::ITunesConnectError # @param type (String): The Type of the in-app-purchase (Spaceship::Tunes::IAPType::CONSUMABLE,Spaceship::Tunes::IAPType::NON_CONSUMABLE,Spaceship::Tunes::IAPType::RECURRING,Spaceship::Tunes::IAPType::NON_RENEW_SUBSCRIPTION) # @param versions (Hash): a Hash of the languages # @example: { # 'de-DE': { # name: "Name shown in AppStore", # description: "Description of the In app Purchase" # # } # } # @param reference_name (String): iTC Reference Name # @param product_id (String): A unique ID for your in-app-purchase # @param bundle_id (String): The bundle ID must match the one you used in Xcode. It # @param cleared_for_sale (Boolean): Is this In-App-Purchase Cleared for Sale # @param review_notes (String): Review Notes # @param review_screenshot (String): Path to the screenshot (should be 640x940 PNG) # @param pricing_intervals (Hash): a Hash of the languages # @example: # [ # { # country: "WW", # begin_date: nil, # end_date: nil, # tier: 1 # } # ] # @param family_id (String) Only used on RECURRING purchases, assigns the In-App-Purchase to a specific family # @param subscription_free_trial (String) Free Trial duration (1w,1m,3m....) # @param subscription_duration (String) 1w,1m..... # @param subscription_price_target (Hash) Only used on RECURRING purchases, used to set the # price of all the countries to be roughly the same as the price calculated from the price # tier and currency given as input. # @example: # { # currency: "EUR", # tier: 2 # } def create!(type: "consumable", versions: nil, reference_name: nil, product_id: nil, cleared_for_sale: true, merch_screenshot: nil, review_notes: nil, review_screenshot: nil, pricing_intervals: nil, family_id: nil, subscription_free_trial: nil, subscription_duration: nil, subscription_price_target: nil) client.create_iap!(app_id: self.application.apple_id, type: type, versions: versions, reference_name: reference_name, product_id: product_id, cleared_for_sale: cleared_for_sale, merch_screenshot: merch_screenshot, review_notes: review_notes, review_screenshot: review_screenshot, pricing_intervals: pricing_intervals, family_id: family_id, subscription_duration: subscription_duration, subscription_free_trial: subscription_free_trial) # Update pricing for a recurring subscription. if type == Spaceship::Tunes::IAPType::RECURRING && (pricing_intervals || subscription_price_target) # There are cases where the product that was just created is not immediately found, # and in order to update its pricing the purchase_id is needed. Therefore polling is done # for 4 times until it is found. If it's not found after 6 tries, a PotentialServerError # exception is raised. product = find_product_with_retries(product_id, 6) raw_pricing_intervals = client.transform_to_raw_pricing_intervals(application.apple_id, product.purchase_id, pricing_intervals, subscription_price_target) client.update_recurring_iap_pricing!(app_id: self.application.apple_id, purchase_id: product.purchase_id, pricing_intervals: raw_pricing_intervals) end end # return all available In-App-Purchase's of current app # this is not paged inside iTC-API so if you have a lot if IAP's (2k+) # it might take some time to load, same as it takes when you load the list via App Store Connect def all(include_deleted: false) r = client.iaps(app_id: self.application.apple_id) return_iaps = [] r.each do |product| attrs = product attrs[:application] = self.application loaded_iap = Tunes::IAPList.factory(attrs) next if loaded_iap.status == "deleted" && !include_deleted return_iaps << loaded_iap end return_iaps end # find a specific product # @param product_id (String) Product Id def find(product_id) all.each do |product| if product.product_id == product_id return product end end return nil end # generate app-specific shared secret (or regenerate if exists) def generate_shared_secret client.generate_shared_secret(app_id: self.application.apple_id) end # retrieve app-specific shared secret # @param create (Boolean) Create new shared secret if does not exist def get_shared_secret(create: false) secret = client.get_shared_secret(app_id: self.application.apple_id) if create && secret.nil? secret = generate_shared_secret end secret end private def find_product_with_retries(product_id, max_tries) try_number = 0 product = nil until product if try_number > max_tries raise PotentialServerError.new, "Failed to find the product with id=#{product_id}. "\ "This can be caused either by a server error or due to the removal of the product." end product = find(product_id) try_number += 1 end product end end end end