Move Generated Client to separate module

.buildkite/commands/validate-pods.sh

@@ -5,3 +5,6 @@ validate_podspec --allow-warnings Gravatar.podspec
 
 echo "--- :cocoapods: Validate GravatarUI.podspec"
 validate_podspec --allow-warnings GravatarUI.podspec
+
+echo "--- :cocoapods: Validate GravatarOpenAPIClient.podspec"
+validate_podspec --allow-warnings GravatarOpenAPIClient.podspec

.buildkite/pipeline.yml

@@ -44,6 +44,7 @@ steps:
     command: |
       .buildkite/commands/publish-pod.sh "Gravatar.podspec"
       .buildkite/commands/publish-pod.sh "GravatarUI.podspec"
+      .buildkite/commands/publish-pod.sh "GravatarOpenAPIClient.podspec"
     plugins: [$CI_TOOLKIT]
     depends_on:
       - "test"

.gitignore

@@ -45,9 +45,18 @@ fastlane/README.md
 fastlane/report.xml
 fastlane/test_output
 
+# OpenAPI
+openapi/GravatarOpenAPIClient/
+!openapi/GravatarOpenAPIClient/.openapi-generator/
+!openapi/GravatarOpenAPIClient/.openapi-generator-ignore
+!openapi/GravatarOpenAPIClient/docs/
+!openapi/GravatarOpenAPIClient/GravatarOpenAPIClient.podspec
+!openapi/GravatarOpenAPIClient/Package.swift
+!openapi/GravatarOpenAPIClient/project.yml
+!openapi/GravatarOpenAPIClient/README.md
+
 # SwiftGen (part of wpmreleasetoolkit)
 vendor/swiftgen
 
 # Other
-openapi-generator/
 Demo/Demo/Secrets.swift

Demo/Gravatar-Demo.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved

