Updated README.md and NanoHTTPDServer

2017-07-11 17:35:59 +02:00 · 2017-07-11 17:35:59 +02:00 · d3e0833913
commit d3e0833913
parent 7c1607448e
2 changed files with 102 additions and 2 deletions
--- a/README.md
+++ b/README.md
@ -1,2 +1,95 @@
 # cordova-plugin-webserver
-A webserver plugin for cordova
+*A webserver plugin for cordova*
+This plugin helps you to start a full webserver in JavaScript on Android and iOS.
+
+## Why?
+
+I started this project because I wanted a solution like [ExpressJS](http://expressjs.com/de/) but hybrid (for iOS and Android). I didn't want to build two native applications which each serve a backend (two codebases are just bah!). So this is the solution to create a Webserver which can receives HTTP Requests and responds with HTTP Responds.
+
+## Installation
+
+Just add the cordova plugin to your project
+
+`cordova plugin add https://github.com/bykof/cordova-plugin-webserver`
+
+## Use
+
+Ok so it's pretty ez. There are 4 Methods which are available in the `webserver` variable:
+
+- start(port) or start()
+- stop()
+- onRequest(request)
+- sendResponse(responseId, responseObject, callbackSuccess, callbackError)
+
+### start(port)
+
+port (optional): Set a port of your webserver.
+Default port: 8080
+
+This method will start your webserver.
+
+### stop()
+
+This method will stop your webserver.
+
+### onRequest(callback(request))
+
+Ok now this is the interesting part...
+Everytime a request will be received by the webserver your callback function will be called. In this case you are thinking right! You have to define onRequest BEFORE your start your server. I think it would work also after the start() but I didn't tested it yet.
+
+The params will look like this:
+```
+{
+	requestId: '3jh4-ku34k-k3j4k-k3j42',
+	body: '',
+	headers: {
+		... some headers
+	},
+	method: 'POST',
+	path: '/hello/world',
+	query: 'bla=wer&blu=2'
+}
+```
+
+### sendResponse(requestId, responseObject,  callbackSuccess, callbackError)
+
+If you received a request you will probably send a response "*cough*"...
+We need to add a requestId param to map a response to a request, because internally the webserver will wait for the response. (Yes currently the webserver will wait until there aren't computers anymore on earth).
+
+The params have to look like this (there are not default values for the params!):
+```
+{
+	status: 200,
+	body: '<html>Hello ... something</html>',
+	headers: {
+		'Content-Type': 'text/html' <--- this is important
+	}
+}
+```
+
+## Example
+
+```
+webserver.onRequest(
+	function(request) {
+		console.log("O MA GAWD! This is the request: ", request);
+
+		webserver.sendResponse(
+			request.responseId,
+			{
+				status: 200,
+				body: '<html>Hello World</html>',
+				headers: {
+					'Content-Type': 'text/html'
+				}
+			}
+		);
+	}
+);
+
+webserver.start();
+
+//... after a long long time
+// stop the server
+webserver.stop();
+```
--- a/src/android/NanoHTTPDWebserver.java
+++ b/src/android/NanoHTTPDWebserver.java
@ -13,8 +13,10 @@ import fi.iki.elonen.NanoHTTPD;

 import java.io.ByteArrayInputStream;
 import java.io.InputStream;
+import java.io.StringWriter;
 import java.io.UnsupportedEncodingException;
 import java.util.Iterator;
+import java.util.Scanner;
 import java.util.UUID;

 public class NanoHTTPDWebserver extends NanoHTTPD{
@ -26,6 +28,11 @@ public class NanoHTTPDWebserver extends NanoHTTPD{
        this.webserver = webserver;
    }

+    private String inputStreamToString(InputStream inputStream) {
+        Scanner s = new Scanner(inputStream).useDelimiter("\\A");
+        return s.hasNext() ? s.next() : "";
+    }
+
    /**
     * Create a request object
     *
@ -44,7 +51,7 @@ public class NanoHTTPDWebserver extends NanoHTTPD{
    private JSONObject createJSONRequest(String requestId, IHTTPSession session) throws JSONException {
        JSONObject jsonRequest = new JSONObject();
        jsonRequest.put("requestId", requestId);
-        jsonRequest.put("body", session.getParameters());
+        jsonRequest.put("body", this.inputStreamToString(session.getInputStream()));
        jsonRequest.put("headers", session.getHeaders());
        jsonRequest.put("method", session.getMethod());
        jsonRequest.put("path", session.getUri());