New RestClient class in the core module.

3 files changed, 339 insertions, 236 deletions

diff --git a/Module.md b/Module.md
index 4ffb485f..e7ec7753 100644
--- a/Module.md
+++ b/Module.md
@@ -98,6 +98,10 @@ Predictable state container based on Redux library.
 
 A set of components for creating multiplatform automatic JSON-RPC connectivity with a backend server.
 
+# Package pl.treksoft.kvision.rest
+
+RESTful API client with support for type-safe connectivity.
+
 # Package pl.treksoft.kvision.routing
 
 Simple and easy to use JavaScript router wrapper.
diff --git a/kvision-modules/kvision-remote/src/main/kotlin/pl/treksoft/kvision/remote/CallAgent.kt b/kvision-modules/kvision-remote/src/main/kotlin/pl/treksoft/kvision/remote/CallAgent.kt
index 924a84c1..64c257cd 100644
--- a/kvision-modules/kvision-remote/src/main/kotlin/pl/treksoft/kvision/remote/CallAgent.kt
+++ b/kvision-modules/kvision-remote/src/main/kotlin/pl/treksoft/kvision/remote/CallAgent.kt
@@ -21,18 +21,12 @@
  */
 package pl.treksoft.kvision.remote
 
-import kotlinx.serialization.DeserializationStrategy
-import kotlinx.serialization.DynamicObjectParser
 import kotlinx.serialization.ImplicitReflectionSerializer
-import kotlinx.serialization.SerializationStrategy
-import kotlinx.serialization.serializer
 import kotlinx.serialization.stringify
 import pl.treksoft.jquery.JQueryAjaxSettings
 import pl.treksoft.jquery.JQueryXHR
 import pl.treksoft.jquery.jQuery
-import pl.treksoft.kvision.remote.JSON.toObj
 import kotlin.js.Promise
-import kotlin.js.then
 import kotlin.js.undefined
 import kotlin.js.JSON as NativeJSON
 
@@ -147,234 +141,4 @@ open class CallAgent {
             })
         }
     }
