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

State History collapse

Promo codes 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, #persistent_cookie_path, #select_device, #send_shared_login_request, #store_cookie, #store_session, #with_retry

Constructor Details

#initialize ⇒ TunesClient

Returns a new instance of TunesClient.



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

def initialize
  super

  @du_client = DUClient.new
end

Instance Attribute Details

#du_client ⇒ Object (readonly)

Returns the value of attribute du_client.



12
13
14
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 12

def du_client
  @du_client
end

Class Method Details

.hostname ⇒ Object 



41
42
43
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 41

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



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

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 



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

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

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

All build trains, even if there is no TestFlight



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

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

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



554
555
556
557
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 554

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

#app_details(app_id) ⇒ Object 



198
199
200
201
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 198

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

#app_promocodes(app_id: nil) ⇒ Object 



836
837
838
839
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 836

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 



855
856
857
858
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 855

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) ⇒ Object 



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 288

def app_version(app_id, is_live)
  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)
  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 



306
307
308
309
310
311
312
313
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 306

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 



193
194
195
196
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 193

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 



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

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) ⇒ Object

Parameters:

  • internal (testing_type) —

    or external



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

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

#candidate_builds(app_id, version_id) ⇒ Object 



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

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) ⇒ 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.



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 223

def create_application!(name: nil, primary_language: nil, version: nil, sku: nil, bundle_id: nil, bundle_id_suffix: nil, company_name: nil)
  # First, we need to fetch the data from Apple, which we then modify with the user's values
  app_type = 'ios'
  r = request(:get, "ra/apps/create/v2/?platformString=#{app_type}")
  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 || 'English' }
  data['vendorId'] = { value: sku }
  data['bundleIdSuffix'] = { value: bundle_id_suffix }
  data['companyName'] = { value: company_name } if company_name
  data['enabledPlatformsForCreation'] = { value: [app_type] }

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

  # 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_tester!(tester: nil, email: nil, first_name: nil, last_name: nil) ⇒ Object 



748
749
750
751
752
753
754
755
756
757
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 748

def create_tester!(tester: nil, email: nil, first_name: nil, last_name: 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
        }
      }

  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 



254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 254

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_tester!(tester) ⇒ Object 



779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 779

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 



841
842
843
844
845
846
847
848
849
850
851
852
853
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 841

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



666
667
668
669
670
671
672
673
674
675
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 666

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 



274
275
276
277
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 274

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 



269
270
271
272
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 269

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 



279
280
281
282
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 279

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

#handle_itc_response(raw) ⇒ Object

rubocop:disable Metrics/PerceivedComplexity



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 130

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

  handle_response_hash = lambda do |hash|
    errors = []
    if hash.kind_of? Hash
      hash.each do |key, value|
        errors += handle_response_hash.call(value)

        if key == 'errorKeys' and value.kind_of? Array and value.count > 0
          errors += value
        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 



681
682
683
684
685
686
687
688
689
690
691
692
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 681

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 



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

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)



397
398
399
400
401
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 397

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



488
489
490
491
492
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 488

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

#release!(app_id, version) ⇒ Object 



719
720
721
722
723
724
725
726
727
728
729
730
731
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 719

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 



816
817
818
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 816

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 



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

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

#select_team ⇒ Object

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



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 82

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

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

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

  if t_id.length > 0
    # 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: "
    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 



694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 694

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 



124
125
126
127
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 124

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



596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
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
658
659
660
661
662
663
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 596

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"

, { …



410
411
412
413
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 410

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



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

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



68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 68

def team_id=(team_id)
  response = request(:post) do |req|
    req.url "ra/v1/session/webSession"
    req.body = { contentProviderId: team_id }.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



118
119
120
121
122
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 118

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



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

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 



736
737
738
739
740
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 736

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

#testers_by_app(tester, app_id) ⇒ Object 



742
743
744
745
746
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 742

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 



203
204
205
206
207
208
209
210
211
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 203

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 



315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 315

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 



564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 564

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 



524
525
526
527
528
529
530
531
532
533
534
535
536
537
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 524

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 



334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 334

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



457
458
459
460
461
462
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 457

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



422
423
424
425
426
427
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 422

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_screenshot(app_version, upload_image, device) ⇒ 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

Returns:

  • (JSON) —

    the response



445
446
447
448
449
450
451
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 445

def upload_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_screenshot(app_version, upload_image, content_provider_id, sso_token_for_image, device)
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



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

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



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

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



433
434
435
436
437
438
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 433

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



497
498
499
500
501
502
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 497

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 



828
829
830
831
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 828

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 



823
824
825
826
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 823

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