Basic API functions

Author: sung

.github/workflows/gradle.yml

@@ -13,6 +13,6 @@ jobs:
       uses: actions/setup-java@v1
       with:
         java-version: 1.8
-    - name: Build with Gradle
+    - name: Build and test with Gradle
       run: |
         gradle clean test

README.md

@@ -1,2 +1,5 @@
 # AzurApi-Kotlin
 A Kotlin wrapper for Azur Lane JSON
+
+## Support server
+![Discord Banner 2](https://discordapp.com/api/guilds/648206344729526272/widget.png?style=banner2)

build.gradle.kts

@@ -1,9 +1,12 @@
+val kotlinVersion = "1.3.61"
+val fuelVersion = "2.2.1"
+val kotlintestVersion = "3.4.2"
+
 plugins {
-    `build-scan`
     kotlin("jvm") version "1.3.61"
 }
 
-group = "com.github.sylux6.azurapikotlin"
+group = "com.github.azurapi.azurapikotlin"
 version = "v1.0.0"
 
 repositories {
@@ -13,17 +16,15 @@ repositories {
 
 dependencies {
     implementation(kotlin("stdlib-jdk8"))
-    testImplementation("org.junit.jupiter:junit-jupiter:5.5.2")
-    implementation("com.github.kittinunf.fuel:fuel:2.2.1")
-    implementation("com.github.kittinunf.fuel:fuel-json:2.2.1")
+    implementation("com.github.kittinunf.fuel:fuel:$fuelVersion")
+    implementation("com.github.kittinunf.fuel:fuel-json:$fuelVersion")
     implementation("org.json", "json", "20190722")
+
+    testImplementation("io.kotlintest:kotlintest-runner-junit5:$kotlintestVersion")
 }
 
-tasks.test {
+tasks.withType<Test> {
     useJUnitPlatform()
-    testLogging {
-        events("passed", "skipped", "failed")
-    }
 }
 
 tasks {
@@ -33,11 +34,4 @@ tasks {
     compileTestKotlin {
         kotlinOptions.jvmTarget = "1.8"
     }
-}
-
-buildScan {
-    termsOfServiceUrl = "https://gradle.com/terms-of-service"
-    termsOfServiceAgree = "yes"
-
-    publishAlways()
 }

src/main/kotlin/com/github/azurapi/azurapikotlin/api/Atago.kt

@@ -0,0 +1,62 @@
+package com.github.azurapi.azurapikotlin.api
+
+import com.github.azurapi.azurapikotlin.internal.entities.Ship
+import com.github.azurapi.azurapikotlin.internal.exceptions.DatabaseException
+import com.github.azurapi.azurapikotlin.internal.exceptions.ShipNotFoundException
+import com.github.azurapi.azurapikotlin.internal.exceptions.ApiException
+import com.github.azurapi.azurapikotlin.json.Takao
+import java.util.stream.Collectors
+
+/**
+ * API class
+ * @throws ShipNotFoundException
+ * @throws DatabaseException
+ * @throws ApiException
+ */
+class Atago {
+
+    private val database = try {
+        Takao()
+    } catch (e: DatabaseException) {
+        throw DatabaseException(e.message ?: "")
+    }
+
+    /**
+     * @since 1.0.0
+     *
+     * Get information about a ship by name
+     * @param name name of the ship
+     */
+    fun getShipByName(name: String): Ship {
+        val formattedName = name.toLowerCase()
+        if (database.shipsByName.containsKey(formattedName)) {
+            return database.shipsByName[formattedName]!!
+        } else {
+            throw ShipNotFoundException("Could not find ship with name: $name")
+        }
+    }
+
+    /**
+     * @since 1.0.0
+     *
+     * Get information about a ship by id
+     * @param id id of the ship
+     */
+    fun getShipById(id: String): Ship {
+        val formattedId = id.toLowerCase()
+        if (database.shipsById.containsKey(formattedId)) {
+            return database.shipsById[formattedId]!!
+        } else {
+            throw ShipNotFoundException("Could not find ship with id: $id")
+        }
+    }
+
+    /**
+     * @since 1.0.0
+     *
+     * Get list of all ships
+     */
+    fun getAllShips(): List<Ship> {
+        return database.shipsById.values.stream().collect(Collectors.toList())
+    }
+}

src/main/kotlin/com/github/sylux6/azurapikotlin/api/AtagoInfo.kt renamed to src/main/kotlin/com/github/azurapi/azurapikotlin/api/AtagoInfo.kt

@@ -1,4 +1,4 @@
-package com.github.sylux6.azurapikotlin.api
+package com.github.azurapi.azurapikotlin.api
 
 /**
  * API info

src/main/kotlin/com/github/sylux6/azurapikotlin/internal/entities/Ship.kt renamed to src/main/kotlin/com/github/azurapi/azurapikotlin/internal/entities/Ship.kt

@@ -1,4 +1,4 @@
-package com.github.sylux6.azurapikotlin.internal.entities
+package com.github.azurapi.azurapikotlin.internal.entities
 
 /**
  * Stars of a ship
@@ -38,9 +38,9 @@ data class SkinInfo (
  */
 data class Skin (
         val image: String,
-        val background: String?,
+        val background: String,
         val name: String,
-        val chibi: String?,
+        val chibi: String,
         val info: SkinInfo?
 )
 
@@ -52,10 +52,10 @@ data class Skin (
  * @param cn chinese name
  */
 data class Name (
-        val jp: String?,
-        val kr: String?,
+        val jp: String,
+        val kr: String,
         val en: String,
-        val cn: String?
+        val cn: String
 )
 
 /**
@@ -97,9 +97,9 @@ data class StatsDetails (
  * @param base
  */
 data class Stats (
-        val level120: StatsDetails,
-        val level100: StatsDetails,
-        val base: StatsDetails
+    val level120: StatsDetails,
+    val level100: StatsDetails,
+    val base: StatsDetails
 )
 
 /**
@@ -121,11 +121,11 @@ data class Url (
  * @param pixiv
  */
 data class Miscellaneous (
-        val voice: String?,
-        val twitter: Url?,
-        val artist: String?,
-        val web: Url?,
-        val pixiv: Url?
+    val voice: String,
+    val twitter: Url?,
+    val artist: String?,
+    val web: Url?,
+    val pixiv: Url?
 )
 
 /**
@@ -145,18 +145,18 @@ data class Miscellaneous (
  * @param misc
  */
 data class Ship (
-        val wikiUrl: String,
-        val id: String,
-        val names: Name,
-        val shipClass: String,
-        val nationality: String,
-        val hullType: String,
-        val thumbnail: String,
-        val skins: List<Skin>,
-        val buildTime: String,
-        val rarity: String,
-        val stars: Stars?,
-        val stats: Stats?,
-        val misc: Miscellaneous?
+    val wikiUrl: String,
+    val id: String,
+    val names: Name,
+    val shipClass: String,
+    val nationality: String,
+    val hullType: String,
+    val thumbnail: String,
+    val skins: List<Skin>,
+    val buildTime: String,
+    val rarity: String,
+    val stars: Stars?,
+    val stats: Stats?,
+    val misc: Miscellaneous?
 )
 

src/main/kotlin/com/github/azurapi/azurapikotlin/internal/exceptions/ApiException.kt

@@ -0,0 +1,4 @@
+package com.github.azurapi.azurapikotlin.internal.exceptions
+
+class ApiException(message: String = "") : Exception(message) {
+}

src/main/kotlin/com/github/azurapi/azurapikotlin/internal/exceptions/DatabaseException.kt

@@ -0,0 +1,6 @@
+package com.github.azurapi.azurapikotlin.internal.exceptions
+
+import java.lang.Exception
+
+class DatabaseException(message: String = "") : Exception(message) {
+}

src/main/kotlin/com/github/azurapi/azurapikotlin/internal/exceptions/ShipNotFoundException.kt

@@ -0,0 +1,4 @@
+package com.github.azurapi.azurapikotlin.internal.exceptions
+
+class ShipNotFoundException(message: String = "") : Exception(message) {
+}

src/main/kotlin/com/github/azurapi/azurapikotlin/internal/responses/ErrorResponse.kt

@@ -0,0 +1,4 @@
+package com.github.azurapi.azurapikotlin.internal.responses
+
+class ErrorResponse {
+}