Options for redirect middleware

Signed-off-by: Vishal Rana <vr@labstack.com>

middleware/basic_auth.go

@@ -42,7 +42,7 @@ func BasicAuth(fn BasicAuthValidator) echo.MiddlewareFunc {
 	return BasicAuthWithConfig(c)
 }
 
-// BasicAuthWithConfig returns an BasicAuth middleware from config.
+// BasicAuthWithConfig returns an BasicAuth middleware with config.
 // See `BasicAuth()`.
 func BasicAuthWithConfig(config BasicAuthConfig) echo.MiddlewareFunc {
 	// Defaults

middleware/body_limit.go

@@ -50,7 +50,7 @@ func BodyLimit(limit string) echo.MiddlewareFunc {
 	return BodyLimitWithConfig(c)
 }
 
-// BodyLimitWithConfig returns a BodyLimit middleware from config.
+// BodyLimitWithConfig returns a BodyLimit middleware with config.
 // See: `BodyLimit()`.
 func BodyLimitWithConfig(config BodyLimitConfig) echo.MiddlewareFunc {
 	// Defaults

middleware/compress.go

@@ -43,7 +43,7 @@ func Gzip() echo.MiddlewareFunc {
 	return GzipWithConfig(DefaultGzipConfig)
 }
 
-// GzipWithConfig return Gzip middleware from config.
+// GzipWithConfig return Gzip middleware with config.
 // See: `Gzip()`.
 func GzipWithConfig(config GzipConfig) echo.MiddlewareFunc {
 	// Defaults

middleware/cors.go

@@ -62,7 +62,7 @@ func CORS() echo.MiddlewareFunc {
 	return CORSWithConfig(DefaultCORSConfig)
 }
 
-// CORSWithConfig returns a CORS middleware from config.
+// CORSWithConfig returns a CORS middleware with config.
 // See: `CORS()`.
 func CORSWithConfig(config CORSConfig) echo.MiddlewareFunc {
 	// Defaults

middleware/csrf.go

@@ -83,7 +83,7 @@ func CSRF() echo.MiddlewareFunc {
 	return CSRFWithConfig(c)
 }
 
-// CSRFWithConfig returns a CSRF middleware from config.
+// CSRFWithConfig returns a CSRF middleware with config.
 // See `CSRF()`.
 func CSRFWithConfig(config CSRFConfig) echo.MiddlewareFunc {
 	// Defaults

middleware/jwt.go

@@ -79,7 +79,7 @@ func JWT(key []byte) echo.MiddlewareFunc {
 	return JWTWithConfig(c)
 }
 
-// JWTWithConfig returns a JWT auth middleware from config.
+// JWTWithConfig returns a JWT auth middleware with config.
 // See: `JWT()`.
 func JWTWithConfig(config JWTConfig) echo.MiddlewareFunc {
 	// Defaults

middleware/logger.go

@@ -70,7 +70,7 @@ func Logger() echo.MiddlewareFunc {
 	return LoggerWithConfig(DefaultLoggerConfig)
 }
 
-// LoggerWithConfig returns a Logger middleware from config.
+// LoggerWithConfig returns a Logger middleware with config.
 // See: `Logger()`.
 func LoggerWithConfig(config LoggerConfig) echo.MiddlewareFunc {
 	// Defaults

middleware/method_override.go

@@ -34,7 +34,7 @@ func MethodOverride() echo.MiddlewareFunc {
 	return MethodOverrideWithConfig(DefaultMethodOverrideConfig)
 }
 
-// MethodOverrideWithConfig returns a MethodOverride middleware from config.
+// MethodOverrideWithConfig returns a MethodOverride middleware with config.
 // See: `MethodOverride()`.
 func MethodOverrideWithConfig(config MethodOverrideConfig) echo.MiddlewareFunc {
 	// Defaults

middleware/recover.go

@@ -45,7 +45,7 @@ func Recover() echo.MiddlewareFunc {
 	return RecoverWithConfig(DefaultRecoverConfig)
 }
 
-// RecoverWithConfig returns a Recover middleware from config.
+// RecoverWithConfig returns a Recover middleware with config.
 // See: `Recover()`.
 func RecoverWithConfig(config RecoverConfig) echo.MiddlewareFunc {
 	// Defaults

middleware/redirect.go

@@ -6,16 +6,56 @@ import (
 	"github.com/labstack/echo"
 )
 
+type (
+	// RedirectConfig defines the config for Redirect middleware.
+	RedirectConfig struct {
+		// Skipper defines a function to skip middleware.
+		Skipper Skipper
+
+		// Status code to be used when redirecting the request.
+		// Optional. Default value http.StatusMovedPermanently.
+		Code int `json:"code"`
+	}
+)
+
+var (
+	// DefaultRedirectConfig is the default Redirect middleware config.
+	DefaultRedirectConfig = RedirectConfig{
+		Skipper: defaultSkipper,
+		Code:    http.StatusMovedPermanently,
+	}
+)
+
 // HTTPSRedirect redirects HTTP requests to HTTPS.
 // For example, http://labstack.com will be redirect to https://labstack.com.
+//
+// Usage `Echo#Pre(HTTPSRedirect())`
 func HTTPSRedirect() echo.MiddlewareFunc {
+	return HTTPSRedirectWithConfig(DefaultRedirectConfig)
+}
+
+// HTTPSRedirectWithConfig returns a HTTPSRedirect middleware with config.
+// See `HTTPSRedirect()`.
+func HTTPSRedirectWithConfig(config RedirectConfig) echo.MiddlewareFunc {
+	// Defaults
+	if config.Skipper == nil {
+		config.Skipper = DefaultTrailingSlashConfig.Skipper
+	}
+	if config.Code == 0 {
+		config.Code = DefaultRedirectConfig.Code
+	}
+
 	return func(next echo.HandlerFunc) echo.HandlerFunc {
 		return func(c echo.Context) error {
+			if config.Skipper(c) {
+				return next(c)
+			}
+
 			req := c.Request()
 			host := req.Host()
 			uri := req.URI()
 			if !req.IsTLS() {
-				return c.Redirect(http.StatusMovedPermanently, "https://"+host+uri)
+				return c.Redirect(config.Code, "https://"+host+uri)
 			}
 			return next(c)
 		}
@@ -24,9 +64,29 @@ func HTTPSRedirect() echo.MiddlewareFunc {
 
 // HTTPSWWWRedirect redirects HTTP requests to WWW HTTPS.
 // For example, http://labstack.com will be redirect to https://www.labstack.com.
+//
+// Usage `Echo#Pre(HTTPSWWWRedirect())`
 func HTTPSWWWRedirect() echo.MiddlewareFunc {
+	return HTTPSWWWRedirectWithConfig(DefaultRedirectConfig)
+}
+
+// HTTPSWWWRedirectWithConfig returns a HTTPSRedirect middleware with config.
+// See `HTTPSWWWRedirect()`.
+func HTTPSWWWRedirectWithConfig(config RedirectConfig) echo.MiddlewareFunc {
+	// Defaults
+	if config.Skipper == nil {
+		config.Skipper = DefaultTrailingSlashConfig.Skipper
+	}
+	if config.Code == 0 {
+		config.Code = DefaultRedirectConfig.Code
+	}
+
 	return func(next echo.HandlerFunc) echo.HandlerFunc {
 		return func(c echo.Context) error {
+			if config.Skipper(c) {
+				return next(c)
+			}
+
 			req := c.Request()
 			host := req.Host()
 			uri := req.URI()
@@ -40,9 +100,29 @@ func HTTPSWWWRedirect() echo.MiddlewareFunc {
 
 // WWWRedirect redirects non WWW requests to WWW.
 // For example, http://labstack.com will be redirect to http://www.labstack.com.
+//
+// Usage `Echo#Pre(WWWRedirect())`
 func WWWRedirect() echo.MiddlewareFunc {
+	return WWWRedirectWithConfig(DefaultRedirectConfig)
+}
+
+// WWWRedirectWithConfig returns a HTTPSRedirect middleware with config.
+// See `WWWRedirect()`.
+func WWWRedirectWithConfig(config RedirectConfig) echo.MiddlewareFunc {
+	// Defaults
+	if config.Skipper == nil {
+		config.Skipper = DefaultTrailingSlashConfig.Skipper
+	}
+	if config.Code == 0 {
+		config.Code = DefaultRedirectConfig.Code
+	}
+
 	return func(next echo.HandlerFunc) echo.HandlerFunc {
 		return func(c echo.Context) error {
+			if config.Skipper(c) {
+				return next(c)
+			}
+
 			req := c.Request()
 			scheme := req.Scheme()
 			host := req.Host()
@@ -57,9 +137,28 @@ func WWWRedirect() echo.MiddlewareFunc {
 
 // NonWWWRedirect redirects WWW request to non WWW.
 // For example, http://www.labstack.com will be redirect to http://labstack.com.
+//
+// Usage `Echo#Pre(NonWWWRedirect())`
 func NonWWWRedirect() echo.MiddlewareFunc {
+	return NonWWWRedirectWithConfig(DefaultRedirectConfig)
+}
+
+// NonWWWRedirectWithConfig returns a HTTPSRedirect middleware with config.
+// See `NonWWWRedirect()`.
+func NonWWWRedirectWithConfig(config RedirectConfig) echo.MiddlewareFunc {
+	if config.Skipper == nil {
+		config.Skipper = DefaultTrailingSlashConfig.Skipper
+	}
+	if config.Code == 0 {
+		config.Code = DefaultRedirectConfig.Code
+	}
+
 	return func(next echo.HandlerFunc) echo.HandlerFunc {
 		return func(c echo.Context) error {
+			if config.Skipper(c) {
+				return next(c)
+			}
+
 			req := c.Request()
 			scheme := req.Scheme()
 			host := req.Host()

middleware/secure.go

@@ -74,7 +74,7 @@ func Secure() echo.MiddlewareFunc {
 	return SecureWithConfig(DefaultSecureConfig)
 }
 
-// SecureWithConfig returns a Secure middleware from config.
+// SecureWithConfig returns a Secure middleware with config.
 // See: `Secure()`.
 func SecureWithConfig(config SecureConfig) echo.MiddlewareFunc {
 	// Defaults

middleware/slash.go

@@ -28,10 +28,10 @@ var (
 //
 // Usage `Echo#Pre(AddTrailingSlash())`
 func AddTrailingSlash() echo.MiddlewareFunc {
-	return AddTrailingSlashWithConfig(TrailingSlashConfig{})
+	return AddTrailingSlashWithConfig(DefaultTrailingSlashConfig)
 }
 
-// AddTrailingSlashWithConfig returns a AddTrailingSlash middleware from config.
+// AddTrailingSlashWithConfig returns a AddTrailingSlash middleware with config.
 // See `AddTrailingSlash()`.
 func AddTrailingSlashWithConfig(config TrailingSlashConfig) echo.MiddlewareFunc {
 	// Defaults
@@ -78,7 +78,7 @@ func RemoveTrailingSlash() echo.MiddlewareFunc {
 	return RemoveTrailingSlashWithConfig(TrailingSlashConfig{})
 }
 
-// RemoveTrailingSlashWithConfig returns a RemoveTrailingSlash middleware from config.
+// RemoveTrailingSlashWithConfig returns a RemoveTrailingSlash middleware with config.
 // See `RemoveTrailingSlash()`.
 func RemoveTrailingSlashWithConfig(config TrailingSlashConfig) echo.MiddlewareFunc {
 	// Defaults

middleware/static.go

@@ -50,7 +50,7 @@ func Static(root string) echo.MiddlewareFunc {
 	return StaticWithConfig(c)
 }
 
-// StaticWithConfig returns a Static middleware from config.
+// StaticWithConfig returns a Static middleware with config.
 // See `Static()`.
 func StaticWithConfig(config StaticConfig) echo.MiddlewareFunc {
 	// Defaults