Renamed API methods

Author: Jinya

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Jinya <https://github.com/Jinya>
+Copyright (c) 2021-2022 Jinya (https://github.com/Jinya)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

Sources/AppStoreReviewManager/AppStoreReviewManager.swift

@@ -1,53 +1,40 @@
 //
-//  AppStoreReviewManager
-//  https://github.com/Jinya/AppStoreReviewManager
+// AppStoreReviewManager
+// The MIT License (MIT)
 //
-//  Created by Jinya on 2021/10/29.
-//
-//  Copyright (c) 2021 Jinya<https://github.com/Jinya>
-//
-//  Permission is hereby granted, free of charge, to any person obtaining a copy
-//  of this software and associated documentation files (the "Software"), to deal
-//  in the Software without restriction, including without limitation the rights
-//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-//  copies of the Software, and to permit persons to whom the Software is
-//  furnished to do so, subject to the following conditions:
-//
-//  The above copyright notice and this permission notice shall be included in
-//  all copies or substantial portions of the Software.
-//
-//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-//  THE SOFTWARE.
+// Copyright (c) 2021-2022 Jinya (https://github.com/Jinya)
 
 import UIKit
 import StoreKit
 
 @available(iOS 9.0, *)
 public struct AppStoreReviewManager {
-    
-    private static let baseURLString = "https://apps.apple.com/app"
-    
-    /// Get the App Store page url string for your app.
-    /// - Parameter id: the App Store ID for your app, you can find the App Store ID in your app's product URL
-    /// - Returns: the App Store page url string for your app
-    public static func appStorePageURLString(with id: String) -> String {
-        return baseURLString + "/id\(id)"
+    /// Base URL string
+    private static let base = "https://apps.apple.com/app"
+
+    /// Get the App Store product page URL string with a given App Store ID.
+    private static func productURLString(with appStoreID: String) -> String {
+        return base + "/id\(appStoreID)"
+    }
+
+    /// Get the App Store product page URL with a given App Store ID.
+    /// - Parameter appStoreID: The App Store ID of a product.
+    /// - Returns: A product URL to the App Store.
+    public static func productURL(with appStoreID: String) -> URL? {
+        return URL(string: productURLString(with: appStoreID))
     }
 
-    /// Request StoreKit to ask the user to rate or review your app, users will submit a rating through the standardized prompt, and can write and submit a review without leaving the app. You can prompt for ratings up to three times in a 365-day.
+    /// Tells StoreKit to ask the user to rate or review your app, if appropriate.
+    ///
+    /// This is a convenient wrapper method for `SKStoreReviewController.requestReview()` and `SKStoreReviewController.requestReview(in: UIWindowScene)`.
     @available(iOS 10.3, *)
-    public static func requestReviewInApp() {
+    public static func requestReview() {
         let block = {
             if #available(iOS 14.0, *) {
                 guard let windowScene = UIApplication.shared.connectedScenes
                     .first(where: { $0.activationState == .foregroundActive }) as? UIWindowScene
                 else {
-                    debugPrint("AppStoreReviewManager couldn't find a foreground active window scene to request review alert!")
+                    Swift.print("AppStoreReviewManager couldn't find a foreground active window scene to request review alert!")
                     return
                 }
                 SKStoreReviewController.requestReview(in: windowScene)
@@ -65,10 +52,10 @@ public struct AppStoreReviewManager {
         }
     }
 
-    /// Initiate a write review form for a deep link to the App Store page for your app.
-    /// - Parameter id: the App Store ID for your app, you can find the App Store ID in your app's product URL
-    public static func requestReviewInAppStore(with id: String) {
-        let urlString = appStorePageURLString(with: id) + "?action=write-review"
+    /// Automatically open the App Store product page and present a write review form in the App Store.
+    /// - Parameter appStoreID: The App Store ID of a product.
+    public static func openProductPageForReview(with appStoreID: String) {
+        let urlString = productURLString(with: appStoreID) + "?action=write-review"
         guard let writeReviewURL = URL(string: urlString) else {
             assertionFailure("Expected a valid URL, \(urlString) is not a valid url string.")
             return
@@ -79,20 +66,4 @@ public struct AppStoreReviewManager {
             UIApplication.shared.openURL(writeReviewURL)
         }
     }
-    
-    /// Open a deep link to the App Store page for your app.
-    /// - Parameter id: the App Store ID for your app, you can find the App Store ID in your app's product URL
-    public static func openAppStorePage(with id: String) {
-        let urlString = appStorePageURLString(with: id)
-        guard let appStorePageURL = URL(string: urlString) else {
-            assertionFailure("Expected a valid URL, \(urlString) is not a valid url string.")
-            return
-        }
-        if #available(iOS 10.0, *) {
-            UIApplication.shared.open(appStorePageURL, options: [:], completionHandler: nil)
-        } else {
-            UIApplication.shared.openURL(appStorePageURL)
-        }
-    }
-    
 }