Class: Spaceship::TunesClient

Inherits:
Client
  • Object
show all
Defined in:
lib/spaceship/tunes/tunes_client.rb

Overview

rubocop:disable Metrics/ClassLength

Defined Under Namespace

Classes: ITunesConnectError, ITunesConnectTemporaryError

Constant Summary

Constants inherited from Client

Client::PROTOCOL_VERSION, Client::USER_AGENT

Instance Attribute Summary collapse

Attributes inherited from Client

#client, #csrf_tokens, #logger, #user

Init and Login collapse

Applications collapse

AppVersions collapse

Pricing collapse

App Icons collapse

CandiateBuilds collapse

Build Trains collapse

Submit for Review collapse

release collapse

Testers collapse

Sandbox Testers collapse

State History collapse

Promo codes collapse

reject collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Client

#UI, #cookie, #handle_two_factor, #handle_two_step, #itc_service_key, #load_session_from_env, #load_session_from_file, login, #login, #page_size, #paging, #parse_response, #persistent_cookie_path, #request, #select_device, #send_shared_login_request, #store_cookie, #store_session, #with_retry

Constructor Details

#initialize ⇒ TunesClient

Returns a new instance of TunesClient.



16
17
18
19
20
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 16

def initialize
  super

  @du_client = DUClient.new
end

Instance Attribute Details

#du_client ⇒ Object (readonly)

Returns the value of attribute du_client.



14
15
16
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 14

def du_client
  @du_client
end

Class Method Details

.hostname ⇒ Object 



43
44
45
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 43

def self.hostname
  "https://itunesconnect.apple.com/WebObjects/iTunesConnect.woa/"
end

.video_preview_resolution_for(device, is_portrait) ⇒ Object

trailer preview screenshots are required to have a specific size



24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 24

def video_preview_resolution_for(device, is_portrait)
  resolutions = {
      'iphone4' => [1136, 640],
      'iphone6' => [1334, 750],
      'iphone6Plus' => [2208, 1242],
      'ipad' => [1024, 768],
      'ipadPro' => [2732, 2048]
  }

  r = resolutions[device]
  r = [r[1], r[0]] if is_portrait
  r
end

Instance Method Details

#add_tester_to_app!(tester, app_id) ⇒ Object 



885
886
887
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 885

def add_tester_to_app!(tester, app_id)
  update_tester_from_app!(tester, app_id, true)
end

#all_build_trains(app_id: nil, platform: 'ios') ⇒ Object

All build trains, even if there is no TestFlight



611
612
613
614
615
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 611

def all_build_trains(app_id: nil, platform: 'ios')
  platform = 'ios' if platform.nil?
  r = request(:get, "ra/apps/#{app_id}/buildHistory?platform=#{platform}")
  handle_itc_response(r.body)
end

#all_builds_for_train(app_id: nil, train: nil, platform: 'ios') ⇒ Object 



617
618
619
620
621
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 617

def all_builds_for_train(app_id: nil, train: nil, platform: 'ios')
  platform = 'ios' if platform.nil?
  r = request(:get, "ra/apps/#{app_id}/trains/#{train}/buildHistory?platform=#{platform}")
  handle_itc_response(r.body)
end

#app_details(app_id) ⇒ Object 



242
243
244
245
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 242

def app_details(app_id)
  r = request(:get, "ra/apps/#{app_id}/details")
  parse_response(r, 'data')
end

#app_promocodes(app_id: nil) ⇒ Object 



958
959
960
961
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 958

def app_promocodes(app_id: nil)
  r = request(:get, "ra/apps/#{app_id}/promocodes/versions")
  parse_response(r, 'data')['versions']
end

#app_promocodes_history(app_id: nil) ⇒ Object 



977
978
979
980
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 977

def app_promocodes_history(app_id: nil)
  r = request(:get, "ra/apps/#{app_id}/promocodes/history")
  parse_response(r, 'data')['requests']
end

#app_version(app_id, is_live, platform: nil) ⇒ Object 



334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 334

def app_version(app_id, is_live, platform: nil)
  raise "app_id is required" unless app_id

  # First we need to fetch the IDs for the edit / live version
  r = request(:get, "ra/apps/#{app_id}/overview")
  platforms = parse_response(r, 'data')['platforms']

  platform = Spaceship::Tunes::AppVersionCommon.find_platform(platforms, search_platform: platform)
  return nil unless platform

  version_id = Spaceship::Tunes::AppVersionCommon.find_version_id(platform, is_live)
  return nil unless version_id

  version_platform = platform['platformString']

  app_version_data(app_id, version_platform: version_platform, version_id: version_id)
end

#app_version_data(app_id, version_platform: nil, version_id: nil) ⇒ Object 



352
353
354
355
356
357
358
359
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 352

