-
Notifications
You must be signed in to change notification settings - Fork 37
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2993 from wordpress-mobile/add-subscribers-endpoint
Add subscribers endpoint
- Loading branch information
Showing
12 changed files
with
636 additions
and
3 deletions.
There are no files selected for viewing
153 changes: 153 additions & 0 deletions
153
...wordpress/android/fluxc/network/rest/wpcom/stats/subscribers/SubscribersRestClientTest.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,153 @@ | ||
| package org.wordpress.android.fluxc.network.rest.wpcom.stats.subscribers | ||
|
|
||
| import com.android.volley.RequestQueue | ||
| import com.android.volley.VolleyError | ||
| import org.assertj.core.api.Assertions.assertThat | ||
| import org.junit.Before | ||
| import org.junit.Test | ||
| import org.junit.runner.RunWith | ||
| import org.mockito.Mock | ||
| import org.mockito.junit.MockitoJUnitRunner | ||
| import org.mockito.kotlin.KArgumentCaptor | ||
| import org.mockito.kotlin.any | ||
| import org.mockito.kotlin.argumentCaptor | ||
| import org.mockito.kotlin.eq | ||
| import org.mockito.kotlin.mock | ||
| import org.mockito.kotlin.whenever | ||
| import org.wordpress.android.fluxc.Dispatcher | ||
| import org.wordpress.android.fluxc.model.SiteModel | ||
| import org.wordpress.android.fluxc.network.BaseRequest.BaseNetworkError | ||
| import org.wordpress.android.fluxc.network.BaseRequest.GenericErrorType.NETWORK_ERROR | ||
| import org.wordpress.android.fluxc.network.UserAgent | ||
| import org.wordpress.android.fluxc.network.rest.wpcom.WPComGsonRequest.WPComGsonNetworkError | ||
| import org.wordpress.android.fluxc.network.rest.wpcom.WPComGsonRequestBuilder | ||
| import org.wordpress.android.fluxc.network.rest.wpcom.WPComGsonRequestBuilder.Response | ||
| import org.wordpress.android.fluxc.network.rest.wpcom.WPComGsonRequestBuilder.Response.Success | ||
| import org.wordpress.android.fluxc.network.rest.wpcom.auth.AccessToken | ||
| import org.wordpress.android.fluxc.network.rest.wpcom.stats.subscribers.SubscribersRestClient.SubscribersResponse | ||
| import org.wordpress.android.fluxc.network.utils.StatsGranularity | ||
| import org.wordpress.android.fluxc.network.utils.StatsGranularity.DAYS | ||
| import org.wordpress.android.fluxc.network.utils.StatsGranularity.MONTHS | ||
| import org.wordpress.android.fluxc.network.utils.StatsGranularity.WEEKS | ||
| import org.wordpress.android.fluxc.network.utils.StatsGranularity.YEARS | ||
| import org.wordpress.android.fluxc.store.StatsStore.StatsErrorType.API_ERROR | ||
| import org.wordpress.android.fluxc.test | ||
|
|
||
| @RunWith(MockitoJUnitRunner::class) | ||
| class SubscribersRestClientTest { | ||
| @Mock | ||
| private lateinit var dispatcher: Dispatcher | ||
|
|
||
| @Mock | ||
| private lateinit var wpComGsonRequestBuilder: WPComGsonRequestBuilder | ||
|
|
||
| @Mock | ||
| private lateinit var site: SiteModel | ||
|
|
||
| @Mock | ||
| private lateinit var requestQueue: RequestQueue | ||
|
|
||
| @Mock | ||
| private lateinit var accessToken: AccessToken | ||
|
|
||
| @Mock | ||
| private lateinit var userAgent: UserAgent | ||
| private lateinit var urlCaptor: KArgumentCaptor<String> | ||
| private lateinit var paramsCaptor: KArgumentCaptor<Map<String, String>> | ||
| private lateinit var restClient: SubscribersRestClient | ||
| private val siteId = 12L | ||
| private val quantity = 30 | ||
| private val currentDateValue = "2022-10-10" | ||
|
|
||
| @Before | ||
| fun setUp() { | ||
| urlCaptor = argumentCaptor() | ||
| paramsCaptor = argumentCaptor() | ||
| restClient = SubscribersRestClient( | ||
| dispatcher, | ||
| wpComGsonRequestBuilder, | ||
| null, | ||
| requestQueue, | ||
| accessToken, userAgent | ||
| ) | ||
| } | ||
|
|
||
| @Test | ||
| fun `returns subscribers per day success response`() = test { testSuccessResponse(DAYS) } | ||
|
|
||
| @Test | ||
| fun `returns subscribers per day error response`() = test { testErrorResponse(DAYS) } | ||
|
|
||
| @Test | ||
| fun `returns subscribers per week success response`() = test { testSuccessResponse(WEEKS) } | ||
|
|
||
| @Test | ||
| fun `returns subscribers per week error response`() = test { testErrorResponse(WEEKS) } | ||
|
|
||
| @Test | ||
| fun `returns subscribers per month success response`() = test { testSuccessResponse(MONTHS) } | ||
|
|
||
| @Test | ||
| fun `returns subscribers per month error response`() = test { testErrorResponse(MONTHS) } | ||
|
|
||
| @Test | ||
| fun `returns subscribers per year success response`() = test { testSuccessResponse(YEARS) } | ||
|
|
||
| @Test | ||
| fun `returns subscribers per year error response`() = test { testErrorResponse(YEARS) } | ||
|
|
||
| private suspend fun testSuccessResponse(granularity: StatsGranularity) { | ||
| val response = mock<SubscribersResponse>() | ||
| initSubscribersResponse(response) | ||
|
|
||
| val responseModel = restClient.fetchSubscribers(site, granularity, quantity, currentDateValue, false) | ||
|
|
||
| assertThat(responseModel.response).isNotNull() | ||
| assertThat(responseModel.response).isEqualTo(response) | ||
| assertThat(urlCaptor.lastValue) | ||
| .isEqualTo("https://public-api.wordpress.com/rest/v1.1/sites/12/stats/subscribers/") | ||
| assertThat(paramsCaptor.lastValue).isEqualTo( | ||
| mapOf("quantity" to quantity.toString(), "unit" to granularity.toString(), "date" to currentDateValue) | ||
| ) | ||
| } | ||
|
|
||
| private suspend fun testErrorResponse(period: StatsGranularity) { | ||
| val errorMessage = "message" | ||
| initSubscribersResponse( | ||
| error = WPComGsonNetworkError(BaseNetworkError(NETWORK_ERROR, errorMessage, VolleyError(errorMessage))) | ||
| ) | ||
|
|
||
| val responseModel = restClient.fetchSubscribers(site, period, quantity, currentDateValue, false) | ||
|
|
||
| assertThat(responseModel.error).isNotNull() | ||
| assertThat(responseModel.error.type).isEqualTo(API_ERROR) | ||
| assertThat(responseModel.error.message).isEqualTo(errorMessage) | ||
| } | ||
|
|
||
| private suspend fun initSubscribersResponse( | ||
| data: SubscribersResponse? = null, | ||
| error: WPComGsonNetworkError? = null | ||
| ) = initResponse(SubscribersResponse::class.java, data ?: mock(), error) | ||
|
|
||
| private suspend fun <T> initResponse( | ||
| clazz: Class<T>, | ||
| data: T, | ||
| error: WPComGsonNetworkError? = null, | ||
| cachingEnabled: Boolean = false | ||
| ): Response<T> { | ||
| val response = if (error != null) Response.Error(error) else Success(data) | ||
| whenever( | ||
| wpComGsonRequestBuilder.syncGetRequest( | ||
| eq(restClient), | ||
| urlCaptor.capture(), | ||
| paramsCaptor.capture(), | ||
| eq(clazz), | ||
| eq(cachingEnabled), | ||
| any(), | ||
| eq(false) | ||
| ) | ||
| ).thenReturn(response) | ||
| whenever(site.siteId).thenReturn(siteId) | ||
| return response | ||
| } | ||
| } |
76 changes: 76 additions & 0 deletions
76
...le/src/test/java/org/wordpress/android/fluxc/persistance/stats/SubscribersSqlUtilsTest.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| package org.wordpress.android.fluxc.persistance.stats | ||
|
|
||
| import org.junit.Before | ||
| import org.junit.Test | ||
| import org.junit.runner.RunWith | ||
| import org.mockito.Mock | ||
| import org.mockito.junit.MockitoJUnitRunner | ||
| import org.mockito.kotlin.eq | ||
| import org.mockito.kotlin.isNull | ||
| import org.mockito.kotlin.verify | ||
| import org.mockito.kotlin.whenever | ||
| import org.wordpress.android.fluxc.model.SiteModel | ||
| import org.wordpress.android.fluxc.network.rest.wpcom.stats.subscribers.SubscribersRestClient.SubscribersResponse | ||
| import org.wordpress.android.fluxc.network.rest.wpcom.stats.time.StatsUtils | ||
| import org.wordpress.android.fluxc.network.utils.StatsGranularity.DAYS | ||
| import org.wordpress.android.fluxc.network.utils.StatsGranularity.MONTHS | ||
| import org.wordpress.android.fluxc.network.utils.StatsGranularity.WEEKS | ||
| import org.wordpress.android.fluxc.network.utils.StatsGranularity.YEARS | ||
| import org.wordpress.android.fluxc.persistence.StatsRequestSqlUtils | ||
| import org.wordpress.android.fluxc.persistence.StatsSqlUtils | ||
| import org.wordpress.android.fluxc.persistence.StatsSqlUtils.BlockType.SUBSCRIBERS | ||
| import org.wordpress.android.fluxc.persistence.StatsSqlUtils.StatsType.DAY | ||
| import org.wordpress.android.fluxc.persistence.StatsSqlUtils.StatsType.MONTH | ||
| import org.wordpress.android.fluxc.persistence.StatsSqlUtils.StatsType.WEEK | ||
| import org.wordpress.android.fluxc.persistence.StatsSqlUtils.StatsType.YEAR | ||
| import org.wordpress.android.fluxc.persistence.TimeStatsSqlUtils.SubscribersSqlUtils | ||
| import org.wordpress.android.fluxc.store.stats.subscribers.SUBSCRIBERS_RESPONSE | ||
| import java.util.Date | ||
| import kotlin.test.assertEquals | ||
|
|
||
| private val DATE = Date(0) | ||
| private const val DATE_VALUE = "2024-04-22" | ||
|
|
||
| @RunWith(MockitoJUnitRunner::class) | ||
| class SubscribersSqlUtilsTest { | ||
| @Mock | ||
| lateinit var statsSqlUtils: StatsSqlUtils | ||
|
|
||
| @Mock | ||
| lateinit var site: SiteModel | ||
|
|
||
| @Mock | ||
| lateinit var statsUtils: StatsUtils | ||
|
|
||
| @Mock | ||
| lateinit var statsRequestSqlUtils: StatsRequestSqlUtils | ||
| private lateinit var timeStatsSqlUtils: SubscribersSqlUtils | ||
| private val mappedTypes = mapOf(DAY to DAYS, WEEK to WEEKS, MONTH to MONTHS, YEAR to YEARS) | ||
|
|
||
| @Before | ||
| fun setUp() { | ||
| timeStatsSqlUtils = SubscribersSqlUtils(statsSqlUtils, statsUtils, statsRequestSqlUtils) | ||
| whenever(statsUtils.getFormattedDate(eq(DATE), isNull())).thenReturn(DATE_VALUE) | ||
| } | ||
|
|
||
| @Test | ||
| fun `returns data from stats utils`() { | ||
| mappedTypes.forEach { (statsType, dbGranularity) -> | ||
| whenever(statsSqlUtils.select(site, SUBSCRIBERS, statsType, SubscribersResponse::class.java, DATE_VALUE)) | ||
| .thenReturn(SUBSCRIBERS_RESPONSE) | ||
|
|
||
| val result = timeStatsSqlUtils.select(site, dbGranularity, DATE) | ||
|
|
||
| assertEquals(result, SUBSCRIBERS_RESPONSE) | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| fun `inserts data to stats utils`() { | ||
| mappedTypes.forEach { (statsType, dbGranularity) -> | ||
| timeStatsSqlUtils.insert(site, SUBSCRIBERS_RESPONSE, dbGranularity, DATE) | ||
|
|
||
| verify(statsSqlUtils).insert(site, SUBSCRIBERS, statsType, SUBSCRIBERS_RESPONSE, true, DATE_VALUE) | ||
| } | ||
| } | ||
| } |
16 changes: 16 additions & 0 deletions
16
.../src/test/java/org/wordpress/android/fluxc/store/stats/subscribers/SubscribersFixtures.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| package org.wordpress.android.fluxc.store.stats.subscribers | ||
|
|
||
| import org.wordpress.android.fluxc.model.stats.subscribers.SubscribersModel | ||
| import org.wordpress.android.fluxc.model.stats.subscribers.SubscribersModel.PeriodData | ||
| import org.wordpress.android.fluxc.network.rest.wpcom.stats.subscribers.SubscribersRestClient.SubscribersResponse | ||
| import org.wordpress.android.fluxc.store.StatsStore.StatsError | ||
| import org.wordpress.android.fluxc.store.StatsStore.StatsErrorType.INVALID_RESPONSE | ||
|
|
||
| val SUBSCRIBERS_RESPONSE = SubscribersResponse( | ||
| "2024-04-22", | ||
| "day", | ||
| listOf("period", "subscribers"), | ||
| listOf(listOf("2024-04-21", "10")) | ||
| ) | ||
| val SUBSCRIBERS_MODEL = SubscribersModel("2018-04-22", listOf(PeriodData("2024-04-22", 10))) | ||
| val INVALID_DATA_ERROR = StatsError(INVALID_RESPONSE, "Subscribers: Required data 'period' or 'dates' missing") |
Oops, something went wrong.