add a new 'Context.GzipReader(bool) method and 'iris.GzipReader' middleware as requested at #1528

Former-commit-id: 7665545069bf1784d17a9db1e5f9f5f8df4b0c43

_examples/README.md

@@ -112,6 +112,7 @@
     * [Bind Custom per type](http_request/read-custom-per-type/main.go)
     * [Bind Custom via Unmarshaler](http_request/read-custom-via-unmarshaler/main.go)
     * [Bind Many times](http_request/read-many/main.go)
+    * [Read/Bind Gzip compressed data](http_request/read-gzip/main.go)
     * [Upload/Read File](http_request/upload-file/main.go)
     * [Upload multiple Files](http_request/upload-files/main.go)
     * [Extract Referrer](http_request/extract-referer/main.go)

_examples/http_request/read-body/main.go

@@ -12,6 +12,9 @@ func main() {
 
 func newApp() *iris.Application {
 	app := iris.New()
+	// To automatically decompress using gzip:
+	// app.Use(iris.GzipReader)
+
 	app.Use(setAllowedResponses)
 
 	app.Post("/", readBody)

_examples/http_request/read-gzip/main.go

@@ -0,0 +1,44 @@
+package main
+
+import (
+	"github.com/kataras/iris/v12"
+)
+
+func main() {
+	app := newApp()
+	app.Logger().SetLevel("debug")
+
+	app.Listen(":8080")
+}
+
+type payload struct {
+	Message string `json:"message"`
+}
+
+func newApp() *iris.Application {
+	app := iris.New()
+
+	// GzipReader is a middleware which enables gzip decompression,
+	// when client sends gzip compressed data.
+	//
+	// A shortcut of:
+	// func(ctx iris.Context) {
+	//	ctx.GzipReader(true)
+	//	ctx.Next()
+	// }
+	app.Use(iris.GzipReader)
+
+	app.Post("/", func(ctx iris.Context) {
+		// Bind incoming gzip compressed JSON to "p".
+		var p payload
+		if err := ctx.ReadJSON(&p); err != nil {
+			ctx.StopWithError(iris.StatusBadRequest, err)
+			return
+		}
+
+		// Send back the message as plain text.
+		ctx.WriteString(p.Message)
+	})
+
+	return app
+}

_examples/http_request/read-gzip/main_test.go

@@ -0,0 +1,38 @@
+package main
+
+import (
+	"bytes"
+	"compress/gzip"
+	"encoding/json"
+	"testing"
+
+	"github.com/kataras/iris/v12/httptest"
+)
+
+func TestGzipReader(t *testing.T) {
+	app := newApp()
+
+	expected := payload{Message: "test"}
+	b, err := json.Marshal(expected)
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	buf := new(bytes.Buffer)
+	w := gzip.NewWriter(buf)
+	_, err = w.Write(b)
+	if err != nil {
+		t.Fatal(err)
+	}
+	err = w.Close()
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	e := httptest.New(t, app)
+	// send gzip compressed.
+	e.POST("/").WithHeader("Content-Encoding", "gzip").WithHeader("Content-Type", "application/json").
+		WithBytes(buf.Bytes()).Expect().Status(httptest.StatusOK).Body().Equal(expected.Message)
+	// raw.
+	e.POST("/").WithJSON(expected).Expect().Status(httptest.StatusOK).Body().Equal(expected.Message)
+}