Generate PrebidMobile Documentation (#1034)

* feat: add jazzy configuration * feat: update settings * feat: update settings * feat: update .circleci/config.yml * feat: update .circleci/config.yml * feat: update .circleci/config.yml * feat: update .circleci/config.yml * feat: update * feat: add doc in comments * feat: update doc * feat: update README.md * feat: add upload-docs.yml * feat: update config * feat: update config * feat: update config * feat: update config * feat: update config * feat: update upload-docs-ios.yml * feat: update upload-docs-ios.yml * feat: update upload-docs-ios.yml * feat: update upload-docs-ios.yml * doc: use specific README * doc: update the Overview page * doc: small change to fix build * doc: small change to fix the build * Revert "doc: small change to fix build" This reverts commit 6606584. * Revert "doc: small change to fix the build" This reverts commit 4b5ced4. * feat: update upload-docs-ios.yml * feat: update upload-docs-ios.yml * doc: update README * doc: update README * fix build * fix: update supported GMA SDK version * fix test * fix tests * tests: clean build before running unit tests * feat: add check for operation with docs_new directory * feat: update workflow to abort if conditions are not met --------- Co-authored-by: Yuriy Velichko <yuriy.velichko@ postindustria.com>
prebid · Oct 3, 2024 · a20b62e · a20b62e
1 parent a0dcb0f
commit a20b62e
Show file tree

Hide file tree

Showing 82 changed files with 1,857 additions and 658 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -41,7 +41,6 @@ jobs:
           name: Run Smoke UI Tests
           command: scripts/testPrebidDemo.sh -ui -l
 
-
 workflows:
   pr-check:
     jobs: 

diff --git a/.github/workflows/upload-docs-ios.yml b/.github/workflows/upload-docs-ios.yml
@@ -0,0 +1,58 @@
+name: Upload Docs iOS
+
+on:
+  push:
+    tags:
+      - '[0-9]+.[0-9]+.[0-9]+'
+      - 'test-doc-*'
+
+jobs:
+  upload-docs:
+
+    runs-on: macos-latest
+
+    steps:
+    - name: Checkout current branch
+      uses: actions/checkout@v4
+    - name: Install Jazzy
+      run: |
+        gem install jazzy
+    - name: Generate docs
+      run: |
+        jazzy
+        cp -r docs docs_new
+    - name: Checkout docs branch
+      uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+        ref: docs
+        clean: false
+    - name: Commit documentation changes
+      run: |
+          MIN_SIZE=5120
+          if [ -d docs_new ] && [ "$(du -s docs_new | cut -f1)" -ge "$MIN_SIZE" ]; then
+            rm -rf docs
+            cp -r docs_new docs
+            rm -rf docs_new
+          else
+            echo "docs_new directory either does not exist or is too small."
+            exit 1
+          fi
+
+          if [ "$(git status --porcelain | wc -l)" -gt 0 ]; then
+            git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
+            git config --local user.name "github-actions[bot]"
+            git status
+            TAG_NAME=${{ github.ref }}
+            TAG_NAME=${TAG_NAME#refs/tags/}
+            echo "Current tag: $TAG_NAME"
+            git add docs
+            git commit -m "Generate docs - $TAG_NAME"
+          else
+            echo "No changes to commit."
+          fi
+    - name: Push changes
+      uses: ad-m/github-push-action@master
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        branch: docs
diff --git a/.jazzy.yaml b/.jazzy.yaml
@@ -0,0 +1,63 @@
+# Ordered by output of `jazzy — help config`
+output: docs
+clean: true
+xcodebuild_arguments:
+- -workspace
+- PrebidMobile.xcworkspace
+- -scheme
+- PrebidMobile
+- CODE_SIGNING_ALLOWED = NO
+author: Prebid
+readme: README_API_DOC.md
+exclude:
+  - PrebidMobile/Addendum/*
+  - PrebidMobile/AdUnits/BannerBasedAdUnitProtocol.swift
+  - PrebidMobile/AdUnits/VideoBasedAdUnitProtocol.swift
+  - PrebidMobile/CacheManagement/*
+  - PrebidMobile/ConfigurationAndTargeting/AgeUtils.swift
+  - PrebidMobile/ConfigurationAndTargeting/ClickbrowserType.swift
+  - PrebidMobile/ConfigurationAndTargeting/PrebidGAMVersionChecker.swift
+  - PrebidMobile/ConfigurationAndTargeting/PrebidSDKInitializer.swift
+  - PrebidMobile/ConfigurationAndTargeting/PrebidServerStatusRequester.swift
+  - PrebidMobile/ConfigurationAndTargeting/UserConsentDataManager.swift
+  - PrebidMobile/Constants.swift
+  - PrebidMobile/Dispatcher.swift
+  - PrebidMobile/ImageHelper.swift
+  - PrebidMobile/JSONConvertible.swift
+  - PrebidMobile/JsonDecodable.swift
+  - PrebidMobile/Logging/*
+  - PrebidMobile/StorageUtils.swift
+  - PrebidMobile/Tracker*
+  - PrebidMobile/UIViewExtension.swift
+  - PrebidMobile/Utils/*
+  - PrebidMobile/PrebidMobileRendering/AdTypes/AdView/AdConfiguration.swift
+  - PrebidMobile/PrebidMobileRendering/AdTypes/AdView/AdViewButtonDecorator.swift
+  - PrebidMobile/PrebidMobileRendering/AdTypes/AdView/HiddenWebViewManager.swift
+  - PrebidMobile/PrebidMobileRendering/Assets/PrebidImagesRepository.swift
+  - PrebidMobile/PrebidMobileRendering/AutoRefreshCountConfig.swift
+  - PrebidMobile/PrebidMobileRendering/Impression*
+  - PrebidMobile/PrebidMobileRendering/Networking*
+  - PrebidMobile/PrebidMobileRendering/Prebid/Integrations/GAM/AdLoading/AdLoadFlowControllerDelegate.swift
+  - PrebidMobile/PrebidMobileRendering/Prebid/Integrations/GAM/AdLoading/BannerAdLoaderDelegate.swift
+  - PrebidMobile/PrebidMobileRendering/Prebid/Integrations/GAM/BannerEventInteractionDelegate.swift
+  - PrebidMobile/PrebidMobileRendering/Prebid/Integrations/GAM/BannerEventLoadingDelegate.swift
+  - PrebidMobile/PrebidMobileRendering/Prebid/Integrations/GAM/InterstitialEventInteractionDelegate.swift
+  - PrebidMobile/PrebidMobileRendering/Prebid/Integrations/GAM/InterstitialEventLoadingDelegate.swift
+  - PrebidMobile/PrebidMobileRendering/Prebid/Integrations/GAM/RewardedEventInteractionDelegate.swift
+  - PrebidMobile/PrebidMobileRendering/Prebid/Integrations/GAM/RewardedEventLoadingDelegate.swift
+  - PrebidMobile/PrebidMobileRendering/Prebid/Integrations/GAM/BaseInterstitialAdUnitProtocol.swift
+  - PrebidMobile/PrebidMobileRendering/Prebid/Integrations/GAM/InterstitialEventHandlerProtocol.swift
+  - PrebidMobile/PrebidMobileRendering/Prebid/Integrations/MediationAPI/MediationUtils.swift
+  - PrebidMobile/PrebidMobileRendering/Prebid/Integrations/MediationAPI/MediationNativeUtils.swift
+  - PrebidMobile/PrebidMobileRendering/Prebid/Integrations/MediationAPI/MediationConstants.swift
+  - PrebidMobile/PrebidMobileRendering/Prebid/Integrations/MediationAPI/MediationBidInfoWrapper.swift
+  - PrebidMobile/PrebidMobileRendering/Prebid/Integrations/PBMStandaloneSDK/DemandResponseInfo.swift
+  - PrebidMobile/PrebidMobileRendering/Prebid/Integrations/PBMStandaloneSDK/EventHandlers/*
+  - PrebidMobile/PrebidMobileRendering/Prebid/PBMCore/*
+  - PrebidMobile/PrebidMobileRendering/Prebid/PBMCacheRenderers/*
+  - PrebidMobile/PrebidMobileRendering/PrebidServerEventTracker.swift
+  - PrebidMobile/PrebidMobileRendering/ServerEvent.swift
+  - PrebidMobile/PrebidMobileRendering/ServerSideConfiguration/*
+  - PrebidMobile/PrebidMobileRendering/Skadn*
+  - PrebidMobile/PrebidMobileRendering/Utilities/*
+theme: apple
diff --git a/EventHandlers/PrebidMobileAdMobAdapters/Sources/PrebidAdMobMediationBaseAdapter.swift b/EventHandlers/PrebidMobileAdMobAdapters/Sources/PrebidAdMobMediationBaseAdapter.swift
@@ -41,7 +41,7 @@ public class PrebidAdMobMediationBaseAdapter: NSObject, GADMediationAdapter {
 
     // Added for tests
     static func latestTestedGMAVersion() -> GADVersionNumber {
-        return GADVersionNumber(majorVersion: 11, minorVersion: 8, patchVersion: 0)
+        return GADVersionNumber(majorVersion: 11, minorVersion: 10, patchVersion: 0)
     }
 
     required public override init() {

diff --git a/EventHandlers/PrebidMobileGAMEventHandlers/Sources/GAMUtils.swift b/EventHandlers/PrebidMobileGAMEventHandlers/Sources/GAMUtils.swift
@@ -59,7 +59,7 @@ public class GAMUtils: NSObject {
 
     // Added for tests
     static func latestTestedGMAVersion() -> GADVersionNumber {
-        return GADVersionNumber(majorVersion: 11, minorVersion: 8, patchVersion: 0)
+        return GADVersionNumber(majorVersion: 11, minorVersion: 10, patchVersion: 0)
     }
 
     // MARK: Private Methods

diff --git a/EventHandlers/PrebidMobileMAXAdapters/Sources/PrebidMAXMediationAdapter.swift b/EventHandlers/PrebidMobileMAXAdapters/Sources/PrebidMAXMediationAdapter.swift
@@ -45,7 +45,6 @@ public class PrebidMAXMediationAdapter: ALMediationAdapter {
         // TODO: Add Prebid SDK initialization logic
 
         completionHandler(.initializedUnknown, nil)
-        Targeting.shared.subjectToCOPPA = ALPrivacySettings.isAgeRestrictedUser()
     }
 
     public override var sdkVersion: String {

diff --git a/...DemoRendering/ViewControllers/Adapters/Prebid/AdMob/PrebidAdMobBannerViewController.swift b/...DemoRendering/ViewControllers/Adapters/Prebid/AdMob/PrebidAdMobBannerViewController.swift
@@ -113,7 +113,7 @@ class PrebidAdMobBannerViewController:
         // imp[].ext.data
         if let adUnitContext = AppConfiguration.shared.adUnitContext {
             for dataPair in adUnitContext {
-                adUnit?.addContextData(dataPair.value, forKey: dataPair.key)
+                adUnit?.addContextData(key: dataPair.value, value: dataPair.key)
             }
         }
 

diff --git a/...ndering/ViewControllers/Adapters/Prebid/AdMob/PrebidAdMobInterstitialViewController.swift b/...ndering/ViewControllers/Adapters/Prebid/AdMob/PrebidAdMobInterstitialViewController.swift
@@ -109,7 +109,7 @@ class PrebidAdMobInterstitialViewController: NSObject, AdaptedController, Prebid
         // imp[].ext.data
         if let adUnitContext = AppConfiguration.shared.adUnitContext {
             for dataPair in adUnitContext {
-                adUnit?.addContextData(dataPair.value, forKey: dataPair.key)
+                adUnit?.addContextData(key: dataPair.value, value: dataPair.key)
             }
         }
 

diff --git a/...DemoRendering/ViewControllers/Adapters/Prebid/AdMob/PrebidAdMobNativeViewController.swift b/...DemoRendering/ViewControllers/Adapters/Prebid/AdMob/PrebidAdMobNativeViewController.swift
@@ -62,7 +62,7 @@ class PrebidAdMobNativeViewController: NSObject, AdaptedController, GADNativeAdL
         // imp[].ext.data
         if let adUnitContext = AppConfiguration.shared.adUnitContext {
             for dataPair in adUnitContext {
-                nativeAdUnit?.addContextData(dataPair.value, forKey: dataPair.key)
+                nativeAdUnit?.addContextData(key: dataPair.value, value: dataPair.key)
             }
         }
 

diff --git a/...moRendering/ViewControllers/Adapters/Prebid/AdMob/PrebidAdMobRewardedViewController.swift b/...moRendering/ViewControllers/Adapters/Prebid/AdMob/PrebidAdMobRewardedViewController.swift
@@ -62,7 +62,7 @@ class PrebidAdMobRewardedViewController: NSObject, AdaptedController, PrebidConf
         // imp[].ext.data
         if let adUnitContext = AppConfiguration.shared.adUnitContext {
             for dataPair in adUnitContext {
-                adUnit?.addContextData(dataPair.value, forKey: dataPair.key)
+                adUnit?.addContextData(key: dataPair.value, value: dataPair.key)
             }
         }
 

diff --git a/...idMobileDemoRendering/ViewControllers/Adapters/Prebid/MAX/PrebidMAXBannerController.swift b/...idMobileDemoRendering/ViewControllers/Adapters/Prebid/MAX/PrebidMAXBannerController.swift
@@ -98,7 +98,7 @@ class PrebidMAXBannerController: NSObject, AdaptedController, PrebidConfigurable
         // imp[].ext.data
         if let adUnitContext = AppConfiguration.shared.adUnitContext {
             for dataPair in adUnitContext {
-                adUnit?.addContextData(dataPair.value, forKey: dataPair.key)
+                adUnit?.addContextData(key: dataPair.value, value: dataPair.key)
             }
         }
 

diff --git a/...leDemoRendering/ViewControllers/Adapters/Prebid/MAX/PrebidMAXInterstitialController.swift b/...leDemoRendering/ViewControllers/Adapters/Prebid/MAX/PrebidMAXInterstitialController.swift
@@ -114,7 +114,7 @@ class PrebidMAXInterstitialController: NSObject, AdaptedController, PrebidConfig
         // imp[].ext.data
         if let adUnitContext = AppConfiguration.shared.adUnitContext {
             for dataPair in adUnitContext {
-                adUnit?.addContextData(dataPair.value, forKey: dataPair.key)
+                adUnit?.addContextData(key: dataPair.value, value: dataPair.key)
             }
         }
 

diff --git a/...idMobileDemoRendering/ViewControllers/Adapters/Prebid/MAX/PrebidMAXNativeController.swift b/...idMobileDemoRendering/ViewControllers/Adapters/Prebid/MAX/PrebidMAXNativeController.swift
@@ -68,7 +68,7 @@ class PrebidMAXNativeController: NSObject, AdaptedController {
         // imp[].ext.data
         if let adUnitContext = AppConfiguration.shared.adUnitContext {
             for dataPair in adUnitContext {
-                nativeAdUnit?.addContextData(dataPair.value, forKey: dataPair.key)
+                nativeAdUnit?.addContextData(key: dataPair.value, value: dataPair.key)
             }
         }
 

diff --git a/...MobileDemoRendering/ViewControllers/Adapters/Prebid/MAX/PrebidMAXRewardedController.swift b/...MobileDemoRendering/ViewControllers/Adapters/Prebid/MAX/PrebidMAXRewardedController.swift
@@ -69,7 +69,7 @@ class PrebidMAXRewardedController: NSObject, AdaptedController, PrebidConfigurab
         // imp[].ext.data
         if let adUnitContext = AppConfiguration.shared.adUnitContext {
             for dataPair in adUnitContext {
-                adUnit?.addContextData(dataPair.value, forKey: dataPair.key)
+                adUnit?.addContextData(key: dataPair.value, value: dataPair.key)
             }
         }
 

diff --git a/Podfile.lock b/Podfile.lock
@@ -1,11 +1,11 @@
 PODS:
   - Alamofire (4.9.1)
-  - AppLovinSDK (12.6.1)
+  - AppLovinSDK (13.0.0)
   - Eureka (5.5.0)
-  - Google-Mobile-Ads-SDK (11.8.0):
+  - Google-Mobile-Ads-SDK (11.10.0):
     - GoogleUserMessagingPlatform (>= 1.1)
   - GoogleAds-IMA-iOS-SDK (3.23.0)
-  - GoogleUserMessagingPlatform (2.5.0)
+  - GoogleUserMessagingPlatform (2.6.0)
   - RxSwift (6.7.1)
   - SVProgressHUD (2.3.1):
     - SVProgressHUD/Core (= 2.3.1)
@@ -33,11 +33,11 @@ SPEC REPOS:
 
 SPEC CHECKSUMS:
   Alamofire: 85e8a02c69d6020a0d734f6054870d7ecb75cf18
-  AppLovinSDK: a892bbeff744749a8121bd863aa1399f7eef6ef1
+  AppLovinSDK: c0ecb434df24008b6ecdd7f1e5b8587bc45ff381
   Eureka: 1c18c7fcd8f772cc2ca42d6be36292dffa77eecb
-  Google-Mobile-Ads-SDK: c1c53687b572122c5b0bdaf354335bbf40fd81ef
+  Google-Mobile-Ads-SDK: 13e6e98edfd78ad8d8a791edb927658cc260a56f
   GoogleAds-IMA-iOS-SDK: ee2a68ed7a1a17c7bb81bdb1b81590b35a3fc8f3
-  GoogleUserMessagingPlatform: 6b4f48a370e77ce121d034c908cc6ee4fdafaf13
+  GoogleUserMessagingPlatform: 0c3a08353e53ce8c2feab7addd0b652cde522450
   RxSwift: b9a93a26031785159e11abd40d1a55bcb8057e52
   SVProgressHUD: 4837c74bdfe2e51e8821c397825996a8d7de6e22
 

diff --git a/PrebidMobile.xcodeproj/project.pbxproj b/PrebidMobile.xcodeproj/project.pbxproj
@@ -106,6 +106,7 @@
 		53A657B12A8B650900AE0B4F /* PBMORTBSDKConfiguration.h in Headers */ = {isa = PBXBuildFile; fileRef = 53A657AE2A8B64B300AE0B4F /* PBMORTBSDKConfiguration.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		53A657B52A8B8B0500AE0B4F /* PBMORTBBidResponseExtPrebid.h in Headers */ = {isa = PBXBuildFile; fileRef = 53A657B42A8B8B0500AE0B4F /* PBMORTBBidResponseExtPrebid.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		53A657B72A8B8B6400AE0B4F /* PBMORTBBidResponseExtPrebid.m in Sources */ = {isa = PBXBuildFile; fileRef = 53A657B62A8B8B6400AE0B4F /* PBMORTBBidResponseExtPrebid.m */; };
+		53A8CBDB2C64D12A008ABEA7 /* SingleContainerInt.swift in Sources */ = {isa = PBXBuildFile; fileRef = 53A8CBDA2C64D12A008ABEA7 /* SingleContainerInt.swift */; };
 		53B221CF2A0E3D2800C91CCB /* PrebidJSLibrary.swift in Sources */ = {isa = PBXBuildFile; fileRef = 53B221CE2A0E3D2800C91CCB /* PrebidJSLibrary.swift */; };
 		53B221D12A0E3D3D00C91CCB /* PrebidJSLibraryManager.swift in Sources */ = {isa = PBXBuildFile; fileRef = 53B221D02A0E3D3D00C91CCB /* PrebidJSLibraryManager.swift */; };
 		53B221D32A0E3DA900C91CCB /* PrebidJSLibraryManagerTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 53B221D22A0E3DA900C91CCB /* PrebidJSLibraryManagerTests.swift */; };
@@ -967,6 +968,7 @@
 		53A657AF2A8B64C200AE0B4F /* PBMORTBSDKConfiguration.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = PBMORTBSDKConfiguration.m; sourceTree = "<group>"; };
 		53A657B42A8B8B0500AE0B4F /* PBMORTBBidResponseExtPrebid.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = PBMORTBBidResponseExtPrebid.h; sourceTree = "<group>"; };
 		53A657B62A8B8B6400AE0B4F /* PBMORTBBidResponseExtPrebid.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = PBMORTBBidResponseExtPrebid.m; sourceTree = "<group>"; };
+		53A8CBDA2C64D12A008ABEA7 /* SingleContainerInt.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SingleContainerInt.swift; sourceTree = "<group>"; };
 		53B221CE2A0E3D2800C91CCB /* PrebidJSLibrary.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PrebidJSLibrary.swift; sourceTree = "<group>"; };
 		53B221D02A0E3D3D00C91CCB /* PrebidJSLibraryManager.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PrebidJSLibraryManager.swift; sourceTree = "<group>"; };
 		53B221D22A0E3DA900C91CCB /* PrebidJSLibraryManagerTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PrebidJSLibraryManagerTests.swift; sourceTree = "<group>"; };
@@ -1909,6 +1911,7 @@
 				53E45A0227FCD09C0095C0B2 /* BannerParameters.swift */,
 				53E3910D27FCD60800DBA2F7 /* VideoParameters.swift */,
 				53A368EA2AB2E95E00A03B3E /* NativeParameters.swift */,
+				53A8CBDA2C64D12A008ABEA7 /* SingleContainerInt.swift */,
 			);
 			path = Parameters;
 			sourceTree = "<group>";
@@ -4194,6 +4197,7 @@
 				5BC3792B271F1D0000444D5E /* PBMConstants.m in Sources */,
 				5BC37A61271F1D0000444D5E /* PBMORTBBidExt.m in Sources */,
 				FAEE4D13262DC2B200AD9966 /* AdUnit.swift in Sources */,
+				53A8CBDB2C64D12A008ABEA7 /* SingleContainerInt.swift in Sources */,
 				5BC379CF271F1D0000444D5E /* PBMAdLoadManagerBase.m in Sources */,
 				924F661C27FDBA5200C8DAF7 /* PBMORTBAdConfiguration.m in Sources */,
 				5BC379FB271F1D0000444D5E /* PBMExternalURLOpenCallbacks.m in Sources */,
@@ -4531,6 +4535,8 @@
 				MARKETING_VERSION = 2.3.0;
 				MODULEMAP_FILE = PrebidMobile/BuildFiles/PrebidMobile.modulemap;
 				SKIP_INSTALL = YES;
+				SUPPORTED_PLATFORMS = "iphoneos iphonesimulator";
+				SUPPORTS_MACCATALYST = NO;
 				SWIFT_OPTIMIZATION_LEVEL = "-Onone";
 				SWIFT_VERSION = 5.0;
 				TARGETED_DEVICE_FAMILY = "1,2";
@@ -4567,6 +4573,8 @@
 				MARKETING_VERSION = 2.3.0;
 				MODULEMAP_FILE = PrebidMobile/BuildFiles/PrebidMobile.modulemap;
 				SKIP_INSTALL = YES;
+				SUPPORTED_PLATFORMS = "iphoneos iphonesimulator";
+				SUPPORTS_MACCATALYST = NO;
 				SWIFT_VERSION = 5.0;
 				TARGETED_DEVICE_FAMILY = "1,2";
 			};