@@ -1,5 +1,5 @@
 {
-  "originHash" : "89aad130e119d7a4b1dea1ad42b23e52b29cf016999eed5d14af43b0dc276ac1",
+  "originHash" : "bf24fbca0585c9e7707869442e833d48e8fbe49f5e904fe58370244d9f54521e",
   "pins" : [
     {
       "identity" : "swift-snapshot-testing",

Gravatar.podspec

@@ -18,10 +18,11 @@ Pod::Spec.new do |s|
 
   s.swift_versions    = Gravatar::SWIFT_VERSIONS
 
-  ios_deployment_target = '15.0'
+  ios_deployment_target = Gravatar::IOS_DEPLOYMENT_TARGET
 
   s.ios.deployment_target = ios_deployment_target
 
+  s.dependency 'GravatarOpenAPIClient', s.version.to_s
   s.source_files = 'Sources/Gravatar/**/*.swift'
   s.resource_bundles = {
     'Gravatar' => ['Sources/Gravatar/Resources/*.plist']

GravatarOpenAPIClient.podspec

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative 'version'
+
+Pod::Spec.new do |s|
+  s.name             = 'GravatarOpenAPIClient'
+  s.summary          = 'A Gravatar OpenAPI Client'
+  s.version          = Gravatar::VERSION
+
+  s.swift_versions    = Gravatar::SWIFT_VERSIONS
+
+  # Match the deployment target of Gravatar in order to satisfy `pod lib lint`
+  s.ios.deployment_target = Gravatar::IOS_DEPLOYMENT_TARGET
+
+  s.homepage = 'https://gravatar.com'
+  s.license = { type: 'Mozilla Public License v2', file: 'LICENSE.md' }
+  s.authors = 'Automattic, Inc.'
+  s.source = { :git => 'https://github.com/Automattic/Gravatar-SDK-iOS.git', :tag => s.version.to_s }
+
+  s.documentation_url = 'https://automattic.github.io/Gravatar-SDK-iOS/gravatar'
+
+  s.source_files = 'Sources/GravatarOpenAPIClient/**/*.swift'
+end

GravatarUI.podspec

@@ -18,7 +18,7 @@ Pod::Spec.new do |s|
 
   s.swift_versions    = Gravatar::SWIFT_VERSIONS
 
-  ios_deployment_target = '15.0'
+  ios_deployment_target = Gravatar::IOS_DEPLOYMENT_TARGET
   s.ios.deployment_target = ios_deployment_target
 
   s.source_files = 'Sources/GravatarUI/**/*.swift'

Makefile

@@ -12,9 +12,15 @@ SWIFTFORMAT_CACHE = ~/Library/Caches/com.charcoaldesign.swiftformat
 OPENAPI_GENERATOR_GIT_URL ?= https://github.com/openapitools/openapi-generator
 OPENAPI_GENERATOR_GIT_TAG ?= v7.5.0
 OPENAPI_GENERATOR_CLONE_DIR ?= $(CURRENT_MAKEFILE_DIR)/openapi-generator
+
+OPENAPI_PROJECT_NAME ?= GravatarOpenAPIClient
+OPENAPI_DIR ?= $(CURRENT_MAKEFILE_DIR)/$(OPENAPI_REL_DIR)
+OPENAPI_REL_DIR ?= openapi
+OPENAPI_GENERATED_DIR ?= $(CURRENT_MAKEFILE_DIR)/openapi/$(OPENAPI_PROJECT_NAME)
+OPENAPI_CLIENT_PROPERTIES ?= projectName=$(OPENAPI_PROJECT_NAME),useSPMFileStructure=true
+
 OPENAPI_YAML_PATH ?= $(CURRENT_MAKEFILE_DIR)/openapi/spec.yaml
 MODEL_TEMPLATE_PATH ?= $(CURRENT_MAKEFILE_DIR)/openapi
-OUTPUT_DIRECTORY ?= $(CURRENT_MAKEFILE_DIR)/Sources/Gravatar/OpenApi/Generated
 
 # Derived values (don't change these).
 CURRENT_MAKEFILE_PATH := $(abspath $(lastword $(MAKEFILE_LIST)))
@@ -94,7 +100,7 @@ validate-pod: bundle-install
 	xcrun simctl list >> /dev/null
 	bundle exec pod lib lint \
 		--include-podspecs="*.podspec" \
-		--verbose --fail-fast
+		--verbose --fail-fast --allow-warnings
 
 update-example-snapshots:
 	for filePath in ./Sources/GravatarUI/GravatarUI.docc/Resources/ProfileExamples/*; \
@@ -104,24 +110,19 @@ update-example-snapshots:
 	cd ./Sources/GravatarUI/GravatarUI.docc/Resources/ProfileExamples && \
 	for filePath in *; do name=$${filePath%.*}; mv $$filePath $${name//-dark/~dark}@2x$${filePath#$$name}; done
 
-install-and-generate: $(OPENAPI_GENERATOR_CLONE_DIR) # Clones and setup the openapi-generator.
-	"$(OPENAPI_GENERATOR_CLONE_DIR)"/run-in-docker.sh mvn package
-	make generate
-
-generate: $(OUTPUT_DIRECTORY) # Generates the open-api model
-	cp "$(OPENAPI_YAML_PATH)" "$(OPENAPI_GENERATOR_CLONE_DIR)"/openapi.yaml
-	mkdir -p "$(OPENAPI_GENERATOR_CLONE_DIR)"/templates
-	cp "$(MODEL_TEMPLATE_PATH)"/*.mustache "$(OPENAPI_GENERATOR_CLONE_DIR)"/templates/
-	rm -rf "$(OPENAPI_GENERATOR_CLONE_DIR)"/generated/OpenAPIClient/Classes/OpenAPIs/Models/*
-	"$(OPENAPI_GENERATOR_CLONE_DIR)"/run-in-docker.sh generate -i openapi.yaml \
-    --global-property models \
-    -t templates \
-    -g swift5 \
-    -o ./generated \
-    -p packageName=Gravatar \
-	--additional-properties=useJsonEncodable=false,readonlyProperties=true && \
-    rsync -av --delete "$(OPENAPI_GENERATOR_CLONE_DIR)"/generated/OpenAPIClient/Classes/OpenAPIs/Models/ "$(OUTPUT_DIRECTORY)/" && \
-    make swiftformat && \
+generate: $(OPENAPI_GENERATED_DIR) # Generates the open-api model
+	rm -rf "$(OPENAPI_GENERATED_DIR)"/* && \
+	docker run --rm \
+	-v $(OPENAPI_DIR):/local openapitools/openapi-generator-cli:"$(OPENAPI_GENERATOR_GIT_TAG)" generate \
+	-i /local/openapi.yaml \
+	-o /local/GravatarOpenAPIClient \
+	-t /local/templates \
+	-g swift5 \
+	-p packageName=Gravatar \
+	--additional-properties=useJsonEncodable=false,readonlyProperties=true,$(OPENAPI_CLIENT_PROPERTIES) && \
+	rsync -av --delete "$(OPENAPI_GENERATED_DIR)/Sources/$(OPENAPI_PROJECT_NAME)/" "$(CURRENT_MAKEFILE_DIR)/Sources/$(OPENAPI_PROJECT_NAME)/" && \
+	cp -fp "$(OPENAPI_GENERATED_DIR)/$(OPENAPI_PROJECT_NAME).podspec" "$(CURRENT_MAKEFILE_DIR)/" && \
+	make swiftformat && \
     echo "DONE! 🎉"
 
 generate-strings: bundle-install
@@ -131,22 +132,22 @@ download-strings: bundle-install
 	bundle exec fastlane download_localized_strings
 
 clean-generated:  # Delete the output directory used for generated sources.
-	@echo 'Delete entire directory: $(OUTPUT_DIRECTORY)? [y/N] ' && read ans && [ $${ans:-N} = y ] || (echo "Aborted"; exit 1)
-	rm -rf "$(OUTPUT_DIRECTORY)"
+	@echo 'Delete entire directory: $(OPENAPI_GENERATED_DIR)? [y/N] ' && read ans && [ $${ans:-N} = y ] || (echo "Aborted"; exit 1)
+	rm -rf "$(OPENAPI_GENERATED_DIR)"
 
-clean:  # Clean everything, including the checkout of swift-openapi-generator.
+clean:  # Clean everything
 	@echo 'Delete checkout of openapi-generator $(OPENAPI_GENERATOR_CLONE_DIR)? [y/N] ' && read ans && [ $${ans:-N} = y ] || (echo "Aborted"; exit 1)
-	rm -rf "$(OPENAPI_GENERATOR_CLONE_DIR)"
+	rm -rf "$(OPENAPI_GENERATOR_CLONE_DIR)/*"
 
 
 dump:  # Dump all derived values used by the Makefile.
 	@echo "CURRENT_MAKEFILE_PATH = $(CURRENT_MAKEFILE_PATH)"
 	@echo "CURRENT_MAKEFILE_DIR = $(CURRENT_MAKEFILE_DIR)"
+	@echo "OPENAPI_GENERATED_DIR = $(OPENAPI_GENERATED_DIR)"
 	@echo "OPENAPI_GENERATOR_GIT_URL = $(OPENAPI_GENERATOR_GIT_URL)"
 	@echo "OPENAPI_GENERATOR_GIT_TAG = $(OPENAPI_GENERATOR_GIT_TAG)"
 	@echo "OPENAPI_GENERATOR_CLONE_DIR = $(OPENAPI_GENERATOR_CLONE_DIR)"
 	@echo "OPENAPI_YAML_PATH = $(OPENAPI_YAML_PATH)"
-	@echo "OUTPUT_DIRECTORY = $(OUTPUT_DIRECTORY)"
 
 $(OPENAPI_GENERATOR_CLONE_DIR):
 	git \
@@ -157,5 +158,5 @@ $(OPENAPI_GENERATOR_CLONE_DIR):
 		"$(OPENAPI_GENERATOR_GIT_URL)" \
 		$@
 
-$(OUTPUT_DIRECTORY):
+$(OPENAPI_GENERATED_DIR):
 	mkdir -p "$@"

Package.resolved

@@ -1,5 +1,5 @@
 {
-  "originHash" : "2d82ed06a27431c1da79790f8b215b8abf6d2a7397f42f02e364c7a92f86a5ab",
+  "originHash" : "ce90f93a035f7d411d81060dce4cdc6d5bcbe81fce7d7260084532fa492ff797",
   "pins" : [
     {
       "identity" : "swift-snapshot-testing",

Package.swift

@@ -25,13 +25,14 @@ let package = Package(
     dependencies: [
         .package(url: "https://github.com/nicklockwood/SwiftFormat", from: "0.54.0"),
         .package(url: "https://github.com/pointfreeco/swift-snapshot-testing", from: "1.8.1"),
-        .package(url: "https://github.com/SimplyDanny/SwiftLintPlugins", exact: "0.56.2"),
+        .package(url: "https://github.com/SimplyDanny/SwiftLintPlugins", exact: "0.56.2")
     ],
     targets: [
         // Targets are the basic building blocks of a package, defining a module or a test suite.
         // Targets can depend on other targets in this package and products from dependencies.
         .target(
             name: "Gravatar",
+            dependencies: ["GravatarOpenAPIClient"],
             resources: [.process("Resources")],
             swiftSettings: [
                 .enableExperimentalFeature("StrictConcurrency")
@@ -72,6 +73,12 @@ let package = Package(
             swiftSettings: [
                 .enableExperimentalFeature("StrictConcurrency")
             ]
+        ),
+        .target(
+            name: "GravatarOpenAPIClient",
+            swiftSettings: [
+                .enableExperimentalFeature("StrictConcurrency")
+            ]
         )
     ]
 )

Sources/Gravatar/OpenAPIExports.swift

@@ -0,0 +1,23 @@
+import GravatarOpenAPIClient
+
+// MARK: OpenAPI Models: Public
+
+public typealias CryptoWalletAddress = GravatarOpenAPIClient.CryptoWalletAddress
+public typealias GalleryImage = GravatarOpenAPIClient.GalleryImage
+public typealias Interest = GravatarOpenAPIClient.Interest
+public typealias Language = GravatarOpenAPIClient.Language
+public typealias Link = GravatarOpenAPIClient.Link
+public typealias Profile = GravatarOpenAPIClient.Profile
+public typealias ProfileContactInfo = GravatarOpenAPIClient.ProfileContactInfo
+public typealias ProfilePayments = GravatarOpenAPIClient.ProfilePayments
+public typealias VerifiedAccount = GravatarOpenAPIClient.VerifiedAccount
+
+// MARK: - OpenAPI Models: Package
+
+package typealias Avatar = GravatarOpenAPIClient.Avatar
+
+// MARK: - OpenAPI Models: Internal
+
+typealias AssociatedResponse = GravatarOpenAPIClient.AssociatedResponse
+typealias ModelError = GravatarOpenAPIClient.ModelError
+typealias SetEmailAvatarRequest = GravatarOpenAPIClient.SetEmailAvatarRequest

Sources/Gravatar/OpenApi/Generated/AssociatedResponse.swift → Sources/GravatarOpenAPIClient/Models/AssociatedResponse.swift

@@ -1,8 +1,8 @@
 import Foundation
 
-struct AssociatedResponse: Codable, Hashable, Sendable {
+public struct AssociatedResponse: Codable, Hashable, Sendable {
     /// Whether the entity is associated with the account.
-    private(set) var associated: Bool
+    public private(set) var associated: Bool
 
     init(associated: Bool) {
         self.associated = associated
@@ -14,7 +14,7 @@ struct AssociatedResponse: Codable, Hashable, Sendable {
 
     // Encodable protocol methods
 
-    func encode(to encoder: Encoder) throws {
+    public func encode(to encoder: Encoder) throws {
         var container = encoder.container(keyedBy: CodingKeys.self)
         try container.encode(associated, forKey: .associated)
     }

Sources/Gravatar/OpenApi/Generated/Avatar.swift → Sources/GravatarOpenAPIClient/Models/Avatar.swift

@@ -2,28 +2,28 @@ import Foundation
 
 /// An avatar that the user has already uploaded to their Gravatar account.
 ///
-package struct Avatar: Codable, Hashable, Sendable {
-    package enum Rating: String, Codable, CaseIterable, Sendable {
+public struct Avatar: Codable, Hashable, Sendable {
+    public enum Rating: String, Codable, CaseIterable, Sendable {
         case g = "G"
         case pg = "PG"
         case r = "R"
         case x = "X"
     }
 
     /// Unique identifier for the image.
-    package private(set) var imageId: String
+    public private(set) var imageId: String
     /// Image URL
-    package private(set) var imageUrl: String
+    public private(set) var imageUrl: String
     /// Rating associated with the image.
-    package private(set) var rating: Rating
+    public private(set) var rating: Rating
     /// Date and time when the image was last updated.
-    package private(set) var updatedDate: Date
+    public private(set) var updatedDate: Date
     /// Alternative text description of the image.
-    package private(set) var altText: String
+    public private(set) var altText: String
     /// Whether the image is currently selected as the provided selected email's avatar.
-    package private(set) var selected: Bool?
+    public private(set) var selected: Bool?
 
-    package init(imageId: String, imageUrl: String, rating: Rating, updatedDate: Date, altText: String, selected: Bool? = nil) {
+    init(imageId: String, imageUrl: String, rating: Rating, updatedDate: Date, altText: String, selected: Bool? = nil) {
         self.imageId = imageId
         self.imageUrl = imageUrl
         self.rating = rating
@@ -43,7 +43,7 @@ package struct Avatar: Codable, Hashable, Sendable {
 
     // Encodable protocol methods
 
-    package func encode(to encoder: Encoder) throws {
+    public func encode(to encoder: Encoder) throws {
         var container = encoder.container(keyedBy: CodingKeys.self)
         try container.encode(imageId, forKey: .imageId)
         try container.encode(imageUrl, forKey: .imageUrl)

Sources/Gravatar/OpenApi/Generated/ModelError.swift → Sources/GravatarOpenAPIClient/Models/ModelError.swift

@@ -2,11 +2,11 @@ import Foundation
 
 /// An error response from the API.
 ///
-struct ModelError: Codable, Hashable, Sendable {
+public struct ModelError: Codable, Hashable, Sendable {
     /// The error message
-    private(set) var error: String
+    public private(set) var error: String
     /// The error code for the error message
-    private(set) var code: String?
+    public private(set) var code: String?
 
     init(error: String, code: String? = nil) {
         self.error = error
@@ -20,7 +20,7 @@ struct ModelError: Codable, Hashable, Sendable {
 
     // Encodable protocol methods
 
-    func encode(to encoder: Encoder) throws {
+    public func encode(to encoder: Encoder) throws {
         var container = encoder.container(keyedBy: CodingKeys.self)
         try container.encode(error, forKey: .error)
         try container.encodeIfPresent(code, forKey: .code)

Sources/Gravatar/OpenApi/Generated/SetEmailAvatarRequest.swift → Sources/GravatarOpenAPIClient/Models/SetEmailAvatarRequest.swift

@@ -1,8 +1,8 @@
 import Foundation
 
-struct SetEmailAvatarRequest: Codable, Hashable, Sendable {
+public struct SetEmailAvatarRequest: Codable, Hashable, Sendable {
     /// The email SHA256 hash to set the avatar for.
-    private(set) var emailHash: String
+    public private(set) var emailHash: String
 
     init(emailHash: String) {
         self.emailHash = emailHash
@@ -14,7 +14,7 @@ struct SetEmailAvatarRequest: Codable, Hashable, Sendable {
 
     // Encodable protocol methods
 
-    func encode(to encoder: Encoder) throws {
+    public func encode(to encoder: Encoder) throws {
         var container = encoder.container(keyedBy: CodingKeys.self)
         try container.encode(emailHash, forKey: .emailHash)
     }

openapi/GravatarOpenAPIClient/.openapi-generator-ignore

@@ -0,0 +1,30 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md
+
+.gitignore
+.swiftformat
+Cartfile
+git_push.sh
+Sources/GravatarOpenAPIClient/
+!Sources/GravatarOpenAPIClient/Models/