def app_version_data(app_id, version_platform: nil, version_id: nil)
  raise "app_id is required" unless app_id
  raise "version_platform is required" unless version_platform
  raise "version_id is required" unless version_id

  r = request(:get, "ra/apps/#{app_id}/platforms/#{version_platform}/versions/#{version_id}")
  parse_response(r, 'data')
end

#applications ⇒ Object 



237
238
239
240
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 237

def applications
  r = request(:get, 'ra/apps/manageyourapps/summary/v2')
  parse_response(r, 'data')['summaries']
end

#build_details(app_id: nil, train: nil, build_number: nil, platform: nil) ⇒ Object 



623
624
625
626
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 623

def build_details(app_id: nil, train: nil, build_number: nil, platform: nil)
  r = request(:get, "ra/apps/#{app_id}/platforms/#{platform || 'ios'}/trains/#{train}/builds/#{build_number}/details")
  handle_itc_response(r.body)
end

#build_trains(app_id, testing_type, platform: nil) ⇒ Object

Parameters:

  • internal (testing_type) —

    or external



578
579
580
581
582
583
584
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 578

def build_trains(app_id, testing_type, platform: nil)
  raise "app_id is required" unless app_id
  url = "ra/apps/#{app_id}/trains/?testingType=#{testing_type}"
  url += "&platform=#{platform}" unless platform.nil?
  r = request(:get, url)
  parse_response(r, 'data')
end

#candidate_builds(app_id, version_id) ⇒ Object 



568
569
570
571
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 568

def candidate_builds(app_id, version_id)
  r = request(:get, "ra/apps/#{app_id}/versions/#{version_id}/candidateBuilds")
  parse_response(r, 'data')['builds']
end

#create_application!(name: nil, primary_language: nil, version: nil, sku: nil, bundle_id: nil, bundle_id_suffix: nil, company_name: nil, platform: nil) ⇒ Object

Creates a new application on iTunes Connect

Parameters:

  • name (String) (defaults to: nil) —

    : The name of your app as it will appear on the App Store. This can’t be longer than 255 characters.

  • primary_language (String) (defaults to: nil) —

    : If localized app information isn’t available in an App Store territory, the information from your primary language will be used instead.

  • version (String) (defaults to: nil) —

    : The version number is shown on the App Store and should match the one you used in Xcode.

  • sku (String) (defaults to: nil) —

    : A unique ID for your app that is not visible on the App Store.

  • bundle_id (String) (defaults to: nil) —

    : The bundle ID must match the one you used in Xcode. It can’t be changed after you submit your first build.



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 267

def create_application!(name: nil, primary_language: nil, version: nil, sku: nil, bundle_id: nil, bundle_id_suffix: nil, company_name: nil, platform: nil)
  # First, we need to fetch the data from Apple, which we then modify with the user's values
  primary_language ||= "English"
  platform ||= "ios"
  r = request(:get, "ra/apps/create/v2/?platformString=#{platform}")
  data = parse_response(r, 'data')

  # Now fill in the values we have
  # some values are nil, that's why there is a hash
  data['versionString'] = { value: version }
  data['name'] = { value: name }
  data['bundleId'] = { value: bundle_id }
  data['primaryLanguage'] = { value: primary_language }
  data['primaryLocaleCode'] = { value: primary_language.to_itc_locale }
  data['vendorId'] = { value: sku }
  data['bundleIdSuffix'] = { value: bundle_id_suffix }
  data['companyName'] = { value: company_name } if company_name
  data['enabledPlatformsForCreation'] = { value: [platform] }

  data['initialPlatform'] = platform
  data['enabledPlatformsForCreation'] = { value: [platform] }

  # Now send back the modified hash
  r = request(:post) do |req|
    req.url 'ra/apps/create/v2'
    req.body = data.to_json
    req.headers['Content-Type'] = 'application/json'
  end

  data = parse_response(r, 'data')
  handle_itc_response(data)
end

#create_sandbox_tester!(tester_class: nil, email: nil, password: nil, first_name: nil, last_name: nil, country: nil) ⇒ Object 



902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 902

def create_sandbox_tester!(tester_class: nil, email: nil, password: nil, first_name: nil, last_name: nil, country: nil)
  url = tester_class.url[:create]
  r = request(:post) do |req|
    req.url url
    req.body = {
      user: {
        emailAddress: { value: email },
        password: { value: password },
        confirmPassword: { value: password },
        firstName: { value: first_name },
        lastName: { value: last_name },
        storeFront: { value: country },
        birthDay: { value: 1 },
        birthMonth: { value: 1 },
        secretQuestion: { value: SecureRandom.hex },
        secretAnswer: { value: SecureRandom.hex },
        sandboxAccount: nil
      }
    }.to_json
    req.headers['Content-Type'] = 'application/json'
  end
  parse_response(r, 'data')['user']
end

#create_tester!(tester: nil, email: nil, first_name: nil, last_name: nil, groups: nil) ⇒ Object 



818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 818

