v1.1.0: add totalItems and totalPages to the Page object.

CHANGELOG.md

@@ -1,4 +1,7 @@
 # Changelog
 
+## v1.1.0 (2019-08-18)
+Add `totalItems` and `totalPages` to the `Page` object.
+
 ## v1.0.0 (2019-08-04)
 Initial release.

README.md

@@ -20,7 +20,7 @@ repositories {
 ```groovy
 dependencies {
     /* ... */
-    implementation 'org.jraf:klibqonto:1.0.0'
+    implementation 'org.jraf:klibqonto:1.1.0'
 }
 ```
 

build.gradle

@@ -15,7 +15,7 @@ buildscript {
 
 allprojects {
     group = 'org.jraf'
-    version = '1.0.0'
+    version = '1.1.0'
 
     repositories.addRepos()
 

library/src/main/kotlin/org/jraf/klibqonto/internal/api/model/pagination/HasApiMetaConverter.kt

@@ -31,9 +31,11 @@ import org.jraf.klibqonto.model.pagination.Pagination
 internal object HasApiMetaConverter {
     fun <MODEL> convert(hasApiMeta: HasApiMeta, list: List<MODEL>): Page<MODEL> {
         return PageImpl(
-            list = list,
+            items = list,
             nextPagination = hasApiMeta.meta.next_page?.let { Pagination(it, hasApiMeta.meta.per_page) },
-            previousPagination = hasApiMeta.meta.prev_page?.let { Pagination(it, hasApiMeta.meta.per_page) }
+            previousPagination = hasApiMeta.meta.prev_page?.let { Pagination(it, hasApiMeta.meta.per_page) },
+            totalPages = hasApiMeta.meta.total_pages,
+            totalItems = hasApiMeta.meta.total_count
         )
     }
 }

library/src/main/kotlin/org/jraf/klibqonto/internal/model/pagination/PageImpl.kt

@@ -28,7 +28,9 @@ import org.jraf.klibqonto.model.pagination.Page
 import org.jraf.klibqonto.model.pagination.Pagination
 
 internal data class PageImpl<out T>(
-    override val list: List<T>,
+    override val items: List<T>,
     override val nextPagination: Pagination?,
-    override val previousPagination: Pagination?
+    override val previousPagination: Pagination?,
+    override val totalPages: Int,
+    override val totalItems: Int
 ) : Page<T>

library/src/main/kotlin/org/jraf/klibqonto/model/pagination/Page.kt

@@ -24,8 +24,32 @@
 
 package org.jraf.klibqonto.model.pagination
 
+/**
+ * A page of results.
+ */
 interface Page<out T> {
-    val list: List<T>
+    /**
+     * The actual items of the results.
+     */
+    val items: List<T>
+
+    /**
+     * Next [Pagination] (if any), that can be used to retrieve the next page.
+     */
     val nextPagination: Pagination?
+
+    /**
+     * Previous [Pagination] (if any), that can be used to retrieve the previous page.
+     */
     val previousPagination: Pagination?
+
+    /**
+     * Total number of pages (depends on the number of items per page).
+     */
+    val totalPages: Int
+
+    /**
+     * Total number of items.
+     */
+    val totalItems: Int
 }

sample/src/main/java/org/jraf/klibqonto/sample/BlockingSample.java

@@ -86,12 +86,12 @@ private void main() {
         // Get first page of memberships
         System.out.println("\n\nMemberships:");
         Page<Membership> membershipList = client.getMemberships().getMembershipList(new Pagination());
-        System.out.println(asLines(membershipList.getList()));
+        System.out.println(asLines(membershipList.getItems()));
 
         // Get first page of labels
         System.out.println("\n\nLabels:");
         Page<Label> labels = client.getLabels().getLabelList(new Pagination());
-        System.out.println(asLines(labels.getList()));
+        System.out.println(asLines(labels.getItems()));
 
         // Get first 2 pages of transactions
         System.out.println("\n\nTransactions:");
@@ -119,7 +119,7 @@ private List<Transaction> getTransactionList(Organization organization) {
                 QontoClient.Transactions.SortOrder.DESCENDING,
                 new Pagination(0, 10)
         );
-        ArrayList<Transaction> list = new ArrayList<>(firstPage.getList());
+        ArrayList<Transaction> list = new ArrayList<>(firstPage.getItems());
 
         // 2/ Get next page of transactions (if any)
         Pagination nextPagination = firstPage.getNextPagination();
@@ -133,7 +133,7 @@ private List<Transaction> getTransactionList(Organization organization) {
                     QontoClient.Transactions.SortOrder.DESCENDING,
                     nextPagination
             );
-            list.addAll(secondPage.getList());
+            list.addAll(secondPage.getItems());
         }
         return list;
     }

sample/src/main/java/org/jraf/klibqonto/sample/FutureSample.java

@@ -86,12 +86,12 @@ private void main() throws Exception {
         // Get first page of memberships
         System.out.println("\n\nMemberships:");
         Page<Membership> membershipList = client.getMemberships().getMembershipList(new Pagination()).get();
-        System.out.println(asLines(membershipList.getList()));
+        System.out.println(asLines(membershipList.getItems()));
 
         // Get first page of labels
         System.out.println("\n\nLabels:");
         Page<Label> labels = client.getLabels().getLabelList(new Pagination()).get();
-        System.out.println(asLines(labels.getList()));
+        System.out.println(asLines(labels.getItems()));
 
         // Get first 2 pages of transactions
         System.out.println("\n\nTransactions:");
@@ -119,7 +119,7 @@ private List<Transaction> getTransactionList(Organization organization) throws E
                 QontoClient.Transactions.SortOrder.DESCENDING,
                 new Pagination(0, 10)
         ).get();
-        ArrayList<Transaction> list = new ArrayList<>(firstPage.getList());
+        ArrayList<Transaction> list = new ArrayList<>(firstPage.getItems());
 
         // 2/ Get next page of transactions (if any)
         Pagination nextPagination = firstPage.getNextPagination();
@@ -133,7 +133,7 @@ private List<Transaction> getTransactionList(Organization organization) throws E
                     QontoClient.Transactions.SortOrder.DESCENDING,
                     nextPagination
             ).get();
-            list.addAll(secondPage.getList());
+            list.addAll(secondPage.getItems());
         }
         return list;
     }

