initial upload

.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+.vscode

LICENSE.txt

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

README.md

@@ -0,0 +1,46 @@
+# GoHTTPRouter
+[![GoDoc](https://godoc.org/gitlab.com/martinr92/gohttprouter?status.svg)](https://godoc.org/gitlab.com/martinr92/gohttprouter)
+[![pipeline status](https://gitlab.com/martinr92/gohttprouter/badges/master/pipeline.svg)](https://gitlab.com/martinr92/gohttprouter/commits/master)
+[![coverage report](https://gitlab.com/martinr92/gohttprouter/badges/master/coverage.svg)](https://gitlab.com/martinr92/gohttprouter/commits/master)
+[![codecov](https://codecov.io/gl/martinr92/gohttprouter/branch/master/graph/badge.svg)](https://codecov.io/gl/martinr92/gohttprouter)
+[![Go Report Card](https://goreportcard.com/badge/gitlab.com/martinr92/gohttprouter)](https://goreportcard.com/report/gitlab.com/martinr92/gohttprouter)
+
+GoHTTPRouter is a framework used for HTTP request routing.
+
+# Examples
+## Simple Routing
+Just replace the standard router of golang with this one:
+```golang
+router := gohttprouter.New()
+router.HandleFunc(http.MethodGet, "/home", func(response http.ResponseWriter, request *http.Request, info gohttprouter.RoutingInfo) {
+    response.Write([]byte("Home"))
+})
+err := http.ListenAndServe("localhost:8080", router)
+```
+
+## Routing with placeholder
+A path can also contain placeholder (like :id). If then a request is sent to the url "/user/123" the method gets executed and the URL part (in this case "123") is passed as parameter into your handler function.
+```golang
+router := gohttprouter.New()
+router.HandleFunc(http.MethodGet, "/user/:id", func(response http.ResponseWriter, request *http.Request, info gohttprouter.RoutingInfo) {
+    id := info.Parameters["id"]
+})
+err := http.ListenAndServe("localhost:8080", router)
+```
+
+# License
+```
+Copyright 2019 Martin Riedl
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+	http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+```

route.go

@@ -0,0 +1,110 @@
+// Copyright 2018-2019 Martin Riedl
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// 	http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package gohttprouter
+
+import (
+	"strings"
+)
+
+type route struct {
+	name            string
+	placeholderName string
+	handler         Handler
+	routes          map[string]*route
+}
+
+const parameterPrefix = ":"
+
+func newRoute() *route {
+	return &route{routes: make(map[string]*route)}
+}
+
+func (r *route) parsePath(path string, create bool) (*route, bool, map[string]string) {
+	parts := strings.SplitN(path, "/", 2)
+
+	// parse parameters
+	var parameters map[string]string
+	if !create && r.name != parts[0] {
+		parameters = make(map[string]string)
+		parameters[r.placeholderName] = parts[0]
+	}
+
+	// more path is available
+	if len(parts) == 2 {
+		// parse next part element
+		subParts := strings.SplitN(parts[1], "/", 2)
+		subName := subParts[0]
+
+		// find sub route element
+		var subRoute *route
+		var ok bool
+		if create && isParameter(subName) {
+			subRoute, ok = r.routes[parameterPrefix]
+		} else {
+			subRoute, ok = r.routes[subName]
+		}
+
+		// route not found, try to use placeholder path
+		if !create && !ok {
+			subRoute, ok = r.routes[parameterPrefix]
+		}
+
+		// check for creation
+		subRouteCreated := false
+		if !ok && !create {
+			// no route found
+			return nil, false, nil
+		} else if !ok && create {
+			subRoute = newRoute()
+			subRoute.parseName(subName)
+			r.routes[subRoute.name] = subRoute
+			subRouteCreated = true
+		}
+
+		// parse sub-route
+		matchingRoute, created, subParameters := subRoute.parsePath(parts[1], create)
+		return matchingRoute, (subRouteCreated || created), mergeParameterMaps(parameters, subParameters)
+	}
+
+	// last element in path
+	return r, false, parameters
+}
+
+func (r *route) parseName(name string) {
+	if isParameter(name) {
+		r.name = parameterPrefix
+		r.placeholderName = name[1:]
+	} else {
+		r.name = name
+	}
+}
+
+func mergeParameterMaps(m1, m2 map[string]string) map[string]string {
+	if m1 == nil {
+		return m2
+	} else if m2 == nil {
+		return m1
+	}
+
+	// merge both maps
+	for key, val := range m2 {
+		m1[key] = val
+	}
+	return m1
+}
+
+func isParameter(s string) bool {
+	return strings.Index(s, parameterPrefix) == 0 && len(s) > 1
+}

route_test.go

@@ -0,0 +1,70 @@
+package gohttprouter
+
+import (
+	"testing"
+)
+
+func TestRouteSimple(t *testing.T) {
+	route := newRoute()
+	route.parsePath("/home/path", true)
+	if route.routes["home"].routes["path"].name != "path" {
+		t.Error("error during path parsing")
+	}
+
+	// check for non-existing path
+	r, _, _ := route.parsePath("/home/not/path", false)
+	if r != nil {
+		t.Error("found route that doesn't exist")
+	}
+}
+
+func TestRootNodePlaceholder(t *testing.T) {
+	route := newRoute()
+	route.parsePath("/:id", true)
+	route.parsePath("/:id/name", true)
+	if route.routes[":"].name != ":" || route.routes[":"].placeholderName != "id" {
+		t.Error("error during path parsing")
+	}
+
+	// check for first path
+	r, _, parameters := route.parsePath("/123", false)
+	if r == nil {
+		t.Error("route not found")
+	}
+	if parameters["id"] != "123" {
+		t.Error("missing/invalid parameter ID")
+	}
+
+	// check for second path
+	r, _, parameters = route.parsePath("/123/name", false)
+	if r == nil {
+		t.Error("route not found")
+	}
+	if parameters["id"] != "123" {
+		t.Error("missing/invalid parameter ID")
+	}
+}
+
+func TestRoutePlaceholder(t *testing.T) {
+	route := newRoute()
+	route.parsePath("/user/:id/home/:name", true)
+	placeholderElement := route.routes["user"].routes[":"]
+	homePathElement := placeholderElement.routes["home"]
+
+	// check some field values
+	if homePathElement.name != "home" {
+		t.Error("error during route name parsing with placeholder path;", homePathElement.name)
+	}
+	if placeholderElement.placeholderName != "id" {
+		t.Error("error during placeholder name validation;", placeholderElement.placeholderName)
+	}
+
+	// check path finder
+	foundRoute, _, foundParameters := route.parsePath("/user/123/home/martin", false)
+	if foundRoute != homePathElement.routes[":"] {
+		t.Error("wrong path element returned form path finding")
+	}
+	if foundParameters["id"] != "123" || foundParameters["name"] != "martin" {
+		t.Error("wrong parameter value parsed")
+	}
+}

router.go

@@ -0,0 +1,131 @@
+// Copyright 2018-2019 Martin Riedl
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// 	http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package gohttprouter
+
+import (
+	"fmt"
+	"net/http"
+	"strings"
+)
+
+// Router is the main struct for the whole routing logic.
+type Router struct {
+	registry map[string]*route
+}
+
+// RouteHandler is the function construct called by this framework.
+type RouteHandler func(http.ResponseWriter, *http.Request, RoutingInfo)
+
+// RoutingInfo is returned for each web server method call and includes details abount the execution.
+type RoutingInfo struct {
+	Parameters map[string]string
+}
+
+// Handler interface that must be implemented by custom structs.
+type Handler interface {
+	ServeHTTP(http.ResponseWriter, *http.Request, RoutingInfo)
+}
+
+type defaultHandler struct {
+	Func RouteHandler
+}
+
+func (handler defaultHandler) ServeHTTP(response http.ResponseWriter, request *http.Request, routingInfo RoutingInfo) {
+	handler.Func(response, request, routingInfo)
+}
+
+// New creates a new router instance.
+func New() *Router {
+	return &Router{
+		registry: make(map[string]*route),
+	}
+}
+
+// Handle registers a new handler using method and path for execution.
+func (router *Router) Handle(method string, path string, handler Handler) error {
+	return router.addRoute(method, path, handler)
+}
+
+// HandleFunc registers a new handler function using method and path for execution.
+func (router *Router) HandleFunc(method string, path string, handler RouteHandler) error {
+	newHandler := defaultHandler{Func: handler}
+	return router.addRoute(method, path, newHandler)
+}
+
+func (router *Router) addRoute(method string, path string, handler Handler) error {
+	if err := router.validateRoute(path); err != nil {
+		return err
+	}
+
+	// parse path and set new handler
+	route, created, _ := router.findRoute(method, path, true)
+	if !created {
+		return fmt.Errorf("there is already a handler registered for the path %s", path)
+	}
+	route.handler = handler
+	return nil
+}
+
+func (router *Router) findRoute(method string, path string, create bool) (route *route, created bool, parameter map[string]string) {
+	methodUpper := strings.ToUpper(method)
+
+	// add method, if not already existing
+	methodRoute, ok := router.registry[methodUpper]
+	if !ok && !create {
+		return nil, false, nil
+	} else if !ok && create {
+		methodRoute = newRoute()
+		router.registry[methodUpper] = methodRoute
+		created = true
+	}
+
+	// parse path and set new handler
+	route, pathCreated, parameter := methodRoute.parsePath(path, create)
+	created = created || pathCreated
+	return
+}
+
+func (router *Router) validateRoute(path string) error {
+	// path must start with a slash
+	if strings.Index(path, "/") != 0 {
+		return fmt.Errorf("URL path must start with a slash (/)")
+	}
+
+	// path must not end with a slash
+	if path[len(path)-1] == '/' {
+		return fmt.Errorf("URL path must not end with a slash (/)")
+	}
+
+	return nil
+}
+
+func (router *Router) ServeHTTP(response http.ResponseWriter, request *http.Request) {
+	// check for exact matching
+	route, _, parameter := router.findRoute(request.Method, request.RequestURI, false)
+	if route != nil && route.handler != nil {
+		route.handler.ServeHTTP(response, request, RoutingInfo{Parameters: parameter})
+		return
+	}
+
+	// nothing found
+	http.NotFound(response, request)
+}
+
+// Must is a wrapper that panics if an error was returned.
+func Must(err error) {
+	if err != nil {
+		panic(err)
+	}
+}

router_test.go

@@ -0,0 +1,113 @@
+package gohttprouter
+
+import (
+	"net"
+	"net/http"
+	"strings"
+	"testing"
+)
+
+func testWebServer(t *testing.T) {
+	router := New()
+	Must(router.HandleFunc(http.MethodGet, "/:name", func(response http.ResponseWriter, request *http.Request, info RoutingInfo) {
+		response.Write([]byte("name: " + info.Parameters["name"]))
+	}))
+	err := http.ListenAndServe("localhost:8080", router)
+	if err != nil {
+		t.Error(err)
+	}
+}
+
+func TestRouterInvalidPath(t *testing.T) {
+	router := New()
+	if err := router.HandleFunc(http.MethodGet, "missing/slash", emptyHandlerFunction); err == nil {
+		t.Error("an error was expected during path parsing (missing slash)")
+	}
+	if err := router.HandleFunc(http.MethodGet, "/invalid/shash/", emptyHandlerFunction); err == nil {
+		t.Error("an error was expected during path parsing (ending slash)")
+	}
+}
+
+func TestRouterSamePath(t *testing.T) {
+	router := New()
+	Must(router.HandleFunc(http.MethodGet, "/user/:id/name", emptyHandlerFunction))
+	if err := router.HandleFunc(http.MethodGet, "/user/:name/name", emptyHandlerFunction); err == nil {
+		t.Error("missing exception; path was defined twice")
+	}
+}
+
+func TestRouterServer(t *testing.T) {
+	quitChan := make(chan bool, 2)
+
+	router := New()
+	router.HandleFunc(http.MethodGet, "/home", func(response http.ResponseWriter, request *http.Request, info RoutingInfo) {
+		quitChan <- true
+	})
+	listener, err := net.Listen("tcp", "localhost:8080")
+	if err != nil {
+		t.Error(err)
+	}
+	go http.Serve(listener, router)
+
+	// call method (not existing)
+	resp, err := http.Get("http://localhost:8080/home/test")
+	if err != nil {
+		t.Error(err)
+	}
+	if resp.StatusCode != http.StatusNotFound {
+		t.Error("server should return 404 but returned", resp.StatusCode)
+	}
+
+	// call method (POST not defined)
+	resp, err = http.Post("http://localhost:8080/home", "text/text", strings.NewReader("yea"))
+	if err != nil {
+		t.Error(err)
+	}
+	if resp.StatusCode != http.StatusNotFound {
+		t.Error("server should return 404 but returned", resp.StatusCode)
+	}
+
+	// call method
+	_, err = http.Get("http://localhost:8080/home")
+	if err != nil {
+		t.Error(err)
+	}
+
+	// wait for completion
+	_ = <-quitChan
+	listener.Close()
+}
+
+func TestRouterServerHandler(t *testing.T) {
+	testHandler := TestHandler{CloseChannel: make(chan bool, 2)}
+
+	router := New()
+	router.Handle(http.MethodGet, "/home", testHandler)
+	listener, err := net.Listen("tcp", "localhost:8081")
+	if err != nil {
+		t.Error(err)
+	}
+	go http.Serve(listener, router)
+
+	// call method
+	_, err = http.Get("http://localhost:8081/home")
+	if err != nil {
+		t.Error(err)
+	}
+
+	// wait for completion
+	_ = <-testHandler.CloseChannel
+	listener.Close()
+}
+
+func emptyHandlerFunction(response http.ResponseWriter, request *http.Request, routerInfo RoutingInfo) {
+	// it's fine
+}
+
+type TestHandler struct {
+	CloseChannel chan bool
+}
+
+func (t TestHandler) ServeHTTP(response http.ResponseWriter, request *http.Request, routerInfo RoutingInfo) {
+	t.CloseChannel <- true
+}