add context.Protobuf, MsgPack, ReadProtobuf, ReadMsgPack methods

Former-commit-id: 39d547ecfb1516505a1eb76a12a1f6e9e4111962

Author: kataras

HISTORY.md

@@ -150,7 +150,7 @@ Prior to this version the `iris.Context` was the only one dependency that has be
 | `float, float32, float64`, | |
 | `bool`, | |
 | `slice` | [Path Parameter](https://github.com/kataras/iris/wiki/Routing-path-parameter-types) |
-| Struct | [Request Body](https://github.com/kataras/iris/tree/master/_examples/http_request) of `JSON`, `XML`, `YAML`, `Form`, `URL Query` |
+| Struct | [Request Body](https://github.com/kataras/iris/tree/master/_examples/http_request) of `JSON`, `XML`, `YAML`, `Form`, `URL Query`, `Protobuf`, `MsgPack` |
 
 Here is a preview of what the new Hero handlers look like:
 
@@ -176,6 +176,10 @@ Other Improvements:
 
 New Context Methods:
 
+- `context.Protobuf(proto.Message)` sends protobuf to the client
+- `context.MsgPack(interface{})` sends msgpack format data to the client
+- `context.ReadProtobuf(ptr)` binds request body to a proto message
+- `context.ReadMsgPack(ptr)` binds request body of a msgpack format to a struct
 - `context.Defer(Handler)` works like `Party.Done` but for the request life-cycle.
 - `context.ReflectValue() []reflect.Value` stores and returns the `[]reflect.ValueOf(context)`
 - `context.Controller() reflect.Value` returns the current MVC Controller value (when fired from inside a controller's method).

_examples/README.md

@@ -248,6 +248,7 @@ You can serve [quicktemplate](https://github.com/valyala/quicktemplate) and [her
 - [Read JSON](http_request/read-json/main.go)
     * [Struct Validation](http_request/read-json-struct-validation/main.go)
 - [Read XML](http_request/read-xml/main.go)
+- [Read MsgPack](http_request/read-msgpack/main.go) **NEW**
 - [Read YAML](http_request/read-yaml/main.go)
 - [Read Form](http_request/read-form/main.go)
 - [Read Query](http_request/read-query/main.go)

_examples/configuration/README.md

@@ -35,7 +35,7 @@ func main() {
         DisableBodyConsumptionOnUnmarshal: false,
         DisableAutoFireStatusCode:         false,
         TimeFormat:                        "Mon, 02 Jan 2006 15:04:05 GMT",
-        Charset:                           "UTF-8",
+        Charset:                           "utf-8",
     }))
 }
 ```
@@ -60,10 +60,10 @@ func main() {
     // Prefix: "With", code editors will help you navigate through all
     // configuration options without even a glitch to the documentation.
 
-    app.Listen(":8080", iris.WithoutStartupLog, iris.WithCharset("UTF-8"))
+    app.Listen(":8080", iris.WithoutStartupLog, iris.WithCharset("utf-8"))
 
     // or before run:
-    // app.Configure(iris.WithoutStartupLog, iris.WithCharset("UTF-8"))
+    // app.Configure(iris.WithoutStartupLog, iris.WithCharset("utf-8"))
     // app.Listen(":8080")
 }
 ```
@@ -76,7 +76,7 @@ EnablePathEscape = false
 FireMethodNotAllowed = true
 DisableBodyConsumptionOnUnmarshal = false
 TimeFormat = "Mon, 01 Jan 2006 15:04:05 GMT"
-Charset = "UTF-8"
+Charset = "utf-8"
 
 [Other]
 	MyServerName = "iris"

_examples/configuration/from-configuration-structure/main.go

@@ -21,7 +21,7 @@ func main() {
 		DisableBodyConsumptionOnUnmarshal: false,
 		DisableAutoFireStatusCode:         false,
 		TimeFormat:                        "Mon, 02 Jan 2006 15:04:05 GMT",
-		Charset:                           "UTF-8",
+		Charset:                           "utf-8",
 	}))
 
 	// or before Run:

_examples/configuration/from-toml-file/configs/iris.tml

