Project APIs

[mmertsock]

Overview

• Project API #30
• API to retrieve data collection settings #33

Implements model types, API calls, example app views, and unit tests for project info APIs.

See https://developer.mydatahelps.org/sdk/project_settings.html to compare to JavaScript SDK counterparts.

Security

REMINDER: All file contents are public.

• I have ensured no secure credentials or sensitive information remain in code, metadata, comments, etc. Of particular note:
  • No temporary testing changes committed such as API base URLs, access tokens, print/log statements, etc.
  • Xcode project/target settings should remain generic. Don't leak team identifiers, code signing info, local filesystem paths, etc.
• My changes do not introduce any security risks, or any such risks have been properly mitigated.

Describe briefly what security risks you considered, why they don't apply, or how they've been mitigated.

Checklist

• All public symbols are documented using Swift Markup comments.
• If this feature requires a developer doc update, tag @CareEvolution/api-docs.
• Source code file header comments are clean and standardized. Use "Created by CareEvolution on m/dd/yy".
• Test and update the example app as needed. The example app should demonstrate all features of the SDK, and it's the most convenient way to test your feature.

Consider "Squash and merge" as needed to keep the commit history reasonable on main.

[eschramm]

LGTM - just a question about ProjectType

[eschramm]

Any reason why this would be a struct instead of an enum?

[mmertsock]

For forward compatibility. If this were struct ProjectType: String, and we introduce a new ProjectType value on the server, then the SDK would immediately fail to decode the ProjectInfo for such projects, throwing a decoding error. Using a RawRepresentable struct instead, these new ProjectType values successfully decode, simply as instances with different rawValues.

This pattern is used with most of the enum-like decodable values in the SDK. In practice, the syntax for using these structs (choosing specific values or checking for equality to specific values) looks identical to plain enums, as seen throughout the example app. e.g. you can just check for projectInfo.type == .researchStudy, use the shorthand dot-syntax in switch cases, etc.

See https://github.com/CareEvolution/MyDataHelpsKit-dev/pull/1#discussion_r598414777 for the original discussion about this.

[mmertsock]

Also, your comment has brought attention to the unnecessary documentation comment "May be one of…", which I copied/pasted from the JS SDK. I'll remove that.

[mmertsock]

Updated unit tests to verify/clarify handling of unknown "enum" values.

[eschramm]

Changes LGTM 👍