Add support for Bundle IDs and Capabilities endpoints #57

BalestraPatrick · 2019-12-29T12:44:25Z

This PR implements all the Bundle ID Capabilities and Bundle IDs endpoints.

Sorry for the big PR, but a lot of models are shared between the two web services. I have the Profiles and Devices endpoints ready too, but I was able to split those into a different future PR to make it easier to review.

Feedback is welcome on the API design and everything. I did some smoke tests for all the endpoints and they work just fine.

ghost · 2019-12-29T14:28:58Z

Sources/Models/BundleId.swift

+public struct BundleId: Codable {
+
+    /// The resource's attributes.
+    public let attributes: BundleId.Attributes?


⚠️ An ‘instance_property’ should not be placed amongst the type content(s) ‘subtype’.
type_contents_order BundleId.swift:14

ghost · 2019-12-29T14:28:59Z

Sources/Models/BundleId.swift

+    public let attributes: BundleId.Attributes?
+
+    /// The opaque resource ID that uniquely identifies the resource.
+    public let `id`: String


⚠️ An ‘instance_property’ should not be placed amongst the type content(s) ‘subtype’.
type_contents_order BundleId.swift:17

ghost · 2019-12-29T14:29:00Z

Sources/Models/BundleId.swift

+    public let `id`: String
+
+    /// Navigational links to related data and included resource types and IDs.
+    public let relationships: BundleId.Relationships?


⚠️ An ‘instance_property’ should not be placed amongst the type content(s) ‘subtype’.
type_contents_order BundleId.swift:20

ghost · 2019-12-29T14:29:01Z

Sources/Models/BundleId.swift

+    public let relationships: BundleId.Relationships?
+
+    /// The resource type.Value: bundleIds
+    public let type: String = "bundleIds"


⚠️ An ‘instance_property’ should not be placed amongst the type content(s) ‘subtype’.
type_contents_order BundleId.swift:23

ghost · 2019-12-29T14:29:02Z

Sources/Models/BundleId.swift

+    public let type: String = "bundleIds"
+
+    /// Navigational links that include the self-link.
+    public let links: ResourceLinks<BundleIdResponse>


⚠️ An ‘instance_property’ should not be placed amongst the type content(s) ‘subtype’.
type_contents_order BundleId.swift:26

ghost · 2019-12-29T14:29:32Z

	1 Warning
⚠️	Big PR

	1 Message
📖	View more details on Bitrise

Generated by 🚫 Danger

Sources/Endpoints/Provisioning/Bundle ID Capabilities/DisableCapability.swift

Sources/Models/BundleId.swift

ruipfcosta · 2019-12-29T20:54:36Z

Sources/Models/BundleIdCapabilitiesResponse.swift

+import Foundation
+
+/// A response containing a list of related resource IDs.
+public struct BundleIdCapabilitiesResponse: Codable {


Conforming to Decodable only should suffice here, can this be adjusted? The same should apply to the other response types and most of the nested types.

Every other model conforms to Codable. Searching for types conforming to Codable results in 418 results, searching for Decodable yields only 15 results (mostly related to this PR actually). Should we for consistency keep everything conform to Codable? I change change all instances in this PR to conform to Codable instead of just Decodable like the rest of the codebase.

Thanks for looking into this @BalestraPatrick! I'm happy to stick to the conventions already in use in the project.

ruipfcosta · 2019-12-29T20:56:39Z

Sources/Models/BundleIdCapabilityCreateRequest.swift

+import Foundation
+
+/// A request containing a single resource.
+public struct BundleIdCapabilityCreateRequest: Codable {


Similarly, if should be enough conforming to Encodable here (and other request types), as well as most nested types.

Sources/Endpoints/Provisioning/Bundle IDs/RegisterNewBundleID.swift

Sources/Models/BundleIdResponse.swift

Sources/Models/CapabilityOption.swift

AvdLee · 2019-12-30T13:38:13Z

If you don't get the same warnings locally as here in CI, you might want to update the WeTransfer-iOS-CI submodule. This makes sure that SwiftLint is run locally as well and triggers the same warnings locally. I'll see if I can make this process easier to understand.

BalestraPatrick · 2020-01-03T16:40:32Z

@ruipfcosta @AvdLee This is ready for another round of review whenever you have time 👍

Sources/Models/BundleIdCapabilityResponse.swift

AvdLee

Amazing job, Patrick! Great job on keeping the code consistent with the rest of the project. I've got a small suggestion and I'm interested to hear your thoughts on it!

AvdLee · 2020-01-06T08:33:10Z

Changelog.md

+- Add support for all [Bundle ID](https://developer.apple.com/documentation/appstoreconnectapi/bundle_ids) endpoints. (@ruipfcosta, @BalestraPatrick)
+- Add support for all [Bundle ID Capabilities](https://developer.apple.com/documentation/appstoreconnectapi/bundle_id_capabilities) endpoints. (@BalestraPatrick)
+- Updated CI to make sure PR requests are reviewed using Danger. (@AvdLee)
+- Removed custom Result type. (@ruipfcosta)


Great work on the details here!

AvdLee · 2020-01-06T08:35:51Z

Sources/Endpoints/Provisioning/Bundle ID Capabilities/EnableCapability.swift

+            path: "bundleIdCapabilities",
+            method: .post,
+            parameters: nil,
+            body: try? JSONEncoder().encode(request))


If encoding here fails, it would fail silently. This might make it harder to debug eventually if it's causing the request to fail as well. What do you think about making the enableCapability method throwing?

I took inspiration from all other methods that don't propagate the failure right now. There are other 36 instances of try? JSONEncoder().encode(request) in the project, so not sure it's worth changing these new methods to a new convention.

Hmm, you're right! Lets keep it like this for now.

SwiftLeeBot · 2020-03-08T12:33:25Z

Congratulations! 🎉 This was released as part of Release 1.0.0 🚀

BalestraPatrick added 2 commits December 29, 2019 13:41

Add Bundle ID Capabilities endpoints

33dd3ab

Add Bundle IDs endpoints

0fc29e0

BalestraPatrick requested a review from ruipfcosta December 29, 2019 12:44

ghost reviewed Dec 29, 2019

View reviewed changes

ruipfcosta requested changes Dec 29, 2019

View reviewed changes

Merge branch 'master' into bundle-ids-and-capabilities-endpoints

487a375

ruipfcosta mentioned this pull request Dec 31, 2019

Implemented endpoints for modifying and removing Bundle IDs #60

Closed

BalestraPatrick added 11 commits January 2, 2020 23:26

Remove useless Foundation imports

d7fb23c

Fix MARK syntax

3a077fb

Fix docs indentation

e301582

Remove useless newline character between properties

8720d13

Fix linting errors

029ea1e

Merge branch 'master' into bundle-ids-and-capabilities-endpoints

e50c609

Fix trailing whitespace linter issue

db09e09

Update changelog

7902b9a

Simplify BundleIdResponse model

8924184

Simplify BundleIdCapabilityResponse model

294f19c

Merge branch 'master' into bundle-ids-and-capabilities-endpoints

c1889f7

ghost reviewed Jan 3, 2020

View reviewed changes

Sources/Models/BundleIdCapabilityResponse.swift Outdated Show resolved Hide resolved

BalestraPatrick added 2 commits January 3, 2020 20:13

Remove unneeded space

306f405

Merge branch 'master' into bundle-ids-and-capabilities-endpoints

eff427f

AvdLee requested changes Jan 6, 2020

View reviewed changes

ruipfcosta approved these changes Jan 6, 2020

View reviewed changes

AvdLee approved these changes Jan 6, 2020

View reviewed changes

AvdLee merged commit f2a3a29 into AvdLee:master Jan 6, 2020

BalestraPatrick deleted the bundle-ids-and-capabilities-endpoints branch January 6, 2020 15:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for Bundle IDs and Capabilities endpoints #57

Add support for Bundle IDs and Capabilities endpoints #57

BalestraPatrick commented Dec 29, 2019

ghost Dec 29, 2019 •

edited by ghost

Loading

ghost Dec 29, 2019 •

edited by ghost

Loading

ghost Dec 29, 2019 •

edited by ghost

Loading

ghost Dec 29, 2019 •

edited by ghost

Loading

ghost Dec 29, 2019 •

edited by ghost

Loading

ghost commented Dec 29, 2019 •

edited by ghost

Loading

ruipfcosta Dec 29, 2019

BalestraPatrick Jan 3, 2020

ruipfcosta Jan 6, 2020

ruipfcosta Dec 29, 2019

AvdLee commented Dec 30, 2019

BalestraPatrick commented Jan 3, 2020

AvdLee left a comment

AvdLee Jan 6, 2020

AvdLee Jan 6, 2020

BalestraPatrick Jan 6, 2020

AvdLee Jan 6, 2020

SwiftLeeBot commented Mar 8, 2020

Add support for Bundle IDs and Capabilities endpoints #57

Add support for Bundle IDs and Capabilities endpoints #57

Conversation

BalestraPatrick commented Dec 29, 2019

ghost Dec 29, 2019 • edited by ghost Loading

Choose a reason for hiding this comment

ghost Dec 29, 2019 • edited by ghost Loading

Choose a reason for hiding this comment

ghost Dec 29, 2019 • edited by ghost Loading

Choose a reason for hiding this comment

ghost Dec 29, 2019 • edited by ghost Loading

Choose a reason for hiding this comment

ghost Dec 29, 2019 • edited by ghost Loading

Choose a reason for hiding this comment

ghost commented Dec 29, 2019 • edited by ghost Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AvdLee commented Dec 30, 2019

BalestraPatrick commented Jan 3, 2020

AvdLee left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SwiftLeeBot commented Mar 8, 2020

ghost Dec 29, 2019 •

edited by ghost

Loading

ghost Dec 29, 2019 •

edited by ghost

Loading

ghost Dec 29, 2019 •

edited by ghost

Loading

ghost Dec 29, 2019 •

edited by ghost

Loading

ghost Dec 29, 2019 •

edited by ghost

Loading

ghost commented Dec 29, 2019 •

edited by ghost

Loading