Cleanup before GA Release (#190)

* Suppress docs for CardResult deepLinkUrl. * Remove OrderRequest class that is no longer used. * Make ApproveOrderMetadata internal. * Make PaymentSource class internal. * Make additional classes internal that can be made internal. * Make ThreeDSecureResult private. * Move OrderIntent enum out of SDK and into Demo app. * Restrict analytics items to library group whenever possible. * Rename Error type to GraphQLError. * Rename Extension type to GraphQLExtension. * Update library restriction annotations and make GraphQL types library private. * Extract APIClientError codes into internal PayPalSDKErrorCode enum. * Add documentation suppression annotations for library restricted code. * Make Environment enum associated values internal. * Update restrict annotations. * Fix mockk errors that caused HttpResponseParserUnitTest to fail. * Mark CoreConfig magnesEnvironment extension internal. * Fix package name in PaymentButtons module. * Create PayPalWebCheckoutErrorCode type. * Update PayPalWeb restrictions. * Remove open modifier on PayPalSDKError class. * Restrict PayPalSDKError constructor to library group. * Remove SecureTokenServiceAPI.kt. * Remove Eligibility API files that are no longer used. * Flatten GraphQL package. * Fix detekt lint errors. * Remove unused eligibility query raw resource. * Update PayPalNativeViewModel to parse mxo errors. * Move CardResult into .cardpayments module. * Update PayPalSDKErrorCode type to make it visible for tests. * Fix lint errors. * Remove unecessary JSONObjectExt file. * Update CHANGELOG. * Cleanup unused classes. * Cleanup OrderIntent imports. * Revert NetworkModule deletion.
paypal · Sep 20, 2023 · 73615bc · 73615bc
1 parent 51f5e4d
commit 73615bc
Show file tree

Hide file tree

Showing 88 changed files with 253 additions and 729 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,21 @@
 # PayPal Android SDK Release Notes
 
+## unreleased
+
+* Breaking Changes
+  * CardPayments
+    * Make `Amount` class internal
+    * Make `ApproveOrderMetadata` class internal
+    * Make `AuthenticationResult` class internal
+    * Make `Payee` class internal
+    * Make `PaymentSource` class internal
+    * Make `PurchaseUnit` class internal
+    * Make `ThreeDSecureResult` class internal
+    * Make `Environment` enum associated values internal
+    * Remove `OrderRequest` class
+  * CorePayments
+    * Remove `open` modifier on `PayPalSDKError`
+
 ## 0.0.13 (2023-08-22)
 
 * FraudDetection

diff --git a/CardPayments/src/main/java/com/paypal/android/cardpayments/ApproveOrderListener.kt b/CardPayments/src/main/java/com/paypal/android/cardpayments/ApproveOrderListener.kt
@@ -1,7 +1,6 @@
 package com.paypal.android.cardpayments
 
 import androidx.annotation.MainThread
-import com.paypal.android.cardpayments.model.CardResult
 import com.paypal.android.corepayments.PayPalSDKError
 
 /**

diff --git a/CardPayments/src/main/java/com/paypal/android/cardpayments/ApproveOrderMetadata.kt b/CardPayments/src/main/java/com/paypal/android/cardpayments/ApproveOrderMetadata.kt
@@ -4,7 +4,7 @@ import com.paypal.android.cardpayments.model.PaymentSource
 import com.paypal.android.corepayments.PaymentsJSON
 import org.json.JSONObject
 
-data class ApproveOrderMetadata(val orderId: String, val paymentSource: PaymentSource?) {
+internal data class ApproveOrderMetadata(val orderId: String, val paymentSource: PaymentSource?) {
 
     companion object {
 

diff --git a/CardPayments/src/main/java/com/paypal/android/cardpayments/CardClient.kt b/CardPayments/src/main/java/com/paypal/android/cardpayments/CardClient.kt
@@ -8,7 +8,6 @@ import com.braintreepayments.api.BrowserSwitchOptions
 import com.braintreepayments.api.BrowserSwitchResult
 import com.braintreepayments.api.BrowserSwitchStatus
 import com.paypal.android.cardpayments.api.CheckoutOrdersAPI
-import com.paypal.android.cardpayments.model.CardResult
 import com.paypal.android.corepayments.CoreConfig
 import com.paypal.android.corepayments.CoreCoroutineExceptionHandler
 import com.paypal.android.corepayments.PayPalSDKError

diff --git a/.../android/cardpayments/model/CardResult.kt → ...paypal/android/cardpayments/CardResult.kt b/.../android/cardpayments/model/CardResult.kt → ...paypal/android/cardpayments/CardResult.kt
@@ -1,11 +1,17 @@
-package com.paypal.android.cardpayments.model
+package com.paypal.android.cardpayments
 
 import android.net.Uri
 
 /**
  * A result returned by [CardClient] when an order was successfully approved with a [Card].
+ *
+ * @property [orderId] associated order ID.
  */
 data class CardResult(
     val orderId: String,
+
+    /**
+     * @suppress
+     */
     val deepLinkUrl: Uri? = null
 )
diff --git a/...Payments/src/main/java/com/paypal/android/cardpayments/DataVaultPaymentMethodTokensAPI.kt b/...Payments/src/main/java/com/paypal/android/cardpayments/DataVaultPaymentMethodTokensAPI.kt
@@ -4,7 +4,7 @@ import android.content.Context
 import com.paypal.android.corepayments.CoreConfig
 import com.paypal.android.corepayments.PayPalSDKError
 import com.paypal.android.corepayments.ResourceLoader
-import com.paypal.android.corepayments.graphql.common.GraphQLClient
+import com.paypal.android.corepayments.graphql.GraphQLClient
 import org.json.JSONObject
 
 internal class DataVaultPaymentMethodTokensAPI internal constructor(

diff --git a/CardPayments/src/main/java/com/paypal/android/cardpayments/OrderRequest.kt b/CardPayments/src/main/java/com/paypal/android/cardpayments/OrderRequest.kt
diff --git a/CardPayments/src/main/java/com/paypal/android/cardpayments/model/Amount.kt b/CardPayments/src/main/java/com/paypal/android/cardpayments/model/Amount.kt
@@ -2,7 +2,7 @@ package com.paypal.android.cardpayments.model
 
 import com.paypal.android.corepayments.PaymentsJSON
 
-data class Amount(
+internal data class Amount(
     val currencyCode: String?,
     val value: String?
 ) {

diff --git a/CardPayments/src/main/java/com/paypal/android/cardpayments/model/AuthenticationResult.kt b/CardPayments/src/main/java/com/paypal/android/cardpayments/model/AuthenticationResult.kt
@@ -4,7 +4,7 @@ import com.paypal.android.cardpayments.threedsecure.ThreeDSecureResult
 import com.paypal.android.corepayments.PaymentsJSON
 import org.json.JSONObject
 
-data class AuthenticationResult(
+internal data class AuthenticationResult(
     val liabilityShift: String?,
     val threeDSecure: ThreeDSecureResult? = null
 ) {

diff --git a/CardPayments/src/main/java/com/paypal/android/cardpayments/model/Payee.kt b/CardPayments/src/main/java/com/paypal/android/cardpayments/model/Payee.kt
@@ -2,6 +2,6 @@ package com.paypal.android.cardpayments.model
 
 import com.paypal.android.corepayments.PaymentsJSON
 
-data class Payee(val emailAddress: String) {
+internal data class Payee(val emailAddress: String) {
     internal constructor(json: PaymentsJSON) : this(json.optString("email_address") ?: "")
 }
diff --git a/CardPayments/src/main/java/com/paypal/android/cardpayments/model/PaymentSource.kt b/CardPayments/src/main/java/com/paypal/android/cardpayments/model/PaymentSource.kt
@@ -3,7 +3,7 @@ package com.paypal.android.cardpayments.model
 import com.paypal.android.corepayments.PaymentsJSON
 import org.json.JSONObject
 
-data class PaymentSource(
+internal data class PaymentSource(
     val lastDigits: String,
     val brand: String,
     val type: String? = null,

diff --git a/CardPayments/src/main/java/com/paypal/android/cardpayments/model/PurchaseUnit.kt b/CardPayments/src/main/java/com/paypal/android/cardpayments/model/PurchaseUnit.kt
@@ -6,7 +6,7 @@ import com.paypal.android.corepayments.PaymentsJSON
  * A purchase unit for an order. If an order takes multiple purchase units,
  * each one must contain a reference id.
  */
-data class PurchaseUnit(
+internal data class PurchaseUnit(
     val referenceId: String?,
     val amount: Amount? = null,
     val payee: Payee? = null

diff --git a/...Payments/src/main/java/com/paypal/android/cardpayments/threedsecure/ThreeDSecureResult.kt b/...Payments/src/main/java/com/paypal/android/cardpayments/threedsecure/ThreeDSecureResult.kt
@@ -3,7 +3,7 @@ package com.paypal.android.cardpayments.threedsecure
 import com.paypal.android.corepayments.PaymentsJSON
 import org.json.JSONObject
 
-data class ThreeDSecureResult(
+internal data class ThreeDSecureResult(
     val enrollmentStatus: String? = null,
     val authenticationStatus: String? = null
 ) {

diff --git a/CardPayments/src/test/java/com/paypal/android/cardpayments/CardClientUnitTest.kt b/CardPayments/src/test/java/com/paypal/android/cardpayments/CardClientUnitTest.kt
@@ -11,7 +11,6 @@ import com.braintreepayments.api.BrowserSwitchResult
 import com.braintreepayments.api.BrowserSwitchStatus
 import com.paypal.android.cardpayments.api.CheckoutOrdersAPI
 import com.paypal.android.cardpayments.api.ConfirmPaymentSourceResponse
-import com.paypal.android.cardpayments.model.CardResult
 import com.paypal.android.cardpayments.model.PaymentSource
 import com.paypal.android.corepayments.OrderStatus
 import com.paypal.android.corepayments.PayPalSDKError

diff --git a/CardPayments/src/test/java/com/paypal/android/cardpayments/CardRequestParserUnitTest.kt b/CardPayments/src/test/java/com/paypal/android/cardpayments/CardRequestParserUnitTest.kt
@@ -1,7 +1,7 @@
 package com.paypal.android.cardpayments
 
-import com.paypal.android.corepayments.Code
 import com.paypal.android.corepayments.HttpResponse
+import com.paypal.android.corepayments.PayPalSDKErrorCode
 import io.mockk.every
 import io.mockk.mockk
 import org.junit.Assert
@@ -44,7 +44,7 @@ class CardRequestParserUnitTest {
         private val status: Int,
         private val body: String,
         private val message: String,
-        private val resultCode: Code
+        private val resultCode: PayPalSDKErrorCode
     ) {
 
         companion object {
@@ -56,19 +56,22 @@ class CardRequestParserUnitTest {
                     HttpResponse.STATUS_UNKNOWN_HOST,
                     "json_body",
                     "An error occurred due to an invalid HTTP response. Contact developer.paypal.com/support.",
-                    Code.UNKNOWN_HOST),
+                    PayPalSDKErrorCode.UNKNOWN_HOST
+                ),
                 arrayOf(
                     false,
                     HttpResponse.STATUS_UNDETERMINED,
                     "json_body",
                     "An unknown error occurred. Contact developer.paypal.com/support.",
-                    Code.UNKNOWN),
+                    PayPalSDKErrorCode.UNKNOWN
+                ),
                 arrayOf(
                     false,
                     HttpResponse.SERVER_ERROR,
                     "json_body",
                     "A server error occurred. Contact developer.paypal.com/support.",
-                    Code.SERVER_RESPONSE_ERROR),
+                    PayPalSDKErrorCode.SERVER_RESPONSE_ERROR
+                ),
                 arrayOf(
                     false,
                     HttpURLConnection.HTTP_OK,
@@ -86,7 +89,8 @@ class CardRequestParserUnitTest {
                     """.trimIndent(),
                     "error message -> [Issue: ISSUE_KEY_TITLE.\n" +
                             "Error description: issue description message]",
-                    Code.CHECKOUT_ERROR)
+                    PayPalSDKErrorCode.CHECKOUT_ERROR
+                )
             )
         }
 
@@ -107,7 +111,12 @@ class CardRequestParserUnitTest {
             val sut = CardResponseParser()
             val error = sut.parseError(httpResponse)
 
-            if (status != HttpURLConnection.HTTP_OK) Assert.assertEquals(resultCode.ordinal, error?.code)
+            if (status != HttpURLConnection.HTTP_OK) {
+                Assert.assertEquals(
+                    resultCode.ordinal,
+                    error?.code
+                )
+            }
             Assert.assertEquals(correlationId, error?.correlationId)
             Assert.assertEquals(message, error?.errorDescription)
         }

diff --git a/.../src/test/java/com/paypal/android/cardpayments/DataVaultPaymentMethodTokensAPIUnitTest.kt b/.../src/test/java/com/paypal/android/cardpayments/DataVaultPaymentMethodTokensAPIUnitTest.kt
@@ -6,8 +6,8 @@ import com.paypal.android.corepayments.Address
 import com.paypal.android.corepayments.CoreConfig
 import com.paypal.android.corepayments.Environment
 import com.paypal.android.corepayments.ResourceLoader
-import com.paypal.android.corepayments.graphql.common.GraphQLClient
-import com.paypal.android.corepayments.graphql.common.GraphQLResponse
+import com.paypal.android.corepayments.graphql.GraphQLClient
+import com.paypal.android.corepayments.graphql.GraphQLResponse
 import io.mockk.coEvery
 import io.mockk.coVerify
 import io.mockk.mockk

diff --git a/CorePayments/build.gradle b/CorePayments/build.gradle
@@ -50,6 +50,7 @@ android {
             all {
                 // workaround for spying on java.net.URL in Http module
                 // Ref: https://mockk.io/doc/md/jdk16-access-exceptions.html
+                jvmArgs("--add-opens", "java.base/java.io=ALL-UNNAMED")
                 jvmArgs("--add-opens", "java.base/java.net=ALL-UNNAMED")
             }
         }

diff --git a/CorePayments/src/main/java/com/paypal/android/corepayments/APIClientError.kt b/CorePayments/src/main/java/com/paypal/android/corepayments/APIClientError.kt
@@ -1,45 +1,52 @@
 package com.paypal.android.corepayments
 
+import androidx.annotation.RestrictTo
+import java.lang.Exception
+
+/**
+ * @suppress
+ */
+@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
 object APIClientError {
 
     // 0. An unknown error occurred.
     fun unknownError(correlationId: String?) = PayPalSDKError(
-        code = Code.UNKNOWN.ordinal,
+        code = PayPalSDKErrorCode.UNKNOWN.ordinal,
         errorDescription = "An unknown error occurred. Contact developer.paypal.com/support.",
         correlationId = correlationId
     )
 
     // 1. Error parsing HTTP response data.
     fun dataParsingError(correlationId: String?) = PayPalSDKError(
-        code = Code.DATA_PARSING_ERROR.ordinal,
+        code = PayPalSDKErrorCode.DATA_PARSING_ERROR.ordinal,
         errorDescription = "An error occurred parsing HTTP response data." +
                 " Contact developer.paypal.com/support.",
         correlationId = correlationId
     )
 
     // 2. Unknown Host from network.
     fun unknownHost(correlationId: String?) = PayPalSDKError(
-        code = Code.UNKNOWN_HOST.ordinal,
+        code = PayPalSDKErrorCode.UNKNOWN_HOST.ordinal,
         errorDescription = "An error occurred due to an invalid HTTP response. Contact developer.paypal.com/support.",
         correlationId = correlationId
     )
 
     // 3. Missing HTTP response data.
     fun noResponseData(correlationId: String?) = PayPalSDKError(
-        code = Code.NO_RESPONSE_DATA.ordinal,
+        code = PayPalSDKErrorCode.NO_RESPONSE_DATA.ordinal,
         errorDescription = "An error occurred due to missing HTTP response data. Contact developer.paypal.com/support.",
         correlationId = correlationId
     )
 
     // 4. There was an error constructing the URLRequest.
     val invalidUrlRequest = PayPalSDKError(
-        code = Code.INVALID_URL_REQUEST.ordinal,
+        code = PayPalSDKErrorCode.INVALID_URL_REQUEST.ordinal,
         errorDescription = "An error occurred constructing an HTTP request. Contact developer.paypal.com/support."
     )
 
     // 5. The server's response body returned an error message.
     fun serverResponseError(correlationId: String?) = PayPalSDKError(
-        code = Code.SERVER_RESPONSE_ERROR.ordinal,
+        code = PayPalSDKErrorCode.SERVER_RESPONSE_ERROR.ordinal,
         errorDescription = "A server error occurred. Contact developer.paypal.com/support.",
         correlationId = correlationId
     )
@@ -54,24 +61,23 @@ object APIClientError {
 
     val payPalCheckoutError: (description: String) -> PayPalSDKError = { description ->
         PayPalSDKError(
-            code = Code.CHECKOUT_ERROR.ordinal,
+            code = PayPalSDKErrorCode.CHECKOUT_ERROR.ordinal,
             errorDescription = description
         )
     }
 
+    val payPalNativeCheckoutError: (description: String, reason: Exception) -> PayPalSDKError =
+        { description, reason ->
+            PayPalSDKError(
+                code = PayPalSDKErrorCode.NATIVE_CHECKOUT_ERROR.ordinal,
+                errorDescription = description,
+                reason = reason
+            )
+        }
+
     fun clientIDNotFoundError(code: Int, correlationId: String?) = PayPalSDKError(
         code = code,
         errorDescription = "Error fetching clientId. Contact developer.paypal.com/support.",
         correlationId = correlationId
     )
 }
-
-enum class Code {
-    UNKNOWN,
-    DATA_PARSING_ERROR,
-    UNKNOWN_HOST,
-    NO_RESPONSE_DATA,
-    INVALID_URL_REQUEST,
-    SERVER_RESPONSE_ERROR,
-    CHECKOUT_ERROR
-}
diff --git a/CorePayments/src/main/java/com/paypal/android/corepayments/APIRequest.kt b/CorePayments/src/main/java/com/paypal/android/corepayments/APIRequest.kt
@@ -1,3 +1,9 @@
 package com.paypal.android.corepayments
 
+import androidx.annotation.RestrictTo
+
+/**
+ * @suppress
+ */
+@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
 data class APIRequest(val path: String, val method: HttpMethod, val body: String? = null)
diff --git a/CorePayments/src/main/java/com/paypal/android/corepayments/CoreCoroutineExceptionHandler.kt b/CorePayments/src/main/java/com/paypal/android/corepayments/CoreCoroutineExceptionHandler.kt
@@ -1,9 +1,14 @@
 package com.paypal.android.corepayments
 
+import androidx.annotation.RestrictTo
 import kotlinx.coroutines.CoroutineExceptionHandler
 import kotlin.coroutines.AbstractCoroutineContextElement
 import kotlin.coroutines.CoroutineContext
 
+/**
+ * @suppress
+ */
+@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
 class CoreCoroutineExceptionHandler(private val handler: (PayPalSDKError) -> Unit) :
     AbstractCoroutineContextElement(CoroutineExceptionHandler), CoroutineExceptionHandler {
 

diff --git a/CorePayments/src/main/java/com/paypal/android/corepayments/Environment.kt b/CorePayments/src/main/java/com/paypal/android/corepayments/Environment.kt
@@ -1,6 +1,6 @@
 package com.paypal.android.corepayments
 
-enum class Environment(val url: String, val graphQLEndpoint: String) {
+enum class Environment(internal val url: String, internal val graphQLEndpoint: String) {
     LIVE(
         "https://api.paypal.com",
         "https://www.paypal.com"

diff --git a/CorePayments/src/main/java/com/paypal/android/corepayments/HttpMethod.kt b/CorePayments/src/main/java/com/paypal/android/corepayments/HttpMethod.kt
@@ -1,5 +1,11 @@
 package com.paypal.android.corepayments
 
+import androidx.annotation.RestrictTo
+
+/**
+ * @suppress
+ */
+@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
 enum class HttpMethod {
     GET, POST
 }
diff --git a/CorePayments/src/main/java/com/paypal/android/corepayments/HttpResponse.kt b/CorePayments/src/main/java/com/paypal/android/corepayments/HttpResponse.kt
@@ -1,7 +1,12 @@
 package com.paypal.android.corepayments
 
+import androidx.annotation.RestrictTo
 import java.net.HttpURLConnection
 
+/**
+ * @suppress
+ */
+@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
 data class HttpResponse(
     val status: Int,
     val headers: Map<String, String> = emptyMap(),

diff --git a/CorePayments/src/main/java/com/paypal/android/corepayments/JSONObjectExt.kt b/CorePayments/src/main/java/com/paypal/android/corepayments/JSONObjectExt.kt