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, #logger, #user

Init and Login collapse

Applications collapse

AppVersions collapse

Pricing collapse

App Icons collapse

CandiateBuilds collapse

Build Trains collapse

Submit for Review collapse

Testers collapse

State History collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Client

#UI, #cookie, login, #login, #page_size, #paging, #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 



785
786
787
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 785

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

#app_details(app_id) ⇒ Object 



240
241
242
243
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 240

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

#app_version(app_id, is_live) ⇒ Object 



320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 320

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 



338
339
340
341
342
343
344
345
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 338

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 



235
236
237
238
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 235

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

#build_trains(app_id, testing_type) ⇒ Object

Parameters:

  • internal (testing_type) —

    or external



523
524
525
526
527
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 523

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 



513
514
515
516
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 513

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.



265
266
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
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 265

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['newApp']['name'] = { value: name }
  data['newApp']['bundleId']['value'] = bundle_id
  data['newApp']['primaryLanguage']['value'] = primary_language || 'English'
  data['newApp']['vendorId'] = { value: sku }
  data['newApp']['bundleIdSuffix']['value'] = bundle_id_suffix
  data['companyName']['value'] = company_name if company_name
  data['newApp']['appType'] = 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 



721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 721

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 



296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 296

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 



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
778
779
780
781
782
783
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 752

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

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



638
639
640
641
642
643
644
645
646
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 638

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

  r.body['data']
end

#get_resolution_center(app_id, platform) ⇒ Object 



311
312
313
314
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 311

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

#handle_itc_response(raw) ⇒ Object

rubocop:disable Metrics/CyclomaticComplexity rubocop:disable Metrics/PerceivedComplexity



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
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 173

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

    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') if data['sectionErrorKeys']

  # 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 



672
673
674
675
676
677
678
679
680
681
682
683
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 672

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 



397
398
399
400
401
402
403
404
405
406
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 397

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

#ref_data ⇒ AppVersionRef

Fetches the App Version Reference information from ITC

Returns:

  • (AppVersionRef) —

    the response



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

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

#remove_tester_from_app!(tester, app_id) ⇒ Object 



789
790
791
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 789

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 



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

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



77
78
79
80
81
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
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 77

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'].downcase == t_name.downcase
    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 



685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 685

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 



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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 126

def (user, password)
  clear_user_cached_data

  data = {
    accountName: user,
    password: password,
    rememberMe: true
  }

  begin
    response = request(:post) do |req|
      req.url "https://idmsa.apple.com/appleauth/auth/signin?widgetKey=#{service_key}"
      req.body = data.to_json
      req.headers['Content-Type'] = 'application/json'
      req.headers['X-Requested-With'] = 'XMLHttpRequest'
      req.headers['Accept'] = 'application/json, text/javascript'
    end
  rescue UnauthorizedAccessError
    raise InvalidUserCredentialsError.new, "Invalid username and password combination. Used '#{user}' as the username."
  end

  # get woinst, wois, and itctx cookie values
  request(:get, "https://itunesconnect.apple.com/WebObjects/iTunesConnect.woa/wa/route?noext")
  request(:get, "https://itunesconnect.apple.com/WebObjects/iTunesConnect.woa")

  case response.status
  when 403
    raise InvalidUserCredentialsError.new, "Invalid username and password combination. Used '#{user}' as the username."
  when 200
    return response
  else
    if response["Location"] == "/auth" # redirect to 2 step auth page
      raise "spaceship / fastlane doesn't support 2 step enabled accounts yet. Please temporary disable 2 step verification until spaceship was updated."
    elsif (response.body || "").include?('invalid="true"')
      # User Credentials are wrong
      raise InvalidUserCredentialsError.new, "Invalid username and password combination. Used '#{user}' as the username."
    elsif (response['Set-Cookie'] || "").include?("itctx")
      raise "Looks like your Apple ID is not enabled for iTunes Connect, make sure to be able to login online"
    else
      info = [response.body, response['Set-Cookie']]
      raise ITunesConnectError.new, info.join("\n")
    end
  end
