Merge pull request #5 from troublegum/dev

Release 1.2

Author: troublegum

README.md

@@ -7,7 +7,7 @@
 ## Install
 
 Download a code and unpack it into your project folder.
-Use Thonny IDE or other IDE to load your code in ESP8266/ESP32 board.
+Use Thonny IDE or other IDE for upload your code in ESP8266/ESP32 board.
 
 ## Quick start
 
@@ -57,8 +57,8 @@ import json
 def return_json(request):
     ''' request handler '''
     json_str = json.dumps({"param_one": 1, "param_two": 2})
-    server.send("HTTP/1.0 200 OK\r\n");
-    server.send("Content-Type: application/json\r\n\r\n");
+    server.send("HTTP/1.0 200 OK\r\n")
+    server.send("Content-Type: application/json\r\n\r\n")
     server.send(json_str)
 
 server = MicroPyServer()
@@ -78,7 +78,7 @@ def show_index(request):
     
 def on_request_handler(request, address):
     if str(address[0]) != '127.0.0.1':
-        server.send("HTTP/1.0 403\r\n\r\n");
+        server.send("HTTP/1.0 403\r\n\r\n")
         server.send('ACCESS DENIED!')
         return False        
     return True
@@ -95,7 +95,7 @@ server.start()
 
 ### Turn ON / OFF a LED example
 
-You can remote control a led via internet.
+You can remote control a LED via internet.
 
 ![schema](https://habrastorage.org/webt/jb/xu/aj/jbxuaj0nr8fnqllbq27p_vfx3bw.png)
 
@@ -119,7 +119,7 @@ wlan.active(True)
 
 while not wlan.isconnected():
     wlan.connect(wlan_id, wlan_pass)
-print("Connected... IP: " + wlan.ifconfig()[0]);    
+print("Connected... IP: " + wlan.ifconfig()[0])    
     
 def do_on(request):
     ''' on request handler '''
@@ -145,6 +145,27 @@ server.add_route("/off", do_off)
 server.start()    
 ```    
 
+### Use utils for create response
+```
+from micropyserver import MicroPyServer
+import utils
+
+def hello_world(request):
+    ''' request handler '''
+    utils.send_response(server, "HELLO WORLD!")
+
+def not_found(request):
+    ''' request handler '''
+    utils.send_response(server, "404", 404)
+
+server = MicroPyServer()
+''' add routes '''
+server.add_route("/", hello_world)
+server.add_route("/404", not_found)
+''' start server '''
+server.start()
+```
+
 
 ## MicroPyServer methods
 
@@ -158,10 +179,12 @@ Send response to client - srv.send(response)
 
 Return current request - srv.get_request()
 
-### Event handlers
-
 Set handler on every request - server.on_request(handler)
 
 Set handler on 404 - server.on_not_found(handler)
 
 Set handler on server error - server.on_error(handler)
+
+## Utils methods
+
+Send response to client - utils.send_response(server, response, http_code=200, content_type="text/html", extend_headers=None)

utils.py

@@ -0,0 +1,100 @@
+"""
+MicroPyServer is a simple HTTP server for MicroPython projects.
+
+@see https://github.com/troublegum/micropyserver
+
+The MIT License
+
+Copyright (c) 2019 troublegum. https://github.com/troublegum/micropyserver
+
+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 NONINFINGEMENT. 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.
+"""
+
+""" HTTP response codes """
+HTTP_CODES = {
+    100: 'Continue',
+    101: 'Switching protocols',
+    102: 'Processing',
+    200: 'Ok',
+    201: 'Created',
+    202: 'Accepted',
+    203: 'Non authoritative information',
+    204: 'No content',
+    205: 'Reset content',
+    206: 'Partial content',
+    207: 'Multi status',
+    208: 'Already reported',
+    226: 'Im used',
+    300: 'Multiple choices',
+    301: 'Moved permanently',
+    302: 'Found',
+    303: 'See other',
+    304: 'Not modified',
+    305: 'Use proxy',
+    307: 'Temporary redirect',
+    308: 'Permanent redirect',
+    400: 'Bad request',
+    401: 'Unauthorized',
+    402: 'Payment required',
+    403: 'Forbidden',
+    404: 'Not found',
+    405: 'Method not allowed',
+    406: 'Not acceptable',
+    407: 'Proxy authentication required',
+    408: 'Request timeout',
+    409: 'Conflict',
+    410: 'Gone',
+    411: 'Length required',
+    412: 'Precondition failed',
+    413: 'Request entity too large',
+    414: 'Request uri too long',
+    415: 'Unsupported media type',
+    416: 'Request range not satisfiable',
+    417: 'Expectation failed',
+    418: 'I am a teapot',
+    422: 'Unprocessable entity',
+    423: 'Locked',
+    424: 'Failed dependency',
+    426: 'Upgrade required',
+    428: 'Precondition required',
+    429: 'Too many requests',
+    431: 'Request header fields too large',
+    500: 'Internal server error',
+    501: 'Not implemented',
+    502: 'Bad gateway',
+    503: 'Service unavailable',
+    504: 'Gateway timeout',
+    505: 'Http version not supported',
+    506: 'Variant also negotiates',
+    507: 'Insufficient storage',
+    508: 'Loop detected',
+    510: 'Not extended',
+    511: 'Network authentication required',
+}
+
+
+def send_response(server, response, http_code=200, content_type="text/html", extend_headers=None):
+    """ send response """
+    server.send("HTTP/1.0 " + str(http_code) + " " + HTTP_CODES.get(http_code) + "\r\n")
+    server.send("Content type:" + content_type + "\r\n")
+    if extend_headers is not None:
+        for header in extend_headers:
+            server.send(header + "\r\n")
+    server.send("\r\n")
+    server.send(response)