Merge pull request #14 from go-rs/develop

Develop

Author: roshangade

README.md

@@ -59,6 +59,27 @@ fmt.Println("Starting server.")
 http.ListenAndServe(":8080", api)
 ```
 
+
+## Extend routes
+```
+var user = rest.Extend("/user", api)
+
+user.Use(func(ctx *rest.Context) {
+    //User middleware will execute for /user/* routes
+})
+
+user.Get("/:uid/profile", func(ctx *rest.Context) {
+    ctx.JSON(`{"user": "profile"}`)
+})
+
+user.Get("/:uid", func(ctx *rest.Context) {
+    ctx.JSON(ctx.Params)
+})
+```
+
+###Pending 
+- Stop execution on timeout/abort
+
 ## Documentation
 https://godoc.org/github.com/go-rs/rest-api-framework
 

api.go

@@ -153,8 +153,8 @@ func (api *API) UnhandledException(handle Handler) {
 
 // error variables to handle expected errors
 var (
-	ErrCodeNotFound          = "URL_NOT_FOUND"
-	ErrCodeUncaughtException = "UNCAUGHT_EXCEPTION"
+	ErrCodeNotFound     = "URL_NOT_FOUND"
+	ErrCodeRuntimeError = "RUNTIME_ERROR"
 )
 
 // It's required handle for http module.
@@ -175,7 +175,7 @@ func (api *API) ServeHTTP(res http.ResponseWriter, req *http.Request) {
 		err := recover()
 		if err != nil {
 			if !ctx.end {
-				ctx.code = ErrCodeUncaughtException
+				ctx.code = ErrCodeRuntimeError
 				ctx.err = fmt.Errorf("%v", err)
 				ctx.unhandledException()
 			}

api_test.go

@@ -90,7 +90,7 @@ func TestAPI_Patch(t *testing.T) {
 	validateRoute("Patch", "PATCH", "/:uid", t)
 }
 
-func TestAPI_Exception(t *testing.T) {
+func TestAPI_OnError(t *testing.T) {
 	a.OnError("UID_NOT_FOUND", handle)
 
 	flag := true

context.go

@@ -216,17 +216,16 @@ func (ctx *Context) unhandledException() {
 
 	// NOT FOUND handler
 	if ctx.code == ErrCodeNotFound {
-		http.NotFound(ctx.Response, ctx.Request)
-		return
+		ctx.Status(http.StatusNotFound)
 	}
 
 	if ctx.code != "" || ctx.err != nil {
-		msg := ctx.code
+		msg := "Error Code: " + ctx.code
 		if ctx.err != nil {
-			msg += "\nError: " + ctx.err.Error()
+			msg += "\nError Message: " + ctx.err.Error()
 		}
 		ctx.SetHeader("Content-Type", "text/plain;charset=UTF-8")
-		if ctx.status > 400 {
+		if ctx.status < 400 {
 			ctx.Status(http.StatusInternalServerError)
 		}
 		ctx.Write([]byte(msg))
@@ -238,11 +237,9 @@ func (ctx *Context) recover() {
 	err := recover()
 	if err != nil {
 		//TODO: debugger mode
-		log.Println("Unhandled Error: ", err)
+		log.Println("Runtime Error: ", err)
 		if !ctx.requestSent {
-			ctx.Response.WriteHeader(http.StatusInternalServerError)
-			ctx.Response.Header().Set("Content-Type", "text/plain;charset=UTF-8")
-			_, _ = ctx.Response.Write([]byte("Internal Server Error"))
+			http.Error(ctx.Response, "Internal Server Error", http.StatusInternalServerError)
 		}
 	}
 }

examples/server.go

@@ -2,6 +2,7 @@ package main
 
 import (
 	"fmt"
+	"log"
 	"net/http"
 	"strconv"
 	"time"
@@ -32,7 +33,7 @@ func main() {
 		s := time.Now().UnixNano()
 		ctx.PreSend(func() {
 			x := time.Now().UnixNano() - s
-			ctx.SetHeader("X-Runtime", strconv.FormatInt(x/int64(time.Millisecond), 10))
+			ctx.SetHeader("X-Runtime", strconv.FormatInt(x/int64(time.Microsecond), 10))
 		})
 	})
 
@@ -43,6 +44,7 @@ func main() {
 
 	api.Get("/foo", func(ctx *rest.Context) {
 		ctx.Throw("UNAUTHORIZED")
+		// can also use ctx.ThrowWithError("SERVER_ERROR", error)
 	})
 
 	// error handler
@@ -52,7 +54,15 @@ func main() {
 
 	fmt.Println("Starting server.")
 
-	err := http.ListenAndServe(":8080", api)
+	tout := http.TimeoutHandler(api, 100*time.Millisecond, "timeout")
+
+	server := http.Server{
+		Addr:    ":8080",
+		Handler: tout,
+	}
+
+	if err := server.ListenAndServe(); err != nil {
+		log.Fatalf("could not start server, %v", err)
+	}
 
-	fmt.Println(err)
 }

examples/user/user.go

@@ -6,9 +6,7 @@ import (
 
 func Load(api *rest.API) {
 
-	var user rest.Namespace
-
-	user.Set("/user", api)
+	var user = rest.Extend("/user", api)
 
 	user.Use(func(ctx *rest.Context) {
 		println("User middleware > /user/*")

go.mod

@@ -1,3 +1,3 @@
 module github.com/go-rs/rest-api-framework
 
-go 1.12
+go 1.13

namespace.go

@@ -5,8 +5,9 @@
 package rest
 
 import (
-	"github.com/go-rs/rest-api-framework/utils"
 	"net/http"
+
+	"github.com/go-rs/rest-api-framework/utils"
 )
 
 // Namespace is used to extend routes with a specific prefix
@@ -16,10 +17,12 @@ type Namespace struct {
 }
 
 // Set method is used to set prefix with API
-func (n *Namespace) Set(prefix string, api *API) {
+func Extend(prefix string, api *API) *Namespace {
 	prefix = utils.TrimSuffix(prefix, "/")
-	n.prefix = prefix
-	n.api = api
+	return &Namespace{
+		prefix: prefix,
+		api:    api,
+	}
 }
 
 // Use method is used to set interceptors/middlewares for all requests,

namespace_test.go

@@ -9,11 +9,11 @@ import (
 )
 
 var api API
-var ns Namespace
+var ns *Namespace
 var handle Handler
 
-func TestNamespace_Set(t *testing.T) {
-	ns.Set("/test", &api)
+func TestExtend(t *testing.T) {
+	ns = Extend("/test", &api)
 
 	if ns.prefix != "/test" {
 		t.Error("Prefix is not set.")
@@ -88,7 +88,7 @@ func TestNamespace_Patch(t *testing.T) {
 	validateNsRoute("Patch", "PATCH", "/test/:uid", t)
 }
 
-func TestNamespace_Exception(t *testing.T) {
+func TestNamespace_OnError(t *testing.T) {
 	ns.OnError("UID_NOT_FOUND", handle)
 
 	flag := true

render/text_test.go

@@ -20,7 +20,7 @@ func TestText_Write(t *testing.T) {
 		t.Error("Render text is not valid")
 	}
 
-	if w.Header().Get("Content-Type") != "text/plain" {
+	if w.Header().Get("Content-Type") != "text/plain;charset=UTF-8" {
 		t.Error("Content-Type Header is not set.")
 	}
 }