v2 - refactor (#3)

* add methods for upload handler * fix signatures * use actually exported type for web request type * remove path handlers (will be in rich_http_server) * remove handler code -- library now just has the URL token processing * add example * README formatting * bump version * remove extraneous line
sidoh · May 2, 2019 · d7fe45d · d7fe45d
1 parent 3631a3c
commit d7fe45d
Show file tree

Hide file tree

Showing 13 changed files with 37 additions and 509 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -11,32 +11,14 @@ cache:
 install:
   - pip install -U platformio
   - platformio update
-  - platformio lib -g install 'ESP Async WebServer'
 
 matrix:
   include:
     - env:
-      - PLATFORMIO_CI_SRC=examples/esp8266_simple
+      - PLATFORMIO_CI_SRC=examples/simple
       - PLATFORMIO_ADDITIONAL_ARGS='--lib=.'
       - BOARDS=--board=d1_mini
       - PLATFORMIO_CMD=ci
-    - env:
-      - PLATFORMIO_CI_SRC=examples/esp8266_async_webserver
-      - PLATFORMIO_ADDITIONAL_ARGS='--lib=.'
-      - PLATFORMIO_BUILD_FLAGS=-DPVH_USE_ASYNC_WEBSERVER
-      - BOARDS=--board=d1_mini
-      - PLATFORMIO_CMD=ci
-    - env:
-      - PLATFORMIO_CI_SRC=examples/esp32_simple
-      - PLATFORMIO_ADDITIONAL_ARGS='--lib=.'
-      - BOARDS=--board=esp32doit-devkit-v1
-      - PLATFORMIO_CMD=ci
-    - env:
-      - PLATFORMIO_CI_SRC=examples/esp32_async_webserver
-      - PLATFORMIO_ADDITIONAL_ARGS='--lib=.'
-      - PLATFORMIO_BUILD_FLAGS=-DPVH_USE_ASYNC_WEBSERVER
-      - BOARDS=--board=esp32doit-devkit-v1
-      - PLATFORMIO_CMD=ci
     - env:
       - PLATFORMIO_CMD=test
 

diff --git a/README.md b/README.md
@@ -1,25 +1,15 @@
 # Path Variable Handlers [![Build Status](https://travis-ci.org/sidoh/path_variable_handlers.svg?branch=master)](https://travis-ci.org/sidoh/path_variable_handlers)
 
-This is a library for handling HTTP and REST paths containing variables. Many RESTful APIs contain resources that have variables in their paths (e.g., `/things/:thing_id`).  This library exposes a way to easily process such resource paths in a low-effort way.
+This is a library for handling paths. Many RESTful APIs contain resources that have variables in their paths (e.g., `/things/:thing_id`).  This library exposes a way to process such resource paths in a low-effort way.
 
-Compatible with ESP8266 and ESP32 builtin web servers, and ESPAsyncWebServer for both platforms.
+While this is mostly useful for REST APIs, it could also be used, for example, to process MQTT topics containing wildcards.
 
-### Examples
+There is nothing platform-specific about this library.
 
-Examples are found in the `./examples` directory.  This is the easiest way to get started.
-
-## Compatible Hardware
+## Examples
 
-This library is built on top of handler bindings tied to the espressif platform:
-
-* ESP32
-  * Builtin `WebServer`.
-  * [`ESPAsyncWebServer`](https://github.com/me-no-dev/ESPAsyncWebServer).
-* ESP266: uses the `ESP8266WebServer` bindings built into the SDK by default.
-  * Builtin `ESP8266WebServer`.
-  * ESPAsyncWebServer.
+Examples are found in the `./examples` directory.  This is the easiest way to get started.
 
-Defaults to the builtin web server bindings.  To use `ESPAsyncWebServer`, set the build flag `PVH_USE_ASYNC_WEBSERVER`.
 ## Development
 
 Run tests with:
@@ -31,7 +21,7 @@ platformio test
 Build examples with, for instance:
 
 ```
-platformio ci --board=d1_mini --lib=. examples/esp8266_simple
+platformio ci --board=d1_mini --lib=. examples/simple
 ```
 
 #### New Release

diff --git a/examples/esp32_async_webserver/ESP32AsyncWebServer.ino b/examples/esp32_async_webserver/ESP32AsyncWebServer.ino
diff --git a/examples/esp32_simple/ESP32Simple.ino b/examples/esp32_simple/ESP32Simple.ino
diff --git a/examples/esp8266_async_webserver/ESP8266AsyncWebServer.ino b/examples/esp8266_async_webserver/ESP8266AsyncWebServer.ino
diff --git a/examples/esp8266_simple/ESP8266SimplePathVariable.ino b/examples/esp8266_simple/ESP8266SimplePathVariable.ino
diff --git a/examples/simple/Simple.ino b/examples/simple/Simple.ino
@@ -0,0 +1,25 @@
+#include <Arduino.h>
+
+#include <TokenIterator.h>
+#include <UrlTokenBindings.h>
+
+void setup() {
+  Serial.begin(115200);
+
+  char p1[] = "example/path/a/b/c";
+  char p2[] = "example/path/:var1/:var2/:var3";
+
+  TokenIterator itr1(p1, strlen(p1), '/');
+  TokenIterator itr2(p2, strlen(p2), '/');
+  UrlTokenBindings bindings(itr1, itr2);
+
+  if (bindings.hasBinding("var1")) {      // has this one
+    Serial.println(bindings.get("var1")); // will print "a"
+  }
+
+  if (bindings.hasBinding("var4")) {
+    // does not have this binding
+  }
+}
+
+void loop() { }
diff --git a/library.json b/library.json
@@ -18,12 +18,9 @@
   ],
   "license": "MIT",
   "dependencies": { },
-  "version": "1.1.0",
+  "version": "2.0.0",
   "frameworks": "arduino",
-  "platforms": [
-    "espressif8266",
-    "espressif32"
-  ],
+  "platforms": "*",
   "examples": "examples/*/*.ino",
   "exclude": [
     "platformio.ini",

diff --git a/library.properties b/library.properties
@@ -1,9 +1,9 @@
 name=PathVariableHandlers
-version=1.1.0
+version=2.0.0
 author=Chris Mullins <[email protected]>
 maintainer=Chris Mullins <[email protected]>
 sentence=Library for handling paths containing variables.
 paragraph=Many RESTful APIs contain resources that have variables in their paths (e.g., /things/:thing_id).  This library exposes a way to easily process such resource paths in a low-effort way.  Compatible with ESP8266WebServer for ESP8266 and ESPAsyncWebServer for ESP32.
 category=Communication
 url=https://github.com/sidoh/path_variable_handlers
-architectures=esp8266,esp32
+architectures=*