-
-    /**
-     * Makes a remote call to the remote server.
-     * @param url an URL address
-     * @param data data to be sent
-     * @param deserializer a deserializer for the result value
-     * @param method a HTTP method
-     * @param contentType a content type of the request
-     * @param beforeSend a content type of the request
-     * @param transform a function to transform the result of the call
-     * @return a promise of the result
-     */
-    fun <T : Any> remoteCall(
-        url: String,
-        data: dynamic = null,
-        deserializer: DeserializationStrategy<T>,
-        method: HttpMethod = HttpMethod.GET,
-        contentType: String = "application/json",
-        beforeSend: ((JQueryXHR, JQueryAjaxSettings) -> Boolean)? = null,
-        transform: ((dynamic) -> dynamic)? = null
-    ): Promise<T> {
-        return remoteCall(url, data, method, contentType, beforeSend).then { result: dynamic ->
-            val transformed = if (transform != null) {
-                transform(result)
-            } else {
-                result
-            }
-            DynamicObjectParser().parse(transformed, deserializer)
-        }
-    }
-
-    /**
-     * Makes a remote call to the remote server.
-     * @param url an URL address
-     * @param serializer for the data
-     * @param data data to be sent
-     * @param method a HTTP method
-     * @param contentType a content type of the request
-     * @param beforeSend a content type of the request
-     * @return a promise of the result
-     */
-    fun <V : Any> remoteCall(
-        url: String,
-        serializer: SerializationStrategy<V>,
-        data: V,
-        method: HttpMethod = HttpMethod.GET,
-        contentType: String = "application/json",
-        beforeSend: ((JQueryXHR, JQueryAjaxSettings) -> Boolean)? = null
-    ): Promise<dynamic> {
-        return remoteCall(url, data.toObj(serializer), method, contentType, beforeSend)
-    }
-
-
-    /**
-     * Makes a remote call to the remote server.
-     * @param url an URL address
-     * @param serializer for the data
-     * @param data data to be sent
-     * @param deserializer a deserializer for the result value
-     * @param method a HTTP method
-     * @param contentType a content type of the request
-     * @param beforeSend a content type of the request
-     * @param transform a function to transform the result of the call
-     * @return a promise of the result
-     */
-    fun <T : Any, V : Any> remoteCall(
-        url: String,
-        serializer: SerializationStrategy<V>,
-        data: V,
-        deserializer: DeserializationStrategy<T>,
-        method: HttpMethod = HttpMethod.GET,
-        contentType: String = "application/json",
-        beforeSend: ((JQueryXHR, JQueryAjaxSettings) -> Boolean)? = null,
-        transform: ((dynamic) -> dynamic)? = null
-    ): Promise<T> {
-        return remoteCall(url, data.toObj(serializer), method, contentType, beforeSend).then { result: dynamic ->
-            val transformed = if (transform != null) {
-                transform(result)
-            } else {
-                result
-            }
-            DynamicObjectParser().parse(transformed, deserializer)
-        }
-    }
-
-    /**
-     * Helper inline function to automatically get deserializer for the result value with dynamic data.
-     * @param url an URL address
-     * @param data data to be sent
-     * @param method a HTTP method
-     * @param contentType a content type of the request
-     * @param beforeSend a content type of the request
-     * @param transform a function to transform the result of the call
-     * @return a promise of the result
-     */
-    @UseExperimental(ImplicitReflectionSerializer::class)
-    inline fun <reified T : Any> call(
-        url: String,
-        data: dynamic = null,
-        method: HttpMethod = HttpMethod.GET,
-        contentType: String = "application/json",
-        noinline beforeSend: ((JQueryXHR, JQueryAjaxSettings) -> Boolean)? = null,
-        noinline transform: ((dynamic) -> dynamic)? = null
-    ): Promise<T> {
-        return remoteCall(url, data, T::class.serializer(), method, contentType, beforeSend, transform)
-    }
-
-    /**
-     * Helper inline function to automatically get serializer for the data.
-     * @param url an URL address
-     * @param data data to be sent
-     * @param method a HTTP method
-     * @param contentType a content type of the request
-     * @param beforeSend a content type of the request
-     * @return a promise of the result
-     */
-    @UseExperimental(ImplicitReflectionSerializer::class)
-    inline fun <reified V : Any> call(
-        url: String,
-        data: V,
-        method: HttpMethod = HttpMethod.GET,
-        contentType: String = "application/json",
-        noinline beforeSend: ((JQueryXHR, JQueryAjaxSettings) -> Boolean)? = null
-    ): Promise<dynamic> {
-        return remoteCall(
-            url,
-            V::class.serializer(),
-            data,
-            method,
-            contentType,
-            beforeSend
-        )
-    }
-
-    /**
-     * Helper inline function to automatically get serializer for the data.
-     * @param url an URL address
-     * @param data data to be sent
-     * @param deserializer a deserializer for the result value
-     * @param method a HTTP method
-     * @param contentType a content type of the request
-     * @param beforeSend a content type of the request
-     * @param transform a function to transform the result of the call
-     * @return a promise of the result
-     */
-    @UseExperimental(ImplicitReflectionSerializer::class)
-    inline fun <T : Any, reified V : Any> call(
-        url: String,
-        data: V,
-        deserializer: DeserializationStrategy<T>,
-        method: HttpMethod = HttpMethod.GET,
-        contentType: String = "application/json",
-        noinline beforeSend: ((JQueryXHR, JQueryAjaxSettings) -> Boolean)? = null,
-        noinline transform: ((dynamic) -> dynamic)? = null
-    ): Promise<T> {
-        return remoteCall(
-            url,
-            V::class.serializer(),
-            data,
-            deserializer,
-            method,
-            contentType,
-            beforeSend,
-            transform
-        )
-    }
-
-    /**
-     * Helper inline function to automatically deserializer for the result value with typed data.
-     * @param url an URL address
-     * @param serializer for the data
-     * @param data data to be sent
-     * @param method a HTTP method
-     * @param contentType a content type of the request
-     * @param beforeSend a content type of the request
-     * @param transform a function to transform the result of the call
-     * @return a promise of the result
-     */
-    @UseExperimental(ImplicitReflectionSerializer::class)
-    inline fun <reified T : Any, V : Any> call(
-        url: String,
-        serializer: SerializationStrategy<V>,
-        data: V,
-        method: HttpMethod = HttpMethod.GET,
-        contentType: String = "application/json",
-        noinline beforeSend: ((JQueryXHR, JQueryAjaxSettings) -> Boolean)? = null,
-        noinline transform: ((dynamic) -> dynamic)? = null
-    ): Promise<T> {
-        return remoteCall(
-            url,
-            serializer,
-            data,
-            T::class.serializer(),
-            method,
-            contentType,
-            beforeSend,
-            transform
-        )
-    }
-
-    /**
-     * Helper inline function to automatically get serializer for the data and deserializer for the result value.
-     * @param url an URL address
-     * @param data data to be sent
-     * @param method a HTTP method
-     * @param contentType a content type of the request
-     * @param beforeSend a content type of the request
-     * @param transform a function to transform the result of the call
-     * @return a promise of the result
-     */
-    @UseExperimental(ImplicitReflectionSerializer::class)
-    inline fun <reified T : Any, reified V : Any> call(
-        url: String,
-        data: V,
-        method: HttpMethod = HttpMethod.GET,
-        contentType: String = "application/json",
-        noinline beforeSend: ((JQueryXHR, JQueryAjaxSettings) -> Boolean)? = null,
-        noinline transform: ((dynamic) -> dynamic)? = null
-    ): Promise<T> {
-        return remoteCall(
-            url,
-            V::class.serializer(),
-            data,
-            T::class.serializer(),
-            method,
-            contentType,
-            beforeSend,
-            transform
-        )
-    }
 }