sample/src/main/kotlin/org/jraf/klibqonto/sample/FlowSample.kt

@@ -114,14 +114,14 @@ object FlowSample {
     private suspend fun getMembershipList() {
         client.memberships.getMembershipList()
             .collect {
-                println(it.list.joinToString("\n"))
+                println(it.items.joinToString("\n"))
             }
     }
 
     private suspend fun getLabelList() {
         client.labels.getLabelList()
             .collect {
-                println(it.list.joinToString("\n"))
+                println(it.items.joinToString("\n"))
             }
     }
 
@@ -156,7 +156,7 @@ object FlowSample {
                     )
                 } ?: emptyFlow())
                     .map { nextPage ->
-                        firstPage.list + nextPage.list
+                        firstPage.items + nextPage.items
                     }
             }
             .onEach { transactionList ->

sample/src/main/kotlin/org/jraf/klibqonto/sample/Sample.kt

@@ -83,12 +83,12 @@ object Sample {
             // Get first page of memberships
             println("\n\nMemberships:")
             val membershipList = client.memberships.getMembershipList()
-            println(membershipList.list.joinToString("\n"))
+            println(membershipList.items.joinToString("\n"))
 
             // Get first page of labels
             println("\n\nLabels:")
             val labels = client.labels.getLabelList()
-            println(labels.list.joinToString("\n"))
+            println(labels.items.joinToString("\n"))
 
             // Get first 2 pages of transactions
             println("\n\nTransactions:")
@@ -115,7 +115,7 @@ object Sample {
             sortField = QontoClient.Transactions.SortField.UPDATED_DATE,
             pagination = Pagination(itemsPerPage = 10)
         )
-        val list = firstPage.list.toMutableList()
+        val list = firstPage.items.toMutableList()
 
         // 2/ Get next page of transactions (if any)
         firstPage.nextPagination?.let { nextPagination ->
@@ -126,7 +126,7 @@ object Sample {
                 sortField = QontoClient.Transactions.SortField.UPDATED_DATE,
                 pagination = nextPagination
             )
-            list += secondPage.list
+            list += secondPage.items
         }
         return list
     }