def create_tester!(tester: nil, email: nil, first_name: nil, last_name: nil, groups: nil)
  url = tester.url[:create]
  raise "Action not provided for this tester type." unless url

  tester_data = {
        emailAddress: {
          value: email
        },
        firstName: {
          value: first_name || ""
        },
        lastName: {
          value: last_name || ""
        },
        testing: {
          value: true
        }
      }
  if groups
    tester_data[:groups] = groups.map { |x| { "id" => x } }
  end

  data = { testers: [tester_data] }

  r = request(:post) do |req|
    req.url url
    req.body = data.to_json
    req.headers['Content-Type'] = 'application/json'
  end

  data = parse_response(r, 'data')['testers']
  handle_itc_response(data) || data[0]
end

#create_version!(app_id, version_number, platform = 'ios') ⇒ Object 



300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 300

def create_version!(app_id, version_number, platform = 'ios')
  r = request(:post) do |req|
    req.url "ra/apps/#{app_id}/platforms/#{platform}/versions/create/"
    req.body = {
      version: {
        value: version_number.to_s
      }
    }.to_json
    req.headers['Content-Type'] = 'application/json'
  end

  data = parse_response(r, 'data')
  handle_itc_response(data)
end

#delete_sandbox_testers!(tester_class, emails) ⇒ Object 



926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 926

def delete_sandbox_testers!(tester_class, emails)
  url = tester_class.url[:delete]
  request(:post) do |req|
    req.url url
    req.body = emails.map do |email|
      {
        emailAddress: {
          value: email
        }
      }
    end.to_json
    req.headers['Content-Type'] = 'application/json'
  end
  true
end

#delete_tester!(tester) ⇒ Object 



852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 852

def delete_tester!(tester)
  url = tester.class.url[:delete]
  raise "Action not provided for this tester type." unless url

  data = [
    {
      emailAddress: {
        value: tester.email
      },
      firstName: {
        value: tester.first_name
      },
      lastName: {
        value: tester.last_name
      },
      testing: {
        value: false
      },
      userName: tester.email,
      testerId: tester.tester_id
    }
  ]

  r = request(:post) do |req|
    req.url url
    req.body = data.to_json
    req.headers['Content-Type'] = 'application/json'
  end

  data = parse_response(r, 'data')['testers']
  handle_itc_response(data) || data[0]
end

#generate_app_version_promocodes!(app_id: nil, version_id: nil, quantity: nil) ⇒ Object 



963
964
965
966
967
968
969
970
971
972
973
974
975
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 963

def generate_app_version_promocodes!(app_id: nil, version_id: nil, quantity: nil)
  data = {
    numberOfCodes: { value: quantity },
    agreedToContract: { value: true }
  }
  url = "ra/apps/#{app_id}/promocodes/versions/#{version_id}"
  r = request(:post) do |req|
    req.url url
    req.body = data.to_json
    req.headers['Content-Type'] = 'application/json'
  end
  parse_response(r, 'data')
end

#get_build_info_for_review(app_id: nil, train: nil, build_number: nil, platform: 'ios') ⇒ Object

rubocop:enable Metrics/ParameterLists



730
731
732
733
734
735
736
737
738
739
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 730

def get_build_info_for_review(app_id: nil, train: nil, build_number: nil, platform: 'ios')
  url = "ra/apps/#{app_id}/platforms/#{platform}/trains/#{train}/builds/#{build_number}/testInformation"
  r = request(:get) do |req|
    req.url url
    req.headers['Content-Type'] = 'application/json'
  end
  handle_itc_response(r.body)

  r.body['data']
end

#get_rating_summary(app_id, platform, versionId = '') ⇒ Object 



320
321
322
323
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 320

def get_rating_summary(app_id, platform, versionId = '')
  r = request(:get, "ra/apps/#{app_id}/reviews/summary?platform=#{platform}&versionId=#{versionId}")
  parse_response(r, 'data')
end

#get_resolution_center(app_id, platform) ⇒ Object 



315
316
317
318
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 315

def get_resolution_center(app_id, platform)
  r = request(:get, "ra/apps/#{app_id}/platforms/#{platform}/resolutionCenter?v=latest")
  parse_response(r, 'data')
end

#get_reviews(app_id, platform, storefront, versionId = '') ⇒ Object 



325
326
327
328
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 325

def get_reviews(app_id, platform, storefront, versionId = '')
  r = request(:get, "ra/apps/#{app_id}/reviews?platform=#{platform}&storefront=#{storefront}&versionId=#{versionId}")
  parse_response(r, 'data')['reviews']
end

#groups ⇒ Object 



812
813
814
815
816
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 812

def groups
  return @cached_groups if @cached_groups
  r = request(:get, '/WebObjects/iTunesConnect.woa/ra/users/pre/ext')
  @cached_groups = parse_response(r, 'data')['groups']
end

#handle_itc_response(raw) ⇒ Object

rubocop:disable Metrics/PerceivedComplexity



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 168

