Merge pull request #30 from Bram--/dev

Adds missing wishliscomment field to CollectionItem response object.
Bram-- · May 7, 2024 · 1f3cbde · 1f3cbde
2 parents e7507d3 + 297616d
commit 1f3cbde
Show file tree

Hide file tree

Showing 11 changed files with 17 additions and 17 deletions.
diff --git a/README.md b/README.md
@@ -25,7 +25,7 @@ using it is as simple as adding a single line to Gradle.
 ##### Gradle
 
 ```kotlin
-implementation("org.audux.bgg:bggclient:0.8.1")
+implementation("org.audux.bgg:bggclient:0.9.0")
 ```
 
 ##### Maven
@@ -35,7 +35,7 @@ implementation("org.audux.bgg:bggclient:0.8.1")
 <dependency>
     <groupId>org.audux.bgg</groupId>
     <artifactId>bggclient</artifactId>
-    <version>0.8.1</version>
+    <version>0.9.0</version>
 </dependency>
 ```
 

diff --git a/build.gradle.kts b/build.gradle.kts
@@ -23,7 +23,7 @@ publishing {
         create<MavenPublication>("mavenJava") {
             groupId = "org.audux.bgg"
             artifactId = "bggclient"
-            version = "0.8.1"
+            version = "0.9.0"
 
             pom {
                 name = "Unofficial JVM BGG client"

diff --git a/examples/android/app/build.gradle.kts b/examples/android/app/build.gradle.kts
@@ -68,7 +68,7 @@ dependencies {
     implementation("androidx.lifecycle:lifecycle-runtime-ktx:2.7.0")
     implementation("androidx.lifecycle:lifecycle-viewmodel-compose:2.7.0")
     implementation("io.coil-kt:coil-compose:2.5.0")
-    implementation("org.audux.bgg:bggclient:0.8.1")
+    implementation("org.audux.bgg:bggclient:0.9.0")
 
     testImplementation("junit:junit:4.13.2")
 

diff --git a/examples/java/build.gradle.kts b/examples/java/build.gradle.kts
@@ -12,7 +12,7 @@ repositories {
 }
 
 dependencies {
-    implementation("org.audux.bgg:bggclient:0.8.1")
+    implementation("org.audux.bgg:bggclient:0.9.0")
 
     testImplementation(platform("org.junit:junit-bom:5.9.1"))
     testImplementation("org.junit.jupiter:junit-jupiter")

diff --git a/examples/paginate/build.gradle.kts b/examples/paginate/build.gradle.kts
@@ -20,7 +20,7 @@ application {
 }
 
 dependencies {
-    implementation("org.audux.bgg:bggclient:0.8.1")
+    implementation("org.audux.bgg:bggclient:0.9.0")
 
     testImplementation("org.jetbrains.kotlin:kotlin-test")
 }

diff --git a/src/main/kotlin/org/audux/bgg/BggClient.kt b/src/main/kotlin/org/audux/bgg/BggClient.kt
@@ -184,7 +184,7 @@ object BggClient {
     @JvmOverloads
     fun collection(
         userName: String,
-        subType: ThingType,
+        subType: ThingType? = null,
         excludeSubType: ThingType? = null,
         ids: Array<Int>? = null,
         version: Boolean = false,

diff --git a/src/main/kotlin/org/audux/bgg/request/Collection.kt b/src/main/kotlin/org/audux/bgg/request/Collection.kt
@@ -59,7 +59,7 @@ import org.audux.bgg.response.Response
 /** @see org.audux.bgg.BggClient.collection */
 internal fun InternalBggClient.collection(
     userName: String,
-    subType: ThingType,
+    subType: ThingType?,
     excludeSubType: ThingType?,
     ids: Array<Int>?,
     version: Boolean,
@@ -94,7 +94,7 @@ internal fun InternalBggClient.collection(
                 appendPathSegments(PATH_COLLECTION)
                 parameters.apply {
                     append(PARAM_USERNAME, userName)
-                    append(PARAM_SUBTYPE, subType.param)
+                    subType?.let { append(PARAM_SUBTYPE, it.param) }
 
                     excludeSubType?.let { append(PARAM_EXCLUDE_SUBTYPE, it.param) }
                     ids?.let { append(PARAM_ID, it.joinToString(",")) }

diff --git a/src/main/kotlin/org/audux/bgg/response/Collection.kt b/src/main/kotlin/org/audux/bgg/response/Collection.kt
@@ -79,6 +79,9 @@ data class CollectionItem(
     /** Comment owner/user left on the collection item. */
     val comment: String? = null,
 
+    /** Comment owner/user left on the wishlist item. */
+    val wishlistComment: String? = null,
+
     /** Text user left on the condition of the item. */
     val conditionText: String? = null,
 

diff --git a/src/test/java/org/audux/bgg/BggClientJavaTest.java b/src/test/java/org/audux/bgg/BggClientJavaTest.java
@@ -52,7 +52,7 @@ public void collectionRequest()
     BggClient.setEngine(
         () -> setupMockEngine("collection?username=novaeux&stats=1&subtype=rpgitem"));
 
-    var future = BggClient.collection("Novaeux", ThingType.BOARD_GAME).callAsync();
+    var future = BggClient.collection("Novaeux", ThingType.RPG_ITEM).callAsync();
     var response = future.get(5_000, MILLISECONDS);
 
     assertThat(response.getError()).isNull();
@@ -84,6 +84,7 @@ public void collectionRequest()
                 /* numPlays= */ 0,
                 /* comment= */ null,
                 /* conditionText= */ null,
+                /* wishlistComment= */ null,
                 new CollectionStatistics(
                     /* minimumPlayer= */ null,
                     /* maximumPlayers= */ null,

diff --git a/src/test/kotlin/org/audux/bgg/request/CollectionRequestTest.kt b/src/test/kotlin/org/audux/bgg/request/CollectionRequestTest.kt
@@ -78,8 +78,7 @@ class CollectionRequestTest {
                 TestUtils.setupMockEngine("collection?username=novaeux&stats=1&subtype=rpgitem")
             BggClient.engine = { engine }
 
-            val response =
-                BggClient.collection(userName = "Noveaux", subType = ThingType.RPG_ITEM).call()
+            val response = BggClient.collection(userName = "Noveaux").call()
 
             val request = engine.requestHistory[0]
             assertThat(engine.requestHistory).hasSize(1)
@@ -92,11 +91,7 @@ class CollectionRequestTest {
                     }
                 )
             assertThat(request.url)
-                .isEqualTo(
-                    Url(
-                        "https://boardgamegeek.com/xmlapi2/collection?username=Noveaux&subtype=rpgitem"
-                    )
-                )
+                .isEqualTo(Url("https://boardgamegeek.com/xmlapi2/collection?username=Noveaux"))
             assertThat(response.isError()).isFalse()
             assertThat(response.isSuccess()).isTrue()
             assertThat(response.data!!.items).hasSize(1)

diff --git a/...llection?username=novaeux&stats=1&subtype=boardgame&excludesubtype=boardgameexpansion.xml b/...llection?username=novaeux&stats=1&subtype=boardgame&excludesubtype=boardgameexpansion.xml
@@ -1295,6 +1295,7 @@
             wanttoplay="0"
             wishlist="1"
             wishlistpriority="3" />
+        <wishlistcomment>Testing 1...2...3..</wishlistcomment>
         <numplays>0</numplays>
     </item>
     <item