Merge pull request #10 from go-rs/develop

Develop

Author: roshangade

README.md

@@ -13,8 +13,10 @@ See examples
   - Error handler
   - HTTP, HTTPS support
 
+## How to use?  
+  
 ```
-var api rest.API
+var api = rest.New("/v1")
 
 // request interceptor / middleware
 api.Use(func(ctx *rest.Context) {
@@ -48,14 +50,17 @@ api.Get("/:bar", func(ctx *rest.Context) {
 })
 
 // error handler
-api.Error("UNAUTHORIZED", func(ctx *rest.Context) {
+api.OnError("UNAUTHORIZED", func(ctx *rest.Context) {
   ctx.Text("You are unauthorized")
 })
 
 fmt.Println("Starting server.")
 
-http.ListenAndServe(":8080", &api)
+http.ListenAndServe(":8080", api)
 ```
 
+## Documentation
+https://godoc.org/github.com/go-rs/rest-api-framework
+
 ##### Powered by
 [![GoLand - JetBrains](https://raw.githubusercontent.com/go-rs/rest-api-framework/master/docs/powered-by/logo.svg?sanitize=true)](https://www.jetbrains.com/?from=Go+REST+Services)

api.go

@@ -1,5 +1,5 @@
 // go-rs/rest-api-framework
-// Copyright(c) 2019 Roshan Gade.  All rights reserved.
+// Copyright(c) 2019 Roshan Gade. All rights reserved.
 // MIT Licensed
 
 package rest
@@ -126,8 +126,8 @@ func (api *API) Patch(pattern string, handle Handler) {
 	api.Route(http.MethodPatch, pattern, handle)
 }
 
-// On method is used to handle a custom errors thrown by users
-func (api *API) On(err string, handle Handler) {
+// OnError method is used to handle a custom errors thrown by users
+func (api *API) OnError(err string, handle Handler) {
 	exp := exception{
 		message: err,
 		handle:  handle,

api_test.go

@@ -1,8 +1,7 @@
-/*!
- * rest-a-framework
- * Copyright(c) 2019 Roshan Gade
- * MIT Licensed
- */
+// go-rs/rest-api-framework
+// Copyright(c) 2019 Roshan Gade. All rights reserved.
+// MIT Licensed
+
 package rest
 
 import (
@@ -92,7 +91,7 @@ func TestAPI_Patch(t *testing.T) {
 }
 
 func TestAPI_Exception(t *testing.T) {
-	a.Exception("UID_NOT_FOUND", handle)
+	a.OnError("UID_NOT_FOUND", handle)
 
 	flag := true
 	for _, route := range a.exceptions {

context.go

@@ -1,27 +1,32 @@
 // go-rs/rest-api-framework
-// Copyright(c) 2019 Roshan Gade.  All rights reserved.
+// Copyright(c) 2019 Roshan Gade. All rights reserved.
 // MIT Licensed
 
 package rest
 
 import (
+	"log"
 	"net/http"
 	"net/url"
 
 	"github.com/go-rs/rest-api-framework/render"
 )
 
+// Task, which is used to perform a specific job,
+// just before request completion or after request completion
 type Task func()
 
-/**
- * Context
- */
+// Context, which initializes at every request with pre-declared variables
+// such as Request, Response, Query, Body, Params etc.
 type Context struct {
-	Request         *http.Request
-	Response        http.ResponseWriter
-	Query           url.Values
-	Body            interface{}
-	Params          map[string]string
+	// available to users
+	Request  *http.Request
+	Response http.ResponseWriter
+	Query    url.Values
+	Body     interface{}
+	Params   map[string]string
+
+	// for internal use
 	headers         map[string]string
 	data            map[string]interface{}
 	err             error
@@ -35,150 +40,134 @@ type Context struct {
 	postSendTasks   []Task
 }
 
-/**
- * Initialization of context on every request
- */
+// Initialization of context data on every request
 func (ctx *Context) init() {
 	ctx.headers = make(map[string]string)
 	ctx.data = make(map[string]interface{})
 	ctx.preSendTasks = make([]Task, 0)
 	ctx.postSendTasks = make([]Task, 0)
 	ctx.status = 200
-	ctx.found = false
-	ctx.end = false
 }
 
-/**
- * Destroy context once request end
- */
+// Destroy context data once request end
 func (ctx *Context) destroy() {
 	ctx.Request = nil
 	ctx.Response = nil
+	ctx.Query = nil
+	ctx.Body = nil
 	ctx.Params = nil
+	ctx.headers = nil
 	ctx.data = nil
 	ctx.err = nil
 	ctx.status = 0
 	ctx.found = false
 	ctx.end = false
+	ctx.requestSent = false
+	ctx.preTasksCalled = false
+	ctx.postTasksCalled = false
+	ctx.preSendTasks = nil
+	ctx.postSendTasks = nil
 }
 
-/**
- * Set request data in context
- */
+// Set data
 func (ctx *Context) Set(key string, val interface{}) {
 	ctx.data[key] = val
 }
 
-/**
- * Get request data from context
- */
+// Get data
 func (ctx *Context) Get(key string) (val interface{}, exists bool) {
-	val = ctx.data[key]
-	exists = val != nil
+	val, exists = ctx.data[key]
 	return
 }
 
-/**
- * Set Status
- */
+// Delete data
+func (ctx *Context) Delete(key string, val interface{}) {
+	delete(ctx.data, key)
+}
+
+// Set response status
 func (ctx *Context) Status(code int) *Context {
 	ctx.status = code
 	return ctx
 }
 
-/**
- * Set Header
- */
+// Set response header
 func (ctx *Context) SetHeader(key string, val string) *Context {
 	ctx.headers[key] = val
 	return ctx
 }
 
-/**
- * Throw error
- */
+// Caught error in context on throw
 func (ctx *Context) Throw(err error) {
 	ctx.err = err
 }
 
-/**
- * Get error
- */
+// Get error if any
 func (ctx *Context) GetError() error {
 	return ctx.err
 }
 
-/**
- * End
- */
+// Marked the request is ended
 func (ctx *Context) End() {
 	ctx.end = true
 }
 
-/**
- * Write Bytes
- */
+// Send response in bytes
 func (ctx *Context) Write(data []byte) {
 	ctx.send(data, nil)
 }
 
-/**
- * Write JSON
- */
+// Send JSON data in response
 func (ctx *Context) JSON(data interface{}) {
 	json := render.JSON{
 		Body: data,
 	}
-	body, err := json.Write(ctx.Response)
+	body, err := json.ToBytes(ctx.Response)
 	ctx.send(body, err)
 }
 
-/**
- * Write Text
- */
+// Send text in response
 func (ctx *Context) Text(data string) {
 	txt := render.Text{
 		Body: data,
 	}
-	body, err := txt.Write(ctx.Response)
+	body, err := txt.ToBytes(ctx.Response)
 	ctx.send(body, err)
 }
 
-/**
- *
- */
+// Register pre-send hook
 func (ctx *Context) PreSend(task Task) {
 	ctx.preSendTasks = append(ctx.preSendTasks, task)
 }
 
-/**
- *
- */
+// Register pre-post hook
 func (ctx *Context) PostSend(task Task) {
 	ctx.postSendTasks = append(ctx.postSendTasks, task)
 }
 
 //////////////////////////////////////////////////
-/**
- * Send data
- */
+// Send data, which uses bytes or error if any
+// Also, it calls pre-send and post-send registered hooks
 func (ctx *Context) send(data []byte, err error) {
 	if ctx.end {
 		return
 	}
 
 	if err != nil {
 		ctx.err = err
+		ctx.unhandledException()
 		return
 	}
 
+	// execute pre-send hooks
 	if !ctx.preTasksCalled {
 		ctx.preTasksCalled = true
 		for _, task := range ctx.preSendTasks {
 			task()
 		}
 	}
 
+	// write data
 	if !ctx.requestSent {
 		ctx.requestSent = true
 
@@ -191,11 +180,12 @@ func (ctx *Context) send(data []byte, err error) {
 		_, err = ctx.Response.Write(data)
 
 		if err != nil {
-			ctx.err = err
-			return
+			//TODO: debugger mode
+			log.Println("Response Error: ", err)
 		}
 	}
 
+	// execute post-send hooks
 	if !ctx.postTasksCalled {
 		ctx.postTasksCalled = true
 		for _, task := range ctx.postSendTasks {
@@ -206,13 +196,13 @@ func (ctx *Context) send(data []byte, err error) {
 	ctx.End()
 }
 
-/**
- * Unhandled Exception
- */
+// Unhandled Exception
 func (ctx *Context) unhandledException() {
 	defer func() {
 		err := recover()
 		if err != nil {
+			//TODO: debugger mode
+			log.Println("Unhandled Error: ", err)
 			if !ctx.requestSent {
 				ctx.Response.WriteHeader(http.StatusInternalServerError)
 				ctx.Response.Header().Set("Content-Type", "text/plain;charset=UTF-8")

context_test.go

@@ -1,5 +1,5 @@
 // go-rs/rest-api-framework
-// Copyright(c) 2019 Roshan Gade.  All rights reserved.
+// Copyright(c) 2019 Roshan Gade. All rights reserved.
 // MIT Licensed
 
 package rest
@@ -141,7 +141,7 @@ func TestContext_JSON2(t *testing.T) {
 		t.Error("JSON is not working")
 	}
 
-	if ctx.end {
+	if !ctx.end {
 		t.Error("JSON is no executing successfully")
 	}
 	ctx.destroy()

examples/server.go

@@ -11,7 +11,7 @@ import (
 
 func main() {
 
-	var api = rest.New("")
+	var api = rest.New("/v1")
 
 	user.Load(api)
 
@@ -32,7 +32,7 @@ func main() {
 	})
 
 	// error handler
-	api.Exception("UNAUTHORIZED", func(ctx *rest.Context) {
+	api.OnError("UNAUTHORIZED", func(ctx *rest.Context) {
 		ctx.Status(401).JSON(`{"message": "You are unauthorized"}`)
 	})