def handle_itc_response(raw)
  return unless raw
  return unless raw.kind_of? Hash

  data = raw['data'] || raw # sometimes it's with data, sometimes it isn't

  if data.fetch('sectionErrorKeys', []).count == 0 and
     data.fetch('sectionInfoKeys', []).count == 0 and
     data.fetch('sectionWarningKeys', []).count == 0 and
     data.fetch('validationErrors', []).count == 0

    logger.debug("Request was successful")
  end

  # We pass on the `current_language` so that the error message tells the user
  # what language the error was caused in
  handle_response_hash = lambda do |hash, current_language = nil|
    errors = []
    if hash.kind_of?(Hash)
      current_language ||= hash["language"]

      hash.each do |key, value|
        errors += handle_response_hash.call(value, current_language)

        next unless key == 'errorKeys' and value.kind_of?(Array) and value.count > 0
        # Prepend the error with the language so it's easier to understand for the user
        errors += value.collect do |current_error_message|
          current_language ? "[#{current_language}]: #{current_error_message}" : current_error_message
        end
      end
    elsif hash.kind_of? Array
      hash.each do |value|
        errors += handle_response_hash.call(value)
      end
      # else: We don't care about simple values
    end
    return errors
  end

  errors = handle_response_hash.call(data)
  errors += data.fetch('sectionErrorKeys', [])
  errors += data.fetch('validationErrors', [])

  # Sometimes there is a different kind of error in the JSON response
  # e.g. {"warn"=>nil, "error"=>["operation_failed"], "info"=>nil}
  different_error = raw.fetch('messages', {}).fetch('error', nil)
  errors << different_error if different_error

  if errors.count > 0 # they are separated by `.` by default
    if errors.count == 1 and errors.first == "You haven't made any changes."
      # This is a special error which we really don't care about
    elsif errors.count == 1 and errors.first.include?("try again later")
      raise ITunesConnectTemporaryError.new, errors.first
    else
      raise ITunesConnectError.new, errors.join(' ')
    end
  end

  puts data['sectionInfoKeys'] if data['sectionInfoKeys']
  puts data['sectionWarningKeys'] if data['sectionWarningKeys']

  return data
end

#prepare_app_submissions(app_id, version) ⇒ Object 



745
746
747
748
749
750
751
752
753
754
755
756
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 745

def prepare_app_submissions(app_id, version)
  raise "app_id is required" unless app_id
  raise "version is required" unless version

  r = request(:get) do |req|
    req.url "ra/apps/#{app_id}/versions/#{version}/submit/summary"
    req.headers['Content-Type'] = 'application/json'
  end

  handle_itc_response(r.body)
  parse_response(r, 'data')
end

#price_tier(app_id) ⇒ Object 



411
412
413
414
415
416
417
418
419
420
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 411

def price_tier(app_id)
  r = request(:get, "ra/apps/#{app_id}/pricing/intervals")
  data = parse_response(r, 'data')

  begin
    data["pricingIntervalsFieldTO"]["value"].first["tierStem"]
  rescue
    nil
  end
end

#pricing_tiers ⇒ Array

Note:

Although this information is publicly available, the current spaceship implementation requires you to have a logged in client to access it

Returns an array of all available pricing tiers