diff --git a/src/main/kotlin/pl/treksoft/kvision/rest/RestClient.kt b/src/main/kotlin/pl/treksoft/kvision/rest/RestClient.kt
new file mode 100644
index 00000000..9ccfc38f
--- /dev/null
+++ b/src/main/kotlin/pl/treksoft/kvision/rest/RestClient.kt
@@ -0,0 +1,335 @@
+/*
+ * Copyright (c) 2017-present Robert Jaros
+ *
+ * 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 pl.treksoft.kvision.rest
+
+import kotlinx.serialization.DeserializationStrategy
+import kotlinx.serialization.DynamicObjectParser
+import kotlinx.serialization.ImplicitReflectionSerializer
+import kotlinx.serialization.SerializationStrategy
+import kotlinx.serialization.serializer
+import pl.treksoft.jquery.JQueryAjaxSettings
+import pl.treksoft.jquery.JQueryXHR
+import pl.treksoft.jquery.jQuery
+import pl.treksoft.kvision.utils.JSON.toObj
+import pl.treksoft.kvision.utils.obj
+import kotlin.js.Promise
+import kotlin.js.then
+import kotlin.js.undefined
+import kotlin.js.JSON as NativeJSON
+
+enum class HttpMethod {
+    GET,
+    POST,
+    PUT,
+    DELETE,
+    OPTIONS
+}
+
+/**
+ * HTTP status unauthorized (401).
+ */
+const val HTTP_UNAUTHORIZED = 401
+
+/**
+ * An agent responsible for remote calls.
+ */
+open class RestClient {
+
+    private var counter = 1
+
+    /**
+     * Makes a remote call to the remote server.
+     * @param url an URL address
+     * @param data data to be sent
+     * @param method a HTTP method
+     * @param contentType a content type of the request
+     * @param beforeSend a content type of the request
+     * @return a promise of the result
+     */
+    @Suppress("UnsafeCastFromDynamic", "ComplexMethod")
+    fun remoteCall(
+        url: String,
+        data: dynamic = null,
+        method: HttpMethod = HttpMethod.GET,
+        contentType: String = "application/json",
+        beforeSend: ((JQueryXHR, JQueryAjaxSettings) -> Boolean)? = null
+    ): Promise<dynamic> {
+        return Promise { resolve, reject ->
+            jQuery.ajax(url, obj {
+                this.contentType = if (contentType != "multipart/form-data") contentType else false
+                this.data = data
+                this.method = method.name
+                this.processData = if (contentType != "multipart/form-data") undefined else false
+                this.success =
+                    { data: dynamic, _: Any, _: Any ->
+                        resolve(data)
+                    }
+                this.error =
+                    { xhr: JQueryXHR, _: String, errorText: String ->
+                        val message = if (xhr.responseJSON != null && xhr.responseJSON != undefined) {
+                            NativeJSON.stringify(xhr.responseJSON)
+                        } else if (xhr.responseText != undefined) {
+                            xhr.responseText
+                        } else {
+                            errorText
+                        }
+                        if (xhr.status.toInt() == HTTP_UNAUTHORIZED) {
+                            reject(SecurityException(message))
+                        } else {
+                            reject(Exception(message))
+                        }
+                    }
+                this.beforeSend = beforeSend
+            })
+        }
+    }
+
+    /**
+     * Makes a remote call to the remote server.
+     * @param url an URL address
+     * @param data data to be sent
+     * @param deserializer a deserializer for the result value
+     * @param method a HTTP method
+     * @param contentType a content type of the request
+     * @param beforeSend a content type of the request
+     * @param transform a function to transform the result of the call
+     * @return a promise of the result
+     */
+    fun <T : Any> remoteCall(
+        url: String,
+        data: dynamic = null,
+        deserializer: DeserializationStrategy<T>,
+        method: HttpMethod = HttpMethod.GET,
+        contentType: String = "application/json",
+        beforeSend: ((JQueryXHR, JQueryAjaxSettings) -> Boolean)? = null,
+        transform: ((dynamic) -> dynamic)? = null
+    ): Promise<T> {
+        return remoteCall(url, data, method, contentType, beforeSend).then { result: dynamic ->
+            val transformed = if (transform != null) {
+                transform(result)
+            } else {
+                result
+            }
+            DynamicObjectParser().parse(transformed, deserializer)
+        }
+    }
+
+    /**
+     * Makes a remote call to the remote server.
+     * @param url an URL address
+     * @param serializer for the data
+     * @param data data to be sent
+     * @param method a HTTP method
+     * @param contentType a content type of the request
+     * @param beforeSend a content type of the request
+     * @return a promise of the result
+     */
+    fun <V : Any> remoteCall(
+        url: String,
+        serializer: SerializationStrategy<V>,
+        data: V,
+        method: HttpMethod = HttpMethod.GET,
+        contentType: String = "application/json",
+        beforeSend: ((JQueryXHR, JQueryAjaxSettings) -> Boolean)? = null
+    ): Promise<dynamic> {
+        return remoteCall(url, data.toObj(serializer), method, contentType, beforeSend)
+    }
+
+
+    /**
+     * Makes a remote call to the remote server.
+     * @param url an URL address
+     * @param serializer for the data
+     * @param data data to be sent
+     * @param deserializer a deserializer for the result value
+     * @param method a HTTP method
+     * @param contentType a content type of the request
+     * @param beforeSend a content type of the request
+     * @param transform a function to transform the result of the call
+     * @return a promise of the result
+     */
+    fun <T : Any, V : Any> remoteCall(
+        url: String,
+        serializer: SerializationStrategy<V>,
+        data: V,
+        deserializer: DeserializationStrategy<T>,
+        method: HttpMethod = HttpMethod.GET,
+        contentType: String = "application/json",
+        beforeSend: ((JQueryXHR, JQueryAjaxSettings) -> Boolean)? = null,
+        transform: ((dynamic) -> dynamic)? = null
+    ): Promise<T> {
+        return remoteCall(url, data.toObj(serializer), method, contentType, beforeSend).then { result: dynamic ->
+            val transformed = if (transform != null) {
+                transform(result)
+            } else {
+                result
+            }
+            DynamicObjectParser().parse(transformed, deserializer)
+        }
+    }
+
+    /**
+     * Helper inline function to automatically get deserializer for the result value with dynamic data.
+     * @param url an URL address
+     * @param data data to be sent
+     * @param method a HTTP method
+     * @param contentType a content type of the request
+     * @param beforeSend a content type of the request
+     * @param transform a function to transform the result of the call
+     * @return a promise of the result
+     */
+    @UseExperimental(ImplicitReflectionSerializer::class)
+    inline fun <reified T : Any> call(
+        url: String,
+        data: dynamic = null,
+        method: HttpMethod = HttpMethod.GET,
+        contentType: String = "application/json",
+        noinline beforeSend: ((JQueryXHR, JQueryAjaxSettings) -> Boolean)? = null,
+        noinline transform: ((dynamic) -> dynamic)? = null
+    ): Promise<T> {
+        return remoteCall(url, data, T::class.serializer(), method, contentType, beforeSend, transform)
+    }
+
+    /**
+     * Helper inline function to automatically get serializer for the data.
+     * @param url an URL address
+     * @param data data to be sent
+     * @param method a HTTP method
+     * @param contentType a content type of the request
+     * @param beforeSend a content type of the request
+     * @return a promise of the result
+     */
+    @UseExperimental(ImplicitReflectionSerializer::class)
+    inline fun <reified V : Any> call(
+        url: String,
+        data: V,
+        method: HttpMethod = HttpMethod.GET,
+        contentType: String = "application/json",
+        noinline beforeSend: ((JQueryXHR, JQueryAjaxSettings) -> Boolean)? = null
+    ): Promise<dynamic> {
+        return remoteCall(
+            url,
+            V::class.serializer(),
+            data,
+            method,
+            contentType,
+            beforeSend
+        )
+    }
+
+    /**
+     * Helper inline function to automatically get serializer for the data.
+     * @param url an URL address
+     * @param data data to be sent
+     * @param deserializer a deserializer for the result value
+     * @param method a HTTP method
+     * @param contentType a content type of the request
+     * @param beforeSend a content type of the request
+     * @param transform a function to transform the result of the call
+     * @return a promise of the result
+     */
+    @UseExperimental(ImplicitReflectionSerializer::class)
+    inline fun <T : Any, reified V : Any> call(
+        url: String,
+        data: V,
+        deserializer: DeserializationStrategy<T>,
+        method: HttpMethod = HttpMethod.GET,
+        contentType: String = "application/json",
+        noinline beforeSend: ((JQueryXHR, JQueryAjaxSettings) -> Boolean)? = null,
+        noinline transform: ((dynamic) -> dynamic)? = null
+    ): Promise<T> {
+        return remoteCall(
+            url,
+            V::class.serializer(),
+            data,
+            deserializer,
+            method,
+            contentType,
+            beforeSend,
+            transform
+        )
+    }
+
+    /**
+     * Helper inline function to automatically deserializer for the result value with typed data.
+     * @param url an URL address
+     * @param serializer for the data
+     * @param data data to be sent
+     * @param method a HTTP method
+     * @param contentType a content type of the request
+     * @param beforeSend a content type of the request
+     * @param transform a function to transform the result of the call
+     * @return a promise of the result
+     */
+    @UseExperimental(ImplicitReflectionSerializer::class)
+    inline fun <reified T : Any, V : Any> call(
+        url: String,
+        serializer: SerializationStrategy<V>,
+        data: V,
+        method: HttpMethod = HttpMethod.GET,
+        contentType: String = "application/json",
+        noinline beforeSend: ((JQueryXHR, JQueryAjaxSettings) -> Boolean)? = null,
+        noinline transform: ((dynamic) -> dynamic)? = null
+    ): Promise<T> {
+        return remoteCall(
+            url,
+            serializer,
+            data,
+            T::class.serializer(),
+            method,
+            contentType,
+            beforeSend,
+            transform
+        )
+    }
+
+    /**
+     * Helper inline function to automatically get serializer for the data and deserializer for the result value.
+     * @param url an URL address
+     * @param data data to be sent
+     * @param method a HTTP method
+     * @param contentType a content type of the request
+     * @param beforeSend a content type of the request
+     * @param transform a function to transform the result of the call
+     * @return a promise of the result
+     */
+    @UseExperimental(ImplicitReflectionSerializer::class)
+    inline fun <reified T : Any, reified V : Any> call(
+        url: String,
+        data: V,
+        method: HttpMethod = HttpMethod.GET,
+        contentType: String = "application/json",
+        noinline beforeSend: ((JQueryXHR, JQueryAjaxSettings) -> Boolean)? = null,
+        noinline transform: ((dynamic) -> dynamic)? = null
+    ): Promise<T> {
+        return remoteCall(
+            url,
+            V::class.serializer(),
+            data,
+            T::class.serializer(),
+            method,
+            contentType,
+            beforeSend,
+            transform
+        )
+    }
+}