Add getVersion function

Author: sylux6

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

@@ -1,6 +1,7 @@
 package com.github.azurapi.azurapikotlin.api
 
 import com.github.azurapi.azurapikotlin.internal.entities.Ship
+import com.github.azurapi.azurapikotlin.internal.entities.Version
 import com.github.azurapi.azurapikotlin.internal.exceptions.DatabaseException
 import com.github.azurapi.azurapikotlin.internal.exceptions.ShipNotFoundException
 import com.github.azurapi.azurapikotlin.internal.exceptions.ApiException
@@ -59,4 +60,13 @@ object Atago {
     fun getAllShips(): List<Ship> {
         return database.shipsById.values.stream().collect(Collectors.toList())
     }
+
+    /**
+     * @since 1.0.0
+     *
+     * Get version of the api wrapper
+     */
+    fun getVersion(): Version {
+        return Version(AtagoInfo.VERSION, database.lastUpdated, database.databaseVersion, database.lastUpdatedDatabase)
+    }
 }

src/main/kotlin/com/github/azurapi/azurapikotlin/internal/entities/Version.kt

@@ -0,0 +1,17 @@
+package com.github.azurapi.azurapikotlin.internal.entities
+
+import java.util.*
+
+/**
+ * Version representation
+ * @param apiVersion api version
+ * @param lastUpdatedApi last time database has been reloaded
+ * @param databaseVersion json version
+ * @param lastUpdatedDatabase last time json has been refreshed
+ */
+data class Version (
+    val apiVersion: String,
+    val lastUpdatedApi: Date,
+    val databaseVersion: String,
+    val lastUpdatedDatabase: Date
+)

src/main/kotlin/com/github/azurapi/azurapikotlin/json/Takao.kt

@@ -1,31 +1,39 @@
 package com.github.azurapi.azurapikotlin.json
 
-import com.github.kittinunf.fuel.httpGet
-import com.github.kittinunf.fuel.json.responseJson
 import com.github.azurapi.azurapikotlin.internal.entities.Ship
 import com.github.azurapi.azurapikotlin.internal.exceptions.DatabaseException
 import com.github.azurapi.azurapikotlin.utils.ShipParser
+import com.github.kittinunf.fuel.httpGet
+import com.github.kittinunf.fuel.json.responseJson
 import info.debatty.java.stringsimilarity.Cosine
-import info.debatty.java.stringsimilarity.Levenshtein
-import info.debatty.java.stringsimilarity.NormalizedLevenshtein
 import org.json.JSONObject
+import java.util.*
+import kotlin.collections.HashMap
 
 /**
- * JSON deserializer object
+ * JSON deserializer object.
+ * THIS CLASS IS NOT MEANT TO BE USED, USE ATAGO INSTEAD.
  * @throws DatabaseException
  */
 class Takao {
 
     private lateinit var jsonDatabase: JSONObject
+    private lateinit var jsonVersion: JSONObject
+
+    var lastUpdated: Date
+    lateinit var lastUpdatedDatabase: Date
+    lateinit var databaseVersion: String
+
     var shipsById = HashMap<String, Ship>()
     var shipsByName = HashMap<String, Ship>()
 
     init {
         loadDatabase()
+        lastUpdated = Date()
     }
 
-    fun loadJSON(): JSONObject {
-        val (_, response, result) = TakaoInfo.JSON_SOURCE
+    private fun loadJSON(url: String): JSONObject {
+        val (_, response, result) = url
             .httpGet()
             .responseJson()
         return if (response.statusCode == 200) {
@@ -35,14 +43,18 @@ class Takao {
         }
     }
 
-    private fun loadDatabase() {
+    fun loadDatabase() {
+        lastUpdated = Date()
         try {
-            jsonDatabase = loadJSON()
+            jsonDatabase = loadJSON(TakaoInfo.JSON_SOURCE)
+            jsonVersion = loadJSON(TakaoInfo.JSON_VERSION)
             for (shipId in jsonDatabase.keySet()) {
                 val ship = ShipParser.jsonToShip(jsonDatabase.getJSONObject(shipId), shipId)
                 shipsById[ship.id.toLowerCase()] = ship
                 shipsByName[ship.names.en.toLowerCase()] = ship
             }
+            databaseVersion = jsonVersion.getInt("version-number").toString()
+            lastUpdatedDatabase = Date(jsonVersion.getLong("last-data-refresh-date"))
         } catch (e: Exception) {
             throw DatabaseException("Could not reload database: (${e.message})")
         }

src/main/kotlin/com/github/azurapi/azurapikotlin/json/TakaoInfo.kt

@@ -4,6 +4,6 @@ package com.github.azurapi.azurapikotlin.json
  * JSON deserializer info
  */
 object TakaoInfo {
-    const val VERSION = "1.0.0"
     const val JSON_SOURCE = "https://raw.githubusercontent.com/AzurAPI/azurapi-js-setup/master/ships.json"
+    const val JSON_VERSION = "https://raw.githubusercontent.com/AzurAPI/azurapi-js-setup/master/version-info.json"
 }

src/test/kotlin/com/github/azurapi/azurapikotlin/api/AtagoTestCase.kt

@@ -1,9 +1,7 @@
 package com.github.azurapi.azurapikotlin.api
 
-import info.debatty.java.stringsimilarity.Cosine
-import info.debatty.java.stringsimilarity.Levenshtein
 import io.kotlintest.TestCase
-import io.kotlintest.matchers.boolean.shouldBeTrue
+import io.kotlintest.matchers.types.shouldNotBeNull
 import io.kotlintest.shouldBe
 import io.kotlintest.specs.StringSpec
 
@@ -29,5 +27,17 @@ class AtagoTestCase : StringSpec() {
             Atago.getShipByName("Jeanne d'Arc").names.en.shouldBe("Jeanne d'Arc")
             Atago.getShipByName("jeanne").names.en.shouldBe("Jeanne d'Arc")
         }
+
+        "it should return Atago by her id" {
+            Atago.getShipById("201").names.en.shouldBe("Atago")
+        }
+
+        "it should return a Version object of the api" {
+            val version = Atago.getVersion()
+            version.databaseVersion.shouldNotBeNull()
+            version.lastUpdatedApi.shouldNotBeNull()
+            version.lastUpdatedDatabase.shouldNotBeNull()
+            version.apiVersion.shouldNotBeNull()
+        }
     }
 }