Merge pull request #4 from RoavaDev/inventory-api

Inventory API implementation

src/main/kotlin/dev/roava/api/InventoryApi.kt

@@ -0,0 +1,38 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2023 RoavaDev
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package dev.roava.api
+
+import dev.roava.json.inventory.ItemListData
+import retrofit2.Call
+import retrofit2.http.GET
+import retrofit2.http.Path
+
+interface InventoryApi {
+    @GET("/v1/users/{userId}/items/{itemType}/{itemId}")
+    fun getUserItems(@Path("userId") userId: Long, @Path("itemType") itemType: String, @Path("itemId") itemId: Long): Call<ItemListData>
+
+    @GET("/v1/users/{userId}/items/{itemType}/{itemId}/is-owned")
+    fun getIsOwned(@Path("userId") userId: Long, @Path("itemType") itemType: String, @Path("itemId") itemId: Long): Call<Boolean>
+}

src/main/kotlin/dev/roava/json/inventory/ItemData.kt

@@ -0,0 +1,40 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2023 RoavaDev
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package dev.roava.json.inventory
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties
+import com.fasterxml.jackson.annotation.JsonProperty
+
+@JsonIgnoreProperties(ignoreUnknown = true)
+data class ItemData(
+    @JsonProperty("type")
+    val type: String,
+    @JsonProperty("id")
+    val id: Long,
+    @JsonProperty("name")
+    val name: String,
+    @JsonProperty("instanceId")
+    val instanceId: Long
+)

src/main/kotlin/dev/roava/json/inventory/ItemListData.kt

@@ -0,0 +1,34 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2023 RoavaDev
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package dev.roava.json.inventory
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties
+import com.fasterxml.jackson.annotation.JsonProperty
+
+@JsonIgnoreProperties(ignoreUnknown = true)
+data class ItemListData(
+    @JsonProperty("data")
+    val items: List<ItemData>
+)

src/main/kotlin/dev/roava/user/User.kt

@@ -26,6 +26,7 @@ package dev.roava.user
 
 import dev.roava.api.FriendApi
 import dev.roava.api.GroupApi
+import dev.roava.api.InventoryApi
 import dev.roava.api.UserApi
 import dev.roava.client.RoavaRequest
 import dev.roava.group.Group
@@ -184,4 +185,23 @@ class User {
 
         return false
     }
+
+    /**
+     * Method to get if a User has a gamepass
+     *
+     * @param[gamepassId] The gamepass's ID
+     * @throws[RuntimeException]
+     * @return[Boolean]
+     */
+    @Throws(RuntimeException::class)
+    fun hasGamepass(gamepassId: Long) = runCatching {
+        val gamepasses = request.createRequest(InventoryApi::class.java, "inventory")
+            .getIsOwned(id, "gamepass", gamepassId)
+            .execute()
+            .body()
+
+        gamepasses ?: false
+    }.getOrElse {
+        throw RuntimeException("Could not fetch the user's items!")
+    }
 }

src/test/kotlin/dev/roava/user/UserTest.kt

@@ -79,4 +79,11 @@ internal class UserTest {
     fun isInGroup() {
         assertTrue(testUser.isInGroup(15771240))
     }
+
+    @Test
+    fun hasGamepass() {
+        val user = User(72242614)
+
+        assertTrue(user.hasGamepass(13827472))
+    }
 }