[spaceship] Adding support for DEP_ID #14852

heartofagoof · 2019-06-03T19:11:46Z

Checklist

I've run bundle exec rspec from the root directory to see all new and existing tests pass
I've followed the fastlane code style and run bundle exec rubocop -a to ensure the code style is valid
I've read the Contribution Guidelines
I've updated the documentation if necessary.

Motivation and Context

This change allows the DEP id to be updated in avaliability - this will be default in coming times instead of VPP id.

Description

Added the class B2bOrganization and added related parsing for it in Availability and TunesClient
Added tests
Updated test fixtures to work with the tests

max-ott · 2019-07-05T10:02:17Z

Hi @heartofagoof thanks for your PR! What's the easiest way to test this via spaceship / irb so we can get this approved?

leifktaylor

I've tested this in IRB and Spaceship Sandbox.
It works like a charm. I have REDACTED the values of the company names etc in the output to protect my the privacy of my firm.

Below is the output of the terminal:

# Summary of first few lines without output
[20] pry(#<Spaceship::Playground>)> app = Spaceship::Application.find('REDACTED')
[22] pry(#<Spaceship::Playground>)> org_map = {'type' => 'ADD', 'depCustomerId' => 'REDACTED', 'organizationId' => 'REDACTED', 'name' => 'REDACTED'}

[26] pry(#<Spaceship::Playground>)> new_org = Spaceship::Tunes::B2bOrganization.new('value' =>  org_map)
=> <Spaceship::Tunes::B2bOrganization 
	type="ADD", 
	dep_customer_id="REDACTED", 
	dep_organization_id="REDACTED", 
	name="REDACTED">

[28] pry(#<Spaceship::Playground>)> availability = app.availability
=> <Spaceship::Tunes::Availability 
	include_future_territories=true, 
	territories=[<Spaceship::Tunes::Territory 
		code="US", 
		currency_code="USD", 
		name="United States", 
		region="The United States and Canada", 
		region_locale_key="ITC.region.NAM">], 
	cleared_for_preorder=false, 
	app_available_date=nil, 
	b2b_app_enabled=false, 
	educational_discount=true, 
	b2b_unavailable=false, 
	b2b_users=[], 
	b2b_organizations=[]>
[29] pry(#<Spaceship::Playground>)> availability.enable_b2b_app!
=> <Spaceship::Tunes::Availability 
	include_future_territories=true, 
	territories=[<Spaceship::Tunes::Territory 
		code="US", 
		currency_code="USD", 
		name="United States", 
		region="The United States and Canada", 
		region_locale_key="ITC.region.NAM">], 
	cleared_for_preorder=false, 
	app_available_date=nil, 
	b2b_app_enabled=true, 
	educational_discount=false, 
	b2b_unavailable=false, 
	b2b_users=[], 
	b2b_organizations=[]>
[30] pry(#<Spaceship::Playground>)> availability.update_dep_organizations([new_org])
=> <Spaceship::Tunes::Availability 
	include_future_territories=true, 
	territories=[<Spaceship::Tunes::Territory 
		code="US", 
		currency_code="USD", 
		name="United States", 
		region="The United States and Canada", 
		region_locale_key="ITC.region.NAM">], 
	cleared_for_preorder=false, 
	app_available_date=nil, 
	b2b_app_enabled=true, 
	educational_discount=false, 
	b2b_unavailable=false, 
	b2b_users=[], 
	b2b_organizations=[<Spaceship::Tunes::B2bOrganization 
		type="ADD", 
		dep_customer_id="REDACTED", 
		dep_organization_id="REDACTED", 
		name="REDACTED">]>
[31] pry(#<Spaceship::Playground>)> app.update_availability!(availability)
=> <Spaceship::Tunes::Availability 
	include_future_territories=true, 
	territories=[<Spaceship::Tunes::Territory 
		code="US", 
		currency_code="USD", 
		name="United States", 
		region="The United States and Canada", 
		region_locale_key="ITC.region.NAM">], 
	cleared_for_preorder=false, 
	app_available_date=nil, 
	b2b_app_enabled=true, 
	educational_discount=false, 
	b2b_unavailable=false, 
	b2b_users=[], 
	b2b_organizations=[<Spaceship::Tunes::B2bOrganization 
		type="NO_CHANGE", 
		dep_customer_id="REDACTED", 
		dep_organization_id=REDACTED, 
		name="REDACTED">]>
[32] pry(#<Spaceship::Playground>)>

Below is the POST and response (redacted) in the spaceship logs.

INFO  [16:12:13]: >> POST ra/apps/REDACTED/pricing/intervals: {"sectionErrorKeys":[],"sectionInfoKeys":[],"sectionWarningKeys":[],"value":null,"countriesChanged":true,"countries":[{"code":"US"}],"b2BAppFlagDisabled":false,"educationDiscountDisabledFlag":false,"hotFudgeFeatureEnabled":true,"coldFudgeFeatureEnabled":true,"bitcodeAutoRecompileDisAllowed":false,"b2bAppEnabled":true,"educationalDiscount":false,"theWorld":true,"pricingIntervalsFieldTO":{"value":[{"priceTierEffectiveDate":null,"priceTierEndDate":null,"priceTierEffectiveISODate":null,"priceTierEndISODate":null,"tierStem":"0"}],"isEditable":true,"isRequired":false,"errorKeys":null},"availableDate": REDACTED,"unavailableDate":-2,"creatingApp":false,"hasApprovedVersion":false,"preOrder":{"clearedForPreOrder":{"value":false,"isEditable":true,"isRequired":true,"errorKeys":null},"appAvailableDate":{"value":null,"isEditable":true,"isRequired":true,"errorKeys":null},"preOrderAvailableDate":null},"appVersionsForOTAByPlatforms":{"iOS":[]},"b2bUsers":[],"b2bOrganizations":[{"value":{"type":"ADD","depCustomerId":"REDACTED","organizationId":"REDACTED","name":"REDACTED"}}]} 
DEBUG [16:12:26]: << POST ra/apps/REDACTED/pricing/intervals: 200 {"data"=>{"sectionErrorKeys"=>[], "sectionInfoKeys"=>[], "sectionWarningKeys"=>[], "value"=>nil, "countriesChanged"=>false, "countries"=>[{"code"=>"US", "name"=>"United States", "region"=>"The United States and Canada", "regionLocaleKey"=>"ITC.region.NAM", "currencyCodeISO3A"=>"USD"}], "b2BAppFlagDisabled"=>false, "educationDiscountDisabledFlag"=>false, "hotFudgeFeatureEnabled"=>true, "coldFudgeFeatureEnabled"=>true, "bitcodeAutoRecompileDisAllowed"=>false, "b2bAppEnabled"=>true, "educationalDiscount"=>false, "theWorld"=>true, "pricingIntervalsFieldTO"=>{"value"=>[{"priceTierEffectiveDate"=>nil, "priceTierEndDate"=>nil, "priceTierEffectiveISODate"=>nil, "priceTierEndISODate"=>nil, "tierStem"=>"0"}], "isEditable"=>true, "isRequired"=>false, "errorKeys"=>nil}, "availableDate"=>1562914800000, "unavailableDate"=>-2, "creatingApp"=>false, "hasApprovedVersion"=>false, "preOrder"=>{"clearedForPreOrder"=>{"value"=>false, "isEditable"=>true, "isRequired"=>true, "errorKeys"=>nil}, "appAvailableDate"=>{"value"=>nil, "isEditable"=>true, "isRequired"=>true, "errorKeys"=>nil}, "preOrderAvailableDate"=>nil}, "appVersionsForOTAByPlatforms"=>{"iOS"=>[]}, "b2bUsers"=>[], "b2bOrganizations"=>[{"value"=>{"type"=>"NO_CHANGE", "depCustomerId"=>"REDACTED", "organizationId"=> REDACTED, "name"=>"REDACTED"}, "isEditable"=>true, "isRequired"=>false, "errorKeys"=>nil}]}, "messages"=>{"warn"=>nil, "error"=>nil, "info"=>nil}, "statusCode"=>"SUCCESS"}

I've attached a screenshot of the GUI in the appstore showing the added B2B customer.

leifktaylor · 2019-07-15T17:00:02Z

@max-ott I hope this review is sufficient.
I hope this gets merged in soon.
This fix unblocks my team.

heartofagoof · 2019-07-15T18:01:50Z

@leifktaylor Thank you for your interest in the PR and thank you for taking time to test the change. : )

@max-ott I think @leifktaylor s steps are all you need to test. One thing that is left untested in his review is whether the change can successfully add a new DEP id and remove an existing one in one go.

You will need to get https://support.apple.com/en-us/HT204142 - apple business maanger ( or school manager ) on your account and then you can get a DEP id.

leifktaylor · 2019-07-17T17:01:31Z

@max-ott @janpio @heartofagoof
Tested ADD and DELETE in the same request. Works great.
I think this is ready for merge.

There is a quality of life issue that you may want to look into, see the comments at the bottom of the post.


# Create app object
[1] pry(#<Spaceship::Playground>)> app = Spaceship::Application.find('REDACTED BUNDLEID')
=> <Spaceship::Tunes::Application 
	apple_id="REDACTED_APPLE_ID", 
	name="REDACTED APPNAME", 
	vendor_id="REDACTED VENDORID", 
	bundle_id="REDACTED BUNDLEID", 
	last_modified=REDACTED,
	issues_count=0, 
	app_icon_preview_url="REDACTED URL", 
	version_sets=[<Spaceship::Tunes::VersionSet 
		type="APP", 
		application=<Spaceship::Tunes::Application 
		#<Object ...>>, 
		platform="ios">]>
		
# Instantiate two b2b organization objects (One to remove, one to add)
[2] pry(#<Spaceship::Playground>)> add_map = {'type' => 'ADD', 'depCustomerId' => 'REDACTED_DEP_ID', 'organizationId' => 'REDACTED_DEP_ID', 'name' => 'Fake Company A'}
=> {"type"=>"ADD", "depCustomerId"=>"REDACTED_DEP_ID", "organizationId"=>"REDACTED_DEP_ID", "name"=>"Fake Company A"}
[3] pry(#<Spaceship::Playground>)> remove_map = {'type' => 'DELETE', 'depCustomerId' => 'REDACTED_DEP_ID', 'organizationId' => 'REDACTED_DEP_ID', 'name' => 'Fake Company B'}
=> {"type"=>"DELETE", "depCustomerId"=>"REDACTED_DEP_ID", "organizationId"=>"REDACTED_DEP_ID", "name"=>"Fake Company B"}
[4] pry(#<Spaceship::Playground>)> add_org = Spaceship::Tunes::B2bOrganization.new('value' => add_map)
=> <Spaceship::Tunes::B2bOrganization 
	type="ADD", 
	dep_customer_id="REDACTED_DEP_ID A", 
	dep_organization_id="REDACTED_DEP_ID A", 
	name="Fake Company A">
[5] pry(#<Spaceship::Playground>)> remove_org = Spaceship::Tunes::B2bOrganization.new('value' =>  remove_map)
=> <Spaceship::Tunes::B2bOrganization 
	type="DELETE", 
	dep_customer_id="REDACTED_DEP_ID B", 
	dep_organization_id="REDACTED_DEP_ID B", 
	name="Fake Company B">

# Get Pricing and Availability object for the app
[6] pry(#<Spaceship::Playground>)> availability = app.availability
=> <Spaceship::Tunes::Availability 
	include_future_territories=true, 
	territories=[<Spaceship::Tunes::Territory 
		code="US", 
		currency_code="USD", 
		name="United States", 
		region="The United States and Canada", 
		region_locale_key="ITC.region.NAM">], 
	cleared_for_preorder=false, 
	app_available_date=nil, 
	b2b_app_enabled=true, 
	educational_discount=false, 
	b2b_unavailable=false, 
	b2b_users=[], 
	b2b_organizations=[<Spaceship::Tunes::B2bOrganization 
		type="NO_CHANGE", 
		dep_customer_id="REDACTED_DEP_ID B", 
		dep_organization_id=REDACTED_DEP_ID, 
		name="Fake Company B">]>

# Clear the current b2b organizations before adding our ADD and DELETE b2b objects to the b2b_organizations list.
# This is to avoid duplicate entries (e.g. an ADD b2b obj, and a NO_CHANGE b2b obj of the same Organization)
# duplicate entries will cause API error, see below.
[7] pry(#<Spaceship::Playground>)> availability.b2b_organizations = []
=> []

# Add the 2 b2b organization objects to the b2b_organizations array
[8] pry(#<Spaceship::Playground>)> availability.update_dep_organizations([add_org, remove_org])
=> <Spaceship::Tunes::Availability 
	include_future_territories=true, 
	territories=[<Spaceship::Tunes::Territory 
		code="US", 
		currency_code="USD", 
		name="United States", 
		region="The United States and Canada", 
		region_locale_key="ITC.region.NAM">], 
	cleared_for_preorder=false, 
	app_available_date=nil, 
	b2b_app_enabled=true, 
	educational_discount=false, 
	b2b_unavailable=false, 
	b2b_users=[], 
	b2b_organizations=[<Spaceship::Tunes::B2bOrganization 
		type="ADD", 
		dep_customer_id="REDACTED_DEP_ID A", 
		dep_organization_id="REDACTED_DEP_ID A", 
		name="Fake Company A">, <Spaceship::Tunes::B2bOrganization 
		type="DELETE", 
		dep_customer_id="REDACTED_DEP_ID B", 
		dep_organization_id="REDACTED_DEP_ID B", 
		name="Fake Company B">]>

# Update availability command goes through and works
[9] pry(#<Spaceship::Playground>)> app.update_availability!(availability)
=> <Spaceship::Tunes::Availability 
	include_future_territories=true, 
	territories=[<Spaceship::Tunes::Territory 
		code="US", 
		currency_code="USD", 
		name="United States", 
		region="The United States and Canada", 
		region_locale_key="ITC.region.NAM">], 
	cleared_for_preorder=false, 
	app_available_date=nil, 
	b2b_app_enabled=true, 
	educational_discount=false, 
	b2b_unavailable=false, 
	b2b_users=[], 
	b2b_organizations=[<Spaceship::Tunes::B2bOrganization 
		type="NO_CHANGE", 
		dep_customer_id="REDACTED_DEP_ID A", 
		dep_organization_id=REDACTED_DEP_ID A, 
		name="Fake Company A">]>
[10] pry(#<Spaceship::Playground>)>

Possible Quality of life improvement for next PR

Note: Regarding above comment about duplicate entries (e.g. an ADD b2b obj and a NO_CHANGE b2b obj of the same organization):

The new availability.update_dep_organizations method will not automatically remove NO_CHANGE entry of ORGANIZATION_A if you are adding a DELETE entry for ORGANIZATION_A.

E.g. , if we have an Availability.b2b_organizations array like this:

	b2b_organizations=[<Spaceship::Tunes::B2bOrganization 
		type="NO_CHANGE", 
		dep_customer_id="REDACTED", 
		dep_organization_id=REDACTED, 
		name="COMPANY A">]>

And then we pass in this object with availability.update_dep_organizations:

<Spaceship::Tunes::B2bOrganization 
		type="DELETE", 
		dep_customer_id="REDACTED", 
		dep_organization_id="REDACTED", 
		name="COMPANY A">]

Our availability.b2b_organizations object will now look like this, and will be rejected by the Appstore API if we attempt to call app.update_availability!

	b2b_organizations=[<Spaceship::Tunes::B2bOrganization 
		type="DELETE", 
		dep_customer_id="REDACTED", 
		dep_organization_id="REDACTED", 
		name="COMPANY A">, <Spaceship::Tunes::B2bOrganization 
		type=false, 
		dep_customer_id="REDACTED", 
		dep_organization_id=REDACTED, 
		name="COMPANY A">]>

Calling app.update_availability with this b2b_organizations array will result in an API Error from Apple.

[31] pry(#<Spaceship::Playground>)> app.update_availability!(availability)
Spaceship::Tunes::Error: invalid_request

EvilTony · 2019-07-23T14:14:43Z

Is there any chance we can get this reviewed and merged soon @max-ott ?

It is clean enough to work with and I also need this to help speed up my CI/CD pipeline and remove manual actions.

max-ott · 2019-07-23T20:18:09Z

I don't have write access, so my review does not really count here. With all the changes going on with regards to TestFlight etc. more niche things might take more time. Sorry about that 🙏

leifktaylor · 2019-08-12T19:51:28Z

@joshdholtz
Are there any further actions I can take to expedite this PR?

joshdholtz

Thanks again for adding all of the b2b logic! ❤️ This is 🔥

fastlane-bot · 2019-08-30T19:32:13Z

Congratulations! 🎉 This was released as part of fastlane 2.130.0 🚀

Adding support for DEP_ID

cdb699c

googlebot added the cla: yes label Jun 3, 2019

fastlane-bot added the status: needs-attention label Jun 17, 2019

janpio changed the title ~~Adding support for DEP_ID~~ [spaceship] Adding support for DEP_ID Jun 19, 2019

janpio added the tool: spaceship label Jun 19, 2019

leifktaylor approved these changes Jul 12, 2019

View reviewed changes

EvilTony approved these changes Jul 23, 2019

View reviewed changes

joshdholtz approved these changes Aug 30, 2019

View reviewed changes

joshdholtz merged commit 62fb4c5 into fastlane:master Aug 30, 2019

joshdholtz mentioned this pull request Aug 30, 2019

Version bump to 2.130.0 #15248

Merged

fastlane-bot added status: released and removed status: needs-attention labels Aug 30, 2019

fastlane locked and limited conversation to collaborators Oct 29, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[spaceship] Adding support for DEP_ID #14852

[spaceship] Adding support for DEP_ID #14852

heartofagoof commented Jun 3, 2019

max-ott commented Jul 5, 2019

leifktaylor left a comment

leifktaylor commented Jul 15, 2019

heartofagoof commented Jul 15, 2019

leifktaylor commented Jul 17, 2019 •

edited

EvilTony commented Jul 23, 2019

max-ott commented Jul 23, 2019

leifktaylor commented Aug 12, 2019

joshdholtz left a comment

fastlane-bot commented Aug 30, 2019

[spaceship] Adding support for DEP_ID #14852

[spaceship] Adding support for DEP_ID #14852

Conversation

heartofagoof commented Jun 3, 2019

Checklist

Motivation and Context

Description

max-ott commented Jul 5, 2019

leifktaylor left a comment

Choose a reason for hiding this comment

leifktaylor commented Jul 15, 2019

heartofagoof commented Jul 15, 2019

leifktaylor commented Jul 17, 2019 • edited

Possible Quality of life improvement for next PR

EvilTony commented Jul 23, 2019

max-ott commented Jul 23, 2019

leifktaylor commented Aug 12, 2019

joshdholtz left a comment

Choose a reason for hiding this comment

fastlane-bot commented Aug 30, 2019

leifktaylor commented Jul 17, 2019 •

edited