end

#service_key ⇒ Object 



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

def service_key
  return @service_key if @service_key
  # We need a service key from a JS file to properly auth
  js = request(:get, "https://itunesconnect.apple.com/itc/static-resources/controllers/login_cntrl.js")
  @service_key ||= js.body.match(/itcServiceKey = '(.*)'/)[1]
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, encryption: false) ⇒ Object 



582
583
584
585
586
587
588
589
590
591
592
593
594
595
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
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 582

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,
                                        encryption: 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['testInfo']['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
  build_info['significantChange'] ||= {}
  build_info['significantChange']['value'] = significant_change
  build_info['testInfo']['reviewFirstName']['value'] = first_name if first_name
  build_info['testInfo']['reviewLastName']['value'] = last_name if last_name
  build_info['testInfo']['reviewPhone']['value'] = phone_number if phone_number
  build_info['testInfo']['reviewEmail']['value'] = review_email if review_email
  build_info['testInfo']['reviewUserName']['value'] = review_user_name if review_user_name
  build_info['testInfo']['reviewPassword']['value'] = review_password if review_password

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

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

  encryption_info = r.body['data']
  update_encryption_compliance(app_id: app_id,
                               train: train,
                               build_number: build_number,
                               platform: platform,
                               encryption_info: encryption_info,
                               encryption: encryption)
end

#supported_countries ⇒ Object

An array of supported countries [ 

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

, { …



415
416
417
418
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 415

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



53
54
55
56
57
58
59
60
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 53

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



63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 63

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



113
114
115
116
117
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 113

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
 
# 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']
end

#testers(tester) ⇒ Object 



709
710
711
712
713
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 709

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

#testers_by_app(tester, app_id) ⇒ Object 



715
716
717
718
719
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 715

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 



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

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 



347
348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 347

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 



550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 550

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"
  r = request(:get) do |req|
    req.url url
    req.headers['Content-Type'] = 'application/json'
  end
  handle_itc_response(r.body)

  build_info = r.body['data']
  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

  # 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 



529
530
531
532
533
534
535
536
537
538
539
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 529

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

  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_encryption_compliance(app_id: nil, train: nil, build_number: nil, platform: 'ios', encryption_info: nil, encryption: nil, is_exempt: true, proprietary: false, third_party: false) ⇒ Object 



648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 648

def update_encryption_compliance(app_id: nil, train: nil, build_number: nil, platform: 'ios', encryption_info: nil, encryption: nil, is_exempt: true, proprietary: false, third_party: false)
  return unless encryption_info['exportComplianceRequired']
  # only sometimes this is required

  encryption_info['usesEncryption']['value'] = encryption
  encryption_info['encryptionUpdated'] ||= {}
  encryption_info['encryptionUpdated']['value'] = encryption
  encryption_info['isExempt']['value'] = is_exempt
  encryption_info['containsProprietaryCryptography']['value'] = proprietary
  encryption_info['containsThirdPartyCryptography']['value'] = third_party

  r = request(:post) do |req|
    req.url "ra/apps/#{app_id}/platforms/#{platform}/trains/#{train}/builds/#{build_number}/submit/complete"
    req.body = encryption_info.to_json
    req.headers['Content-Type'] = 'application/json'
  end

  handle_itc_response(r.body)
end

#update_price_tier!(app_id, price_tier) ⇒ Object 



366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 366

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



462
463
464
465
466
467
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 462

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



427
428
429
430
431
432
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 427

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



450
451
452
453
454
455
456
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 450

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



473
474
475
476
477
478
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 473

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



484
485
486
487
488
489
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 484

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



438
439
440
441
442
443
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 438

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



502
503
504
505
506
507
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 502

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 



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

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 



796
797
798
799
 
# File 'lib/spaceship/tunes/tunes_client.rb', line 796

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