First commit

troublegum · troublegum · commit ff3f9b638b9f · 2019-11-02T16:31:18.000+03:00
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,2 @@
+/.idea
+/__pycache__
diff --git a/README.md b/README.md
@@ -0,0 +1,86 @@
+# MicroPyServer
+
+MicroPyServer is a simple HTTP server for MicroPython projects.
+
+## Install
+
+Download a code and unpack it on your project folder.
+Use Thonny IDE or other IDE for upload your code in ESP8266/ESP32 board.
+
+## Quick start
+
+### Hello world example
+
+```
+from micropyserver import MicroPyServer
+
+def show_message(request):
+    ''' request handler '''
+    server.send("HELLO WORLD!")
+
+server = MicroPyServer()
+''' add request handler '''
+server.add_route("/", show_message)
+''' start server '''
+server.start()
+```
+
+### Add some routes
+```
+from micropyserver import MicroPyServer
+
+def show_index(request):
+    ''' main request handler '''
+    server.send("THIS IS INDEX PAGE!")
+    
+def show_info(request, address):
+    ''' info request handler '''
+    server.send("Your IP:" + str(address))
+
+server = MicroPyServer()
+''' add request handlers '''
+server.add_route("/", show_index)
+server.add_route("/info", show_info)
+''' start server '''
+server.start()
+```
+
+
+### Send JSON response example
+
+```
+from micropyserver import MicroPyServer
+import json
+
+def return_json(request):
+    ''' request handler '''
+    json_str = json.dumps({"param_one": 1, "param_two": 2})
+    server.send(json_str, content_type="Content-Type: application/json")
+
+server = MicroPyServer()
+''' add request handler '''
+server.add_route("/", return_json)
+''' start server '''
+server.start()
+```
+
+### More examples
+
+More examples you can find in a folder "examples".
+
+## MicroPyServer methods
+
+Constructor - srv = MicroPyServer(host="0.0.0.0", port=80)
+
+Start server - srv.start() 
+
+Add new route - srv.add_route(path, handler, method="GET")
+
+Send response to client - srv.send(response, status=200, content_type="Content-Type: text/plain", extra_headers=[])
+
+Send 404 to client - srv.not_found()
+
+Send 500 to client - srv.internal_error(error)
+
+
+
diff --git a/examples/example1.py b/examples/example1.py
@@ -0,0 +1,32 @@
+"""
+Example 1
+
+Needed ESP8266 or ESP32 board
+
+@see https://github.com/troublegum/micropyserver
+"""
+import esp
+import network
+from micropyserver import MicroPyServer
+
+wlan_id = "your wi-fi"
+wlan_pass = "your password"
+
+wlan = network.WLAN(network.STA_IF)
+wlan.active(True)
+if not wlan.isconnected():
+    wlan.connect(wlan_id, wlan_pass)
+
+
+def show_index_page(request):
+    server.send("THIS IS INDEX PAGE")
+
+
+def show_info_page(request):
+    server.send("THIS IS INFO PAGE")
+
+
+server = MicroPyServer()
+server.add_route("/info", show_info_page)
+server.add_route("/", show_index_page)
+server.start()
diff --git a/examples/example2.py b/examples/example2.py
@@ -0,0 +1,31 @@
+"""
+Example 2
+
+Needed ESP8266 or ESP32 board
+
+@see https://github.com/troublegum/micropyserver
+"""
+
+import esp
+import network
+from micropyserver import MicroPyServer
+
+wlan_id = "your wi-fi"
+wlan_pass = "your password"
+
+wlan = network.WLAN(network.STA_IF)
+wlan.active(True)
+if not wlan.isconnected():
+    wlan.connect(wlan_id, wlan_pass)
+
+
+def show_index_page(request):
+    html_file = open("index.html")
+    html = html_file.read()
+    html_file.close()
+    server.send(html, content_type="Content-Type: text/html")
+
+
+server = MicroPyServer()
+server.add_route("/", show_index_page)
+server.start()
diff --git a/examples/index.html b/examples/index.html
@@ -0,0 +1,6 @@
+<!DOCTYPE html>
+<html>
+    <body>
+        <h1>Hello, MicroPyServer!</h1>
+    </body>
+</html>
diff --git a/micropyserver.py b/micropyserver.py
@@ -0,0 +1,122 @@
+"""
+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 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.
+"""
+import re
+import socket
+import sys
+
+
+class MicroPyServer(object):
+
+    def __init__(self, host="0.0.0.0", port=80):
+        """ Constructor """
+        self._host = host
+        self._port = port
+        self._routes = []
+        self._connect = None
+        self._on_request_handler = None
+
+    def start(self):
+        """ Start server """
+        sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+        sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
+        sock.bind((self._host, self._port))
+        sock.listen(1)
+        while True:
+            try:
+                self._connect, address = sock.accept()
+                request = self._get_request()
+                if len(request) == 0:
+                    self._connect.close()
+                    continue
+                if self._on_request_handler:
+                    if not self._on_request_handler(request, address):
+                        continue
+                route = self.find_route(request)
+                if route:
+                    route["handler"](request)
+                else:
+                    self.not_found()
+            except Exception as e:
+                try:
+                    self.internal_error(str(e))
+                except Exception as e:
+                    sys.print_exception(e)
+            finally:
+                self._connect.close()
+
+    def add_route(self, path, handler, method="GET"):
+        """ Add new route  """
+        self._routes.append({"path": path, "handler": handler, "method": method})
+
+    def send(self, response, status=200, content_type="Content-Type: text/plain", extra_headers=[]):
+        """ Send response to client """
+        if self._connect is None:
+            raise Exception("Can't send response, no connection instance")
+
+        status_message = {200: "OK", 400: "Bad Request", 403: "Forbidden", 404: "Not Found",
+                          500: "Internal Server Error"}
+        self._connect.sendall("HTTP/1.0 " + str(status) + " " + status_message[status] + "\r\n")
+        self._connect.sendall(content_type + "\r\n")
+        for header in extra_headers:
+            self._connect.sendall(header + "\r\n")
+        self._connect.sendall("X-Powered-By: MicroPyServer\r\n")
+        self._connect.sendall("\r\n")
+        self._connect.sendall(response)
+
+    def find_route(self, request):
+        """ Find route """
+        lines = request.split("\r\n")
+        method = re.search("^([A-Z]+)", lines[0]).group(1)
+        path = re.search("^[A-Z]+\\s+(/[-a-zA-Z0-9_.]*)", lines[0]).group(1)
+        for route in self._routes:
+            if method != route["method"]:
+                continue
+            if path == route["path"]:
+                return route
+            else:
+                match = re.search("^" + route["path"] + "$", path)
+                if match:
+                    print(method, path, route["path"])
+                    return route
+
+    def not_found(self):
+        """ Not found action """
+        self.send("404", status=404)
+
+    def internal_error(self, error):
+        """ Catch error action """
+        self.send("Error: " + error, status=500)
+        sys.exc_info()
+
+    def on_request(self, handler):
+        """ Set request handler """
+        self._on_request_handler = handler
+
+    def _get_request(self):
+        """ Return request body """
+        return str(self._connect.recv(4096), "utf8")
