feat: add sample for RESTful API : GET

Author: nphau

.idea/misc.xml

@@ -3,7 +3,7 @@
 <p align="center">
     <a>
         <img src="https://img.shields.io/badge/kotlin-v1.6.10-blue.svg">
-        <img src="https://img.shields.io/badge/gradle-7.%3Cspan%20class="x x-first x-last">0.4-blueviolet.svg">
+        <img src="https://img.shields.io/badge/gradle-7.%3Cspan%20class="x x-first x-last">1.0-blueviolet.svg">
         <img src="https://img.shields.io/badge/API-21%2B-blue.svg?style=flat">
         <img src="https://img.shields.io/badge/License-Apache%202.0-success.svg">
         <img src="https://circleci.com/gh/twilio-labs/plugin-rtc.svg?style=svg">
@@ -12,13 +12,48 @@
 
 [![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#table-of-contents)
 
-## 🚀 Copyright
+## 👇 Overview
+
+A minimal way to create HTTP server in android with Kotlin. Create asynchronous client and server applications. Anything from microservices to multiplatform HTTP client apps in a simple way. Open Source, free, and fun!
+
+```kotlin
+embeddedServer(Netty, PORT, watchPaths = emptyList()) {
+            install(WebSockets)
+            install(CallLogging)
+            routing {
+                get("/") {
+                    call.respondText(
+                        text = "Hello!! You are here in ${Build.MODEL}",
+                        contentType = ContentType.Text.Plain
+                    )
+                }
+            }
+        }
+```
+## 🚀 How to use
+
+Cloning the repository into a local directory and checkout the desired branch:
+
+```
+git clone [email protected]:nphau/android.embeddedserver.git
+cd android.embeddedserver
+git checkout master
+```
+## 🍲 Screenshots
+
+<h4 align="center">
+<img src="docs/device.gif" width="20%" vspace="10" hspace="10">
+<img src="docs/edge_get.gif" width="70%" vspace="10" hspace="10">
+
+## ✨ Contributing
+Please feel free to contact me or make a pull request.
+
+## 👀 Author
 
 ``` Created by $username on $today
 Copyright (c) $today.year . All rights reserved.
 Last modified $file.lastModified
 ```
-## 👇 Authors
 <p>
     <a href="https://nphau.medium.com/" target="_blank">
     <img src="https://avatars2.githubusercontent.com/u/13111806?s=400&u=f09b6160dbbe2b7eeae0aeb0ab4efac0caad57d7&v=4" width="96" height="96">

README.md

@@ -4,12 +4,12 @@ plugins {
 }
 
 android {
-    compileSdk 31
+    compileSdk 32
 
     defaultConfig {
-        applicationId "com.imstudio.app.embeddedserver"
+        applicationId "com.nphau.app.embeddedserver"
         minSdk 21
-        targetSdk 31
+        targetSdk 32
         versionCode 1
         versionName "1.0"
 
@@ -30,27 +30,30 @@ android {
         jvmTarget = '1.8'
     }
     packagingOptions {
-        exclude 'META-INF/*'
-        // Due to https://github.com/Kotlin/kotlinx.coroutines/issues/2023
-        exclude 'META-INF/licenses/*'
-        exclude '**/attach_hotspot_windows.dll'
+        jniLibs {
+            excludes += ['META-INF/*', 'META-INF/licenses/*']
+        }
+        resources {
+            excludes += ['META-INF/*', 'META-INF/licenses/*', '**/attach_hotspot_windows.dll']
+        }
     }
 }
 
 dependencies {
 
     implementation 'androidx.core:core-ktx:1.7.0'
-    implementation 'androidx.appcompat:appcompat:1.3.1'
-    implementation 'com.google.android.material:material:1.4.0'
-    implementation 'androidx.constraintlayout:constraintlayout:2.1.1'
+    implementation 'androidx.appcompat:appcompat:1.4.1'
+    implementation 'com.google.android.material:material:1.5.0'
+    implementation 'androidx.constraintlayout:constraintlayout:2.1.3'
     androidTestImplementation 'androidx.test.ext:junit:1.1.3'
     androidTestImplementation 'androidx.test.espresso:espresso-core:3.4.0'
 
     // Coroutines
-    implementation "org.jetbrains.kotlinx:kotlinx-coroutines-core:1.5.2"
+    implementation "org.jetbrains.kotlinx:kotlinx-coroutines-core:1.6.0"
 
     // Embedded Server
-    implementation 'io.ktor:ktor-server-core:1.6.2'
+    implementation 'io.ktor:ktor-server-core:1.6.4'
+    implementation 'io.ktor:ktor-gson:1.6.4'
     implementation 'io.ktor:ktor-server-netty:1.6.2'
     implementation 'io.ktor:ktor-websockets:1.6.2'
 }

app/build.gradle

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <manifest xmlns:android="http://schemas.android.com/apk/res/android"
-    package="com.imstudio.app.embeddedserver">
+    package="com.nphau.app.embeddedserver">
 
     <uses-permission android:name="android.permission.INTERNET" />
     <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
@@ -15,14 +15,30 @@
         android:supportsRtl="true"
         android:theme="@style/Theme.MyApplication">
         <activity
-            android:name=".MainActivity"
+            android:name="com.nphau.app.embeddedserver.activities.MainActivity"
             android:exported="true">
             <intent-filter>
                 <action android:name="android.intent.action.MAIN" />
 
                 <category android:name="android.intent.category.LAUNCHER" />
             </intent-filter>
         </activity>
+        <provider
+            android:name="androidx.core.content.FileProvider"
+            android:authorities="${applicationId}.provider"
+            android:enabled="true"
+            android:exported="false"
+            android:grantUriPermissions="true"
+            android:permission="android.permission.MANAGE_DOCUMENTS">
+
+            <intent-filter>
+                <action android:name="android.content.action.DOCUMENTS_PROVIDER" />
+            </intent-filter>
+
+            <meta-data
+                android:name="android.support.FILE_PROVIDER_PATHS"
+                android:resource="@xml/file_provider_paths" />
+        </provider>
     </application>
 
 </manifest>

app/src/main/AndroidManifest.xml

@@ -0,0 +1,118 @@
+/*
+ * Created by nphau on 04/02/2022, 22:24
+ * Copyright (c) 2022 . All rights reserved.
+ * Last modified 04/02/2022, 22:23
+ */
+
+package com.nphau.app.embeddedserver.activities
+
+import android.os.Build
+import android.os.Bundle
+import android.widget.TextView
+import androidx.appcompat.app.AppCompatActivity
+import androidx.appcompat.widget.AppCompatImageView
+import com.nphau.app.embeddedserver.R
+import com.nphau.app.embeddedserver.data.BaseResponse
+import com.nphau.app.embeddedserver.data.Database
+import com.nphau.app.embeddedserver.data.models.Cart
+import com.nphau.app.embeddedserver.extensions.animateFlash
+import com.nphau.app.embeddedserver.utils.NetworkUtils
+import io.ktor.application.*
+import io.ktor.features.*
+import io.ktor.gson.*
+import io.ktor.http.*
+import io.ktor.response.*
+import io.ktor.routing.*
+import io.ktor.server.engine.*
+import io.ktor.server.netty.*
+import io.ktor.websocket.*
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.launch
+
+class MainActivity : AppCompatActivity() {
+
+    companion object {
+        private const val PORT = 5001
+    }
+
+    private val server by lazy {
+        embeddedServer(Netty, PORT, watchPaths = emptyList()) {
+            install(WebSockets)
+            install(CallLogging)
+            // provides the automatic content conversion of requests based on theirContent-Type
+            // and Accept headers. Together with the json() setting, this enables automatic
+            // serialization and deserialization to and from JSON – allowing
+            // us to delegate this tedious task to the framework.
+            install(ContentNegotiation) {
+                gson {
+                    setPrettyPrinting()
+                    disableHtmlEscaping()
+                }
+            }
+            // configures Cross-Origin Resource Sharing. CORS is needed to make calls from arbitrary
+            // JavaScript clients, and helps us prevent issues down the line.
+            install(CORS) {
+                method(HttpMethod.Get)
+                method(HttpMethod.Post)
+                method(HttpMethod.Delete)
+                anyHost()
+            }
+            // Greatly reduces the amount of data that's needed to be sent to the client by
+            // gzipping outgoing content when applicable.
+            install(Compression) {
+                gzip()
+            }
+            routing {
+                get("/") {
+                    call.respondText(
+                        text = "Hello!! You are here in ${Build.MODEL}",
+                        contentType = ContentType.Text.Plain
+                    )
+                }
+                get("/fruits") {
+                    call.respond(HttpStatusCode.OK, BaseResponse(Cart.sample()))
+                }
+                get("/fruits/{id}") {
+                    val id = call.parameters["id"]
+                    val fruit = Database.FRUITS.find { it.id == id }
+                    if (fruit != null) {
+                        call.respond(HttpStatusCode.OK, BaseResponse(fruit))
+                    } else {
+                        call.respond(HttpStatusCode.NotFound)
+                    }
+                }
+            }
+        }
+    }
+
+    override fun onCreate(savedInstanceState: Bundle?) {
+        super.onCreate(savedInstanceState)
+        setContentView(R.layout.activity_main)
+
+        findViewById<AppCompatImageView>(R.id.image_logo).animateFlash()
+
+        // Show IP Address
+        findViewById<TextView>(R.id.text_status).apply {
+            val simpleTextApi =
+                String.format("GET: %s:%d", NetworkUtils.getLocalIpAddress(), PORT)
+            val apiGet =
+                String.format("GET: %s:%d/fruits", NetworkUtils.getLocalIpAddress(), PORT)
+            val apiGetWithId =
+                String.format("GET: %s:%d/fruits/{id}", NetworkUtils.getLocalIpAddress(), PORT)
+            text = String.format("%s\n%s\n%s", simpleTextApi, apiGet, apiGetWithId)
+            //animateFlash()
+        }
+
+        // Start server
+        CoroutineScope(Dispatchers.IO).launch {
+            server.start(wait = true)
+        }
+    }
+
+    override fun onDestroy() {
+        server.stop(1_000, 2_000)
+        super.onDestroy()
+    }
+
+}

app/src/main/assets/images/file.png

@@ -0,0 +1,9 @@
+/*
+ * Created by nphau on 04/02/2022, 23:02
+ * Copyright (c) 2022 . All rights reserved.
+ * Last modified 04/02/2022, 23:02
+ */
+
+package com.nphau.app.embeddedserver.data
+
+data class BaseResponse<T>(val data: T? = null, val error: String? = null)

app/src/main/java/com/imstudio/app/embeddedserver/MainActivity.kt

@@ -0,0 +1,20 @@
+/*
+ * Created by nphau on 04/02/2022, 23:00
+ * Copyright (c) 2022 . All rights reserved.
+ * Last modified 04/02/2022, 23:00
+ */
+
+package com.nphau.app.embeddedserver.data
+
+import com.nphau.app.embeddedserver.data.models.Fruit
+import java.util.*
+
+object Database {
+
+    val FRUITS = listOf(
+        Fruit(UUID.randomUUID().toString(), "Cucumbers 🥒"),
+        Fruit(UUID.randomUUID().toString(), "Tomatoes 🍅"),
+        Fruit(UUID.randomUUID().toString(), "Orange Juice 🍊")
+    )
+
+}