[{

"tierStem": "0",
"tierName": "Free",
"pricingInfo": [{
    "country": "United States",
    "countryCode": "US",
    "currencySymbol": "$",
    "currencyCode": "USD",
    "wholesalePrice": 0.0,
    "retailPrice": 0.0,
    "fRetailPrice": "$0.00",
    "fWholesalePrice": "$0.00"
  }, {
  ...

}, { …

Returns:

  • (Array) —

    the PricingTier objects (Spaceship::Tunes::PricingTier)



443
444
445
446
447
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 443

def pricing_tiers
  r = request(:get, 'ra/apps/pricing/matrix')
  data = parse_response(r, 'data')['pricingTiers']
  data.map { |tier| Spaceship::Tunes::PricingTier.factory(tier) }
end

#ref_data ⇒ AppVersionRef

Fetches the App Version Reference information from ITC

Returns:

  • (AppVersionRef) —

    the response



548
549
550
551
552
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 548

def ref_data
  r = request(:get, '/WebObjects/iTunesConnect.woa/ra/apps/version/ref')
  data = parse_response(r, 'data')
  Spaceship::Tunes::AppVersionRef.factory(data)
end

#reject!(app_id, version) ⇒ Object 



986
987
988
989
990
991
992
993
994
995
996
997
998
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 986

def reject!(app_id, version)
  raise "app_id is required" unless app_id
  raise "version is required" unless version

  r = request(:post) do |req|
    req.url "ra/apps/#{app_id}/versions/#{version}/reject"
    req.headers['Content-Type'] = 'application/json'
    req.body = app_id.to_s
  end

  handle_itc_response(r.body)
  parse_response(r, 'data')
end

#release!(app_id, version) ⇒ Object 



783
784
785
786
787
788
789
790
791
792
793
794
795
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 783

def release!(app_id, version)
  raise "app_id is required" unless app_id
  raise "version is required" unless version

  r = request(:post) do |req|
    req.url "ra/apps/#{app_id}/versions/#{version}/releaseToStore"
    req.headers['Content-Type'] = 'application/json'
    req.body = app_id.to_s
  end

  handle_itc_response(r.body)
  parse_response(r, 'data')
end

#remove_tester_from_app!(tester, app_id) ⇒ Object 



889
890
891
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 889

def remove_tester_from_app!(tester, app_id)
  update_tester_from_app!(tester, app_id, false)
end

#remove_testflight_build_from_review!(app_id: nil, train: nil, build_number: nil, platform: 'ios') ⇒ Object 



601
602
603
604
605
606
607
608
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 601

def remove_testflight_build_from_review!(app_id: nil, train: nil, build_number: nil, platform: 'ios')
  r = request(:post) do |req|
    req.url "ra/apps/#{app_id}/platforms/#{platform}/trains/#{train}/builds/#{build_number}/reject"
    req.body = {}.to_json
    req.headers['Content-Type'] = 'application/json'
  end
  handle_itc_response(r.body)
end

#sandbox_testers(tester_class) ⇒ Object 



896
897
898
899
900
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 896

def sandbox_testers(tester_class)
  url = tester_class.url[:index]
  r = request(:get, url)
  parse_response(r, 'data')
end

#select_team ⇒ Object

Shows a team selection for the user in the terminal. This should not be called on CI systems



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 104

def select_team
  t_id = (ENV['FASTLANE_ITC_TEAM_ID'] || '').strip
  t_name = (ENV['FASTLANE_ITC_TEAM_NAME'] || '').strip

  if t_name.length > 0 && t_id.length.zero? # we prefer IDs over names, they are unique
    puts "Looking for iTunes Connect Team with name #{t_name}" if $verbose

    teams.each do |t|
      t_id = t['contentProvider']['contentProviderId'].to_s if t['contentProvider']['name'].casecmp(t_name.downcase).zero?
    end

    puts "Could not find team with name '#{t_name}', trying to fallback to default team" if t_id.length.zero?
  end

  t_id = teams.first['contentProvider']['contentProviderId'].to_s if teams.count == 1

  if t_id.length > 0
    puts "Looking for iTunes Connect Team with ID #{t_id}" if $verbose

    # actually set the team id here
    self.team_id = t_id
    return
  end

  # user didn't specify a team... #thisiswhywecanthavenicethings
  loop do
    puts "Multiple iTunes Connect teams found, please enter the number of the team you want to use: "
    puts "Note: to automatically choose the team, provide either the iTunes Connect Team ID, or the Team Name in your fastlane/Appfile:"
    puts "Alternatively you can pass the team name or team ID using the `FASTLANE_ITC_TEAM_ID` or `FASTLANE_ITC_TEAM_NAME` environment variable"
    first_team = teams.first["contentProvider"]
    puts ""
    puts "  itc_team_id \"#{first_team['contentProviderId']}\""
    puts ""
    puts "or"
    puts ""
    puts "  itc_team_name \"#{first_team['name']}\""
    puts ""
    teams.each_with_index do |team, i|
      puts "#{i + 1}) \"#{team['contentProvider']['name']}\" (#{team['contentProvider']['contentProviderId']})"
    end

    selected = ($stdin.gets || '').strip.to_i - 1
    team_to_use = teams[selected] if selected >= 0

    if team_to_use
      self.team_id = team_to_use['contentProvider']['contentProviderId'].to_s # actually set the team id here
      break
    end
  end
end

#send_app_submission(app_id, data) ⇒ Object 



758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 758

def send_app_submission(app_id, data)
  raise "app_id is required" unless app_id

  # ra/apps/1039164429/version/submit/complete
  r = request(:post) do |req|
    req.url "ra/apps/#{app_id}/version/submit/complete"
    req.body = data.to_json
    req.headers['Content-Type'] = 'application/json'
  end

  handle_itc_response(r.body)

  if r.body.fetch('messages').fetch('info').last == "Successful POST"
    # success
  else
    raise "Something went wrong when submitting the app for review. Make sure to pass valid options to submit your app for review"
  end

  parse_response(r, 'data')
end

#send_login_request(user, password) ⇒ Object 



162
163
164
165
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 162

def (user, password)
  clear_user_cached_data
  (user, password)
end

#submit_testflight_build_for_review!(app_id: nil, train: nil, build_number: nil, platform: 'ios', changelog: nil, description: nil, feedback_email: nil, marketing_url: nil, first_name: nil, last_name: nil, review_email: nil, phone_number: nil, significant_change: false, privacy_policy_url: nil, review_user_name: nil, review_password: nil, review_notes: nil, encryption: false, encryption_updated: false, is_exempt: false, proprietary: false, third_party: false) ⇒ Object

rubocop:disable Metrics/ParameterLists



660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 660

def submit_testflight_build_for_review!(app_id: nil, train: nil, build_number: nil, platform: 'ios',
                                        # Required Metadata:
                                        changelog: nil,
                                        description: nil,
                                        feedback_email: nil,
                                        marketing_url: nil,
                                        first_name: nil,
                                        last_name: nil,
                                        review_email: nil,
                                        phone_number: nil,
                                        significant_change: false,

                                        # Optional Metadata:
                                        privacy_policy_url: nil,
                                        review_user_name: nil,
                                        review_password: nil,
                                        review_notes: nil,
                                        encryption: false,
                                        encryption_updated: false,
                                        is_exempt: false,
                                        proprietary: false,
                                        third_party: false)

  build_info = get_build_info_for_review(app_id: app_id, train: train, build_number: build_number, platform: platform)
  # Now fill in the values provided by the user

  # First the localised values:
  build_info['details'].each do |current|
    current['whatsNew']['value'] = changelog if changelog
    current['description']['value'] = description if description
    current['feedbackEmail']['value'] = feedback_email if feedback_email
    current['marketingUrl']['value'] = marketing_url if marketing_url
    current['privacyPolicyUrl']['value'] = privacy_policy_url if privacy_policy_url
    current['pageLanguageValue'] = current['language'] # There is no valid reason why we need this, only iTC being iTC
  end

  review_info = {
    "significantChange" => {
      "value" => significant_change
    },
    "buildTestInformationTO" => build_info,
    "exportComplianceTO" => {
      "usesEncryption" => {
        "value" => encryption
      },
      "encryptionUpdated" => {
        "value" => encryption_updated
      },
      "isExempt" => {
        "value" => is_exempt
      },
      "containsProprietaryCryptography" => {
        "value" => proprietary
      },
      "containsThirdPartyCryptography" => {
        "value" => third_party
      }
    }
  }

  r = request(:post) do |req| # same URL, but a POST request
    req.url "ra/apps/#{app_id}/platforms/#{platform}/trains/#{train}/builds/#{build_number}/review/submit"

    req.body = review_info.to_json
    req.headers['Content-Type'] = 'application/json'
  end
  handle_itc_response(r.body)
end

#supported_countries ⇒ Object

An array of supported countries [ 

"code": "AL",
"name": "Albania",
"region": "Europe"

, { …



456
457
458
459
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 456

def supported_countries
  r = request(:get, "ra/apps/pricing/supportedCountries")
  parse_response(r, 'data')
end

#team_id ⇒ String

Returns The currently selected Team ID.

Returns:

  • (String) —

    The currently selected Team ID



60
61
62
63
64
65
66
67
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 60

def team_id
  return @current_team_id if @current_team_id

  if teams.count > 1
    puts "The current user is in #{teams.count} teams. Pass a team ID or call `select_team` to choose a team. Using the first one for now."
  end
  @current_team_id ||= teams[0]['contentProvider']['contentProviderId']
end

#team_id=(team_id) ⇒ Object

Set a new team ID which will be used from now on



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 70

def team_id=(team_id)
  # First, we verify the team actually exists, because otherwise iTC would return the
  # following confusing error message
  #
  #     invalid content provider id
  #
  available_teams = teams.collect do |team|
    (team["contentProvider"] || {})["contentProviderId"]
  end

  result = available_teams.find do |available_team_id|
    team_id.to_s == available_team_id.to_s
  end

  unless result
    raise ITunesConnectError.new, "Could not set team ID to '#{team_id}', only found the following available teams: #{available_teams.join(', ')}"
  end

  response = request(:post) do |req|
    req.url "ra/v1/session/webSession"
    req.body = {
      contentProviderId: team_id,
      dsId: user_detail_data.ds_id # https://github.com/fastlane/fastlane/issues/6711
    }.to_json
    req.headers['Content-Type'] = 'application/json'
  end

  handle_itc_response(response.body)

  @current_team_id = team_id
end

#team_information ⇒ Hash

Returns Fetches all information of the currently used team.

Returns:

  • (Hash) —

    Fetches all information of the currently used team



156
157
158
159
160
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 156

def team_information
  teams.find do |t|
    t['teamId'] == team_id
  end
end

#teams ⇒ Array

Returns A list of all available teams.

Returns:

  • (Array) —

    A list of all available teams



48
49
50
51
52
53
54
55
56
57
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 48

def teams
  return @teams if @teams
  r = request(:get, "ra/user/detail")
  @teams = parse_response(r, 'data')['associatedAccounts'].sort_by do |team|
    [
      team['contentProvider']['name'],
      team['contentProvider']['contentProviderId']
    ]
  end
end

#testers(tester) ⇒ Object 



800
801
802
803
804
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 800

def testers(tester)
  url = tester.url[:index]
  r = request(:get, url)
  parse_response(r, 'data')['testers']
end

#testers_by_app(tester, app_id) ⇒ Object 



806
807
808
809
810
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 806

def testers_by_app(tester, app_id)
  url = tester.url(app_id)[:index_by_app]
  r = request(:get, url)
  parse_response(r, 'data')['users']
end

#update_app_details!(app_id, data) ⇒ Object 



247
248
249
250
251
252
253
254
255
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 247

def update_app_details!(app_id, data)
  r = request(:post) do |req|
    req.url "ra/apps/#{app_id}/details"
    req.body = data.to_json
    req.headers['Content-Type'] = 'application/json'
  end

  handle_itc_response(r.body)
end

#update_app_version!(app_id, version_id, data) ⇒ Object 



361
362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 361

def update_app_version!(app_id, version_id, data)
  raise "app_id is required" unless app_id
  raise "version_id is required" unless version_id.to_i > 0

  with_tunes_retry do
    r = request(:post) do |req|
      req.url "ra/apps/#{app_id}/platforms/ios/versions/#{version_id}"
      req.body = data.to_json
      req.headers['Content-Type'] = 'application/json'
    end

    handle_itc_response(r.body)
  end
end

#update_build_information!(app_id: nil, train: nil, build_number: nil, whats_new: nil, description: nil, feedback_email: nil, platform: 'ios') ⇒ Object 



628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 628

def update_build_information!(app_id: nil,
                              train: nil,
                              build_number: nil,

                              # optional:
                              whats_new: nil,
                              description: nil,
                              feedback_email: nil,
                              platform: 'ios')
  url = "ra/apps/#{app_id}/platforms/#{platform}/trains/#{train}/builds/#{build_number}/testInformation"

  build_info = get_build_info_for_review(app_id: app_id, train: train, build_number: build_number, platform: platform)
  build_info["details"].each do |current|
    current["whatsNew"]["value"] = whats_new if whats_new
    current["description"]["value"] = description if description
    current["feedbackEmail"]["value"] = feedback_email if feedback_email
  end

  review_user_name = build_info['reviewUserName']['value']
  review_password = build_info['reviewPassword']['value']
  build_info['reviewAccountRequired']['value'] = (review_user_name.to_s + review_password.to_s).length > 0

  # Now send everything back to iTC
  r = request(:post) do |req| # same URL, but a POST request
    req.url url
    req.body = build_info.to_json
    req.headers['Content-Type'] = 'application/json'
  end
  handle_itc_response(r.body)
end

#update_build_trains!(app_id, testing_type, data) ⇒ Object 



586
587
588
589
590
591
592
593
594
595
596
597
598
599
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 586

def update_build_trains!(app_id, testing_type, data)
  raise "app_id is required" unless app_id

  # The request fails if this key is present in the data
  data.delete("dailySubmissionCountByPlatform")

  r = request(:post) do |req|
    req.url "ra/apps/#{app_id}/testingTypes/#{testing_type}/trains/"
    req.body = data.to_json
    req.headers['Content-Type'] = 'application/json'
  end

  handle_itc_response(r.body)
end

#update_price_tier!(app_id, price_tier) ⇒ Object 



380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 380

def update_price_tier!(app_id, price_tier)
  r = request(:get, "ra/apps/#{app_id}/pricing/intervals")
  data = parse_response(r, 'data')

  first_price = (data["pricingIntervalsFieldTO"]["value"] || []).count == 0 # first price
  data["pricingIntervalsFieldTO"]["value"] ||= []
  data["pricingIntervalsFieldTO"]["value"] << {} if data["pricingIntervalsFieldTO"]["value"].count == 0
  data["pricingIntervalsFieldTO"]["value"].first["tierStem"] = price_tier.to_s

  effective_date = (first_price ? nil : Time.now.to_i * 1000)
  data["pricingIntervalsFieldTO"]["value"].first["priceTierEffectiveDate"] = effective_date
  data["pricingIntervalsFieldTO"]["value"].first["priceTierEndDate"] = nil
  data["countriesChanged"] = first_price
  data["theWorld"] = true

  if first_price # first price, need to set all countries
    data["countries"] = supported_countries.collect do |c|
      c.delete('region') # we don't care about le region
      c
    end
  end

  # send the changes back to Apple
  r = request(:post) do |req|
    req.url "ra/apps/#{app_id}/pricing/intervals"
    req.body = data.to_json
    req.headers['Content-Type'] = 'application/json'
  end
  handle_itc_response(r.body)
end

#upload_geojson(app_version, upload_file) ⇒ JSON

Uploads the transit app file

Parameters:

  • app_version (AppVersion) —

    : The version of your app

  • upload_file (UploadFile) —

    : The image to upload

Returns:

  • (JSON) —

    the response



517
518
519
520
521
522
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 517

def upload_geojson(app_version, upload_file)
  raise "app_version is required" unless app_version
  raise "upload_file is required" unless upload_file

  du_client.upload_geojson(app_version, upload_file, content_provider_id, sso_token_for_image)
end

#upload_large_icon(app_version, upload_image) ⇒ JSON

Uploads a large icon

Parameters:

  • app_version (AppVersion) —

    : The version of your app

  • upload_image (UploadFile) —

    : The icon to upload

Returns:

  • (JSON) —

    the response



468
469
470
471
472
473
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 468

def upload_large_icon(app_version, upload_image)
  raise "app_version is required" unless app_version
  raise "upload_image is required" unless upload_image

  du_client.upload_large_icon(app_version, upload_image, content_provider_id, sso_token_for_image)
end

#upload_messages_screenshot(app_version, upload_image, device) ⇒ JSON

Uploads an iMessage screenshot

Parameters:

  • app_version (AppVersion) —

    : The version of your app

  • upload_image (UploadFile) —

    : The image to upload

  • device (string) —

    : The target device

Returns:

  • (JSON) —

    the response



505
506
507
508
509
510
511
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 505

def upload_messages_screenshot(app_version, upload_image, device)
  raise "app_version is required" unless app_version
  raise "upload_image is required" unless upload_image
  raise "device is required" unless device

  du_client.upload_messages_screenshot(app_version, upload_image, content_provider_id, sso_token_for_image, device)
end

#upload_screenshot(app_version, upload_image, device, is_messages) ⇒ JSON

Uploads a screenshot

Parameters:

  • app_version (AppVersion) —

    : The version of your app

  • upload_image (UploadFile) —

    : The image to upload

  • device (string) —

    : The target device

  • is_messages (Bool) —

    : True if the screenshot is for iMessage

Returns:

  • (JSON) —

    the response



492
493
494
495
496
497
498
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 492

def upload_screenshot(app_version, upload_image, device, is_messages)
  raise "app_version is required" unless app_version
  raise "upload_image is required" unless upload_image
  raise "device is required" unless device

  du_client.upload_screenshot(app_version, upload_image, content_provider_id, sso_token_for_image, device, is_messages)
end

#upload_trailer(app_version, upload_trailer) ⇒ JSON

Uploads the transit app file

Parameters:

  • app_version (AppVersion) —

    : The version of your app

  • upload_trailer (UploadFile) —

    : The trailer to upload

Returns:

  • (JSON) —

    the response



528
529
530
531
532
533
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 528

def upload_trailer(app_version, upload_trailer)
  raise "app_version is required" unless app_version
  raise "upload_trailer is required" unless upload_trailer

  du_client.upload_trailer(app_version, upload_trailer, content_provider_id, sso_token_for_video)
end

#upload_trailer_preview(app_version, upload_trailer_preview) ⇒ JSON

Uploads the trailer preview

Parameters:

  • app_version (AppVersion) —

    : The version of your app

  • upload_trailer_preview (UploadFile) —

    : The trailer preview to upload

Returns:

  • (JSON) —

    the response



539
540
541
542
543
544
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 539

def upload_trailer_preview(app_version, upload_trailer_preview)
  raise "app_version is required" unless app_version
  raise "upload_trailer_preview is required" unless upload_trailer_preview

  du_client.upload_trailer_preview(app_version, upload_trailer_preview, content_provider_id, sso_token_for_image)
end

#upload_watch_icon(app_version, upload_image) ⇒ JSON

Uploads a watch icon

Parameters:

  • app_version (AppVersion) —

    : The version of your app

  • upload_image (UploadFile) —

    : The icon to upload

Returns:

  • (JSON) —

    the response



479
480
481
482
483
484
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 479

def upload_watch_icon(app_version, upload_image)
  raise "app_version is required" unless app_version
  raise "upload_image is required" unless upload_image

  du_client.upload_watch_icon(app_version, upload_image, content_provider_id, sso_token_for_image)
end

#user_detail_data ⇒ UserDetail

Fetches the User Detail information from ITC. This gets called often and almost never changes so we cache it

Returns:

  • (UserDetail) —

    the response



557
558
559
560
561
562
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 557

def user_detail_data
  return @cached if @cached
  r = request(:get, '/WebObjects/iTunesConnect.woa/ra/user/detail')
  data = parse_response(r, 'data')
  @cached = Spaceship::Tunes::UserDetail.factory(data)
end

#version_states_history(app_id, platform, version_id) ⇒ Object 



950
951
952
953
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 950

def version_states_history(app_id, platform, version_id)
  r = request(:get, "ra/apps/#{app_id}/versions/#{version_id}/stateHistory?platform=#{platform}")
  parse_response(r, 'data')
end

#versions_history(app_id, platform) ⇒ Object 



945
946
947
948
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 945

def versions_history(app_id, platform)
  r = request(:get, "ra/apps/#{app_id}/stateHistory?platform=#{platform}")
  parse_response(r, 'data')['versions']
end