@@ -3,7 +3,7 @@ EnablePathEscape = false
 FireMethodNotAllowed = true
 DisableBodyConsumptionOnUnmarshal = false
 TimeFormat = "Mon, 01 Jan 2006 15:04:05 GMT"
-Charset = "UTF-8"
+Charset = "utf-8"
 
 [Other]
 	MyServerName = "iris"

_examples/configuration/functional/main.go

@@ -15,9 +15,9 @@ func main() {
 	// Prefix: "With", code editors will help you navigate through all
 	// configuration options without even a glitch to the documentation.
 
-	app.Listen(":8080", iris.WithoutStartupLog, iris.WithCharset("UTF-8"))
+	app.Listen(":8080", iris.WithoutStartupLog, iris.WithCharset("utf-8"))
 
 	// or before run:
-	// app.Configure(iris.WithoutStartupLog, iris.WithCharset("UTF-8"))
+	// app.Configure(iris.WithoutStartupLog, iris.WithCharset("utf-8"))
 	// app.Listen(":8080")
 }

_examples/http_request/read-msgpack/main.go

@@ -0,0 +1,38 @@
+package main
+
+import "github.com/kataras/iris/v12"
+
+// User example struct to bind to.
+type User struct {
+	Firstname string `msgpack:"firstname"`
+	Lastname  string `msgpack:"lastname"`
+	City      string `msgpack:"city"`
+	Age       int    `msgpack:"age"`
+}
+
+// readMsgPack reads a `User` from MsgPack post body.
+func readMsgPack(ctx iris.Context) {
+	var u User
+	err := ctx.ReadMsgPack(&u)
+	if err != nil {
+		ctx.StatusCode(iris.StatusBadRequest)
+		ctx.WriteString(err.Error())
+		return
+	}
+
+	ctx.Writef("Received: %#+v\n", u)
+}
+
+func main() {
+	app := iris.New()
+	app.Post("/", readMsgPack)
+
+	// POST: http://localhost:8080
+	//
+	// To run the example, use a tool like Postman:
+	// 1. Body: Binary
+	// 2. Select File, select the one from "_examples/http_responsewriter/write-rest" example.
+	// The output should be:
+	// Received: main.User{Firstname:"John", Lastname:"Doe", City:"Neither FBI knows!!!", Age:25}
+	app.Listen(":8080")
+}

_examples/http_responsewriter/write-rest/main.go

@@ -7,12 +7,12 @@ import (
 	"github.com/kataras/iris/v12/context"
 )
 
-// User bind struct
+// User example struct for json and msgpack.
 type User struct {
-	Firstname string `json:"firstname"`
-	Lastname  string `json:"lastname"`
-	City      string `json:"city"`
-	Age       int    `json:"age"`
+	Firstname string `json:"firstname" msgpack:"firstname"`
+	Lastname  string `json:"lastname" msgpack:"lastname"`
+	City      string `json:"city" msgpack:"city"`
+	Age       int    `json:"age" msgpack:"age"`
 }
 
 // ExampleXML just a test struct to view represents xml content-type
@@ -22,6 +22,12 @@ type ExampleXML struct {
 	Two     string   `xml:"two,attr"`
 }
 
