Skip to content

Commit

Permalink
PIA-1733: Introduce DIP signup API for supported countries (#12)
Browse files Browse the repository at this point in the history
  • Loading branch information
@kp-juan-docal
kp-juan-docal authored Jun 6, 2024
1 parent d841496 commit 078beb9
Show file tree
Hide file tree
Showing 3 changed files with 158 additions and 19 deletions.
18 changes: 13 additions & 5 deletions account/src/commonMain/kotlin/com/privateinternetaccess/account/AccountAPI.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ package com.privateinternetaccess.account
import com.privateinternetaccess.account.internals.Account
import com.privateinternetaccess.account.internals.AndroidAccount
import com.privateinternetaccess.account.internals.IOSAccount
import com.privateinternetaccess.account.internals.model.response.DipCountriesResponse
import com.privateinternetaccess.account.model.request.AmazonSignupInformation
import com.privateinternetaccess.account.model.request.AndroidSignupInformation
import com.privateinternetaccess.account.model.request.IOSPaymentInformation
Expand Down Expand Up @@ -92,20 +93,27 @@ public interface AccountAPI {
fun deleteAccount(callback: (error: List<AccountRequestError>) -> Unit)

/**
* @param ipTokens `List<String>`
* @param callback `(details: DipCountriesResponse?, error: List<AccountRequestError>) -> Unit`
*/
fun supportedDedicatedIPCountries(
callback: (details: DipCountriesResponse?, error: List<AccountRequestError>) -> Unit
)

/**
* @param dipTokens `List<String>`
* @param callback `(details: DedicatedIPInformation, error: List<AccountRequestError>) -> Unit`
*/
fun dedicatedIPs(
ipTokens: List<String>,
fun redeemDedicatedIPs(
dipTokens: List<String>,
callback: (details: List<DedicatedIPInformation>, error: List<AccountRequestError>) -> Unit
)

/**
* @param ipToken `String`
* @param dipToken `String`
* @param callback `(details: DedicatedIPInformation, error: List<AccountRequestError>) -> Unit`
*/
fun renewDedicatedIP(
ipToken: String,
dipToken: String,
callback: (error: List<AccountRequestError>) -> Unit
)

Expand Down
136 changes: 122 additions & 14 deletions account/src/commonMain/kotlin/com/privateinternetaccess/account/internals/Account.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ package com.privateinternetaccess.account.internals
import com.privateinternetaccess.account.*
import com.privateinternetaccess.account.internals.model.request.DedicatedIPRequest
import com.privateinternetaccess.account.internals.model.response.ApiTokenResponse
import com.privateinternetaccess.account.internals.model.response.DipCountriesResponse
import com.privateinternetaccess.account.internals.model.response.SetEmailResponse
import com.privateinternetaccess.account.internals.model.response.VpnTokenResponse
import com.privateinternetaccess.account.internals.persistency.AccountPersistence
Expand Down Expand Up @@ -83,7 +84,8 @@ internal open class Account(
REDEEM("/api/client/giftcard_redeem"),
REFRESH_TOKEN("/api/client/v4/refresh"),
MESSAGES("/api/client/v2/messages"),
DEDICATED_IP("/api/client/v2/dedicated_ip"),
SUPPORTED_DEDICATED_IP_COUNTRIES("/api/client/v5/dip_regions"),
REDEEM_DEDICATED_IP("/api/client/v2/dedicated_ip"),
RENEW_DEDICATED_IP("/api/client/v2/check_renew_dip"),
ANDROID_SUBSCRIPTIONS("/api/client/android"),
AMAZON_SUBSCRIPTIONS("/api/client/amazon"),
Expand Down Expand Up @@ -115,7 +117,8 @@ internal open class Account(
Path.REDEEM to "api",
Path.REFRESH_TOKEN to "apiv4",
Path.MESSAGES to "apiv2",
Path.DEDICATED_IP to "apiv2",
Path.SUPPORTED_DEDICATED_IP_COUNTRIES to "apiv5",
Path.REDEEM_DEDICATED_IP to "apiv2",
Path.RENEW_DEDICATED_IP to "apiv2",
Path.ANDROID_SUBSCRIPTIONS to "api",
Path.AMAZON_SUBSCRIPTIONS to "api",
Expand Down Expand Up @@ -203,21 +206,29 @@ internal open class Account(
}
}

override fun dedicatedIPs(
ipTokens: List<String>,
override fun supportedDedicatedIPCountries(
callback: (details: DipCountriesResponse?, error: List<AccountRequestError>) -> Unit
) {
launch {
supportedDedicatedIPCountriesAsync(endpointsProvider.accountEndpoints(), callback)
}
}

override fun redeemDedicatedIPs(
dipTokens: List<String>,
callback: (details: List<DedicatedIPInformation>, error: List<AccountRequestError>) -> Unit
) {
launch {
dedicatedIPsAsync(ipTokens, endpointsProvider.accountEndpoints(), callback)
redeemDedicatedIPsAsync(dipTokens, endpointsProvider.accountEndpoints(), callback)
}
}

override fun renewDedicatedIP(
ipToken: String,
dipToken: String,
callback: (error: List<AccountRequestError>) -> Unit
) {
launch {
renewDedicatedIPAsync(ipToken, endpointsProvider.accountEndpoints(), callback)
renewDedicatedIPAsync(dipToken, endpointsProvider.accountEndpoints(), callback)
}
}

Expand Down Expand Up @@ -775,8 +786,105 @@ internal open class Account(
}
}

private suspend fun dedicatedIPsAsync(
ipTokens: List<String>,
private suspend fun supportedDedicatedIPCountriesAsync(
endpoints: List<AccountEndpoint>,
callback: (details: DipCountriesResponse?, error: List<AccountRequestError>) -> Unit
) {
val listErrors: MutableList<AccountRequestError> = mutableListOf()
var supportedDedicatedIPsCountries: DipCountriesResponse? = null
if (endpoints.isEmpty()) {
listErrors.add(
AccountRequestError(
600,
"No available endpoints to perform the request"
)
)
}

refreshTokensIfNeeded(endpoints)
for (endpoint in endpoints) {
val apiToken = persistence.apiTokenResponse()?.apiToken
if (apiToken == null) {
listErrors.add(AccountRequestError(600, "Invalid request token"))
break
}

if (endpoint.usePinnedCertificate && certificate.isNullOrEmpty()) {
listErrors.add(
AccountRequestError(
600,
"No available certificate for pinning purposes"
)
)
continue
}

val httpClientConfigResult = if (endpoint.usePinnedCertificate) {
AccountHttpClient.client(certificate, Pair(endpoint.ipOrRootDomain, endpoint.certificateCommonName!!))
} else {
AccountHttpClient.client()
}

val httpClient = httpClientConfigResult.first
val httpClientError = httpClientConfigResult.second
if (httpClientError != null) {
listErrors.add(AccountRequestError(600, httpClientError.message))
continue
}

if (httpClient == null) {
listErrors.add(AccountRequestError(600, "Invalid http client"))
continue
}

val url = AccountUtils.prepareRequestUrl(endpoint.ipOrRootDomain, Path.SUPPORTED_DEDICATED_IP_COUNTRIES)
if (url == null) {
listErrors.add(AccountRequestError(600, "Error preparing url ${endpoint.ipOrRootDomain} - ${Path.SUPPORTED_DEDICATED_IP_COUNTRIES.url}"))
continue
}

var succeeded = false
val response = httpClient.getCatching<Pair<HttpResponse?, Exception?>> {
url(url)
header("Authorization", "Token $apiToken")
}

response.first?.let {
if (AccountUtils.isErrorStatusCode(it.status.value)) {
listErrors.add(it.mapStatusCodeToAccountError())
} else {
try {
supportedDedicatedIPsCountries = json.decodeFromString(
DipCountriesResponse.serializer(), it.bodyAsText()
)
succeeded = true
} catch (exception: SerializationException) {
listErrors.add(AccountRequestError(600, "Decode error $exception"))
}
}
}
response.second?.let {
listErrors.add(AccountRequestError(600, it.message))
}

// Close the used client explicitly.
// We need to recreate it due to the possibility of pinning among the endpoints list.
httpClient.close()

// If there were no errors in the request for the current endpoint. No need to try the next endpoint.
if (succeeded) {
listErrors.clear()
break
}
}

withContext(Dispatchers.Main) {
callback(supportedDedicatedIPsCountries, listErrors)
}
}

private suspend fun redeemDedicatedIPsAsync(
dipTokens: List<String>,
endpoints: List<AccountEndpoint>,
callback: (details: List<DedicatedIPInformation>, error: List<AccountRequestError>) -> Unit
) {
Expand Down Expand Up @@ -827,9 +935,9 @@ internal open class Account(
continue
}

val url = AccountUtils.prepareRequestUrl(endpoint.ipOrRootDomain, Path.DEDICATED_IP)
val url = AccountUtils.prepareRequestUrl(endpoint.ipOrRootDomain, Path.REDEEM_DEDICATED_IP)
if (url == null) {
listErrors.add(AccountRequestError(600, "Error preparing url ${endpoint.ipOrRootDomain} - ${Path.DEDICATED_IP.url}"))
listErrors.add(AccountRequestError(600, "Error preparing url ${endpoint.ipOrRootDomain} - ${Path.REDEEM_DEDICATED_IP.url}"))
continue
}

Expand All @@ -838,7 +946,7 @@ internal open class Account(
url(url)
header("Authorization", "Token $apiToken")
contentType(ContentType.Application.Json)
setBody(json.encodeToString(DedicatedIPRequest.serializer(), DedicatedIPRequest(ipTokens)))
setBody(json.encodeToString(DedicatedIPRequest.serializer(), DedicatedIPRequest(dipTokens)))
}

response.first?.let {
Expand Down Expand Up @@ -877,7 +985,7 @@ internal open class Account(
}

private suspend fun renewDedicatedIPAsync(
ipToken: String,
dipToken: String,
endpoints: List<AccountEndpoint>,
callback: (error: List<AccountRequestError>) -> Unit
) {
Expand Down Expand Up @@ -935,7 +1043,7 @@ internal open class Account(

var succeeded = false
val formParameters = Parameters.build {
append("token", ipToken)
append("token", dipToken)
}
val response = httpClient.postCatching<Pair<HttpResponse?, Exception?>>(formParameters = formParameters) {
url(url)
Expand Down
23 changes: 23 additions & 0 deletions ...kotlin/com/privateinternetaccess/account/internals/model/response/DipCountriesResponse.kt
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
package com.privateinternetaccess.account.internals.model.response


import kotlinx.serialization.SerialName
import kotlinx.serialization.Serializable

@Serializable
data class DipCountriesResponse(
@SerialName("dedicatedIpCountriesAvailable")
val dedicatedIpCountriesAvailable: List<DedicatedIpCountriesAvailable>
) {
@Serializable
data class DedicatedIpCountriesAvailable(
@SerialName("country_code")
val countryCode: String,
@SerialName("name")
val name: String,
@SerialName("new_regions")
val newRegions: List<String>,
@SerialName("regions")
val regions: List<String>
)
}

0 comments on commit 078beb9

Please sign in to comment.