Overhauled the library with several new features (#5)
## Summary Updates the library to v4.5.1 of the App Store Connect API, and ships it as a breaking 2.0.0 release with pagination, API key authentication, rate limiting, and a lighter install for consumers. ## Breaking changes - **Minimum platforms:** iOS 14, macOS 11, tvOS 14, watchOS 7, and visionOS 1. - **Toolchain:** Swift 6.0+ (Xcode 16+). The package builds in the Swift 6 language mode. - **Runtime:** requires `swift-openapi-runtime` 1.11.0 or later. ## Changes - **API:** updated the OpenAPI specification to v4.5.1, covering 1,303 operations and 1,473 schemas. - **Pagination:** the spec patch adds the undocumented `cursor` query parameter to the 465 paged operations. `PagedDocumentLinks.nextCursor` reads the cursor from a page, and `PagedSequence` iterates every page. - **Authentication:** `APIKeyTokenProvider` signs ES256 tokens from an API key and reuses each one until a minute before it expires. `BearerAuthMiddleware` now accepts a token provider. - **Rate limiting:** `RateLimitMiddleware` retries `429` responses, waiting for `Retry-After` or backing off exponentially. - **Generated code:** committed to `Sources/ASConnectService/Sources/Public/Generated` instead of generated by a build plugin. Consumers now resolve 4 packages instead of 12, and Xcode no longer asks to trust a plugin. - **Tooling:** - `make oas-download` now downloads, patches, generates, and checks the docs in one go. - New `make oas-generate`, `make oas-validate`, and `make doc-check` targets. - The generator is pinned in `Tools/`, and the DocC plugin is only resolved by the documentation targets. - **Documentation:** the DocC catalog now lists every operation and schema in the spec, and the catalog and README are rewritten for the new APIs. - **Housekeeping:** Apache 2.0 license headers on every Swift file, including `Package.swift` and the tests. Reviewed-on: #5 Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
This commit was merged in pull request #5.
This commit is contained in:
1 parent
3aaf5cd7a5
commit
0431fb5133
27 files changed
+1046471
-284
No files matched your search
@@ -0,0 +1,151 @@
|
||||
// ===----------------------------------------------------------------------===
|
||||
//
|
||||
// This source file is part of the ASConnectService open source project
|
||||
//
|
||||
// Copyright (c) 2026 Röck+Cöde VoF. and the ASConnectService project authors
|
||||
// Licensed under Apache license v2.0
|
||||
//
|
||||
// See LICENSE for license information
|
||||
// See CONTRIBUTORS for the list of ASConnectService project authors
|
||||
//
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
//
|
||||
// ===----------------------------------------------------------------------===
|
||||
|
||||
#if canImport(CryptoKit)
|
||||
import CryptoKit
|
||||
import Foundation
|
||||
import Testing
|
||||
|
||||
// A non-testable import ensures that the provider can be created from outside the module.
|
||||
import ASConnectService
|
||||
|
||||
@Suite("APIKeyTokenProvider")
|
||||
struct APIKeyTokenProviderTests {
|
||||
// MARK: Properties
|
||||
|
||||
private let key = P256.Signing.PrivateKey()
|
||||
private let clock = TestClock()
|
||||
|
||||
// MARK: Tests
|
||||
|
||||
@Test("Signs a token for a team key")
|
||||
func signsTeamKeyToken() async throws {
|
||||
let token = try await makeProvider(issuerID: .Sample.issuerID).token()
|
||||
let (header, payload) = try decode(token)
|
||||
|
||||
#expect(header == ["alg": "ES256", "kid": String.Sample.keyID, "typ": "JWT"])
|
||||
#expect(payload["iss"] as? String == .Sample.issuerID)
|
||||
#expect(payload["sub"] == nil)
|
||||
#expect(payload["aud"] as? String == "appstoreconnect-v1")
|
||||
#expect(payload["iat"] as? Int == Int(clock.date.timeIntervalSince1970))
|
||||
#expect(payload["exp"] as? Int == Int(clock.date.timeIntervalSince1970) + 20 * 60)
|
||||
}
|
||||
|
||||
@Test("Signs a token for an individual key")
|
||||
func signsIndividualKeyToken() async throws {
|
||||
let token = try await makeProvider(issuerID: nil).token()
|
||||
let (_, payload) = try decode(token)
|
||||
|
||||
#expect(payload["iss"] == nil)
|
||||
#expect(payload["sub"] as? String == "user")
|
||||
}
|
||||
|
||||
@Test("Signs the token with the private key")
|
||||
func signsWithPrivateKey() async throws {
|
||||
let token = try await makeProvider(issuerID: .Sample.issuerID).token()
|
||||
let parts = token.split(separator: ".").map(String.init)
|
||||
let signature = try P256.Signing.ECDSASignature(rawRepresentation: try #require(Data(base64URL: parts[2])))
|
||||
|
||||
#expect(key.publicKey.isValidSignature(signature, for: Data("\(parts[0]).\(parts[1])".utf8)))
|
||||
}
|
||||
|
||||
@Test("Returns the current token until it is about to expire")
|
||||
func returnsCurrentToken() async throws {
|
||||
let provider = try makeProvider(issuerID: .Sample.issuerID)
|
||||
let token = try await provider.token()
|
||||
|
||||
clock.advance(by: 18 * 60)
|
||||
|
||||
#expect(try await provider.token() == token)
|
||||
}
|
||||
|
||||
@Test("Signs a new token when the current one is about to expire")
|
||||
func signsNewToken() async throws {
|
||||
let provider = try makeProvider(issuerID: .Sample.issuerID)
|
||||
let token = try await provider.token()
|
||||
|
||||
clock.advance(by: 19 * 60 + 1)
|
||||
|
||||
#expect(try await provider.token() != token)
|
||||
}
|
||||
|
||||
@Test("Throws when the private key is not valid")
|
||||
func throwsWithInvalidPrivateKey() {
|
||||
#expect(throws: (any Error).self) {
|
||||
try APIKeyTokenProvider(
|
||||
issuerID: .Sample.issuerID,
|
||||
keyID: .Sample.keyID,
|
||||
privateKey: "not-a-private-key"
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// MARK: - Helpers
|
||||
|
||||
private extension APIKeyTokenProviderTests {
|
||||
func makeProvider(issuerID: String?) throws -> APIKeyTokenProvider {
|
||||
try APIKeyTokenProvider(
|
||||
issuerID: issuerID,
|
||||
keyID: .Sample.keyID,
|
||||
privateKey: key.pemRepresentation,
|
||||
now: { [clock] in clock.date }
|
||||
)
|
||||
}
|
||||
|
||||
func decode(_ token: String) throws -> (header: [String: String], payload: [String: Any]) {
|
||||
let parts = token.split(separator: ".").map(String.init)
|
||||
|
||||
try #require(parts.count == 3)
|
||||
|
||||
let header = try JSONDecoder().decode([String: String].self, from: try #require(Data(base64URL: parts[0])))
|
||||
let payloadData = try #require(Data(base64URL: parts[1]))
|
||||
let payload = try #require(try JSONSerialization.jsonObject(with: payloadData) as? [String: Any])
|
||||
|
||||
return (header, payload)
|
||||
}
|
||||
}
|
||||
|
||||
/// A clock whose date only changes when it is advanced.
|
||||
private final class TestClock: @unchecked Sendable {
|
||||
private(set) var date = Date(timeIntervalSince1970: 1_800_000_000)
|
||||
|
||||
func advance(by interval: TimeInterval) {
|
||||
date = date.addingTimeInterval(interval)
|
||||
}
|
||||
}
|
||||
|
||||
// MARK: - Data+Base64URL
|
||||
|
||||
private extension Data {
|
||||
init?(base64URL: String) {
|
||||
var base64 = base64URL
|
||||
.replacingOccurrences(of: "-", with: "+")
|
||||
.replacingOccurrences(of: "_", with: "/")
|
||||
|
||||
base64 += String(repeating: "=", count: (4 - base64.count % 4) % 4)
|
||||
|
||||
self.init(base64Encoded: base64)
|
||||
}
|
||||
}
|
||||
|
||||
// MARK: - String+Samples
|
||||
|
||||
private extension String {
|
||||
enum Sample {
|
||||
static let issuerID: String = "57246542-96fe-1a63-e053-0824d011072a"
|
||||
static let keyID: String = "2X9R4HXF34"
|
||||
}
|
||||
}
|
||||
#endif
|
||||
Reference in new issue
Block a user