+// ExampleYAML just a test struct to write yaml to the client.
+type ExampleYAML struct {
+	Name       string `yaml:"name"`
+	ServerAddr string `yaml:"ServerAddr"`
+}
+
 func main() {
 	app := iris.New()
 
@@ -36,15 +42,15 @@ func main() {
 
 	// Write
 	app.Get("/encode", func(ctx iris.Context) {
-		peter := User{
+		u := User{
 			Firstname: "John",
 			Lastname:  "Doe",
 			City:      "Neither FBI knows!!!",
 			Age:       25,
 		}
 
 		// Manually setting a content type: ctx.ContentType("application/javascript")
-		ctx.JSON(peter)
+		ctx.JSON(u)
 	})
 
 	// Other content types,
@@ -74,6 +80,21 @@ func main() {
 		ctx.Markdown([]byte("# Hello Dynamic Markdown -- iris"))
 	})
 
+	app.Get("/yaml", func(ctx iris.Context) {
+		ctx.YAML(ExampleYAML{Name: "Iris", ServerAddr: "localhost:8080"})
+	})
+
+	app.Get("/msgpack", func(ctx iris.Context) {
+		u := User{
+			Firstname: "John",
+			Lastname:  "Doe",
+			City:      "Neither FBI knows!!!",
+			Age:       25,
+		}
+
+		ctx.MsgPack(u)
+	})
+
 	// http://localhost:8080/decode
 	// http://localhost:8080/encode
 	//
@@ -83,6 +104,7 @@ func main() {
 	// http://localhost:8080/jsonp
 	// http://localhost:8080/xml
 	// http://localhost:8080/markdown
+	// http://localhost:8080/msgpack
 	//
 	// `iris.WithOptimizations` is an optional configurator,
 	// if passed to the `Run` then it will ensure that the application

_examples/overview/main.go

@@ -83,7 +83,7 @@ func main() {
 	})
 
 	// Listen for incoming HTTP/1.x & HTTP/2 clients on localhost port 8080.
-	app.Listen(":8080", iris.WithCharset("UTF-8"))
+	app.Listen(":8080", iris.WithCharset("utf-8"))
 }
 
 func logThisMiddleware(ctx iris.Context) {

_examples/view/template_html_0/main.go

@@ -24,7 +24,7 @@ func main() {
 	app.Get("/", hi)
 
 	// http://localhost:8080
-	app.Listen(":8080", iris.WithCharset("UTF-8")) // defaults to that but you can change it.
+	app.Listen(":8080", iris.WithCharset("utf-8")) // defaults to that but you can change it.
 }
 
 func hi(ctx iris.Context) {

configuration.go

@@ -803,7 +803,7 @@ type Configuration struct {
 
 	// Charset character encoding for various rendering
 	// used for templates and the rest of the responses
-	// Defaults to "UTF-8".
+	// Defaults to "utf-8".
 	Charset string `json:"charset,omitempty" yaml:"Charset" toml:"Charset"`
 
 	// PostMaxMemory sets the maximum post data size
@@ -1109,7 +1109,7 @@ func DefaultConfiguration() Configuration {
 		DisableBodyConsumptionOnUnmarshal: false,
 		DisableAutoFireStatusCode:         false,
 		TimeFormat:                        "Mon, 02 Jan 2006 15:04:05 GMT",
-		Charset:                           "UTF-8",
+		Charset:                           "utf-8",
 
 		// PostMaxMemory is for post body max memory.
 		//

configuration_test.go

@@ -148,7 +148,7 @@ FireMethodNotAllowed: true
 EnableOptimizations: true
 DisableBodyConsumptionOnUnmarshal: true
 TimeFormat: "Mon, 02 Jan 2006 15:04:05 GMT"
-Charset: "UTF-8"
+Charset: "utf-8"
 
 RemoteAddrHeaders:
   X-Real-Ip: true
@@ -192,7 +192,7 @@ Other:
 		t.Fatalf("error on TestConfigurationYAML: Expected TimeFormat %s but got %s", expected, c.TimeFormat)
 	}
 
-	if expected := "UTF-8"; c.Charset != expected {
+	if expected := "utf-8"; c.Charset != expected {
 		t.Fatalf("error on TestConfigurationYAML: Expected Charset %s but got %s", expected, c.Charset)
 	}
 
@@ -245,7 +245,7 @@ FireMethodNotAllowed = true
 EnableOptimizations = true
 DisableBodyConsumptionOnUnmarshal = true
 TimeFormat = "Mon, 02 Jan 2006 15:04:05 GMT"
-Charset = "UTF-8"
+Charset = "utf-8"
 
 [RemoteAddrHeaders]
     X-Real-Ip = true
@@ -291,7 +291,7 @@ Charset = "UTF-8"
 		t.Fatalf("error on TestConfigurationTOML: Expected TimeFormat %s but got %s", expected, c.TimeFormat)
 	}
 
-	if expected := "UTF-8"; c.Charset != expected {
+	if expected := "utf-8"; c.Charset != expected {
 		t.Fatalf("error on TestConfigurationTOML: Expected Charset %s but got %s", expected, c.Charset)
 	}